From 5985ea37574ce8ceb2e7d19a8278696455f78165 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Wed, 17 Sep 2025 15:47:05 +1000 Subject: [PATCH] microsite --- .github/ISSUE_TEMPLATE/bug_report.md | 38 + .github/ISSUE_TEMPLATE/feature_request.md | 20 + .github/ISSUE_TEMPLATE/question.md | 15 + .github/PULL_REQUEST_TEMPLATE.md | 14 + .github/workflows/prod-web-deploy.yml | 58 + .github/workflows/star-check.yml | 42 + .github/workflows/test-web-deploy.yml | 31 + fix_docs.sh | 10 + website/.gitignore | 20 + website/README.md | 41 + website/docs/index.md | 323 + .../accessanalyzer/analyzer_tags/index.md | 85 + .../accessanalyzer/analyzers/index.md | 257 + .../analyzers_list_only/index.md | 73 + website/docs/services/accessanalyzer/index.md | 38 + .../acmpca/certificate_authorities/index.md | 330 + .../index.md | 73 + .../index.md | 202 + .../certificate_authority_tags/index.md | 95 + .../services/acmpca/certificates/index.md | 271 + website/docs/services/acmpca/index.md | 41 + .../docs/services/acmpca/permissions/index.md | 191 + .../amazonmq/configuration_tags/index.md | 93 + .../services/amazonmq/configurations/index.md | 254 + .../configurations_list_only/index.md | 73 + website/docs/services/amazonmq/index.md | 38 + .../docs/services/amplify/app_tags/index.md | 113 + website/docs/services/amplify/apps/index.md | 368 + .../services/amplify/apps_list_only/index.md | 73 + .../services/amplify/branch_tags/index.md | 103 + .../docs/services/amplify/branches/index.md | 339 + .../amplify/branches_list_only/index.md | 73 + .../docs/services/amplify/domains/index.md | 280 + .../amplify/domains_list_only/index.md | 73 + website/docs/services/amplify/index.md | 43 + .../amplifyuibuilder/component_tags/index.md | 107 + .../amplifyuibuilder/components/index.md | 341 + .../components_list_only/index.md | 78 + .../amplifyuibuilder/form_tags/index.md | 99 + .../services/amplifyuibuilder/forms/index.md | 319 + .../amplifyuibuilder/forms_list_only/index.md | 78 + .../docs/services/amplifyuibuilder/index.md | 44 + .../amplifyuibuilder/theme_tags/index.md | 91 + .../services/amplifyuibuilder/themes/index.md | 265 + .../themes_list_only/index.md | 78 + .../services/apigateway/accounts/index.md | 183 + .../services/apigateway/api_key_tags/index.md | 91 + .../services/apigateway/api_keys/index.md | 270 + .../apigateway/api_keys_list_only/index.md | 73 + .../services/apigateway/authorizers/index.md | 268 + .../apigateway/authorizers_list_only/index.md | 75 + .../apigateway/base_path_mapping_v2s/index.md | 223 + .../base_path_mapping_v2s_list_only/index.md | 74 + .../apigateway/base_path_mappings/index.md | 218 + .../base_path_mappings_list_only/index.md | 75 + .../client_certificate_tags/index.md | 79 + .../apigateway/client_certificates/index.md | 213 + .../client_certificates_list_only/index.md | 73 + .../services/apigateway/deployments/index.md | 272 + .../apigateway/deployments_list_only/index.md | 75 + .../apigateway/documentation_parts/index.md | 222 + .../documentation_parts_list_only/index.md | 75 + .../documentation_versions/index.md | 212 + .../documentation_versions_list_only/index.md | 75 + .../index.md | 83 + .../domain_name_access_associations/index.md | 216 + .../index.md | 73 + .../apigateway/domain_name_tags/index.md | 97 + .../apigateway/domain_name_v2_tags/index.md | 89 + .../apigateway/domain_name_v2s/index.md | 258 + .../domain_name_v2s_list_only/index.md | 74 + .../services/apigateway/domain_names/index.md | 277 + .../domain_names_list_only/index.md | 73 + .../apigateway/gateway_responses/index.md | 230 + .../gateway_responses_list_only/index.md | 73 + website/docs/services/apigateway/index.md | 86 + .../docs/services/apigateway/methods/index.md | 282 + .../docs/services/apigateway/models/index.md | 225 + .../apigateway/models_list_only/index.md | 75 + .../apigateway/request_validators/index.md | 220 + .../request_validators_list_only/index.md | 75 + .../services/apigateway/resources/index.md | 216 + .../apigateway/resources_list_only/index.md | 75 + .../apigateway/rest_api_tags/index.md | 107 + .../services/apigateway/rest_apis/index.md | 349 + .../apigateway/rest_apis_list_only/index.md | 73 + .../services/apigateway/stage_tags/index.md | 101 + .../docs/services/apigateway/stages/index.md | 309 + .../apigateway/stages_list_only/index.md | 75 + .../apigateway/usage_plan_keys/index.md | 207 + .../usage_plan_keys_list_only/index.md | 73 + .../apigateway/usage_plan_tags/index.md | 87 + .../services/apigateway/usage_plans/index.md | 259 + .../apigateway/usage_plans_list_only/index.md | 73 + .../apigateway/vpc_link_tags/index.md | 83 + .../services/apigateway/vpc_links/index.md | 249 + .../apigateway/vpc_links_list_only/index.md | 73 + .../apigatewayv2/api_mappings/index.md | 224 + .../api_mappings_list_only/index.md | 75 + .../services/apigatewayv2/api_tags/index.md | 111 + .../docs/services/apigatewayv2/apis/index.md | 368 + .../apigatewayv2/apis_list_only/index.md | 73 + .../apigatewayv2/authorizers/index.md | 280 + .../authorizers_list_only/index.md | 75 + .../apigatewayv2/deployments/index.md | 214 + .../deployments_list_only/index.md | 75 + .../apigatewayv2/domain_name_tags/index.md | 85 + .../apigatewayv2/domain_names/index.md | 233 + .../domain_names_list_only/index.md | 73 + website/docs/services/apigatewayv2/index.md | 60 + .../integration_responses/index.md | 246 + .../integration_responses_list_only/index.md | 77 + .../apigatewayv2/integrations/index.md | 322 + .../integrations_list_only/index.md | 75 + .../services/apigatewayv2/models/index.md | 232 + .../apigatewayv2/models_list_only/index.md | 75 + .../apigatewayv2/route_responses/index.md | 239 + .../route_responses_list_only/index.md | 77 + .../services/apigatewayv2/routes/index.md | 280 + .../apigatewayv2/routes_list_only/index.md | 75 + .../apigatewayv2/vpc_link_tags/index.md | 83 + .../services/apigatewayv2/vpc_links/index.md | 243 + .../apigatewayv2/vpc_links_list_only/index.md | 73 + .../appconfig/application_tags/index.md | 81 + .../services/appconfig/applications/index.md | 220 + .../appconfig/applications_list_only/index.md | 73 + .../configuration_profile_tags/index.md | 97 + .../appconfig/configuration_profiles/index.md | 279 + .../configuration_profiles_list_only/index.md | 75 + .../appconfig/deployment_strategies/index.md | 258 + .../deployment_strategies_list_only/index.md | 73 + .../deployment_strategy_tags/index.md | 91 + .../appconfig/deployment_tags/index.md | 93 + .../services/appconfig/deployments/index.md | 261 + .../appconfig/deployments_list_only/index.md | 77 + .../appconfig/environment_tags/index.md | 87 + .../services/appconfig/environments/index.md | 247 + .../appconfig/environments_list_only/index.md | 75 + .../extension_association_tags/index.md | 91 + .../appconfig/extension_associations/index.md | 248 + .../extension_associations_list_only/index.md | 73 + .../appconfig/extension_tags/index.md | 91 + .../services/appconfig/extensions/index.md | 247 + .../appconfig/extensions_list_only/index.md | 73 + .../hosted_configuration_versions/index.md | 235 + .../index.md | 77 + website/docs/services/appconfig/index.md | 58 + .../appflow/connector_profiles/index.md | 410 + .../connector_profiles_list_only/index.md | 73 + .../docs/services/appflow/connectors/index.md | 224 + .../appflow/connectors_list_only/index.md | 73 + .../docs/services/appflow/flow_tags/index.md | 95 + website/docs/services/appflow/flows/index.md | 471 + .../services/appflow/flows_list_only/index.md | 73 + website/docs/services/appflow/index.md | 42 + .../appintegrations/application_tags/index.md | 89 + .../appintegrations/applications/index.md | 253 + .../applications_list_only/index.md | 73 + .../data_integration_tags/index.md | 93 + .../data_integrations/index.md | 304 + .../data_integrations_list_only/index.md | 73 + .../event_integration_tags/index.md | 85 + .../event_integrations/index.md | 237 + .../event_integrations_list_only/index.md | 73 + .../docs/services/appintegrations/index.md | 44 + .../services/applicationautoscaling/index.md | 39 + .../scalable_targets/index.md | 287 + .../scalable_targets_list_only/index.md | 78 + .../scaling_policies/index.md | 333 + .../scaling_policies_list_only/index.md | 75 + .../application_tags/index.md | 99 + .../applicationinsights/applications/index.md | 408 + .../applications_list_only/index.md | 73 + .../services/applicationinsights/index.md | 38 + .../docs/services/applicationsignals/index.md | 38 + .../service_level_objective_tags/index.md | 95 + .../service_level_objectives/index.md | 309 + .../index.md | 73 + .../auto_scaling_configuration_tags/index.md | 89 + .../auto_scaling_configurations/index.md | 233 + .../index.md | 73 + website/docs/services/apprunner/index.md | 50 + .../observability_configuration_tags/index.md | 85 + .../observability_configurations/index.md | 212 + .../index.md | 73 + .../services/apprunner/service_tags/index.md | 99 + .../docs/services/apprunner/services/index.md | 326 + .../apprunner/services_list_only/index.md | 73 + .../apprunner/vpc_connector_tags/index.md | 85 + .../apprunner/vpc_connectors/index.md | 220 + .../vpc_connectors_list_only/index.md | 73 + .../vpc_ingress_connection_tags/index.md | 87 + .../vpc_ingress_connections/index.md | 235 + .../index.md | 73 + .../appstream/app_block_builder_tags/index.md | 99 + .../appstream/app_block_builders/index.md | 304 + .../app_block_builders_list_only/index.md | 73 + .../services/appstream/app_blocks/index.md | 227 + .../index.md | 185 + .../application_fleet_associations/index.md | 177 + .../services/appstream/applications/index.md | 267 + .../appstream/directory_configs/index.md | 254 + .../directory_configs_list_only/index.md | 73 + .../services/appstream/entitlements/index.md | 213 + .../appstream/image_builder_tags/index.md | 101 + .../appstream/image_builders/index.md | 319 + .../image_builders_list_only/index.md | 73 + website/docs/services/appstream/index.md | 48 + .../docs/services/appsync/api_tags/index.md | 87 + website/docs/services/appsync/apis/index.md | 257 + .../services/appsync/apis_list_only/index.md | 73 + .../appsync/channel_namespace_tags/index.md | 89 + .../appsync/channel_namespaces/index.md | 253 + .../channel_namespaces_list_only/index.md | 74 + .../services/appsync/data_sources/index.md | 316 + .../appsync/data_sources_list_only/index.md | 73 + .../domain_name_api_associations/index.md | 190 + .../services/appsync/domain_names/index.md | 220 + .../appsync/domain_names_list_only/index.md | 73 + .../appsync/function_configurations/index.md | 303 + .../index.md | 73 + .../appsync/graphql_api_tags/index.md | 123 + .../services/appsync/graphql_apis/index.md | 368 + .../appsync/graphql_apis_list_only/index.md | 73 + website/docs/services/appsync/index.md | 55 + .../docs/services/appsync/resolvers/index.md | 327 + .../appsync/resolvers_list_only/index.md | 73 + .../appsync/source_api_associations/index.md | 256 + .../index.md | 73 + website/docs/services/apptest/index.md | 38 + .../services/apptest/test_case_tags/index.md | 95 + .../docs/services/apptest/test_cases/index.md | 250 + .../apptest/test_cases_list_only/index.md | 73 + website/docs/services/aps/index.md | 44 + .../aps/rule_groups_namespace_tags/index.md | 83 + .../aps/rule_groups_namespaces/index.md | 233 + .../rule_groups_namespaces_list_only/index.md | 73 + .../docs/services/aps/scraper_tags/index.md | 89 + website/docs/services/aps/scrapers/index.md | 270 + .../services/aps/scrapers_list_only/index.md | 73 + .../docs/services/aps/workspace_tags/index.md | 89 + website/docs/services/aps/workspaces/index.md | 271 + .../aps/workspaces_list_only/index.md | 73 + .../index.md | 192 + .../index.md | 75 + website/docs/services/arczonalshift/index.md | 39 + .../zonal_autoshift_configurations/index.md | 230 + .../index.md | 73 + .../athena/capacity_reservation_tags/index.md | 91 + .../athena/capacity_reservations/index.md | 249 + .../capacity_reservations_list_only/index.md | 73 + .../athena/data_catalog_tags/index.md | 83 + .../services/athena/data_catalogs/index.md | 232 + .../athena/data_catalogs_list_only/index.md | 73 + website/docs/services/athena/index.md | 48 + .../services/athena/named_queries/index.md | 217 + .../athena/named_queries_list_only/index.md | 74 + .../athena/prepared_statements/index.md | 221 + .../prepared_statements_list_only/index.md | 75 + .../services/athena/work_group_tags/index.md | 89 + .../docs/services/athena/work_groups/index.md | 305 + .../athena/work_groups_list_only/index.md | 73 + .../auditmanager/assessment_tags/index.md | 99 + .../auditmanager/assessments/index.md | 299 + .../assessments_list_only/index.md | 73 + website/docs/services/auditmanager/index.md | 38 + .../auto_scaling_group_tags/index.md | 143 + .../autoscaling/auto_scaling_groups/index.md | 596 ++ .../auto_scaling_groups_list_only/index.md | 73 + website/docs/services/autoscaling/index.md | 47 + .../launch_configurations/index.md | 331 + .../launch_configurations_list_only/index.md | 73 + .../autoscaling/lifecycle_hooks/index.md | 250 + .../lifecycle_hooks_list_only/index.md | 75 + .../autoscaling/scaling_policies/index.md | 338 + .../scaling_policies_list_only/index.md | 73 + .../autoscaling/scheduled_actions/index.md | 248 + .../scheduled_actions_list_only/index.md | 75 + .../services/autoscaling/warm_pools/index.md | 207 + .../docs/services/b2bi/capabilities/index.md | 260 + .../b2bi/capabilities_list_only/index.md | 73 + .../services/b2bi/capability_tags/index.md | 91 + website/docs/services/b2bi/index.md | 47 + .../services/b2bi/partnership_tags/index.md | 97 + .../docs/services/b2bi/partnerships/index.md | 266 + .../b2bi/partnerships_list_only/index.md | 73 + .../docs/services/b2bi/profile_tags/index.md | 95 + website/docs/services/b2bi/profiles/index.md | 267 + .../services/b2bi/profiles_list_only/index.md | 73 + .../services/b2bi/transformer_tags/index.md | 103 + .../docs/services/b2bi/transformers/index.md | 306 + .../b2bi/transformers_list_only/index.md | 73 + .../services/backup/backup_plans/index.md | 237 + .../backup/backup_plans_list_only/index.md | 74 + .../backup/backup_selections/index.md | 224 + .../backup_selections_list_only/index.md | 73 + .../services/backup/backup_vaults/index.md | 261 + .../backup/backup_vaults_list_only/index.md | 73 + .../docs/services/backup/frameworks/index.md | 250 + .../backup/frameworks_list_only/index.md | 73 + website/docs/services/backup/index.md | 52 + .../index.md | 267 + .../index.md | 73 + .../services/backup/report_plans/index.md | 252 + .../backup/report_plans_list_only/index.md | 73 + .../backup/restore_testing_plan_tags/index.md | 89 + .../backup/restore_testing_plans/index.md | 264 + .../restore_testing_plans_list_only/index.md | 73 + .../restore_testing_selections/index.md | 261 + .../index.md | 75 + .../backupgateway/hypervisor_tags/index.md | 89 + .../backupgateway/hypervisors/index.md | 266 + .../hypervisors_list_only/index.md | 73 + website/docs/services/backupgateway/index.md | 38 + .../batch/compute_environment_tags/index.md | 97 + .../batch/compute_environments/index.md | 318 + .../compute_environments_list_only/index.md | 73 + website/docs/services/batch/index.md | 47 + .../batch/job_definition_tags/index.md | 99 + .../services/batch/job_definitions/index.md | 494 + .../batch/job_definitions_list_only/index.md | 73 + .../services/batch/job_queue_tags/index.md | 89 + .../docs/services/batch/job_queues/index.md | 254 + .../batch/job_queues_list_only/index.md | 73 + .../batch/scheduling_policies/index.md | 225 + .../scheduling_policies_list_only/index.md | 73 + .../batch/scheduling_policy_tags/index.md | 81 + .../bcmdataexports/export_tags/index.md | 79 + .../services/bcmdataexports/exports/index.md | 218 + .../bcmdataexports/exports_list_only/index.md | 74 + website/docs/services/bcmdataexports/index.md | 38 + .../bedrock/agent_alias_tags/index.md | 95 + .../services/bedrock/agent_aliases/index.md | 255 + .../bedrock/agent_aliases_list_only/index.md | 75 + .../docs/services/bedrock/agent_tags/index.md | 121 + website/docs/services/bedrock/agents/index.md | 395 + .../bedrock/agents_list_only/index.md | 73 + .../index.md | 97 + .../application_inference_profiles/index.md | 249 + .../index.md | 74 + .../services/bedrock/data_sources/index.md | 341 + .../bedrock/data_sources_list_only/index.md | 75 + .../services/bedrock/flow_alias_tags/index.md | 93 + .../services/bedrock/flow_aliases/index.md | 250 + .../bedrock/flow_aliases_list_only/index.md | 75 + .../docs/services/bedrock/flow_tags/index.md | 107 + .../services/bedrock/flow_versions/index.md | 237 + .../bedrock/flow_versions_list_only/index.md | 75 + website/docs/services/bedrock/flows/index.md | 329 + .../services/bedrock/flows_list_only/index.md | 73 + .../services/bedrock/guardrail_tags/index.md | 111 + .../bedrock/guardrail_versions/index.md | 185 + .../docs/services/bedrock/guardrails/index.md | 339 + .../bedrock/guardrails_list_only/index.md | 73 + website/docs/services/bedrock/index.md | 67 + .../bedrock/knowledge_base_tags/index.md | 97 + .../services/bedrock/knowledge_bases/index.md | 314 + .../knowledge_bases_list_only/index.md | 73 + .../services/bedrock/prompt_tags/index.md | 95 + .../bedrock/prompt_version_tags/index.md | 97 + .../services/bedrock/prompt_versions/index.md | 233 + .../prompt_versions_list_only/index.md | 73 + .../docs/services/bedrock/prompts/index.md | 267 + .../bedrock/prompts_list_only/index.md | 73 + .../billing_group_tags/index.md | 97 + .../billingconductor/billing_groups/index.md | 279 + .../billing_groups_list_only/index.md | 73 + .../custom_line_item_tags/index.md | 99 + .../custom_line_items/index.md | 291 + .../custom_line_items_list_only/index.md | 73 + .../docs/services/billingconductor/index.md | 47 + .../pricing_plan_tags/index.md | 89 + .../billingconductor/pricing_plans/index.md | 246 + .../pricing_plans_list_only/index.md | 73 + .../pricing_rule_tags/index.md | 103 + .../billingconductor/pricing_rules/index.md | 294 + .../pricing_rules_list_only/index.md | 73 + .../services/budgets/budgets_actions/index.md | 296 + .../budgets_actions_list_only/index.md | 75 + website/docs/services/budgets/index.md | 37 + website/docs/services/cassandra/index.md | 43 + .../services/cassandra/keyspace_tags/index.md | 81 + .../services/cassandra/keyspaces/index.md | 249 + .../cassandra/keyspaces_list_only/index.md | 73 + .../services/cassandra/table_tags/index.md | 99 + .../docs/services/cassandra/tables/index.md | 377 + .../cassandra/tables_list_only/index.md | 75 + .../docs/services/cassandra/types/index.md | 221 + .../cassandra/types_list_only/index.md | 75 + .../services/ce/anomaly_monitors/index.md | 242 + .../ce/anomaly_monitors_list_only/index.md | 73 + .../ce/anomaly_subscriptions/index.md | 255 + .../anomaly_subscriptions_list_only/index.md | 73 + .../docs/services/ce/cost_categories/index.md | 232 + .../ce/cost_categories_list_only/index.md | 73 + website/docs/services/ce/index.md | 41 + .../certificatemanager/accounts/index.md | 183 + .../docs/services/certificatemanager/index.md | 37 + .../chatbot/custom_action_tags/index.md | 85 + .../services/chatbot/custom_actions/index.md | 245 + .../chatbot/custom_actions_list_only/index.md | 73 + website/docs/services/chatbot/index.md | 44 + .../index.md | 97 + .../index.md | 297 + .../index.md | 73 + .../slack_channel_configuration_tags/index.md | 95 + .../slack_channel_configurations/index.md | 287 + .../index.md | 73 + .../analysis_template_tags/index.md | 99 + .../cleanrooms/analysis_templates/index.md | 279 + .../analysis_templates_list_only/index.md | 75 + .../cleanrooms/collaboration_tags/index.md | 99 + .../cleanrooms/collaborations/index.md | 319 + .../collaborations_list_only/index.md | 73 + .../index.md | 91 + .../configured_table_associations/index.md | 279 + .../index.md | 75 + .../cleanrooms/configured_table_tags/index.md | 91 + .../cleanrooms/configured_tables/index.md | 303 + .../configured_tables_list_only/index.md | 73 + .../cleanrooms/id_mapping_table_tags/index.md | 97 + .../cleanrooms/id_mapping_tables/index.md | 283 + .../id_mapping_tables_list_only/index.md | 75 + .../id_namespace_association_tags/index.md | 97 + .../id_namespace_associations/index.md | 286 + .../index.md | 76 + website/docs/services/cleanrooms/index.md | 59 + .../cleanrooms/membership_tags/index.md | 91 + .../services/cleanrooms/memberships/index.md | 292 + .../cleanrooms/memberships_list_only/index.md | 73 + .../privacy_budget_template_tags/index.md | 93 + .../privacy_budget_templates/index.md | 260 + .../index.md | 75 + website/docs/services/cleanroomsml/index.md | 38 + .../training_dataset_tags/index.md | 87 + .../cleanroomsml/training_datasets/index.md | 249 + .../training_datasets_list_only/index.md | 74 + website/docs/services/cloud_control/index.md | 39 + .../services/cloud_control/resource/index.md | 64 + .../cloud_control/resource_request/index.md | 72 + .../cloud_control/resource_requests/index.md | 67 + .../services/cloud_control/resources/index.md | 77 + .../cloudformation/guard_hooks/index.md | 298 + .../guard_hooks_list_only/index.md | 73 + .../hook_default_versions/index.md | 196 + .../hook_default_versions_list_only/index.md | 73 + .../cloudformation/hook_type_configs/index.md | 225 + .../hook_type_configs_list_only/index.md | 74 + .../cloudformation/hook_versions/index.md | 232 + .../hook_versions_list_only/index.md | 73 + website/docs/services/cloudformation/index.md | 64 + .../cloudformation/lambda_hooks/index.md | 282 + .../lambda_hooks_list_only/index.md | 73 + .../module_default_versions/index.md | 184 + .../index.md | 73 + .../cloudformation/module_versions/index.md | 197 + .../public_type_versions/index.md | 216 + .../public_type_versions_list_only/index.md | 75 + .../cloudformation/publishers/index.md | 187 + .../publishers_list_only/index.md | 73 + .../resource_default_versions/index.md | 215 + .../index.md | 73 + .../cloudformation/resource_versions/index.md | 236 + .../resource_versions_list_only/index.md | 73 + .../cloudformation/stack_set_tags/index.md | 105 + .../cloudformation/stack_sets/index.md | 350 + .../stack_sets_list_only/index.md | 73 + .../cloudformation/stack_tags/index.md | 119 + .../services/cloudformation/stacks/index.md | 329 + .../cloudformation/stacks_list_only/index.md | 73 + .../cloudformation/type_activations/index.md | 285 + .../type_activations_list_only/index.md | 73 + .../cloudfront/anycast_ip_list_tags/index.md | 85 + .../cloudfront/anycast_ip_lists/index.md | 215 + .../anycast_ip_lists_list_only/index.md | 73 + .../cloudfront/cache_policies/index.md | 222 + .../cache_policies_list_only/index.md | 73 + .../index.md | 203 + .../index.md | 73 + .../continuous_deployment_policies/index.md | 222 + .../index.md | 73 + .../cloudfront/distribution_tags/index.md | 81 + .../cloudfront/distributions/index.md | 371 + .../distributions_list_only/index.md | 73 + .../services/cloudfront/functions/index.md | 243 + .../cloudfront/functions_list_only/index.md | 73 + website/docs/services/cloudfront/index.md | 64 + .../services/cloudfront/key_groups/index.md | 206 + .../cloudfront/key_groups_list_only/index.md | 73 + .../cloudfront/key_value_stores/index.md | 225 + .../key_value_stores_list_only/index.md | 73 + .../monitoring_subscriptions/index.md | 177 + .../origin_access_controls/index.md | 204 + .../origin_access_controls_list_only/index.md | 73 + .../origin_request_policies/index.md | 216 + .../index.md | 73 + .../services/cloudfront/public_keys/index.md | 206 + .../cloudfront/public_keys_list_only/index.md | 73 + .../cloudfront/realtime_log_configs/index.md | 233 + .../realtime_log_configs_list_only/index.md | 73 + .../response_headers_policies/index.md | 253 + .../index.md | 73 + .../docs/services/cloudhsm/backups/index.md | 93 + .../docs/services/cloudhsm/clusters/index.md | 97 + website/docs/services/cloudhsm/hsm/index.md | 63 + website/docs/services/cloudhsm/index.md | 39 + website/docs/services/cloudhsm/tags/index.md | 74 + .../services/cloudtrail/channel_tags/index.md | 83 + .../services/cloudtrail/channels/index.md | 227 + .../cloudtrail/channels_list_only/index.md | 73 + .../cloudtrail/dashboard_tags/index.md | 93 + .../services/cloudtrail/dashboards/index.md | 260 + .../cloudtrail/dashboards_list_only/index.md | 73 + .../cloudtrail/event_data_store_tags/index.md | 109 + .../cloudtrail/event_data_stores/index.md | 362 + .../event_data_stores_list_only/index.md | 73 + website/docs/services/cloudtrail/index.md | 48 + .../cloudtrail/resource_policies/index.md | 187 + .../services/cloudtrail/trail_tags/index.md | 109 + .../docs/services/cloudtrail/trails/index.md | 366 + .../cloudtrail/trails_list_only/index.md | 73 + .../services/cloudwatch/alarm_tags/index.md | 119 + .../docs/services/cloudwatch/alarms/index.md | 375 + .../cloudwatch/alarms_list_only/index.md | 73 + .../cloudwatch/composite_alarm_tags/index.md | 97 + .../cloudwatch/composite_alarms/index.md | 279 + .../composite_alarms_list_only/index.md | 73 + .../services/cloudwatch/dashboards/index.md | 203 + .../cloudwatch/dashboards_list_only/index.md | 73 + website/docs/services/cloudwatch/index.md | 49 + .../services/cloudwatch/log_events/index.md | 65 + .../services/cloudwatch/log_groups/index.md | 81 + .../services/cloudwatch/log_streams/index.md | 80 + .../cloudwatch/metric_stream_tags/index.md | 99 + .../cloudwatch/metric_streams/index.md | 297 + .../metric_streams_list_only/index.md | 73 + .../codeartifact/domain_tags/index.md | 87 + .../services/codeartifact/domains/index.md | 236 + .../codeartifact/domains_list_only/index.md | 73 + website/docs/services/codeartifact/index.md | 44 + .../codeartifact/package_group_tags/index.md | 89 + .../codeartifact/package_groups/index.md | 265 + .../package_groups_list_only/index.md | 73 + .../codeartifact/repositories/index.md | 271 + .../repositories_list_only/index.md | 73 + .../codeartifact/repository_tags/index.md | 93 + .../services/codebuild/fleet_tags/index.md | 99 + .../docs/services/codebuild/fleets/index.md | 323 + .../codebuild/fleets_list_only/index.md | 73 + website/docs/services/codebuild/index.md | 38 + .../codeconnections/connection_tags/index.md | 87 + .../codeconnections/connections/index.md | 231 + .../connections_list_only/index.md | 73 + .../docs/services/codeconnections/index.md | 38 + .../codedeploy/application_tags/index.md | 79 + .../services/codedeploy/applications/index.md | 218 + .../applications_list_only/index.md | 73 + .../codedeploy/deployment_configs/index.md | 235 + .../deployment_configs_list_only/index.md | 73 + website/docs/services/codedeploy/index.md | 40 + .../docs/services/codeguruprofiler/index.md | 38 + .../profiling_group_tags/index.md | 85 + .../profiling_groups/index.md | 251 + .../profiling_groups_list_only/index.md | 73 + .../docs/services/codegurureviewer/index.md | 38 + .../repository_association_tags/index.md | 87 + .../repository_associations/index.md | 248 + .../index.md | 73 + .../custom_action_type_tags/index.md | 91 + .../codepipeline/custom_action_types/index.md | 275 + .../custom_action_types_list_only/index.md | 78 + website/docs/services/codepipeline/index.md | 41 + .../codepipeline/pipeline_tags/index.md | 99 + .../services/codepipeline/pipelines/index.md | 385 + .../codepipeline/pipelines_list_only/index.md | 73 + .../connection_tags/index.md | 87 + .../codestarconnections/connections/index.md | 231 + .../connections_list_only/index.md | 73 + .../services/codestarconnections/index.md | 43 + .../repository_link_tags/index.md | 89 + .../repository_links/index.md | 253 + .../repository_links_list_only/index.md | 73 + .../sync_configurations/index.md | 268 + .../sync_configurations_list_only/index.md | 75 + .../services/codestarnotifications/index.md | 38 + .../notification_rule_tags/index.md | 95 + .../notification_rules/index.md | 274 + .../notification_rules_list_only/index.md | 73 + .../identity_pool_principal_tags/index.md | 224 + .../index.md | 75 + .../identity_pool_role_attachments/index.md | 216 + .../index.md | 73 + .../services/cognito/identity_pools/index.md | 300 + .../cognito/identity_pools_list_only/index.md | 73 + website/docs/services/cognito/index.md | 58 + .../log_delivery_configurations/index.md | 241 + .../cognito/managed_login_brandings/index.md | 214 + .../cognito/user_pool_clients/index.md | 373 + .../user_pool_clients_list_only/index.md | 75 + .../cognito/user_pool_groups/index.md | 229 + .../user_pool_groups_list_only/index.md | 75 + .../user_pool_identity_providers/index.md | 239 + .../index.md | 75 + .../user_pool_resource_servers/index.md | 221 + .../index.md | 75 + .../index.md | 232 + .../index.md | 185 + .../services/cognito/user_pool_users/index.md | 239 + .../user_pool_users_list_only/index.md | 75 + .../docs/services/cognito/user_pools/index.md | 550 + .../cognito/user_pools_list_only/index.md | 73 + .../index.md | 193 + .../document_classifier_tags/index.md | 99 + .../comprehend/document_classifiers/index.md | 321 + .../document_classifiers_list_only/index.md | 73 + .../comprehend/flywheel_tags/index.md | 91 + .../services/comprehend/flywheels/index.md | 278 + .../comprehend/flywheels_list_only/index.md | 73 + website/docs/services/comprehend/index.md | 41 + .../aggregation_authorization_tags/index.md | 81 + .../aggregation_authorizations/index.md | 223 + .../index.md | 75 + .../services/config/config_rules/index.md | 270 + .../config/config_rules_list_only/index.md | 73 + .../configuration_aggregator_tags/index.md | 83 + .../config/configuration_aggregators/index.md | 249 + .../index.md | 73 + .../config/conformance_packs/index.md | 252 + .../conformance_packs_list_only/index.md | 73 + website/docs/services/config/index.md | 50 + .../organization_conformance_packs/index.md | 259 + .../index.md | 73 + .../services/config/stored_queries/index.md | 233 + .../config/stored_queries_list_only/index.md | 73 + .../config/stored_query_tags/index.md | 85 + .../connect/agent_status_tags/index.md | 95 + .../services/connect/agent_statuses/index.md | 243 + .../connect/agent_statuses_list_only/index.md | 73 + .../connect/approved_origins/index.md | 195 + .../approved_origins_list_only/index.md | 75 + .../connect/contact_flow_module_tags/index.md | 89 + .../connect/contact_flow_modules/index.md | 246 + .../contact_flow_modules_list_only/index.md | 73 + .../connect/contact_flow_tags/index.md | 89 + .../services/connect/contact_flows/index.md | 252 + .../connect/contact_flows_list_only/index.md | 73 + .../connect/email_address_tags/index.md | 85 + .../services/connect/email_addresses/index.md | 242 + .../email_addresses_list_only/index.md | 74 + .../connect/evaluation_form_tags/index.md | 89 + .../connect/evaluation_forms/index.md | 298 + .../evaluation_forms_list_only/index.md | 73 + .../connect/hours_of_operation_tags/index.md | 89 + .../connect/hours_of_operations/index.md | 273 + .../hours_of_operations_list_only/index.md | 73 + website/docs/services/connect/index.md | 100 + .../connect/instance_storage_configs/index.md | 282 + .../index.md | 77 + .../services/connect/instance_tags/index.md | 93 + .../docs/services/connect/instances/index.md | 275 + .../connect/instances_list_only/index.md | 73 + .../connect/integration_associations/index.md | 256 + .../index.md | 77 + .../connect/predefined_attributes/index.md | 220 + .../predefined_attributes_list_only/index.md | 75 + .../services/connect/prompt_tags/index.md | 85 + .../docs/services/connect/prompts/index.md | 235 + .../connect/prompts_list_only/index.md | 73 + .../docs/services/connect/queue_tags/index.md | 97 + website/docs/services/connect/queues/index.md | 287 + .../connect/queues_list_only/index.md | 73 + .../connect/quick_connect_tags/index.md | 87 + .../services/connect/quick_connects/index.md | 248 + .../connect/quick_connects_list_only/index.md | 73 + .../connect/routing_profile_tags/index.md | 91 + .../connect/routing_profiles/index.md | 278 + .../routing_profiles_list_only/index.md | 73 + website/docs/services/connect/rules/index.md | 271 + .../services/connect/security_keys/index.md | 196 + .../connect/security_keys_list_only/index.md | 75 + .../connect/security_profile_tags/index.md | 99 + .../connect/security_profiles/index.md | 283 + .../security_profiles_list_only/index.md | 73 + .../connect/task_template_tags/index.md | 97 + .../services/connect/task_templates/index.md | 288 + .../connect/task_templates_list_only/index.md | 73 + .../traffic_distribution_group_tags/index.md | 87 + .../traffic_distribution_groups/index.md | 233 + .../index.md | 73 + .../user_hierarchy_group_tags/index.md | 83 + .../connect/user_hierarchy_groups/index.md | 226 + .../user_hierarchy_groups_list_only/index.md | 73 + .../user_hierarchy_structures/index.md | 205 + .../docs/services/connect/user_tags/index.md | 97 + website/docs/services/connect/users/index.md | 303 + .../services/connect/users_list_only/index.md | 73 + .../docs/services/connect/view_tags/index.md | 91 + .../services/connect/view_versions/index.md | 204 + .../connect/view_versions_list_only/index.md | 74 + website/docs/services/connect/views/index.md | 252 + .../services/connect/views_list_only/index.md | 73 + .../connectcampaigns/campaign_tags/index.md | 85 + .../connectcampaigns/campaigns/index.md | 257 + .../campaigns_list_only/index.md | 73 + .../docs/services/connectcampaigns/index.md | 38 + .../connectcampaignsv2/campaign_tags/index.md | 93 + .../connectcampaignsv2/campaigns/index.md | 348 + .../campaigns_list_only/index.md | 73 + .../docs/services/connectcampaignsv2/index.md | 38 + .../enabled_baseline_tags/index.md | 85 + .../controltower/enabled_baselines/index.md | 310 + .../enabled_baselines_list_only/index.md | 74 + .../enabled_control_tags/index.md | 81 + .../controltower/enabled_controls/index.md | 257 + .../enabled_controls_list_only/index.md | 75 + website/docs/services/controltower/index.md | 44 + .../controltower/landing_zone_tags/index.md | 89 + .../controltower/landing_zones/index.md | 310 + .../landing_zones_list_only/index.md | 73 + website/docs/services/cur/index.md | 37 + .../services/cur/report_definitions/index.md | 291 + .../cur/report_definitions_list_only/index.md | 73 + .../index.md | 93 + .../calculated_attribute_definitions/index.md | 271 + .../index.md | 75 + .../customerprofiles/domain_tags/index.md | 93 + .../customerprofiles/domains/index.md | 287 + .../domains_list_only/index.md | 73 + .../event_stream_tags/index.md | 89 + .../customerprofiles/event_streams/index.md | 241 + .../event_streams_list_only/index.md | 75 + .../event_trigger_tags/index.md | 93 + .../customerprofiles/event_triggers/index.md | 275 + .../event_triggers_list_only/index.md | 75 + .../docs/services/customerprofiles/index.md | 56 + .../integration_tags/index.md | 91 + .../customerprofiles/integrations/index.md | 323 + .../integrations_list_only/index.md | 75 + .../object_type_tags/index.md | 99 + .../customerprofiles/object_types/index.md | 292 + .../object_types_list_only/index.md | 75 + .../segment_definition_tags/index.md | 89 + .../segment_definitions/index.md | 254 + .../segment_definitions_list_only/index.md | 75 + .../services/databrew/dataset_tags/index.md | 87 + .../docs/services/databrew/datasets/index.md | 297 + .../databrew/datasets_list_only/index.md | 73 + website/docs/services/databrew/index.md | 53 + .../docs/services/databrew/job_tags/index.md | 113 + website/docs/services/databrew/jobs/index.md | 405 + .../services/databrew/jobs_list_only/index.md | 73 + .../services/databrew/project_tags/index.md | 85 + .../docs/services/databrew/projects/index.md | 247 + .../databrew/projects_list_only/index.md | 73 + .../services/databrew/recipe_tags/index.md | 81 + .../docs/services/databrew/recipes/index.md | 233 + .../databrew/recipes_list_only/index.md | 73 + .../services/databrew/ruleset_tags/index.md | 83 + .../docs/services/databrew/rulesets/index.md | 248 + .../databrew/rulesets_list_only/index.md | 73 + .../services/databrew/schedule_tags/index.md | 81 + .../docs/services/databrew/schedules/index.md | 227 + .../databrew/schedules_list_only/index.md | 73 + website/docs/services/datapipeline/index.md | 37 + .../services/datapipeline/pipelines/index.md | 274 + .../datapipeline/pipelines_list_only/index.md | 73 + .../services/datasync/agent_tags/index.md | 89 + .../docs/services/datasync/agents/index.md | 251 + .../datasync/agents_list_only/index.md | 73 + website/docs/services/datasync/index.md | 77 + .../location_azure_blob_tags/index.md | 93 + .../datasync/location_azure_blobs/index.md | 263 + .../location_azure_blobs_list_only/index.md | 73 + .../services/datasync/location_efs/index.md | 260 + .../datasync/location_efs_list_only/index.md | 73 + .../datasync/location_efs_tags/index.md | 91 + .../services/datasync/location_hdfs/index.md | 303 + .../datasync/location_hdfs_list_only/index.md | 73 + .../datasync/location_hdfs_tags/index.md | 103 + .../services/datasync/location_nfs/index.md | 241 + .../datasync/location_nfs_list_only/index.md | 73 + .../datasync/location_nfs_tags/index.md | 87 + .../location_object_storage_tags/index.md | 97 + .../location_object_storages/index.md | 274 + .../index.md | 73 + .../datasync/location_s3_tags/index.md | 87 + .../services/datasync/location_s3s/index.md | 242 + .../datasync/location_s3s_list_only/index.md | 73 + .../datasync/location_smb_tags/index.md | 93 + .../services/datasync/location_smbs/index.md | 263 + .../datasync/location_smbs_list_only/index.md | 73 + .../locationf_sx_lustre_tags/index.md | 85 + .../datasync/locationf_sx_lustres/index.md | 235 + .../locationf_sx_lustres_list_only/index.md | 73 + .../datasync/locationf_sx_ontap_tags/index.md | 89 + .../datasync/locationf_sx_ontaps/index.md | 251 + .../locationf_sx_ontaps_list_only/index.md | 73 + .../datasync/locationf_sx_open_zfs/index.md | 247 + .../locationf_sx_open_zfs_list_only/index.md | 73 + .../locationf_sx_open_zfs_tags/index.md | 87 + .../datasync/locationf_sx_windows/index.md | 258 + .../locationf_sx_windows_list_only/index.md | 73 + .../locationf_sx_windows_tags/index.md | 91 + .../datasync/storage_system_tags/index.md | 93 + .../datasync/storage_systems/index.md | 273 + .../storage_systems_list_only/index.md | 73 + .../docs/services/datasync/task_tags/index.md | 105 + website/docs/services/datasync/tasks/index.md | 367 + .../datasync/tasks_list_only/index.md | 73 + .../services/datazone/data_sources/index.md | 322 + .../datazone/data_sources_list_only/index.md | 75 + .../services/datazone/domain_tags/index.md | 99 + .../docs/services/datazone/domains/index.md | 276 + .../datazone/domains_list_only/index.md | 73 + .../datazone/environment_actions/index.md | 244 + .../environment_actions_list_only/index.md | 77 + .../index.md | 255 + .../index.md | 75 + .../datazone/environment_profiles/index.md | 279 + .../environment_profiles_list_only/index.md | 75 + .../services/datazone/environments/index.md | 310 + .../datazone/environments_list_only/index.md | 75 + .../services/datazone/group_profiles/index.md | 236 + .../group_profiles_list_only/index.md | 75 + website/docs/services/datazone/index.md | 58 + .../datazone/project_memberships/index.md | 226 + .../project_memberships_list_only/index.md | 78 + .../docs/services/datazone/projects/index.md | 236 + .../datazone/projects_list_only/index.md | 75 + .../datazone/subscription_targets/index.md | 294 + .../subscription_targets_list_only/index.md | 77 + .../services/datazone/user_profiles/index.md | 254 + .../datazone/user_profiles_list_only/index.md | 75 + .../docs/services/deadline/farm_tags/index.md | 85 + website/docs/services/deadline/farms/index.md | 253 + .../deadline/farms_list_only/index.md | 73 + .../services/deadline/fleet_tags/index.md | 99 + .../docs/services/deadline/fleets/index.md | 287 + .../deadline/fleets_list_only/index.md | 73 + website/docs/services/deadline/index.md | 57 + .../deadline/license_endpoint_tags/index.md | 91 + .../deadline/license_endpoints/index.md | 251 + .../license_endpoints_list_only/index.md | 73 + .../deadline/metered_products/index.md | 208 + .../metered_products_list_only/index.md | 73 + .../docs/services/deadline/monitors/index.md | 248 + .../deadline/monitors_list_only/index.md | 73 + .../deadline/queue_environments/index.md | 242 + .../queue_environments_list_only/index.md | 77 + .../queue_fleet_associations/index.md | 209 + .../index.md | 77 + .../services/deadline/queue_tags/index.md | 97 + .../docs/services/deadline/queues/index.md | 300 + .../deadline/queues_list_only/index.md | 73 + .../deadline/storage_profiles/index.md | 233 + .../storage_profiles_list_only/index.md | 75 + .../services/detective/graph_tags/index.md | 79 + .../docs/services/detective/graphs/index.md | 220 + .../detective/graphs_list_only/index.md | 73 + website/docs/services/detective/index.md | 42 + .../detective/member_invitations/index.md | 218 + .../member_invitations_list_only/index.md | 75 + .../detective/organization_admins/index.md | 197 + .../organization_admins_list_only/index.md | 73 + website/docs/services/devopsguru/index.md | 41 + .../index.md | 200 + .../index.md | 73 + .../devopsguru/notification_channels/index.md | 199 + .../notification_channels_list_only/index.md | 73 + .../devopsguru/resource_collections/index.md | 207 + .../resource_collections_list_only/index.md | 73 + .../docs/services/directoryservice/index.md | 37 + .../directoryservice/simple_ads/index.md | 281 + .../simple_ads_list_only/index.md | 73 + .../services/dms/data_migration_tags/index.md | 93 + .../services/dms/data_migrations/index.md | 273 + .../dms/data_migrations_list_only/index.md | 73 + .../services/dms/data_provider_tags/index.md | 91 + .../docs/services/dms/data_providers/index.md | 310 + .../dms/data_providers_list_only/index.md | 73 + website/docs/services/dms/index.md | 50 + .../dms/instance_profile_tags/index.md | 97 + .../services/dms/instance_profiles/index.md | 296 + .../dms/instance_profiles_list_only/index.md | 73 + .../dms/migration_project_tags/index.md | 99 + .../services/dms/migration_projects/index.md | 320 + .../dms/migration_projects_list_only/index.md | 73 + .../dms/replication_config_tags/index.md | 95 + .../services/dms/replication_configs/index.md | 301 + .../replication_configs_list_only/index.md | 73 + .../docdbelastic/cluster_tags/index.md | 105 + .../services/docdbelastic/clusters/index.md | 357 + .../docdbelastic/clusters_list_only/index.md | 73 + website/docs/services/docdbelastic/index.md | 38 + .../services/dynamodb/global_tables/index.md | 461 + .../dynamodb/global_tables_list_only/index.md | 73 + website/docs/services/dynamodb/index.md | 40 + .../services/dynamodb/table_tags/index.md | 117 + .../docs/services/dynamodb/tables/index.md | 448 + .../dynamodb/tables_list_only/index.md | 73 + .../ec2/capacity_reservation_fleets/index.md | 309 + .../index.md | 73 + .../ec2/capacity_reservations/index.md | 316 + .../capacity_reservations_list_only/index.md | 73 + .../ec2/carrier_gateway_tags/index.md | 83 + .../services/ec2/carrier_gateways/index.md | 219 + .../ec2/carrier_gateways_list_only/index.md | 73 + .../ec2/customer_gateway_tags/index.md | 89 + .../services/ec2/customer_gateways/index.md | 248 + .../ec2/customer_gateways_list_only/index.md | 73 + .../docs/services/ec2/dhcp_options/index.md | 263 + .../ec2/dhcp_options_list_only/index.md | 73 + .../services/ec2/dhcp_options_tags/index.md | 89 + website/docs/services/ec2/ec2fleets/index.md | 382 + .../services/ec2/ec2fleets_list_only/index.md | 73 + .../egress_only_internet_gateways/index.md | 190 + .../index.md | 73 + .../services/ec2/eip_associations/index.md | 225 + .../ec2/eip_associations_list_only/index.md | 73 + website/docs/services/ec2/eip_tags/index.md | 93 + website/docs/services/ec2/eips/index.md | 275 + .../docs/services/ec2/eips_list_only/index.md | 75 + .../index.md | 204 + .../index.md | 75 + .../docs/services/ec2/flow_log_tags/index.md | 99 + website/docs/services/ec2/flow_logs/index.md | 291 + .../services/ec2/flow_logs_list_only/index.md | 73 + .../gateway_route_table_associations/index.md | 190 + website/docs/services/ec2/hosts/index.md | 249 + .../services/ec2/hosts_list_only/index.md | 73 + website/docs/services/ec2/index.md | 251 + .../instance_connect_endpoint_tags/index.md | 85 + .../ec2/instance_connect_endpoints/index.md | 235 + .../index.md | 73 + .../docs/services/ec2/instance_tags/index.md | 167 + website/docs/services/ec2/instances/index.md | 722 ++ .../services/ec2/instances_list_only/index.md | 73 + .../ec2/internet_gateway_tags/index.md | 77 + .../services/ec2/internet_gateways/index.md | 204 + .../ec2/internet_gateways_list_only/index.md | 73 + .../services/ec2/ipam_allocations/index.md | 209 + .../ec2/ipam_allocations_list_only/index.md | 77 + .../services/ec2/ipam_pool_cidrs/index.md | 206 + .../ec2/ipam_pool_cidrs_list_only/index.md | 76 + .../docs/services/ec2/ipam_pool_tags/index.md | 121 + website/docs/services/ec2/ipam_pools/index.md | 348 + .../ec2/ipam_pools_list_only/index.md | 73 + .../ec2/ipam_resource_discoveries/index.md | 236 + .../index.md | 73 + .../index.md | 95 + .../index.md | 242 + .../index.md | 73 + .../ec2/ipam_resource_discovery_tags/index.md | 91 + .../services/ec2/ipam_scope_tags/index.md | 91 + .../docs/services/ec2/ipam_scopes/index.md | 235 + .../ec2/ipam_scopes_list_only/index.md | 73 + website/docs/services/ec2/ipam_tags/index.md | 99 + website/docs/services/ec2/ipams/index.md | 257 + .../services/ec2/ipams_list_only/index.md | 73 + .../docs/services/ec2/key_pair_tags/index.md | 87 + website/docs/services/ec2/key_pairs/index.md | 225 + .../services/ec2/key_pairs_list_only/index.md | 73 + .../services/ec2/launch_templates/index.md | 401 + .../ec2/launch_templates_list_only/index.md | 73 + .../local_gateway_route_table_tags/index.md | 89 + .../index.md | 89 + .../index.md | 233 + .../index.md | 73 + .../ec2/local_gateway_route_tables/index.md | 231 + .../index.md | 73 + .../index.md | 85 + .../index.md | 227 + .../index.md | 73 + .../ec2/local_gateway_routes/index.md | 231 + .../local_gateway_routes_list_only/index.md | 75 + .../services/ec2/nat_gateway_tags/index.md | 93 + .../docs/services/ec2/nat_gateways/index.md | 266 + .../ec2/nat_gateways_list_only/index.md | 73 + .../services/ec2/network_acl_tags/index.md | 79 + .../docs/services/ec2/network_acls/index.md | 213 + .../ec2/network_acls_list_only/index.md | 73 + .../index.md | 238 + .../index.md | 73 + .../index.md | 93 + .../index.md | 87 + .../network_insights_access_scopes/index.md | 258 + .../index.md | 73 + .../ec2/network_insights_analyses/index.md | 265 + .../index.md | 73 + .../network_insights_analysis_tags/index.md | 103 + .../ec2/network_insights_path_tags/index.md | 101 + .../ec2/network_insights_paths/index.md | 279 + .../network_insights_paths_list_only/index.md | 73 + .../network_interface_attachments/index.md | 238 + .../index.md | 73 + .../ec2/network_interface_tags/index.md | 117 + .../services/ec2/network_interfaces/index.md | 345 + .../ec2/network_interfaces_list_only/index.md | 73 + .../index.md | 213 + .../index.md | 79 + .../ec2/placement_group_tags/index.md | 83 + .../services/ec2/placement_groups/index.md | 219 + .../ec2/placement_groups_list_only/index.md | 73 + .../services/ec2/prefix_list_tags/index.md | 91 + .../docs/services/ec2/prefix_lists/index.md | 249 + .../ec2/prefix_lists_list_only/index.md | 73 + .../services/ec2/route_table_tags/index.md | 79 + .../docs/services/ec2/route_tables/index.md | 211 + .../ec2/route_tables_list_only/index.md | 73 + website/docs/services/ec2/routes/index.md | 300 + .../services/ec2/routes_list_only/index.md | 75 + .../ec2/security_group_egresses/index.md | 258 + .../index.md | 73 + .../ec2/security_group_ingresses/index.md | 277 + .../index.md | 73 + .../services/ec2/security_group_tags/index.md | 89 + .../security_group_vpc_associations/index.md | 204 + .../index.md | 75 + .../services/ec2/security_groups/index.md | 268 + .../ec2/security_groups_list_only/index.md | 73 + .../snapshot_block_public_accesses/index.md | 200 + .../index.md | 73 + .../docs/services/ec2/spot_fleets/index.md | 355 + .../ec2/spot_fleets_list_only/index.md | 73 + .../services/ec2/subnet_cidr_blocks/index.md | 216 + .../ec2/subnet_cidr_blocks_list_only/index.md | 73 + .../subnet_network_acl_associations/index.md | 198 + .../index.md | 73 + .../subnet_route_table_associations/index.md | 201 + .../index.md | 73 + .../docs/services/ec2/subnet_tags/index.md | 113 + website/docs/services/ec2/subnets/index.md | 331 + .../services/ec2/subnets_list_only/index.md | 73 + .../transit_gateway_attachment_tags/index.md | 85 + .../ec2/transit_gateway_attachments/index.md | 274 + .../index.md | 73 + .../ec2/transit_gateway_connect_tags/index.md | 87 + .../ec2/transit_gateway_connects/index.md | 231 + .../index.md | 73 + .../index.md | 213 + .../index.md | 77 + .../index.md | 87 + .../index.md | 231 + .../index.md | 73 + .../index.md | 225 + .../index.md | 77 + .../index.md | 225 + .../index.md | 77 + .../index.md | 91 + .../index.md | 248 + .../index.md | 73 + .../index.md | 195 + .../index.md | 75 + .../index.md | 195 + .../index.md | 75 + .../transit_gateway_route_table_tags/index.md | 79 + .../ec2/transit_gateway_route_tables/index.md | 213 + .../index.md | 73 + .../ec2/transit_gateway_routes/index.md | 209 + .../transit_gateway_routes_list_only/index.md | 75 + .../ec2/transit_gateway_tags/index.md | 103 + .../index.md | 89 + .../transit_gateway_vpc_attachments/index.md | 290 + .../index.md | 73 + .../services/ec2/transit_gateways/index.md | 346 + .../ec2/transit_gateways_list_only/index.md | 73 + .../verified_access_endpoint_tags/index.md | 115 + .../ec2/verified_access_endpoints/index.md | 478 + .../index.md | 73 + .../ec2/verified_access_group_tags/index.md | 95 + .../ec2/verified_access_groups/index.md | 289 + .../verified_access_groups_list_only/index.md | 73 + .../verified_access_instance_tags/index.md | 91 + .../ec2/verified_access_instances/index.md | 353 + .../index.md | 73 + .../index.md | 97 + .../verified_access_trust_providers/index.md | 308 + .../index.md | 73 + .../services/ec2/volume_attachments/index.md | 202 + .../ec2/volume_attachments_list_only/index.md | 75 + .../docs/services/ec2/volume_tags/index.md | 99 + website/docs/services/ec2/volumes/index.md | 296 + .../services/ec2/volumes_list_only/index.md | 73 + .../index.md | 83 + .../index.md | 226 + .../index.md | 73 + .../vpc_block_public_access_options/index.md | 182 + .../services/ec2/vpc_cidr_blocks/index.md | 259 + .../ec2/vpc_cidr_blocks_list_only/index.md | 75 + .../index.md | 222 + .../index.md | 73 + .../vpc_endpoint_service_permissions/index.md | 217 + .../index.md | 73 + .../ec2/vpc_endpoint_service_tags/index.md | 87 + .../ec2/vpc_endpoint_services/index.md | 265 + .../vpc_endpoint_services_list_only/index.md | 73 + .../services/ec2/vpc_endpoint_tags/index.md | 107 + .../docs/services/ec2/vpc_endpoints/index.md | 323 + .../ec2/vpc_endpoints_list_only/index.md | 73 + .../ec2/vpc_gateway_attachments/index.md | 224 + .../index.md | 75 + .../ec2/vpc_peering_connection_tags/index.md | 87 + .../ec2/vpc_peering_connections/index.md | 243 + .../index.md | 73 + website/docs/services/ec2/vpc_tags/index.md | 97 + .../ec2/vpcdhcp_options_associations/index.md | 203 + .../index.md | 75 + website/docs/services/ec2/vpcs/index.md | 275 + .../docs/services/ec2/vpcs_list_only/index.md | 73 + .../ec2/vpn_connection_routes/index.md | 195 + .../vpn_connection_routes_list_only/index.md | 75 + .../services/ec2/vpn_connection_tags/index.md | 105 + .../services/ec2/vpn_connections/index.md | 335 + .../ec2/vpn_connections_list_only/index.md | 73 + .../services/ec2/vpn_gateway_tags/index.md | 81 + .../docs/services/ec2/vpn_gateways/index.md | 218 + .../ec2/vpn_gateways_list_only/index.md | 73 + website/docs/services/ecr/index.md | 49 + .../services/ecr/public_repositories/index.md | 243 + .../public_repositories_list_only/index.md | 73 + .../ecr/public_repository_tags/index.md | 83 + .../ecr/pull_through_cache_rules/index.md | 230 + .../index.md | 73 + .../services/ecr/registry_policies/index.md | 199 + .../ecr/registry_policies_list_only/index.md | 73 + .../ecr/replication_configurations/index.md | 204 + .../index.md | 73 + .../docs/services/ecr/repositories/index.md | 292 + .../ecr/repositories_list_only/index.md | 73 + .../repository_creation_templates/index.md | 274 + .../index.md | 73 + .../services/ecr/repository_tags/index.md | 93 + .../index.md | 221 + .../index.md | 73 + website/docs/services/ecs/index.md | 45 + .../services/ecs/primary_task_sets/index.md | 171 + .../docs/services/ecs/service_tags/index.md | 127 + website/docs/services/ecs/services/index.md | 501 + .../services/ecs/services_list_only/index.md | 75 + .../ecs/task_definition_tags/index.md | 111 + .../services/ecs/task_definitions/index.md | 514 + .../ecs/task_definitions_list_only/index.md | 73 + website/docs/services/ecs/task_sets/index.md | 275 + .../docs/services/efs/access_points/index.md | 245 + .../efs/access_points_list_only/index.md | 73 + .../docs/services/efs/file_systems/index.md | 368 + .../efs/file_systems_list_only/index.md | 73 + website/docs/services/efs/index.md | 41 + .../docs/services/efs/mount_targets/index.md | 229 + .../efs/mount_targets_list_only/index.md | 73 + .../docs/services/eks/access_entries/index.md | 261 + .../eks/access_entries_list_only/index.md | 75 + .../services/eks/access_entry_tags/index.md | 89 + website/docs/services/eks/addon_tags/index.md | 93 + website/docs/services/eks/addons/index.md | 279 + .../services/eks/addons_list_only/index.md | 75 + .../docs/services/eks/cluster_tags/index.md | 119 + website/docs/services/eks/clusters/index.md | 389 + .../services/eks/clusters_list_only/index.md | 73 + .../eks/fargate_profile_tags/index.md | 87 + .../services/eks/fargate_profiles/index.md | 252 + .../eks/fargate_profiles_list_only/index.md | 75 + .../identity_provider_config_tags/index.md | 85 + .../eks/identity_provider_configs/index.md | 244 + .../index.md | 77 + website/docs/services/eks/index.md | 56 + .../docs/services/eks/nodegroup_tags/index.md | 115 + website/docs/services/eks/nodegroups/index.md | 372 + .../eks/nodegroups_list_only/index.md | 73 + .../pod_identity_association_tags/index.md | 87 + .../eks/pod_identity_associations/index.md | 246 + .../index.md | 73 + .../global_replication_groups/index.md | 281 + .../index.md | 73 + website/docs/services/elasticache/index.md | 52 + .../elasticache/parameter_group_tags/index.md | 83 + .../elasticache/parameter_groups/index.md | 235 + .../parameter_groups_list_only/index.md | 73 + .../serverless_cache_tags/index.md | 113 + .../elasticache/serverless_caches/index.md | 342 + .../serverless_caches_list_only/index.md | 73 + .../elasticache/subnet_group_tags/index.md | 81 + .../elasticache/subnet_groups/index.md | 229 + .../subnet_groups_list_only/index.md | 73 + .../elasticache/user_group_tags/index.md | 85 + .../services/elasticache/user_groups/index.md | 240 + .../user_groups_list_only/index.md | 73 + .../services/elasticache/user_tags/index.md | 93 + .../docs/services/elasticache/users/index.md | 269 + .../elasticache/users_list_only/index.md | 73 + .../application_versions/index.md | 218 + .../application_versions_list_only/index.md | 75 + .../elasticbeanstalk/applications/index.md | 223 + .../applications_list_only/index.md | 73 + .../configuration_templates/index.md | 246 + .../index.md | 75 + .../environment_tags/index.md | 99 + .../elasticbeanstalk/environments/index.md | 302 + .../environments_list_only/index.md | 73 + .../docs/services/elasticbeanstalk/index.md | 44 + .../services/elasticloadbalancingv2/index.md | 50 + .../listener_rules/index.md | 296 + .../listener_rules_list_only/index.md | 73 + .../elasticloadbalancingv2/listeners/index.md | 314 + .../listeners_list_only/index.md | 73 + .../load_balancer_tags/index.md | 107 + .../load_balancers/index.md | 333 + .../load_balancers_list_only/index.md | 73 + .../target_group_tags/index.md | 119 + .../target_groups/index.md | 393 + .../target_groups_list_only/index.md | 73 + .../trust_store_revocations/index.md | 207 + .../index.md | 75 + .../trust_store_tags/index.md | 89 + .../trust_stores/index.md | 253 + .../trust_stores_list_only/index.md | 73 + website/docs/services/emr/index.md | 45 + .../emr/security_configurations/index.md | 192 + .../index.md | 73 + .../emr/studio_session_mappings/index.md | 271 + .../index.md | 77 + .../docs/services/emr/studio_tags/index.md | 113 + website/docs/services/emr/studios/index.md | 343 + .../services/emr/studios_list_only/index.md | 73 + .../services/emr/wal_workspace_tags/index.md | 77 + .../docs/services/emr/wal_workspaces/index.md | 209 + .../emr/wal_workspaces_list_only/index.md | 73 + website/docs/services/emrcontainers/index.md | 38 + .../virtual_cluster_tags/index.md | 83 + .../emrcontainers/virtual_clusters/index.md | 229 + .../virtual_clusters_list_only/index.md | 73 + .../emrserverless/application_tags/index.md | 109 + .../emrserverless/applications/index.md | 402 + .../applications_list_only/index.md | 73 + website/docs/services/emrserverless/index.md | 38 + .../id_mapping_workflow_tags/index.md | 93 + .../id_mapping_workflows/index.md | 287 + .../id_mapping_workflows_list_only/index.md | 73 + .../id_namespace_tags/index.md | 93 + .../entityresolution/id_namespaces/index.md | 274 + .../id_namespaces_list_only/index.md | 73 + .../docs/services/entityresolution/index.md | 49 + .../matching_workflow_tags/index.md | 95 + .../matching_workflows/index.md | 314 + .../matching_workflows_list_only/index.md | 73 + .../policy_statements/index.md | 235 + .../policy_statements_list_only/index.md | 75 + .../schema_mapping_tags/index.md | 89 + .../entityresolution/schema_mappings/index.md | 245 + .../schema_mappings_list_only/index.md | 73 + .../services/events/api_destinations/index.md | 239 + .../api_destinations_list_only/index.md | 73 + .../docs/services/events/archives/index.md | 228 + .../events/archives_list_only/index.md | 73 + .../docs/services/events/connections/index.md | 274 + .../events/connections_list_only/index.md | 73 + .../docs/services/events/endpoints/index.md | 260 + .../events/endpoints_list_only/index.md | 73 + .../services/events/event_bus_tags/index.md | 89 + .../docs/services/events/event_buses/index.md | 263 + .../events/event_buses_list_only/index.md | 73 + website/docs/services/events/index.md | 48 + website/docs/services/events/rules/index.md | 352 + .../services/events/rules_list_only/index.md | 73 + .../eventschemas/discoverer_tags/index.md | 87 + .../eventschemas/discoverers/index.md | 243 + .../discoverers_list_only/index.md | 73 + website/docs/services/eventschemas/index.md | 45 + .../services/eventschemas/registries/index.md | 224 + .../registries_list_only/index.md | 73 + .../eventschemas/registry_policies/index.md | 197 + .../eventschemas/registry_tags/index.md | 81 + .../eventschemas/schema_tags/index.md | 93 + .../services/eventschemas/schemata/index.md | 256 + .../eventschemas/schemata_list_only/index.md | 73 + .../services/evidently/experiments/index.md | 284 + .../docs/services/evidently/features/index.md | 243 + website/docs/services/evidently/index.md | 42 + .../docs/services/evidently/launches/index.md | 268 + .../docs/services/evidently/projects/index.md | 265 + .../services/evidently/segment_tags/index.md | 83 + .../docs/services/evidently/segments/index.md | 216 + .../evidently/segments_list_only/index.md | 73 + .../finspace/environment_tags/index.md | 103 + .../services/finspace/environments/index.md | 282 + .../finspace/environments_list_only/index.md | 73 + website/docs/services/finspace/index.md | 38 + .../fis/experiment_template_tags/index.md | 93 + .../fis/experiment_templates/index.md | 287 + .../experiment_templates_list_only/index.md | 73 + website/docs/services/fis/index.md | 40 + .../target_account_configurations/index.md | 219 + .../index.md | 75 + website/docs/services/fms/index.md | 43 + .../fms/notification_channels/index.md | 205 + .../notification_channels_list_only/index.md | 73 + website/docs/services/fms/policies/index.md | 360 + .../services/fms/policies_list_only/index.md | 73 + .../docs/services/fms/policy_tags/index.md | 105 + .../services/fms/resource_set_tags/index.md | 85 + .../docs/services/fms/resource_sets/index.md | 243 + .../fms/resource_sets_list_only/index.md | 73 + .../forecast/dataset_group_tags/index.md | 83 + .../services/forecast/dataset_groups/index.md | 223 + .../dataset_groups_list_only/index.md | 73 + .../services/forecast/dataset_tags/index.md | 89 + .../docs/services/forecast/datasets/index.md | 242 + .../forecast/datasets_list_only/index.md | 73 + website/docs/services/forecast/index.md | 41 + .../frauddetector/detector_tags/index.md | 97 + .../services/frauddetector/detectors/index.md | 397 + .../detectors_list_only/index.md | 73 + .../frauddetector/event_type_tags/index.md | 91 + .../frauddetector/event_types/index.md | 317 + .../event_types_list_only/index.md | 73 + website/docs/services/frauddetector/index.md | 53 + .../frauddetector/label_tags/index.md | 85 + .../services/frauddetector/labels/index.md | 229 + .../frauddetector/labels_list_only/index.md | 73 + .../services/frauddetector/list_tags/index.md | 89 + .../services/frauddetector/lists/index.md | 249 + .../frauddetector/lists_list_only/index.md | 73 + .../frauddetector/outcome_tags/index.md | 85 + .../services/frauddetector/outcomes/index.md | 229 + .../frauddetector/outcomes_list_only/index.md | 73 + .../frauddetector/variable_tags/index.md | 93 + .../services/frauddetector/variables/index.md | 263 + .../variables_list_only/index.md | 73 + .../data_repository_association_tags/index.md | 91 + .../fsx/data_repository_associations/index.md | 269 + .../index.md | 73 + website/docs/services/fsx/index.md | 38 + .../docs/services/gamelift/aliases/index.md | 216 + .../gamelift/aliases_list_only/index.md | 73 + .../docs/services/gamelift/builds/index.md | 231 + .../gamelift/builds_list_only/index.md | 73 + .../gamelift/container_fleet_tags/index.md | 123 + .../gamelift/container_fleets/index.md | 399 + .../container_fleets_list_only/index.md | 73 + .../container_group_definition_tags/index.md | 103 + .../container_group_definitions/index.md | 331 + .../index.md | 73 + .../docs/services/gamelift/fleets/index.md | 444 + .../gamelift/fleets_list_only/index.md | 73 + .../gamelift/game_server_group_tags/index.md | 101 + .../gamelift/game_server_groups/index.md | 341 + .../game_server_groups_list_only/index.md | 73 + .../gamelift/game_session_queue_tags/index.md | 93 + .../gamelift/game_session_queues/index.md | 271 + .../game_session_queues_list_only/index.md | 73 + website/docs/services/gamelift/index.md | 65 + .../services/gamelift/location_tags/index.md | 79 + .../docs/services/gamelift/locations/index.md | 213 + .../gamelift/locations_list_only/index.md | 73 + .../matchmaking_configuration_tags/index.md | 109 + .../matchmaking_configurations/index.md | 329 + .../index.md | 73 + .../matchmaking_rule_set_tags/index.md | 83 + .../gamelift/matchmaking_rule_sets/index.md | 227 + .../matchmaking_rule_sets_list_only/index.md | 73 + .../services/gamelift/script_tags/index.md | 89 + .../docs/services/gamelift/scripts/index.md | 245 + .../gamelift/scripts_list_only/index.md | 73 + .../accelerator_tags/index.md | 93 + .../globalaccelerator/accelerators/index.md | 247 + .../accelerators_list_only/index.md | 73 + .../cross_account_attachment_tags/index.md | 83 + .../cross_account_attachments/index.md | 230 + .../index.md | 73 + .../endpoint_groups/index.md | 278 + .../endpoint_groups_list_only/index.md | 73 + .../docs/services/globalaccelerator/index.md | 45 + .../globalaccelerator/listeners/index.md | 230 + .../listeners_list_only/index.md | 73 + .../docs/services/glue/crawler_tags/index.md | 101 + website/docs/services/glue/crawlers/index.md | 346 + .../services/glue/crawlers_list_only/index.md | 73 + website/docs/services/glue/databases/index.md | 249 + .../glue/databases_list_only/index.md | 73 + website/docs/services/glue/index.md | 53 + website/docs/services/glue/job_tags/index.md | 119 + website/docs/services/glue/jobs/index.md | 369 + .../services/glue/jobs_list_only/index.md | 73 + .../glue/schema_version_metadata/index.md | 202 + .../index.md | 77 + .../services/glue/schema_versions/index.md | 202 + .../glue/schema_versions_list_only/index.md | 73 + .../docs/services/glue/trigger_tags/index.md | 93 + website/docs/services/glue/triggers/index.md | 281 + .../services/glue/triggers_list_only/index.md | 73 + .../services/glue/usage_profile_tags/index.md | 83 + .../services/glue/usage_profiles/index.md | 229 + .../glue/usage_profiles_list_only/index.md | 73 + website/docs/services/grafana/index.md | 37 + .../docs/services/grafana/workspaces/index.md | 401 + .../grafana/workspaces_list_only/index.md | 73 + .../component_version_tags/index.md | 85 + .../greengrassv2/component_versions/index.md | 265 + .../component_versions_list_only/index.md | 73 + .../greengrassv2/deployment_tags/index.md | 89 + .../greengrassv2/deployments/index.md | 285 + .../deployments_list_only/index.md | 73 + website/docs/services/greengrassv2/index.md | 41 + .../groundstation/config_tags/index.md | 85 + .../services/groundstation/configs/index.md | 263 + .../groundstation/configs_list_only/index.md | 73 + .../dataflow_endpoint_group_tags/index.md | 85 + .../dataflow_endpoint_groups/index.md | 259 + .../index.md | 73 + website/docs/services/groundstation/index.md | 44 + .../mission_profile_tags/index.md | 97 + .../groundstation/mission_profiles/index.md | 287 + .../mission_profiles_list_only/index.md | 76 + .../services/guardduty/detector_tags/index.md | 85 + .../services/guardduty/detectors/index.md | 253 + .../guardduty/detectors_list_only/index.md | 73 + .../services/guardduty/filter_tags/index.md | 87 + .../docs/services/guardduty/filters/index.md | 253 + .../guardduty/filters_list_only/index.md | 75 + website/docs/services/guardduty/index.md | 54 + .../services/guardduty/ip_set_tags/index.md | 87 + .../docs/services/guardduty/ip_sets/index.md | 249 + .../guardduty/ip_sets_list_only/index.md | 75 + .../malware_protection_plan_tags/index.md | 91 + .../malware_protection_plans/index.md | 248 + .../index.md | 73 + .../docs/services/guardduty/masters/index.md | 202 + .../guardduty/masters_list_only/index.md | 75 + .../docs/services/guardduty/members/index.md | 237 + .../guardduty/members_list_only/index.md | 75 + .../guardduty/threat_intel_set_tags/index.md | 87 + .../guardduty/threat_intel_sets/index.md | 248 + .../threat_intel_sets_list_only/index.md | 75 + .../healthimaging/datastore_tags/index.md | 89 + .../healthimaging/datastores/index.md | 230 + .../datastores_list_only/index.md | 73 + website/docs/services/healthimaging/index.md | 38 + .../healthlake/fhir_datastore_tags/index.md | 95 + .../healthlake/fhir_datastores/index.md | 285 + .../fhir_datastores_list_only/index.md | 73 + website/docs/services/healthlake/index.md | 38 + .../docs/services/iam/group_policies/index.md | 194 + website/docs/services/iam/groups/index.md | 246 + .../services/iam/groups_list_only/index.md | 73 + website/docs/services/iam/index.md | 63 + .../services/iam/instance_profiles/index.md | 220 + .../iam/instance_profiles_list_only/index.md | 73 + .../services/iam/managed_policies/index.md | 284 + .../iam/managed_policies_list_only/index.md | 73 + .../services/iam/oidc_provider_tags/index.md | 83 + .../docs/services/iam/oidc_providers/index.md | 237 + .../iam/oidc_providers_list_only/index.md | 73 + .../docs/services/iam/role_policies/index.md | 194 + website/docs/services/iam/role_tags/index.md | 95 + website/docs/services/iam/roles/index.md | 287 + .../services/iam/roles_list_only/index.md | 73 + .../services/iam/saml_provider_tags/index.md | 81 + .../docs/services/iam/saml_providers/index.md | 220 + .../iam/saml_providers_list_only/index.md | 73 + .../iam/server_certificate_tags/index.md | 87 + .../services/iam/server_certificates/index.md | 250 + .../server_certificates_list_only/index.md | 73 + .../iam/service_linked_roles/index.md | 195 + .../docs/services/iam/user_policies/index.md | 194 + website/docs/services/iam/user_tags/index.md | 91 + website/docs/services/iam/users/index.md | 307 + .../services/iam/users_list_only/index.md | 73 + .../iam/virtualmfa_device_tags/index.md | 83 + .../services/iam/virtualmfa_devices/index.md | 225 + .../iam/virtualmfa_devices_list_only/index.md | 73 + .../identitystore/group_memberships/index.md | 208 + .../group_memberships_list_only/index.md | 75 + .../services/identitystore/groups/index.md | 216 + .../identitystore/groups_list_only/index.md | 75 + website/docs/services/identitystore/index.md | 39 + .../imagebuilder/component_tags/index.md | 99 + .../services/imagebuilder/components/index.md | 278 + .../components_list_only/index.md | 73 + .../container_recipe_tags/index.md | 105 + .../imagebuilder/container_recipes/index.md | 355 + .../container_recipes_list_only/index.md | 73 + .../distribution_configuration_tags/index.md | 83 + .../distribution_configurations/index.md | 273 + .../index.md | 73 + .../imagebuilder/image_pipeline_tags/index.md | 103 + .../imagebuilder/image_pipelines/index.md | 346 + .../image_pipelines_list_only/index.md | 73 + .../imagebuilder/image_recipe_tags/index.md | 93 + .../imagebuilder/image_recipes/index.md | 278 + .../image_recipes_list_only/index.md | 73 + .../services/imagebuilder/image_tags/index.md | 101 + .../services/imagebuilder/images/index.md | 306 + .../imagebuilder/images_list_only/index.md | 73 + website/docs/services/imagebuilder/index.md | 62 + .../index.md | 103 + .../infrastructure_configurations/index.md | 313 + .../index.md | 73 + .../imagebuilder/lifecycle_policies/index.md | 288 + .../lifecycle_policies_list_only/index.md | 73 + .../lifecycle_policy_tags/index.md | 91 + .../imagebuilder/workflow_tags/index.md | 93 + .../services/imagebuilder/workflows/index.md | 263 + .../imagebuilder/workflows_list_only/index.md | 73 + .../inspector/assessment_targets/index.md | 209 + .../assessment_targets_list_only/index.md | 73 + .../inspector/assessment_templates/index.md | 224 + .../assessment_templates_list_only/index.md | 73 + website/docs/services/inspector/index.md | 40 + .../inspector/resource_groups/index.md | 171 + .../cis_scan_configuration_tags/index.md | 85 + .../cis_scan_configurations/index.md | 241 + .../index.md | 73 + .../services/inspectorv2/filters/index.md | 273 + .../inspectorv2/filters_list_only/index.md | 73 + website/docs/services/inspectorv2/index.md | 40 + .../docs/services/internetmonitor/index.md | 38 + .../internetmonitor/monitor_tags/index.md | 107 + .../internetmonitor/monitors/index.md | 332 + .../monitors_list_only/index.md | 73 + website/docs/services/invoicing/index.md | 37 + .../services/invoicing/invoice_units/index.md | 247 + .../invoice_units_list_only/index.md | 73 + .../iot/account_audit_configurations/index.md | 245 + .../index.md | 73 + .../services/iot/authorizer_tags/index.md | 91 + .../docs/services/iot/authorizers/index.md | 258 + .../iot/authorizers_list_only/index.md | 73 + .../services/iot/billing_group_tags/index.md | 83 + .../docs/services/iot/billing_groups/index.md | 231 + .../iot/billing_groups_list_only/index.md | 73 + .../services/iot/ca_certificate_tags/index.md | 93 + .../services/iot/ca_certificates/index.md | 270 + .../iot/ca_certificates_list_only/index.md | 73 + .../iot/certificate_provider_tags/index.md | 83 + .../iot/certificate_providers/index.md | 232 + .../certificate_providers_list_only/index.md | 73 + .../docs/services/iot/certificates/index.md | 234 + .../iot/certificates_list_only/index.md | 73 + .../docs/services/iot/command_tags/index.md | 99 + website/docs/services/iot/commands/index.md | 299 + .../services/iot/commands_list_only/index.md | 73 + .../services/iot/custom_metric_tags/index.md | 83 + .../docs/services/iot/custom_metrics/index.md | 226 + .../iot/custom_metrics_list_only/index.md | 73 + .../docs/services/iot/dimension_tags/index.md | 83 + website/docs/services/iot/dimensions/index.md | 229 + .../iot/dimensions_list_only/index.md | 73 + .../iot/domain_configuration_tags/index.md | 105 + .../iot/domain_configurations/index.md | 309 + .../domain_configurations_list_only/index.md | 73 + .../services/iot/fleet_metric_tags/index.md | 101 + .../docs/services/iot/fleet_metrics/index.md | 282 + .../iot/fleet_metrics_list_only/index.md | 73 + website/docs/services/iot/index.md | 110 + .../services/iot/job_template_tags/index.md | 101 + .../docs/services/iot/job_templates/index.md | 447 + .../iot/job_templates_list_only/index.md | 73 + website/docs/services/iot/loggings/index.md | 217 + .../services/iot/loggings_list_only/index.md | 73 + .../iot/mitigation_action_tags/index.md | 85 + .../services/iot/mitigation_actions/index.md | 249 + .../iot/mitigation_actions_list_only/index.md | 73 + website/docs/services/iot/policies/index.md | 230 + .../services/iot/policies_list_only/index.md | 73 + .../docs/services/iot/policy_tags/index.md | 83 + .../iot/provisioning_template_tags/index.md | 91 + .../iot/provisioning_templates/index.md | 268 + .../provisioning_templates_list_only/index.md | 73 + .../iot/resource_specific_loggings/index.md | 218 + .../index.md | 73 + .../services/iot/role_alias_tags/index.md | 83 + .../docs/services/iot/role_aliases/index.md | 235 + .../iot/role_aliases_list_only/index.md | 73 + .../iot/scheduled_audit_tags/index.md | 87 + .../services/iot/scheduled_audits/index.md | 244 + .../iot/scheduled_audits_list_only/index.md | 73 + .../iot/security_profile_tags/index.md | 91 + .../services/iot/security_profiles/index.md | 295 + .../iot/security_profiles_list_only/index.md | 73 + .../iot/software_package_tags/index.md | 81 + .../software_package_version_tags/index.md | 89 + .../iot/software_package_versions/index.md | 245 + .../index.md | 75 + .../services/iot/software_packages/index.md | 234 + .../iot/software_packages_list_only/index.md | 73 + .../services/iot/thing_group_tags/index.md | 87 + .../docs/services/iot/thing_groups/index.md | 254 + .../iot/thing_groups_list_only/index.md | 73 + .../services/iot/thing_type_tags/index.md | 85 + .../docs/services/iot/thing_types/index.md | 250 + .../iot/thing_types_list_only/index.md | 73 + website/docs/services/iot/things/index.md | 213 + .../services/iot/things_list_only/index.md | 73 + .../iot/topic_rule_destinations/index.md | 231 + .../index.md | 73 + .../services/iot/topic_rule_tags/index.md | 81 + .../docs/services/iot/topic_rules/index.md | 379 + .../iot/topic_rules_list_only/index.md | 73 + .../iotanalytics/dataset_tags/index.md | 91 + .../services/iotanalytics/datasets/index.md | 296 + .../iotanalytics/datasets_list_only/index.md | 73 + website/docs/services/iotanalytics/index.md | 41 + .../iotanalytics/pipeline_tags/index.md | 81 + .../services/iotanalytics/pipelines/index.md | 263 + .../iotanalytics/pipelines_list_only/index.md | 73 + .../services/iotcoredeviceadvisor/index.md | 38 + .../suite_definition_tags/index.md | 83 + .../suite_definitions/index.md | 243 + .../suite_definitions_list_only/index.md | 73 + .../iotevents/alarm_model_tags/index.md | 91 + .../services/iotevents/alarm_models/index.md | 327 + .../iotevents/alarm_models_list_only/index.md | 73 + .../iotevents/detector_model_tags/index.md | 87 + .../iotevents/detector_models/index.md | 335 + .../detector_models_list_only/index.md | 73 + website/docs/services/iotevents/index.md | 44 + .../services/iotevents/input_tags/index.md | 81 + .../docs/services/iotevents/inputs/index.md | 228 + .../iotevents/inputs_list_only/index.md | 73 + .../iotfleethub/application_tags/index.md | 97 + .../iotfleethub/applications/index.md | 252 + .../applications_list_only/index.md | 73 + website/docs/services/iotfleethub/index.md | 38 + .../iotfleetwise/campaign_tags/index.md | 119 + .../services/iotfleetwise/campaigns/index.md | 376 + .../iotfleetwise/campaigns_list_only/index.md | 73 + .../decoder_manifest_tags/index.md | 95 + .../iotfleetwise/decoder_manifests/index.md | 274 + .../decoder_manifests_list_only/index.md | 73 + .../services/iotfleetwise/fleet_tags/index.md | 87 + .../services/iotfleetwise/fleets/index.md | 238 + .../iotfleetwise/fleets_list_only/index.md | 73 + website/docs/services/iotfleetwise/index.md | 56 + .../iotfleetwise/model_manifest_tags/index.md | 91 + .../iotfleetwise/model_manifests/index.md | 256 + .../model_manifests_list_only/index.md | 73 + .../iotfleetwise/signal_catalog_tags/index.md | 89 + .../iotfleetwise/signal_catalogs/index.md | 259 + .../signal_catalogs_list_only/index.md | 73 + .../iotfleetwise/state_template_tags/index.md | 93 + .../iotfleetwise/state_templates/index.md | 263 + .../state_templates_list_only/index.md | 73 + .../iotfleetwise/vehicle_tags/index.md | 91 + .../services/iotfleetwise/vehicles/index.md | 256 + .../iotfleetwise/vehicles_list_only/index.md | 73 + .../iotsitewise/access_policies/index.md | 251 + .../access_policies_list_only/index.md | 73 + .../iotsitewise/asset_model_tags/index.md | 93 + .../iotsitewise/asset_models/index.md | 329 + .../asset_models_list_only/index.md | 73 + .../services/iotsitewise/asset_tags/index.md | 91 + .../docs/services/iotsitewise/assets/index.md | 294 + .../iotsitewise/assets_list_only/index.md | 73 + .../iotsitewise/dashboard_tags/index.md | 87 + .../services/iotsitewise/dashboards/index.md | 252 + .../iotsitewise/dashboards_list_only/index.md | 73 + .../iotsitewise/gateway_tags/index.md | 83 + .../services/iotsitewise/gateways/index.md | 250 + .../iotsitewise/gateways_list_only/index.md | 73 + website/docs/services/iotsitewise/index.md | 55 + .../services/iotsitewise/portal_tags/index.md | 101 + .../services/iotsitewise/portals/index.md | 294 + .../iotsitewise/portals_list_only/index.md | 73 + .../iotsitewise/project_tags/index.md | 87 + .../services/iotsitewise/projects/index.md | 249 + .../iotsitewise/projects_list_only/index.md | 73 + .../iottwinmaker/component_type_tags/index.md | 105 + .../iottwinmaker/component_types/index.md | 294 + .../component_types_list_only/index.md | 75 + .../services/iottwinmaker/entities/index.md | 286 + .../iottwinmaker/entities_list_only/index.md | 75 + .../iottwinmaker/entity_tags/index.md | 99 + website/docs/services/iottwinmaker/index.md | 50 + .../services/iottwinmaker/scene_tags/index.md | 95 + .../services/iottwinmaker/scenes/index.md | 268 + .../iottwinmaker/scenes_list_only/index.md | 75 + .../iottwinmaker/sync_job_tags/index.md | 89 + .../services/iottwinmaker/sync_jobs/index.md | 232 + .../iottwinmaker/sync_jobs_list_only/index.md | 75 + .../iottwinmaker/workspace_tags/index.md | 89 + .../services/iottwinmaker/workspaces/index.md | 247 + .../workspaces_list_only/index.md | 73 + .../iotwireless/destination_tags/index.md | 87 + .../iotwireless/destinations/index.md | 246 + .../destinations_list_only/index.md | 73 + .../iotwireless/device_profile_tags/index.md | 83 + .../iotwireless/device_profiles/index.md | 241 + .../device_profiles_list_only/index.md | 73 + .../iotwireless/fuota_task_tags/index.md | 99 + .../services/iotwireless/fuota_tasks/index.md | 289 + .../fuota_tasks_list_only/index.md | 73 + website/docs/services/iotwireless/index.md | 68 + .../iotwireless/multicast_group_tags/index.md | 91 + .../iotwireless/multicast_groups/index.md | 252 + .../multicast_groups_list_only/index.md | 73 + .../index.md | 87 + .../network_analyzer_configurations/index.md | 244 + .../index.md | 73 + .../iotwireless/partner_account_tags/index.md | 91 + .../iotwireless/partner_accounts/index.md | 270 + .../partner_accounts_list_only/index.md | 73 + .../iotwireless/service_profile_tags/index.md | 83 + .../iotwireless/service_profiles/index.md | 240 + .../service_profiles_list_only/index.md | 73 + .../iotwireless/task_definition_tags/index.md | 89 + .../iotwireless/task_definitions/index.md | 256 + .../task_definitions_list_only/index.md | 73 + .../wireless_device_import_task_tags/index.md | 97 + .../wireless_device_import_tasks/index.md | 253 + .../index.md | 73 + .../iotwireless/wireless_device_tags/index.md | 97 + .../iotwireless/wireless_devices/index.md | 298 + .../wireless_devices_list_only/index.md | 73 + .../wireless_gateway_tags/index.md | 91 + .../iotwireless/wireless_gateways/index.md | 254 + .../wireless_gateways_list_only/index.md | 73 + .../docs/services/ivs/channel_tags/index.md | 95 + website/docs/services/ivs/channels/index.md | 262 + .../services/ivs/channels_list_only/index.md | 73 + .../ivs/encoder_configuration_tags/index.md | 81 + .../ivs/encoder_configurations/index.md | 224 + .../encoder_configurations_list_only/index.md | 73 + website/docs/services/ivs/index.md | 65 + .../ivs/ingest_configuration_tags/index.md | 93 + .../ivs/ingest_configurations/index.md | 251 + .../ingest_configurations_list_only/index.md | 73 + .../ivs/playback_key_pair_tags/index.md | 83 + .../services/ivs/playback_key_pairs/index.md | 226 + .../ivs/playback_key_pairs_list_only/index.md | 73 + .../playback_restriction_policies/index.md | 239 + .../index.md | 73 + .../playback_restriction_policy_tags/index.md | 85 + .../services/ivs/public_key_tags/index.md | 83 + .../docs/services/ivs/public_keys/index.md | 226 + .../ivs/public_keys_list_only/index.md | 73 + .../ivs/recording_configuration_tags/index.md | 89 + .../ivs/recording_configurations/index.md | 269 + .../index.md | 73 + website/docs/services/ivs/stage_tags/index.md | 83 + website/docs/services/ivs/stages/index.md | 233 + .../services/ivs/stages_list_only/index.md | 73 + .../ivs/storage_configuration_tags/index.md | 81 + .../ivs/storage_configurations/index.md | 230 + .../storage_configurations_list_only/index.md | 73 + .../services/ivs/stream_key_tags/index.md | 81 + .../docs/services/ivs/stream_keys/index.md | 217 + .../ivs/stream_keys_list_only/index.md | 73 + website/docs/services/ivschat/index.md | 41 + .../logging_configuration_tags/index.md | 85 + .../ivschat/logging_configurations/index.md | 258 + .../logging_configurations_list_only/index.md | 73 + .../docs/services/ivschat/room_tags/index.md | 89 + website/docs/services/ivschat/rooms/index.md | 247 + .../services/ivschat/rooms_list_only/index.md | 73 + .../kafkaconnect/connector_tags/index.md | 101 + .../services/kafkaconnect/connectors/index.md | 383 + .../connectors_list_only/index.md | 73 + .../kafkaconnect/custom_plugin_tags/index.md | 89 + .../kafkaconnect/custom_plugins/index.md | 253 + .../custom_plugins_list_only/index.md | 73 + website/docs/services/kafkaconnect/index.md | 44 + .../worker_configuration_tags/index.md | 85 + .../worker_configurations/index.md | 233 + .../worker_configurations_list_only/index.md | 73 + .../services/kendra/data_source_tags/index.md | 97 + .../services/kendra/data_sources/index.md | 492 + .../kendra/data_sources_list_only/index.md | 75 + .../docs/services/kendra/faq_tags/index.md | 93 + website/docs/services/kendra/faqs/index.md | 267 + .../services/kendra/faqs_list_only/index.md | 75 + website/docs/services/kendra/index.md | 44 + .../docs/services/kendra/index_tags/index.md | 97 + website/docs/services/kendra/indices/index.md | 310 + .../kendra/indices_list_only/index.md | 73 + .../execution_plan_tags/index.md | 85 + .../kendraranking/execution_plans/index.md | 234 + .../execution_plans_list_only/index.md | 73 + website/docs/services/kendraranking/index.md | 38 + website/docs/services/kinesis/index.md | 39 + .../kinesis/resource_policies/index.md | 188 + .../services/kinesis/stream_tags/index.md | 87 + .../docs/services/kinesis/streams/index.md | 267 + .../kinesis/streams_list_only/index.md | 73 + .../application_tags/index.md | 91 + .../kinesisanalyticsv2/applications/index.md | 353 + .../applications_list_only/index.md | 73 + .../docs/services/kinesisanalyticsv2/index.md | 38 + .../delivery_stream_tags/index.md | 109 + .../kinesisfirehose/delivery_streams/index.md | 621 ++ .../delivery_streams_list_only/index.md | 73 + .../docs/services/kinesisfirehose/index.md | 38 + website/docs/services/kinesisvideo/index.md | 37 + .../kinesisvideo/signaling_channels/index.md | 202 + .../services/kinesisvideo/streams/index.md | 215 + website/docs/services/kms/aliases/index.md | 203 + .../services/kms/aliases_list_only/index.md | 73 + website/docs/services/kms/index.md | 43 + website/docs/services/kms/key_tags/index.md | 101 + website/docs/services/kms/keys/index.md | 319 + .../docs/services/kms/keys_list_only/index.md | 73 + .../services/kms/replica_key_tags/index.md | 89 + .../docs/services/kms/replica_keys/index.md | 253 + .../kms/replica_keys_list_only/index.md | 73 + .../lakeformation/data_cells_filters/index.md | 237 + .../data_cells_filters_list_only/index.md | 79 + website/docs/services/lakeformation/index.md | 41 + .../principal_permissions/index.md | 226 + .../lakeformation/tag_associations/index.md | 204 + .../docs/services/lakeformation/tags/index.md | 211 + .../lakeformation/tags_list_only/index.md | 73 + website/docs/services/lambda/aliases/index.md | 253 + .../lambda/aliases_list_only/index.md | 73 + .../lambda/code_signing_config_tags/index.md | 85 + .../lambda/code_signing_configs/index.md | 231 + .../code_signing_configs_list_only/index.md | 73 + .../lambda/event_invoke_configs/index.md | 226 + .../event_invoke_configs_list_only/index.md | 75 + .../lambda/event_source_mapping_tags/index.md | 131 + .../lambda/event_source_mappings/index.md | 422 + .../event_source_mappings_list_only/index.md | 73 + .../services/lambda/function_tags/index.md | 129 + .../docs/services/lambda/functions/index.md | 460 + .../lambda/functions_list_only/index.md | 73 + website/docs/services/lambda/index.md | 58 + .../lambda/layer_version_permissions/index.md | 213 + .../index.md | 73 + .../services/lambda/layer_versions/index.md | 230 + .../lambda/layer_versions_list_only/index.md | 73 + .../docs/services/lambda/permissions/index.md | 240 + .../lambda/permissions_list_only/index.md | 75 + website/docs/services/lambda/urls/index.md | 240 + .../services/lambda/urls_list_only/index.md | 73 + .../docs/services/lambda/versions/index.md | 229 + .../lambda/versions_list_only/index.md | 73 + .../launchwizard/deployment_tags/index.md | 95 + .../launchwizard/deployments/index.md | 316 + .../deployments_list_only/index.md | 73 + website/docs/services/launchwizard/index.md | 38 + .../docs/services/lex/bot_aliases/index.md | 288 + .../lex/bot_aliases_list_only/index.md | 75 + .../docs/services/lex/bot_versions/index.md | 214 + .../lex/bot_versions_list_only/index.md | 75 + website/docs/services/lex/bots/index.md | 596 ++ .../docs/services/lex/bots_list_only/index.md | 73 + website/docs/services/lex/index.md | 43 + .../services/lex/resource_policies/index.md | 212 + .../lex/resource_policies_list_only/index.md | 73 + .../services/licensemanager/grants/index.md | 237 + .../licensemanager/grants_list_only/index.md | 73 + website/docs/services/licensemanager/index.md | 39 + .../services/licensemanager/licenses/index.md | 300 + .../licenses_list_only/index.md | 73 + .../docs/services/lightsail/alarms/index.md | 285 + .../lightsail/alarms_list_only/index.md | 73 + .../services/lightsail/bucket_tags/index.md | 93 + .../docs/services/lightsail/buckets/index.md | 267 + .../lightsail/buckets_list_only/index.md | 73 + .../lightsail/certificate_tags/index.md | 85 + .../services/lightsail/certificates/index.md | 232 + .../lightsail/certificates_list_only/index.md | 73 + .../lightsail/container_tags/index.md | 95 + .../services/lightsail/containers/index.md | 295 + .../lightsail/containers_list_only/index.md | 73 + .../services/lightsail/database_tags/index.md | 105 + .../services/lightsail/databases/index.md | 328 + .../lightsail/databases_list_only/index.md | 73 + .../lightsail/distribution_tags/index.md | 99 + .../services/lightsail/distributions/index.md | 315 + .../distributions_list_only/index.md | 73 + website/docs/services/lightsail/index.md | 62 + .../services/lightsail/instance_tags/index.md | 115 + .../services/lightsail/instances/index.md | 366 + .../lightsail/instances_list_only/index.md | 73 + .../lightsail/load_balancer_tags/index.md | 93 + .../load_balancer_tls_certificates/index.md | 251 + .../index.md | 75 + .../lightsail/load_balancers/index.md | 276 + .../load_balancers_list_only/index.md | 73 + .../services/lightsail/static_ips/index.md | 222 + .../lightsail/static_ips_list_only/index.md | 73 + .../services/location/api_key_tags/index.md | 97 + .../docs/services/location/api_keys/index.md | 321 + .../location/api_keys_list_only/index.md | 73 + .../geofence_collection_tags/index.md | 93 + .../location/geofence_collections/index.md | 256 + .../geofence_collections_list_only/index.md | 73 + website/docs/services/location/index.md | 55 + .../docs/services/location/map_tags/index.md | 91 + website/docs/services/location/maps/index.md | 250 + .../services/location/maps_list_only/index.md | 73 + .../location/place_index_tags/index.md | 93 + .../services/location/place_indices/index.md | 254 + .../location/place_indices_list_only/index.md | 73 + .../location/route_calculator_tags/index.md | 91 + .../location/route_calculators/index.md | 246 + .../route_calculators_list_only/index.md | 73 + .../location/tracker_consumers/index.md | 195 + .../tracker_consumers_list_only/index.md | 75 + .../services/location/tracker_tags/index.md | 99 + .../docs/services/location/trackers/index.md | 277 + .../location/trackers_list_only/index.md | 73 + .../services/logs/account_policies/index.md | 261 + .../logs/account_policies_list_only/index.md | 77 + .../docs/services/logs/deliveries/index.md | 263 + .../logs/deliveries_list_only/index.md | 73 + .../logs/delivery_destination_tags/index.md | 87 + .../logs/delivery_destinations/index.md | 247 + .../delivery_destinations_list_only/index.md | 73 + .../logs/delivery_source_tags/index.md | 87 + .../services/logs/delivery_sources/index.md | 238 + .../logs/delivery_sources_list_only/index.md | 73 + .../docs/services/logs/delivery_tags/index.md | 93 + .../docs/services/logs/destinations/index.md | 228 + .../logs/destinations_list_only/index.md | 73 + website/docs/services/logs/index.md | 64 + .../docs/services/logs/integrations/index.md | 251 + .../logs/integrations_list_only/index.md | 73 + .../logs/log_anomaly_detectors/index.md | 249 + .../log_anomaly_detectors_list_only/index.md | 73 + .../docs/services/logs/log_streams/index.md | 192 + .../logs/log_streams_list_only/index.md | 75 + .../services/logs/metric_filters/index.md | 236 + .../logs/metric_filters_list_only/index.md | 75 + .../services/logs/query_definitions/index.md | 221 + .../logs/query_definitions_list_only/index.md | 73 + .../services/logs/resource_policies/index.md | 206 + .../logs/resource_policies_list_only/index.md | 73 + .../logs/subscription_filters/index.md | 244 + .../subscription_filters_list_only/index.md | 75 + .../docs/services/logs/transformers/index.md | 297 + .../logs/transformers_list_only/index.md | 73 + .../docs/services/lookoutequipment/index.md | 38 + .../inference_scheduler_tags/index.md | 93 + .../inference_schedulers/index.md | 281 + .../inference_schedulers_list_only/index.md | 73 + .../services/lookoutmetrics/alerts/index.md | 226 + .../lookoutmetrics/alerts_list_only/index.md | 73 + .../lookoutmetrics/anomaly_detectors/index.md | 295 + .../anomaly_detectors_list_only/index.md | 73 + website/docs/services/lookoutmetrics/index.md | 39 + website/docs/services/lookoutvision/index.md | 37 + .../services/lookoutvision/projects/index.md | 187 + .../lookoutvision/projects_list_only/index.md | 73 + .../services/m2/application_tags/index.md | 91 + .../docs/services/m2/applications/index.md | 263 + .../m2/applications_list_only/index.md | 73 + website/docs/services/m2/deployments/index.md | 256 + .../m2/deployments_list_only/index.md | 73 + .../services/m2/environment_tags/index.md | 105 + .../docs/services/m2/environments/index.md | 326 + .../m2/environments_list_only/index.md | 73 + website/docs/services/m2/index.md | 43 + .../services/macie/allow_list_tags/index.md | 87 + .../docs/services/macie/allow_lists/index.md | 233 + .../macie/allow_lists_list_only/index.md | 73 + .../custom_data_identifier_tags/index.md | 91 + .../macie/custom_data_identifiers/index.md | 252 + .../index.md | 73 + .../macie/findings_filter_tags/index.md | 89 + .../services/macie/findings_filters/index.md | 245 + .../macie/findings_filters_list_only/index.md | 73 + website/docs/services/macie/index.md | 46 + website/docs/services/macie/sessions/index.md | 211 + .../macie/sessions_list_only/index.md | 73 + .../managedblockchain/accessor_tags/index.md | 89 + .../managedblockchain/accessors/index.md | 230 + .../accessors_list_only/index.md | 73 + .../docs/services/managedblockchain/index.md | 38 + .../mediaconnect/bridge_outputs/index.md | 200 + .../mediaconnect/bridge_sources/index.md | 208 + .../services/mediaconnect/bridges/index.md | 278 + .../mediaconnect/bridges_list_only/index.md | 73 + .../mediaconnect/flow_entitlements/index.md | 258 + .../flow_entitlements_list_only/index.md | 73 + .../mediaconnect/flow_outputs/index.md | 328 + .../flow_outputs_list_only/index.md | 73 + .../mediaconnect/flow_sources/index.md | 341 + .../flow_sources_list_only/index.md | 73 + .../mediaconnect/flow_vpc_interfaces/index.md | 239 + .../flow_vpc_interfaces_list_only/index.md | 75 + .../docs/services/mediaconnect/flows/index.md | 336 + .../mediaconnect/flows_list_only/index.md | 73 + .../services/mediaconnect/gateways/index.md | 215 + .../mediaconnect/gateways_list_only/index.md | 73 + website/docs/services/mediaconnect/index.md | 51 + .../channel_placement_group_tags/index.md | 89 + .../channel_placement_groups/index.md | 245 + .../index.md | 75 + .../index.md | 89 + .../index.md | 228 + .../index.md | 74 + .../cloud_watch_alarm_template_tags/index.md | 111 + .../cloud_watch_alarm_templates/index.md | 319 + .../index.md | 74 + .../services/medialive/cluster_tags/index.md | 91 + .../docs/services/medialive/clusters/index.md | 263 + .../medialive/clusters_list_only/index.md | 73 + .../index.md | 89 + .../index.md | 228 + .../index.md | 74 + .../event_bridge_rule_template_tags/index.md | 97 + .../event_bridge_rule_templates/index.md | 257 + .../index.md | 74 + website/docs/services/medialive/index.md | 67 + .../medialive/multiplex_tags/index.md | 93 + .../services/medialive/multiplexes/index.md | 255 + .../medialive/multiplexes_list_only/index.md | 73 + .../medialive/multiplexprograms/index.md | 270 + .../multiplexprograms_list_only/index.md | 75 + .../services/medialive/network_tags/index.md | 89 + .../docs/services/medialive/networks/index.md | 243 + .../medialive/networks_list_only/index.md | 73 + .../medialive/sdi_source_tags/index.md | 89 + .../services/medialive/sdi_sources/index.md | 240 + .../medialive/sdi_sources_list_only/index.md | 73 + .../medialive/signal_map_tags/index.md | 117 + .../services/medialive/signal_maps/index.md | 360 + .../medialive/signal_maps_list_only/index.md | 74 + .../services/mediapackage/asset_tags/index.md | 91 + .../services/mediapackage/assets/index.md | 247 + .../mediapackage/assets_list_only/index.md | 73 + .../mediapackage/channel_tags/index.md | 87 + .../services/mediapackage/channels/index.md | 247 + .../mediapackage/channels_list_only/index.md | 73 + website/docs/services/mediapackage/index.md | 50 + .../origin_endpoint_tags/index.md | 105 + .../mediapackage/origin_endpoints/index.md | 359 + .../origin_endpoints_list_only/index.md | 73 + .../packaging_configuration_tags/index.md | 89 + .../packaging_configurations/index.md | 289 + .../index.md | 73 + .../packaging_group_tags/index.md | 85 + .../mediapackage/packaging_groups/index.md | 237 + .../packaging_groups_list_only/index.md | 73 + .../channel_group_tags/index.md | 87 + .../mediapackagev2/channel_groups/index.md | 227 + .../channel_groups_list_only/index.md | 73 + .../mediapackagev2/channel_policies/index.md | 196 + .../mediapackagev2/channel_tags/index.md | 93 + .../services/mediapackagev2/channels/index.md | 246 + .../channels_list_only/index.md | 73 + website/docs/services/mediapackagev2/index.md | 46 + .../origin_endpoint_policies/index.md | 204 + .../origin_endpoint_tags/index.md | 109 + .../mediapackagev2/origin_endpoints/index.md | 368 + .../origin_endpoints_list_only/index.md | 73 + .../mediatailor/channel_policies/index.md | 188 + .../mediatailor/channel_tags/index.md | 93 + .../services/mediatailor/channels/index.md | 286 + .../mediatailor/channels_list_only/index.md | 73 + website/docs/services/mediatailor/index.md | 51 + .../mediatailor/live_source_tags/index.md | 83 + .../mediatailor/live_sources/index.md | 233 + .../live_sources_list_only/index.md | 75 + .../playback_configuration_tags/index.md | 109 + .../playback_configurations/index.md | 330 + .../index.md | 73 + .../mediatailor/source_location_tags/index.md | 87 + .../mediatailor/source_locations/index.md | 257 + .../source_locations_list_only/index.md | 73 + .../mediatailor/vod_source_tags/index.md | 83 + .../services/mediatailor/vod_sources/index.md | 233 + .../vod_sources_list_only/index.md | 75 + .../docs/services/memorydb/acl_tags/index.md | 83 + website/docs/services/memorydb/acls/index.md | 228 + .../services/memorydb/acls_list_only/index.md | 73 + .../services/memorydb/cluster_tags/index.md | 133 + .../docs/services/memorydb/clusters/index.md | 406 + .../memorydb/clusters_list_only/index.md | 73 + website/docs/services/memorydb/index.md | 53 + .../multi_region_cluster_tags/index.md | 99 + .../memorydb/multi_region_clusters/index.md | 277 + .../multi_region_clusters_list_only/index.md | 73 + .../memorydb/parameter_group_tags/index.md | 85 + .../memorydb/parameter_groups/index.md | 239 + .../parameter_groups_list_only/index.md | 73 + .../memorydb/subnet_group_tags/index.md | 83 + .../services/memorydb/subnet_groups/index.md | 232 + .../memorydb/subnet_groups_list_only/index.md | 73 + .../docs/services/memorydb/user_tags/index.md | 85 + website/docs/services/memorydb/users/index.md | 236 + .../memorydb/users_list_only/index.md | 73 + .../services/msk/batch_scram_secrets/index.md | 220 + .../batch_scram_secrets_list_only/index.md | 73 + .../services/msk/cluster_policies/index.md | 209 + .../msk/cluster_policies_list_only/index.md | 73 + .../docs/services/msk/cluster_tags/index.md | 101 + website/docs/services/msk/clusters/index.md | 391 + .../services/msk/clusters_list_only/index.md | 73 + .../docs/services/msk/configurations/index.md | 234 + .../msk/configurations_list_only/index.md | 73 + website/docs/services/msk/index.md | 53 + .../services/msk/replicator_tags/index.md | 89 + .../docs/services/msk/replicators/index.md | 296 + .../msk/replicators_list_only/index.md | 73 + .../msk/serverless_cluster_tags/index.md | 83 + .../services/msk/serverless_clusters/index.md | 230 + .../serverless_clusters_list_only/index.md | 73 + .../services/msk/vpc_connection_tags/index.md | 87 + .../services/msk/vpc_connections/index.md | 274 + .../msk/vpc_connections_list_only/index.md | 73 + .../services/mwaa/environment_tags/index.md | 133 + .../docs/services/mwaa/environments/index.md | 391 + .../mwaa/environments_list_only/index.md | 73 + website/docs/services/mwaa/index.md | 38 + .../services/neptune/db_cluster_tags/index.md | 131 + .../services/neptune/db_clusters/index.md | 472 + .../neptune/db_clusters_list_only/index.md | 73 + website/docs/services/neptune/index.md | 38 + .../services/neptunegraph/graph_tags/index.md | 93 + .../services/neptunegraph/graphs/index.md | 276 + .../neptunegraph/graphs_list_only/index.md | 73 + website/docs/services/neptunegraph/index.md | 40 + .../private_graph_endpoints/index.md | 249 + .../index.md | 73 + .../firewall_policies/index.md | 242 + .../firewall_policies_list_only/index.md | 74 + .../firewall_policy_tags/index.md | 85 + .../networkfirewall/firewall_tags/index.md | 97 + .../networkfirewall/firewalls/index.md | 298 + .../firewalls_list_only/index.md | 73 + .../docs/services/networkfirewall/index.md | 48 + .../logging_configurations/index.md | 224 + .../networkfirewall/rule_group_tags/index.md | 89 + .../networkfirewall/rule_groups/index.md | 261 + .../rule_groups_list_only/index.md | 74 + .../index.md | 85 + .../tls_inspection_configurations/index.md | 239 + .../index.md | 74 + .../connect_attachment_tags/index.md | 109 + .../connect_attachments/index.md | 299 + .../connect_attachments_list_only/index.md | 73 + .../networkmanager/connect_peer_tags/index.md | 99 + .../networkmanager/connect_peers/index.md | 269 + .../connect_peers_list_only/index.md | 73 + .../networkmanager/core_network_tags/index.md | 97 + .../networkmanager/core_networks/index.md | 258 + .../core_networks_list_only/index.md | 73 + .../customer_gateway_associations/index.md | 210 + .../index.md | 75 + .../networkmanager/device_tags/index.md | 101 + .../services/networkmanager/devices/index.md | 283 + .../networkmanager/devices_list_only/index.md | 75 + .../index.md | 107 + .../index.md | 289 + .../index.md | 73 + .../global_network_tags/index.md | 85 + .../networkmanager/global_networks/index.md | 237 + .../global_networks_list_only/index.md | 73 + website/docs/services/networkmanager/index.md | 77 + .../networkmanager/link_associations/index.md | 203 + .../link_associations_list_only/index.md | 77 + .../networkmanager/link_tags/index.md | 95 + .../services/networkmanager/links/index.md | 263 + .../networkmanager/links_list_only/index.md | 75 + .../networkmanager/site_tags/index.md | 89 + .../site_to_site_vpn_attachment_tags/index.md | 107 + .../site_to_site_vpn_attachments/index.md | 283 + .../index.md | 73 + .../services/networkmanager/sites/index.md | 239 + .../networkmanager/sites_list_only/index.md | 75 + .../transit_gateway_peering_tags/index.md | 97 + .../transit_gateway_peerings/index.md | 251 + .../index.md | 73 + .../transit_gateway_registrations/index.md | 195 + .../index.md | 75 + .../index.md | 109 + .../index.md | 287 + .../index.md | 73 + .../vpc_attachment_tags/index.md | 111 + .../networkmanager/vpc_attachments/index.md | 301 + .../vpc_attachments_list_only/index.md | 73 + website/docs/services/oam/index.md | 41 + website/docs/services/oam/link_tags/index.md | 87 + website/docs/services/oam/links/index.md | 253 + .../services/oam/links_list_only/index.md | 73 + website/docs/services/oam/sink_tags/index.md | 81 + website/docs/services/oam/sinks/index.md | 225 + .../services/oam/sinks_list_only/index.md | 73 + .../omics/annotation_store_tags/index.md | 101 + .../services/omics/annotation_stores/index.md | 274 + .../annotation_stores_list_only/index.md | 73 + website/docs/services/omics/index.md | 53 + .../omics/reference_store_tags/index.md | 87 + .../services/omics/reference_stores/index.md | 219 + .../omics/reference_stores_list_only/index.md | 73 + .../services/omics/run_group_tags/index.md | 91 + .../docs/services/omics/run_groups/index.md | 254 + .../omics/run_groups_list_only/index.md | 73 + .../omics/sequence_store_tags/index.md | 89 + .../services/omics/sequence_stores/index.md | 226 + .../omics/sequence_stores_list_only/index.md | 73 + .../omics/variant_store_tags/index.md | 97 + .../services/omics/variant_stores/index.md | 260 + .../omics/variant_stores_list_only/index.md | 73 + .../services/omics/workflow_tags/index.md | 101 + .../docs/services/omics/workflows/index.md | 298 + .../omics/workflows_list_only/index.md | 73 + .../access_policies/index.md | 222 + .../access_policies_list_only/index.md | 75 + .../collection_tags/index.md | 91 + .../opensearchserverless/collections/index.md | 240 + .../collections_list_only/index.md | 73 + .../services/opensearchserverless/index.md | 48 + .../lifecycle_policies/index.md | 220 + .../lifecycle_policies_list_only/index.md | 75 + .../security_configs/index.md | 253 + .../security_configs_list_only/index.md | 73 + .../security_policies/index.md | 227 + .../security_policies_list_only/index.md | 75 + .../vpc_endpoints/index.md | 276 + .../vpc_endpoints_list_only/index.md | 73 + .../application_tags/index.md | 89 + .../opensearchservice/applications/index.md | 254 + .../applications_list_only/index.md | 73 + .../opensearchservice/domains/index.md | 433 + .../docs/services/opensearchservice/index.md | 39 + website/docs/services/opsworkscm/index.md | 38 + .../services/opsworkscm/server_tags/index.md | 119 + .../docs/services/opsworkscm/servers/index.md | 353 + .../opsworkscm/servers_list_only/index.md | 73 + .../organizations/account_tags/index.md | 93 + .../services/organizations/accounts/index.md | 256 + .../organizations/accounts_list_only/index.md | 73 + website/docs/services/organizations/index.md | 49 + .../organizational_unit_tags/index.md | 83 + .../organizational_units/index.md | 229 + .../organizational_units_list_only/index.md | 73 + .../organizations/organizations/index.md | 217 + .../organizations_list_only/index.md | 73 + .../services/organizations/policies/index.md | 260 + .../organizations/policies_list_only/index.md | 73 + .../organizations/policy_tags/index.md | 91 + .../organizations/resource_policies/index.md | 217 + .../resource_policies_list_only/index.md | 73 + .../resource_policy_tags/index.md | 81 + website/docs/services/osis/index.md | 38 + .../docs/services/osis/pipeline_tags/index.md | 99 + website/docs/services/osis/pipelines/index.md | 304 + .../osis/pipelines_list_only/index.md | 73 + .../application_instance_tags/index.md | 105 + .../panorama/application_instances/index.md | 305 + .../application_instances_list_only/index.md | 73 + website/docs/services/panorama/index.md | 42 + .../services/panorama/package_tags/index.md | 85 + .../panorama/package_versions/index.md | 243 + .../docs/services/panorama/packages/index.md | 254 + .../panorama/packages_list_only/index.md | 73 + .../paymentcryptography/aliases/index.md | 201 + .../aliases_list_only/index.md | 73 + .../services/paymentcryptography/index.md | 40 + .../paymentcryptography/key_tags/index.md | 89 + .../paymentcryptography/keys/index.md | 257 + .../keys_list_only/index.md | 73 + .../pcaconnectorad/connector_tags/index.md | 83 + .../pcaconnectorad/connectors/index.md | 241 + .../connectors_list_only/index.md | 73 + .../directory_registration_tags/index.md | 79 + .../directory_registrations/index.md | 216 + .../index.md | 73 + website/docs/services/pcaconnectorad/index.md | 48 + .../service_principal_names/index.md | 197 + .../index.md | 75 + .../index.md | 220 + .../index.md | 75 + .../pcaconnectorad/template_tags/index.md | 85 + .../pcaconnectorad/templates/index.md | 236 + .../templates_list_only/index.md | 73 + .../pcaconnectorscep/challenge_tags/index.md | 79 + .../pcaconnectorscep/challenges/index.md | 210 + .../challenges_list_only/index.md | 73 + .../pcaconnectorscep/connector_tags/index.md | 87 + .../pcaconnectorscep/connectors/index.md | 235 + .../connectors_list_only/index.md | 73 + .../docs/services/pcaconnectorscep/index.md | 41 + .../docs/services/pcs/cluster_tags/index.md | 95 + website/docs/services/pcs/clusters/index.md | 277 + .../services/pcs/clusters_list_only/index.md | 73 + .../pcs/compute_node_group_tags/index.md | 105 + .../services/pcs/compute_node_groups/index.md | 355 + .../compute_node_groups_list_only/index.md | 73 + website/docs/services/pcs/index.md | 44 + website/docs/services/pcs/queue_tags/index.md | 89 + website/docs/services/pcs/queues/index.md | 246 + .../services/pcs/queues_list_only/index.md | 73 + .../personalize/dataset_groups/index.md | 211 + .../dataset_groups_list_only/index.md | 73 + .../services/personalize/datasets/index.md | 245 + .../personalize/datasets_list_only/index.md | 73 + website/docs/services/personalize/index.md | 43 + .../services/personalize/schemata/index.md | 205 + .../personalize/schemata_list_only/index.md | 74 + .../services/personalize/solutions/index.md | 261 + .../personalize/solutions_list_only/index.md | 73 + .../pinpoint/in_app_template_tags/index.md | 87 + .../pinpoint/in_app_templates/index.md | 264 + .../in_app_templates_list_only/index.md | 73 + website/docs/services/pinpoint/index.md | 38 + website/docs/services/pipes/index.md | 38 + .../docs/services/pipes/pipe_tags/index.md | 109 + website/docs/services/pipes/pipes/index.md | 554 + .../services/pipes/pipes_list_only/index.md | 73 + .../index.md | 93 + .../environment_account_connections/index.md | 276 + .../index.md | 73 + .../proton/environment_template_tags/index.md | 87 + .../proton/environment_templates/index.md | 402 + .../environment_templates_list_only/index.md | 73 + website/docs/services/proton/index.md | 44 + .../proton/service_template_tags/index.md | 87 + .../proton/service_templates/index.md | 394 + .../service_templates_list_only/index.md | 73 + .../qbusiness/application_tags/index.md | 113 + .../services/qbusiness/applications/index.md | 344 + .../qbusiness/applications_list_only/index.md | 73 + .../qbusiness/data_accessor_tags/index.md | 93 + .../qbusiness/data_accessors/index.md | 276 + .../data_accessors_list_only/index.md | 75 + .../qbusiness/data_source_tags/index.md | 107 + .../services/qbusiness/data_sources/index.md | 323 + .../qbusiness/data_sources_list_only/index.md | 77 + website/docs/services/qbusiness/index.md | 58 + .../services/qbusiness/index_tags/index.md | 99 + .../docs/services/qbusiness/indices/index.md | 272 + .../qbusiness/indices_list_only/index.md | 75 + .../services/qbusiness/permissions/index.md | 214 + .../qbusiness/permissions_list_only/index.md | 75 + .../services/qbusiness/plugin_tags/index.md | 99 + .../docs/services/qbusiness/plugins/index.md | 278 + .../qbusiness/plugins_list_only/index.md | 75 + .../qbusiness/retriever_tags/index.md | 95 + .../services/qbusiness/retrievers/index.md | 263 + .../qbusiness/retrievers_list_only/index.md | 75 + .../qbusiness/web_experience_tags/index.md | 105 + .../qbusiness/web_experiences/index.md | 297 + .../web_experiences_list_only/index.md | 75 + website/docs/services/qldb/index.md | 38 + .../docs/services/qldb/stream_tags/index.md | 91 + website/docs/services/qldb/streams/index.md | 260 + .../services/qldb/streams_list_only/index.md | 75 + .../services/quicksight/analyses/index.md | 2196 ++++ .../quicksight/analyses_list_only/index.md | 75 + .../quicksight/analysis_tags/index.md | 109 + .../quicksight/custom_permissions/index.md | 244 + .../custom_permissions_list_only/index.md | 75 + .../custom_permissions_tags/index.md | 83 + .../quicksight/dashboard_tags/index.md | 113 + .../services/quicksight/dashboards/index.md | 2223 ++++ .../quicksight/dashboards_list_only/index.md | 75 + .../quicksight/data_set_tags/index.md | 121 + .../services/quicksight/data_sets/index.md | 480 + .../quicksight/data_sets_list_only/index.md | 75 + .../quicksight/data_source_tags/index.md | 107 + .../services/quicksight/data_sources/index.md | 425 + .../data_sources_list_only/index.md | 75 + .../services/quicksight/folder_tags/index.md | 95 + .../docs/services/quicksight/folders/index.md | 284 + .../quicksight/folders_list_only/index.md | 75 + website/docs/services/quicksight/index.md | 66 + .../quicksight/refresh_schedules/index.md | 224 + .../refresh_schedules_list_only/index.md | 77 + .../quicksight/template_tags/index.md | 99 + .../services/quicksight/templates/index.md | 2121 ++++ .../quicksight/templates_list_only/index.md | 75 + .../services/quicksight/theme_tags/index.md | 99 + .../docs/services/quicksight/themes/index.md | 320 + .../quicksight/themes_list_only/index.md | 75 + .../docs/services/quicksight/topics/index.md | 382 + .../quicksight/topics_list_only/index.md | 75 + .../quicksight/vpc_connection_tags/index.md | 103 + .../quicksight/vpc_connections/index.md | 302 + .../vpc_connections_list_only/index.md | 75 + website/docs/services/ram/index.md | 41 + .../services/ram/permission_tags/index.md | 89 + .../docs/services/ram/permissions/index.md | 244 + .../ram/permissions_list_only/index.md | 73 + .../services/ram/resource_share_tags/index.md | 89 + .../services/ram/resource_shares/index.md | 256 + .../ram/resource_shares_list_only/index.md | 73 + website/docs/services/rbin/index.md | 38 + website/docs/services/rbin/rule_tags/index.md | 95 + website/docs/services/rbin/rules/index.md | 280 + .../services/rbin/rules_list_only/index.md | 73 + .../rds/customdb_engine_version_tags/index.md | 99 + .../rds/customdb_engine_versions/index.md | 302 + .../index.md | 75 + .../db_cluster_parameter_group_tags/index.md | 83 + .../rds/db_cluster_parameter_groups/index.md | 248 + .../index.md | 73 + .../services/rds/db_cluster_tags/index.md | 199 + .../docs/services/rds/db_clusters/index.md | 784 ++ .../rds/db_clusters_list_only/index.md | 73 + .../services/rds/db_instance_tags/index.md | 237 + .../docs/services/rds/db_instances/index.md | 989 ++ .../rds/db_instances_list_only/index.md | 73 + .../rds/db_parameter_group_tags/index.md | 83 + .../services/rds/db_parameter_groups/index.md | 244 + .../db_parameter_groups_list_only/index.md | 73 + website/docs/services/rds/db_proxies/index.md | 289 + .../rds/db_proxies_list_only/index.md | 73 + .../rds/db_proxy_endpoint_tags/index.md | 93 + .../services/rds/db_proxy_endpoints/index.md | 254 + .../rds/db_proxy_endpoints_list_only/index.md | 74 + .../docs/services/rds/db_proxy_tags/index.md | 99 + .../rds/db_proxy_target_groups/index.md | 242 + .../db_proxy_target_groups_list_only/index.md | 73 + .../services/rds/db_shard_group_tags/index.md | 91 + .../services/rds/db_shard_groups/index.md | 259 + .../rds/db_shard_groups_list_only/index.md | 73 + .../rds/db_subnet_group_tags/index.md | 81 + .../services/rds/db_subnet_groups/index.md | 232 + .../rds/db_subnet_groups_list_only/index.md | 73 + .../rds/event_subscription_tags/index.md | 87 + .../services/rds/event_subscriptions/index.md | 253 + .../event_subscriptions_list_only/index.md | 73 + .../services/rds/global_cluster_tags/index.md | 91 + .../services/rds/global_clusters/index.md | 277 + .../rds/global_clusters_list_only/index.md | 73 + website/docs/services/rds/index.md | 76 + .../services/rds/integration_tags/index.md | 93 + .../docs/services/rds/integrations/index.md | 262 + .../rds/integrations_list_only/index.md | 73 + .../services/rds/option_group_tags/index.md | 85 + .../docs/services/rds/option_groups/index.md | 259 + .../rds/option_groups_list_only/index.md | 73 + .../cluster_parameter_group_tags/index.md | 83 + .../cluster_parameter_groups/index.md | 260 + .../index.md | 73 + .../cluster_subnet_group_tags/index.md | 81 + .../redshift/cluster_subnet_groups/index.md | 277 + .../cluster_subnet_groups_list_only/index.md | 73 + .../services/redshift/cluster_tags/index.md | 183 + .../docs/services/redshift/clusters/index.md | 643 ++ .../redshift/clusters_list_only/index.md | 73 + .../redshift/endpoint_accesses/index.md | 286 + .../endpoint_accesses_list_only/index.md | 73 + .../redshift/endpoint_authorizations/index.md | 253 + .../index.md | 75 + .../redshift/event_subscription_tags/index.md | 101 + .../redshift/event_subscriptions/index.md | 277 + .../event_subscriptions_list_only/index.md | 73 + website/docs/services/redshift/index.md | 56 + .../redshift/integration_tags/index.md | 89 + .../services/redshift/integrations/index.md | 257 + .../redshift/integrations_list_only/index.md | 73 + .../redshift/scheduled_actions/index.md | 265 + .../scheduled_actions_list_only/index.md | 74 + .../docs/services/redshiftserverless/index.md | 41 + .../namespace_tags/index.md | 107 + .../redshiftserverless/namespaces/index.md | 380 + .../namespaces_list_only/index.md | 74 + .../workgroup_tags/index.md | 99 + .../redshiftserverless/workgroups/index.md | 335 + .../workgroups_list_only/index.md | 74 + .../refactorspaces/application_tags/index.md | 101 + .../refactorspaces/applications/index.md | 291 + .../applications_list_only/index.md | 75 + .../refactorspaces/environment_tags/index.md | 87 + .../refactorspaces/environments/index.md | 271 + .../environments_list_only/index.md | 73 + website/docs/services/refactorspaces/index.md | 47 + .../refactorspaces/route_tags/index.md | 93 + .../services/refactorspaces/routes/index.md | 329 + .../refactorspaces/routes_list_only/index.md | 77 + .../refactorspaces/service_tags/index.md | 95 + .../services/refactorspaces/services/index.md | 283 + .../services_list_only/index.md | 77 + .../rekognition/collection_tags/index.md | 79 + .../services/rekognition/collections/index.md | 213 + .../collections_list_only/index.md | 73 + website/docs/services/rekognition/index.md | 43 + .../services/rekognition/projects/index.md | 188 + .../rekognition/projects_list_only/index.md | 73 + .../stream_processor_tags/index.md | 105 + .../rekognition/stream_processors/index.md | 316 + .../stream_processors_list_only/index.md | 73 + .../services/resiliencehub/app_tags/index.md | 97 + .../docs/services/resiliencehub/apps/index.md | 349 + .../resiliencehub/apps_list_only/index.md | 73 + website/docs/services/resiliencehub/index.md | 41 + .../resiliency_policies/index.md | 250 + .../resiliency_policies_list_only/index.md | 74 + .../resiliency_policy_tags/index.md | 87 + .../default_view_associations/index.md | 182 + .../docs/services/resourceexplorer2/index.md | 42 + .../resourceexplorer2/index_tags/index.md | 81 + .../resourceexplorer2/indices/index.md | 218 + .../indices_list_only/index.md | 73 + .../resourceexplorer2/view_tags/index.md | 85 + .../services/resourceexplorer2/views/index.md | 233 + .../views_list_only/index.md | 73 + .../resourcegroups/group_tags/index.md | 87 + .../services/resourcegroups/groups/index.md | 269 + .../resourcegroups/groups_list_only/index.md | 73 + website/docs/services/resourcegroups/index.md | 40 + .../resourcegroups/tag_sync_tasks/index.md | 226 + .../tag_sync_tasks_list_only/index.md | 73 + .../services/robomaker/fleet_tags/index.md | 79 + .../docs/services/robomaker/fleets/index.md | 205 + .../robomaker/fleets_list_only/index.md | 73 + website/docs/services/robomaker/index.md | 49 + .../robomaker/robot_application_tags/index.md | 87 + .../robot_application_versions/index.md | 184 + .../robomaker/robot_applications/index.md | 251 + .../robot_applications_list_only/index.md | 73 + .../services/robomaker/robot_tags/index.md | 85 + .../docs/services/robomaker/robots/index.md | 231 + .../robomaker/robots_list_only/index.md | 73 + .../simulation_application_tags/index.md | 91 + .../simulation_application_versions/index.md | 184 + .../simulation_applications/index.md | 271 + .../index.md | 73 + .../services/rolesanywhere/crl_tags/index.md | 85 + .../docs/services/rolesanywhere/crls/index.md | 238 + .../rolesanywhere/crls_list_only/index.md | 73 + website/docs/services/rolesanywhere/index.md | 44 + .../rolesanywhere/profile_tags/index.md | 97 + .../services/rolesanywhere/profiles/index.md | 292 + .../rolesanywhere/profiles_list_only/index.md | 73 + .../rolesanywhere/trust_anchor_tags/index.md | 87 + .../rolesanywhere/trust_anchors/index.md | 252 + .../trust_anchors_list_only/index.md | 73 + .../route53/cidr_collections/index.md | 215 + .../cidr_collections_list_only/index.md | 73 + .../docs/services/route53/dnssecs/index.md | 195 + .../route53/dnssecs_list_only/index.md | 73 + .../services/route53/health_checks/index.md | 235 + .../route53/health_checks_list_only/index.md | 73 + .../services/route53/hosted_zones/index.md | 265 + .../route53/hosted_zones_list_only/index.md | 73 + website/docs/services/route53/index.md | 46 + .../route53/key_signing_keys/index.md | 237 + .../key_signing_keys_list_only/index.md | 75 + .../route53/resource_record_sets/index.md | 81 + .../docs/services/route53profiles/index.md | 43 + .../profile_association_tags/index.md | 85 + .../profile_associations/index.md | 243 + .../profile_associations_list_only/index.md | 73 + .../profile_resource_associations/index.md | 238 + .../index.md | 73 + .../route53profiles/profile_tags/index.md | 83 + .../route53profiles/profiles/index.md | 223 + .../profiles_list_only/index.md | 73 + .../cluster_tags/index.md | 83 + .../route53recoverycontrol/clusters/index.md | 207 + .../clusters_list_only/index.md | 73 + .../control_panel_tags/index.md | 87 + .../control_panels/index.md | 232 + .../control_panels_list_only/index.md | 73 + .../services/route53recoverycontrol/index.md | 46 + .../routing_controls/index.md | 220 + .../routing_controls_list_only/index.md | 73 + .../safety_rule_tags/index.md | 89 + .../safety_rules/index.md | 259 + .../safety_rules_list_only/index.md | 73 + .../cell_tags/index.md | 83 + .../route53recoveryreadiness/cells/index.md | 230 + .../cells_list_only/index.md | 73 + .../route53recoveryreadiness/index.md | 47 + .../readiness_check_tags/index.md | 81 + .../readiness_checks/index.md | 229 + .../readiness_checks_list_only/index.md | 73 + .../recovery_group_tags/index.md | 81 + .../recovery_groups/index.md | 229 + .../recovery_groups_list_only/index.md | 73 + .../resource_set_tags/index.md | 83 + .../resource_sets/index.md | 250 + .../resource_sets_list_only/index.md | 73 + .../firewall_domain_list_tags/index.md | 99 + .../firewall_domain_lists/index.md | 266 + .../firewall_domain_lists_list_only/index.md | 73 + .../index.md | 101 + .../firewall_rule_group_associations/index.md | 272 + .../index.md | 73 + .../firewall_rule_group_tags/index.md | 99 + .../firewall_rule_groups/index.md | 277 + .../firewall_rule_groups_list_only/index.md | 73 + .../docs/services/route53resolver/index.md | 60 + .../outpost_resolver_tags/index.md | 97 + .../outpost_resolvers/index.md | 262 + .../outpost_resolvers_list_only/index.md | 73 + .../route53resolver/resolver_configs/index.md | 208 + .../resolver_configs_list_only/index.md | 74 + .../index.md | 218 + .../index.md | 73 + .../resolver_query_logging_configs/index.md | 234 + .../index.md | 73 + .../resolver_rule_associations/index.md | 206 + .../index.md | 73 + .../resolver_rule_tags/index.md | 89 + .../route53resolver/resolver_rules/index.md | 251 + .../resolver_rules_list_only/index.md | 73 + .../resolverdnssec_configs/index.md | 201 + .../resolverdnssec_configs_list_only/index.md | 73 + .../services/rum/app_monitor_tags/index.md | 87 + .../docs/services/rum/app_monitors/index.md | 344 + .../rum/app_monitors_list_only/index.md | 73 + website/docs/services/rum/index.md | 38 + .../services/s3/access_grant_tags/index.md | 93 + .../docs/services/s3/access_grants/index.md | 257 + .../s3/access_grants_instance_tags/index.md | 81 + .../s3/access_grants_instances/index.md | 212 + .../index.md | 73 + .../s3/access_grants_list_only/index.md | 73 + .../s3/access_grants_location_tags/index.md | 83 + .../s3/access_grants_locations/index.md | 222 + .../index.md | 73 + .../docs/services/s3/access_points/index.md | 251 + .../s3/access_points_list_only/index.md | 73 + .../docs/services/s3/bucket_policies/index.md | 207 + .../s3/bucket_policies_list_only/index.md | 73 + website/docs/services/s3/bucket_tags/index.md | 123 + website/docs/services/s3/buckets/index.md | 587 ++ .../services/s3/buckets_list_only/index.md | 73 + website/docs/services/s3/index.md | 60 + .../index.md | 205 + .../s3/multi_region_access_points/index.md | 214 + .../index.md | 73 + .../docs/services/s3/storage_lens/index.md | 269 + .../s3/storage_lens_group_tags/index.md | 81 + .../services/s3/storage_lens_groups/index.md | 247 + .../s3/storage_lens_groups_list_only/index.md | 73 + .../s3/storage_lens_list_only/index.md | 73 + .../services/s3/storage_lens_tags/index.md | 77 + .../s3express/bucket_policies/index.md | 207 + .../bucket_policies_list_only/index.md | 73 + .../s3express/directory_buckets/index.md | 256 + .../directory_buckets_list_only/index.md | 73 + website/docs/services/s3express/index.md | 39 + .../access_point_policies/index.md | 188 + .../s3objectlambda/access_points/index.md | 233 + .../access_points_list_only/index.md | 73 + website/docs/services/s3objectlambda/index.md | 38 + .../s3outposts/access_points/index.md | 231 + .../access_points_list_only/index.md | 73 + .../s3outposts/bucket_policies/index.md | 188 + .../services/s3outposts/bucket_tags/index.md | 83 + .../docs/services/s3outposts/buckets/index.md | 241 + .../s3outposts/buckets_list_only/index.md | 73 + .../services/s3outposts/endpoints/index.md | 243 + .../s3outposts/endpoints_list_only/index.md | 73 + website/docs/services/s3outposts/index.md | 43 + website/docs/services/s3tables/index.md | 39 + .../s3tables/table_bucket_policies/index.md | 208 + .../table_bucket_policies_list_only/index.md | 73 + .../services/s3tables/table_buckets/index.md | 213 + .../s3tables/table_buckets_list_only/index.md | 73 + .../sagemaker/app_image_config_tags/index.md | 85 + .../sagemaker/app_image_configs/index.md | 246 + .../app_image_configs_list_only/index.md | 73 + .../docs/services/sagemaker/app_tags/index.md | 87 + website/docs/services/sagemaker/apps/index.md | 237 + .../sagemaker/apps_list_only/index.md | 79 + .../services/sagemaker/cluster_tags/index.md | 93 + .../docs/services/sagemaker/clusters/index.md | 286 + .../sagemaker/clusters_list_only/index.md | 73 + .../data_quality_job_definition_tags/index.md | 99 + .../data_quality_job_definitions/index.md | 324 + .../index.md | 73 + .../services/sagemaker/device_fleets/index.md | 211 + .../docs/services/sagemaker/devices/index.md | 195 + .../services/sagemaker/endpoint_tags/index.md | 89 + .../services/sagemaker/endpoints/index.md | 263 + .../sagemaker/endpoints_list_only/index.md | 73 + .../sagemaker/feature_group_tags/index.md | 97 + .../sagemaker/feature_groups/index.md | 308 + .../feature_groups_list_only/index.md | 73 + .../services/sagemaker/image_tags/index.md | 85 + .../sagemaker/image_versions/index.md | 283 + .../image_versions_list_only/index.md | 74 + .../docs/services/sagemaker/images/index.md | 240 + .../sagemaker/images_list_only/index.md | 73 + website/docs/services/sagemaker/index.md | 105 + .../inference_component_tags/index.md | 97 + .../sagemaker/inference_components/index.md | 289 + .../inference_components_list_only/index.md | 73 + .../inference_experiment_tags/index.md | 109 + .../sagemaker/inference_experiments/index.md | 337 + .../inference_experiments_list_only/index.md | 73 + .../mlflow_tracking_server_tags/index.md | 91 + .../mlflow_tracking_servers/index.md | 263 + .../index.md | 73 + .../model_bias_job_definition_tags/index.md | 99 + .../model_bias_job_definitions/index.md | 319 + .../index.md | 73 + .../index.md | 99 + .../index.md | 317 + .../index.md | 73 + .../model_package_group_tags/index.md | 87 + .../sagemaker/model_package_groups/index.md | 243 + .../model_package_groups_list_only/index.md | 73 + .../sagemaker/model_package_tags/index.md | 133 + .../sagemaker/model_packages/index.md | 583 ++ .../model_packages_list_only/index.md | 73 + .../index.md | 99 + .../model_quality_job_definitions/index.md | 325 + .../index.md | 73 + .../monitoring_schedule_tags/index.md | 93 + .../sagemaker/monitoring_schedules/index.md | 325 + .../monitoring_schedules_list_only/index.md | 73 + .../sagemaker/partner_app_tags/index.md | 97 + .../services/sagemaker/partner_apps/index.md | 290 + .../sagemaker/partner_apps_list_only/index.md | 73 + .../services/sagemaker/pipeline_tags/index.md | 87 + .../services/sagemaker/pipelines/index.md | 255 + .../sagemaker/pipelines_list_only/index.md | 73 + .../services/sagemaker/project_tags/index.md | 91 + .../docs/services/sagemaker/projects/index.md | 261 + .../sagemaker/projects_list_only/index.md | 73 + .../services/sagemaker/space_tags/index.md | 91 + .../docs/services/sagemaker/spaces/index.md | 294 + .../sagemaker/spaces_list_only/index.md | 75 + .../studio_lifecycle_config_tags/index.md | 83 + .../studio_lifecycle_configs/index.md | 222 + .../index.md | 73 + .../sagemaker/user_profile_tags/index.md | 87 + .../services/sagemaker/user_profiles/index.md | 313 + .../user_profiles_list_only/index.md | 75 + website/docs/services/scheduler/index.md | 40 + .../scheduler/schedule_group_tags/index.md | 85 + .../scheduler/schedule_groups/index.md | 226 + .../schedule_groups_list_only/index.md | 73 + .../services/scheduler/schedules/index.md | 326 + .../scheduler/schedules_list_only/index.md | 73 + website/docs/services/secretsmanager/index.md | 44 + .../secretsmanager/resource_policies/index.md | 217 + .../resource_policies_list_only/index.md | 73 + .../rotation_schedules/index.md | 245 + .../rotation_schedules_list_only/index.md | 73 + .../secretsmanager/secret_tags/index.md | 89 + .../secret_target_attachments/index.md | 231 + .../index.md | 73 + .../services/secretsmanager/secrets/index.md | 278 + .../secretsmanager/secrets_list_only/index.md | 73 + .../securityhub/automation_rule_tags/index.md | 97 + .../securityhub/automation_rules/index.md | 371 + .../automation_rules_list_only/index.md | 73 + .../configuration_policies/index.md | 252 + .../configuration_policies_list_only/index.md | 73 + .../configuration_policy_tags/index.md | 91 + .../securityhub/delegated_admins/index.md | 196 + .../delegated_admins_list_only/index.md | 73 + .../securityhub/finding_aggregators/index.md | 208 + .../finding_aggregators_list_only/index.md | 73 + .../services/securityhub/hub_tags/index.md | 85 + .../docs/services/securityhub/hubs/index.md | 236 + .../securityhub/hubs_list_only/index.md | 73 + website/docs/services/securityhub/index.md | 60 + .../services/securityhub/insights/index.md | 433 + .../securityhub/insights_list_only/index.md | 73 + .../organization_configurations/index.md | 227 + .../index.md | 73 + .../securityhub/policy_associations/index.md | 231 + .../policy_associations_list_only/index.md | 73 + .../product_subscriptions/index.md | 188 + .../product_subscriptions_list_only/index.md | 73 + .../securityhub/security_controls/index.md | 227 + .../security_controls_list_only/index.md | 73 + .../services/securityhub/standards/index.md | 211 + .../securityhub/standards_list_only/index.md | 73 + .../securitylake/data_lake_tags/index.md | 87 + .../services/securitylake/data_lakes/index.md | 281 + .../data_lakes_list_only/index.md | 73 + website/docs/services/securitylake/index.md | 43 + .../subscriber_notifications/index.md | 281 + .../index.md | 73 + .../securitylake/subscriber_tags/index.md | 97 + .../securitylake/subscribers/index.md | 339 + .../subscribers_list_only/index.md | 73 + .../index.md | 287 + website/docs/services/servicecatalog/index.md | 40 + .../service_action_associations/index.md | 204 + .../index.md | 77 + .../servicecatalog/service_actions/index.md | 235 + .../service_actions_list_only/index.md | 73 + .../application_tags/index.md | 89 + .../applications/index.md | 230 + .../applications_list_only/index.md | 73 + .../attribute_group_associations/index.md | 199 + .../index.md | 77 + .../attribute_group_tags/index.md | 85 + .../attribute_groups/index.md | 228 + .../attribute_groups_list_only/index.md | 73 + .../servicecatalogappregistry/index.md | 45 + .../resource_associations/index.md | 209 + .../resource_associations_list_only/index.md | 79 + .../index.md | 207 + .../services/ses/configuration_sets/index.md | 267 + .../ses/configuration_sets_list_only/index.md | 73 + .../services/ses/contact_list_tags/index.md | 81 + .../docs/services/ses/contact_lists/index.md | 229 + .../ses/contact_lists_list_only/index.md | 73 + .../services/ses/dedicated_ip_pools/index.md | 207 + .../ses/dedicated_ip_pools_list_only/index.md | 73 + .../services/ses/email_identities/index.md | 264 + .../ses/email_identities_list_only/index.md | 73 + website/docs/services/ses/index.md | 69 + .../mail_manager_addon_instance_tags/index.md | 83 + .../ses/mail_manager_addon_instances/index.md | 220 + .../index.md | 73 + .../index.md | 81 + .../mail_manager_addon_subscriptions/index.md | 217 + .../index.md | 73 + .../ses/mail_manager_archive_tags/index.md | 87 + .../ses/mail_manager_archives/index.md | 244 + .../mail_manager_archives_list_only/index.md | 73 + .../mail_manager_ingress_point_tags/index.md | 95 + .../ses/mail_manager_ingress_points/index.md | 264 + .../index.md | 73 + .../ses/mail_manager_relay_tags/index.md | 87 + .../services/ses/mail_manager_relays/index.md | 243 + .../mail_manager_relays_list_only/index.md | 73 + .../ses/mail_manager_rule_set_tags/index.md | 83 + .../ses/mail_manager_rule_sets/index.md | 232 + .../mail_manager_rule_sets_list_only/index.md | 73 + .../mail_manager_traffic_policies/index.md | 244 + .../index.md | 73 + .../mail_manager_traffic_policy_tags/index.md | 87 + website/docs/services/ses/templates/index.md | 207 + .../services/ses/templates_list_only/index.md | 73 + .../docs/services/ses/vdm_attributes/index.md | 192 + .../services/shield/drt_accesses/index.md | 230 + .../shield/drt_accesses_list_only/index.md | 73 + website/docs/services/shield/index.md | 45 + .../shield/proactive_engagements/index.md | 222 + .../proactive_engagements_list_only/index.md | 73 + .../shield/protection_group_tags/index.md | 87 + .../shield/protection_groups/index.md | 245 + .../protection_groups_list_only/index.md | 73 + .../services/shield/protection_tags/index.md | 87 + .../docs/services/shield/protections/index.md | 263 + .../shield/protections_list_only/index.md | 73 + website/docs/services/signer/index.md | 40 + .../signer/profile_permissions/index.md | 221 + .../profile_permissions_list_only/index.md | 75 + .../signer/signing_profile_tags/index.md | 87 + .../services/signer/signing_profiles/index.md | 228 + .../signing_profiles_list_only/index.md | 73 + website/docs/services/simspaceweaver/index.md | 37 + .../simspaceweaver/simulations/index.md | 237 + .../simulations_list_only/index.md | 73 + website/docs/services/sns/index.md | 39 + .../sns/topic_inline_policies/index.md | 188 + website/docs/services/sns/topic_tags/index.md | 99 + website/docs/services/sns/topics/index.md | 325 + .../services/sns/topics_list_only/index.md | 73 + website/docs/services/sqs/index.md | 39 + .../sqs/queue_inline_policies/index.md | 191 + website/docs/services/sqs/queue_tags/index.md | 109 + website/docs/services/sqs/queues/index.md | 347 + .../services/sqs/queues_list_only/index.md | 73 + .../docs/services/ssm/associations/index.md | 327 + .../ssm/associations_list_only/index.md | 73 + .../docs/services/ssm/document_tags/index.md | 93 + website/docs/services/ssm/documents/index.md | 279 + .../services/ssm/documents_list_only/index.md | 73 + website/docs/services/ssm/index.md | 50 + .../docs/services/ssm/parameter_tags/index.md | 91 + website/docs/services/ssm/parameters/index.md | 257 + .../ssm/parameters_list_only/index.md | 73 + .../services/ssm/patch_baseline_tags/index.md | 103 + .../services/ssm/patch_baselines/index.md | 326 + .../ssm/patch_baselines_list_only/index.md | 73 + .../services/ssm/resource_data_syncs/index.md | 262 + .../resource_data_syncs_list_only/index.md | 73 + .../services/ssm/resource_policies/index.md | 211 + .../ssm/resource_policies_list_only/index.md | 76 + .../ssmcontacts/contact_channels/index.md | 236 + .../contact_channels_list_only/index.md | 73 + .../services/ssmcontacts/contacts/index.md | 236 + .../ssmcontacts/contacts_list_only/index.md | 73 + website/docs/services/ssmcontacts/index.md | 43 + .../docs/services/ssmcontacts/plans/index.md | 210 + .../ssmcontacts/rotation_tags/index.md | 87 + .../services/ssmcontacts/rotations/index.md | 274 + .../ssmcontacts/rotations_list_only/index.md | 73 + website/docs/services/ssmincidents/index.md | 41 + .../replication_set_tags/index.md | 81 + .../ssmincidents/replication_sets/index.md | 230 + .../replication_sets_list_only/index.md | 73 + .../ssmincidents/response_plan_tags/index.md | 91 + .../ssmincidents/response_plans/index.md | 302 + .../response_plans_list_only/index.md | 73 + .../configuration_manager_tags/index.md | 89 + .../configuration_managers/index.md | 350 + .../configuration_managers_list_only/index.md | 73 + website/docs/services/ssmquicksetup/index.md | 38 + .../sso/application_assignments/index.md | 203 + .../index.md | 77 + .../services/sso/application_tags/index.md | 89 + .../docs/services/sso/applications/index.md | 256 + .../sso/applications_list_only/index.md | 73 + .../docs/services/sso/assignments/index.md | 244 + .../sso/assignments_list_only/index.md | 83 + website/docs/services/sso/index.md | 50 + .../index.md | 217 + .../index.md | 73 + .../docs/services/sso/instance_tags/index.md | 85 + website/docs/services/sso/instances/index.md | 228 + .../services/sso/instances_list_only/index.md | 73 + .../services/sso/permission_set_tags/index.md | 95 + .../services/sso/permission_sets/index.md | 303 + .../sso/permission_sets_list_only/index.md | 75 + .../stepfunctions/activities/index.md | 222 + .../activities_list_only/index.md | 73 + .../stepfunctions/activity_tags/index.md | 81 + website/docs/services/stepfunctions/index.md | 45 + .../state_machine_aliases/index.md | 236 + .../state_machine_aliases_list_only/index.md | 73 + .../stepfunctions/state_machine_tags/index.md | 101 + .../state_machine_versions/index.md | 204 + .../state_machine_versions_list_only/index.md | 73 + .../stepfunctions/state_machines/index.md | 302 + .../state_machines_list_only/index.md | 73 + .../supportapp/account_aliases/index.md | 200 + .../account_aliases_list_only/index.md | 74 + website/docs/services/supportapp/index.md | 41 + .../slack_channel_configurations/index.md | 252 + .../index.md | 75 + .../slack_workspace_configurations/index.md | 204 + .../index.md | 73 + .../services/synthetics/canaries/index.md | 407 + .../synthetics/canaries_list_only/index.md | 73 + .../services/synthetics/canary_tags/index.md | 111 + .../services/synthetics/group_tags/index.md | 81 + .../docs/services/synthetics/groups/index.md | 225 + .../synthetics/groups_list_only/index.md | 73 + website/docs/services/synthetics/index.md | 41 + .../application_tags/index.md | 91 + .../systemsmanagersap/applications/index.md | 263 + .../applications_list_only/index.md | 73 + .../docs/services/systemsmanagersap/index.md | 38 + .../timestream/database_tags/index.md | 81 + .../services/timestream/databases/index.md | 230 + .../timestream/databases_list_only/index.md | 73 + website/docs/services/timestream/index.md | 47 + .../influxdb_instance_tags/index.md | 117 + .../timestream/influxdb_instances/index.md | 370 + .../influxdb_instances_list_only/index.md | 73 + .../timestream/scheduled_queries/index.md | 329 + .../scheduled_queries_list_only/index.md | 73 + .../timestream/scheduled_query_tags/index.md | 111 + .../services/timestream/table_tags/index.md | 89 + .../docs/services/timestream/tables/index.md | 272 + .../timestream/tables_list_only/index.md | 76 + .../services/transfer/agreement_tags/index.md | 93 + .../services/transfer/agreements/index.md | 264 + .../transfer/agreements_list_only/index.md | 75 + .../transfer/certificate_tags/index.md | 103 + .../services/transfer/certificates/index.md | 271 + .../transfer/certificates_list_only/index.md | 74 + .../services/transfer/connector_tags/index.md | 93 + .../services/transfer/connectors/index.md | 266 + .../transfer/connectors_list_only/index.md | 73 + website/docs/services/transfer/index.md | 57 + .../services/transfer/profile_tags/index.md | 85 + .../docs/services/transfer/profiles/index.md | 229 + .../transfer/profiles_list_only/index.md | 73 + .../services/transfer/public_keys/index.md | 63 + .../services/transfer/server_tags/index.md | 113 + .../docs/services/transfer/servers/index.md | 425 + .../transfer/servers_list_only/index.md | 73 + .../docs/services/transfer/user_tags/index.md | 95 + website/docs/services/transfer/users/index.md | 284 + .../transfer/users_list_only/index.md | 73 + .../services/transfer/workflow_tags/index.md | 85 + .../docs/services/transfer/workflows/index.md | 259 + .../transfer/workflows_list_only/index.md | 73 + .../identity_sources/index.md | 230 + .../identity_sources_list_only/index.md | 75 + .../services/verifiedpermissions/index.md | 43 + .../verifiedpermissions/policies/index.md | 213 + .../policies_list_only/index.md | 75 + .../policy_stores/index.md | 225 + .../policy_stores_list_only/index.md | 73 + .../policy_templates/index.md | 217 + .../policy_templates_list_only/index.md | 75 + .../services/voiceid/domain_tags/index.md | 83 + .../docs/services/voiceid/domains/index.md | 241 + .../voiceid/domains_list_only/index.md | 73 + website/docs/services/voiceid/index.md | 38 + .../access_log_subscription_tags/index.md | 89 + .../access_log_subscriptions/index.md | 281 + .../index.md | 73 + .../vpclattice/auth_policies/index.md | 190 + website/docs/services/vpclattice/index.md | 70 + .../vpclattice/listener_tags/index.md | 93 + .../services/vpclattice/listeners/index.md | 259 + .../vpclattice/listeners_list_only/index.md | 73 + .../resource_configuration_tags/index.md | 97 + .../resource_configurations/index.md | 278 + .../index.md | 73 + .../vpclattice/resource_gateway_tags/index.md | 89 + .../vpclattice/resource_gateways/index.md | 264 + .../resource_gateways_list_only/index.md | 73 + .../vpclattice/resource_policies/index.md | 188 + .../services/vpclattice/rule_tags/index.md | 91 + .../docs/services/vpclattice/rules/index.md | 277 + .../vpclattice/rules_list_only/index.md | 73 + .../index.md | 83 + .../index.md | 229 + .../index.md | 73 + .../index.md | 101 + .../index.md | 264 + .../index.md | 73 + .../vpclattice/service_network_tags/index.md | 89 + .../index.md | 97 + .../service_network_vpc_associations/index.md | 262 + .../index.md | 73 + .../vpclattice/service_networks/index.md | 246 + .../service_networks_list_only/index.md | 73 + .../services/vpclattice/service_tags/index.md | 95 + .../services/vpclattice/services/index.md | 271 + .../vpclattice/services_list_only/index.md | 73 + .../vpclattice/target_group_tags/index.md | 93 + .../vpclattice/target_groups/index.md | 294 + .../target_groups_list_only/index.md | 73 + website/docs/services/wafv2/index.md | 50 + .../docs/services/wafv2/ip_set_tags/index.md | 89 + website/docs/services/wafv2/ip_sets/index.md | 250 + .../services/wafv2/ip_sets_list_only/index.md | 77 + .../wafv2/logging_configurations/index.md | 290 + .../logging_configurations_list_only/index.md | 73 + .../wafv2/regex_pattern_set_tags/index.md | 87 + .../wafv2/regex_pattern_sets/index.md | 241 + .../regex_pattern_sets_list_only/index.md | 77 + .../services/wafv2/rule_group_tags/index.md | 99 + .../docs/services/wafv2/rule_groups/index.md | 510 + .../wafv2/rule_groups_list_only/index.md | 77 + .../docs/services/wafv2/web_acl_tags/index.md | 105 + website/docs/services/wafv2/web_acls/index.md | 529 + .../wafv2/web_acls_list_only/index.md | 77 + .../wafv2/webacl_associations/index.md | 249 + .../services/wisdom/ai_agent_tags/index.md | 93 + .../wisdom/ai_agent_versions/index.md | 224 + .../ai_agent_versions_list_only/index.md | 77 + .../docs/services/wisdom/ai_agents/index.md | 246 + .../wisdom/ai_agents_list_only/index.md | 75 + .../wisdom/ai_guardrail_tags/index.md | 101 + .../wisdom/ai_guardrail_versions/index.md | 224 + .../ai_guardrail_versions_list_only/index.md | 77 + .../services/wisdom/ai_guardrails/index.md | 303 + .../wisdom/ai_guardrails_list_only/index.md | 75 + .../services/wisdom/ai_prompt_tags/index.md | 99 + .../wisdom/ai_prompt_versions/index.md | 224 + .../ai_prompt_versions_list_only/index.md | 77 + .../docs/services/wisdom/ai_prompts/index.md | 271 + .../wisdom/ai_prompts_list_only/index.md | 75 + .../assistant_association_tags/index.md | 87 + .../wisdom/assistant_associations/index.md | 232 + .../assistant_associations_list_only/index.md | 76 + .../services/wisdom/assistant_tags/index.md | 87 + .../docs/services/wisdom/assistants/index.md | 236 + .../wisdom/assistants_list_only/index.md | 73 + website/docs/services/wisdom/index.md | 64 + .../wisdom/knowledge_base_tags/index.md | 93 + .../services/wisdom/knowledge_bases/index.md | 288 + .../wisdom/knowledge_bases_list_only/index.md | 73 + .../wisdom/message_template_tags/index.md | 97 + .../wisdom/message_template_versions/index.md | 208 + .../index.md | 73 + .../wisdom/message_templates/index.md | 361 + .../message_templates_list_only/index.md | 73 + .../workspaces/connection_aliases/index.md | 181 + website/docs/services/workspaces/index.md | 39 + .../workspaces/workspaces_pool_tags/index.md | 95 + .../workspaces/workspaces_pools/index.md | 268 + .../workspaces_pools_list_only/index.md | 73 + .../environment_tags/index.md | 113 + .../environments/index.md | 324 + .../environments_list_only/index.md | 73 + .../services/workspacesthinclient/index.md | 38 + .../workspacesweb/browser_settings/index.md | 258 + .../browser_settings_list_only/index.md | 73 + .../browser_settings_tags/index.md | 85 + .../data_protection_settings/index.md | 300 + .../index.md | 73 + .../data_protection_settings_tags/index.md | 91 + .../identity_provider_tags/index.md | 85 + .../workspacesweb/identity_providers/index.md | 242 + .../identity_providers_list_only/index.md | 73 + website/docs/services/workspacesweb/index.md | 62 + .../workspacesweb/ip_access_settings/index.md | 273 + .../ip_access_settings_list_only/index.md | 73 + .../ip_access_settings_tags/index.md | 91 + .../workspacesweb/network_settings/index.md | 239 + .../network_settings_list_only/index.md | 73 + .../network_settings_tags/index.md | 85 + .../workspacesweb/portal_tags/index.md | 117 + .../services/workspacesweb/portals/index.md | 415 + .../workspacesweb/portals_list_only/index.md | 73 + .../workspacesweb/trust_store_tags/index.md | 81 + .../workspacesweb/trust_stores/index.md | 227 + .../trust_stores_list_only/index.md | 73 + .../user_access_logging_settings/index.md | 220 + .../index.md | 73 + .../index.md | 81 + .../workspacesweb/user_settings/index.md | 324 + .../user_settings_list_only/index.md | 73 + .../workspacesweb/user_settings_tags/index.md | 101 + .../docs/services/xray/group_tags/index.md | 85 + website/docs/services/xray/groups/index.md | 228 + .../services/xray/groups_list_only/index.md | 73 + website/docs/services/xray/index.md | 43 + .../services/xray/resource_policies/index.md | 212 + .../xray/resource_policies_list_only/index.md | 73 + .../services/xray/sampling_rule_tags/index.md | 85 + .../services/xray/sampling_rules/index.md | 261 + .../xray/sampling_rules_list_only/index.md | 73 + website/docusaurus.config.js | 232 + website/package.json | 51 + website/sidebars.js | 43 + .../components/CopyableCode/CopyableCode.js | 29 + .../src/components/HomepageFeatures/index.js | 64 + .../HomepageFeatures/styles.module.css | 11 + website/src/css/custom.css | 259 + website/src/pages/blog.js | 10 + website/src/pages/contact-us.js | 10 + website/src/pages/install.js | 10 + website/src/pages/providers/aws.js | 10 + website/src/pages/providers/azure.js | 10 + website/src/pages/providers/confluent.js | 10 + website/src/pages/providers/databricks.js | 10 + website/src/pages/providers/github.js | 10 + website/src/pages/providers/google.js | 10 + website/src/pages/providers/index.js | 10 + website/src/pages/providers/okta.js | 10 + website/src/pages/providers/openai.js | 10 + website/src/pages/providers/snowflake.js | 10 + website/src/pages/stackql-deploy.js | 10 + website/src/pages/stackqldocs.js | 10 + website/src/pages/tutorials.js | 10 + website/src/theme/Footer/Copyright/index.tsx | 20 + website/src/theme/Footer/Layout/index.tsx | 34 + website/src/theme/Footer/LinkItem/index.tsx | 36 + .../theme/Footer/Links/MultiColumn/index.tsx | 51 + .../src/theme/Footer/Links/Simple/index.tsx | 42 + website/src/theme/Footer/Links/index.tsx | 21 + website/src/theme/Footer/Logo/index.tsx | 46 + .../src/theme/Footer/Logo/styles.module.css | 16 + website/src/theme/Footer/index.tsx | 262 + website/src/theme/Footer/styles.module.css | 16 + website/src/theme/Logo/index.d.ts | 9 + website/src/theme/Logo/index.js | 76 + website/static/.nojekyll | 0 website/static/CNAME | 1 + website/static/img/favicon-16x16.png | Bin 0 -> 872 bytes website/static/img/favicon-32x32.png | Bin 0 -> 1533 bytes website/static/img/favicon.ico | Bin 0 -> 15086 bytes .../stackql-aws-provider-featured-image.png | Bin 0 -> 36181 bytes website/static/img/stackql-cover.png | Bin 0 -> 29955 bytes .../img/stackql-registry-logo-mobile.svg | 3 + .../stackql-registry-logo-white-mobile.svg | 3 + .../img/stackql-registry-logo-white.svg | 1 + website/static/img/stackql-registry-logo.svg | 1 + website/yarn.lock | 9087 +++++++++++++++++ 3156 files changed, 467273 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/prod-web-deploy.yml create mode 100644 .github/workflows/star-check.yml create mode 100644 .github/workflows/test-web-deploy.yml create mode 100644 fix_docs.sh create mode 100644 website/.gitignore create mode 100644 website/README.md create mode 100644 website/docs/index.md create mode 100644 website/docs/services/accessanalyzer/analyzer_tags/index.md create mode 100644 website/docs/services/accessanalyzer/analyzers/index.md create mode 100644 website/docs/services/accessanalyzer/analyzers_list_only/index.md create mode 100644 website/docs/services/accessanalyzer/index.md create mode 100644 website/docs/services/acmpca/certificate_authorities/index.md create mode 100644 website/docs/services/acmpca/certificate_authorities_list_only/index.md create mode 100644 website/docs/services/acmpca/certificate_authority_activations/index.md create mode 100644 website/docs/services/acmpca/certificate_authority_tags/index.md create mode 100644 website/docs/services/acmpca/certificates/index.md create mode 100644 website/docs/services/acmpca/index.md create mode 100644 website/docs/services/acmpca/permissions/index.md create mode 100644 website/docs/services/amazonmq/configuration_tags/index.md create mode 100644 website/docs/services/amazonmq/configurations/index.md create mode 100644 website/docs/services/amazonmq/configurations_list_only/index.md create mode 100644 website/docs/services/amazonmq/index.md create mode 100644 website/docs/services/amplify/app_tags/index.md create mode 100644 website/docs/services/amplify/apps/index.md create mode 100644 website/docs/services/amplify/apps_list_only/index.md create mode 100644 website/docs/services/amplify/branch_tags/index.md create mode 100644 website/docs/services/amplify/branches/index.md create mode 100644 website/docs/services/amplify/branches_list_only/index.md create mode 100644 website/docs/services/amplify/domains/index.md create mode 100644 website/docs/services/amplify/domains_list_only/index.md create mode 100644 website/docs/services/amplify/index.md create mode 100644 website/docs/services/amplifyuibuilder/component_tags/index.md create mode 100644 website/docs/services/amplifyuibuilder/components/index.md create mode 100644 website/docs/services/amplifyuibuilder/components_list_only/index.md create mode 100644 website/docs/services/amplifyuibuilder/form_tags/index.md create mode 100644 website/docs/services/amplifyuibuilder/forms/index.md create mode 100644 website/docs/services/amplifyuibuilder/forms_list_only/index.md create mode 100644 website/docs/services/amplifyuibuilder/index.md create mode 100644 website/docs/services/amplifyuibuilder/theme_tags/index.md create mode 100644 website/docs/services/amplifyuibuilder/themes/index.md create mode 100644 website/docs/services/amplifyuibuilder/themes_list_only/index.md create mode 100644 website/docs/services/apigateway/accounts/index.md create mode 100644 website/docs/services/apigateway/api_key_tags/index.md create mode 100644 website/docs/services/apigateway/api_keys/index.md create mode 100644 website/docs/services/apigateway/api_keys_list_only/index.md create mode 100644 website/docs/services/apigateway/authorizers/index.md create mode 100644 website/docs/services/apigateway/authorizers_list_only/index.md create mode 100644 website/docs/services/apigateway/base_path_mapping_v2s/index.md create mode 100644 website/docs/services/apigateway/base_path_mapping_v2s_list_only/index.md create mode 100644 website/docs/services/apigateway/base_path_mappings/index.md create mode 100644 website/docs/services/apigateway/base_path_mappings_list_only/index.md create mode 100644 website/docs/services/apigateway/client_certificate_tags/index.md create mode 100644 website/docs/services/apigateway/client_certificates/index.md create mode 100644 website/docs/services/apigateway/client_certificates_list_only/index.md create mode 100644 website/docs/services/apigateway/deployments/index.md create mode 100644 website/docs/services/apigateway/deployments_list_only/index.md create mode 100644 website/docs/services/apigateway/documentation_parts/index.md create mode 100644 website/docs/services/apigateway/documentation_parts_list_only/index.md create mode 100644 website/docs/services/apigateway/documentation_versions/index.md create mode 100644 website/docs/services/apigateway/documentation_versions_list_only/index.md create mode 100644 website/docs/services/apigateway/domain_name_access_association_tags/index.md create mode 100644 website/docs/services/apigateway/domain_name_access_associations/index.md create mode 100644 website/docs/services/apigateway/domain_name_access_associations_list_only/index.md create mode 100644 website/docs/services/apigateway/domain_name_tags/index.md create mode 100644 website/docs/services/apigateway/domain_name_v2_tags/index.md create mode 100644 website/docs/services/apigateway/domain_name_v2s/index.md create mode 100644 website/docs/services/apigateway/domain_name_v2s_list_only/index.md create mode 100644 website/docs/services/apigateway/domain_names/index.md create mode 100644 website/docs/services/apigateway/domain_names_list_only/index.md create mode 100644 website/docs/services/apigateway/gateway_responses/index.md create mode 100644 website/docs/services/apigateway/gateway_responses_list_only/index.md create mode 100644 website/docs/services/apigateway/index.md create mode 100644 website/docs/services/apigateway/methods/index.md create mode 100644 website/docs/services/apigateway/models/index.md create mode 100644 website/docs/services/apigateway/models_list_only/index.md create mode 100644 website/docs/services/apigateway/request_validators/index.md create mode 100644 website/docs/services/apigateway/request_validators_list_only/index.md create mode 100644 website/docs/services/apigateway/resources/index.md create mode 100644 website/docs/services/apigateway/resources_list_only/index.md create mode 100644 website/docs/services/apigateway/rest_api_tags/index.md create mode 100644 website/docs/services/apigateway/rest_apis/index.md create mode 100644 website/docs/services/apigateway/rest_apis_list_only/index.md create mode 100644 website/docs/services/apigateway/stage_tags/index.md create mode 100644 website/docs/services/apigateway/stages/index.md create mode 100644 website/docs/services/apigateway/stages_list_only/index.md create mode 100644 website/docs/services/apigateway/usage_plan_keys/index.md create mode 100644 website/docs/services/apigateway/usage_plan_keys_list_only/index.md create mode 100644 website/docs/services/apigateway/usage_plan_tags/index.md create mode 100644 website/docs/services/apigateway/usage_plans/index.md create mode 100644 website/docs/services/apigateway/usage_plans_list_only/index.md create mode 100644 website/docs/services/apigateway/vpc_link_tags/index.md create mode 100644 website/docs/services/apigateway/vpc_links/index.md create mode 100644 website/docs/services/apigateway/vpc_links_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/api_mappings/index.md create mode 100644 website/docs/services/apigatewayv2/api_mappings_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/api_tags/index.md create mode 100644 website/docs/services/apigatewayv2/apis/index.md create mode 100644 website/docs/services/apigatewayv2/apis_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/authorizers/index.md create mode 100644 website/docs/services/apigatewayv2/authorizers_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/deployments/index.md create mode 100644 website/docs/services/apigatewayv2/deployments_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/domain_name_tags/index.md create mode 100644 website/docs/services/apigatewayv2/domain_names/index.md create mode 100644 website/docs/services/apigatewayv2/domain_names_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/index.md create mode 100644 website/docs/services/apigatewayv2/integration_responses/index.md create mode 100644 website/docs/services/apigatewayv2/integration_responses_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/integrations/index.md create mode 100644 website/docs/services/apigatewayv2/integrations_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/models/index.md create mode 100644 website/docs/services/apigatewayv2/models_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/route_responses/index.md create mode 100644 website/docs/services/apigatewayv2/route_responses_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/routes/index.md create mode 100644 website/docs/services/apigatewayv2/routes_list_only/index.md create mode 100644 website/docs/services/apigatewayv2/vpc_link_tags/index.md create mode 100644 website/docs/services/apigatewayv2/vpc_links/index.md create mode 100644 website/docs/services/apigatewayv2/vpc_links_list_only/index.md create mode 100644 website/docs/services/appconfig/application_tags/index.md create mode 100644 website/docs/services/appconfig/applications/index.md create mode 100644 website/docs/services/appconfig/applications_list_only/index.md create mode 100644 website/docs/services/appconfig/configuration_profile_tags/index.md create mode 100644 website/docs/services/appconfig/configuration_profiles/index.md create mode 100644 website/docs/services/appconfig/configuration_profiles_list_only/index.md create mode 100644 website/docs/services/appconfig/deployment_strategies/index.md create mode 100644 website/docs/services/appconfig/deployment_strategies_list_only/index.md create mode 100644 website/docs/services/appconfig/deployment_strategy_tags/index.md create mode 100644 website/docs/services/appconfig/deployment_tags/index.md create mode 100644 website/docs/services/appconfig/deployments/index.md create mode 100644 website/docs/services/appconfig/deployments_list_only/index.md create mode 100644 website/docs/services/appconfig/environment_tags/index.md create mode 100644 website/docs/services/appconfig/environments/index.md create mode 100644 website/docs/services/appconfig/environments_list_only/index.md create mode 100644 website/docs/services/appconfig/extension_association_tags/index.md create mode 100644 website/docs/services/appconfig/extension_associations/index.md create mode 100644 website/docs/services/appconfig/extension_associations_list_only/index.md create mode 100644 website/docs/services/appconfig/extension_tags/index.md create mode 100644 website/docs/services/appconfig/extensions/index.md create mode 100644 website/docs/services/appconfig/extensions_list_only/index.md create mode 100644 website/docs/services/appconfig/hosted_configuration_versions/index.md create mode 100644 website/docs/services/appconfig/hosted_configuration_versions_list_only/index.md create mode 100644 website/docs/services/appconfig/index.md create mode 100644 website/docs/services/appflow/connector_profiles/index.md create mode 100644 website/docs/services/appflow/connector_profiles_list_only/index.md create mode 100644 website/docs/services/appflow/connectors/index.md create mode 100644 website/docs/services/appflow/connectors_list_only/index.md create mode 100644 website/docs/services/appflow/flow_tags/index.md create mode 100644 website/docs/services/appflow/flows/index.md create mode 100644 website/docs/services/appflow/flows_list_only/index.md create mode 100644 website/docs/services/appflow/index.md create mode 100644 website/docs/services/appintegrations/application_tags/index.md create mode 100644 website/docs/services/appintegrations/applications/index.md create mode 100644 website/docs/services/appintegrations/applications_list_only/index.md create mode 100644 website/docs/services/appintegrations/data_integration_tags/index.md create mode 100644 website/docs/services/appintegrations/data_integrations/index.md create mode 100644 website/docs/services/appintegrations/data_integrations_list_only/index.md create mode 100644 website/docs/services/appintegrations/event_integration_tags/index.md create mode 100644 website/docs/services/appintegrations/event_integrations/index.md create mode 100644 website/docs/services/appintegrations/event_integrations_list_only/index.md create mode 100644 website/docs/services/appintegrations/index.md create mode 100644 website/docs/services/applicationautoscaling/index.md create mode 100644 website/docs/services/applicationautoscaling/scalable_targets/index.md create mode 100644 website/docs/services/applicationautoscaling/scalable_targets_list_only/index.md create mode 100644 website/docs/services/applicationautoscaling/scaling_policies/index.md create mode 100644 website/docs/services/applicationautoscaling/scaling_policies_list_only/index.md create mode 100644 website/docs/services/applicationinsights/application_tags/index.md create mode 100644 website/docs/services/applicationinsights/applications/index.md create mode 100644 website/docs/services/applicationinsights/applications_list_only/index.md create mode 100644 website/docs/services/applicationinsights/index.md create mode 100644 website/docs/services/applicationsignals/index.md create mode 100644 website/docs/services/applicationsignals/service_level_objective_tags/index.md create mode 100644 website/docs/services/applicationsignals/service_level_objectives/index.md create mode 100644 website/docs/services/applicationsignals/service_level_objectives_list_only/index.md create mode 100644 website/docs/services/apprunner/auto_scaling_configuration_tags/index.md create mode 100644 website/docs/services/apprunner/auto_scaling_configurations/index.md create mode 100644 website/docs/services/apprunner/auto_scaling_configurations_list_only/index.md create mode 100644 website/docs/services/apprunner/index.md create mode 100644 website/docs/services/apprunner/observability_configuration_tags/index.md create mode 100644 website/docs/services/apprunner/observability_configurations/index.md create mode 100644 website/docs/services/apprunner/observability_configurations_list_only/index.md create mode 100644 website/docs/services/apprunner/service_tags/index.md create mode 100644 website/docs/services/apprunner/services/index.md create mode 100644 website/docs/services/apprunner/services_list_only/index.md create mode 100644 website/docs/services/apprunner/vpc_connector_tags/index.md create mode 100644 website/docs/services/apprunner/vpc_connectors/index.md create mode 100644 website/docs/services/apprunner/vpc_connectors_list_only/index.md create mode 100644 website/docs/services/apprunner/vpc_ingress_connection_tags/index.md create mode 100644 website/docs/services/apprunner/vpc_ingress_connections/index.md create mode 100644 website/docs/services/apprunner/vpc_ingress_connections_list_only/index.md create mode 100644 website/docs/services/appstream/app_block_builder_tags/index.md create mode 100644 website/docs/services/appstream/app_block_builders/index.md create mode 100644 website/docs/services/appstream/app_block_builders_list_only/index.md create mode 100644 website/docs/services/appstream/app_blocks/index.md create mode 100644 website/docs/services/appstream/application_entitlement_associations/index.md create mode 100644 website/docs/services/appstream/application_fleet_associations/index.md create mode 100644 website/docs/services/appstream/applications/index.md create mode 100644 website/docs/services/appstream/directory_configs/index.md create mode 100644 website/docs/services/appstream/directory_configs_list_only/index.md create mode 100644 website/docs/services/appstream/entitlements/index.md create mode 100644 website/docs/services/appstream/image_builder_tags/index.md create mode 100644 website/docs/services/appstream/image_builders/index.md create mode 100644 website/docs/services/appstream/image_builders_list_only/index.md create mode 100644 website/docs/services/appstream/index.md create mode 100644 website/docs/services/appsync/api_tags/index.md create mode 100644 website/docs/services/appsync/apis/index.md create mode 100644 website/docs/services/appsync/apis_list_only/index.md create mode 100644 website/docs/services/appsync/channel_namespace_tags/index.md create mode 100644 website/docs/services/appsync/channel_namespaces/index.md create mode 100644 website/docs/services/appsync/channel_namespaces_list_only/index.md create mode 100644 website/docs/services/appsync/data_sources/index.md create mode 100644 website/docs/services/appsync/data_sources_list_only/index.md create mode 100644 website/docs/services/appsync/domain_name_api_associations/index.md create mode 100644 website/docs/services/appsync/domain_names/index.md create mode 100644 website/docs/services/appsync/domain_names_list_only/index.md create mode 100644 website/docs/services/appsync/function_configurations/index.md create mode 100644 website/docs/services/appsync/function_configurations_list_only/index.md create mode 100644 website/docs/services/appsync/graphql_api_tags/index.md create mode 100644 website/docs/services/appsync/graphql_apis/index.md create mode 100644 website/docs/services/appsync/graphql_apis_list_only/index.md create mode 100644 website/docs/services/appsync/index.md create mode 100644 website/docs/services/appsync/resolvers/index.md create mode 100644 website/docs/services/appsync/resolvers_list_only/index.md create mode 100644 website/docs/services/appsync/source_api_associations/index.md create mode 100644 website/docs/services/appsync/source_api_associations_list_only/index.md create mode 100644 website/docs/services/apptest/index.md create mode 100644 website/docs/services/apptest/test_case_tags/index.md create mode 100644 website/docs/services/apptest/test_cases/index.md create mode 100644 website/docs/services/apptest/test_cases_list_only/index.md create mode 100644 website/docs/services/aps/index.md create mode 100644 website/docs/services/aps/rule_groups_namespace_tags/index.md create mode 100644 website/docs/services/aps/rule_groups_namespaces/index.md create mode 100644 website/docs/services/aps/rule_groups_namespaces_list_only/index.md create mode 100644 website/docs/services/aps/scraper_tags/index.md create mode 100644 website/docs/services/aps/scrapers/index.md create mode 100644 website/docs/services/aps/scrapers_list_only/index.md create mode 100644 website/docs/services/aps/workspace_tags/index.md create mode 100644 website/docs/services/aps/workspaces/index.md create mode 100644 website/docs/services/aps/workspaces_list_only/index.md create mode 100644 website/docs/services/arczonalshift/autoshift_observer_notification_statuses/index.md create mode 100644 website/docs/services/arczonalshift/autoshift_observer_notification_statuses_list_only/index.md create mode 100644 website/docs/services/arczonalshift/index.md create mode 100644 website/docs/services/arczonalshift/zonal_autoshift_configurations/index.md create mode 100644 website/docs/services/arczonalshift/zonal_autoshift_configurations_list_only/index.md create mode 100644 website/docs/services/athena/capacity_reservation_tags/index.md create mode 100644 website/docs/services/athena/capacity_reservations/index.md create mode 100644 website/docs/services/athena/capacity_reservations_list_only/index.md create mode 100644 website/docs/services/athena/data_catalog_tags/index.md create mode 100644 website/docs/services/athena/data_catalogs/index.md create mode 100644 website/docs/services/athena/data_catalogs_list_only/index.md create mode 100644 website/docs/services/athena/index.md create mode 100644 website/docs/services/athena/named_queries/index.md create mode 100644 website/docs/services/athena/named_queries_list_only/index.md create mode 100644 website/docs/services/athena/prepared_statements/index.md create mode 100644 website/docs/services/athena/prepared_statements_list_only/index.md create mode 100644 website/docs/services/athena/work_group_tags/index.md create mode 100644 website/docs/services/athena/work_groups/index.md create mode 100644 website/docs/services/athena/work_groups_list_only/index.md create mode 100644 website/docs/services/auditmanager/assessment_tags/index.md create mode 100644 website/docs/services/auditmanager/assessments/index.md create mode 100644 website/docs/services/auditmanager/assessments_list_only/index.md create mode 100644 website/docs/services/auditmanager/index.md create mode 100644 website/docs/services/autoscaling/auto_scaling_group_tags/index.md create mode 100644 website/docs/services/autoscaling/auto_scaling_groups/index.md create mode 100644 website/docs/services/autoscaling/auto_scaling_groups_list_only/index.md create mode 100644 website/docs/services/autoscaling/index.md create mode 100644 website/docs/services/autoscaling/launch_configurations/index.md create mode 100644 website/docs/services/autoscaling/launch_configurations_list_only/index.md create mode 100644 website/docs/services/autoscaling/lifecycle_hooks/index.md create mode 100644 website/docs/services/autoscaling/lifecycle_hooks_list_only/index.md create mode 100644 website/docs/services/autoscaling/scaling_policies/index.md create mode 100644 website/docs/services/autoscaling/scaling_policies_list_only/index.md create mode 100644 website/docs/services/autoscaling/scheduled_actions/index.md create mode 100644 website/docs/services/autoscaling/scheduled_actions_list_only/index.md create mode 100644 website/docs/services/autoscaling/warm_pools/index.md create mode 100644 website/docs/services/b2bi/capabilities/index.md create mode 100644 website/docs/services/b2bi/capabilities_list_only/index.md create mode 100644 website/docs/services/b2bi/capability_tags/index.md create mode 100644 website/docs/services/b2bi/index.md create mode 100644 website/docs/services/b2bi/partnership_tags/index.md create mode 100644 website/docs/services/b2bi/partnerships/index.md create mode 100644 website/docs/services/b2bi/partnerships_list_only/index.md create mode 100644 website/docs/services/b2bi/profile_tags/index.md create mode 100644 website/docs/services/b2bi/profiles/index.md create mode 100644 website/docs/services/b2bi/profiles_list_only/index.md create mode 100644 website/docs/services/b2bi/transformer_tags/index.md create mode 100644 website/docs/services/b2bi/transformers/index.md create mode 100644 website/docs/services/b2bi/transformers_list_only/index.md create mode 100644 website/docs/services/backup/backup_plans/index.md create mode 100644 website/docs/services/backup/backup_plans_list_only/index.md create mode 100644 website/docs/services/backup/backup_selections/index.md create mode 100644 website/docs/services/backup/backup_selections_list_only/index.md create mode 100644 website/docs/services/backup/backup_vaults/index.md create mode 100644 website/docs/services/backup/backup_vaults_list_only/index.md create mode 100644 website/docs/services/backup/frameworks/index.md create mode 100644 website/docs/services/backup/frameworks_list_only/index.md create mode 100644 website/docs/services/backup/index.md create mode 100644 website/docs/services/backup/logically_air_gapped_backup_vaults/index.md create mode 100644 website/docs/services/backup/logically_air_gapped_backup_vaults_list_only/index.md create mode 100644 website/docs/services/backup/report_plans/index.md create mode 100644 website/docs/services/backup/report_plans_list_only/index.md create mode 100644 website/docs/services/backup/restore_testing_plan_tags/index.md create mode 100644 website/docs/services/backup/restore_testing_plans/index.md create mode 100644 website/docs/services/backup/restore_testing_plans_list_only/index.md create mode 100644 website/docs/services/backup/restore_testing_selections/index.md create mode 100644 website/docs/services/backup/restore_testing_selections_list_only/index.md create mode 100644 website/docs/services/backupgateway/hypervisor_tags/index.md create mode 100644 website/docs/services/backupgateway/hypervisors/index.md create mode 100644 website/docs/services/backupgateway/hypervisors_list_only/index.md create mode 100644 website/docs/services/backupgateway/index.md create mode 100644 website/docs/services/batch/compute_environment_tags/index.md create mode 100644 website/docs/services/batch/compute_environments/index.md create mode 100644 website/docs/services/batch/compute_environments_list_only/index.md create mode 100644 website/docs/services/batch/index.md create mode 100644 website/docs/services/batch/job_definition_tags/index.md create mode 100644 website/docs/services/batch/job_definitions/index.md create mode 100644 website/docs/services/batch/job_definitions_list_only/index.md create mode 100644 website/docs/services/batch/job_queue_tags/index.md create mode 100644 website/docs/services/batch/job_queues/index.md create mode 100644 website/docs/services/batch/job_queues_list_only/index.md create mode 100644 website/docs/services/batch/scheduling_policies/index.md create mode 100644 website/docs/services/batch/scheduling_policies_list_only/index.md create mode 100644 website/docs/services/batch/scheduling_policy_tags/index.md create mode 100644 website/docs/services/bcmdataexports/export_tags/index.md create mode 100644 website/docs/services/bcmdataexports/exports/index.md create mode 100644 website/docs/services/bcmdataexports/exports_list_only/index.md create mode 100644 website/docs/services/bcmdataexports/index.md create mode 100644 website/docs/services/bedrock/agent_alias_tags/index.md create mode 100644 website/docs/services/bedrock/agent_aliases/index.md create mode 100644 website/docs/services/bedrock/agent_aliases_list_only/index.md create mode 100644 website/docs/services/bedrock/agent_tags/index.md create mode 100644 website/docs/services/bedrock/agents/index.md create mode 100644 website/docs/services/bedrock/agents_list_only/index.md create mode 100644 website/docs/services/bedrock/application_inference_profile_tags/index.md create mode 100644 website/docs/services/bedrock/application_inference_profiles/index.md create mode 100644 website/docs/services/bedrock/application_inference_profiles_list_only/index.md create mode 100644 website/docs/services/bedrock/data_sources/index.md create mode 100644 website/docs/services/bedrock/data_sources_list_only/index.md create mode 100644 website/docs/services/bedrock/flow_alias_tags/index.md create mode 100644 website/docs/services/bedrock/flow_aliases/index.md create mode 100644 website/docs/services/bedrock/flow_aliases_list_only/index.md create mode 100644 website/docs/services/bedrock/flow_tags/index.md create mode 100644 website/docs/services/bedrock/flow_versions/index.md create mode 100644 website/docs/services/bedrock/flow_versions_list_only/index.md create mode 100644 website/docs/services/bedrock/flows/index.md create mode 100644 website/docs/services/bedrock/flows_list_only/index.md create mode 100644 website/docs/services/bedrock/guardrail_tags/index.md create mode 100644 website/docs/services/bedrock/guardrail_versions/index.md create mode 100644 website/docs/services/bedrock/guardrails/index.md create mode 100644 website/docs/services/bedrock/guardrails_list_only/index.md create mode 100644 website/docs/services/bedrock/index.md create mode 100644 website/docs/services/bedrock/knowledge_base_tags/index.md create mode 100644 website/docs/services/bedrock/knowledge_bases/index.md create mode 100644 website/docs/services/bedrock/knowledge_bases_list_only/index.md create mode 100644 website/docs/services/bedrock/prompt_tags/index.md create mode 100644 website/docs/services/bedrock/prompt_version_tags/index.md create mode 100644 website/docs/services/bedrock/prompt_versions/index.md create mode 100644 website/docs/services/bedrock/prompt_versions_list_only/index.md create mode 100644 website/docs/services/bedrock/prompts/index.md create mode 100644 website/docs/services/bedrock/prompts_list_only/index.md create mode 100644 website/docs/services/billingconductor/billing_group_tags/index.md create mode 100644 website/docs/services/billingconductor/billing_groups/index.md create mode 100644 website/docs/services/billingconductor/billing_groups_list_only/index.md create mode 100644 website/docs/services/billingconductor/custom_line_item_tags/index.md create mode 100644 website/docs/services/billingconductor/custom_line_items/index.md create mode 100644 website/docs/services/billingconductor/custom_line_items_list_only/index.md create mode 100644 website/docs/services/billingconductor/index.md create mode 100644 website/docs/services/billingconductor/pricing_plan_tags/index.md create mode 100644 website/docs/services/billingconductor/pricing_plans/index.md create mode 100644 website/docs/services/billingconductor/pricing_plans_list_only/index.md create mode 100644 website/docs/services/billingconductor/pricing_rule_tags/index.md create mode 100644 website/docs/services/billingconductor/pricing_rules/index.md create mode 100644 website/docs/services/billingconductor/pricing_rules_list_only/index.md create mode 100644 website/docs/services/budgets/budgets_actions/index.md create mode 100644 website/docs/services/budgets/budgets_actions_list_only/index.md create mode 100644 website/docs/services/budgets/index.md create mode 100644 website/docs/services/cassandra/index.md create mode 100644 website/docs/services/cassandra/keyspace_tags/index.md create mode 100644 website/docs/services/cassandra/keyspaces/index.md create mode 100644 website/docs/services/cassandra/keyspaces_list_only/index.md create mode 100644 website/docs/services/cassandra/table_tags/index.md create mode 100644 website/docs/services/cassandra/tables/index.md create mode 100644 website/docs/services/cassandra/tables_list_only/index.md create mode 100644 website/docs/services/cassandra/types/index.md create mode 100644 website/docs/services/cassandra/types_list_only/index.md create mode 100644 website/docs/services/ce/anomaly_monitors/index.md create mode 100644 website/docs/services/ce/anomaly_monitors_list_only/index.md create mode 100644 website/docs/services/ce/anomaly_subscriptions/index.md create mode 100644 website/docs/services/ce/anomaly_subscriptions_list_only/index.md create mode 100644 website/docs/services/ce/cost_categories/index.md create mode 100644 website/docs/services/ce/cost_categories_list_only/index.md create mode 100644 website/docs/services/ce/index.md create mode 100644 website/docs/services/certificatemanager/accounts/index.md create mode 100644 website/docs/services/certificatemanager/index.md create mode 100644 website/docs/services/chatbot/custom_action_tags/index.md create mode 100644 website/docs/services/chatbot/custom_actions/index.md create mode 100644 website/docs/services/chatbot/custom_actions_list_only/index.md create mode 100644 website/docs/services/chatbot/index.md create mode 100644 website/docs/services/chatbot/microsoft_teams_channel_configuration_tags/index.md create mode 100644 website/docs/services/chatbot/microsoft_teams_channel_configurations/index.md create mode 100644 website/docs/services/chatbot/microsoft_teams_channel_configurations_list_only/index.md create mode 100644 website/docs/services/chatbot/slack_channel_configuration_tags/index.md create mode 100644 website/docs/services/chatbot/slack_channel_configurations/index.md create mode 100644 website/docs/services/chatbot/slack_channel_configurations_list_only/index.md create mode 100644 website/docs/services/cleanrooms/analysis_template_tags/index.md create mode 100644 website/docs/services/cleanrooms/analysis_templates/index.md create mode 100644 website/docs/services/cleanrooms/analysis_templates_list_only/index.md create mode 100644 website/docs/services/cleanrooms/collaboration_tags/index.md create mode 100644 website/docs/services/cleanrooms/collaborations/index.md create mode 100644 website/docs/services/cleanrooms/collaborations_list_only/index.md create mode 100644 website/docs/services/cleanrooms/configured_table_association_tags/index.md create mode 100644 website/docs/services/cleanrooms/configured_table_associations/index.md create mode 100644 website/docs/services/cleanrooms/configured_table_associations_list_only/index.md create mode 100644 website/docs/services/cleanrooms/configured_table_tags/index.md create mode 100644 website/docs/services/cleanrooms/configured_tables/index.md create mode 100644 website/docs/services/cleanrooms/configured_tables_list_only/index.md create mode 100644 website/docs/services/cleanrooms/id_mapping_table_tags/index.md create mode 100644 website/docs/services/cleanrooms/id_mapping_tables/index.md create mode 100644 website/docs/services/cleanrooms/id_mapping_tables_list_only/index.md create mode 100644 website/docs/services/cleanrooms/id_namespace_association_tags/index.md create mode 100644 website/docs/services/cleanrooms/id_namespace_associations/index.md create mode 100644 website/docs/services/cleanrooms/id_namespace_associations_list_only/index.md create mode 100644 website/docs/services/cleanrooms/index.md create mode 100644 website/docs/services/cleanrooms/membership_tags/index.md create mode 100644 website/docs/services/cleanrooms/memberships/index.md create mode 100644 website/docs/services/cleanrooms/memberships_list_only/index.md create mode 100644 website/docs/services/cleanrooms/privacy_budget_template_tags/index.md create mode 100644 website/docs/services/cleanrooms/privacy_budget_templates/index.md create mode 100644 website/docs/services/cleanrooms/privacy_budget_templates_list_only/index.md create mode 100644 website/docs/services/cleanroomsml/index.md create mode 100644 website/docs/services/cleanroomsml/training_dataset_tags/index.md create mode 100644 website/docs/services/cleanroomsml/training_datasets/index.md create mode 100644 website/docs/services/cleanroomsml/training_datasets_list_only/index.md create mode 100644 website/docs/services/cloud_control/index.md create mode 100644 website/docs/services/cloud_control/resource/index.md create mode 100644 website/docs/services/cloud_control/resource_request/index.md create mode 100644 website/docs/services/cloud_control/resource_requests/index.md create mode 100644 website/docs/services/cloud_control/resources/index.md create mode 100644 website/docs/services/cloudformation/guard_hooks/index.md create mode 100644 website/docs/services/cloudformation/guard_hooks_list_only/index.md create mode 100644 website/docs/services/cloudformation/hook_default_versions/index.md create mode 100644 website/docs/services/cloudformation/hook_default_versions_list_only/index.md create mode 100644 website/docs/services/cloudformation/hook_type_configs/index.md create mode 100644 website/docs/services/cloudformation/hook_type_configs_list_only/index.md create mode 100644 website/docs/services/cloudformation/hook_versions/index.md create mode 100644 website/docs/services/cloudformation/hook_versions_list_only/index.md create mode 100644 website/docs/services/cloudformation/index.md create mode 100644 website/docs/services/cloudformation/lambda_hooks/index.md create mode 100644 website/docs/services/cloudformation/lambda_hooks_list_only/index.md create mode 100644 website/docs/services/cloudformation/module_default_versions/index.md create mode 100644 website/docs/services/cloudformation/module_default_versions_list_only/index.md create mode 100644 website/docs/services/cloudformation/module_versions/index.md create mode 100644 website/docs/services/cloudformation/public_type_versions/index.md create mode 100644 website/docs/services/cloudformation/public_type_versions_list_only/index.md create mode 100644 website/docs/services/cloudformation/publishers/index.md create mode 100644 website/docs/services/cloudformation/publishers_list_only/index.md create mode 100644 website/docs/services/cloudformation/resource_default_versions/index.md create mode 100644 website/docs/services/cloudformation/resource_default_versions_list_only/index.md create mode 100644 website/docs/services/cloudformation/resource_versions/index.md create mode 100644 website/docs/services/cloudformation/resource_versions_list_only/index.md create mode 100644 website/docs/services/cloudformation/stack_set_tags/index.md create mode 100644 website/docs/services/cloudformation/stack_sets/index.md create mode 100644 website/docs/services/cloudformation/stack_sets_list_only/index.md create mode 100644 website/docs/services/cloudformation/stack_tags/index.md create mode 100644 website/docs/services/cloudformation/stacks/index.md create mode 100644 website/docs/services/cloudformation/stacks_list_only/index.md create mode 100644 website/docs/services/cloudformation/type_activations/index.md create mode 100644 website/docs/services/cloudformation/type_activations_list_only/index.md create mode 100644 website/docs/services/cloudfront/anycast_ip_list_tags/index.md create mode 100644 website/docs/services/cloudfront/anycast_ip_lists/index.md create mode 100644 website/docs/services/cloudfront/anycast_ip_lists_list_only/index.md create mode 100644 website/docs/services/cloudfront/cache_policies/index.md create mode 100644 website/docs/services/cloudfront/cache_policies_list_only/index.md create mode 100644 website/docs/services/cloudfront/cloud_front_origin_access_identities/index.md create mode 100644 website/docs/services/cloudfront/cloud_front_origin_access_identities_list_only/index.md create mode 100644 website/docs/services/cloudfront/continuous_deployment_policies/index.md create mode 100644 website/docs/services/cloudfront/continuous_deployment_policies_list_only/index.md create mode 100644 website/docs/services/cloudfront/distribution_tags/index.md create mode 100644 website/docs/services/cloudfront/distributions/index.md create mode 100644 website/docs/services/cloudfront/distributions_list_only/index.md create mode 100644 website/docs/services/cloudfront/functions/index.md create mode 100644 website/docs/services/cloudfront/functions_list_only/index.md create mode 100644 website/docs/services/cloudfront/index.md create mode 100644 website/docs/services/cloudfront/key_groups/index.md create mode 100644 website/docs/services/cloudfront/key_groups_list_only/index.md create mode 100644 website/docs/services/cloudfront/key_value_stores/index.md create mode 100644 website/docs/services/cloudfront/key_value_stores_list_only/index.md create mode 100644 website/docs/services/cloudfront/monitoring_subscriptions/index.md create mode 100644 website/docs/services/cloudfront/origin_access_controls/index.md create mode 100644 website/docs/services/cloudfront/origin_access_controls_list_only/index.md create mode 100644 website/docs/services/cloudfront/origin_request_policies/index.md create mode 100644 website/docs/services/cloudfront/origin_request_policies_list_only/index.md create mode 100644 website/docs/services/cloudfront/public_keys/index.md create mode 100644 website/docs/services/cloudfront/public_keys_list_only/index.md create mode 100644 website/docs/services/cloudfront/realtime_log_configs/index.md create mode 100644 website/docs/services/cloudfront/realtime_log_configs_list_only/index.md create mode 100644 website/docs/services/cloudfront/response_headers_policies/index.md create mode 100644 website/docs/services/cloudfront/response_headers_policies_list_only/index.md create mode 100644 website/docs/services/cloudhsm/backups/index.md create mode 100644 website/docs/services/cloudhsm/clusters/index.md create mode 100644 website/docs/services/cloudhsm/hsm/index.md create mode 100644 website/docs/services/cloudhsm/index.md create mode 100644 website/docs/services/cloudhsm/tags/index.md create mode 100644 website/docs/services/cloudtrail/channel_tags/index.md create mode 100644 website/docs/services/cloudtrail/channels/index.md create mode 100644 website/docs/services/cloudtrail/channels_list_only/index.md create mode 100644 website/docs/services/cloudtrail/dashboard_tags/index.md create mode 100644 website/docs/services/cloudtrail/dashboards/index.md create mode 100644 website/docs/services/cloudtrail/dashboards_list_only/index.md create mode 100644 website/docs/services/cloudtrail/event_data_store_tags/index.md create mode 100644 website/docs/services/cloudtrail/event_data_stores/index.md create mode 100644 website/docs/services/cloudtrail/event_data_stores_list_only/index.md create mode 100644 website/docs/services/cloudtrail/index.md create mode 100644 website/docs/services/cloudtrail/resource_policies/index.md create mode 100644 website/docs/services/cloudtrail/trail_tags/index.md create mode 100644 website/docs/services/cloudtrail/trails/index.md create mode 100644 website/docs/services/cloudtrail/trails_list_only/index.md create mode 100644 website/docs/services/cloudwatch/alarm_tags/index.md create mode 100644 website/docs/services/cloudwatch/alarms/index.md create mode 100644 website/docs/services/cloudwatch/alarms_list_only/index.md create mode 100644 website/docs/services/cloudwatch/composite_alarm_tags/index.md create mode 100644 website/docs/services/cloudwatch/composite_alarms/index.md create mode 100644 website/docs/services/cloudwatch/composite_alarms_list_only/index.md create mode 100644 website/docs/services/cloudwatch/dashboards/index.md create mode 100644 website/docs/services/cloudwatch/dashboards_list_only/index.md create mode 100644 website/docs/services/cloudwatch/index.md create mode 100644 website/docs/services/cloudwatch/log_events/index.md create mode 100644 website/docs/services/cloudwatch/log_groups/index.md create mode 100644 website/docs/services/cloudwatch/log_streams/index.md create mode 100644 website/docs/services/cloudwatch/metric_stream_tags/index.md create mode 100644 website/docs/services/cloudwatch/metric_streams/index.md create mode 100644 website/docs/services/cloudwatch/metric_streams_list_only/index.md create mode 100644 website/docs/services/codeartifact/domain_tags/index.md create mode 100644 website/docs/services/codeartifact/domains/index.md create mode 100644 website/docs/services/codeartifact/domains_list_only/index.md create mode 100644 website/docs/services/codeartifact/index.md create mode 100644 website/docs/services/codeartifact/package_group_tags/index.md create mode 100644 website/docs/services/codeartifact/package_groups/index.md create mode 100644 website/docs/services/codeartifact/package_groups_list_only/index.md create mode 100644 website/docs/services/codeartifact/repositories/index.md create mode 100644 website/docs/services/codeartifact/repositories_list_only/index.md create mode 100644 website/docs/services/codeartifact/repository_tags/index.md create mode 100644 website/docs/services/codebuild/fleet_tags/index.md create mode 100644 website/docs/services/codebuild/fleets/index.md create mode 100644 website/docs/services/codebuild/fleets_list_only/index.md create mode 100644 website/docs/services/codebuild/index.md create mode 100644 website/docs/services/codeconnections/connection_tags/index.md create mode 100644 website/docs/services/codeconnections/connections/index.md create mode 100644 website/docs/services/codeconnections/connections_list_only/index.md create mode 100644 website/docs/services/codeconnections/index.md create mode 100644 website/docs/services/codedeploy/application_tags/index.md create mode 100644 website/docs/services/codedeploy/applications/index.md create mode 100644 website/docs/services/codedeploy/applications_list_only/index.md create mode 100644 website/docs/services/codedeploy/deployment_configs/index.md create mode 100644 website/docs/services/codedeploy/deployment_configs_list_only/index.md create mode 100644 website/docs/services/codedeploy/index.md create mode 100644 website/docs/services/codeguruprofiler/index.md create mode 100644 website/docs/services/codeguruprofiler/profiling_group_tags/index.md create mode 100644 website/docs/services/codeguruprofiler/profiling_groups/index.md create mode 100644 website/docs/services/codeguruprofiler/profiling_groups_list_only/index.md create mode 100644 website/docs/services/codegurureviewer/index.md create mode 100644 website/docs/services/codegurureviewer/repository_association_tags/index.md create mode 100644 website/docs/services/codegurureviewer/repository_associations/index.md create mode 100644 website/docs/services/codegurureviewer/repository_associations_list_only/index.md create mode 100644 website/docs/services/codepipeline/custom_action_type_tags/index.md create mode 100644 website/docs/services/codepipeline/custom_action_types/index.md create mode 100644 website/docs/services/codepipeline/custom_action_types_list_only/index.md create mode 100644 website/docs/services/codepipeline/index.md create mode 100644 website/docs/services/codepipeline/pipeline_tags/index.md create mode 100644 website/docs/services/codepipeline/pipelines/index.md create mode 100644 website/docs/services/codepipeline/pipelines_list_only/index.md create mode 100644 website/docs/services/codestarconnections/connection_tags/index.md create mode 100644 website/docs/services/codestarconnections/connections/index.md create mode 100644 website/docs/services/codestarconnections/connections_list_only/index.md create mode 100644 website/docs/services/codestarconnections/index.md create mode 100644 website/docs/services/codestarconnections/repository_link_tags/index.md create mode 100644 website/docs/services/codestarconnections/repository_links/index.md create mode 100644 website/docs/services/codestarconnections/repository_links_list_only/index.md create mode 100644 website/docs/services/codestarconnections/sync_configurations/index.md create mode 100644 website/docs/services/codestarconnections/sync_configurations_list_only/index.md create mode 100644 website/docs/services/codestarnotifications/index.md create mode 100644 website/docs/services/codestarnotifications/notification_rule_tags/index.md create mode 100644 website/docs/services/codestarnotifications/notification_rules/index.md create mode 100644 website/docs/services/codestarnotifications/notification_rules_list_only/index.md create mode 100644 website/docs/services/cognito/identity_pool_principal_tags/index.md create mode 100644 website/docs/services/cognito/identity_pool_principal_tags_list_only/index.md create mode 100644 website/docs/services/cognito/identity_pool_role_attachments/index.md create mode 100644 website/docs/services/cognito/identity_pool_role_attachments_list_only/index.md create mode 100644 website/docs/services/cognito/identity_pools/index.md create mode 100644 website/docs/services/cognito/identity_pools_list_only/index.md create mode 100644 website/docs/services/cognito/index.md create mode 100644 website/docs/services/cognito/log_delivery_configurations/index.md create mode 100644 website/docs/services/cognito/managed_login_brandings/index.md create mode 100644 website/docs/services/cognito/user_pool_clients/index.md create mode 100644 website/docs/services/cognito/user_pool_clients_list_only/index.md create mode 100644 website/docs/services/cognito/user_pool_groups/index.md create mode 100644 website/docs/services/cognito/user_pool_groups_list_only/index.md create mode 100644 website/docs/services/cognito/user_pool_identity_providers/index.md create mode 100644 website/docs/services/cognito/user_pool_identity_providers_list_only/index.md create mode 100644 website/docs/services/cognito/user_pool_resource_servers/index.md create mode 100644 website/docs/services/cognito/user_pool_resource_servers_list_only/index.md create mode 100644 website/docs/services/cognito/user_pool_risk_configuration_attachments/index.md create mode 100644 website/docs/services/cognito/user_pool_user_to_group_attachments/index.md create mode 100644 website/docs/services/cognito/user_pool_users/index.md create mode 100644 website/docs/services/cognito/user_pool_users_list_only/index.md create mode 100644 website/docs/services/cognito/user_pools/index.md create mode 100644 website/docs/services/cognito/user_pools_list_only/index.md create mode 100644 website/docs/services/cognito/user_poolui_customization_attachments/index.md create mode 100644 website/docs/services/comprehend/document_classifier_tags/index.md create mode 100644 website/docs/services/comprehend/document_classifiers/index.md create mode 100644 website/docs/services/comprehend/document_classifiers_list_only/index.md create mode 100644 website/docs/services/comprehend/flywheel_tags/index.md create mode 100644 website/docs/services/comprehend/flywheels/index.md create mode 100644 website/docs/services/comprehend/flywheels_list_only/index.md create mode 100644 website/docs/services/comprehend/index.md create mode 100644 website/docs/services/config/aggregation_authorization_tags/index.md create mode 100644 website/docs/services/config/aggregation_authorizations/index.md create mode 100644 website/docs/services/config/aggregation_authorizations_list_only/index.md create mode 100644 website/docs/services/config/config_rules/index.md create mode 100644 website/docs/services/config/config_rules_list_only/index.md create mode 100644 website/docs/services/config/configuration_aggregator_tags/index.md create mode 100644 website/docs/services/config/configuration_aggregators/index.md create mode 100644 website/docs/services/config/configuration_aggregators_list_only/index.md create mode 100644 website/docs/services/config/conformance_packs/index.md create mode 100644 website/docs/services/config/conformance_packs_list_only/index.md create mode 100644 website/docs/services/config/index.md create mode 100644 website/docs/services/config/organization_conformance_packs/index.md create mode 100644 website/docs/services/config/organization_conformance_packs_list_only/index.md create mode 100644 website/docs/services/config/stored_queries/index.md create mode 100644 website/docs/services/config/stored_queries_list_only/index.md create mode 100644 website/docs/services/config/stored_query_tags/index.md create mode 100644 website/docs/services/connect/agent_status_tags/index.md create mode 100644 website/docs/services/connect/agent_statuses/index.md create mode 100644 website/docs/services/connect/agent_statuses_list_only/index.md create mode 100644 website/docs/services/connect/approved_origins/index.md create mode 100644 website/docs/services/connect/approved_origins_list_only/index.md create mode 100644 website/docs/services/connect/contact_flow_module_tags/index.md create mode 100644 website/docs/services/connect/contact_flow_modules/index.md create mode 100644 website/docs/services/connect/contact_flow_modules_list_only/index.md create mode 100644 website/docs/services/connect/contact_flow_tags/index.md create mode 100644 website/docs/services/connect/contact_flows/index.md create mode 100644 website/docs/services/connect/contact_flows_list_only/index.md create mode 100644 website/docs/services/connect/email_address_tags/index.md create mode 100644 website/docs/services/connect/email_addresses/index.md create mode 100644 website/docs/services/connect/email_addresses_list_only/index.md create mode 100644 website/docs/services/connect/evaluation_form_tags/index.md create mode 100644 website/docs/services/connect/evaluation_forms/index.md create mode 100644 website/docs/services/connect/evaluation_forms_list_only/index.md create mode 100644 website/docs/services/connect/hours_of_operation_tags/index.md create mode 100644 website/docs/services/connect/hours_of_operations/index.md create mode 100644 website/docs/services/connect/hours_of_operations_list_only/index.md create mode 100644 website/docs/services/connect/index.md create mode 100644 website/docs/services/connect/instance_storage_configs/index.md create mode 100644 website/docs/services/connect/instance_storage_configs_list_only/index.md create mode 100644 website/docs/services/connect/instance_tags/index.md create mode 100644 website/docs/services/connect/instances/index.md create mode 100644 website/docs/services/connect/instances_list_only/index.md create mode 100644 website/docs/services/connect/integration_associations/index.md create mode 100644 website/docs/services/connect/integration_associations_list_only/index.md create mode 100644 website/docs/services/connect/predefined_attributes/index.md create mode 100644 website/docs/services/connect/predefined_attributes_list_only/index.md create mode 100644 website/docs/services/connect/prompt_tags/index.md create mode 100644 website/docs/services/connect/prompts/index.md create mode 100644 website/docs/services/connect/prompts_list_only/index.md create mode 100644 website/docs/services/connect/queue_tags/index.md create mode 100644 website/docs/services/connect/queues/index.md create mode 100644 website/docs/services/connect/queues_list_only/index.md create mode 100644 website/docs/services/connect/quick_connect_tags/index.md create mode 100644 website/docs/services/connect/quick_connects/index.md create mode 100644 website/docs/services/connect/quick_connects_list_only/index.md create mode 100644 website/docs/services/connect/routing_profile_tags/index.md create mode 100644 website/docs/services/connect/routing_profiles/index.md create mode 100644 website/docs/services/connect/routing_profiles_list_only/index.md create mode 100644 website/docs/services/connect/rules/index.md create mode 100644 website/docs/services/connect/security_keys/index.md create mode 100644 website/docs/services/connect/security_keys_list_only/index.md create mode 100644 website/docs/services/connect/security_profile_tags/index.md create mode 100644 website/docs/services/connect/security_profiles/index.md create mode 100644 website/docs/services/connect/security_profiles_list_only/index.md create mode 100644 website/docs/services/connect/task_template_tags/index.md create mode 100644 website/docs/services/connect/task_templates/index.md create mode 100644 website/docs/services/connect/task_templates_list_only/index.md create mode 100644 website/docs/services/connect/traffic_distribution_group_tags/index.md create mode 100644 website/docs/services/connect/traffic_distribution_groups/index.md create mode 100644 website/docs/services/connect/traffic_distribution_groups_list_only/index.md create mode 100644 website/docs/services/connect/user_hierarchy_group_tags/index.md create mode 100644 website/docs/services/connect/user_hierarchy_groups/index.md create mode 100644 website/docs/services/connect/user_hierarchy_groups_list_only/index.md create mode 100644 website/docs/services/connect/user_hierarchy_structures/index.md create mode 100644 website/docs/services/connect/user_tags/index.md create mode 100644 website/docs/services/connect/users/index.md create mode 100644 website/docs/services/connect/users_list_only/index.md create mode 100644 website/docs/services/connect/view_tags/index.md create mode 100644 website/docs/services/connect/view_versions/index.md create mode 100644 website/docs/services/connect/view_versions_list_only/index.md create mode 100644 website/docs/services/connect/views/index.md create mode 100644 website/docs/services/connect/views_list_only/index.md create mode 100644 website/docs/services/connectcampaigns/campaign_tags/index.md create mode 100644 website/docs/services/connectcampaigns/campaigns/index.md create mode 100644 website/docs/services/connectcampaigns/campaigns_list_only/index.md create mode 100644 website/docs/services/connectcampaigns/index.md create mode 100644 website/docs/services/connectcampaignsv2/campaign_tags/index.md create mode 100644 website/docs/services/connectcampaignsv2/campaigns/index.md create mode 100644 website/docs/services/connectcampaignsv2/campaigns_list_only/index.md create mode 100644 website/docs/services/connectcampaignsv2/index.md create mode 100644 website/docs/services/controltower/enabled_baseline_tags/index.md create mode 100644 website/docs/services/controltower/enabled_baselines/index.md create mode 100644 website/docs/services/controltower/enabled_baselines_list_only/index.md create mode 100644 website/docs/services/controltower/enabled_control_tags/index.md create mode 100644 website/docs/services/controltower/enabled_controls/index.md create mode 100644 website/docs/services/controltower/enabled_controls_list_only/index.md create mode 100644 website/docs/services/controltower/index.md create mode 100644 website/docs/services/controltower/landing_zone_tags/index.md create mode 100644 website/docs/services/controltower/landing_zones/index.md create mode 100644 website/docs/services/controltower/landing_zones_list_only/index.md create mode 100644 website/docs/services/cur/index.md create mode 100644 website/docs/services/cur/report_definitions/index.md create mode 100644 website/docs/services/cur/report_definitions_list_only/index.md create mode 100644 website/docs/services/customerprofiles/calculated_attribute_definition_tags/index.md create mode 100644 website/docs/services/customerprofiles/calculated_attribute_definitions/index.md create mode 100644 website/docs/services/customerprofiles/calculated_attribute_definitions_list_only/index.md create mode 100644 website/docs/services/customerprofiles/domain_tags/index.md create mode 100644 website/docs/services/customerprofiles/domains/index.md create mode 100644 website/docs/services/customerprofiles/domains_list_only/index.md create mode 100644 website/docs/services/customerprofiles/event_stream_tags/index.md create mode 100644 website/docs/services/customerprofiles/event_streams/index.md create mode 100644 website/docs/services/customerprofiles/event_streams_list_only/index.md create mode 100644 website/docs/services/customerprofiles/event_trigger_tags/index.md create mode 100644 website/docs/services/customerprofiles/event_triggers/index.md create mode 100644 website/docs/services/customerprofiles/event_triggers_list_only/index.md create mode 100644 website/docs/services/customerprofiles/index.md create mode 100644 website/docs/services/customerprofiles/integration_tags/index.md create mode 100644 website/docs/services/customerprofiles/integrations/index.md create mode 100644 website/docs/services/customerprofiles/integrations_list_only/index.md create mode 100644 website/docs/services/customerprofiles/object_type_tags/index.md create mode 100644 website/docs/services/customerprofiles/object_types/index.md create mode 100644 website/docs/services/customerprofiles/object_types_list_only/index.md create mode 100644 website/docs/services/customerprofiles/segment_definition_tags/index.md create mode 100644 website/docs/services/customerprofiles/segment_definitions/index.md create mode 100644 website/docs/services/customerprofiles/segment_definitions_list_only/index.md create mode 100644 website/docs/services/databrew/dataset_tags/index.md create mode 100644 website/docs/services/databrew/datasets/index.md create mode 100644 website/docs/services/databrew/datasets_list_only/index.md create mode 100644 website/docs/services/databrew/index.md create mode 100644 website/docs/services/databrew/job_tags/index.md create mode 100644 website/docs/services/databrew/jobs/index.md create mode 100644 website/docs/services/databrew/jobs_list_only/index.md create mode 100644 website/docs/services/databrew/project_tags/index.md create mode 100644 website/docs/services/databrew/projects/index.md create mode 100644 website/docs/services/databrew/projects_list_only/index.md create mode 100644 website/docs/services/databrew/recipe_tags/index.md create mode 100644 website/docs/services/databrew/recipes/index.md create mode 100644 website/docs/services/databrew/recipes_list_only/index.md create mode 100644 website/docs/services/databrew/ruleset_tags/index.md create mode 100644 website/docs/services/databrew/rulesets/index.md create mode 100644 website/docs/services/databrew/rulesets_list_only/index.md create mode 100644 website/docs/services/databrew/schedule_tags/index.md create mode 100644 website/docs/services/databrew/schedules/index.md create mode 100644 website/docs/services/databrew/schedules_list_only/index.md create mode 100644 website/docs/services/datapipeline/index.md create mode 100644 website/docs/services/datapipeline/pipelines/index.md create mode 100644 website/docs/services/datapipeline/pipelines_list_only/index.md create mode 100644 website/docs/services/datasync/agent_tags/index.md create mode 100644 website/docs/services/datasync/agents/index.md create mode 100644 website/docs/services/datasync/agents_list_only/index.md create mode 100644 website/docs/services/datasync/index.md create mode 100644 website/docs/services/datasync/location_azure_blob_tags/index.md create mode 100644 website/docs/services/datasync/location_azure_blobs/index.md create mode 100644 website/docs/services/datasync/location_azure_blobs_list_only/index.md create mode 100644 website/docs/services/datasync/location_efs/index.md create mode 100644 website/docs/services/datasync/location_efs_list_only/index.md create mode 100644 website/docs/services/datasync/location_efs_tags/index.md create mode 100644 website/docs/services/datasync/location_hdfs/index.md create mode 100644 website/docs/services/datasync/location_hdfs_list_only/index.md create mode 100644 website/docs/services/datasync/location_hdfs_tags/index.md create mode 100644 website/docs/services/datasync/location_nfs/index.md create mode 100644 website/docs/services/datasync/location_nfs_list_only/index.md create mode 100644 website/docs/services/datasync/location_nfs_tags/index.md create mode 100644 website/docs/services/datasync/location_object_storage_tags/index.md create mode 100644 website/docs/services/datasync/location_object_storages/index.md create mode 100644 website/docs/services/datasync/location_object_storages_list_only/index.md create mode 100644 website/docs/services/datasync/location_s3_tags/index.md create mode 100644 website/docs/services/datasync/location_s3s/index.md create mode 100644 website/docs/services/datasync/location_s3s_list_only/index.md create mode 100644 website/docs/services/datasync/location_smb_tags/index.md create mode 100644 website/docs/services/datasync/location_smbs/index.md create mode 100644 website/docs/services/datasync/location_smbs_list_only/index.md create mode 100644 website/docs/services/datasync/locationf_sx_lustre_tags/index.md create mode 100644 website/docs/services/datasync/locationf_sx_lustres/index.md create mode 100644 website/docs/services/datasync/locationf_sx_lustres_list_only/index.md create mode 100644 website/docs/services/datasync/locationf_sx_ontap_tags/index.md create mode 100644 website/docs/services/datasync/locationf_sx_ontaps/index.md create mode 100644 website/docs/services/datasync/locationf_sx_ontaps_list_only/index.md create mode 100644 website/docs/services/datasync/locationf_sx_open_zfs/index.md create mode 100644 website/docs/services/datasync/locationf_sx_open_zfs_list_only/index.md create mode 100644 website/docs/services/datasync/locationf_sx_open_zfs_tags/index.md create mode 100644 website/docs/services/datasync/locationf_sx_windows/index.md create mode 100644 website/docs/services/datasync/locationf_sx_windows_list_only/index.md create mode 100644 website/docs/services/datasync/locationf_sx_windows_tags/index.md create mode 100644 website/docs/services/datasync/storage_system_tags/index.md create mode 100644 website/docs/services/datasync/storage_systems/index.md create mode 100644 website/docs/services/datasync/storage_systems_list_only/index.md create mode 100644 website/docs/services/datasync/task_tags/index.md create mode 100644 website/docs/services/datasync/tasks/index.md create mode 100644 website/docs/services/datasync/tasks_list_only/index.md create mode 100644 website/docs/services/datazone/data_sources/index.md create mode 100644 website/docs/services/datazone/data_sources_list_only/index.md create mode 100644 website/docs/services/datazone/domain_tags/index.md create mode 100644 website/docs/services/datazone/domains/index.md create mode 100644 website/docs/services/datazone/domains_list_only/index.md create mode 100644 website/docs/services/datazone/environment_actions/index.md create mode 100644 website/docs/services/datazone/environment_actions_list_only/index.md create mode 100644 website/docs/services/datazone/environment_blueprint_configurations/index.md create mode 100644 website/docs/services/datazone/environment_blueprint_configurations_list_only/index.md create mode 100644 website/docs/services/datazone/environment_profiles/index.md create mode 100644 website/docs/services/datazone/environment_profiles_list_only/index.md create mode 100644 website/docs/services/datazone/environments/index.md create mode 100644 website/docs/services/datazone/environments_list_only/index.md create mode 100644 website/docs/services/datazone/group_profiles/index.md create mode 100644 website/docs/services/datazone/group_profiles_list_only/index.md create mode 100644 website/docs/services/datazone/index.md create mode 100644 website/docs/services/datazone/project_memberships/index.md create mode 100644 website/docs/services/datazone/project_memberships_list_only/index.md create mode 100644 website/docs/services/datazone/projects/index.md create mode 100644 website/docs/services/datazone/projects_list_only/index.md create mode 100644 website/docs/services/datazone/subscription_targets/index.md create mode 100644 website/docs/services/datazone/subscription_targets_list_only/index.md create mode 100644 website/docs/services/datazone/user_profiles/index.md create mode 100644 website/docs/services/datazone/user_profiles_list_only/index.md create mode 100644 website/docs/services/deadline/farm_tags/index.md create mode 100644 website/docs/services/deadline/farms/index.md create mode 100644 website/docs/services/deadline/farms_list_only/index.md create mode 100644 website/docs/services/deadline/fleet_tags/index.md create mode 100644 website/docs/services/deadline/fleets/index.md create mode 100644 website/docs/services/deadline/fleets_list_only/index.md create mode 100644 website/docs/services/deadline/index.md create mode 100644 website/docs/services/deadline/license_endpoint_tags/index.md create mode 100644 website/docs/services/deadline/license_endpoints/index.md create mode 100644 website/docs/services/deadline/license_endpoints_list_only/index.md create mode 100644 website/docs/services/deadline/metered_products/index.md create mode 100644 website/docs/services/deadline/metered_products_list_only/index.md create mode 100644 website/docs/services/deadline/monitors/index.md create mode 100644 website/docs/services/deadline/monitors_list_only/index.md create mode 100644 website/docs/services/deadline/queue_environments/index.md create mode 100644 website/docs/services/deadline/queue_environments_list_only/index.md create mode 100644 website/docs/services/deadline/queue_fleet_associations/index.md create mode 100644 website/docs/services/deadline/queue_fleet_associations_list_only/index.md create mode 100644 website/docs/services/deadline/queue_tags/index.md create mode 100644 website/docs/services/deadline/queues/index.md create mode 100644 website/docs/services/deadline/queues_list_only/index.md create mode 100644 website/docs/services/deadline/storage_profiles/index.md create mode 100644 website/docs/services/deadline/storage_profiles_list_only/index.md create mode 100644 website/docs/services/detective/graph_tags/index.md create mode 100644 website/docs/services/detective/graphs/index.md create mode 100644 website/docs/services/detective/graphs_list_only/index.md create mode 100644 website/docs/services/detective/index.md create mode 100644 website/docs/services/detective/member_invitations/index.md create mode 100644 website/docs/services/detective/member_invitations_list_only/index.md create mode 100644 website/docs/services/detective/organization_admins/index.md create mode 100644 website/docs/services/detective/organization_admins_list_only/index.md create mode 100644 website/docs/services/devopsguru/index.md create mode 100644 website/docs/services/devopsguru/log_anomaly_detection_integrations/index.md create mode 100644 website/docs/services/devopsguru/log_anomaly_detection_integrations_list_only/index.md create mode 100644 website/docs/services/devopsguru/notification_channels/index.md create mode 100644 website/docs/services/devopsguru/notification_channels_list_only/index.md create mode 100644 website/docs/services/devopsguru/resource_collections/index.md create mode 100644 website/docs/services/devopsguru/resource_collections_list_only/index.md create mode 100644 website/docs/services/directoryservice/index.md create mode 100644 website/docs/services/directoryservice/simple_ads/index.md create mode 100644 website/docs/services/directoryservice/simple_ads_list_only/index.md create mode 100644 website/docs/services/dms/data_migration_tags/index.md create mode 100644 website/docs/services/dms/data_migrations/index.md create mode 100644 website/docs/services/dms/data_migrations_list_only/index.md create mode 100644 website/docs/services/dms/data_provider_tags/index.md create mode 100644 website/docs/services/dms/data_providers/index.md create mode 100644 website/docs/services/dms/data_providers_list_only/index.md create mode 100644 website/docs/services/dms/index.md create mode 100644 website/docs/services/dms/instance_profile_tags/index.md create mode 100644 website/docs/services/dms/instance_profiles/index.md create mode 100644 website/docs/services/dms/instance_profiles_list_only/index.md create mode 100644 website/docs/services/dms/migration_project_tags/index.md create mode 100644 website/docs/services/dms/migration_projects/index.md create mode 100644 website/docs/services/dms/migration_projects_list_only/index.md create mode 100644 website/docs/services/dms/replication_config_tags/index.md create mode 100644 website/docs/services/dms/replication_configs/index.md create mode 100644 website/docs/services/dms/replication_configs_list_only/index.md create mode 100644 website/docs/services/docdbelastic/cluster_tags/index.md create mode 100644 website/docs/services/docdbelastic/clusters/index.md create mode 100644 website/docs/services/docdbelastic/clusters_list_only/index.md create mode 100644 website/docs/services/docdbelastic/index.md create mode 100644 website/docs/services/dynamodb/global_tables/index.md create mode 100644 website/docs/services/dynamodb/global_tables_list_only/index.md create mode 100644 website/docs/services/dynamodb/index.md create mode 100644 website/docs/services/dynamodb/table_tags/index.md create mode 100644 website/docs/services/dynamodb/tables/index.md create mode 100644 website/docs/services/dynamodb/tables_list_only/index.md create mode 100644 website/docs/services/ec2/capacity_reservation_fleets/index.md create mode 100644 website/docs/services/ec2/capacity_reservation_fleets_list_only/index.md create mode 100644 website/docs/services/ec2/capacity_reservations/index.md create mode 100644 website/docs/services/ec2/capacity_reservations_list_only/index.md create mode 100644 website/docs/services/ec2/carrier_gateway_tags/index.md create mode 100644 website/docs/services/ec2/carrier_gateways/index.md create mode 100644 website/docs/services/ec2/carrier_gateways_list_only/index.md create mode 100644 website/docs/services/ec2/customer_gateway_tags/index.md create mode 100644 website/docs/services/ec2/customer_gateways/index.md create mode 100644 website/docs/services/ec2/customer_gateways_list_only/index.md create mode 100644 website/docs/services/ec2/dhcp_options/index.md create mode 100644 website/docs/services/ec2/dhcp_options_list_only/index.md create mode 100644 website/docs/services/ec2/dhcp_options_tags/index.md create mode 100644 website/docs/services/ec2/ec2fleets/index.md create mode 100644 website/docs/services/ec2/ec2fleets_list_only/index.md create mode 100644 website/docs/services/ec2/egress_only_internet_gateways/index.md create mode 100644 website/docs/services/ec2/egress_only_internet_gateways_list_only/index.md create mode 100644 website/docs/services/ec2/eip_associations/index.md create mode 100644 website/docs/services/ec2/eip_associations_list_only/index.md create mode 100644 website/docs/services/ec2/eip_tags/index.md create mode 100644 website/docs/services/ec2/eips/index.md create mode 100644 website/docs/services/ec2/eips_list_only/index.md create mode 100644 website/docs/services/ec2/enclave_certificate_iam_role_associations/index.md create mode 100644 website/docs/services/ec2/enclave_certificate_iam_role_associations_list_only/index.md create mode 100644 website/docs/services/ec2/flow_log_tags/index.md create mode 100644 website/docs/services/ec2/flow_logs/index.md create mode 100644 website/docs/services/ec2/flow_logs_list_only/index.md create mode 100644 website/docs/services/ec2/gateway_route_table_associations/index.md create mode 100644 website/docs/services/ec2/hosts/index.md create mode 100644 website/docs/services/ec2/hosts_list_only/index.md create mode 100644 website/docs/services/ec2/index.md create mode 100644 website/docs/services/ec2/instance_connect_endpoint_tags/index.md create mode 100644 website/docs/services/ec2/instance_connect_endpoints/index.md create mode 100644 website/docs/services/ec2/instance_connect_endpoints_list_only/index.md create mode 100644 website/docs/services/ec2/instance_tags/index.md create mode 100644 website/docs/services/ec2/instances/index.md create mode 100644 website/docs/services/ec2/instances_list_only/index.md create mode 100644 website/docs/services/ec2/internet_gateway_tags/index.md create mode 100644 website/docs/services/ec2/internet_gateways/index.md create mode 100644 website/docs/services/ec2/internet_gateways_list_only/index.md create mode 100644 website/docs/services/ec2/ipam_allocations/index.md create mode 100644 website/docs/services/ec2/ipam_allocations_list_only/index.md create mode 100644 website/docs/services/ec2/ipam_pool_cidrs/index.md create mode 100644 website/docs/services/ec2/ipam_pool_cidrs_list_only/index.md create mode 100644 website/docs/services/ec2/ipam_pool_tags/index.md create mode 100644 website/docs/services/ec2/ipam_pools/index.md create mode 100644 website/docs/services/ec2/ipam_pools_list_only/index.md create mode 100644 website/docs/services/ec2/ipam_resource_discoveries/index.md create mode 100644 website/docs/services/ec2/ipam_resource_discoveries_list_only/index.md create mode 100644 website/docs/services/ec2/ipam_resource_discovery_association_tags/index.md create mode 100644 website/docs/services/ec2/ipam_resource_discovery_associations/index.md create mode 100644 website/docs/services/ec2/ipam_resource_discovery_associations_list_only/index.md create mode 100644 website/docs/services/ec2/ipam_resource_discovery_tags/index.md create mode 100644 website/docs/services/ec2/ipam_scope_tags/index.md create mode 100644 website/docs/services/ec2/ipam_scopes/index.md create mode 100644 website/docs/services/ec2/ipam_scopes_list_only/index.md create mode 100644 website/docs/services/ec2/ipam_tags/index.md create mode 100644 website/docs/services/ec2/ipams/index.md create mode 100644 website/docs/services/ec2/ipams_list_only/index.md create mode 100644 website/docs/services/ec2/key_pair_tags/index.md create mode 100644 website/docs/services/ec2/key_pairs/index.md create mode 100644 website/docs/services/ec2/key_pairs_list_only/index.md create mode 100644 website/docs/services/ec2/launch_templates/index.md create mode 100644 website/docs/services/ec2/launch_templates_list_only/index.md create mode 100644 website/docs/services/ec2/local_gateway_route_table_tags/index.md create mode 100644 website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_association_tags/index.md create mode 100644 website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md create mode 100644 website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_associations_list_only/index.md create mode 100644 website/docs/services/ec2/local_gateway_route_tables/index.md create mode 100644 website/docs/services/ec2/local_gateway_route_tables_list_only/index.md create mode 100644 website/docs/services/ec2/local_gateway_route_tablevpc_association_tags/index.md create mode 100644 website/docs/services/ec2/local_gateway_route_tablevpc_associations/index.md create mode 100644 website/docs/services/ec2/local_gateway_route_tablevpc_associations_list_only/index.md create mode 100644 website/docs/services/ec2/local_gateway_routes/index.md create mode 100644 website/docs/services/ec2/local_gateway_routes_list_only/index.md create mode 100644 website/docs/services/ec2/nat_gateway_tags/index.md create mode 100644 website/docs/services/ec2/nat_gateways/index.md create mode 100644 website/docs/services/ec2/nat_gateways_list_only/index.md create mode 100644 website/docs/services/ec2/network_acl_tags/index.md create mode 100644 website/docs/services/ec2/network_acls/index.md create mode 100644 website/docs/services/ec2/network_acls_list_only/index.md create mode 100644 website/docs/services/ec2/network_insights_access_scope_analyses/index.md create mode 100644 website/docs/services/ec2/network_insights_access_scope_analyses_list_only/index.md create mode 100644 website/docs/services/ec2/network_insights_access_scope_analysis_tags/index.md create mode 100644 website/docs/services/ec2/network_insights_access_scope_tags/index.md create mode 100644 website/docs/services/ec2/network_insights_access_scopes/index.md create mode 100644 website/docs/services/ec2/network_insights_access_scopes_list_only/index.md create mode 100644 website/docs/services/ec2/network_insights_analyses/index.md create mode 100644 website/docs/services/ec2/network_insights_analyses_list_only/index.md create mode 100644 website/docs/services/ec2/network_insights_analysis_tags/index.md create mode 100644 website/docs/services/ec2/network_insights_path_tags/index.md create mode 100644 website/docs/services/ec2/network_insights_paths/index.md create mode 100644 website/docs/services/ec2/network_insights_paths_list_only/index.md create mode 100644 website/docs/services/ec2/network_interface_attachments/index.md create mode 100644 website/docs/services/ec2/network_interface_attachments_list_only/index.md create mode 100644 website/docs/services/ec2/network_interface_tags/index.md create mode 100644 website/docs/services/ec2/network_interfaces/index.md create mode 100644 website/docs/services/ec2/network_interfaces_list_only/index.md create mode 100644 website/docs/services/ec2/network_performance_metric_subscriptions/index.md create mode 100644 website/docs/services/ec2/network_performance_metric_subscriptions_list_only/index.md create mode 100644 website/docs/services/ec2/placement_group_tags/index.md create mode 100644 website/docs/services/ec2/placement_groups/index.md create mode 100644 website/docs/services/ec2/placement_groups_list_only/index.md create mode 100644 website/docs/services/ec2/prefix_list_tags/index.md create mode 100644 website/docs/services/ec2/prefix_lists/index.md create mode 100644 website/docs/services/ec2/prefix_lists_list_only/index.md create mode 100644 website/docs/services/ec2/route_table_tags/index.md create mode 100644 website/docs/services/ec2/route_tables/index.md create mode 100644 website/docs/services/ec2/route_tables_list_only/index.md create mode 100644 website/docs/services/ec2/routes/index.md create mode 100644 website/docs/services/ec2/routes_list_only/index.md create mode 100644 website/docs/services/ec2/security_group_egresses/index.md create mode 100644 website/docs/services/ec2/security_group_egresses_list_only/index.md create mode 100644 website/docs/services/ec2/security_group_ingresses/index.md create mode 100644 website/docs/services/ec2/security_group_ingresses_list_only/index.md create mode 100644 website/docs/services/ec2/security_group_tags/index.md create mode 100644 website/docs/services/ec2/security_group_vpc_associations/index.md create mode 100644 website/docs/services/ec2/security_group_vpc_associations_list_only/index.md create mode 100644 website/docs/services/ec2/security_groups/index.md create mode 100644 website/docs/services/ec2/security_groups_list_only/index.md create mode 100644 website/docs/services/ec2/snapshot_block_public_accesses/index.md create mode 100644 website/docs/services/ec2/snapshot_block_public_accesses_list_only/index.md create mode 100644 website/docs/services/ec2/spot_fleets/index.md create mode 100644 website/docs/services/ec2/spot_fleets_list_only/index.md create mode 100644 website/docs/services/ec2/subnet_cidr_blocks/index.md create mode 100644 website/docs/services/ec2/subnet_cidr_blocks_list_only/index.md create mode 100644 website/docs/services/ec2/subnet_network_acl_associations/index.md create mode 100644 website/docs/services/ec2/subnet_network_acl_associations_list_only/index.md create mode 100644 website/docs/services/ec2/subnet_route_table_associations/index.md create mode 100644 website/docs/services/ec2/subnet_route_table_associations_list_only/index.md create mode 100644 website/docs/services/ec2/subnet_tags/index.md create mode 100644 website/docs/services/ec2/subnets/index.md create mode 100644 website/docs/services/ec2/subnets_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_attachment_tags/index.md create mode 100644 website/docs/services/ec2/transit_gateway_attachments/index.md create mode 100644 website/docs/services/ec2/transit_gateway_attachments_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_connect_tags/index.md create mode 100644 website/docs/services/ec2/transit_gateway_connects/index.md create mode 100644 website/docs/services/ec2/transit_gateway_connects_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_multicast_domain_associations/index.md create mode 100644 website/docs/services/ec2/transit_gateway_multicast_domain_associations_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_multicast_domain_tags/index.md create mode 100644 website/docs/services/ec2/transit_gateway_multicast_domains/index.md create mode 100644 website/docs/services/ec2/transit_gateway_multicast_domains_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_multicast_group_members/index.md create mode 100644 website/docs/services/ec2/transit_gateway_multicast_group_members_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_multicast_group_sources/index.md create mode 100644 website/docs/services/ec2/transit_gateway_multicast_group_sources_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_peering_attachment_tags/index.md create mode 100644 website/docs/services/ec2/transit_gateway_peering_attachments/index.md create mode 100644 website/docs/services/ec2/transit_gateway_peering_attachments_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_route_table_associations/index.md create mode 100644 website/docs/services/ec2/transit_gateway_route_table_associations_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_route_table_propagations/index.md create mode 100644 website/docs/services/ec2/transit_gateway_route_table_propagations_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_route_table_tags/index.md create mode 100644 website/docs/services/ec2/transit_gateway_route_tables/index.md create mode 100644 website/docs/services/ec2/transit_gateway_route_tables_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_routes/index.md create mode 100644 website/docs/services/ec2/transit_gateway_routes_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateway_tags/index.md create mode 100644 website/docs/services/ec2/transit_gateway_vpc_attachment_tags/index.md create mode 100644 website/docs/services/ec2/transit_gateway_vpc_attachments/index.md create mode 100644 website/docs/services/ec2/transit_gateway_vpc_attachments_list_only/index.md create mode 100644 website/docs/services/ec2/transit_gateways/index.md create mode 100644 website/docs/services/ec2/transit_gateways_list_only/index.md create mode 100644 website/docs/services/ec2/verified_access_endpoint_tags/index.md create mode 100644 website/docs/services/ec2/verified_access_endpoints/index.md create mode 100644 website/docs/services/ec2/verified_access_endpoints_list_only/index.md create mode 100644 website/docs/services/ec2/verified_access_group_tags/index.md create mode 100644 website/docs/services/ec2/verified_access_groups/index.md create mode 100644 website/docs/services/ec2/verified_access_groups_list_only/index.md create mode 100644 website/docs/services/ec2/verified_access_instance_tags/index.md create mode 100644 website/docs/services/ec2/verified_access_instances/index.md create mode 100644 website/docs/services/ec2/verified_access_instances_list_only/index.md create mode 100644 website/docs/services/ec2/verified_access_trust_provider_tags/index.md create mode 100644 website/docs/services/ec2/verified_access_trust_providers/index.md create mode 100644 website/docs/services/ec2/verified_access_trust_providers_list_only/index.md create mode 100644 website/docs/services/ec2/volume_attachments/index.md create mode 100644 website/docs/services/ec2/volume_attachments_list_only/index.md create mode 100644 website/docs/services/ec2/volume_tags/index.md create mode 100644 website/docs/services/ec2/volumes/index.md create mode 100644 website/docs/services/ec2/volumes_list_only/index.md create mode 100644 website/docs/services/ec2/vpc_block_public_access_exclusion_tags/index.md create mode 100644 website/docs/services/ec2/vpc_block_public_access_exclusions/index.md create mode 100644 website/docs/services/ec2/vpc_block_public_access_exclusions_list_only/index.md create mode 100644 website/docs/services/ec2/vpc_block_public_access_options/index.md create mode 100644 website/docs/services/ec2/vpc_cidr_blocks/index.md create mode 100644 website/docs/services/ec2/vpc_cidr_blocks_list_only/index.md create mode 100644 website/docs/services/ec2/vpc_endpoint_connection_notifications/index.md create mode 100644 website/docs/services/ec2/vpc_endpoint_connection_notifications_list_only/index.md create mode 100644 website/docs/services/ec2/vpc_endpoint_service_permissions/index.md create mode 100644 website/docs/services/ec2/vpc_endpoint_service_permissions_list_only/index.md create mode 100644 website/docs/services/ec2/vpc_endpoint_service_tags/index.md create mode 100644 website/docs/services/ec2/vpc_endpoint_services/index.md create mode 100644 website/docs/services/ec2/vpc_endpoint_services_list_only/index.md create mode 100644 website/docs/services/ec2/vpc_endpoint_tags/index.md create mode 100644 website/docs/services/ec2/vpc_endpoints/index.md create mode 100644 website/docs/services/ec2/vpc_endpoints_list_only/index.md create mode 100644 website/docs/services/ec2/vpc_gateway_attachments/index.md create mode 100644 website/docs/services/ec2/vpc_gateway_attachments_list_only/index.md create mode 100644 website/docs/services/ec2/vpc_peering_connection_tags/index.md create mode 100644 website/docs/services/ec2/vpc_peering_connections/index.md create mode 100644 website/docs/services/ec2/vpc_peering_connections_list_only/index.md create mode 100644 website/docs/services/ec2/vpc_tags/index.md create mode 100644 website/docs/services/ec2/vpcdhcp_options_associations/index.md create mode 100644 website/docs/services/ec2/vpcdhcp_options_associations_list_only/index.md create mode 100644 website/docs/services/ec2/vpcs/index.md create mode 100644 website/docs/services/ec2/vpcs_list_only/index.md create mode 100644 website/docs/services/ec2/vpn_connection_routes/index.md create mode 100644 website/docs/services/ec2/vpn_connection_routes_list_only/index.md create mode 100644 website/docs/services/ec2/vpn_connection_tags/index.md create mode 100644 website/docs/services/ec2/vpn_connections/index.md create mode 100644 website/docs/services/ec2/vpn_connections_list_only/index.md create mode 100644 website/docs/services/ec2/vpn_gateway_tags/index.md create mode 100644 website/docs/services/ec2/vpn_gateways/index.md create mode 100644 website/docs/services/ec2/vpn_gateways_list_only/index.md create mode 100644 website/docs/services/ecr/index.md create mode 100644 website/docs/services/ecr/public_repositories/index.md create mode 100644 website/docs/services/ecr/public_repositories_list_only/index.md create mode 100644 website/docs/services/ecr/public_repository_tags/index.md create mode 100644 website/docs/services/ecr/pull_through_cache_rules/index.md create mode 100644 website/docs/services/ecr/pull_through_cache_rules_list_only/index.md create mode 100644 website/docs/services/ecr/registry_policies/index.md create mode 100644 website/docs/services/ecr/registry_policies_list_only/index.md create mode 100644 website/docs/services/ecr/replication_configurations/index.md create mode 100644 website/docs/services/ecr/replication_configurations_list_only/index.md create mode 100644 website/docs/services/ecr/repositories/index.md create mode 100644 website/docs/services/ecr/repositories_list_only/index.md create mode 100644 website/docs/services/ecr/repository_creation_templates/index.md create mode 100644 website/docs/services/ecr/repository_creation_templates_list_only/index.md create mode 100644 website/docs/services/ecr/repository_tags/index.md create mode 100644 website/docs/services/ecs/cluster_capacity_provider_associations/index.md create mode 100644 website/docs/services/ecs/cluster_capacity_provider_associations_list_only/index.md create mode 100644 website/docs/services/ecs/index.md create mode 100644 website/docs/services/ecs/primary_task_sets/index.md create mode 100644 website/docs/services/ecs/service_tags/index.md create mode 100644 website/docs/services/ecs/services/index.md create mode 100644 website/docs/services/ecs/services_list_only/index.md create mode 100644 website/docs/services/ecs/task_definition_tags/index.md create mode 100644 website/docs/services/ecs/task_definitions/index.md create mode 100644 website/docs/services/ecs/task_definitions_list_only/index.md create mode 100644 website/docs/services/ecs/task_sets/index.md create mode 100644 website/docs/services/efs/access_points/index.md create mode 100644 website/docs/services/efs/access_points_list_only/index.md create mode 100644 website/docs/services/efs/file_systems/index.md create mode 100644 website/docs/services/efs/file_systems_list_only/index.md create mode 100644 website/docs/services/efs/index.md create mode 100644 website/docs/services/efs/mount_targets/index.md create mode 100644 website/docs/services/efs/mount_targets_list_only/index.md create mode 100644 website/docs/services/eks/access_entries/index.md create mode 100644 website/docs/services/eks/access_entries_list_only/index.md create mode 100644 website/docs/services/eks/access_entry_tags/index.md create mode 100644 website/docs/services/eks/addon_tags/index.md create mode 100644 website/docs/services/eks/addons/index.md create mode 100644 website/docs/services/eks/addons_list_only/index.md create mode 100644 website/docs/services/eks/cluster_tags/index.md create mode 100644 website/docs/services/eks/clusters/index.md create mode 100644 website/docs/services/eks/clusters_list_only/index.md create mode 100644 website/docs/services/eks/fargate_profile_tags/index.md create mode 100644 website/docs/services/eks/fargate_profiles/index.md create mode 100644 website/docs/services/eks/fargate_profiles_list_only/index.md create mode 100644 website/docs/services/eks/identity_provider_config_tags/index.md create mode 100644 website/docs/services/eks/identity_provider_configs/index.md create mode 100644 website/docs/services/eks/identity_provider_configs_list_only/index.md create mode 100644 website/docs/services/eks/index.md create mode 100644 website/docs/services/eks/nodegroup_tags/index.md create mode 100644 website/docs/services/eks/nodegroups/index.md create mode 100644 website/docs/services/eks/nodegroups_list_only/index.md create mode 100644 website/docs/services/eks/pod_identity_association_tags/index.md create mode 100644 website/docs/services/eks/pod_identity_associations/index.md create mode 100644 website/docs/services/eks/pod_identity_associations_list_only/index.md create mode 100644 website/docs/services/elasticache/global_replication_groups/index.md create mode 100644 website/docs/services/elasticache/global_replication_groups_list_only/index.md create mode 100644 website/docs/services/elasticache/index.md create mode 100644 website/docs/services/elasticache/parameter_group_tags/index.md create mode 100644 website/docs/services/elasticache/parameter_groups/index.md create mode 100644 website/docs/services/elasticache/parameter_groups_list_only/index.md create mode 100644 website/docs/services/elasticache/serverless_cache_tags/index.md create mode 100644 website/docs/services/elasticache/serverless_caches/index.md create mode 100644 website/docs/services/elasticache/serverless_caches_list_only/index.md create mode 100644 website/docs/services/elasticache/subnet_group_tags/index.md create mode 100644 website/docs/services/elasticache/subnet_groups/index.md create mode 100644 website/docs/services/elasticache/subnet_groups_list_only/index.md create mode 100644 website/docs/services/elasticache/user_group_tags/index.md create mode 100644 website/docs/services/elasticache/user_groups/index.md create mode 100644 website/docs/services/elasticache/user_groups_list_only/index.md create mode 100644 website/docs/services/elasticache/user_tags/index.md create mode 100644 website/docs/services/elasticache/users/index.md create mode 100644 website/docs/services/elasticache/users_list_only/index.md create mode 100644 website/docs/services/elasticbeanstalk/application_versions/index.md create mode 100644 website/docs/services/elasticbeanstalk/application_versions_list_only/index.md create mode 100644 website/docs/services/elasticbeanstalk/applications/index.md create mode 100644 website/docs/services/elasticbeanstalk/applications_list_only/index.md create mode 100644 website/docs/services/elasticbeanstalk/configuration_templates/index.md create mode 100644 website/docs/services/elasticbeanstalk/configuration_templates_list_only/index.md create mode 100644 website/docs/services/elasticbeanstalk/environment_tags/index.md create mode 100644 website/docs/services/elasticbeanstalk/environments/index.md create mode 100644 website/docs/services/elasticbeanstalk/environments_list_only/index.md create mode 100644 website/docs/services/elasticbeanstalk/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/listener_rules/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/listener_rules_list_only/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/listeners/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/listeners_list_only/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/load_balancer_tags/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/load_balancers/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/load_balancers_list_only/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/target_group_tags/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/target_groups/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/target_groups_list_only/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/trust_store_revocations/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/trust_store_revocations_list_only/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/trust_store_tags/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/trust_stores/index.md create mode 100644 website/docs/services/elasticloadbalancingv2/trust_stores_list_only/index.md create mode 100644 website/docs/services/emr/index.md create mode 100644 website/docs/services/emr/security_configurations/index.md create mode 100644 website/docs/services/emr/security_configurations_list_only/index.md create mode 100644 website/docs/services/emr/studio_session_mappings/index.md create mode 100644 website/docs/services/emr/studio_session_mappings_list_only/index.md create mode 100644 website/docs/services/emr/studio_tags/index.md create mode 100644 website/docs/services/emr/studios/index.md create mode 100644 website/docs/services/emr/studios_list_only/index.md create mode 100644 website/docs/services/emr/wal_workspace_tags/index.md create mode 100644 website/docs/services/emr/wal_workspaces/index.md create mode 100644 website/docs/services/emr/wal_workspaces_list_only/index.md create mode 100644 website/docs/services/emrcontainers/index.md create mode 100644 website/docs/services/emrcontainers/virtual_cluster_tags/index.md create mode 100644 website/docs/services/emrcontainers/virtual_clusters/index.md create mode 100644 website/docs/services/emrcontainers/virtual_clusters_list_only/index.md create mode 100644 website/docs/services/emrserverless/application_tags/index.md create mode 100644 website/docs/services/emrserverless/applications/index.md create mode 100644 website/docs/services/emrserverless/applications_list_only/index.md create mode 100644 website/docs/services/emrserverless/index.md create mode 100644 website/docs/services/entityresolution/id_mapping_workflow_tags/index.md create mode 100644 website/docs/services/entityresolution/id_mapping_workflows/index.md create mode 100644 website/docs/services/entityresolution/id_mapping_workflows_list_only/index.md create mode 100644 website/docs/services/entityresolution/id_namespace_tags/index.md create mode 100644 website/docs/services/entityresolution/id_namespaces/index.md create mode 100644 website/docs/services/entityresolution/id_namespaces_list_only/index.md create mode 100644 website/docs/services/entityresolution/index.md create mode 100644 website/docs/services/entityresolution/matching_workflow_tags/index.md create mode 100644 website/docs/services/entityresolution/matching_workflows/index.md create mode 100644 website/docs/services/entityresolution/matching_workflows_list_only/index.md create mode 100644 website/docs/services/entityresolution/policy_statements/index.md create mode 100644 website/docs/services/entityresolution/policy_statements_list_only/index.md create mode 100644 website/docs/services/entityresolution/schema_mapping_tags/index.md create mode 100644 website/docs/services/entityresolution/schema_mappings/index.md create mode 100644 website/docs/services/entityresolution/schema_mappings_list_only/index.md create mode 100644 website/docs/services/events/api_destinations/index.md create mode 100644 website/docs/services/events/api_destinations_list_only/index.md create mode 100644 website/docs/services/events/archives/index.md create mode 100644 website/docs/services/events/archives_list_only/index.md create mode 100644 website/docs/services/events/connections/index.md create mode 100644 website/docs/services/events/connections_list_only/index.md create mode 100644 website/docs/services/events/endpoints/index.md create mode 100644 website/docs/services/events/endpoints_list_only/index.md create mode 100644 website/docs/services/events/event_bus_tags/index.md create mode 100644 website/docs/services/events/event_buses/index.md create mode 100644 website/docs/services/events/event_buses_list_only/index.md create mode 100644 website/docs/services/events/index.md create mode 100644 website/docs/services/events/rules/index.md create mode 100644 website/docs/services/events/rules_list_only/index.md create mode 100644 website/docs/services/eventschemas/discoverer_tags/index.md create mode 100644 website/docs/services/eventschemas/discoverers/index.md create mode 100644 website/docs/services/eventschemas/discoverers_list_only/index.md create mode 100644 website/docs/services/eventschemas/index.md create mode 100644 website/docs/services/eventschemas/registries/index.md create mode 100644 website/docs/services/eventschemas/registries_list_only/index.md create mode 100644 website/docs/services/eventschemas/registry_policies/index.md create mode 100644 website/docs/services/eventschemas/registry_tags/index.md create mode 100644 website/docs/services/eventschemas/schema_tags/index.md create mode 100644 website/docs/services/eventschemas/schemata/index.md create mode 100644 website/docs/services/eventschemas/schemata_list_only/index.md create mode 100644 website/docs/services/evidently/experiments/index.md create mode 100644 website/docs/services/evidently/features/index.md create mode 100644 website/docs/services/evidently/index.md create mode 100644 website/docs/services/evidently/launches/index.md create mode 100644 website/docs/services/evidently/projects/index.md create mode 100644 website/docs/services/evidently/segment_tags/index.md create mode 100644 website/docs/services/evidently/segments/index.md create mode 100644 website/docs/services/evidently/segments_list_only/index.md create mode 100644 website/docs/services/finspace/environment_tags/index.md create mode 100644 website/docs/services/finspace/environments/index.md create mode 100644 website/docs/services/finspace/environments_list_only/index.md create mode 100644 website/docs/services/finspace/index.md create mode 100644 website/docs/services/fis/experiment_template_tags/index.md create mode 100644 website/docs/services/fis/experiment_templates/index.md create mode 100644 website/docs/services/fis/experiment_templates_list_only/index.md create mode 100644 website/docs/services/fis/index.md create mode 100644 website/docs/services/fis/target_account_configurations/index.md create mode 100644 website/docs/services/fis/target_account_configurations_list_only/index.md create mode 100644 website/docs/services/fms/index.md create mode 100644 website/docs/services/fms/notification_channels/index.md create mode 100644 website/docs/services/fms/notification_channels_list_only/index.md create mode 100644 website/docs/services/fms/policies/index.md create mode 100644 website/docs/services/fms/policies_list_only/index.md create mode 100644 website/docs/services/fms/policy_tags/index.md create mode 100644 website/docs/services/fms/resource_set_tags/index.md create mode 100644 website/docs/services/fms/resource_sets/index.md create mode 100644 website/docs/services/fms/resource_sets_list_only/index.md create mode 100644 website/docs/services/forecast/dataset_group_tags/index.md create mode 100644 website/docs/services/forecast/dataset_groups/index.md create mode 100644 website/docs/services/forecast/dataset_groups_list_only/index.md create mode 100644 website/docs/services/forecast/dataset_tags/index.md create mode 100644 website/docs/services/forecast/datasets/index.md create mode 100644 website/docs/services/forecast/datasets_list_only/index.md create mode 100644 website/docs/services/forecast/index.md create mode 100644 website/docs/services/frauddetector/detector_tags/index.md create mode 100644 website/docs/services/frauddetector/detectors/index.md create mode 100644 website/docs/services/frauddetector/detectors_list_only/index.md create mode 100644 website/docs/services/frauddetector/event_type_tags/index.md create mode 100644 website/docs/services/frauddetector/event_types/index.md create mode 100644 website/docs/services/frauddetector/event_types_list_only/index.md create mode 100644 website/docs/services/frauddetector/index.md create mode 100644 website/docs/services/frauddetector/label_tags/index.md create mode 100644 website/docs/services/frauddetector/labels/index.md create mode 100644 website/docs/services/frauddetector/labels_list_only/index.md create mode 100644 website/docs/services/frauddetector/list_tags/index.md create mode 100644 website/docs/services/frauddetector/lists/index.md create mode 100644 website/docs/services/frauddetector/lists_list_only/index.md create mode 100644 website/docs/services/frauddetector/outcome_tags/index.md create mode 100644 website/docs/services/frauddetector/outcomes/index.md create mode 100644 website/docs/services/frauddetector/outcomes_list_only/index.md create mode 100644 website/docs/services/frauddetector/variable_tags/index.md create mode 100644 website/docs/services/frauddetector/variables/index.md create mode 100644 website/docs/services/frauddetector/variables_list_only/index.md create mode 100644 website/docs/services/fsx/data_repository_association_tags/index.md create mode 100644 website/docs/services/fsx/data_repository_associations/index.md create mode 100644 website/docs/services/fsx/data_repository_associations_list_only/index.md create mode 100644 website/docs/services/fsx/index.md create mode 100644 website/docs/services/gamelift/aliases/index.md create mode 100644 website/docs/services/gamelift/aliases_list_only/index.md create mode 100644 website/docs/services/gamelift/builds/index.md create mode 100644 website/docs/services/gamelift/builds_list_only/index.md create mode 100644 website/docs/services/gamelift/container_fleet_tags/index.md create mode 100644 website/docs/services/gamelift/container_fleets/index.md create mode 100644 website/docs/services/gamelift/container_fleets_list_only/index.md create mode 100644 website/docs/services/gamelift/container_group_definition_tags/index.md create mode 100644 website/docs/services/gamelift/container_group_definitions/index.md create mode 100644 website/docs/services/gamelift/container_group_definitions_list_only/index.md create mode 100644 website/docs/services/gamelift/fleets/index.md create mode 100644 website/docs/services/gamelift/fleets_list_only/index.md create mode 100644 website/docs/services/gamelift/game_server_group_tags/index.md create mode 100644 website/docs/services/gamelift/game_server_groups/index.md create mode 100644 website/docs/services/gamelift/game_server_groups_list_only/index.md create mode 100644 website/docs/services/gamelift/game_session_queue_tags/index.md create mode 100644 website/docs/services/gamelift/game_session_queues/index.md create mode 100644 website/docs/services/gamelift/game_session_queues_list_only/index.md create mode 100644 website/docs/services/gamelift/index.md create mode 100644 website/docs/services/gamelift/location_tags/index.md create mode 100644 website/docs/services/gamelift/locations/index.md create mode 100644 website/docs/services/gamelift/locations_list_only/index.md create mode 100644 website/docs/services/gamelift/matchmaking_configuration_tags/index.md create mode 100644 website/docs/services/gamelift/matchmaking_configurations/index.md create mode 100644 website/docs/services/gamelift/matchmaking_configurations_list_only/index.md create mode 100644 website/docs/services/gamelift/matchmaking_rule_set_tags/index.md create mode 100644 website/docs/services/gamelift/matchmaking_rule_sets/index.md create mode 100644 website/docs/services/gamelift/matchmaking_rule_sets_list_only/index.md create mode 100644 website/docs/services/gamelift/script_tags/index.md create mode 100644 website/docs/services/gamelift/scripts/index.md create mode 100644 website/docs/services/gamelift/scripts_list_only/index.md create mode 100644 website/docs/services/globalaccelerator/accelerator_tags/index.md create mode 100644 website/docs/services/globalaccelerator/accelerators/index.md create mode 100644 website/docs/services/globalaccelerator/accelerators_list_only/index.md create mode 100644 website/docs/services/globalaccelerator/cross_account_attachment_tags/index.md create mode 100644 website/docs/services/globalaccelerator/cross_account_attachments/index.md create mode 100644 website/docs/services/globalaccelerator/cross_account_attachments_list_only/index.md create mode 100644 website/docs/services/globalaccelerator/endpoint_groups/index.md create mode 100644 website/docs/services/globalaccelerator/endpoint_groups_list_only/index.md create mode 100644 website/docs/services/globalaccelerator/index.md create mode 100644 website/docs/services/globalaccelerator/listeners/index.md create mode 100644 website/docs/services/globalaccelerator/listeners_list_only/index.md create mode 100644 website/docs/services/glue/crawler_tags/index.md create mode 100644 website/docs/services/glue/crawlers/index.md create mode 100644 website/docs/services/glue/crawlers_list_only/index.md create mode 100644 website/docs/services/glue/databases/index.md create mode 100644 website/docs/services/glue/databases_list_only/index.md create mode 100644 website/docs/services/glue/index.md create mode 100644 website/docs/services/glue/job_tags/index.md create mode 100644 website/docs/services/glue/jobs/index.md create mode 100644 website/docs/services/glue/jobs_list_only/index.md create mode 100644 website/docs/services/glue/schema_version_metadata/index.md create mode 100644 website/docs/services/glue/schema_version_metadata_list_only/index.md create mode 100644 website/docs/services/glue/schema_versions/index.md create mode 100644 website/docs/services/glue/schema_versions_list_only/index.md create mode 100644 website/docs/services/glue/trigger_tags/index.md create mode 100644 website/docs/services/glue/triggers/index.md create mode 100644 website/docs/services/glue/triggers_list_only/index.md create mode 100644 website/docs/services/glue/usage_profile_tags/index.md create mode 100644 website/docs/services/glue/usage_profiles/index.md create mode 100644 website/docs/services/glue/usage_profiles_list_only/index.md create mode 100644 website/docs/services/grafana/index.md create mode 100644 website/docs/services/grafana/workspaces/index.md create mode 100644 website/docs/services/grafana/workspaces_list_only/index.md create mode 100644 website/docs/services/greengrassv2/component_version_tags/index.md create mode 100644 website/docs/services/greengrassv2/component_versions/index.md create mode 100644 website/docs/services/greengrassv2/component_versions_list_only/index.md create mode 100644 website/docs/services/greengrassv2/deployment_tags/index.md create mode 100644 website/docs/services/greengrassv2/deployments/index.md create mode 100644 website/docs/services/greengrassv2/deployments_list_only/index.md create mode 100644 website/docs/services/greengrassv2/index.md create mode 100644 website/docs/services/groundstation/config_tags/index.md create mode 100644 website/docs/services/groundstation/configs/index.md create mode 100644 website/docs/services/groundstation/configs_list_only/index.md create mode 100644 website/docs/services/groundstation/dataflow_endpoint_group_tags/index.md create mode 100644 website/docs/services/groundstation/dataflow_endpoint_groups/index.md create mode 100644 website/docs/services/groundstation/dataflow_endpoint_groups_list_only/index.md create mode 100644 website/docs/services/groundstation/index.md create mode 100644 website/docs/services/groundstation/mission_profile_tags/index.md create mode 100644 website/docs/services/groundstation/mission_profiles/index.md create mode 100644 website/docs/services/groundstation/mission_profiles_list_only/index.md create mode 100644 website/docs/services/guardduty/detector_tags/index.md create mode 100644 website/docs/services/guardduty/detectors/index.md create mode 100644 website/docs/services/guardduty/detectors_list_only/index.md create mode 100644 website/docs/services/guardduty/filter_tags/index.md create mode 100644 website/docs/services/guardduty/filters/index.md create mode 100644 website/docs/services/guardduty/filters_list_only/index.md create mode 100644 website/docs/services/guardduty/index.md create mode 100644 website/docs/services/guardduty/ip_set_tags/index.md create mode 100644 website/docs/services/guardduty/ip_sets/index.md create mode 100644 website/docs/services/guardduty/ip_sets_list_only/index.md create mode 100644 website/docs/services/guardduty/malware_protection_plan_tags/index.md create mode 100644 website/docs/services/guardduty/malware_protection_plans/index.md create mode 100644 website/docs/services/guardduty/malware_protection_plans_list_only/index.md create mode 100644 website/docs/services/guardduty/masters/index.md create mode 100644 website/docs/services/guardduty/masters_list_only/index.md create mode 100644 website/docs/services/guardduty/members/index.md create mode 100644 website/docs/services/guardduty/members_list_only/index.md create mode 100644 website/docs/services/guardduty/threat_intel_set_tags/index.md create mode 100644 website/docs/services/guardduty/threat_intel_sets/index.md create mode 100644 website/docs/services/guardduty/threat_intel_sets_list_only/index.md create mode 100644 website/docs/services/healthimaging/datastore_tags/index.md create mode 100644 website/docs/services/healthimaging/datastores/index.md create mode 100644 website/docs/services/healthimaging/datastores_list_only/index.md create mode 100644 website/docs/services/healthimaging/index.md create mode 100644 website/docs/services/healthlake/fhir_datastore_tags/index.md create mode 100644 website/docs/services/healthlake/fhir_datastores/index.md create mode 100644 website/docs/services/healthlake/fhir_datastores_list_only/index.md create mode 100644 website/docs/services/healthlake/index.md create mode 100644 website/docs/services/iam/group_policies/index.md create mode 100644 website/docs/services/iam/groups/index.md create mode 100644 website/docs/services/iam/groups_list_only/index.md create mode 100644 website/docs/services/iam/index.md create mode 100644 website/docs/services/iam/instance_profiles/index.md create mode 100644 website/docs/services/iam/instance_profiles_list_only/index.md create mode 100644 website/docs/services/iam/managed_policies/index.md create mode 100644 website/docs/services/iam/managed_policies_list_only/index.md create mode 100644 website/docs/services/iam/oidc_provider_tags/index.md create mode 100644 website/docs/services/iam/oidc_providers/index.md create mode 100644 website/docs/services/iam/oidc_providers_list_only/index.md create mode 100644 website/docs/services/iam/role_policies/index.md create mode 100644 website/docs/services/iam/role_tags/index.md create mode 100644 website/docs/services/iam/roles/index.md create mode 100644 website/docs/services/iam/roles_list_only/index.md create mode 100644 website/docs/services/iam/saml_provider_tags/index.md create mode 100644 website/docs/services/iam/saml_providers/index.md create mode 100644 website/docs/services/iam/saml_providers_list_only/index.md create mode 100644 website/docs/services/iam/server_certificate_tags/index.md create mode 100644 website/docs/services/iam/server_certificates/index.md create mode 100644 website/docs/services/iam/server_certificates_list_only/index.md create mode 100644 website/docs/services/iam/service_linked_roles/index.md create mode 100644 website/docs/services/iam/user_policies/index.md create mode 100644 website/docs/services/iam/user_tags/index.md create mode 100644 website/docs/services/iam/users/index.md create mode 100644 website/docs/services/iam/users_list_only/index.md create mode 100644 website/docs/services/iam/virtualmfa_device_tags/index.md create mode 100644 website/docs/services/iam/virtualmfa_devices/index.md create mode 100644 website/docs/services/iam/virtualmfa_devices_list_only/index.md create mode 100644 website/docs/services/identitystore/group_memberships/index.md create mode 100644 website/docs/services/identitystore/group_memberships_list_only/index.md create mode 100644 website/docs/services/identitystore/groups/index.md create mode 100644 website/docs/services/identitystore/groups_list_only/index.md create mode 100644 website/docs/services/identitystore/index.md create mode 100644 website/docs/services/imagebuilder/component_tags/index.md create mode 100644 website/docs/services/imagebuilder/components/index.md create mode 100644 website/docs/services/imagebuilder/components_list_only/index.md create mode 100644 website/docs/services/imagebuilder/container_recipe_tags/index.md create mode 100644 website/docs/services/imagebuilder/container_recipes/index.md create mode 100644 website/docs/services/imagebuilder/container_recipes_list_only/index.md create mode 100644 website/docs/services/imagebuilder/distribution_configuration_tags/index.md create mode 100644 website/docs/services/imagebuilder/distribution_configurations/index.md create mode 100644 website/docs/services/imagebuilder/distribution_configurations_list_only/index.md create mode 100644 website/docs/services/imagebuilder/image_pipeline_tags/index.md create mode 100644 website/docs/services/imagebuilder/image_pipelines/index.md create mode 100644 website/docs/services/imagebuilder/image_pipelines_list_only/index.md create mode 100644 website/docs/services/imagebuilder/image_recipe_tags/index.md create mode 100644 website/docs/services/imagebuilder/image_recipes/index.md create mode 100644 website/docs/services/imagebuilder/image_recipes_list_only/index.md create mode 100644 website/docs/services/imagebuilder/image_tags/index.md create mode 100644 website/docs/services/imagebuilder/images/index.md create mode 100644 website/docs/services/imagebuilder/images_list_only/index.md create mode 100644 website/docs/services/imagebuilder/index.md create mode 100644 website/docs/services/imagebuilder/infrastructure_configuration_tags/index.md create mode 100644 website/docs/services/imagebuilder/infrastructure_configurations/index.md create mode 100644 website/docs/services/imagebuilder/infrastructure_configurations_list_only/index.md create mode 100644 website/docs/services/imagebuilder/lifecycle_policies/index.md create mode 100644 website/docs/services/imagebuilder/lifecycle_policies_list_only/index.md create mode 100644 website/docs/services/imagebuilder/lifecycle_policy_tags/index.md create mode 100644 website/docs/services/imagebuilder/workflow_tags/index.md create mode 100644 website/docs/services/imagebuilder/workflows/index.md create mode 100644 website/docs/services/imagebuilder/workflows_list_only/index.md create mode 100644 website/docs/services/inspector/assessment_targets/index.md create mode 100644 website/docs/services/inspector/assessment_targets_list_only/index.md create mode 100644 website/docs/services/inspector/assessment_templates/index.md create mode 100644 website/docs/services/inspector/assessment_templates_list_only/index.md create mode 100644 website/docs/services/inspector/index.md create mode 100644 website/docs/services/inspector/resource_groups/index.md create mode 100644 website/docs/services/inspectorv2/cis_scan_configuration_tags/index.md create mode 100644 website/docs/services/inspectorv2/cis_scan_configurations/index.md create mode 100644 website/docs/services/inspectorv2/cis_scan_configurations_list_only/index.md create mode 100644 website/docs/services/inspectorv2/filters/index.md create mode 100644 website/docs/services/inspectorv2/filters_list_only/index.md create mode 100644 website/docs/services/inspectorv2/index.md create mode 100644 website/docs/services/internetmonitor/index.md create mode 100644 website/docs/services/internetmonitor/monitor_tags/index.md create mode 100644 website/docs/services/internetmonitor/monitors/index.md create mode 100644 website/docs/services/internetmonitor/monitors_list_only/index.md create mode 100644 website/docs/services/invoicing/index.md create mode 100644 website/docs/services/invoicing/invoice_units/index.md create mode 100644 website/docs/services/invoicing/invoice_units_list_only/index.md create mode 100644 website/docs/services/iot/account_audit_configurations/index.md create mode 100644 website/docs/services/iot/account_audit_configurations_list_only/index.md create mode 100644 website/docs/services/iot/authorizer_tags/index.md create mode 100644 website/docs/services/iot/authorizers/index.md create mode 100644 website/docs/services/iot/authorizers_list_only/index.md create mode 100644 website/docs/services/iot/billing_group_tags/index.md create mode 100644 website/docs/services/iot/billing_groups/index.md create mode 100644 website/docs/services/iot/billing_groups_list_only/index.md create mode 100644 website/docs/services/iot/ca_certificate_tags/index.md create mode 100644 website/docs/services/iot/ca_certificates/index.md create mode 100644 website/docs/services/iot/ca_certificates_list_only/index.md create mode 100644 website/docs/services/iot/certificate_provider_tags/index.md create mode 100644 website/docs/services/iot/certificate_providers/index.md create mode 100644 website/docs/services/iot/certificate_providers_list_only/index.md create mode 100644 website/docs/services/iot/certificates/index.md create mode 100644 website/docs/services/iot/certificates_list_only/index.md create mode 100644 website/docs/services/iot/command_tags/index.md create mode 100644 website/docs/services/iot/commands/index.md create mode 100644 website/docs/services/iot/commands_list_only/index.md create mode 100644 website/docs/services/iot/custom_metric_tags/index.md create mode 100644 website/docs/services/iot/custom_metrics/index.md create mode 100644 website/docs/services/iot/custom_metrics_list_only/index.md create mode 100644 website/docs/services/iot/dimension_tags/index.md create mode 100644 website/docs/services/iot/dimensions/index.md create mode 100644 website/docs/services/iot/dimensions_list_only/index.md create mode 100644 website/docs/services/iot/domain_configuration_tags/index.md create mode 100644 website/docs/services/iot/domain_configurations/index.md create mode 100644 website/docs/services/iot/domain_configurations_list_only/index.md create mode 100644 website/docs/services/iot/fleet_metric_tags/index.md create mode 100644 website/docs/services/iot/fleet_metrics/index.md create mode 100644 website/docs/services/iot/fleet_metrics_list_only/index.md create mode 100644 website/docs/services/iot/index.md create mode 100644 website/docs/services/iot/job_template_tags/index.md create mode 100644 website/docs/services/iot/job_templates/index.md create mode 100644 website/docs/services/iot/job_templates_list_only/index.md create mode 100644 website/docs/services/iot/loggings/index.md create mode 100644 website/docs/services/iot/loggings_list_only/index.md create mode 100644 website/docs/services/iot/mitigation_action_tags/index.md create mode 100644 website/docs/services/iot/mitigation_actions/index.md create mode 100644 website/docs/services/iot/mitigation_actions_list_only/index.md create mode 100644 website/docs/services/iot/policies/index.md create mode 100644 website/docs/services/iot/policies_list_only/index.md create mode 100644 website/docs/services/iot/policy_tags/index.md create mode 100644 website/docs/services/iot/provisioning_template_tags/index.md create mode 100644 website/docs/services/iot/provisioning_templates/index.md create mode 100644 website/docs/services/iot/provisioning_templates_list_only/index.md create mode 100644 website/docs/services/iot/resource_specific_loggings/index.md create mode 100644 website/docs/services/iot/resource_specific_loggings_list_only/index.md create mode 100644 website/docs/services/iot/role_alias_tags/index.md create mode 100644 website/docs/services/iot/role_aliases/index.md create mode 100644 website/docs/services/iot/role_aliases_list_only/index.md create mode 100644 website/docs/services/iot/scheduled_audit_tags/index.md create mode 100644 website/docs/services/iot/scheduled_audits/index.md create mode 100644 website/docs/services/iot/scheduled_audits_list_only/index.md create mode 100644 website/docs/services/iot/security_profile_tags/index.md create mode 100644 website/docs/services/iot/security_profiles/index.md create mode 100644 website/docs/services/iot/security_profiles_list_only/index.md create mode 100644 website/docs/services/iot/software_package_tags/index.md create mode 100644 website/docs/services/iot/software_package_version_tags/index.md create mode 100644 website/docs/services/iot/software_package_versions/index.md create mode 100644 website/docs/services/iot/software_package_versions_list_only/index.md create mode 100644 website/docs/services/iot/software_packages/index.md create mode 100644 website/docs/services/iot/software_packages_list_only/index.md create mode 100644 website/docs/services/iot/thing_group_tags/index.md create mode 100644 website/docs/services/iot/thing_groups/index.md create mode 100644 website/docs/services/iot/thing_groups_list_only/index.md create mode 100644 website/docs/services/iot/thing_type_tags/index.md create mode 100644 website/docs/services/iot/thing_types/index.md create mode 100644 website/docs/services/iot/thing_types_list_only/index.md create mode 100644 website/docs/services/iot/things/index.md create mode 100644 website/docs/services/iot/things_list_only/index.md create mode 100644 website/docs/services/iot/topic_rule_destinations/index.md create mode 100644 website/docs/services/iot/topic_rule_destinations_list_only/index.md create mode 100644 website/docs/services/iot/topic_rule_tags/index.md create mode 100644 website/docs/services/iot/topic_rules/index.md create mode 100644 website/docs/services/iot/topic_rules_list_only/index.md create mode 100644 website/docs/services/iotanalytics/dataset_tags/index.md create mode 100644 website/docs/services/iotanalytics/datasets/index.md create mode 100644 website/docs/services/iotanalytics/datasets_list_only/index.md create mode 100644 website/docs/services/iotanalytics/index.md create mode 100644 website/docs/services/iotanalytics/pipeline_tags/index.md create mode 100644 website/docs/services/iotanalytics/pipelines/index.md create mode 100644 website/docs/services/iotanalytics/pipelines_list_only/index.md create mode 100644 website/docs/services/iotcoredeviceadvisor/index.md create mode 100644 website/docs/services/iotcoredeviceadvisor/suite_definition_tags/index.md create mode 100644 website/docs/services/iotcoredeviceadvisor/suite_definitions/index.md create mode 100644 website/docs/services/iotcoredeviceadvisor/suite_definitions_list_only/index.md create mode 100644 website/docs/services/iotevents/alarm_model_tags/index.md create mode 100644 website/docs/services/iotevents/alarm_models/index.md create mode 100644 website/docs/services/iotevents/alarm_models_list_only/index.md create mode 100644 website/docs/services/iotevents/detector_model_tags/index.md create mode 100644 website/docs/services/iotevents/detector_models/index.md create mode 100644 website/docs/services/iotevents/detector_models_list_only/index.md create mode 100644 website/docs/services/iotevents/index.md create mode 100644 website/docs/services/iotevents/input_tags/index.md create mode 100644 website/docs/services/iotevents/inputs/index.md create mode 100644 website/docs/services/iotevents/inputs_list_only/index.md create mode 100644 website/docs/services/iotfleethub/application_tags/index.md create mode 100644 website/docs/services/iotfleethub/applications/index.md create mode 100644 website/docs/services/iotfleethub/applications_list_only/index.md create mode 100644 website/docs/services/iotfleethub/index.md create mode 100644 website/docs/services/iotfleetwise/campaign_tags/index.md create mode 100644 website/docs/services/iotfleetwise/campaigns/index.md create mode 100644 website/docs/services/iotfleetwise/campaigns_list_only/index.md create mode 100644 website/docs/services/iotfleetwise/decoder_manifest_tags/index.md create mode 100644 website/docs/services/iotfleetwise/decoder_manifests/index.md create mode 100644 website/docs/services/iotfleetwise/decoder_manifests_list_only/index.md create mode 100644 website/docs/services/iotfleetwise/fleet_tags/index.md create mode 100644 website/docs/services/iotfleetwise/fleets/index.md create mode 100644 website/docs/services/iotfleetwise/fleets_list_only/index.md create mode 100644 website/docs/services/iotfleetwise/index.md create mode 100644 website/docs/services/iotfleetwise/model_manifest_tags/index.md create mode 100644 website/docs/services/iotfleetwise/model_manifests/index.md create mode 100644 website/docs/services/iotfleetwise/model_manifests_list_only/index.md create mode 100644 website/docs/services/iotfleetwise/signal_catalog_tags/index.md create mode 100644 website/docs/services/iotfleetwise/signal_catalogs/index.md create mode 100644 website/docs/services/iotfleetwise/signal_catalogs_list_only/index.md create mode 100644 website/docs/services/iotfleetwise/state_template_tags/index.md create mode 100644 website/docs/services/iotfleetwise/state_templates/index.md create mode 100644 website/docs/services/iotfleetwise/state_templates_list_only/index.md create mode 100644 website/docs/services/iotfleetwise/vehicle_tags/index.md create mode 100644 website/docs/services/iotfleetwise/vehicles/index.md create mode 100644 website/docs/services/iotfleetwise/vehicles_list_only/index.md create mode 100644 website/docs/services/iotsitewise/access_policies/index.md create mode 100644 website/docs/services/iotsitewise/access_policies_list_only/index.md create mode 100644 website/docs/services/iotsitewise/asset_model_tags/index.md create mode 100644 website/docs/services/iotsitewise/asset_models/index.md create mode 100644 website/docs/services/iotsitewise/asset_models_list_only/index.md create mode 100644 website/docs/services/iotsitewise/asset_tags/index.md create mode 100644 website/docs/services/iotsitewise/assets/index.md create mode 100644 website/docs/services/iotsitewise/assets_list_only/index.md create mode 100644 website/docs/services/iotsitewise/dashboard_tags/index.md create mode 100644 website/docs/services/iotsitewise/dashboards/index.md create mode 100644 website/docs/services/iotsitewise/dashboards_list_only/index.md create mode 100644 website/docs/services/iotsitewise/gateway_tags/index.md create mode 100644 website/docs/services/iotsitewise/gateways/index.md create mode 100644 website/docs/services/iotsitewise/gateways_list_only/index.md create mode 100644 website/docs/services/iotsitewise/index.md create mode 100644 website/docs/services/iotsitewise/portal_tags/index.md create mode 100644 website/docs/services/iotsitewise/portals/index.md create mode 100644 website/docs/services/iotsitewise/portals_list_only/index.md create mode 100644 website/docs/services/iotsitewise/project_tags/index.md create mode 100644 website/docs/services/iotsitewise/projects/index.md create mode 100644 website/docs/services/iotsitewise/projects_list_only/index.md create mode 100644 website/docs/services/iottwinmaker/component_type_tags/index.md create mode 100644 website/docs/services/iottwinmaker/component_types/index.md create mode 100644 website/docs/services/iottwinmaker/component_types_list_only/index.md create mode 100644 website/docs/services/iottwinmaker/entities/index.md create mode 100644 website/docs/services/iottwinmaker/entities_list_only/index.md create mode 100644 website/docs/services/iottwinmaker/entity_tags/index.md create mode 100644 website/docs/services/iottwinmaker/index.md create mode 100644 website/docs/services/iottwinmaker/scene_tags/index.md create mode 100644 website/docs/services/iottwinmaker/scenes/index.md create mode 100644 website/docs/services/iottwinmaker/scenes_list_only/index.md create mode 100644 website/docs/services/iottwinmaker/sync_job_tags/index.md create mode 100644 website/docs/services/iottwinmaker/sync_jobs/index.md create mode 100644 website/docs/services/iottwinmaker/sync_jobs_list_only/index.md create mode 100644 website/docs/services/iottwinmaker/workspace_tags/index.md create mode 100644 website/docs/services/iottwinmaker/workspaces/index.md create mode 100644 website/docs/services/iottwinmaker/workspaces_list_only/index.md create mode 100644 website/docs/services/iotwireless/destination_tags/index.md create mode 100644 website/docs/services/iotwireless/destinations/index.md create mode 100644 website/docs/services/iotwireless/destinations_list_only/index.md create mode 100644 website/docs/services/iotwireless/device_profile_tags/index.md create mode 100644 website/docs/services/iotwireless/device_profiles/index.md create mode 100644 website/docs/services/iotwireless/device_profiles_list_only/index.md create mode 100644 website/docs/services/iotwireless/fuota_task_tags/index.md create mode 100644 website/docs/services/iotwireless/fuota_tasks/index.md create mode 100644 website/docs/services/iotwireless/fuota_tasks_list_only/index.md create mode 100644 website/docs/services/iotwireless/index.md create mode 100644 website/docs/services/iotwireless/multicast_group_tags/index.md create mode 100644 website/docs/services/iotwireless/multicast_groups/index.md create mode 100644 website/docs/services/iotwireless/multicast_groups_list_only/index.md create mode 100644 website/docs/services/iotwireless/network_analyzer_configuration_tags/index.md create mode 100644 website/docs/services/iotwireless/network_analyzer_configurations/index.md create mode 100644 website/docs/services/iotwireless/network_analyzer_configurations_list_only/index.md create mode 100644 website/docs/services/iotwireless/partner_account_tags/index.md create mode 100644 website/docs/services/iotwireless/partner_accounts/index.md create mode 100644 website/docs/services/iotwireless/partner_accounts_list_only/index.md create mode 100644 website/docs/services/iotwireless/service_profile_tags/index.md create mode 100644 website/docs/services/iotwireless/service_profiles/index.md create mode 100644 website/docs/services/iotwireless/service_profiles_list_only/index.md create mode 100644 website/docs/services/iotwireless/task_definition_tags/index.md create mode 100644 website/docs/services/iotwireless/task_definitions/index.md create mode 100644 website/docs/services/iotwireless/task_definitions_list_only/index.md create mode 100644 website/docs/services/iotwireless/wireless_device_import_task_tags/index.md create mode 100644 website/docs/services/iotwireless/wireless_device_import_tasks/index.md create mode 100644 website/docs/services/iotwireless/wireless_device_import_tasks_list_only/index.md create mode 100644 website/docs/services/iotwireless/wireless_device_tags/index.md create mode 100644 website/docs/services/iotwireless/wireless_devices/index.md create mode 100644 website/docs/services/iotwireless/wireless_devices_list_only/index.md create mode 100644 website/docs/services/iotwireless/wireless_gateway_tags/index.md create mode 100644 website/docs/services/iotwireless/wireless_gateways/index.md create mode 100644 website/docs/services/iotwireless/wireless_gateways_list_only/index.md create mode 100644 website/docs/services/ivs/channel_tags/index.md create mode 100644 website/docs/services/ivs/channels/index.md create mode 100644 website/docs/services/ivs/channels_list_only/index.md create mode 100644 website/docs/services/ivs/encoder_configuration_tags/index.md create mode 100644 website/docs/services/ivs/encoder_configurations/index.md create mode 100644 website/docs/services/ivs/encoder_configurations_list_only/index.md create mode 100644 website/docs/services/ivs/index.md create mode 100644 website/docs/services/ivs/ingest_configuration_tags/index.md create mode 100644 website/docs/services/ivs/ingest_configurations/index.md create mode 100644 website/docs/services/ivs/ingest_configurations_list_only/index.md create mode 100644 website/docs/services/ivs/playback_key_pair_tags/index.md create mode 100644 website/docs/services/ivs/playback_key_pairs/index.md create mode 100644 website/docs/services/ivs/playback_key_pairs_list_only/index.md create mode 100644 website/docs/services/ivs/playback_restriction_policies/index.md create mode 100644 website/docs/services/ivs/playback_restriction_policies_list_only/index.md create mode 100644 website/docs/services/ivs/playback_restriction_policy_tags/index.md create mode 100644 website/docs/services/ivs/public_key_tags/index.md create mode 100644 website/docs/services/ivs/public_keys/index.md create mode 100644 website/docs/services/ivs/public_keys_list_only/index.md create mode 100644 website/docs/services/ivs/recording_configuration_tags/index.md create mode 100644 website/docs/services/ivs/recording_configurations/index.md create mode 100644 website/docs/services/ivs/recording_configurations_list_only/index.md create mode 100644 website/docs/services/ivs/stage_tags/index.md create mode 100644 website/docs/services/ivs/stages/index.md create mode 100644 website/docs/services/ivs/stages_list_only/index.md create mode 100644 website/docs/services/ivs/storage_configuration_tags/index.md create mode 100644 website/docs/services/ivs/storage_configurations/index.md create mode 100644 website/docs/services/ivs/storage_configurations_list_only/index.md create mode 100644 website/docs/services/ivs/stream_key_tags/index.md create mode 100644 website/docs/services/ivs/stream_keys/index.md create mode 100644 website/docs/services/ivs/stream_keys_list_only/index.md create mode 100644 website/docs/services/ivschat/index.md create mode 100644 website/docs/services/ivschat/logging_configuration_tags/index.md create mode 100644 website/docs/services/ivschat/logging_configurations/index.md create mode 100644 website/docs/services/ivschat/logging_configurations_list_only/index.md create mode 100644 website/docs/services/ivschat/room_tags/index.md create mode 100644 website/docs/services/ivschat/rooms/index.md create mode 100644 website/docs/services/ivschat/rooms_list_only/index.md create mode 100644 website/docs/services/kafkaconnect/connector_tags/index.md create mode 100644 website/docs/services/kafkaconnect/connectors/index.md create mode 100644 website/docs/services/kafkaconnect/connectors_list_only/index.md create mode 100644 website/docs/services/kafkaconnect/custom_plugin_tags/index.md create mode 100644 website/docs/services/kafkaconnect/custom_plugins/index.md create mode 100644 website/docs/services/kafkaconnect/custom_plugins_list_only/index.md create mode 100644 website/docs/services/kafkaconnect/index.md create mode 100644 website/docs/services/kafkaconnect/worker_configuration_tags/index.md create mode 100644 website/docs/services/kafkaconnect/worker_configurations/index.md create mode 100644 website/docs/services/kafkaconnect/worker_configurations_list_only/index.md create mode 100644 website/docs/services/kendra/data_source_tags/index.md create mode 100644 website/docs/services/kendra/data_sources/index.md create mode 100644 website/docs/services/kendra/data_sources_list_only/index.md create mode 100644 website/docs/services/kendra/faq_tags/index.md create mode 100644 website/docs/services/kendra/faqs/index.md create mode 100644 website/docs/services/kendra/faqs_list_only/index.md create mode 100644 website/docs/services/kendra/index.md create mode 100644 website/docs/services/kendra/index_tags/index.md create mode 100644 website/docs/services/kendra/indices/index.md create mode 100644 website/docs/services/kendra/indices_list_only/index.md create mode 100644 website/docs/services/kendraranking/execution_plan_tags/index.md create mode 100644 website/docs/services/kendraranking/execution_plans/index.md create mode 100644 website/docs/services/kendraranking/execution_plans_list_only/index.md create mode 100644 website/docs/services/kendraranking/index.md create mode 100644 website/docs/services/kinesis/index.md create mode 100644 website/docs/services/kinesis/resource_policies/index.md create mode 100644 website/docs/services/kinesis/stream_tags/index.md create mode 100644 website/docs/services/kinesis/streams/index.md create mode 100644 website/docs/services/kinesis/streams_list_only/index.md create mode 100644 website/docs/services/kinesisanalyticsv2/application_tags/index.md create mode 100644 website/docs/services/kinesisanalyticsv2/applications/index.md create mode 100644 website/docs/services/kinesisanalyticsv2/applications_list_only/index.md create mode 100644 website/docs/services/kinesisanalyticsv2/index.md create mode 100644 website/docs/services/kinesisfirehose/delivery_stream_tags/index.md create mode 100644 website/docs/services/kinesisfirehose/delivery_streams/index.md create mode 100644 website/docs/services/kinesisfirehose/delivery_streams_list_only/index.md create mode 100644 website/docs/services/kinesisfirehose/index.md create mode 100644 website/docs/services/kinesisvideo/index.md create mode 100644 website/docs/services/kinesisvideo/signaling_channels/index.md create mode 100644 website/docs/services/kinesisvideo/streams/index.md create mode 100644 website/docs/services/kms/aliases/index.md create mode 100644 website/docs/services/kms/aliases_list_only/index.md create mode 100644 website/docs/services/kms/index.md create mode 100644 website/docs/services/kms/key_tags/index.md create mode 100644 website/docs/services/kms/keys/index.md create mode 100644 website/docs/services/kms/keys_list_only/index.md create mode 100644 website/docs/services/kms/replica_key_tags/index.md create mode 100644 website/docs/services/kms/replica_keys/index.md create mode 100644 website/docs/services/kms/replica_keys_list_only/index.md create mode 100644 website/docs/services/lakeformation/data_cells_filters/index.md create mode 100644 website/docs/services/lakeformation/data_cells_filters_list_only/index.md create mode 100644 website/docs/services/lakeformation/index.md create mode 100644 website/docs/services/lakeformation/principal_permissions/index.md create mode 100644 website/docs/services/lakeformation/tag_associations/index.md create mode 100644 website/docs/services/lakeformation/tags/index.md create mode 100644 website/docs/services/lakeformation/tags_list_only/index.md create mode 100644 website/docs/services/lambda/aliases/index.md create mode 100644 website/docs/services/lambda/aliases_list_only/index.md create mode 100644 website/docs/services/lambda/code_signing_config_tags/index.md create mode 100644 website/docs/services/lambda/code_signing_configs/index.md create mode 100644 website/docs/services/lambda/code_signing_configs_list_only/index.md create mode 100644 website/docs/services/lambda/event_invoke_configs/index.md create mode 100644 website/docs/services/lambda/event_invoke_configs_list_only/index.md create mode 100644 website/docs/services/lambda/event_source_mapping_tags/index.md create mode 100644 website/docs/services/lambda/event_source_mappings/index.md create mode 100644 website/docs/services/lambda/event_source_mappings_list_only/index.md create mode 100644 website/docs/services/lambda/function_tags/index.md create mode 100644 website/docs/services/lambda/functions/index.md create mode 100644 website/docs/services/lambda/functions_list_only/index.md create mode 100644 website/docs/services/lambda/index.md create mode 100644 website/docs/services/lambda/layer_version_permissions/index.md create mode 100644 website/docs/services/lambda/layer_version_permissions_list_only/index.md create mode 100644 website/docs/services/lambda/layer_versions/index.md create mode 100644 website/docs/services/lambda/layer_versions_list_only/index.md create mode 100644 website/docs/services/lambda/permissions/index.md create mode 100644 website/docs/services/lambda/permissions_list_only/index.md create mode 100644 website/docs/services/lambda/urls/index.md create mode 100644 website/docs/services/lambda/urls_list_only/index.md create mode 100644 website/docs/services/lambda/versions/index.md create mode 100644 website/docs/services/lambda/versions_list_only/index.md create mode 100644 website/docs/services/launchwizard/deployment_tags/index.md create mode 100644 website/docs/services/launchwizard/deployments/index.md create mode 100644 website/docs/services/launchwizard/deployments_list_only/index.md create mode 100644 website/docs/services/launchwizard/index.md create mode 100644 website/docs/services/lex/bot_aliases/index.md create mode 100644 website/docs/services/lex/bot_aliases_list_only/index.md create mode 100644 website/docs/services/lex/bot_versions/index.md create mode 100644 website/docs/services/lex/bot_versions_list_only/index.md create mode 100644 website/docs/services/lex/bots/index.md create mode 100644 website/docs/services/lex/bots_list_only/index.md create mode 100644 website/docs/services/lex/index.md create mode 100644 website/docs/services/lex/resource_policies/index.md create mode 100644 website/docs/services/lex/resource_policies_list_only/index.md create mode 100644 website/docs/services/licensemanager/grants/index.md create mode 100644 website/docs/services/licensemanager/grants_list_only/index.md create mode 100644 website/docs/services/licensemanager/index.md create mode 100644 website/docs/services/licensemanager/licenses/index.md create mode 100644 website/docs/services/licensemanager/licenses_list_only/index.md create mode 100644 website/docs/services/lightsail/alarms/index.md create mode 100644 website/docs/services/lightsail/alarms_list_only/index.md create mode 100644 website/docs/services/lightsail/bucket_tags/index.md create mode 100644 website/docs/services/lightsail/buckets/index.md create mode 100644 website/docs/services/lightsail/buckets_list_only/index.md create mode 100644 website/docs/services/lightsail/certificate_tags/index.md create mode 100644 website/docs/services/lightsail/certificates/index.md create mode 100644 website/docs/services/lightsail/certificates_list_only/index.md create mode 100644 website/docs/services/lightsail/container_tags/index.md create mode 100644 website/docs/services/lightsail/containers/index.md create mode 100644 website/docs/services/lightsail/containers_list_only/index.md create mode 100644 website/docs/services/lightsail/database_tags/index.md create mode 100644 website/docs/services/lightsail/databases/index.md create mode 100644 website/docs/services/lightsail/databases_list_only/index.md create mode 100644 website/docs/services/lightsail/distribution_tags/index.md create mode 100644 website/docs/services/lightsail/distributions/index.md create mode 100644 website/docs/services/lightsail/distributions_list_only/index.md create mode 100644 website/docs/services/lightsail/index.md create mode 100644 website/docs/services/lightsail/instance_tags/index.md create mode 100644 website/docs/services/lightsail/instances/index.md create mode 100644 website/docs/services/lightsail/instances_list_only/index.md create mode 100644 website/docs/services/lightsail/load_balancer_tags/index.md create mode 100644 website/docs/services/lightsail/load_balancer_tls_certificates/index.md create mode 100644 website/docs/services/lightsail/load_balancer_tls_certificates_list_only/index.md create mode 100644 website/docs/services/lightsail/load_balancers/index.md create mode 100644 website/docs/services/lightsail/load_balancers_list_only/index.md create mode 100644 website/docs/services/lightsail/static_ips/index.md create mode 100644 website/docs/services/lightsail/static_ips_list_only/index.md create mode 100644 website/docs/services/location/api_key_tags/index.md create mode 100644 website/docs/services/location/api_keys/index.md create mode 100644 website/docs/services/location/api_keys_list_only/index.md create mode 100644 website/docs/services/location/geofence_collection_tags/index.md create mode 100644 website/docs/services/location/geofence_collections/index.md create mode 100644 website/docs/services/location/geofence_collections_list_only/index.md create mode 100644 website/docs/services/location/index.md create mode 100644 website/docs/services/location/map_tags/index.md create mode 100644 website/docs/services/location/maps/index.md create mode 100644 website/docs/services/location/maps_list_only/index.md create mode 100644 website/docs/services/location/place_index_tags/index.md create mode 100644 website/docs/services/location/place_indices/index.md create mode 100644 website/docs/services/location/place_indices_list_only/index.md create mode 100644 website/docs/services/location/route_calculator_tags/index.md create mode 100644 website/docs/services/location/route_calculators/index.md create mode 100644 website/docs/services/location/route_calculators_list_only/index.md create mode 100644 website/docs/services/location/tracker_consumers/index.md create mode 100644 website/docs/services/location/tracker_consumers_list_only/index.md create mode 100644 website/docs/services/location/tracker_tags/index.md create mode 100644 website/docs/services/location/trackers/index.md create mode 100644 website/docs/services/location/trackers_list_only/index.md create mode 100644 website/docs/services/logs/account_policies/index.md create mode 100644 website/docs/services/logs/account_policies_list_only/index.md create mode 100644 website/docs/services/logs/deliveries/index.md create mode 100644 website/docs/services/logs/deliveries_list_only/index.md create mode 100644 website/docs/services/logs/delivery_destination_tags/index.md create mode 100644 website/docs/services/logs/delivery_destinations/index.md create mode 100644 website/docs/services/logs/delivery_destinations_list_only/index.md create mode 100644 website/docs/services/logs/delivery_source_tags/index.md create mode 100644 website/docs/services/logs/delivery_sources/index.md create mode 100644 website/docs/services/logs/delivery_sources_list_only/index.md create mode 100644 website/docs/services/logs/delivery_tags/index.md create mode 100644 website/docs/services/logs/destinations/index.md create mode 100644 website/docs/services/logs/destinations_list_only/index.md create mode 100644 website/docs/services/logs/index.md create mode 100644 website/docs/services/logs/integrations/index.md create mode 100644 website/docs/services/logs/integrations_list_only/index.md create mode 100644 website/docs/services/logs/log_anomaly_detectors/index.md create mode 100644 website/docs/services/logs/log_anomaly_detectors_list_only/index.md create mode 100644 website/docs/services/logs/log_streams/index.md create mode 100644 website/docs/services/logs/log_streams_list_only/index.md create mode 100644 website/docs/services/logs/metric_filters/index.md create mode 100644 website/docs/services/logs/metric_filters_list_only/index.md create mode 100644 website/docs/services/logs/query_definitions/index.md create mode 100644 website/docs/services/logs/query_definitions_list_only/index.md create mode 100644 website/docs/services/logs/resource_policies/index.md create mode 100644 website/docs/services/logs/resource_policies_list_only/index.md create mode 100644 website/docs/services/logs/subscription_filters/index.md create mode 100644 website/docs/services/logs/subscription_filters_list_only/index.md create mode 100644 website/docs/services/logs/transformers/index.md create mode 100644 website/docs/services/logs/transformers_list_only/index.md create mode 100644 website/docs/services/lookoutequipment/index.md create mode 100644 website/docs/services/lookoutequipment/inference_scheduler_tags/index.md create mode 100644 website/docs/services/lookoutequipment/inference_schedulers/index.md create mode 100644 website/docs/services/lookoutequipment/inference_schedulers_list_only/index.md create mode 100644 website/docs/services/lookoutmetrics/alerts/index.md create mode 100644 website/docs/services/lookoutmetrics/alerts_list_only/index.md create mode 100644 website/docs/services/lookoutmetrics/anomaly_detectors/index.md create mode 100644 website/docs/services/lookoutmetrics/anomaly_detectors_list_only/index.md create mode 100644 website/docs/services/lookoutmetrics/index.md create mode 100644 website/docs/services/lookoutvision/index.md create mode 100644 website/docs/services/lookoutvision/projects/index.md create mode 100644 website/docs/services/lookoutvision/projects_list_only/index.md create mode 100644 website/docs/services/m2/application_tags/index.md create mode 100644 website/docs/services/m2/applications/index.md create mode 100644 website/docs/services/m2/applications_list_only/index.md create mode 100644 website/docs/services/m2/deployments/index.md create mode 100644 website/docs/services/m2/deployments_list_only/index.md create mode 100644 website/docs/services/m2/environment_tags/index.md create mode 100644 website/docs/services/m2/environments/index.md create mode 100644 website/docs/services/m2/environments_list_only/index.md create mode 100644 website/docs/services/m2/index.md create mode 100644 website/docs/services/macie/allow_list_tags/index.md create mode 100644 website/docs/services/macie/allow_lists/index.md create mode 100644 website/docs/services/macie/allow_lists_list_only/index.md create mode 100644 website/docs/services/macie/custom_data_identifier_tags/index.md create mode 100644 website/docs/services/macie/custom_data_identifiers/index.md create mode 100644 website/docs/services/macie/custom_data_identifiers_list_only/index.md create mode 100644 website/docs/services/macie/findings_filter_tags/index.md create mode 100644 website/docs/services/macie/findings_filters/index.md create mode 100644 website/docs/services/macie/findings_filters_list_only/index.md create mode 100644 website/docs/services/macie/index.md create mode 100644 website/docs/services/macie/sessions/index.md create mode 100644 website/docs/services/macie/sessions_list_only/index.md create mode 100644 website/docs/services/managedblockchain/accessor_tags/index.md create mode 100644 website/docs/services/managedblockchain/accessors/index.md create mode 100644 website/docs/services/managedblockchain/accessors_list_only/index.md create mode 100644 website/docs/services/managedblockchain/index.md create mode 100644 website/docs/services/mediaconnect/bridge_outputs/index.md create mode 100644 website/docs/services/mediaconnect/bridge_sources/index.md create mode 100644 website/docs/services/mediaconnect/bridges/index.md create mode 100644 website/docs/services/mediaconnect/bridges_list_only/index.md create mode 100644 website/docs/services/mediaconnect/flow_entitlements/index.md create mode 100644 website/docs/services/mediaconnect/flow_entitlements_list_only/index.md create mode 100644 website/docs/services/mediaconnect/flow_outputs/index.md create mode 100644 website/docs/services/mediaconnect/flow_outputs_list_only/index.md create mode 100644 website/docs/services/mediaconnect/flow_sources/index.md create mode 100644 website/docs/services/mediaconnect/flow_sources_list_only/index.md create mode 100644 website/docs/services/mediaconnect/flow_vpc_interfaces/index.md create mode 100644 website/docs/services/mediaconnect/flow_vpc_interfaces_list_only/index.md create mode 100644 website/docs/services/mediaconnect/flows/index.md create mode 100644 website/docs/services/mediaconnect/flows_list_only/index.md create mode 100644 website/docs/services/mediaconnect/gateways/index.md create mode 100644 website/docs/services/mediaconnect/gateways_list_only/index.md create mode 100644 website/docs/services/mediaconnect/index.md create mode 100644 website/docs/services/medialive/channel_placement_group_tags/index.md create mode 100644 website/docs/services/medialive/channel_placement_groups/index.md create mode 100644 website/docs/services/medialive/channel_placement_groups_list_only/index.md create mode 100644 website/docs/services/medialive/cloud_watch_alarm_template_group_tags/index.md create mode 100644 website/docs/services/medialive/cloud_watch_alarm_template_groups/index.md create mode 100644 website/docs/services/medialive/cloud_watch_alarm_template_groups_list_only/index.md create mode 100644 website/docs/services/medialive/cloud_watch_alarm_template_tags/index.md create mode 100644 website/docs/services/medialive/cloud_watch_alarm_templates/index.md create mode 100644 website/docs/services/medialive/cloud_watch_alarm_templates_list_only/index.md create mode 100644 website/docs/services/medialive/cluster_tags/index.md create mode 100644 website/docs/services/medialive/clusters/index.md create mode 100644 website/docs/services/medialive/clusters_list_only/index.md create mode 100644 website/docs/services/medialive/event_bridge_rule_template_group_tags/index.md create mode 100644 website/docs/services/medialive/event_bridge_rule_template_groups/index.md create mode 100644 website/docs/services/medialive/event_bridge_rule_template_groups_list_only/index.md create mode 100644 website/docs/services/medialive/event_bridge_rule_template_tags/index.md create mode 100644 website/docs/services/medialive/event_bridge_rule_templates/index.md create mode 100644 website/docs/services/medialive/event_bridge_rule_templates_list_only/index.md create mode 100644 website/docs/services/medialive/index.md create mode 100644 website/docs/services/medialive/multiplex_tags/index.md create mode 100644 website/docs/services/medialive/multiplexes/index.md create mode 100644 website/docs/services/medialive/multiplexes_list_only/index.md create mode 100644 website/docs/services/medialive/multiplexprograms/index.md create mode 100644 website/docs/services/medialive/multiplexprograms_list_only/index.md create mode 100644 website/docs/services/medialive/network_tags/index.md create mode 100644 website/docs/services/medialive/networks/index.md create mode 100644 website/docs/services/medialive/networks_list_only/index.md create mode 100644 website/docs/services/medialive/sdi_source_tags/index.md create mode 100644 website/docs/services/medialive/sdi_sources/index.md create mode 100644 website/docs/services/medialive/sdi_sources_list_only/index.md create mode 100644 website/docs/services/medialive/signal_map_tags/index.md create mode 100644 website/docs/services/medialive/signal_maps/index.md create mode 100644 website/docs/services/medialive/signal_maps_list_only/index.md create mode 100644 website/docs/services/mediapackage/asset_tags/index.md create mode 100644 website/docs/services/mediapackage/assets/index.md create mode 100644 website/docs/services/mediapackage/assets_list_only/index.md create mode 100644 website/docs/services/mediapackage/channel_tags/index.md create mode 100644 website/docs/services/mediapackage/channels/index.md create mode 100644 website/docs/services/mediapackage/channels_list_only/index.md create mode 100644 website/docs/services/mediapackage/index.md create mode 100644 website/docs/services/mediapackage/origin_endpoint_tags/index.md create mode 100644 website/docs/services/mediapackage/origin_endpoints/index.md create mode 100644 website/docs/services/mediapackage/origin_endpoints_list_only/index.md create mode 100644 website/docs/services/mediapackage/packaging_configuration_tags/index.md create mode 100644 website/docs/services/mediapackage/packaging_configurations/index.md create mode 100644 website/docs/services/mediapackage/packaging_configurations_list_only/index.md create mode 100644 website/docs/services/mediapackage/packaging_group_tags/index.md create mode 100644 website/docs/services/mediapackage/packaging_groups/index.md create mode 100644 website/docs/services/mediapackage/packaging_groups_list_only/index.md create mode 100644 website/docs/services/mediapackagev2/channel_group_tags/index.md create mode 100644 website/docs/services/mediapackagev2/channel_groups/index.md create mode 100644 website/docs/services/mediapackagev2/channel_groups_list_only/index.md create mode 100644 website/docs/services/mediapackagev2/channel_policies/index.md create mode 100644 website/docs/services/mediapackagev2/channel_tags/index.md create mode 100644 website/docs/services/mediapackagev2/channels/index.md create mode 100644 website/docs/services/mediapackagev2/channels_list_only/index.md create mode 100644 website/docs/services/mediapackagev2/index.md create mode 100644 website/docs/services/mediapackagev2/origin_endpoint_policies/index.md create mode 100644 website/docs/services/mediapackagev2/origin_endpoint_tags/index.md create mode 100644 website/docs/services/mediapackagev2/origin_endpoints/index.md create mode 100644 website/docs/services/mediapackagev2/origin_endpoints_list_only/index.md create mode 100644 website/docs/services/mediatailor/channel_policies/index.md create mode 100644 website/docs/services/mediatailor/channel_tags/index.md create mode 100644 website/docs/services/mediatailor/channels/index.md create mode 100644 website/docs/services/mediatailor/channels_list_only/index.md create mode 100644 website/docs/services/mediatailor/index.md create mode 100644 website/docs/services/mediatailor/live_source_tags/index.md create mode 100644 website/docs/services/mediatailor/live_sources/index.md create mode 100644 website/docs/services/mediatailor/live_sources_list_only/index.md create mode 100644 website/docs/services/mediatailor/playback_configuration_tags/index.md create mode 100644 website/docs/services/mediatailor/playback_configurations/index.md create mode 100644 website/docs/services/mediatailor/playback_configurations_list_only/index.md create mode 100644 website/docs/services/mediatailor/source_location_tags/index.md create mode 100644 website/docs/services/mediatailor/source_locations/index.md create mode 100644 website/docs/services/mediatailor/source_locations_list_only/index.md create mode 100644 website/docs/services/mediatailor/vod_source_tags/index.md create mode 100644 website/docs/services/mediatailor/vod_sources/index.md create mode 100644 website/docs/services/mediatailor/vod_sources_list_only/index.md create mode 100644 website/docs/services/memorydb/acl_tags/index.md create mode 100644 website/docs/services/memorydb/acls/index.md create mode 100644 website/docs/services/memorydb/acls_list_only/index.md create mode 100644 website/docs/services/memorydb/cluster_tags/index.md create mode 100644 website/docs/services/memorydb/clusters/index.md create mode 100644 website/docs/services/memorydb/clusters_list_only/index.md create mode 100644 website/docs/services/memorydb/index.md create mode 100644 website/docs/services/memorydb/multi_region_cluster_tags/index.md create mode 100644 website/docs/services/memorydb/multi_region_clusters/index.md create mode 100644 website/docs/services/memorydb/multi_region_clusters_list_only/index.md create mode 100644 website/docs/services/memorydb/parameter_group_tags/index.md create mode 100644 website/docs/services/memorydb/parameter_groups/index.md create mode 100644 website/docs/services/memorydb/parameter_groups_list_only/index.md create mode 100644 website/docs/services/memorydb/subnet_group_tags/index.md create mode 100644 website/docs/services/memorydb/subnet_groups/index.md create mode 100644 website/docs/services/memorydb/subnet_groups_list_only/index.md create mode 100644 website/docs/services/memorydb/user_tags/index.md create mode 100644 website/docs/services/memorydb/users/index.md create mode 100644 website/docs/services/memorydb/users_list_only/index.md create mode 100644 website/docs/services/msk/batch_scram_secrets/index.md create mode 100644 website/docs/services/msk/batch_scram_secrets_list_only/index.md create mode 100644 website/docs/services/msk/cluster_policies/index.md create mode 100644 website/docs/services/msk/cluster_policies_list_only/index.md create mode 100644 website/docs/services/msk/cluster_tags/index.md create mode 100644 website/docs/services/msk/clusters/index.md create mode 100644 website/docs/services/msk/clusters_list_only/index.md create mode 100644 website/docs/services/msk/configurations/index.md create mode 100644 website/docs/services/msk/configurations_list_only/index.md create mode 100644 website/docs/services/msk/index.md create mode 100644 website/docs/services/msk/replicator_tags/index.md create mode 100644 website/docs/services/msk/replicators/index.md create mode 100644 website/docs/services/msk/replicators_list_only/index.md create mode 100644 website/docs/services/msk/serverless_cluster_tags/index.md create mode 100644 website/docs/services/msk/serverless_clusters/index.md create mode 100644 website/docs/services/msk/serverless_clusters_list_only/index.md create mode 100644 website/docs/services/msk/vpc_connection_tags/index.md create mode 100644 website/docs/services/msk/vpc_connections/index.md create mode 100644 website/docs/services/msk/vpc_connections_list_only/index.md create mode 100644 website/docs/services/mwaa/environment_tags/index.md create mode 100644 website/docs/services/mwaa/environments/index.md create mode 100644 website/docs/services/mwaa/environments_list_only/index.md create mode 100644 website/docs/services/mwaa/index.md create mode 100644 website/docs/services/neptune/db_cluster_tags/index.md create mode 100644 website/docs/services/neptune/db_clusters/index.md create mode 100644 website/docs/services/neptune/db_clusters_list_only/index.md create mode 100644 website/docs/services/neptune/index.md create mode 100644 website/docs/services/neptunegraph/graph_tags/index.md create mode 100644 website/docs/services/neptunegraph/graphs/index.md create mode 100644 website/docs/services/neptunegraph/graphs_list_only/index.md create mode 100644 website/docs/services/neptunegraph/index.md create mode 100644 website/docs/services/neptunegraph/private_graph_endpoints/index.md create mode 100644 website/docs/services/neptunegraph/private_graph_endpoints_list_only/index.md create mode 100644 website/docs/services/networkfirewall/firewall_policies/index.md create mode 100644 website/docs/services/networkfirewall/firewall_policies_list_only/index.md create mode 100644 website/docs/services/networkfirewall/firewall_policy_tags/index.md create mode 100644 website/docs/services/networkfirewall/firewall_tags/index.md create mode 100644 website/docs/services/networkfirewall/firewalls/index.md create mode 100644 website/docs/services/networkfirewall/firewalls_list_only/index.md create mode 100644 website/docs/services/networkfirewall/index.md create mode 100644 website/docs/services/networkfirewall/logging_configurations/index.md create mode 100644 website/docs/services/networkfirewall/rule_group_tags/index.md create mode 100644 website/docs/services/networkfirewall/rule_groups/index.md create mode 100644 website/docs/services/networkfirewall/rule_groups_list_only/index.md create mode 100644 website/docs/services/networkfirewall/tls_inspection_configuration_tags/index.md create mode 100644 website/docs/services/networkfirewall/tls_inspection_configurations/index.md create mode 100644 website/docs/services/networkfirewall/tls_inspection_configurations_list_only/index.md create mode 100644 website/docs/services/networkmanager/connect_attachment_tags/index.md create mode 100644 website/docs/services/networkmanager/connect_attachments/index.md create mode 100644 website/docs/services/networkmanager/connect_attachments_list_only/index.md create mode 100644 website/docs/services/networkmanager/connect_peer_tags/index.md create mode 100644 website/docs/services/networkmanager/connect_peers/index.md create mode 100644 website/docs/services/networkmanager/connect_peers_list_only/index.md create mode 100644 website/docs/services/networkmanager/core_network_tags/index.md create mode 100644 website/docs/services/networkmanager/core_networks/index.md create mode 100644 website/docs/services/networkmanager/core_networks_list_only/index.md create mode 100644 website/docs/services/networkmanager/customer_gateway_associations/index.md create mode 100644 website/docs/services/networkmanager/customer_gateway_associations_list_only/index.md create mode 100644 website/docs/services/networkmanager/device_tags/index.md create mode 100644 website/docs/services/networkmanager/devices/index.md create mode 100644 website/docs/services/networkmanager/devices_list_only/index.md create mode 100644 website/docs/services/networkmanager/direct_connect_gateway_attachment_tags/index.md create mode 100644 website/docs/services/networkmanager/direct_connect_gateway_attachments/index.md create mode 100644 website/docs/services/networkmanager/direct_connect_gateway_attachments_list_only/index.md create mode 100644 website/docs/services/networkmanager/global_network_tags/index.md create mode 100644 website/docs/services/networkmanager/global_networks/index.md create mode 100644 website/docs/services/networkmanager/global_networks_list_only/index.md create mode 100644 website/docs/services/networkmanager/index.md create mode 100644 website/docs/services/networkmanager/link_associations/index.md create mode 100644 website/docs/services/networkmanager/link_associations_list_only/index.md create mode 100644 website/docs/services/networkmanager/link_tags/index.md create mode 100644 website/docs/services/networkmanager/links/index.md create mode 100644 website/docs/services/networkmanager/links_list_only/index.md create mode 100644 website/docs/services/networkmanager/site_tags/index.md create mode 100644 website/docs/services/networkmanager/site_to_site_vpn_attachment_tags/index.md create mode 100644 website/docs/services/networkmanager/site_to_site_vpn_attachments/index.md create mode 100644 website/docs/services/networkmanager/site_to_site_vpn_attachments_list_only/index.md create mode 100644 website/docs/services/networkmanager/sites/index.md create mode 100644 website/docs/services/networkmanager/sites_list_only/index.md create mode 100644 website/docs/services/networkmanager/transit_gateway_peering_tags/index.md create mode 100644 website/docs/services/networkmanager/transit_gateway_peerings/index.md create mode 100644 website/docs/services/networkmanager/transit_gateway_peerings_list_only/index.md create mode 100644 website/docs/services/networkmanager/transit_gateway_registrations/index.md create mode 100644 website/docs/services/networkmanager/transit_gateway_registrations_list_only/index.md create mode 100644 website/docs/services/networkmanager/transit_gateway_route_table_attachment_tags/index.md create mode 100644 website/docs/services/networkmanager/transit_gateway_route_table_attachments/index.md create mode 100644 website/docs/services/networkmanager/transit_gateway_route_table_attachments_list_only/index.md create mode 100644 website/docs/services/networkmanager/vpc_attachment_tags/index.md create mode 100644 website/docs/services/networkmanager/vpc_attachments/index.md create mode 100644 website/docs/services/networkmanager/vpc_attachments_list_only/index.md create mode 100644 website/docs/services/oam/index.md create mode 100644 website/docs/services/oam/link_tags/index.md create mode 100644 website/docs/services/oam/links/index.md create mode 100644 website/docs/services/oam/links_list_only/index.md create mode 100644 website/docs/services/oam/sink_tags/index.md create mode 100644 website/docs/services/oam/sinks/index.md create mode 100644 website/docs/services/oam/sinks_list_only/index.md create mode 100644 website/docs/services/omics/annotation_store_tags/index.md create mode 100644 website/docs/services/omics/annotation_stores/index.md create mode 100644 website/docs/services/omics/annotation_stores_list_only/index.md create mode 100644 website/docs/services/omics/index.md create mode 100644 website/docs/services/omics/reference_store_tags/index.md create mode 100644 website/docs/services/omics/reference_stores/index.md create mode 100644 website/docs/services/omics/reference_stores_list_only/index.md create mode 100644 website/docs/services/omics/run_group_tags/index.md create mode 100644 website/docs/services/omics/run_groups/index.md create mode 100644 website/docs/services/omics/run_groups_list_only/index.md create mode 100644 website/docs/services/omics/sequence_store_tags/index.md create mode 100644 website/docs/services/omics/sequence_stores/index.md create mode 100644 website/docs/services/omics/sequence_stores_list_only/index.md create mode 100644 website/docs/services/omics/variant_store_tags/index.md create mode 100644 website/docs/services/omics/variant_stores/index.md create mode 100644 website/docs/services/omics/variant_stores_list_only/index.md create mode 100644 website/docs/services/omics/workflow_tags/index.md create mode 100644 website/docs/services/omics/workflows/index.md create mode 100644 website/docs/services/omics/workflows_list_only/index.md create mode 100644 website/docs/services/opensearchserverless/access_policies/index.md create mode 100644 website/docs/services/opensearchserverless/access_policies_list_only/index.md create mode 100644 website/docs/services/opensearchserverless/collection_tags/index.md create mode 100644 website/docs/services/opensearchserverless/collections/index.md create mode 100644 website/docs/services/opensearchserverless/collections_list_only/index.md create mode 100644 website/docs/services/opensearchserverless/index.md create mode 100644 website/docs/services/opensearchserverless/lifecycle_policies/index.md create mode 100644 website/docs/services/opensearchserverless/lifecycle_policies_list_only/index.md create mode 100644 website/docs/services/opensearchserverless/security_configs/index.md create mode 100644 website/docs/services/opensearchserverless/security_configs_list_only/index.md create mode 100644 website/docs/services/opensearchserverless/security_policies/index.md create mode 100644 website/docs/services/opensearchserverless/security_policies_list_only/index.md create mode 100644 website/docs/services/opensearchserverless/vpc_endpoints/index.md create mode 100644 website/docs/services/opensearchserverless/vpc_endpoints_list_only/index.md create mode 100644 website/docs/services/opensearchservice/application_tags/index.md create mode 100644 website/docs/services/opensearchservice/applications/index.md create mode 100644 website/docs/services/opensearchservice/applications_list_only/index.md create mode 100644 website/docs/services/opensearchservice/domains/index.md create mode 100644 website/docs/services/opensearchservice/index.md create mode 100644 website/docs/services/opsworkscm/index.md create mode 100644 website/docs/services/opsworkscm/server_tags/index.md create mode 100644 website/docs/services/opsworkscm/servers/index.md create mode 100644 website/docs/services/opsworkscm/servers_list_only/index.md create mode 100644 website/docs/services/organizations/account_tags/index.md create mode 100644 website/docs/services/organizations/accounts/index.md create mode 100644 website/docs/services/organizations/accounts_list_only/index.md create mode 100644 website/docs/services/organizations/index.md create mode 100644 website/docs/services/organizations/organizational_unit_tags/index.md create mode 100644 website/docs/services/organizations/organizational_units/index.md create mode 100644 website/docs/services/organizations/organizational_units_list_only/index.md create mode 100644 website/docs/services/organizations/organizations/index.md create mode 100644 website/docs/services/organizations/organizations_list_only/index.md create mode 100644 website/docs/services/organizations/policies/index.md create mode 100644 website/docs/services/organizations/policies_list_only/index.md create mode 100644 website/docs/services/organizations/policy_tags/index.md create mode 100644 website/docs/services/organizations/resource_policies/index.md create mode 100644 website/docs/services/organizations/resource_policies_list_only/index.md create mode 100644 website/docs/services/organizations/resource_policy_tags/index.md create mode 100644 website/docs/services/osis/index.md create mode 100644 website/docs/services/osis/pipeline_tags/index.md create mode 100644 website/docs/services/osis/pipelines/index.md create mode 100644 website/docs/services/osis/pipelines_list_only/index.md create mode 100644 website/docs/services/panorama/application_instance_tags/index.md create mode 100644 website/docs/services/panorama/application_instances/index.md create mode 100644 website/docs/services/panorama/application_instances_list_only/index.md create mode 100644 website/docs/services/panorama/index.md create mode 100644 website/docs/services/panorama/package_tags/index.md create mode 100644 website/docs/services/panorama/package_versions/index.md create mode 100644 website/docs/services/panorama/packages/index.md create mode 100644 website/docs/services/panorama/packages_list_only/index.md create mode 100644 website/docs/services/paymentcryptography/aliases/index.md create mode 100644 website/docs/services/paymentcryptography/aliases_list_only/index.md create mode 100644 website/docs/services/paymentcryptography/index.md create mode 100644 website/docs/services/paymentcryptography/key_tags/index.md create mode 100644 website/docs/services/paymentcryptography/keys/index.md create mode 100644 website/docs/services/paymentcryptography/keys_list_only/index.md create mode 100644 website/docs/services/pcaconnectorad/connector_tags/index.md create mode 100644 website/docs/services/pcaconnectorad/connectors/index.md create mode 100644 website/docs/services/pcaconnectorad/connectors_list_only/index.md create mode 100644 website/docs/services/pcaconnectorad/directory_registration_tags/index.md create mode 100644 website/docs/services/pcaconnectorad/directory_registrations/index.md create mode 100644 website/docs/services/pcaconnectorad/directory_registrations_list_only/index.md create mode 100644 website/docs/services/pcaconnectorad/index.md create mode 100644 website/docs/services/pcaconnectorad/service_principal_names/index.md create mode 100644 website/docs/services/pcaconnectorad/service_principal_names_list_only/index.md create mode 100644 website/docs/services/pcaconnectorad/template_group_access_control_entries/index.md create mode 100644 website/docs/services/pcaconnectorad/template_group_access_control_entries_list_only/index.md create mode 100644 website/docs/services/pcaconnectorad/template_tags/index.md create mode 100644 website/docs/services/pcaconnectorad/templates/index.md create mode 100644 website/docs/services/pcaconnectorad/templates_list_only/index.md create mode 100644 website/docs/services/pcaconnectorscep/challenge_tags/index.md create mode 100644 website/docs/services/pcaconnectorscep/challenges/index.md create mode 100644 website/docs/services/pcaconnectorscep/challenges_list_only/index.md create mode 100644 website/docs/services/pcaconnectorscep/connector_tags/index.md create mode 100644 website/docs/services/pcaconnectorscep/connectors/index.md create mode 100644 website/docs/services/pcaconnectorscep/connectors_list_only/index.md create mode 100644 website/docs/services/pcaconnectorscep/index.md create mode 100644 website/docs/services/pcs/cluster_tags/index.md create mode 100644 website/docs/services/pcs/clusters/index.md create mode 100644 website/docs/services/pcs/clusters_list_only/index.md create mode 100644 website/docs/services/pcs/compute_node_group_tags/index.md create mode 100644 website/docs/services/pcs/compute_node_groups/index.md create mode 100644 website/docs/services/pcs/compute_node_groups_list_only/index.md create mode 100644 website/docs/services/pcs/index.md create mode 100644 website/docs/services/pcs/queue_tags/index.md create mode 100644 website/docs/services/pcs/queues/index.md create mode 100644 website/docs/services/pcs/queues_list_only/index.md create mode 100644 website/docs/services/personalize/dataset_groups/index.md create mode 100644 website/docs/services/personalize/dataset_groups_list_only/index.md create mode 100644 website/docs/services/personalize/datasets/index.md create mode 100644 website/docs/services/personalize/datasets_list_only/index.md create mode 100644 website/docs/services/personalize/index.md create mode 100644 website/docs/services/personalize/schemata/index.md create mode 100644 website/docs/services/personalize/schemata_list_only/index.md create mode 100644 website/docs/services/personalize/solutions/index.md create mode 100644 website/docs/services/personalize/solutions_list_only/index.md create mode 100644 website/docs/services/pinpoint/in_app_template_tags/index.md create mode 100644 website/docs/services/pinpoint/in_app_templates/index.md create mode 100644 website/docs/services/pinpoint/in_app_templates_list_only/index.md create mode 100644 website/docs/services/pinpoint/index.md create mode 100644 website/docs/services/pipes/index.md create mode 100644 website/docs/services/pipes/pipe_tags/index.md create mode 100644 website/docs/services/pipes/pipes/index.md create mode 100644 website/docs/services/pipes/pipes_list_only/index.md create mode 100644 website/docs/services/proton/environment_account_connection_tags/index.md create mode 100644 website/docs/services/proton/environment_account_connections/index.md create mode 100644 website/docs/services/proton/environment_account_connections_list_only/index.md create mode 100644 website/docs/services/proton/environment_template_tags/index.md create mode 100644 website/docs/services/proton/environment_templates/index.md create mode 100644 website/docs/services/proton/environment_templates_list_only/index.md create mode 100644 website/docs/services/proton/index.md create mode 100644 website/docs/services/proton/service_template_tags/index.md create mode 100644 website/docs/services/proton/service_templates/index.md create mode 100644 website/docs/services/proton/service_templates_list_only/index.md create mode 100644 website/docs/services/qbusiness/application_tags/index.md create mode 100644 website/docs/services/qbusiness/applications/index.md create mode 100644 website/docs/services/qbusiness/applications_list_only/index.md create mode 100644 website/docs/services/qbusiness/data_accessor_tags/index.md create mode 100644 website/docs/services/qbusiness/data_accessors/index.md create mode 100644 website/docs/services/qbusiness/data_accessors_list_only/index.md create mode 100644 website/docs/services/qbusiness/data_source_tags/index.md create mode 100644 website/docs/services/qbusiness/data_sources/index.md create mode 100644 website/docs/services/qbusiness/data_sources_list_only/index.md create mode 100644 website/docs/services/qbusiness/index.md create mode 100644 website/docs/services/qbusiness/index_tags/index.md create mode 100644 website/docs/services/qbusiness/indices/index.md create mode 100644 website/docs/services/qbusiness/indices_list_only/index.md create mode 100644 website/docs/services/qbusiness/permissions/index.md create mode 100644 website/docs/services/qbusiness/permissions_list_only/index.md create mode 100644 website/docs/services/qbusiness/plugin_tags/index.md create mode 100644 website/docs/services/qbusiness/plugins/index.md create mode 100644 website/docs/services/qbusiness/plugins_list_only/index.md create mode 100644 website/docs/services/qbusiness/retriever_tags/index.md create mode 100644 website/docs/services/qbusiness/retrievers/index.md create mode 100644 website/docs/services/qbusiness/retrievers_list_only/index.md create mode 100644 website/docs/services/qbusiness/web_experience_tags/index.md create mode 100644 website/docs/services/qbusiness/web_experiences/index.md create mode 100644 website/docs/services/qbusiness/web_experiences_list_only/index.md create mode 100644 website/docs/services/qldb/index.md create mode 100644 website/docs/services/qldb/stream_tags/index.md create mode 100644 website/docs/services/qldb/streams/index.md create mode 100644 website/docs/services/qldb/streams_list_only/index.md create mode 100644 website/docs/services/quicksight/analyses/index.md create mode 100644 website/docs/services/quicksight/analyses_list_only/index.md create mode 100644 website/docs/services/quicksight/analysis_tags/index.md create mode 100644 website/docs/services/quicksight/custom_permissions/index.md create mode 100644 website/docs/services/quicksight/custom_permissions_list_only/index.md create mode 100644 website/docs/services/quicksight/custom_permissions_tags/index.md create mode 100644 website/docs/services/quicksight/dashboard_tags/index.md create mode 100644 website/docs/services/quicksight/dashboards/index.md create mode 100644 website/docs/services/quicksight/dashboards_list_only/index.md create mode 100644 website/docs/services/quicksight/data_set_tags/index.md create mode 100644 website/docs/services/quicksight/data_sets/index.md create mode 100644 website/docs/services/quicksight/data_sets_list_only/index.md create mode 100644 website/docs/services/quicksight/data_source_tags/index.md create mode 100644 website/docs/services/quicksight/data_sources/index.md create mode 100644 website/docs/services/quicksight/data_sources_list_only/index.md create mode 100644 website/docs/services/quicksight/folder_tags/index.md create mode 100644 website/docs/services/quicksight/folders/index.md create mode 100644 website/docs/services/quicksight/folders_list_only/index.md create mode 100644 website/docs/services/quicksight/index.md create mode 100644 website/docs/services/quicksight/refresh_schedules/index.md create mode 100644 website/docs/services/quicksight/refresh_schedules_list_only/index.md create mode 100644 website/docs/services/quicksight/template_tags/index.md create mode 100644 website/docs/services/quicksight/templates/index.md create mode 100644 website/docs/services/quicksight/templates_list_only/index.md create mode 100644 website/docs/services/quicksight/theme_tags/index.md create mode 100644 website/docs/services/quicksight/themes/index.md create mode 100644 website/docs/services/quicksight/themes_list_only/index.md create mode 100644 website/docs/services/quicksight/topics/index.md create mode 100644 website/docs/services/quicksight/topics_list_only/index.md create mode 100644 website/docs/services/quicksight/vpc_connection_tags/index.md create mode 100644 website/docs/services/quicksight/vpc_connections/index.md create mode 100644 website/docs/services/quicksight/vpc_connections_list_only/index.md create mode 100644 website/docs/services/ram/index.md create mode 100644 website/docs/services/ram/permission_tags/index.md create mode 100644 website/docs/services/ram/permissions/index.md create mode 100644 website/docs/services/ram/permissions_list_only/index.md create mode 100644 website/docs/services/ram/resource_share_tags/index.md create mode 100644 website/docs/services/ram/resource_shares/index.md create mode 100644 website/docs/services/ram/resource_shares_list_only/index.md create mode 100644 website/docs/services/rbin/index.md create mode 100644 website/docs/services/rbin/rule_tags/index.md create mode 100644 website/docs/services/rbin/rules/index.md create mode 100644 website/docs/services/rbin/rules_list_only/index.md create mode 100644 website/docs/services/rds/customdb_engine_version_tags/index.md create mode 100644 website/docs/services/rds/customdb_engine_versions/index.md create mode 100644 website/docs/services/rds/customdb_engine_versions_list_only/index.md create mode 100644 website/docs/services/rds/db_cluster_parameter_group_tags/index.md create mode 100644 website/docs/services/rds/db_cluster_parameter_groups/index.md create mode 100644 website/docs/services/rds/db_cluster_parameter_groups_list_only/index.md create mode 100644 website/docs/services/rds/db_cluster_tags/index.md create mode 100644 website/docs/services/rds/db_clusters/index.md create mode 100644 website/docs/services/rds/db_clusters_list_only/index.md create mode 100644 website/docs/services/rds/db_instance_tags/index.md create mode 100644 website/docs/services/rds/db_instances/index.md create mode 100644 website/docs/services/rds/db_instances_list_only/index.md create mode 100644 website/docs/services/rds/db_parameter_group_tags/index.md create mode 100644 website/docs/services/rds/db_parameter_groups/index.md create mode 100644 website/docs/services/rds/db_parameter_groups_list_only/index.md create mode 100644 website/docs/services/rds/db_proxies/index.md create mode 100644 website/docs/services/rds/db_proxies_list_only/index.md create mode 100644 website/docs/services/rds/db_proxy_endpoint_tags/index.md create mode 100644 website/docs/services/rds/db_proxy_endpoints/index.md create mode 100644 website/docs/services/rds/db_proxy_endpoints_list_only/index.md create mode 100644 website/docs/services/rds/db_proxy_tags/index.md create mode 100644 website/docs/services/rds/db_proxy_target_groups/index.md create mode 100644 website/docs/services/rds/db_proxy_target_groups_list_only/index.md create mode 100644 website/docs/services/rds/db_shard_group_tags/index.md create mode 100644 website/docs/services/rds/db_shard_groups/index.md create mode 100644 website/docs/services/rds/db_shard_groups_list_only/index.md create mode 100644 website/docs/services/rds/db_subnet_group_tags/index.md create mode 100644 website/docs/services/rds/db_subnet_groups/index.md create mode 100644 website/docs/services/rds/db_subnet_groups_list_only/index.md create mode 100644 website/docs/services/rds/event_subscription_tags/index.md create mode 100644 website/docs/services/rds/event_subscriptions/index.md create mode 100644 website/docs/services/rds/event_subscriptions_list_only/index.md create mode 100644 website/docs/services/rds/global_cluster_tags/index.md create mode 100644 website/docs/services/rds/global_clusters/index.md create mode 100644 website/docs/services/rds/global_clusters_list_only/index.md create mode 100644 website/docs/services/rds/index.md create mode 100644 website/docs/services/rds/integration_tags/index.md create mode 100644 website/docs/services/rds/integrations/index.md create mode 100644 website/docs/services/rds/integrations_list_only/index.md create mode 100644 website/docs/services/rds/option_group_tags/index.md create mode 100644 website/docs/services/rds/option_groups/index.md create mode 100644 website/docs/services/rds/option_groups_list_only/index.md create mode 100644 website/docs/services/redshift/cluster_parameter_group_tags/index.md create mode 100644 website/docs/services/redshift/cluster_parameter_groups/index.md create mode 100644 website/docs/services/redshift/cluster_parameter_groups_list_only/index.md create mode 100644 website/docs/services/redshift/cluster_subnet_group_tags/index.md create mode 100644 website/docs/services/redshift/cluster_subnet_groups/index.md create mode 100644 website/docs/services/redshift/cluster_subnet_groups_list_only/index.md create mode 100644 website/docs/services/redshift/cluster_tags/index.md create mode 100644 website/docs/services/redshift/clusters/index.md create mode 100644 website/docs/services/redshift/clusters_list_only/index.md create mode 100644 website/docs/services/redshift/endpoint_accesses/index.md create mode 100644 website/docs/services/redshift/endpoint_accesses_list_only/index.md create mode 100644 website/docs/services/redshift/endpoint_authorizations/index.md create mode 100644 website/docs/services/redshift/endpoint_authorizations_list_only/index.md create mode 100644 website/docs/services/redshift/event_subscription_tags/index.md create mode 100644 website/docs/services/redshift/event_subscriptions/index.md create mode 100644 website/docs/services/redshift/event_subscriptions_list_only/index.md create mode 100644 website/docs/services/redshift/index.md create mode 100644 website/docs/services/redshift/integration_tags/index.md create mode 100644 website/docs/services/redshift/integrations/index.md create mode 100644 website/docs/services/redshift/integrations_list_only/index.md create mode 100644 website/docs/services/redshift/scheduled_actions/index.md create mode 100644 website/docs/services/redshift/scheduled_actions_list_only/index.md create mode 100644 website/docs/services/redshiftserverless/index.md create mode 100644 website/docs/services/redshiftserverless/namespace_tags/index.md create mode 100644 website/docs/services/redshiftserverless/namespaces/index.md create mode 100644 website/docs/services/redshiftserverless/namespaces_list_only/index.md create mode 100644 website/docs/services/redshiftserverless/workgroup_tags/index.md create mode 100644 website/docs/services/redshiftserverless/workgroups/index.md create mode 100644 website/docs/services/redshiftserverless/workgroups_list_only/index.md create mode 100644 website/docs/services/refactorspaces/application_tags/index.md create mode 100644 website/docs/services/refactorspaces/applications/index.md create mode 100644 website/docs/services/refactorspaces/applications_list_only/index.md create mode 100644 website/docs/services/refactorspaces/environment_tags/index.md create mode 100644 website/docs/services/refactorspaces/environments/index.md create mode 100644 website/docs/services/refactorspaces/environments_list_only/index.md create mode 100644 website/docs/services/refactorspaces/index.md create mode 100644 website/docs/services/refactorspaces/route_tags/index.md create mode 100644 website/docs/services/refactorspaces/routes/index.md create mode 100644 website/docs/services/refactorspaces/routes_list_only/index.md create mode 100644 website/docs/services/refactorspaces/service_tags/index.md create mode 100644 website/docs/services/refactorspaces/services/index.md create mode 100644 website/docs/services/refactorspaces/services_list_only/index.md create mode 100644 website/docs/services/rekognition/collection_tags/index.md create mode 100644 website/docs/services/rekognition/collections/index.md create mode 100644 website/docs/services/rekognition/collections_list_only/index.md create mode 100644 website/docs/services/rekognition/index.md create mode 100644 website/docs/services/rekognition/projects/index.md create mode 100644 website/docs/services/rekognition/projects_list_only/index.md create mode 100644 website/docs/services/rekognition/stream_processor_tags/index.md create mode 100644 website/docs/services/rekognition/stream_processors/index.md create mode 100644 website/docs/services/rekognition/stream_processors_list_only/index.md create mode 100644 website/docs/services/resiliencehub/app_tags/index.md create mode 100644 website/docs/services/resiliencehub/apps/index.md create mode 100644 website/docs/services/resiliencehub/apps_list_only/index.md create mode 100644 website/docs/services/resiliencehub/index.md create mode 100644 website/docs/services/resiliencehub/resiliency_policies/index.md create mode 100644 website/docs/services/resiliencehub/resiliency_policies_list_only/index.md create mode 100644 website/docs/services/resiliencehub/resiliency_policy_tags/index.md create mode 100644 website/docs/services/resourceexplorer2/default_view_associations/index.md create mode 100644 website/docs/services/resourceexplorer2/index.md create mode 100644 website/docs/services/resourceexplorer2/index_tags/index.md create mode 100644 website/docs/services/resourceexplorer2/indices/index.md create mode 100644 website/docs/services/resourceexplorer2/indices_list_only/index.md create mode 100644 website/docs/services/resourceexplorer2/view_tags/index.md create mode 100644 website/docs/services/resourceexplorer2/views/index.md create mode 100644 website/docs/services/resourceexplorer2/views_list_only/index.md create mode 100644 website/docs/services/resourcegroups/group_tags/index.md create mode 100644 website/docs/services/resourcegroups/groups/index.md create mode 100644 website/docs/services/resourcegroups/groups_list_only/index.md create mode 100644 website/docs/services/resourcegroups/index.md create mode 100644 website/docs/services/resourcegroups/tag_sync_tasks/index.md create mode 100644 website/docs/services/resourcegroups/tag_sync_tasks_list_only/index.md create mode 100644 website/docs/services/robomaker/fleet_tags/index.md create mode 100644 website/docs/services/robomaker/fleets/index.md create mode 100644 website/docs/services/robomaker/fleets_list_only/index.md create mode 100644 website/docs/services/robomaker/index.md create mode 100644 website/docs/services/robomaker/robot_application_tags/index.md create mode 100644 website/docs/services/robomaker/robot_application_versions/index.md create mode 100644 website/docs/services/robomaker/robot_applications/index.md create mode 100644 website/docs/services/robomaker/robot_applications_list_only/index.md create mode 100644 website/docs/services/robomaker/robot_tags/index.md create mode 100644 website/docs/services/robomaker/robots/index.md create mode 100644 website/docs/services/robomaker/robots_list_only/index.md create mode 100644 website/docs/services/robomaker/simulation_application_tags/index.md create mode 100644 website/docs/services/robomaker/simulation_application_versions/index.md create mode 100644 website/docs/services/robomaker/simulation_applications/index.md create mode 100644 website/docs/services/robomaker/simulation_applications_list_only/index.md create mode 100644 website/docs/services/rolesanywhere/crl_tags/index.md create mode 100644 website/docs/services/rolesanywhere/crls/index.md create mode 100644 website/docs/services/rolesanywhere/crls_list_only/index.md create mode 100644 website/docs/services/rolesanywhere/index.md create mode 100644 website/docs/services/rolesanywhere/profile_tags/index.md create mode 100644 website/docs/services/rolesanywhere/profiles/index.md create mode 100644 website/docs/services/rolesanywhere/profiles_list_only/index.md create mode 100644 website/docs/services/rolesanywhere/trust_anchor_tags/index.md create mode 100644 website/docs/services/rolesanywhere/trust_anchors/index.md create mode 100644 website/docs/services/rolesanywhere/trust_anchors_list_only/index.md create mode 100644 website/docs/services/route53/cidr_collections/index.md create mode 100644 website/docs/services/route53/cidr_collections_list_only/index.md create mode 100644 website/docs/services/route53/dnssecs/index.md create mode 100644 website/docs/services/route53/dnssecs_list_only/index.md create mode 100644 website/docs/services/route53/health_checks/index.md create mode 100644 website/docs/services/route53/health_checks_list_only/index.md create mode 100644 website/docs/services/route53/hosted_zones/index.md create mode 100644 website/docs/services/route53/hosted_zones_list_only/index.md create mode 100644 website/docs/services/route53/index.md create mode 100644 website/docs/services/route53/key_signing_keys/index.md create mode 100644 website/docs/services/route53/key_signing_keys_list_only/index.md create mode 100644 website/docs/services/route53/resource_record_sets/index.md create mode 100644 website/docs/services/route53profiles/index.md create mode 100644 website/docs/services/route53profiles/profile_association_tags/index.md create mode 100644 website/docs/services/route53profiles/profile_associations/index.md create mode 100644 website/docs/services/route53profiles/profile_associations_list_only/index.md create mode 100644 website/docs/services/route53profiles/profile_resource_associations/index.md create mode 100644 website/docs/services/route53profiles/profile_resource_associations_list_only/index.md create mode 100644 website/docs/services/route53profiles/profile_tags/index.md create mode 100644 website/docs/services/route53profiles/profiles/index.md create mode 100644 website/docs/services/route53profiles/profiles_list_only/index.md create mode 100644 website/docs/services/route53recoverycontrol/cluster_tags/index.md create mode 100644 website/docs/services/route53recoverycontrol/clusters/index.md create mode 100644 website/docs/services/route53recoverycontrol/clusters_list_only/index.md create mode 100644 website/docs/services/route53recoverycontrol/control_panel_tags/index.md create mode 100644 website/docs/services/route53recoverycontrol/control_panels/index.md create mode 100644 website/docs/services/route53recoverycontrol/control_panels_list_only/index.md create mode 100644 website/docs/services/route53recoverycontrol/index.md create mode 100644 website/docs/services/route53recoverycontrol/routing_controls/index.md create mode 100644 website/docs/services/route53recoverycontrol/routing_controls_list_only/index.md create mode 100644 website/docs/services/route53recoverycontrol/safety_rule_tags/index.md create mode 100644 website/docs/services/route53recoverycontrol/safety_rules/index.md create mode 100644 website/docs/services/route53recoverycontrol/safety_rules_list_only/index.md create mode 100644 website/docs/services/route53recoveryreadiness/cell_tags/index.md create mode 100644 website/docs/services/route53recoveryreadiness/cells/index.md create mode 100644 website/docs/services/route53recoveryreadiness/cells_list_only/index.md create mode 100644 website/docs/services/route53recoveryreadiness/index.md create mode 100644 website/docs/services/route53recoveryreadiness/readiness_check_tags/index.md create mode 100644 website/docs/services/route53recoveryreadiness/readiness_checks/index.md create mode 100644 website/docs/services/route53recoveryreadiness/readiness_checks_list_only/index.md create mode 100644 website/docs/services/route53recoveryreadiness/recovery_group_tags/index.md create mode 100644 website/docs/services/route53recoveryreadiness/recovery_groups/index.md create mode 100644 website/docs/services/route53recoveryreadiness/recovery_groups_list_only/index.md create mode 100644 website/docs/services/route53recoveryreadiness/resource_set_tags/index.md create mode 100644 website/docs/services/route53recoveryreadiness/resource_sets/index.md create mode 100644 website/docs/services/route53recoveryreadiness/resource_sets_list_only/index.md create mode 100644 website/docs/services/route53resolver/firewall_domain_list_tags/index.md create mode 100644 website/docs/services/route53resolver/firewall_domain_lists/index.md create mode 100644 website/docs/services/route53resolver/firewall_domain_lists_list_only/index.md create mode 100644 website/docs/services/route53resolver/firewall_rule_group_association_tags/index.md create mode 100644 website/docs/services/route53resolver/firewall_rule_group_associations/index.md create mode 100644 website/docs/services/route53resolver/firewall_rule_group_associations_list_only/index.md create mode 100644 website/docs/services/route53resolver/firewall_rule_group_tags/index.md create mode 100644 website/docs/services/route53resolver/firewall_rule_groups/index.md create mode 100644 website/docs/services/route53resolver/firewall_rule_groups_list_only/index.md create mode 100644 website/docs/services/route53resolver/index.md create mode 100644 website/docs/services/route53resolver/outpost_resolver_tags/index.md create mode 100644 website/docs/services/route53resolver/outpost_resolvers/index.md create mode 100644 website/docs/services/route53resolver/outpost_resolvers_list_only/index.md create mode 100644 website/docs/services/route53resolver/resolver_configs/index.md create mode 100644 website/docs/services/route53resolver/resolver_configs_list_only/index.md create mode 100644 website/docs/services/route53resolver/resolver_query_logging_config_associations/index.md create mode 100644 website/docs/services/route53resolver/resolver_query_logging_config_associations_list_only/index.md create mode 100644 website/docs/services/route53resolver/resolver_query_logging_configs/index.md create mode 100644 website/docs/services/route53resolver/resolver_query_logging_configs_list_only/index.md create mode 100644 website/docs/services/route53resolver/resolver_rule_associations/index.md create mode 100644 website/docs/services/route53resolver/resolver_rule_associations_list_only/index.md create mode 100644 website/docs/services/route53resolver/resolver_rule_tags/index.md create mode 100644 website/docs/services/route53resolver/resolver_rules/index.md create mode 100644 website/docs/services/route53resolver/resolver_rules_list_only/index.md create mode 100644 website/docs/services/route53resolver/resolverdnssec_configs/index.md create mode 100644 website/docs/services/route53resolver/resolverdnssec_configs_list_only/index.md create mode 100644 website/docs/services/rum/app_monitor_tags/index.md create mode 100644 website/docs/services/rum/app_monitors/index.md create mode 100644 website/docs/services/rum/app_monitors_list_only/index.md create mode 100644 website/docs/services/rum/index.md create mode 100644 website/docs/services/s3/access_grant_tags/index.md create mode 100644 website/docs/services/s3/access_grants/index.md create mode 100644 website/docs/services/s3/access_grants_instance_tags/index.md create mode 100644 website/docs/services/s3/access_grants_instances/index.md create mode 100644 website/docs/services/s3/access_grants_instances_list_only/index.md create mode 100644 website/docs/services/s3/access_grants_list_only/index.md create mode 100644 website/docs/services/s3/access_grants_location_tags/index.md create mode 100644 website/docs/services/s3/access_grants_locations/index.md create mode 100644 website/docs/services/s3/access_grants_locations_list_only/index.md create mode 100644 website/docs/services/s3/access_points/index.md create mode 100644 website/docs/services/s3/access_points_list_only/index.md create mode 100644 website/docs/services/s3/bucket_policies/index.md create mode 100644 website/docs/services/s3/bucket_policies_list_only/index.md create mode 100644 website/docs/services/s3/bucket_tags/index.md create mode 100644 website/docs/services/s3/buckets/index.md create mode 100644 website/docs/services/s3/buckets_list_only/index.md create mode 100644 website/docs/services/s3/index.md create mode 100644 website/docs/services/s3/multi_region_access_point_policies/index.md create mode 100644 website/docs/services/s3/multi_region_access_points/index.md create mode 100644 website/docs/services/s3/multi_region_access_points_list_only/index.md create mode 100644 website/docs/services/s3/storage_lens/index.md create mode 100644 website/docs/services/s3/storage_lens_group_tags/index.md create mode 100644 website/docs/services/s3/storage_lens_groups/index.md create mode 100644 website/docs/services/s3/storage_lens_groups_list_only/index.md create mode 100644 website/docs/services/s3/storage_lens_list_only/index.md create mode 100644 website/docs/services/s3/storage_lens_tags/index.md create mode 100644 website/docs/services/s3express/bucket_policies/index.md create mode 100644 website/docs/services/s3express/bucket_policies_list_only/index.md create mode 100644 website/docs/services/s3express/directory_buckets/index.md create mode 100644 website/docs/services/s3express/directory_buckets_list_only/index.md create mode 100644 website/docs/services/s3express/index.md create mode 100644 website/docs/services/s3objectlambda/access_point_policies/index.md create mode 100644 website/docs/services/s3objectlambda/access_points/index.md create mode 100644 website/docs/services/s3objectlambda/access_points_list_only/index.md create mode 100644 website/docs/services/s3objectlambda/index.md create mode 100644 website/docs/services/s3outposts/access_points/index.md create mode 100644 website/docs/services/s3outposts/access_points_list_only/index.md create mode 100644 website/docs/services/s3outposts/bucket_policies/index.md create mode 100644 website/docs/services/s3outposts/bucket_tags/index.md create mode 100644 website/docs/services/s3outposts/buckets/index.md create mode 100644 website/docs/services/s3outposts/buckets_list_only/index.md create mode 100644 website/docs/services/s3outposts/endpoints/index.md create mode 100644 website/docs/services/s3outposts/endpoints_list_only/index.md create mode 100644 website/docs/services/s3outposts/index.md create mode 100644 website/docs/services/s3tables/index.md create mode 100644 website/docs/services/s3tables/table_bucket_policies/index.md create mode 100644 website/docs/services/s3tables/table_bucket_policies_list_only/index.md create mode 100644 website/docs/services/s3tables/table_buckets/index.md create mode 100644 website/docs/services/s3tables/table_buckets_list_only/index.md create mode 100644 website/docs/services/sagemaker/app_image_config_tags/index.md create mode 100644 website/docs/services/sagemaker/app_image_configs/index.md create mode 100644 website/docs/services/sagemaker/app_image_configs_list_only/index.md create mode 100644 website/docs/services/sagemaker/app_tags/index.md create mode 100644 website/docs/services/sagemaker/apps/index.md create mode 100644 website/docs/services/sagemaker/apps_list_only/index.md create mode 100644 website/docs/services/sagemaker/cluster_tags/index.md create mode 100644 website/docs/services/sagemaker/clusters/index.md create mode 100644 website/docs/services/sagemaker/clusters_list_only/index.md create mode 100644 website/docs/services/sagemaker/data_quality_job_definition_tags/index.md create mode 100644 website/docs/services/sagemaker/data_quality_job_definitions/index.md create mode 100644 website/docs/services/sagemaker/data_quality_job_definitions_list_only/index.md create mode 100644 website/docs/services/sagemaker/device_fleets/index.md create mode 100644 website/docs/services/sagemaker/devices/index.md create mode 100644 website/docs/services/sagemaker/endpoint_tags/index.md create mode 100644 website/docs/services/sagemaker/endpoints/index.md create mode 100644 website/docs/services/sagemaker/endpoints_list_only/index.md create mode 100644 website/docs/services/sagemaker/feature_group_tags/index.md create mode 100644 website/docs/services/sagemaker/feature_groups/index.md create mode 100644 website/docs/services/sagemaker/feature_groups_list_only/index.md create mode 100644 website/docs/services/sagemaker/image_tags/index.md create mode 100644 website/docs/services/sagemaker/image_versions/index.md create mode 100644 website/docs/services/sagemaker/image_versions_list_only/index.md create mode 100644 website/docs/services/sagemaker/images/index.md create mode 100644 website/docs/services/sagemaker/images_list_only/index.md create mode 100644 website/docs/services/sagemaker/index.md create mode 100644 website/docs/services/sagemaker/inference_component_tags/index.md create mode 100644 website/docs/services/sagemaker/inference_components/index.md create mode 100644 website/docs/services/sagemaker/inference_components_list_only/index.md create mode 100644 website/docs/services/sagemaker/inference_experiment_tags/index.md create mode 100644 website/docs/services/sagemaker/inference_experiments/index.md create mode 100644 website/docs/services/sagemaker/inference_experiments_list_only/index.md create mode 100644 website/docs/services/sagemaker/mlflow_tracking_server_tags/index.md create mode 100644 website/docs/services/sagemaker/mlflow_tracking_servers/index.md create mode 100644 website/docs/services/sagemaker/mlflow_tracking_servers_list_only/index.md create mode 100644 website/docs/services/sagemaker/model_bias_job_definition_tags/index.md create mode 100644 website/docs/services/sagemaker/model_bias_job_definitions/index.md create mode 100644 website/docs/services/sagemaker/model_bias_job_definitions_list_only/index.md create mode 100644 website/docs/services/sagemaker/model_explainability_job_definition_tags/index.md create mode 100644 website/docs/services/sagemaker/model_explainability_job_definitions/index.md create mode 100644 website/docs/services/sagemaker/model_explainability_job_definitions_list_only/index.md create mode 100644 website/docs/services/sagemaker/model_package_group_tags/index.md create mode 100644 website/docs/services/sagemaker/model_package_groups/index.md create mode 100644 website/docs/services/sagemaker/model_package_groups_list_only/index.md create mode 100644 website/docs/services/sagemaker/model_package_tags/index.md create mode 100644 website/docs/services/sagemaker/model_packages/index.md create mode 100644 website/docs/services/sagemaker/model_packages_list_only/index.md create mode 100644 website/docs/services/sagemaker/model_quality_job_definition_tags/index.md create mode 100644 website/docs/services/sagemaker/model_quality_job_definitions/index.md create mode 100644 website/docs/services/sagemaker/model_quality_job_definitions_list_only/index.md create mode 100644 website/docs/services/sagemaker/monitoring_schedule_tags/index.md create mode 100644 website/docs/services/sagemaker/monitoring_schedules/index.md create mode 100644 website/docs/services/sagemaker/monitoring_schedules_list_only/index.md create mode 100644 website/docs/services/sagemaker/partner_app_tags/index.md create mode 100644 website/docs/services/sagemaker/partner_apps/index.md create mode 100644 website/docs/services/sagemaker/partner_apps_list_only/index.md create mode 100644 website/docs/services/sagemaker/pipeline_tags/index.md create mode 100644 website/docs/services/sagemaker/pipelines/index.md create mode 100644 website/docs/services/sagemaker/pipelines_list_only/index.md create mode 100644 website/docs/services/sagemaker/project_tags/index.md create mode 100644 website/docs/services/sagemaker/projects/index.md create mode 100644 website/docs/services/sagemaker/projects_list_only/index.md create mode 100644 website/docs/services/sagemaker/space_tags/index.md create mode 100644 website/docs/services/sagemaker/spaces/index.md create mode 100644 website/docs/services/sagemaker/spaces_list_only/index.md create mode 100644 website/docs/services/sagemaker/studio_lifecycle_config_tags/index.md create mode 100644 website/docs/services/sagemaker/studio_lifecycle_configs/index.md create mode 100644 website/docs/services/sagemaker/studio_lifecycle_configs_list_only/index.md create mode 100644 website/docs/services/sagemaker/user_profile_tags/index.md create mode 100644 website/docs/services/sagemaker/user_profiles/index.md create mode 100644 website/docs/services/sagemaker/user_profiles_list_only/index.md create mode 100644 website/docs/services/scheduler/index.md create mode 100644 website/docs/services/scheduler/schedule_group_tags/index.md create mode 100644 website/docs/services/scheduler/schedule_groups/index.md create mode 100644 website/docs/services/scheduler/schedule_groups_list_only/index.md create mode 100644 website/docs/services/scheduler/schedules/index.md create mode 100644 website/docs/services/scheduler/schedules_list_only/index.md create mode 100644 website/docs/services/secretsmanager/index.md create mode 100644 website/docs/services/secretsmanager/resource_policies/index.md create mode 100644 website/docs/services/secretsmanager/resource_policies_list_only/index.md create mode 100644 website/docs/services/secretsmanager/rotation_schedules/index.md create mode 100644 website/docs/services/secretsmanager/rotation_schedules_list_only/index.md create mode 100644 website/docs/services/secretsmanager/secret_tags/index.md create mode 100644 website/docs/services/secretsmanager/secret_target_attachments/index.md create mode 100644 website/docs/services/secretsmanager/secret_target_attachments_list_only/index.md create mode 100644 website/docs/services/secretsmanager/secrets/index.md create mode 100644 website/docs/services/secretsmanager/secrets_list_only/index.md create mode 100644 website/docs/services/securityhub/automation_rule_tags/index.md create mode 100644 website/docs/services/securityhub/automation_rules/index.md create mode 100644 website/docs/services/securityhub/automation_rules_list_only/index.md create mode 100644 website/docs/services/securityhub/configuration_policies/index.md create mode 100644 website/docs/services/securityhub/configuration_policies_list_only/index.md create mode 100644 website/docs/services/securityhub/configuration_policy_tags/index.md create mode 100644 website/docs/services/securityhub/delegated_admins/index.md create mode 100644 website/docs/services/securityhub/delegated_admins_list_only/index.md create mode 100644 website/docs/services/securityhub/finding_aggregators/index.md create mode 100644 website/docs/services/securityhub/finding_aggregators_list_only/index.md create mode 100644 website/docs/services/securityhub/hub_tags/index.md create mode 100644 website/docs/services/securityhub/hubs/index.md create mode 100644 website/docs/services/securityhub/hubs_list_only/index.md create mode 100644 website/docs/services/securityhub/index.md create mode 100644 website/docs/services/securityhub/insights/index.md create mode 100644 website/docs/services/securityhub/insights_list_only/index.md create mode 100644 website/docs/services/securityhub/organization_configurations/index.md create mode 100644 website/docs/services/securityhub/organization_configurations_list_only/index.md create mode 100644 website/docs/services/securityhub/policy_associations/index.md create mode 100644 website/docs/services/securityhub/policy_associations_list_only/index.md create mode 100644 website/docs/services/securityhub/product_subscriptions/index.md create mode 100644 website/docs/services/securityhub/product_subscriptions_list_only/index.md create mode 100644 website/docs/services/securityhub/security_controls/index.md create mode 100644 website/docs/services/securityhub/security_controls_list_only/index.md create mode 100644 website/docs/services/securityhub/standards/index.md create mode 100644 website/docs/services/securityhub/standards_list_only/index.md create mode 100644 website/docs/services/securitylake/data_lake_tags/index.md create mode 100644 website/docs/services/securitylake/data_lakes/index.md create mode 100644 website/docs/services/securitylake/data_lakes_list_only/index.md create mode 100644 website/docs/services/securitylake/index.md create mode 100644 website/docs/services/securitylake/subscriber_notifications/index.md create mode 100644 website/docs/services/securitylake/subscriber_notifications_list_only/index.md create mode 100644 website/docs/services/securitylake/subscriber_tags/index.md create mode 100644 website/docs/services/securitylake/subscribers/index.md create mode 100644 website/docs/services/securitylake/subscribers_list_only/index.md create mode 100644 website/docs/services/servicecatalog/cloud_formation_provisioned_products/index.md create mode 100644 website/docs/services/servicecatalog/index.md create mode 100644 website/docs/services/servicecatalog/service_action_associations/index.md create mode 100644 website/docs/services/servicecatalog/service_action_associations_list_only/index.md create mode 100644 website/docs/services/servicecatalog/service_actions/index.md create mode 100644 website/docs/services/servicecatalog/service_actions_list_only/index.md create mode 100644 website/docs/services/servicecatalogappregistry/application_tags/index.md create mode 100644 website/docs/services/servicecatalogappregistry/applications/index.md create mode 100644 website/docs/services/servicecatalogappregistry/applications_list_only/index.md create mode 100644 website/docs/services/servicecatalogappregistry/attribute_group_associations/index.md create mode 100644 website/docs/services/servicecatalogappregistry/attribute_group_associations_list_only/index.md create mode 100644 website/docs/services/servicecatalogappregistry/attribute_group_tags/index.md create mode 100644 website/docs/services/servicecatalogappregistry/attribute_groups/index.md create mode 100644 website/docs/services/servicecatalogappregistry/attribute_groups_list_only/index.md create mode 100644 website/docs/services/servicecatalogappregistry/index.md create mode 100644 website/docs/services/servicecatalogappregistry/resource_associations/index.md create mode 100644 website/docs/services/servicecatalogappregistry/resource_associations_list_only/index.md create mode 100644 website/docs/services/ses/configuration_set_event_destinations/index.md create mode 100644 website/docs/services/ses/configuration_sets/index.md create mode 100644 website/docs/services/ses/configuration_sets_list_only/index.md create mode 100644 website/docs/services/ses/contact_list_tags/index.md create mode 100644 website/docs/services/ses/contact_lists/index.md create mode 100644 website/docs/services/ses/contact_lists_list_only/index.md create mode 100644 website/docs/services/ses/dedicated_ip_pools/index.md create mode 100644 website/docs/services/ses/dedicated_ip_pools_list_only/index.md create mode 100644 website/docs/services/ses/email_identities/index.md create mode 100644 website/docs/services/ses/email_identities_list_only/index.md create mode 100644 website/docs/services/ses/index.md create mode 100644 website/docs/services/ses/mail_manager_addon_instance_tags/index.md create mode 100644 website/docs/services/ses/mail_manager_addon_instances/index.md create mode 100644 website/docs/services/ses/mail_manager_addon_instances_list_only/index.md create mode 100644 website/docs/services/ses/mail_manager_addon_subscription_tags/index.md create mode 100644 website/docs/services/ses/mail_manager_addon_subscriptions/index.md create mode 100644 website/docs/services/ses/mail_manager_addon_subscriptions_list_only/index.md create mode 100644 website/docs/services/ses/mail_manager_archive_tags/index.md create mode 100644 website/docs/services/ses/mail_manager_archives/index.md create mode 100644 website/docs/services/ses/mail_manager_archives_list_only/index.md create mode 100644 website/docs/services/ses/mail_manager_ingress_point_tags/index.md create mode 100644 website/docs/services/ses/mail_manager_ingress_points/index.md create mode 100644 website/docs/services/ses/mail_manager_ingress_points_list_only/index.md create mode 100644 website/docs/services/ses/mail_manager_relay_tags/index.md create mode 100644 website/docs/services/ses/mail_manager_relays/index.md create mode 100644 website/docs/services/ses/mail_manager_relays_list_only/index.md create mode 100644 website/docs/services/ses/mail_manager_rule_set_tags/index.md create mode 100644 website/docs/services/ses/mail_manager_rule_sets/index.md create mode 100644 website/docs/services/ses/mail_manager_rule_sets_list_only/index.md create mode 100644 website/docs/services/ses/mail_manager_traffic_policies/index.md create mode 100644 website/docs/services/ses/mail_manager_traffic_policies_list_only/index.md create mode 100644 website/docs/services/ses/mail_manager_traffic_policy_tags/index.md create mode 100644 website/docs/services/ses/templates/index.md create mode 100644 website/docs/services/ses/templates_list_only/index.md create mode 100644 website/docs/services/ses/vdm_attributes/index.md create mode 100644 website/docs/services/shield/drt_accesses/index.md create mode 100644 website/docs/services/shield/drt_accesses_list_only/index.md create mode 100644 website/docs/services/shield/index.md create mode 100644 website/docs/services/shield/proactive_engagements/index.md create mode 100644 website/docs/services/shield/proactive_engagements_list_only/index.md create mode 100644 website/docs/services/shield/protection_group_tags/index.md create mode 100644 website/docs/services/shield/protection_groups/index.md create mode 100644 website/docs/services/shield/protection_groups_list_only/index.md create mode 100644 website/docs/services/shield/protection_tags/index.md create mode 100644 website/docs/services/shield/protections/index.md create mode 100644 website/docs/services/shield/protections_list_only/index.md create mode 100644 website/docs/services/signer/index.md create mode 100644 website/docs/services/signer/profile_permissions/index.md create mode 100644 website/docs/services/signer/profile_permissions_list_only/index.md create mode 100644 website/docs/services/signer/signing_profile_tags/index.md create mode 100644 website/docs/services/signer/signing_profiles/index.md create mode 100644 website/docs/services/signer/signing_profiles_list_only/index.md create mode 100644 website/docs/services/simspaceweaver/index.md create mode 100644 website/docs/services/simspaceweaver/simulations/index.md create mode 100644 website/docs/services/simspaceweaver/simulations_list_only/index.md create mode 100644 website/docs/services/sns/index.md create mode 100644 website/docs/services/sns/topic_inline_policies/index.md create mode 100644 website/docs/services/sns/topic_tags/index.md create mode 100644 website/docs/services/sns/topics/index.md create mode 100644 website/docs/services/sns/topics_list_only/index.md create mode 100644 website/docs/services/sqs/index.md create mode 100644 website/docs/services/sqs/queue_inline_policies/index.md create mode 100644 website/docs/services/sqs/queue_tags/index.md create mode 100644 website/docs/services/sqs/queues/index.md create mode 100644 website/docs/services/sqs/queues_list_only/index.md create mode 100644 website/docs/services/ssm/associations/index.md create mode 100644 website/docs/services/ssm/associations_list_only/index.md create mode 100644 website/docs/services/ssm/document_tags/index.md create mode 100644 website/docs/services/ssm/documents/index.md create mode 100644 website/docs/services/ssm/documents_list_only/index.md create mode 100644 website/docs/services/ssm/index.md create mode 100644 website/docs/services/ssm/parameter_tags/index.md create mode 100644 website/docs/services/ssm/parameters/index.md create mode 100644 website/docs/services/ssm/parameters_list_only/index.md create mode 100644 website/docs/services/ssm/patch_baseline_tags/index.md create mode 100644 website/docs/services/ssm/patch_baselines/index.md create mode 100644 website/docs/services/ssm/patch_baselines_list_only/index.md create mode 100644 website/docs/services/ssm/resource_data_syncs/index.md create mode 100644 website/docs/services/ssm/resource_data_syncs_list_only/index.md create mode 100644 website/docs/services/ssm/resource_policies/index.md create mode 100644 website/docs/services/ssm/resource_policies_list_only/index.md create mode 100644 website/docs/services/ssmcontacts/contact_channels/index.md create mode 100644 website/docs/services/ssmcontacts/contact_channels_list_only/index.md create mode 100644 website/docs/services/ssmcontacts/contacts/index.md create mode 100644 website/docs/services/ssmcontacts/contacts_list_only/index.md create mode 100644 website/docs/services/ssmcontacts/index.md create mode 100644 website/docs/services/ssmcontacts/plans/index.md create mode 100644 website/docs/services/ssmcontacts/rotation_tags/index.md create mode 100644 website/docs/services/ssmcontacts/rotations/index.md create mode 100644 website/docs/services/ssmcontacts/rotations_list_only/index.md create mode 100644 website/docs/services/ssmincidents/index.md create mode 100644 website/docs/services/ssmincidents/replication_set_tags/index.md create mode 100644 website/docs/services/ssmincidents/replication_sets/index.md create mode 100644 website/docs/services/ssmincidents/replication_sets_list_only/index.md create mode 100644 website/docs/services/ssmincidents/response_plan_tags/index.md create mode 100644 website/docs/services/ssmincidents/response_plans/index.md create mode 100644 website/docs/services/ssmincidents/response_plans_list_only/index.md create mode 100644 website/docs/services/ssmquicksetup/configuration_manager_tags/index.md create mode 100644 website/docs/services/ssmquicksetup/configuration_managers/index.md create mode 100644 website/docs/services/ssmquicksetup/configuration_managers_list_only/index.md create mode 100644 website/docs/services/ssmquicksetup/index.md create mode 100644 website/docs/services/sso/application_assignments/index.md create mode 100644 website/docs/services/sso/application_assignments_list_only/index.md create mode 100644 website/docs/services/sso/application_tags/index.md create mode 100644 website/docs/services/sso/applications/index.md create mode 100644 website/docs/services/sso/applications_list_only/index.md create mode 100644 website/docs/services/sso/assignments/index.md create mode 100644 website/docs/services/sso/assignments_list_only/index.md create mode 100644 website/docs/services/sso/index.md create mode 100644 website/docs/services/sso/instance_access_control_attribute_configurations/index.md create mode 100644 website/docs/services/sso/instance_access_control_attribute_configurations_list_only/index.md create mode 100644 website/docs/services/sso/instance_tags/index.md create mode 100644 website/docs/services/sso/instances/index.md create mode 100644 website/docs/services/sso/instances_list_only/index.md create mode 100644 website/docs/services/sso/permission_set_tags/index.md create mode 100644 website/docs/services/sso/permission_sets/index.md create mode 100644 website/docs/services/sso/permission_sets_list_only/index.md create mode 100644 website/docs/services/stepfunctions/activities/index.md create mode 100644 website/docs/services/stepfunctions/activities_list_only/index.md create mode 100644 website/docs/services/stepfunctions/activity_tags/index.md create mode 100644 website/docs/services/stepfunctions/index.md create mode 100644 website/docs/services/stepfunctions/state_machine_aliases/index.md create mode 100644 website/docs/services/stepfunctions/state_machine_aliases_list_only/index.md create mode 100644 website/docs/services/stepfunctions/state_machine_tags/index.md create mode 100644 website/docs/services/stepfunctions/state_machine_versions/index.md create mode 100644 website/docs/services/stepfunctions/state_machine_versions_list_only/index.md create mode 100644 website/docs/services/stepfunctions/state_machines/index.md create mode 100644 website/docs/services/stepfunctions/state_machines_list_only/index.md create mode 100644 website/docs/services/supportapp/account_aliases/index.md create mode 100644 website/docs/services/supportapp/account_aliases_list_only/index.md create mode 100644 website/docs/services/supportapp/index.md create mode 100644 website/docs/services/supportapp/slack_channel_configurations/index.md create mode 100644 website/docs/services/supportapp/slack_channel_configurations_list_only/index.md create mode 100644 website/docs/services/supportapp/slack_workspace_configurations/index.md create mode 100644 website/docs/services/supportapp/slack_workspace_configurations_list_only/index.md create mode 100644 website/docs/services/synthetics/canaries/index.md create mode 100644 website/docs/services/synthetics/canaries_list_only/index.md create mode 100644 website/docs/services/synthetics/canary_tags/index.md create mode 100644 website/docs/services/synthetics/group_tags/index.md create mode 100644 website/docs/services/synthetics/groups/index.md create mode 100644 website/docs/services/synthetics/groups_list_only/index.md create mode 100644 website/docs/services/synthetics/index.md create mode 100644 website/docs/services/systemsmanagersap/application_tags/index.md create mode 100644 website/docs/services/systemsmanagersap/applications/index.md create mode 100644 website/docs/services/systemsmanagersap/applications_list_only/index.md create mode 100644 website/docs/services/systemsmanagersap/index.md create mode 100644 website/docs/services/timestream/database_tags/index.md create mode 100644 website/docs/services/timestream/databases/index.md create mode 100644 website/docs/services/timestream/databases_list_only/index.md create mode 100644 website/docs/services/timestream/index.md create mode 100644 website/docs/services/timestream/influxdb_instance_tags/index.md create mode 100644 website/docs/services/timestream/influxdb_instances/index.md create mode 100644 website/docs/services/timestream/influxdb_instances_list_only/index.md create mode 100644 website/docs/services/timestream/scheduled_queries/index.md create mode 100644 website/docs/services/timestream/scheduled_queries_list_only/index.md create mode 100644 website/docs/services/timestream/scheduled_query_tags/index.md create mode 100644 website/docs/services/timestream/table_tags/index.md create mode 100644 website/docs/services/timestream/tables/index.md create mode 100644 website/docs/services/timestream/tables_list_only/index.md create mode 100644 website/docs/services/transfer/agreement_tags/index.md create mode 100644 website/docs/services/transfer/agreements/index.md create mode 100644 website/docs/services/transfer/agreements_list_only/index.md create mode 100644 website/docs/services/transfer/certificate_tags/index.md create mode 100644 website/docs/services/transfer/certificates/index.md create mode 100644 website/docs/services/transfer/certificates_list_only/index.md create mode 100644 website/docs/services/transfer/connector_tags/index.md create mode 100644 website/docs/services/transfer/connectors/index.md create mode 100644 website/docs/services/transfer/connectors_list_only/index.md create mode 100644 website/docs/services/transfer/index.md create mode 100644 website/docs/services/transfer/profile_tags/index.md create mode 100644 website/docs/services/transfer/profiles/index.md create mode 100644 website/docs/services/transfer/profiles_list_only/index.md create mode 100644 website/docs/services/transfer/public_keys/index.md create mode 100644 website/docs/services/transfer/server_tags/index.md create mode 100644 website/docs/services/transfer/servers/index.md create mode 100644 website/docs/services/transfer/servers_list_only/index.md create mode 100644 website/docs/services/transfer/user_tags/index.md create mode 100644 website/docs/services/transfer/users/index.md create mode 100644 website/docs/services/transfer/users_list_only/index.md create mode 100644 website/docs/services/transfer/workflow_tags/index.md create mode 100644 website/docs/services/transfer/workflows/index.md create mode 100644 website/docs/services/transfer/workflows_list_only/index.md create mode 100644 website/docs/services/verifiedpermissions/identity_sources/index.md create mode 100644 website/docs/services/verifiedpermissions/identity_sources_list_only/index.md create mode 100644 website/docs/services/verifiedpermissions/index.md create mode 100644 website/docs/services/verifiedpermissions/policies/index.md create mode 100644 website/docs/services/verifiedpermissions/policies_list_only/index.md create mode 100644 website/docs/services/verifiedpermissions/policy_stores/index.md create mode 100644 website/docs/services/verifiedpermissions/policy_stores_list_only/index.md create mode 100644 website/docs/services/verifiedpermissions/policy_templates/index.md create mode 100644 website/docs/services/verifiedpermissions/policy_templates_list_only/index.md create mode 100644 website/docs/services/voiceid/domain_tags/index.md create mode 100644 website/docs/services/voiceid/domains/index.md create mode 100644 website/docs/services/voiceid/domains_list_only/index.md create mode 100644 website/docs/services/voiceid/index.md create mode 100644 website/docs/services/vpclattice/access_log_subscription_tags/index.md create mode 100644 website/docs/services/vpclattice/access_log_subscriptions/index.md create mode 100644 website/docs/services/vpclattice/access_log_subscriptions_list_only/index.md create mode 100644 website/docs/services/vpclattice/auth_policies/index.md create mode 100644 website/docs/services/vpclattice/index.md create mode 100644 website/docs/services/vpclattice/listener_tags/index.md create mode 100644 website/docs/services/vpclattice/listeners/index.md create mode 100644 website/docs/services/vpclattice/listeners_list_only/index.md create mode 100644 website/docs/services/vpclattice/resource_configuration_tags/index.md create mode 100644 website/docs/services/vpclattice/resource_configurations/index.md create mode 100644 website/docs/services/vpclattice/resource_configurations_list_only/index.md create mode 100644 website/docs/services/vpclattice/resource_gateway_tags/index.md create mode 100644 website/docs/services/vpclattice/resource_gateways/index.md create mode 100644 website/docs/services/vpclattice/resource_gateways_list_only/index.md create mode 100644 website/docs/services/vpclattice/resource_policies/index.md create mode 100644 website/docs/services/vpclattice/rule_tags/index.md create mode 100644 website/docs/services/vpclattice/rules/index.md create mode 100644 website/docs/services/vpclattice/rules_list_only/index.md create mode 100644 website/docs/services/vpclattice/service_network_resource_association_tags/index.md create mode 100644 website/docs/services/vpclattice/service_network_resource_associations/index.md create mode 100644 website/docs/services/vpclattice/service_network_resource_associations_list_only/index.md create mode 100644 website/docs/services/vpclattice/service_network_service_association_tags/index.md create mode 100644 website/docs/services/vpclattice/service_network_service_associations/index.md create mode 100644 website/docs/services/vpclattice/service_network_service_associations_list_only/index.md create mode 100644 website/docs/services/vpclattice/service_network_tags/index.md create mode 100644 website/docs/services/vpclattice/service_network_vpc_association_tags/index.md create mode 100644 website/docs/services/vpclattice/service_network_vpc_associations/index.md create mode 100644 website/docs/services/vpclattice/service_network_vpc_associations_list_only/index.md create mode 100644 website/docs/services/vpclattice/service_networks/index.md create mode 100644 website/docs/services/vpclattice/service_networks_list_only/index.md create mode 100644 website/docs/services/vpclattice/service_tags/index.md create mode 100644 website/docs/services/vpclattice/services/index.md create mode 100644 website/docs/services/vpclattice/services_list_only/index.md create mode 100644 website/docs/services/vpclattice/target_group_tags/index.md create mode 100644 website/docs/services/vpclattice/target_groups/index.md create mode 100644 website/docs/services/vpclattice/target_groups_list_only/index.md create mode 100644 website/docs/services/wafv2/index.md create mode 100644 website/docs/services/wafv2/ip_set_tags/index.md create mode 100644 website/docs/services/wafv2/ip_sets/index.md create mode 100644 website/docs/services/wafv2/ip_sets_list_only/index.md create mode 100644 website/docs/services/wafv2/logging_configurations/index.md create mode 100644 website/docs/services/wafv2/logging_configurations_list_only/index.md create mode 100644 website/docs/services/wafv2/regex_pattern_set_tags/index.md create mode 100644 website/docs/services/wafv2/regex_pattern_sets/index.md create mode 100644 website/docs/services/wafv2/regex_pattern_sets_list_only/index.md create mode 100644 website/docs/services/wafv2/rule_group_tags/index.md create mode 100644 website/docs/services/wafv2/rule_groups/index.md create mode 100644 website/docs/services/wafv2/rule_groups_list_only/index.md create mode 100644 website/docs/services/wafv2/web_acl_tags/index.md create mode 100644 website/docs/services/wafv2/web_acls/index.md create mode 100644 website/docs/services/wafv2/web_acls_list_only/index.md create mode 100644 website/docs/services/wafv2/webacl_associations/index.md create mode 100644 website/docs/services/wisdom/ai_agent_tags/index.md create mode 100644 website/docs/services/wisdom/ai_agent_versions/index.md create mode 100644 website/docs/services/wisdom/ai_agent_versions_list_only/index.md create mode 100644 website/docs/services/wisdom/ai_agents/index.md create mode 100644 website/docs/services/wisdom/ai_agents_list_only/index.md create mode 100644 website/docs/services/wisdom/ai_guardrail_tags/index.md create mode 100644 website/docs/services/wisdom/ai_guardrail_versions/index.md create mode 100644 website/docs/services/wisdom/ai_guardrail_versions_list_only/index.md create mode 100644 website/docs/services/wisdom/ai_guardrails/index.md create mode 100644 website/docs/services/wisdom/ai_guardrails_list_only/index.md create mode 100644 website/docs/services/wisdom/ai_prompt_tags/index.md create mode 100644 website/docs/services/wisdom/ai_prompt_versions/index.md create mode 100644 website/docs/services/wisdom/ai_prompt_versions_list_only/index.md create mode 100644 website/docs/services/wisdom/ai_prompts/index.md create mode 100644 website/docs/services/wisdom/ai_prompts_list_only/index.md create mode 100644 website/docs/services/wisdom/assistant_association_tags/index.md create mode 100644 website/docs/services/wisdom/assistant_associations/index.md create mode 100644 website/docs/services/wisdom/assistant_associations_list_only/index.md create mode 100644 website/docs/services/wisdom/assistant_tags/index.md create mode 100644 website/docs/services/wisdom/assistants/index.md create mode 100644 website/docs/services/wisdom/assistants_list_only/index.md create mode 100644 website/docs/services/wisdom/index.md create mode 100644 website/docs/services/wisdom/knowledge_base_tags/index.md create mode 100644 website/docs/services/wisdom/knowledge_bases/index.md create mode 100644 website/docs/services/wisdom/knowledge_bases_list_only/index.md create mode 100644 website/docs/services/wisdom/message_template_tags/index.md create mode 100644 website/docs/services/wisdom/message_template_versions/index.md create mode 100644 website/docs/services/wisdom/message_template_versions_list_only/index.md create mode 100644 website/docs/services/wisdom/message_templates/index.md create mode 100644 website/docs/services/wisdom/message_templates_list_only/index.md create mode 100644 website/docs/services/workspaces/connection_aliases/index.md create mode 100644 website/docs/services/workspaces/index.md create mode 100644 website/docs/services/workspaces/workspaces_pool_tags/index.md create mode 100644 website/docs/services/workspaces/workspaces_pools/index.md create mode 100644 website/docs/services/workspaces/workspaces_pools_list_only/index.md create mode 100644 website/docs/services/workspacesthinclient/environment_tags/index.md create mode 100644 website/docs/services/workspacesthinclient/environments/index.md create mode 100644 website/docs/services/workspacesthinclient/environments_list_only/index.md create mode 100644 website/docs/services/workspacesthinclient/index.md create mode 100644 website/docs/services/workspacesweb/browser_settings/index.md create mode 100644 website/docs/services/workspacesweb/browser_settings_list_only/index.md create mode 100644 website/docs/services/workspacesweb/browser_settings_tags/index.md create mode 100644 website/docs/services/workspacesweb/data_protection_settings/index.md create mode 100644 website/docs/services/workspacesweb/data_protection_settings_list_only/index.md create mode 100644 website/docs/services/workspacesweb/data_protection_settings_tags/index.md create mode 100644 website/docs/services/workspacesweb/identity_provider_tags/index.md create mode 100644 website/docs/services/workspacesweb/identity_providers/index.md create mode 100644 website/docs/services/workspacesweb/identity_providers_list_only/index.md create mode 100644 website/docs/services/workspacesweb/index.md create mode 100644 website/docs/services/workspacesweb/ip_access_settings/index.md create mode 100644 website/docs/services/workspacesweb/ip_access_settings_list_only/index.md create mode 100644 website/docs/services/workspacesweb/ip_access_settings_tags/index.md create mode 100644 website/docs/services/workspacesweb/network_settings/index.md create mode 100644 website/docs/services/workspacesweb/network_settings_list_only/index.md create mode 100644 website/docs/services/workspacesweb/network_settings_tags/index.md create mode 100644 website/docs/services/workspacesweb/portal_tags/index.md create mode 100644 website/docs/services/workspacesweb/portals/index.md create mode 100644 website/docs/services/workspacesweb/portals_list_only/index.md create mode 100644 website/docs/services/workspacesweb/trust_store_tags/index.md create mode 100644 website/docs/services/workspacesweb/trust_stores/index.md create mode 100644 website/docs/services/workspacesweb/trust_stores_list_only/index.md create mode 100644 website/docs/services/workspacesweb/user_access_logging_settings/index.md create mode 100644 website/docs/services/workspacesweb/user_access_logging_settings_list_only/index.md create mode 100644 website/docs/services/workspacesweb/user_access_logging_settings_tags/index.md create mode 100644 website/docs/services/workspacesweb/user_settings/index.md create mode 100644 website/docs/services/workspacesweb/user_settings_list_only/index.md create mode 100644 website/docs/services/workspacesweb/user_settings_tags/index.md create mode 100644 website/docs/services/xray/group_tags/index.md create mode 100644 website/docs/services/xray/groups/index.md create mode 100644 website/docs/services/xray/groups_list_only/index.md create mode 100644 website/docs/services/xray/index.md create mode 100644 website/docs/services/xray/resource_policies/index.md create mode 100644 website/docs/services/xray/resource_policies_list_only/index.md create mode 100644 website/docs/services/xray/sampling_rule_tags/index.md create mode 100644 website/docs/services/xray/sampling_rules/index.md create mode 100644 website/docs/services/xray/sampling_rules_list_only/index.md create mode 100644 website/docusaurus.config.js create mode 100644 website/package.json create mode 100644 website/sidebars.js create mode 100644 website/src/components/CopyableCode/CopyableCode.js create mode 100644 website/src/components/HomepageFeatures/index.js create mode 100644 website/src/components/HomepageFeatures/styles.module.css create mode 100644 website/src/css/custom.css create mode 100644 website/src/pages/blog.js create mode 100644 website/src/pages/contact-us.js create mode 100644 website/src/pages/install.js create mode 100644 website/src/pages/providers/aws.js create mode 100644 website/src/pages/providers/azure.js create mode 100644 website/src/pages/providers/confluent.js create mode 100644 website/src/pages/providers/databricks.js create mode 100644 website/src/pages/providers/github.js create mode 100644 website/src/pages/providers/google.js create mode 100644 website/src/pages/providers/index.js create mode 100644 website/src/pages/providers/okta.js create mode 100644 website/src/pages/providers/openai.js create mode 100644 website/src/pages/providers/snowflake.js create mode 100644 website/src/pages/stackql-deploy.js create mode 100644 website/src/pages/stackqldocs.js create mode 100644 website/src/pages/tutorials.js create mode 100644 website/src/theme/Footer/Copyright/index.tsx create mode 100644 website/src/theme/Footer/Layout/index.tsx create mode 100644 website/src/theme/Footer/LinkItem/index.tsx create mode 100644 website/src/theme/Footer/Links/MultiColumn/index.tsx create mode 100644 website/src/theme/Footer/Links/Simple/index.tsx create mode 100644 website/src/theme/Footer/Links/index.tsx create mode 100644 website/src/theme/Footer/Logo/index.tsx create mode 100644 website/src/theme/Footer/Logo/styles.module.css create mode 100644 website/src/theme/Footer/index.tsx create mode 100644 website/src/theme/Footer/styles.module.css create mode 100644 website/src/theme/Logo/index.d.ts create mode 100644 website/src/theme/Logo/index.js create mode 100644 website/static/.nojekyll create mode 100644 website/static/CNAME create mode 100644 website/static/img/favicon-16x16.png create mode 100644 website/static/img/favicon-32x32.png create mode 100644 website/static/img/favicon.ico create mode 100644 website/static/img/stackql-aws-provider-featured-image.png create mode 100644 website/static/img/stackql-cover.png create mode 100644 website/static/img/stackql-registry-logo-mobile.svg create mode 100644 website/static/img/stackql-registry-logo-white-mobile.svg create mode 100644 website/static/img/stackql-registry-logo-white.svg create mode 100644 website/static/img/stackql-registry-logo.svg create mode 100644 website/yarn.lock diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..0d88430 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '[BUG]' +labels: 'bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..9d33cbe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE]" +labels: enhancement +assignees: '' + +--- + +**Feature Description** +A clear and concise description of what you want to happen. + +**Example(s)** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Possible Approaches or Libraries to Consider** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..b72dd78 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,15 @@ +--- +name: Question +about: Pose a question to the StackQL team +title: "[QUESTION]" +labels: question +assignees: '' + +--- + + +## Question + +This channel is an opportunity to ask ad-hoc questions to the `stackql` team. This channel is in lieu of an official platform for ongoing discussions and questions. Please ask your question :) + +**Note**: Questions over github issues will be deprecated and retired once we settle on a platform / process ongoing. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f7502a0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +## Description + +Please include a summary of the changes and the related issue(s). Please also include relevant motivation and context. + +## Checklist + +Please make sure that the following criteria are met: + +- [ ] The PR title is descriptive. +- [ ] I have ⭐'ed the [stackql](https://github.com/stackql/stackql) and this repo. + +## Additional Notes + +Add any additional information or context that might help the reviewers. diff --git a/.github/workflows/prod-web-deploy.yml b/.github/workflows/prod-web-deploy.yml new file mode 100644 index 0000000..ab53507 --- /dev/null +++ b/.github/workflows/prod-web-deploy.yml @@ -0,0 +1,58 @@ +name: Deploy to GitHub Pages + +on: + push: + branches: + - main + paths: + - 'website/**' + +jobs: + build: + name: Build Docusaurus + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: yarn + cache-dependency-path: website/yarn.lock + + - name: Install dependencies + run: yarn install --frozen-lockfile + working-directory: website + + - name: Build website + run: yarn build + working-directory: website + + - name: Upload Build Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: website/build # Ensure the path is correctly set to the Docusaurus build output + + deploy: + name: Deploy to GitHub Pages + needs: build + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 + with: + working-directory: website/build # Ensures the correct directory is used for deployment diff --git a/.github/workflows/star-check.yml b/.github/workflows/star-check.yml new file mode 100644 index 0000000..24d6c17 --- /dev/null +++ b/.github/workflows/star-check.yml @@ -0,0 +1,42 @@ +name: Check if PR author has starred required repositories +on: + pull_request: + types: [opened, synchronize, reopened] +jobs: + check-starred: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + - name: Get PR author username and repo info + id: get-info + run: | + echo "username=${{ github.event.pull_request.user.login }}" >> $GITHUB_ENV + echo "current_repo=${{ github.event.repository.name }}" >> $GITHUB_ENV + echo "current_owner=${{ github.repository_owner }}" >> $GITHUB_ENV + - name: Pull github provider + uses: stackql/stackql-exec@v2.2.1 + with: + is_command: 'true' + query: "REGISTRY PULL github;" + - name: Run stackql query + id: check-star + uses: stackql/stackql-assert@v2.2.1 + with: + test_query: | + SELECT repo, count(*) as has_starred + FROM github.activity.repo_stargazers + WHERE owner = '${{ env.current_owner }}' and repo IN ('stackql','${{ env.current_repo }}') + AND login = '${{ env.username }}' + GROUP BY repo; + expected_results_str: '[{"has_starred":"1","repo":"stackql"},{"has_starred":"1","repo":"${{ env.current_repo }}"}]' + continue-on-error: true + - name: Check if starred + if: always() # Ensures this runs regardless of check-star outcome + run: | + if [ "${{ steps.check-star.outcome }}" = "success" ]; then + echo "::notice::Thanks for your support!" + else + echo "::error::It seems you haven't starred the required repositories. Please star the following repos before proceeding: https://github.com/${{ env.current_owner }}/${{ env.current_repo }} (this repo) and https://github.com/stackql/stackql (our core repo)" + exit 1 + fi \ No newline at end of file diff --git a/.github/workflows/test-web-deploy.yml b/.github/workflows/test-web-deploy.yml new file mode 100644 index 0000000..1e2ef91 --- /dev/null +++ b/.github/workflows/test-web-deploy.yml @@ -0,0 +1,31 @@ +name: Test deployment + +on: + pull_request: + branches: + - main + paths: + - 'website/**' + +jobs: + test-deploy: + name: Test deployment + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: yarn + cache-dependency-path: website/yarn.lock + + - name: Install dependencies + run: yarn install --frozen-lockfile + working-directory: website + + - name: Test build website + run: yarn build + working-directory: website \ No newline at end of file diff --git a/fix_docs.sh b/fix_docs.sh new file mode 100644 index 0000000..7236adc --- /dev/null +++ b/fix_docs.sh @@ -0,0 +1,10 @@ +find website/docs/services -type f -name "*.md" -exec sed -i \ + -e 's//
\n/g' \ + -e 's#
#\n#g' {} + + +find website/docs/services -type f -name "*.md" -exec sed -i \ + -e 's##\n#g' {} + + +find website/docs/services -type f -name "*.md" -exec sed -i \ + -e 's/\*/*/g' {} + + diff --git a/website/.gitignore b/website/.gitignore new file mode 100644 index 0000000..b2d6de3 --- /dev/null +++ b/website/.gitignore @@ -0,0 +1,20 @@ +# Dependencies +/node_modules + +# Production +/build + +# Generated files +.docusaurus +.cache-loader + +# Misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/website/README.md b/website/README.md new file mode 100644 index 0000000..b28211a --- /dev/null +++ b/website/README.md @@ -0,0 +1,41 @@ +# Website + +This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. + +## Installation + +```bash +yarn +``` + +## Local Development + +```bash +yarn start +``` + +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. + +## Build + +```bash +yarn build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. + +## Deployment + +Using SSH: + +```bash +USE_SSH=true yarn deploy +``` + +Not using SSH: + +```bash +GIT_USER= yarn deploy +``` + +If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. diff --git a/website/docs/index.md b/website/docs/index.md new file mode 100644 index 0000000..9f3caa4 --- /dev/null +++ b/website/docs/index.md @@ -0,0 +1,323 @@ +--- +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/stackql-aws-provider-featured-image.png +id: 'provider-intro' +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + +Cloud services from AWS. + +:::info Provider Summary (v25.01.00283) + +
+
+total services: 231
+total resources: 3176
+
+
+ +::: + +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 (see How to Create AWS Credentials) +- - AWS Secret Access Key (see How to Create AWS Credentials) +- - [OPTIONAL: only required if using ] AWS Session Token (see Temporary security credentials in IAM) + +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: + +- - AWS region (e.g. us-east-1) + +This parameter must be supplied to the `WHERE` clause of each `SELECT` statement. + +## Services +
+ + +
\ No newline at end of file diff --git a/website/docs/services/accessanalyzer/analyzer_tags/index.md b/website/docs/services/accessanalyzer/analyzer_tags/index.md new file mode 100644 index 0000000..6b73a76 --- /dev/null +++ b/website/docs/services/accessanalyzer/analyzer_tags/index.md @@ -0,0 +1,85 @@ +--- +title: analyzer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - analyzer_tags + - accessanalyzer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for analyzers in a region + +## Overview + + + + + + + +
Nameanalyzer_tags
TypeResource
DescriptionThe AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringAnalyzer name
array
stringAmazon Resource Name (ARN) of the analyzer
stringThe type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS
objectThe configuration for the analyzer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all analyzers in a region. +```sql +SELECT +region, +analyzer_name, +archive_rules, +arn, +type, +analyzer_configuration, +tag_key, +tag_value +FROM aws.accessanalyzer.analyzer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analyzer_tags resource, see analyzers + diff --git a/website/docs/services/accessanalyzer/analyzers/index.md b/website/docs/services/accessanalyzer/analyzers/index.md new file mode 100644 index 0000000..3ab7236 --- /dev/null +++ b/website/docs/services/accessanalyzer/analyzers/index.md @@ -0,0 +1,257 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an analyzer resource or lists analyzers in a region + +## Overview + + + + + + + +
Nameanalyzers
TypeResource
DescriptionThe AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringAnalyzer name
array
stringAmazon Resource Name (ARN) of the analyzer
arrayAn array of key-value pairs to apply to this resource.
stringThe type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS
objectThe configuration for the analyzer
stringAWS region.
+ +For more information, see AWS::AccessAnalyzer::Analyzer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all analyzers in a region. +```sql +SELECT +region, +analyzer_name, +archive_rules, +arn, +tags, +type, +analyzer_configuration +FROM aws.accessanalyzer.analyzers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual analyzer. +```sql +SELECT +region, +analyzer_name, +archive_rules, +arn, +tags, +type, +analyzer_configuration +FROM aws.accessanalyzer.analyzers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new analyzer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.accessanalyzer.analyzers ( + Type, + region +) +SELECT +'{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.accessanalyzer.analyzers ( + AnalyzerName, + ArchiveRules, + Tags, + Type, + AnalyzerConfiguration, + region +) +SELECT + '{{ AnalyzerName }}', + '{{ ArchiveRules }}', + '{{ Tags }}', + '{{ Type }}', + '{{ AnalyzerConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: analyzer + props: + - name: AnalyzerName + value: '{{ AnalyzerName }}' + - name: ArchiveRules + value: + - Filter: + - Contains: + - '{{ Contains[0] }}' + Eq: + - '{{ Eq[0] }}' + Exists: '{{ Exists }}' + Property: '{{ Property }}' + Neq: + - '{{ Neq[0] }}' + RuleName: '{{ RuleName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + - name: AnalyzerConfiguration + value: + UnusedAccessConfiguration: + UnusedAccessAge: '{{ UnusedAccessAge }}' + AnalysisRule: + Exclusions: + - AccountIds: + - '{{ AccountIds[0] }}' + ResourceTags: + - - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.accessanalyzer.analyzers +WHERE data__Identifier = '' +AND 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 +``` + +### 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:UpdateAnalyzer, +access-analyzer:UpdateArchiveRule +``` + +### Delete +```json +access-analyzer:DeleteAnalyzer +``` + +### List +```json +access-analyzer:ListAnalyzers +``` diff --git a/website/docs/services/accessanalyzer/analyzers_list_only/index.md b/website/docs/services/accessanalyzer/analyzers_list_only/index.md new file mode 100644 index 0000000..0f397db --- /dev/null +++ b/website/docs/services/accessanalyzer/analyzers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: analyzers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - analyzers_list_only + - accessanalyzer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists analyzers in a region or regions, for all properties use analyzers + +## Overview + + + + + + + +
Nameanalyzers_list_only
TypeResource
DescriptionThe AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN) of the analyzer
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all analyzers in a region. +```sql +SELECT +region, +arn +FROM aws.accessanalyzer.analyzers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analyzers_list_only resource, see analyzers + diff --git a/website/docs/services/accessanalyzer/index.md b/website/docs/services/accessanalyzer/index.md new file mode 100644 index 0000000..9b506f7 --- /dev/null +++ b/website/docs/services/accessanalyzer/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The accessanalyzer service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/acmpca/certificate_authorities/index.md b/website/docs/services/acmpca/certificate_authorities/index.md new file mode 100644 index 0000000..c9201f8 --- /dev/null +++ b/website/docs/services/acmpca/certificate_authorities/index.md @@ -0,0 +1,330 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a certificate_authority resource or lists certificate_authorities in a region + +## Overview + + + + + + + +
Namecertificate_authorities
TypeResource
DescriptionPrivate certificate authority.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the certificate authority.
stringThe type of the certificate authority.
stringPublic key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.
stringAlgorithm your CA uses to sign certificate requests.
objectStructure that contains X.500 distinguished name information for your CA.
objectCertificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions.
array
stringThe base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.
objectStructure that contains CSR pass through extension information used by the CreateCertificateAuthority action.
stringKeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.
stringUsage mode of the ceritificate authority.
stringAWS region.
+ +For more information, see AWS::ACMPCA::CertificateAuthority. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all certificate_authorities in a region. +```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_authorities +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual certificate_authority. +```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_authorities +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new certificate_authority resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.acmpca.certificate_authorities ( + Type, + KeyAlgorithm, + SigningAlgorithm, + Subject, + region +) +SELECT +'{{ Type }}', + '{{ KeyAlgorithm }}', + '{{ SigningAlgorithm }}', + '{{ Subject }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.acmpca.certificate_authorities ( + Type, + KeyAlgorithm, + SigningAlgorithm, + Subject, + RevocationConfiguration, + Tags, + CsrExtensions, + KeyStorageSecurityStandard, + UsageMode, + region +) +SELECT + '{{ Type }}', + '{{ KeyAlgorithm }}', + '{{ SigningAlgorithm }}', + '{{ Subject }}', + '{{ RevocationConfiguration }}', + '{{ Tags }}', + '{{ CsrExtensions }}', + '{{ KeyStorageSecurityStandard }}', + '{{ UsageMode }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: certificate_authority + props: + - name: Type + value: '{{ Type }}' + - name: KeyAlgorithm + value: '{{ KeyAlgorithm }}' + - name: SigningAlgorithm + value: '{{ SigningAlgorithm }}' + - name: Subject + value: + Country: '{{ Country }}' + Organization: '{{ Organization }}' + OrganizationalUnit: '{{ OrganizationalUnit }}' + DistinguishedNameQualifier: '{{ DistinguishedNameQualifier }}' + State: '{{ State }}' + CommonName: '{{ CommonName }}' + SerialNumber: '{{ SerialNumber }}' + Locality: '{{ Locality }}' + Title: '{{ Title }}' + Surname: '{{ Surname }}' + GivenName: '{{ GivenName }}' + Initials: '{{ Initials }}' + Pseudonym: '{{ Pseudonym }}' + GenerationQualifier: '{{ GenerationQualifier }}' + CustomAttributes: + - ObjectIdentifier: '{{ ObjectIdentifier }}' + Value: '{{ Value }}' + - name: RevocationConfiguration + value: + CrlConfiguration: + Enabled: '{{ Enabled }}' + ExpirationInDays: '{{ ExpirationInDays }}' + CustomCname: '{{ CustomCname }}' + S3BucketName: '{{ S3BucketName }}' + S3ObjectAcl: '{{ S3ObjectAcl }}' + CrlDistributionPointExtensionConfiguration: + OmitExtension: '{{ OmitExtension }}' + OcspConfiguration: + Enabled: '{{ Enabled }}' + OcspCustomCname: '{{ OcspCustomCname }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CsrExtensions + value: + KeyUsage: + DigitalSignature: '{{ DigitalSignature }}' + NonRepudiation: '{{ NonRepudiation }}' + KeyEncipherment: '{{ KeyEncipherment }}' + DataEncipherment: '{{ DataEncipherment }}' + KeyAgreement: '{{ KeyAgreement }}' + KeyCertSign: '{{ KeyCertSign }}' + CRLSign: '{{ CRLSign }}' + EncipherOnly: '{{ EncipherOnly }}' + DecipherOnly: '{{ DecipherOnly }}' + SubjectInformationAccess: + - AccessMethod: + CustomObjectIdentifier: null + AccessMethodType: '{{ AccessMethodType }}' + AccessLocation: + OtherName: + TypeId: null + Value: '{{ Value }}' + Rfc822Name: '{{ Rfc822Name }}' + DnsName: '{{ DnsName }}' + DirectoryName: null + EdiPartyName: + PartyName: '{{ PartyName }}' + NameAssigner: '{{ NameAssigner }}' + UniformResourceIdentifier: '{{ UniformResourceIdentifier }}' + IpAddress: '{{ IpAddress }}' + RegisteredId: null + - name: KeyStorageSecurityStandard + value: '{{ KeyStorageSecurityStandard }}' + - name: UsageMode + value: '{{ UsageMode }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.acmpca.certificate_authorities +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +acm-pca:DescribeCertificateAuthority, +acm-pca:GetCertificateAuthorityCsr, +acm-pca:ListCertificateAuthorities, +acm-pca:ListTags +``` diff --git a/website/docs/services/acmpca/certificate_authorities_list_only/index.md b/website/docs/services/acmpca/certificate_authorities_list_only/index.md new file mode 100644 index 0000000..0556835 --- /dev/null +++ b/website/docs/services/acmpca/certificate_authorities_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: certificate_authorities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_authorities_list_only + - acmpca + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists certificate_authorities in a region or regions, for all properties use certificate_authorities + +## Overview + + + + + + + +
Namecertificate_authorities_list_only
TypeResource
DescriptionPrivate certificate authority.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the certificate authority.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all certificate_authorities in a region. +```sql +SELECT +region, +arn +FROM aws.acmpca.certificate_authorities_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_authorities_list_only resource, see certificate_authorities + diff --git a/website/docs/services/acmpca/certificate_authority_activations/index.md b/website/docs/services/acmpca/certificate_authority_activations/index.md new file mode 100644 index 0000000..79329e1 --- /dev/null +++ b/website/docs/services/acmpca/certificate_authority_activations/index.md @@ -0,0 +1,202 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a certificate_authority_activation resource or lists certificate_authority_activations in a region + +## Overview + + + + + + + +
Namecertificate_authority_activations
TypeResource
DescriptionUsed to install the certificate authority certificate and update the certificate authority status.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringArn of the Certificate Authority.
stringCertificate Authority certificate that will be installed in the Certificate Authority.
stringCertificate chain for the Certificate Authority certificate.
stringThe status of the Certificate Authority.
stringThe complete certificate chain, including the Certificate Authority certificate.
stringAWS region.
+ +For more information, see AWS::ACMPCA::CertificateAuthorityActivation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual certificate_authority_activation. +```sql +SELECT +region, +certificate_authority_arn, +certificate, +certificate_chain, +status, +complete_certificate_chain +FROM aws.acmpca.certificate_authority_activations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new certificate_authority_activation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.acmpca.certificate_authority_activations ( + CertificateAuthorityArn, + Certificate, + region +) +SELECT +'{{ CertificateAuthorityArn }}', + '{{ Certificate }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.acmpca.certificate_authority_activations ( + CertificateAuthorityArn, + Certificate, + CertificateChain, + Status, + region +) +SELECT + '{{ CertificateAuthorityArn }}', + '{{ Certificate }}', + '{{ CertificateChain }}', + '{{ Status }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: certificate_authority_activation + props: + - name: CertificateAuthorityArn + value: '{{ CertificateAuthorityArn }}' + - name: Certificate + value: '{{ Certificate }}' + - name: CertificateChain + value: '{{ CertificateChain }}' + - name: Status + value: '{{ Status }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.acmpca.certificate_authority_activations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +acm-pca:GetCertificateAuthorityCertificate, +acm-pca:DescribeCertificateAuthority +``` + +### Delete +```json +acm-pca:UpdateCertificateAuthority +``` + +### Update +```json +acm-pca:ImportCertificateAuthorityCertificate, +acm-pca:UpdateCertificateAuthority +``` diff --git a/website/docs/services/acmpca/certificate_authority_tags/index.md b/website/docs/services/acmpca/certificate_authority_tags/index.md new file mode 100644 index 0000000..0febb15 --- /dev/null +++ b/website/docs/services/acmpca/certificate_authority_tags/index.md @@ -0,0 +1,95 @@ +--- +title: certificate_authority_tags +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_authority_tags + - acmpca + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for certificate_authorities in a region + +## Overview + + + + + + + +
Namecertificate_authority_tags
TypeResource
DescriptionPrivate certificate authority.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the certificate authority.
stringThe type of the certificate authority.
stringPublic key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.
stringAlgorithm your CA uses to sign certificate requests.
objectStructure that contains X.500 distinguished name information for your CA.
objectCertificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions.
stringThe base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.
objectStructure that contains CSR pass through extension information used by the CreateCertificateAuthority action.
stringKeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.
stringUsage mode of the ceritificate authority.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all certificate_authorities in a region. +```sql +SELECT +region, +arn, +type, +key_algorithm, +signing_algorithm, +subject, +revocation_configuration, +certificate_signing_request, +csr_extensions, +key_storage_security_standard, +usage_mode, +tag_key, +tag_value +FROM aws.acmpca.certificate_authority_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_authority_tags resource, see certificate_authorities + diff --git a/website/docs/services/acmpca/certificates/index.md b/website/docs/services/acmpca/certificates/index.md new file mode 100644 index 0000000..fb62e3b --- /dev/null +++ b/website/docs/services/acmpca/certificates/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a certificate resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectSpecifies 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.
stringThe Amazon Resource Name (ARN) for the private CA issues the certificate.
stringThe certificate signing request (CSR) for the certificate.
stringThe name of the algorithm that will be used to sign the certificate to be issued.
This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
stringSpecifies 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).
objectThe period of time during which the certificate will be valid.
objectInformation describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.
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.
Unlike the Validity parameter, the ValidityNotBefore parameter is optional.
The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE.
string
string
stringAWS region.
+ +For more information, see AWS::ACMPCA::Certificate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual certificate. +```sql +SELECT +region, +api_passthrough, +certificate_authority_arn, +certificate_signing_request, +signing_algorithm, +template_arn, +validity, +validity_not_before, +certificate, +arn +FROM aws.acmpca.certificates +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.acmpca.certificates ( + CertificateAuthorityArn, + CertificateSigningRequest, + SigningAlgorithm, + Validity, + region +) +SELECT +'{{ CertificateAuthorityArn }}', + '{{ CertificateSigningRequest }}', + '{{ SigningAlgorithm }}', + '{{ Validity }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.acmpca.certificates ( + ApiPassthrough, + CertificateAuthorityArn, + CertificateSigningRequest, + SigningAlgorithm, + TemplateArn, + Validity, + ValidityNotBefore, + region +) +SELECT + '{{ ApiPassthrough }}', + '{{ CertificateAuthorityArn }}', + '{{ CertificateSigningRequest }}', + '{{ SigningAlgorithm }}', + '{{ TemplateArn }}', + '{{ Validity }}', + '{{ ValidityNotBefore }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: certificate + props: + - name: ApiPassthrough + value: + Extensions: + CertificatePolicies: + - CertPolicyId: '{{ CertPolicyId }}' + PolicyQualifiers: + - PolicyQualifierId: '{{ PolicyQualifierId }}' + Qualifier: + CpsUri: '{{ CpsUri }}' + ExtendedKeyUsage: + - ExtendedKeyUsageType: '{{ ExtendedKeyUsageType }}' + ExtendedKeyUsageObjectIdentifier: null + KeyUsage: + DigitalSignature: '{{ DigitalSignature }}' + NonRepudiation: '{{ NonRepudiation }}' + KeyEncipherment: '{{ KeyEncipherment }}' + DataEncipherment: '{{ DataEncipherment }}' + KeyAgreement: '{{ KeyAgreement }}' + KeyCertSign: '{{ KeyCertSign }}' + CRLSign: '{{ CRLSign }}' + EncipherOnly: '{{ EncipherOnly }}' + DecipherOnly: '{{ DecipherOnly }}' + SubjectAlternativeNames: + - OtherName: + TypeId: null + Value: '{{ Value }}' + Rfc822Name: '{{ Rfc822Name }}' + DnsName: '{{ DnsName }}' + DirectoryName: + Country: '{{ Country }}' + Organization: '{{ Organization }}' + OrganizationalUnit: '{{ OrganizationalUnit }}' + DistinguishedNameQualifier: '{{ DistinguishedNameQualifier }}' + State: '{{ State }}' + CommonName: '{{ CommonName }}' + SerialNumber: '{{ SerialNumber }}' + Locality: '{{ Locality }}' + Title: '{{ Title }}' + Surname: '{{ Surname }}' + GivenName: '{{ GivenName }}' + Initials: '{{ Initials }}' + Pseudonym: '{{ Pseudonym }}' + GenerationQualifier: '{{ GenerationQualifier }}' + CustomAttributes: + - ObjectIdentifier: null + Value: '{{ Value }}' + EdiPartyName: + PartyName: '{{ PartyName }}' + NameAssigner: '{{ NameAssigner }}' + UniformResourceIdentifier: '{{ UniformResourceIdentifier }}' + IpAddress: '{{ IpAddress }}' + RegisteredId: null + CustomExtensions: + - Critical: '{{ Critical }}' + ObjectIdentifier: null + Value: '{{ Value }}' + Subject: null + - name: CertificateAuthorityArn + value: '{{ CertificateAuthorityArn }}' + - name: CertificateSigningRequest + value: '{{ CertificateSigningRequest }}' + - name: SigningAlgorithm + value: '{{ SigningAlgorithm }}' + - name: TemplateArn + value: null + - name: Validity + value: + Value: null + Type: '{{ Type }}' + - name: ValidityNotBefore + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.acmpca.certificates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the certificates resource, the following permissions are required: + +### Create +```json +acm-pca:IssueCertificate, +acm-pca:GetCertificate +``` + +### Read +```json +acm-pca:GetCertificate +``` + +### Delete +```json +acm-pca:GetCertificate +``` diff --git a/website/docs/services/acmpca/index.md b/website/docs/services/acmpca/index.md new file mode 100644 index 0000000..f6ffb8d --- /dev/null +++ b/website/docs/services/acmpca/index.md @@ -0,0 +1,41 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The acmpca service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/acmpca/permissions/index.md b/website/docs/services/acmpca/permissions/index.md new file mode 100644 index 0000000..9410bba --- /dev/null +++ b/website/docs/services/acmpca/permissions/index.md @@ -0,0 +1,191 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a permission resource or lists permissions in a region + +## Overview + + + + + + + +
Namepermissions
TypeResource
DescriptionPermission set on private certificate authority
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arrayThe actions that the specified AWS service principal can use. Actions IssueCertificate, GetCertificate and ListPermissions must be provided.
stringThe Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission.
stringThe AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
stringThe ID of the calling account.
stringAWS region.
+ +For more information, see AWS::ACMPCA::Permission. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual permission. +```sql +SELECT +region, +actions, +certificate_authority_arn, +principal, +source_account +FROM aws.acmpca.permissions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.acmpca.permissions ( + Actions, + CertificateAuthorityArn, + Principal, + region +) +SELECT +'{{ Actions }}', + '{{ CertificateAuthorityArn }}', + '{{ Principal }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.acmpca.permissions ( + Actions, + CertificateAuthorityArn, + Principal, + SourceAccount, + region +) +SELECT + '{{ Actions }}', + '{{ CertificateAuthorityArn }}', + '{{ Principal }}', + '{{ SourceAccount }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: permission + props: + - name: Actions + value: + - '{{ Actions[0] }}' + - name: CertificateAuthorityArn + value: '{{ CertificateAuthorityArn }}' + - name: Principal + value: '{{ Principal }}' + - name: SourceAccount + value: '{{ SourceAccount }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.acmpca.permissions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the permissions resource, the following permissions are required: + +### Create +```json +acm-pca:CreatePermission, +acm-pca:ListPermissions +``` + +### Read +```json +acm-pca:ListPermissions +``` + +### Delete +```json +acm-pca:DeletePermission +``` diff --git a/website/docs/services/amazonmq/configuration_tags/index.md b/website/docs/services/amazonmq/configuration_tags/index.md new file mode 100644 index 0000000..5a97d5d --- /dev/null +++ b/website/docs/services/amazonmq/configuration_tags/index.md @@ -0,0 +1,93 @@ +--- +title: configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_tags + - amazonmq + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configurations in a region + +## Overview + + + + + + + +
Nameconfiguration_tags
TypeResource
DescriptionResource Type definition for AWS::AmazonMQ::Configuration
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Amazon MQ configuration.
stringThe authentication strategy associated with the configuration. The default is SIMPLE.
stringThe type of broker engine. Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.
stringThe version of the broker engine.
stringThe base64-encoded XML configuration.
stringThe description of the configuration.
stringThe ID of the Amazon MQ configuration.
stringThe name of the configuration.
stringThe revision number of the configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configurations in a region. +```sql +SELECT +region, +arn, +authentication_strategy, +engine_type, +engine_version, +data, +description, +id, +name, +revision, +tag_key, +tag_value +FROM aws.amazonmq.configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_tags resource, see configurations + diff --git a/website/docs/services/amazonmq/configurations/index.md b/website/docs/services/amazonmq/configurations/index.md new file mode 100644 index 0000000..366b4ec --- /dev/null +++ b/website/docs/services/amazonmq/configurations/index.md @@ -0,0 +1,254 @@ +--- +title: configurations +hide_title: false +hide_table_of_contents: false +keywords: + - configurations + - amazonmq + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configuration resource or lists configurations in a region + +## Overview + + + + + + + +
Nameconfigurations
TypeResource
DescriptionResource Type definition for AWS::AmazonMQ::Configuration
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Amazon MQ configuration.
stringThe authentication strategy associated with the configuration. The default is SIMPLE.
stringThe type of broker engine. Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.
stringThe version of the broker engine.
stringThe base64-encoded XML configuration.
stringThe description of the configuration.
stringThe ID of the Amazon MQ configuration.
stringThe name of the configuration.
stringThe revision number of the configuration.
arrayCreate tags when creating the configuration.
stringAWS region.
+ +For more information, see AWS::AmazonMQ::Configuration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configurations in a region. +```sql +SELECT +region, +arn, +authentication_strategy, +engine_type, +engine_version, +data, +description, +id, +name, +revision, +tags +FROM aws.amazonmq.configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual configuration. +```sql +SELECT +region, +arn, +authentication_strategy, +engine_type, +engine_version, +data, +description, +id, +name, +revision, +tags +FROM aws.amazonmq.configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.amazonmq.configurations ( + EngineType, + Name, + region +) +SELECT +'{{ EngineType }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.amazonmq.configurations ( + AuthenticationStrategy, + EngineType, + EngineVersion, + Data, + Description, + Name, + Tags, + region +) +SELECT + '{{ AuthenticationStrategy }}', + '{{ EngineType }}', + '{{ EngineVersion }}', + '{{ Data }}', + '{{ Description }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configuration + props: + - name: AuthenticationStrategy + value: '{{ AuthenticationStrategy }}' + - name: EngineType + value: '{{ EngineType }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: Data + value: '{{ Data }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.amazonmq.configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the configurations resource, the following permissions are required: + +### Create +```json +mq:CreateConfiguration, +mq:CreateTags, +mq:UpdateConfiguration +``` + +### Read +```json +mq:DescribeConfiguration, +mq:ListTags +``` + +### Update +```json +mq:UpdateConfiguration, +mq:CreateTags, +mq:DeleteTags +``` + +### Delete +```json +mq:DescribeConfiguration +``` + +### List +```json +mq:ListConfigurations +``` diff --git a/website/docs/services/amazonmq/configurations_list_only/index.md b/website/docs/services/amazonmq/configurations_list_only/index.md new file mode 100644 index 0000000..587774b --- /dev/null +++ b/website/docs/services/amazonmq/configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configurations_list_only + - amazonmq + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configurations in a region or regions, for all properties use configurations + +## Overview + + + + + + + +
Nameconfigurations_list_only
TypeResource
DescriptionResource Type definition for AWS::AmazonMQ::Configuration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the Amazon MQ configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configurations in a region. +```sql +SELECT +region, +id +FROM aws.amazonmq.configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configurations_list_only resource, see configurations + diff --git a/website/docs/services/amazonmq/index.md b/website/docs/services/amazonmq/index.md new file mode 100644 index 0000000..eea948a --- /dev/null +++ b/website/docs/services/amazonmq/index.md @@ -0,0 +1,38 @@ +--- +title: amazonmq +hide_title: false +hide_table_of_contents: false +keywords: + - amazonmq + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The amazonmq service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/amplify/app_tags/index.md b/website/docs/services/amplify/app_tags/index.md new file mode 100644 index 0000000..19adf3c --- /dev/null +++ b/website/docs/services/amplify/app_tags/index.md @@ -0,0 +1,113 @@ +--- +title: app_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_tags + - amplify + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for apps in a region + +## Overview + + + + + + + +
Nameapp_tags
TypeResource
DescriptionThe AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
object
string
array
string
string
boolean
array
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all apps in a region. +```sql +SELECT +region, +access_token, +app_id, +app_name, +arn, +auto_branch_creation_config, +basic_auth_config, +build_spec, +cache_config, +custom_headers, +custom_rules, +default_domain, +description, +enable_branch_auto_deletion, +environment_variables, +iam_service_role, +name, +oauth_token, +platform, +repository, +tag_key, +tag_value +FROM aws.amplify.app_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_tags resource, see apps + diff --git a/website/docs/services/amplify/apps/index.md b/website/docs/services/amplify/apps/index.md new file mode 100644 index 0000000..753a2ea --- /dev/null +++ b/website/docs/services/amplify/apps/index.md @@ -0,0 +1,368 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an app resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
object
string
array
string
string
boolean
array
string
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::Amplify::App. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all apps in a region. +```sql +SELECT +region, +access_token, +app_id, +app_name, +arn, +auto_branch_creation_config, +basic_auth_config, +build_spec, +cache_config, +custom_headers, +custom_rules, +default_domain, +description, +enable_branch_auto_deletion, +environment_variables, +iam_service_role, +name, +oauth_token, +platform, +repository, +tags +FROM aws.amplify.apps +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual app. +```sql +SELECT +region, +access_token, +app_id, +app_name, +arn, +auto_branch_creation_config, +basic_auth_config, +build_spec, +cache_config, +custom_headers, +custom_rules, +default_domain, +description, +enable_branch_auto_deletion, +environment_variables, +iam_service_role, +name, +oauth_token, +platform, +repository, +tags +FROM aws.amplify.apps +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new app resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.amplify.apps ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.amplify.apps ( + AccessToken, + AutoBranchCreationConfig, + BasicAuthConfig, + BuildSpec, + CacheConfig, + CustomHeaders, + CustomRules, + Description, + EnableBranchAutoDeletion, + EnvironmentVariables, + IAMServiceRole, + Name, + OauthToken, + Platform, + Repository, + Tags, + region +) +SELECT + '{{ AccessToken }}', + '{{ AutoBranchCreationConfig }}', + '{{ BasicAuthConfig }}', + '{{ BuildSpec }}', + '{{ CacheConfig }}', + '{{ CustomHeaders }}', + '{{ CustomRules }}', + '{{ Description }}', + '{{ EnableBranchAutoDeletion }}', + '{{ EnvironmentVariables }}', + '{{ IAMServiceRole }}', + '{{ Name }}', + '{{ OauthToken }}', + '{{ Platform }}', + '{{ Repository }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: app + props: + - name: AccessToken + value: '{{ AccessToken }}' + - name: AutoBranchCreationConfig + value: + AutoBranchCreationPatterns: + - '{{ AutoBranchCreationPatterns[0] }}' + BasicAuthConfig: + EnableBasicAuth: '{{ EnableBasicAuth }}' + Username: '{{ Username }}' + Password: '{{ Password }}' + BuildSpec: '{{ BuildSpec }}' + EnableAutoBranchCreation: '{{ EnableAutoBranchCreation }}' + EnableAutoBuild: '{{ EnableAutoBuild }}' + EnablePerformanceMode: '{{ EnablePerformanceMode }}' + EnablePullRequestPreview: '{{ EnablePullRequestPreview }}' + EnvironmentVariables: + - Name: '{{ Name }}' + Value: '{{ Value }}' + Framework: '{{ Framework }}' + PullRequestEnvironmentName: '{{ PullRequestEnvironmentName }}' + Stage: '{{ Stage }}' + - name: BasicAuthConfig + value: null + - name: BuildSpec + value: '{{ BuildSpec }}' + - name: CacheConfig + value: + Type: '{{ Type }}' + - name: CustomHeaders + value: '{{ CustomHeaders }}' + - name: CustomRules + value: + - Condition: '{{ Condition }}' + Status: '{{ Status }}' + Target: '{{ Target }}' + Source: '{{ Source }}' + - name: Description + value: '{{ Description }}' + - name: EnableBranchAutoDeletion + value: '{{ EnableBranchAutoDeletion }}' + - name: EnvironmentVariables + value: + - null + - name: IAMServiceRole + value: '{{ IAMServiceRole }}' + - name: Name + value: '{{ Name }}' + - name: OauthToken + value: '{{ OauthToken }}' + - name: Platform + value: '{{ Platform }}' + - name: Repository + value: '{{ Repository }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.amplify.apps +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +amplify:GetApp, +amplify:DeleteApp, +codecommit:GetRepository, +codecommit:GetRepositoryTriggers, +codecommit:PutRepositoryTriggers, +sns:Unsubscribe, +iam:PassRole +``` + +### List +```json +amplify:GetApp, +amplify:ListApps, +amplify:ListTagsForResource, +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/website/docs/services/amplify/apps_list_only/index.md b/website/docs/services/amplify/apps_list_only/index.md new file mode 100644 index 0000000..821eb13 --- /dev/null +++ b/website/docs/services/amplify/apps_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: apps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - apps_list_only + - amplify + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists apps in a region or regions, for all properties use apps + +## Overview + + + + + + + +
Nameapps_list_only
TypeResource
DescriptionThe AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all apps in a region. +```sql +SELECT +region, +arn +FROM aws.amplify.apps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the apps_list_only resource, see apps + diff --git a/website/docs/services/amplify/branch_tags/index.md b/website/docs/services/amplify/branch_tags/index.md new file mode 100644 index 0000000..4432c5e --- /dev/null +++ b/website/docs/services/amplify/branch_tags/index.md @@ -0,0 +1,103 @@ +--- +title: branch_tags +hide_title: false +hide_table_of_contents: false +keywords: + - branch_tags + - amplify + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for branches in a region + +## Overview + + + + + + + +
Namebranch_tags
TypeResource
DescriptionThe AWS::Amplify::Branch resource creates a new branch within an app.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
object
string
string
string
boolean
boolean
boolean
array
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all branches in a region. +```sql +SELECT +region, +app_id, +arn, +basic_auth_config, +backend, +branch_name, +build_spec, +description, +enable_auto_build, +enable_performance_mode, +enable_pull_request_preview, +environment_variables, +framework, +pull_request_environment_name, +stage, +tag_key, +tag_value +FROM aws.amplify.branch_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the branch_tags resource, see branches + diff --git a/website/docs/services/amplify/branches/index.md b/website/docs/services/amplify/branches/index.md new file mode 100644 index 0000000..39b4822 --- /dev/null +++ b/website/docs/services/amplify/branches/index.md @@ -0,0 +1,339 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a branch resource or lists branches in a region + +## Overview + + + + + + + +
Namebranches
TypeResource
DescriptionThe AWS::Amplify::Branch resource creates a new branch within an app.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
object
string
string
string
boolean
boolean
boolean
array
string
string
string
array
stringAWS region.
+ +For more information, see AWS::Amplify::Branch. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all branches in a region. +```sql +SELECT +region, +app_id, +arn, +basic_auth_config, +backend, +branch_name, +build_spec, +description, +enable_auto_build, +enable_performance_mode, +enable_pull_request_preview, +environment_variables, +framework, +pull_request_environment_name, +stage, +tags +FROM aws.amplify.branches +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual branch. +```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.branches +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new branch resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.amplify.branches ( + AppId, + BranchName, + region +) +SELECT +'{{ AppId }}', + '{{ BranchName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.amplify.branches ( + AppId, + BasicAuthConfig, + Backend, + BranchName, + BuildSpec, + Description, + EnableAutoBuild, + EnablePerformanceMode, + EnablePullRequestPreview, + EnvironmentVariables, + Framework, + PullRequestEnvironmentName, + Stage, + Tags, + region +) +SELECT + '{{ AppId }}', + '{{ BasicAuthConfig }}', + '{{ Backend }}', + '{{ BranchName }}', + '{{ BuildSpec }}', + '{{ Description }}', + '{{ EnableAutoBuild }}', + '{{ EnablePerformanceMode }}', + '{{ EnablePullRequestPreview }}', + '{{ EnvironmentVariables }}', + '{{ Framework }}', + '{{ PullRequestEnvironmentName }}', + '{{ Stage }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: branch + props: + - name: AppId + value: '{{ AppId }}' + - name: BasicAuthConfig + value: + EnableBasicAuth: '{{ EnableBasicAuth }}' + Username: '{{ Username }}' + Password: '{{ Password }}' + - name: Backend + value: + StackArn: '{{ StackArn }}' + - name: BranchName + value: '{{ BranchName }}' + - name: BuildSpec + value: '{{ BuildSpec }}' + - name: Description + value: '{{ Description }}' + - name: EnableAutoBuild + value: '{{ EnableAutoBuild }}' + - name: EnablePerformanceMode + value: '{{ EnablePerformanceMode }}' + - name: EnablePullRequestPreview + value: '{{ EnablePullRequestPreview }}' + - name: EnvironmentVariables + value: + - Name: '{{ Name }}' + Value: '{{ Value }}' + - name: Framework + value: '{{ Framework }}' + - name: PullRequestEnvironmentName + value: '{{ PullRequestEnvironmentName }}' + - name: Stage + value: '{{ Stage }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.amplify.branches +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +amplify:GetBranch, +amplify:DeleteBranch, +codecommit:GetRepository, +codecommit:GetRepositoryTriggers, +sns:Unsubscribe, +iam:PassRole +``` + +### List +```json +amplify:GetBranch, +amplify:ListBranches, +amplify:ListTagsForResource, +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/website/docs/services/amplify/branches_list_only/index.md b/website/docs/services/amplify/branches_list_only/index.md new file mode 100644 index 0000000..a46f9b7 --- /dev/null +++ b/website/docs/services/amplify/branches_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: branches_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - branches_list_only + - amplify + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists branches in a region or regions, for all properties use branches + +## Overview + + + + + + + +
Namebranches_list_only
TypeResource
DescriptionThe AWS::Amplify::Branch resource creates a new branch within an app.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all branches in a region. +```sql +SELECT +region, +arn +FROM aws.amplify.branches_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the branches_list_only resource, see branches + diff --git a/website/docs/services/amplify/domains/index.md b/website/docs/services/amplify/domains/index.md new file mode 100644 index 0000000..1ec3ce4 --- /dev/null +++ b/website/docs/services/amplify/domains/index.md @@ -0,0 +1,280 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain resource or lists domains in a region + +## Overview + + + + + + + +
Namedomains
TypeResource
DescriptionThe AWS::Amplify::Domain resource allows you to connect a custom domain to your app.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
object
object
string
string
string
boolean
string
array
stringAWS region.
+ +For more information, see AWS::Amplify::Domain. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domains in a region. +```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.domains +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain. +```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.domains +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.amplify.domains ( + AppId, + DomainName, + SubDomainSettings, + region +) +SELECT +'{{ AppId }}', + '{{ DomainName }}', + '{{ SubDomainSettings }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.amplify.domains ( + AppId, + AutoSubDomainCreationPatterns, + AutoSubDomainIAMRole, + CertificateSettings, + DomainName, + EnableAutoSubDomain, + SubDomainSettings, + region +) +SELECT + '{{ AppId }}', + '{{ AutoSubDomainCreationPatterns }}', + '{{ AutoSubDomainIAMRole }}', + '{{ CertificateSettings }}', + '{{ DomainName }}', + '{{ EnableAutoSubDomain }}', + '{{ SubDomainSettings }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain + props: + - name: AppId + value: '{{ AppId }}' + - name: AutoSubDomainCreationPatterns + value: + - '{{ AutoSubDomainCreationPatterns[0] }}' + - name: AutoSubDomainIAMRole + value: '{{ AutoSubDomainIAMRole }}' + - name: CertificateSettings + value: + CertificateType: '{{ CertificateType }}' + CustomCertificateArn: '{{ CustomCertificateArn }}' + - name: DomainName + value: '{{ DomainName }}' + - name: EnableAutoSubDomain + value: '{{ EnableAutoSubDomain }}' + - name: SubDomainSettings + value: + - Prefix: '{{ Prefix }}' + BranchName: '{{ BranchName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.amplify.domains +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +amplify:DeleteDomainAssociation, +iam:PassRole, +amplify:DeleteDomainAssociation +``` + +### List +```json +amplify:ListDomainAssociations, +iam:PassRole, +amplify:ListTagsForResource +``` + +### 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/website/docs/services/amplify/domains_list_only/index.md b/website/docs/services/amplify/domains_list_only/index.md new file mode 100644 index 0000000..d2e02c1 --- /dev/null +++ b/website/docs/services/amplify/domains_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domains_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domains in a region or regions, for all properties use domains + +## Overview + + + + + + + +
Namedomains_list_only
TypeResource
DescriptionThe AWS::Amplify::Domain resource allows you to connect a custom domain to your app.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domains in a region. +```sql +SELECT +region, +arn +FROM aws.amplify.domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domains_list_only resource, see domains + diff --git a/website/docs/services/amplify/index.md b/website/docs/services/amplify/index.md new file mode 100644 index 0000000..fb485d2 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The amplify service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/amplifyuibuilder/component_tags/index.md b/website/docs/services/amplifyuibuilder/component_tags/index.md new file mode 100644 index 0000000..6ca2b80 --- /dev/null +++ b/website/docs/services/amplifyuibuilder/component_tags/index.md @@ -0,0 +1,107 @@ +--- +title: component_tags +hide_title: false +hide_table_of_contents: false +keywords: + - component_tags + - amplifyuibuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for components in a region + +## Overview + + + + + + + +
Namecomponent_tags
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Component Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
array
object
string
string
string
object
string
string
string
object
object
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all components in a region. +```sql +SELECT +region, +app_id, +binding_properties, +children, +collection_properties, +component_type, +created_at, +environment_name, +events, +id, +modified_at, +name, +overrides, +properties, +schema_version, +source_id, +variants, +tag_key, +tag_value +FROM aws.amplifyuibuilder.component_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_tags resource, see components + diff --git a/website/docs/services/amplifyuibuilder/components/index.md b/website/docs/services/amplifyuibuilder/components/index.md new file mode 100644 index 0000000..ffcaf82 --- /dev/null +++ b/website/docs/services/amplifyuibuilder/components/index.md @@ -0,0 +1,341 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a component resource or lists components in a region + +## Overview + + + + + + + +
Namecomponents
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Component Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
array
object
string
string
string
object
string
string
string
object
object
string
string
object
array
stringAWS region.
+ +For more information, see AWS::AmplifyUIBuilder::Component. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all components in a region. +```sql +SELECT +region, +app_id, +binding_properties, +children, +collection_properties, +component_type, +created_at, +environment_name, +events, +id, +modified_at, +name, +overrides, +properties, +schema_version, +source_id, +tags, +variants +FROM aws.amplifyuibuilder.components +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual component. +```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.components +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new component resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.amplifyuibuilder.components ( + AppId, + BindingProperties, + Children, + CollectionProperties, + ComponentType, + EnvironmentName, + Events, + Name, + Overrides, + Properties, + SchemaVersion, + SourceId, + Tags, + Variants, + region +) +SELECT +'{{ AppId }}', + '{{ BindingProperties }}', + '{{ Children }}', + '{{ CollectionProperties }}', + '{{ ComponentType }}', + '{{ EnvironmentName }}', + '{{ Events }}', + '{{ Name }}', + '{{ Overrides }}', + '{{ Properties }}', + '{{ SchemaVersion }}', + '{{ SourceId }}', + '{{ Tags }}', + '{{ Variants }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.amplifyuibuilder.components ( + AppId, + BindingProperties, + Children, + CollectionProperties, + ComponentType, + EnvironmentName, + Events, + Name, + Overrides, + Properties, + SchemaVersion, + SourceId, + Tags, + Variants, + region +) +SELECT + '{{ AppId }}', + '{{ BindingProperties }}', + '{{ Children }}', + '{{ CollectionProperties }}', + '{{ ComponentType }}', + '{{ EnvironmentName }}', + '{{ Events }}', + '{{ Name }}', + '{{ Overrides }}', + '{{ Properties }}', + '{{ SchemaVersion }}', + '{{ SourceId }}', + '{{ Tags }}', + '{{ Variants }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: component + props: + - name: AppId + value: '{{ AppId }}' + - name: BindingProperties + value: {} + - name: Children + value: + - ComponentType: '{{ ComponentType }}' + Name: '{{ Name }}' + Properties: {} + Children: + - null + Events: {} + SourceId: '{{ SourceId }}' + - name: CollectionProperties + value: {} + - name: ComponentType + value: '{{ ComponentType }}' + - name: EnvironmentName + value: '{{ EnvironmentName }}' + - name: Events + value: null + - name: Name + value: '{{ Name }}' + - name: Overrides + value: {} + - name: Properties + value: null + - name: SchemaVersion + value: '{{ SchemaVersion }}' + - name: SourceId + value: '{{ SourceId }}' + - name: Tags + value: {} + - name: Variants + value: + - VariantValues: {} + Overrides: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.amplifyuibuilder.components +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +amplify:GetApp, +amplifyuibuilder:ListComponents +``` diff --git a/website/docs/services/amplifyuibuilder/components_list_only/index.md b/website/docs/services/amplifyuibuilder/components_list_only/index.md new file mode 100644 index 0000000..9638b46 --- /dev/null +++ b/website/docs/services/amplifyuibuilder/components_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: components_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - components_list_only + - amplifyuibuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists components in a region or regions, for all properties use components + +## Overview + + + + + + + +
Namecomponents_list_only
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Component Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all components in a region. +```sql +SELECT +region, +app_id, +environment_name, +id +FROM aws.amplifyuibuilder.components_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the components_list_only resource, see components + diff --git a/website/docs/services/amplifyuibuilder/form_tags/index.md b/website/docs/services/amplifyuibuilder/form_tags/index.md new file mode 100644 index 0000000..4a8c14b --- /dev/null +++ b/website/docs/services/amplifyuibuilder/form_tags/index.md @@ -0,0 +1,99 @@ +--- +title: form_tags +hide_title: false +hide_table_of_contents: false +keywords: + - form_tags + - amplifyuibuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for forms in a region + +## Overview + + + + + + + +
Nameform_tags
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Form Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
string
object
string
string
string
string
string
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all forms in a region. +```sql +SELECT +region, +app_id, +cta, +data_type, +environment_name, +fields, +form_action_type, +id, +label_decorator, +name, +schema_version, +sectional_elements, +style, +tag_key, +tag_value +FROM aws.amplifyuibuilder.form_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the form_tags resource, see forms + diff --git a/website/docs/services/amplifyuibuilder/forms/index.md b/website/docs/services/amplifyuibuilder/forms/index.md new file mode 100644 index 0000000..992e603 --- /dev/null +++ b/website/docs/services/amplifyuibuilder/forms/index.md @@ -0,0 +1,319 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a form resource or lists forms in a region + +## Overview + + + + + + + +
Nameforms
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Form Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
string
object
string
string
string
string
string
object
object
object
stringAWS region.
+ +For more information, see AWS::AmplifyUIBuilder::Form. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all forms in a region. +```sql +SELECT +region, +app_id, +cta, +data_type, +environment_name, +fields, +form_action_type, +id, +label_decorator, +name, +schema_version, +sectional_elements, +style, +tags +FROM aws.amplifyuibuilder.forms +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual form. +```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.forms +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new form resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.amplifyuibuilder.forms ( + AppId, + Cta, + DataType, + EnvironmentName, + Fields, + FormActionType, + LabelDecorator, + Name, + SchemaVersion, + SectionalElements, + Style, + Tags, + region +) +SELECT +'{{ AppId }}', + '{{ Cta }}', + '{{ DataType }}', + '{{ EnvironmentName }}', + '{{ Fields }}', + '{{ FormActionType }}', + '{{ LabelDecorator }}', + '{{ Name }}', + '{{ SchemaVersion }}', + '{{ SectionalElements }}', + '{{ Style }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.amplifyuibuilder.forms ( + AppId, + Cta, + DataType, + EnvironmentName, + Fields, + FormActionType, + LabelDecorator, + Name, + SchemaVersion, + SectionalElements, + Style, + Tags, + region +) +SELECT + '{{ AppId }}', + '{{ Cta }}', + '{{ DataType }}', + '{{ EnvironmentName }}', + '{{ Fields }}', + '{{ FormActionType }}', + '{{ LabelDecorator }}', + '{{ Name }}', + '{{ SchemaVersion }}', + '{{ SectionalElements }}', + '{{ Style }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: form + props: + - name: AppId + value: '{{ AppId }}' + - name: Cta + value: + Position: '{{ Position }}' + Clear: + Excluded: '{{ Excluded }}' + Children: '{{ Children }}' + Position: null + Cancel: null + Submit: null + - name: DataType + value: + DataSourceType: '{{ DataSourceType }}' + DataTypeName: '{{ DataTypeName }}' + - name: EnvironmentName + value: '{{ EnvironmentName }}' + - name: Fields + value: {} + - name: FormActionType + value: '{{ FormActionType }}' + - name: LabelDecorator + value: '{{ LabelDecorator }}' + - name: Name + value: '{{ Name }}' + - name: SchemaVersion + value: '{{ SchemaVersion }}' + - name: SectionalElements + value: {} + - name: Style + value: + HorizontalGap: null + VerticalGap: null + OuterPadding: null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.amplifyuibuilder.forms +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +amplify:GetApp, +amplifyuibuilder:GetForm +``` + +### Update +```json +amplify:GetApp, +amplifyuibuilder:GetForm, +amplifyuibuilder:TagResource, +amplifyuibuilder:UntagResource, +amplifyuibuilder:UpdateForm +``` + +### Delete +```json +amplify:GetApp, +amplifyuibuilder:DeleteForm, +amplifyuibuilder:UntagResource +``` + +### List +```json +amplify:GetApp, +amplifyuibuilder:ListForms +``` diff --git a/website/docs/services/amplifyuibuilder/forms_list_only/index.md b/website/docs/services/amplifyuibuilder/forms_list_only/index.md new file mode 100644 index 0000000..20363c0 --- /dev/null +++ b/website/docs/services/amplifyuibuilder/forms_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: forms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - forms_list_only + - amplifyuibuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists forms in a region or regions, for all properties use forms + +## Overview + + + + + + + +
Nameforms_list_only
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Form Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all forms in a region. +```sql +SELECT +region, +app_id, +environment_name, +id +FROM aws.amplifyuibuilder.forms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the forms_list_only resource, see forms + diff --git a/website/docs/services/amplifyuibuilder/index.md b/website/docs/services/amplifyuibuilder/index.md new file mode 100644 index 0000000..1c8146d --- /dev/null +++ b/website/docs/services/amplifyuibuilder/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The amplifyuibuilder service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/amplifyuibuilder/theme_tags/index.md b/website/docs/services/amplifyuibuilder/theme_tags/index.md new file mode 100644 index 0000000..9e91492 --- /dev/null +++ b/website/docs/services/amplifyuibuilder/theme_tags/index.md @@ -0,0 +1,91 @@ +--- +title: theme_tags +hide_title: false +hide_table_of_contents: false +keywords: + - theme_tags + - amplifyuibuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for themes in a region + +## Overview + + + + + + + +
Nametheme_tags
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Theme Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all themes in a region. +```sql +SELECT +region, +app_id, +created_at, +environment_name, +id, +modified_at, +name, +overrides, +values, +tag_key, +tag_value +FROM aws.amplifyuibuilder.theme_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the theme_tags resource, see themes + diff --git a/website/docs/services/amplifyuibuilder/themes/index.md b/website/docs/services/amplifyuibuilder/themes/index.md new file mode 100644 index 0000000..ba4c67b --- /dev/null +++ b/website/docs/services/amplifyuibuilder/themes/index.md @@ -0,0 +1,265 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a theme resource or lists themes in a region + +## Overview + + + + + + + +
Namethemes
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Theme Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
object
array
stringAWS region.
+ +For more information, see AWS::AmplifyUIBuilder::Theme. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all themes in a region. +```sql +SELECT +region, +app_id, +created_at, +environment_name, +id, +modified_at, +name, +overrides, +tags, +values +FROM aws.amplifyuibuilder.themes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual theme. +```sql +SELECT +region, +app_id, +created_at, +environment_name, +id, +modified_at, +name, +overrides, +tags, +values +FROM aws.amplifyuibuilder.themes +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new theme resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.amplifyuibuilder.themes ( + AppId, + EnvironmentName, + Name, + Overrides, + Tags, + Values, + region +) +SELECT +'{{ AppId }}', + '{{ EnvironmentName }}', + '{{ Name }}', + '{{ Overrides }}', + '{{ Tags }}', + '{{ Values }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.amplifyuibuilder.themes ( + AppId, + EnvironmentName, + Name, + Overrides, + Tags, + Values, + region +) +SELECT + '{{ AppId }}', + '{{ EnvironmentName }}', + '{{ Name }}', + '{{ Overrides }}', + '{{ Tags }}', + '{{ Values }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: theme + props: + - name: AppId + value: '{{ AppId }}' + - name: EnvironmentName + value: '{{ EnvironmentName }}' + - name: Name + value: '{{ Name }}' + - name: Overrides + value: + - Key: '{{ Key }}' + Value: + Value: '{{ Value }}' + Children: + - null + - name: Tags + value: {} + - name: Values + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.amplifyuibuilder.themes +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +amplify:GetApp, +amplifyuibuilder:ListThemes +``` diff --git a/website/docs/services/amplifyuibuilder/themes_list_only/index.md b/website/docs/services/amplifyuibuilder/themes_list_only/index.md new file mode 100644 index 0000000..34fd2b7 --- /dev/null +++ b/website/docs/services/amplifyuibuilder/themes_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: themes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - themes_list_only + - amplifyuibuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists themes in a region or regions, for all properties use themes + +## Overview + + + + + + + +
Namethemes_list_only
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Theme Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all themes in a region. +```sql +SELECT +region, +app_id, +environment_name, +id +FROM aws.amplifyuibuilder.themes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the themes_list_only resource, see themes + diff --git a/website/docs/services/apigateway/accounts/index.md b/website/docs/services/apigateway/accounts/index.md new file mode 100644 index 0000000..e54dd65 --- /dev/null +++ b/website/docs/services/apigateway/accounts/index.md @@ -0,0 +1,183 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an account resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::Account. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual account. +```sql +SELECT +region, +id, +cloud_watch_role_arn +FROM aws.apigateway.accounts +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new account resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.accounts ( + CloudWatchRoleArn, + region +) +SELECT +'{{ CloudWatchRoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.accounts ( + CloudWatchRoleArn, + region +) +SELECT + '{{ CloudWatchRoleArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: account + props: + - name: CloudWatchRoleArn + value: '{{ CloudWatchRoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.accounts +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the accounts resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Create +```json +apigateway:PATCH, +iam:GetRole, +iam:PassRole +``` + +### Update +```json +apigateway:PATCH, +iam:GetRole, +iam:PassRole +``` + +### Delete +```json +apigateway:PATCH +``` diff --git a/website/docs/services/apigateway/api_key_tags/index.md b/website/docs/services/apigateway/api_key_tags/index.md new file mode 100644 index 0000000..304ffcb --- /dev/null +++ b/website/docs/services/apigateway/api_key_tags/index.md @@ -0,0 +1,91 @@ +--- +title: api_key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - api_key_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for api_keys in a region + +## Overview + + + + + + + +
Nameapi_key_tags
TypeResource
DescriptionThe AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
stringA name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all api_keys in a region. +```sql +SELECT +region, +api_key_id, +customer_id, +description, +enabled, +generate_distinct_id, +name, +stage_keys, +value, +tag_key, +tag_value +FROM aws.apigateway.api_key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_key_tags resource, see api_keys + diff --git a/website/docs/services/apigateway/api_keys/index.md b/website/docs/services/apigateway/api_keys/index.md new file mode 100644 index 0000000..f75f64b --- /dev/null +++ b/website/docs/services/apigateway/api_keys/index.md @@ -0,0 +1,270 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an api_key resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
stringA name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
array
array
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::ApiKey. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all api_keys in a region. +```sql +SELECT +region, +api_key_id, +customer_id, +description, +enabled, +generate_distinct_id, +name, +stage_keys, +tags, +value +FROM aws.apigateway.api_keys +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual api_key. +```sql +SELECT +region, +api_key_id, +customer_id, +description, +enabled, +generate_distinct_id, +name, +stage_keys, +tags, +value +FROM aws.apigateway.api_keys +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new api_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.api_keys ( + CustomerId, + Description, + Enabled, + GenerateDistinctId, + Name, + StageKeys, + Tags, + Value, + region +) +SELECT +'{{ CustomerId }}', + '{{ Description }}', + '{{ Enabled }}', + '{{ GenerateDistinctId }}', + '{{ Name }}', + '{{ StageKeys }}', + '{{ Tags }}', + '{{ Value }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.api_keys ( + CustomerId, + Description, + Enabled, + GenerateDistinctId, + Name, + StageKeys, + Tags, + Value, + region +) +SELECT + '{{ CustomerId }}', + '{{ Description }}', + '{{ Enabled }}', + '{{ GenerateDistinctId }}', + '{{ Name }}', + '{{ StageKeys }}', + '{{ Tags }}', + '{{ Value }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: api_key + props: + - name: CustomerId + value: '{{ CustomerId }}' + - name: Description + value: '{{ Description }}' + - name: Enabled + value: '{{ Enabled }}' + - name: GenerateDistinctId + value: '{{ GenerateDistinctId }}' + - name: Name + value: '{{ Name }}' + - name: StageKeys + value: + - RestApiId: '{{ RestApiId }}' + StageName: '{{ StageName }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Value + value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.api_keys +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH, +apigateway:PUT, +apigateway:DELETE +``` + +### Delete +```json +apigateway:DELETE, +apigateway:GET +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/api_keys_list_only/index.md b/website/docs/services/apigateway/api_keys_list_only/index.md new file mode 100644 index 0000000..b034d23 --- /dev/null +++ b/website/docs/services/apigateway/api_keys_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: api_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - api_keys_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists api_keys in a region or regions, for all properties use api_keys + +## Overview + + + + + + + +
Nameapi_keys_list_only
TypeResource
DescriptionThe AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all api_keys in a region. +```sql +SELECT +region, +api_key_id +FROM aws.apigateway.api_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_keys_list_only resource, see api_keys + diff --git a/website/docs/services/apigateway/authorizers/index.md b/website/docs/services/apigateway/authorizers/index.md new file mode 100644 index 0000000..9c04dd3 --- /dev/null +++ b/website/docs/services/apigateway/authorizers/index.md @@ -0,0 +1,268 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an authorizer resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
integer
string
string
string
string
array
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::Authorizer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all authorizers in a region. +```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.authorizers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual authorizer. +```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.authorizers +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new authorizer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.authorizers ( + RestApiId, + Name, + Type, + region +) +SELECT +'{{ RestApiId }}', + '{{ Name }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.authorizers ( + RestApiId, + AuthType, + AuthorizerCredentials, + AuthorizerResultTtlInSeconds, + AuthorizerUri, + IdentitySource, + IdentityValidationExpression, + Name, + ProviderARNs, + Type, + region +) +SELECT + '{{ RestApiId }}', + '{{ AuthType }}', + '{{ AuthorizerCredentials }}', + '{{ AuthorizerResultTtlInSeconds }}', + '{{ AuthorizerUri }}', + '{{ IdentitySource }}', + '{{ IdentityValidationExpression }}', + '{{ Name }}', + '{{ ProviderARNs }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: authorizer + props: + - name: RestApiId + value: '{{ RestApiId }}' + - name: AuthType + value: '{{ AuthType }}' + - name: AuthorizerCredentials + value: '{{ AuthorizerCredentials }}' + - name: AuthorizerResultTtlInSeconds + value: '{{ AuthorizerResultTtlInSeconds }}' + - name: AuthorizerUri + value: '{{ AuthorizerUri }}' + - name: IdentitySource + value: '{{ IdentitySource }}' + - name: IdentityValidationExpression + value: '{{ IdentityValidationExpression }}' + - name: Name + value: '{{ Name }}' + - name: ProviderARNs + value: + - '{{ ProviderARNs[0] }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.authorizers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the authorizers resource, the following permissions are required: + +### Create +```json +apigateway:POST, +iam:PassRole +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH, +iam:PassRole +``` + +### Delete +```json +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/authorizers_list_only/index.md b/website/docs/services/apigateway/authorizers_list_only/index.md new file mode 100644 index 0000000..75498b8 --- /dev/null +++ b/website/docs/services/apigateway/authorizers_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: authorizers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - authorizers_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists authorizers in a region or regions, for all properties use authorizers + +## Overview + + + + + + + +
Nameauthorizers_list_only
TypeResource
DescriptionThe AWS::ApiGateway::Authorizer resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all authorizers in a region. +```sql +SELECT +region, +rest_api_id, +authorizer_id +FROM aws.apigateway.authorizers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the authorizers_list_only resource, see authorizers + diff --git a/website/docs/services/apigateway/base_path_mapping_v2s/index.md b/website/docs/services/apigateway/base_path_mapping_v2s/index.md new file mode 100644 index 0000000..a1c1ae7 --- /dev/null +++ b/website/docs/services/apigateway/base_path_mapping_v2s/index.md @@ -0,0 +1,223 @@ +--- +title: base_path_mapping_v2s +hide_title: false +hide_table_of_contents: false +keywords: + - base_path_mapping_v2s + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a base_path_mapping_v2 resource or lists base_path_mapping_v2s in a region + +## Overview + + + + + + + +
Namebase_path_mapping_v2s
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::BasePathMappingV2
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe base path name that callers of the API must provide in the URL after the domain name.
stringThe Arn of an AWS::ApiGateway::DomainNameV2 resource.
stringThe ID of the API.
stringThe name of the API's stage.
stringAmazon Resource Name (ARN) of the resource.
stringAWS region.
+ +For more information, see AWS::ApiGateway::BasePathMappingV2. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all base_path_mapping_v2s in a region. +```sql +SELECT +region, +base_path, +domain_name_arn, +rest_api_id, +stage, +base_path_mapping_arn +FROM aws.apigateway.base_path_mapping_v2s +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual base_path_mapping_v2. +```sql +SELECT +region, +base_path, +domain_name_arn, +rest_api_id, +stage, +base_path_mapping_arn +FROM aws.apigateway.base_path_mapping_v2s +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new base_path_mapping_v2 resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.base_path_mapping_v2s ( + DomainNameArn, + RestApiId, + region +) +SELECT +'{{ DomainNameArn }}', + '{{ RestApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.base_path_mapping_v2s ( + BasePath, + DomainNameArn, + RestApiId, + Stage, + region +) +SELECT + '{{ BasePath }}', + '{{ DomainNameArn }}', + '{{ RestApiId }}', + '{{ Stage }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: base_path_mapping_v2 + props: + - name: BasePath + value: '{{ BasePath }}' + - name: DomainNameArn + value: '{{ DomainNameArn }}' + - name: RestApiId + value: '{{ RestApiId }}' + - name: Stage + value: '{{ Stage }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.base_path_mapping_v2s +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the base_path_mapping_v2s resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:DELETE, +apigateway:PATCH +``` + +### Delete +```json +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/base_path_mapping_v2s_list_only/index.md b/website/docs/services/apigateway/base_path_mapping_v2s_list_only/index.md new file mode 100644 index 0000000..4b5cae9 --- /dev/null +++ b/website/docs/services/apigateway/base_path_mapping_v2s_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: base_path_mapping_v2s_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - base_path_mapping_v2s_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists base_path_mapping_v2s in a region or regions, for all properties use base_path_mapping_v2s + +## Overview + + + + + + + +
Namebase_path_mapping_v2s_list_only
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::BasePathMappingV2
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe base path name that callers of the API must provide in the URL after the domain name.
stringAmazon Resource Name (ARN) of the resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all base_path_mapping_v2s in a region. +```sql +SELECT +region, +base_path_mapping_arn +FROM aws.apigateway.base_path_mapping_v2s_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the base_path_mapping_v2s_list_only resource, see base_path_mapping_v2s + diff --git a/website/docs/services/apigateway/base_path_mappings/index.md b/website/docs/services/apigateway/base_path_mappings/index.md new file mode 100644 index 0000000..679ff4f --- /dev/null +++ b/website/docs/services/apigateway/base_path_mappings/index.md @@ -0,0 +1,218 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a base_path_mapping resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::BasePathMapping. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all base_path_mappings in a region. +```sql +SELECT +region, +base_path, +domain_name, +rest_api_id, +stage +FROM aws.apigateway.base_path_mappings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual base_path_mapping. +```sql +SELECT +region, +base_path, +domain_name, +rest_api_id, +stage +FROM aws.apigateway.base_path_mappings +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new base_path_mapping resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.base_path_mappings ( + DomainName, + region +) +SELECT +'{{ DomainName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.base_path_mappings ( + BasePath, + DomainName, + RestApiId, + Stage, + region +) +SELECT + '{{ BasePath }}', + '{{ DomainName }}', + '{{ RestApiId }}', + '{{ Stage }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: base_path_mapping + props: + - name: BasePath + value: '{{ BasePath }}' + - name: DomainName + value: '{{ DomainName }}' + - name: RestApiId + value: '{{ RestApiId }}' + - name: Stage + value: '{{ Stage }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.base_path_mappings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the base_path_mappings resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:DELETE, +apigateway:PATCH +``` + +### Delete +```json +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/base_path_mappings_list_only/index.md b/website/docs/services/apigateway/base_path_mappings_list_only/index.md new file mode 100644 index 0000000..9475cc0 --- /dev/null +++ b/website/docs/services/apigateway/base_path_mappings_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: base_path_mappings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - base_path_mappings_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists base_path_mappings in a region or regions, for all properties use base_path_mappings + +## Overview + + + + + + + +
Namebase_path_mappings_list_only
TypeResource
DescriptionThe AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all base_path_mappings in a region. +```sql +SELECT +region, +domain_name, +base_path +FROM aws.apigateway.base_path_mappings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the base_path_mappings_list_only resource, see base_path_mappings + diff --git a/website/docs/services/apigateway/client_certificate_tags/index.md b/website/docs/services/apigateway/client_certificate_tags/index.md new file mode 100644 index 0000000..57e6a66 --- /dev/null +++ b/website/docs/services/apigateway/client_certificate_tags/index.md @@ -0,0 +1,79 @@ +--- +title: client_certificate_tags +hide_title: false +hide_table_of_contents: false +keywords: + - client_certificate_tags + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for client_certificates in a region + +## Overview + + + + + + + +
Nameclient_certificate_tags
TypeResource
DescriptionThe AWS::ApiGateway::ClientCertificate resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all client_certificates in a region. +```sql +SELECT +region, +client_certificate_id, +description, +tag_key, +tag_value +FROM aws.apigateway.client_certificate_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the client_certificate_tags resource, see client_certificates + diff --git a/website/docs/services/apigateway/client_certificates/index.md b/website/docs/services/apigateway/client_certificates/index.md new file mode 100644 index 0000000..606845e --- /dev/null +++ b/website/docs/services/apigateway/client_certificates/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a client_certificate resource or lists 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.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
array
stringAWS region.
+ +For more information, see AWS::ApiGateway::ClientCertificate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all client_certificates in a region. +```sql +SELECT +region, +client_certificate_id, +description, +tags +FROM aws.apigateway.client_certificates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual client_certificate. +```sql +SELECT +region, +client_certificate_id, +description, +tags +FROM aws.apigateway.client_certificates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new client_certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.client_certificates ( + Description, + Tags, + region +) +SELECT +'{{ Description }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.client_certificates ( + Description, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: client_certificate + props: + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.client_certificates +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH, +apigateway:PUT, +apigateway:DELETE +``` + +### Delete +```json +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/client_certificates_list_only/index.md b/website/docs/services/apigateway/client_certificates_list_only/index.md new file mode 100644 index 0000000..8fb3d15 --- /dev/null +++ b/website/docs/services/apigateway/client_certificates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: client_certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - client_certificates_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists client_certificates in a region or regions, for all properties use client_certificates + +## Overview + + + + + + + +
Nameclient_certificates_list_only
TypeResource
DescriptionThe AWS::ApiGateway::ClientCertificate resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all client_certificates in a region. +```sql +SELECT +region, +client_certificate_id +FROM aws.apigateway.client_certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the client_certificates_list_only resource, see client_certificates + diff --git a/website/docs/services/apigateway/deployments/index.md b/website/docs/services/apigateway/deployments/index.md new file mode 100644 index 0000000..6f88ab6 --- /dev/null +++ b/website/docs/services/apigateway/deployments/index.md @@ -0,0 +1,272 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a deployment resource or lists 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.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
objectThe description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
string
string
objectThe DeploymentCanarySettings property type specifies settings for the canary deployment.
stringAWS region.
+ +For more information, see AWS::ApiGateway::Deployment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all deployments in a region. +```sql +SELECT +region, +deployment_id, +description, +stage_description, +stage_name, +rest_api_id, +deployment_canary_settings +FROM aws.apigateway.deployments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual deployment. +```sql +SELECT +region, +deployment_id, +description, +stage_description, +stage_name, +rest_api_id, +deployment_canary_settings +FROM aws.apigateway.deployments +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new deployment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.deployments ( + RestApiId, + region +) +SELECT +'{{ RestApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.deployments ( + Description, + StageDescription, + StageName, + RestApiId, + DeploymentCanarySettings, + region +) +SELECT + '{{ Description }}', + '{{ StageDescription }}', + '{{ StageName }}', + '{{ RestApiId }}', + '{{ DeploymentCanarySettings }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: deployment + props: + - name: Description + value: '{{ Description }}' + - name: StageDescription + value: + CacheTtlInSeconds: '{{ CacheTtlInSeconds }}' + Description: '{{ Description }}' + LoggingLevel: '{{ LoggingLevel }}' + CanarySetting: + DeploymentId: '{{ DeploymentId }}' + PercentTraffic: null + StageVariableOverrides: {} + UseStageCache: '{{ UseStageCache }}' + ThrottlingRateLimit: null + ClientCertificateId: '{{ ClientCertificateId }}' + Variables: {} + DocumentationVersion: '{{ DocumentationVersion }}' + CacheDataEncrypted: '{{ CacheDataEncrypted }}' + DataTraceEnabled: '{{ DataTraceEnabled }}' + ThrottlingBurstLimit: '{{ ThrottlingBurstLimit }}' + CachingEnabled: '{{ CachingEnabled }}' + TracingEnabled: '{{ TracingEnabled }}' + MethodSettings: + - CacheDataEncrypted: '{{ CacheDataEncrypted }}' + CacheTtlInSeconds: '{{ CacheTtlInSeconds }}' + CachingEnabled: '{{ CachingEnabled }}' + DataTraceEnabled: '{{ DataTraceEnabled }}' + HttpMethod: '{{ HttpMethod }}' + LoggingLevel: '{{ LoggingLevel }}' + MetricsEnabled: '{{ MetricsEnabled }}' + ResourcePath: '{{ ResourcePath }}' + ThrottlingBurstLimit: '{{ ThrottlingBurstLimit }}' + ThrottlingRateLimit: null + AccessLogSetting: + DestinationArn: '{{ DestinationArn }}' + Format: '{{ Format }}' + CacheClusterSize: '{{ CacheClusterSize }}' + MetricsEnabled: '{{ MetricsEnabled }}' + Tags: + - Value: '{{ Value }}' + Key: '{{ Key }}' + CacheClusterEnabled: '{{ CacheClusterEnabled }}' + - name: StageName + value: '{{ StageName }}' + - name: RestApiId + value: '{{ RestApiId }}' + - name: DeploymentCanarySettings + value: + StageVariableOverrides: {} + PercentTraffic: null + UseStageCache: '{{ UseStageCache }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.deployments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Create +```json +apigateway:POST, +apigateway:PATCH, +apigateway:PUT, +apigateway:GET +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` diff --git a/website/docs/services/apigateway/deployments_list_only/index.md b/website/docs/services/apigateway/deployments_list_only/index.md new file mode 100644 index 0000000..aa658b4 --- /dev/null +++ b/website/docs/services/apigateway/deployments_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: deployments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployments in a region or regions, for all properties use deployments + +## Overview + + + + + + + +
Namedeployments_list_only
TypeResource
DescriptionThe AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet. The stage acts as an environment.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployments in a region. +```sql +SELECT +region, +deployment_id, +rest_api_id +FROM aws.apigateway.deployments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployments_list_only resource, see deployments + diff --git a/website/docs/services/apigateway/documentation_parts/index.md b/website/docs/services/apigateway/documentation_parts/index.md new file mode 100644 index 0000000..6952a57 --- /dev/null +++ b/website/docs/services/apigateway/documentation_parts/index.md @@ -0,0 +1,222 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a documentation_part resource or lists 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*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
objectThe Location property specifies the location of the Amazon API Gateway API entity that the documentation applies to. Location is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.
For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.
string
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::DocumentationPart. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all documentation_parts in a region. +```sql +SELECT +region, +documentation_part_id, +location, +properties, +rest_api_id +FROM aws.apigateway.documentation_parts +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual documentation_part. +```sql +SELECT +region, +documentation_part_id, +location, +properties, +rest_api_id +FROM aws.apigateway.documentation_parts +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new documentation_part resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.documentation_parts ( + Location, + Properties, + RestApiId, + region +) +SELECT +'{{ Location }}', + '{{ Properties }}', + '{{ RestApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.documentation_parts ( + Location, + Properties, + RestApiId, + region +) +SELECT + '{{ Location }}', + '{{ Properties }}', + '{{ RestApiId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: documentation_part + props: + - name: Location + value: + Method: '{{ Method }}' + Name: '{{ Name }}' + Path: '{{ Path }}' + StatusCode: '{{ StatusCode }}' + Type: '{{ Type }}' + - name: Properties + value: '{{ Properties }}' + - name: RestApiId + value: '{{ RestApiId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.documentation_parts +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the documentation_parts resource, the following permissions are required: + +### Create +```json +apigateway:GET, +apigateway:POST +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH +``` + +### Delete +```json +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/documentation_parts_list_only/index.md b/website/docs/services/apigateway/documentation_parts_list_only/index.md new file mode 100644 index 0000000..44efd69 --- /dev/null +++ b/website/docs/services/apigateway/documentation_parts_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: documentation_parts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - documentation_parts_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists documentation_parts in a region or regions, for all properties use documentation_parts + +## Overview + + + + + + + +
Namedocumentation_parts_list_only
TypeResource
DescriptionThe AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all documentation_parts in a region. +```sql +SELECT +region, +documentation_part_id, +rest_api_id +FROM aws.apigateway.documentation_parts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the documentation_parts_list_only resource, see documentation_parts + diff --git a/website/docs/services/apigateway/documentation_versions/index.md b/website/docs/services/apigateway/documentation_versions/index.md new file mode 100644 index 0000000..67d8f39 --- /dev/null +++ b/website/docs/services/apigateway/documentation_versions/index.md @@ -0,0 +1,212 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a documentation_version resource or lists 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*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::DocumentationVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all documentation_versions in a region. +```sql +SELECT +region, +description, +documentation_version, +rest_api_id +FROM aws.apigateway.documentation_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual documentation_version. +```sql +SELECT +region, +description, +documentation_version, +rest_api_id +FROM aws.apigateway.documentation_versions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new documentation_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.documentation_versions ( + DocumentationVersion, + RestApiId, + region +) +SELECT +'{{ DocumentationVersion }}', + '{{ RestApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.documentation_versions ( + Description, + DocumentationVersion, + RestApiId, + region +) +SELECT + '{{ Description }}', + '{{ DocumentationVersion }}', + '{{ RestApiId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: documentation_version + props: + - name: Description + value: '{{ Description }}' + - name: DocumentationVersion + value: '{{ DocumentationVersion }}' + - name: RestApiId + value: '{{ RestApiId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.documentation_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the documentation_versions resource, the following permissions are required: + +### Create +```json +apigateway:GET, +apigateway:POST +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH +``` + +### Delete +```json +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/documentation_versions_list_only/index.md b/website/docs/services/apigateway/documentation_versions_list_only/index.md new file mode 100644 index 0000000..dbe1a43 --- /dev/null +++ b/website/docs/services/apigateway/documentation_versions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: documentation_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - documentation_versions_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists documentation_versions in a region or regions, for all properties use documentation_versions + +## Overview + + + + + + + +
Namedocumentation_versions_list_only
TypeResource
DescriptionThe AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all documentation_versions in a region. +```sql +SELECT +region, +documentation_version, +rest_api_id +FROM aws.apigateway.documentation_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the documentation_versions_list_only resource, see documentation_versions + diff --git a/website/docs/services/apigateway/domain_name_access_association_tags/index.md b/website/docs/services/apigateway/domain_name_access_association_tags/index.md new file mode 100644 index 0000000..f9d05c9 --- /dev/null +++ b/website/docs/services/apigateway/domain_name_access_association_tags/index.md @@ -0,0 +1,83 @@ +--- +title: domain_name_access_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_access_association_tags + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domain_name_access_associations in a region + +## Overview + + + + + + + +
Namedomain_name_access_association_tags
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainNameAccessAssociation.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe amazon resource name (ARN) of the domain name access association resource.
stringThe amazon resource name (ARN) of the domain name resource.
stringThe source of the domain name access association resource.
stringThe source type of the domain name access association resource.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domain_name_access_associations in a region. +```sql +SELECT +region, +domain_name_access_association_arn, +domain_name_arn, +access_association_source, +access_association_source_type, +tag_key, +tag_value +FROM aws.apigateway.domain_name_access_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_name_access_association_tags resource, see domain_name_access_associations + diff --git a/website/docs/services/apigateway/domain_name_access_associations/index.md b/website/docs/services/apigateway/domain_name_access_associations/index.md new file mode 100644 index 0000000..7518bed --- /dev/null +++ b/website/docs/services/apigateway/domain_name_access_associations/index.md @@ -0,0 +1,216 @@ +--- +title: domain_name_access_associations +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_access_associations + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain_name_access_association resource or lists domain_name_access_associations in a region + +## Overview + + + + + + + +
Namedomain_name_access_associations
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainNameAccessAssociation.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe amazon resource name (ARN) of the domain name access association resource.
stringThe amazon resource name (ARN) of the domain name resource.
stringThe source of the domain name access association resource.
stringThe source type of the domain name access association resource.
arrayAn array of arbitrary tags (key-value pairs) to associate with the domainname access association.
stringAWS region.
+ +For more information, see AWS::ApiGateway::DomainNameAccessAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domain_name_access_associations in a region. +```sql +SELECT +region, +domain_name_access_association_arn, +domain_name_arn, +access_association_source, +access_association_source_type, +tags +FROM aws.apigateway.domain_name_access_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain_name_access_association. +```sql +SELECT +region, +domain_name_access_association_arn, +domain_name_arn, +access_association_source, +access_association_source_type, +tags +FROM aws.apigateway.domain_name_access_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain_name_access_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.domain_name_access_associations ( + DomainNameArn, + AccessAssociationSource, + AccessAssociationSourceType, + region +) +SELECT +'{{ DomainNameArn }}', + '{{ AccessAssociationSource }}', + '{{ AccessAssociationSourceType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.domain_name_access_associations ( + DomainNameArn, + AccessAssociationSource, + AccessAssociationSourceType, + Tags, + region +) +SELECT + '{{ DomainNameArn }}', + '{{ AccessAssociationSource }}', + '{{ AccessAssociationSourceType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain_name_access_association + props: + - name: DomainNameArn + value: '{{ DomainNameArn }}' + - name: AccessAssociationSource + value: '{{ AccessAssociationSource }}' + - name: AccessAssociationSourceType + value: '{{ AccessAssociationSourceType }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.domain_name_access_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the domain_name_access_associations resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:DELETE, +apigateway:GET +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/domain_name_access_associations_list_only/index.md b/website/docs/services/apigateway/domain_name_access_associations_list_only/index.md new file mode 100644 index 0000000..f3a446d --- /dev/null +++ b/website/docs/services/apigateway/domain_name_access_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domain_name_access_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_access_associations_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domain_name_access_associations in a region or regions, for all properties use domain_name_access_associations + +## Overview + + + + + + + +
Namedomain_name_access_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainNameAccessAssociation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe amazon resource name (ARN) of the domain name access association resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domain_name_access_associations in a region. +```sql +SELECT +region, +domain_name_access_association_arn +FROM aws.apigateway.domain_name_access_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_name_access_associations_list_only resource, see domain_name_access_associations + diff --git a/website/docs/services/apigateway/domain_name_tags/index.md b/website/docs/services/apigateway/domain_name_tags/index.md new file mode 100644 index 0000000..178e1f2 --- /dev/null +++ b/website/docs/services/apigateway/domain_name_tags/index.md @@ -0,0 +1,97 @@ +--- +title: domain_name_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_tags + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domain_names in a region + +## Overview + + + + + + + +
Namedomain_name_tags
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainName.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
objectThe EndpointConfiguration property type specifies the endpoint types of a REST API.
EndpointConfiguration is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domain_names in a region. +```sql +SELECT +region, +mutual_tls_authentication, +ownership_verification_certificate_arn, +regional_hosted_zone_id, +regional_domain_name, +domain_name, +security_policy, +distribution_hosted_zone_id, +endpoint_configuration, +distribution_domain_name, +regional_certificate_arn, +certificate_arn, +tag_key, +tag_value +FROM aws.apigateway.domain_name_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_name_tags resource, see domain_names + diff --git a/website/docs/services/apigateway/domain_name_v2_tags/index.md b/website/docs/services/apigateway/domain_name_v2_tags/index.md new file mode 100644 index 0000000..2186767 --- /dev/null +++ b/website/docs/services/apigateway/domain_name_v2_tags/index.md @@ -0,0 +1,89 @@ +--- +title: domain_name_v2_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_v2_tags + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domain_name_v2s in a region + +## Overview + + + + + + + +
Namedomain_name_v2_tags
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainNameV2.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
objectThe EndpointConfiguration property type specifies the endpoint types of a REST API.
EndpointConfiguration is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.
string
object
string
stringThe amazon resource name (ARN) of the domain name resource.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domain_name_v2s in a region. +```sql +SELECT +region, +certificate_arn, +domain_name, +endpoint_configuration, +security_policy, +policy, +domain_name_id, +domain_name_arn, +tag_key, +tag_value +FROM aws.apigateway.domain_name_v2_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_name_v2_tags resource, see domain_name_v2s + diff --git a/website/docs/services/apigateway/domain_name_v2s/index.md b/website/docs/services/apigateway/domain_name_v2s/index.md new file mode 100644 index 0000000..2bad6e2 --- /dev/null +++ b/website/docs/services/apigateway/domain_name_v2s/index.md @@ -0,0 +1,258 @@ +--- +title: domain_name_v2s +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_v2s + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain_name_v2 resource or lists domain_name_v2s in a region + +## Overview + + + + + + + +
Namedomain_name_v2s
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainNameV2.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
objectThe EndpointConfiguration property type specifies the endpoint types of a REST API.
EndpointConfiguration is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.
string
object
string
stringThe amazon resource name (ARN) of the domain name resource.
array
stringAWS region.
+ +For more information, see AWS::ApiGateway::DomainNameV2. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domain_name_v2s in a region. +```sql +SELECT +region, +certificate_arn, +domain_name, +endpoint_configuration, +security_policy, +policy, +domain_name_id, +domain_name_arn, +tags +FROM aws.apigateway.domain_name_v2s +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain_name_v2. +```sql +SELECT +region, +certificate_arn, +domain_name, +endpoint_configuration, +security_policy, +policy, +domain_name_id, +domain_name_arn, +tags +FROM aws.apigateway.domain_name_v2s +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain_name_v2 resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.domain_name_v2s ( + CertificateArn, + DomainName, + EndpointConfiguration, + SecurityPolicy, + Policy, + Tags, + region +) +SELECT +'{{ CertificateArn }}', + '{{ DomainName }}', + '{{ EndpointConfiguration }}', + '{{ SecurityPolicy }}', + '{{ Policy }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.domain_name_v2s ( + CertificateArn, + DomainName, + EndpointConfiguration, + SecurityPolicy, + Policy, + Tags, + region +) +SELECT + '{{ CertificateArn }}', + '{{ DomainName }}', + '{{ EndpointConfiguration }}', + '{{ SecurityPolicy }}', + '{{ Policy }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain_name_v2 + props: + - name: CertificateArn + value: '{{ CertificateArn }}' + - name: DomainName + value: '{{ DomainName }}' + - name: EndpointConfiguration + value: + Types: + - '{{ Types[0] }}' + VpcEndpointIds: + - '{{ VpcEndpointIds[0] }}' + - name: SecurityPolicy + value: '{{ SecurityPolicy }}' + - name: Policy + value: {} + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.domain_name_v2s +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the domain_name_v2s resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET, +apigateway:UpdateDomainNamePolicy +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PUT, +apigateway:PATCH, +apigateway:UpdateDomainNamePolicy +``` + +### Delete +```json +apigateway:DELETE, +apigateway:GET, +apigateway:UpdateDomainNamePolicy +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/domain_name_v2s_list_only/index.md b/website/docs/services/apigateway/domain_name_v2s_list_only/index.md new file mode 100644 index 0000000..29e22aa --- /dev/null +++ b/website/docs/services/apigateway/domain_name_v2s_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: domain_name_v2s_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_v2s_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domain_name_v2s in a region or regions, for all properties use domain_name_v2s + +## Overview + + + + + + + +
Namedomain_name_v2s_list_only
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainNameV2.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe amazon resource name (ARN) of the domain name resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domain_name_v2s in a region. +```sql +SELECT +region, +domain_name_arn +FROM aws.apigateway.domain_name_v2s_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_name_v2s_list_only resource, see domain_name_v2s + diff --git a/website/docs/services/apigateway/domain_names/index.md b/website/docs/services/apigateway/domain_names/index.md new file mode 100644 index 0000000..fbf1285 --- /dev/null +++ b/website/docs/services/apigateway/domain_names/index.md @@ -0,0 +1,277 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain_name resource or lists domain_names in a region + +## Overview + + + + + + + +
Namedomain_names
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainName.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
objectThe EndpointConfiguration property type specifies the endpoint types of a REST API.
EndpointConfiguration is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.
string
string
array
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::DomainName. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domain_names in a region. +```sql +SELECT +region, +mutual_tls_authentication, +ownership_verification_certificate_arn, +regional_hosted_zone_id, +regional_domain_name, +domain_name, +security_policy, +distribution_hosted_zone_id, +endpoint_configuration, +distribution_domain_name, +regional_certificate_arn, +tags, +certificate_arn +FROM aws.apigateway.domain_names +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain_name. +```sql +SELECT +region, +mutual_tls_authentication, +ownership_verification_certificate_arn, +regional_hosted_zone_id, +regional_domain_name, +domain_name, +security_policy, +distribution_hosted_zone_id, +endpoint_configuration, +distribution_domain_name, +regional_certificate_arn, +tags, +certificate_arn +FROM aws.apigateway.domain_names +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain_name resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.domain_names ( + MutualTlsAuthentication, + OwnershipVerificationCertificateArn, + DomainName, + SecurityPolicy, + EndpointConfiguration, + RegionalCertificateArn, + Tags, + CertificateArn, + region +) +SELECT +'{{ MutualTlsAuthentication }}', + '{{ OwnershipVerificationCertificateArn }}', + '{{ DomainName }}', + '{{ SecurityPolicy }}', + '{{ EndpointConfiguration }}', + '{{ RegionalCertificateArn }}', + '{{ Tags }}', + '{{ CertificateArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.domain_names ( + MutualTlsAuthentication, + OwnershipVerificationCertificateArn, + DomainName, + SecurityPolicy, + EndpointConfiguration, + RegionalCertificateArn, + Tags, + CertificateArn, + region +) +SELECT + '{{ MutualTlsAuthentication }}', + '{{ OwnershipVerificationCertificateArn }}', + '{{ DomainName }}', + '{{ SecurityPolicy }}', + '{{ EndpointConfiguration }}', + '{{ RegionalCertificateArn }}', + '{{ Tags }}', + '{{ CertificateArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain_name + props: + - name: MutualTlsAuthentication + value: + TruststoreVersion: '{{ TruststoreVersion }}' + TruststoreUri: '{{ TruststoreUri }}' + - name: OwnershipVerificationCertificateArn + value: '{{ OwnershipVerificationCertificateArn }}' + - name: DomainName + value: '{{ DomainName }}' + - name: SecurityPolicy + value: '{{ SecurityPolicy }}' + - name: EndpointConfiguration + value: + Types: + - '{{ Types[0] }}' + VpcEndpointIds: + - '{{ VpcEndpointIds[0] }}' + - name: RegionalCertificateArn + value: '{{ RegionalCertificateArn }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: CertificateArn + value: '{{ CertificateArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.domain_names +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the domain_names resource, the following permissions are required: + +### Read +```json +apigateway:* +``` + +### Create +```json +apigateway:* +``` + +### Update +```json +apigateway:* +``` + +### List +```json +apigateway:* +``` + +### Delete +```json +apigateway:* +``` diff --git a/website/docs/services/apigateway/domain_names_list_only/index.md b/website/docs/services/apigateway/domain_names_list_only/index.md new file mode 100644 index 0000000..9284321 --- /dev/null +++ b/website/docs/services/apigateway/domain_names_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domain_names_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domain_names_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domain_names in a region or regions, for all properties use domain_names + +## Overview + + + + + + + +
Namedomain_names_list_only
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainName.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domain_names in a region. +```sql +SELECT +region, +domain_name +FROM aws.apigateway.domain_names_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_names_list_only resource, see domain_names + diff --git a/website/docs/services/apigateway/gateway_responses/index.md b/website/docs/services/apigateway/gateway_responses/index.md new file mode 100644 index 0000000..3f6e27d --- /dev/null +++ b/website/docs/services/apigateway/gateway_responses/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a gateway_response resource or lists gateway_responses in a region + +## Overview + + + + + + + +
Namegateway_responses
TypeResource
DescriptionThe AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
stringAWS region.
+ +For more information, see AWS::ApiGateway::GatewayResponse. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all gateway_responses in a region. +```sql +SELECT +region, +id, +rest_api_id, +response_type, +status_code, +response_parameters, +response_templates +FROM aws.apigateway.gateway_responses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual gateway_response. +```sql +SELECT +region, +id, +rest_api_id, +response_type, +status_code, +response_parameters, +response_templates +FROM aws.apigateway.gateway_responses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new gateway_response resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.gateway_responses ( + RestApiId, + ResponseType, + region +) +SELECT +'{{ RestApiId }}', + '{{ ResponseType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.gateway_responses ( + RestApiId, + ResponseType, + StatusCode, + ResponseParameters, + ResponseTemplates, + region +) +SELECT + '{{ RestApiId }}', + '{{ ResponseType }}', + '{{ StatusCode }}', + '{{ ResponseParameters }}', + '{{ ResponseTemplates }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: gateway_response + props: + - name: RestApiId + value: '{{ RestApiId }}' + - name: ResponseType + value: '{{ ResponseType }}' + - name: StatusCode + value: '{{ StatusCode }}' + - name: ResponseParameters + value: {} + - name: ResponseTemplates + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.gateway_responses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the gateway_responses resource, the following permissions are required: + +### Create +```json +apigateway:PUT, +apigateway:GET +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PUT +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/gateway_responses_list_only/index.md b/website/docs/services/apigateway/gateway_responses_list_only/index.md new file mode 100644 index 0000000..807f440 --- /dev/null +++ b/website/docs/services/apigateway/gateway_responses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: gateway_responses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - gateway_responses_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists gateway_responses in a region or regions, for all properties use gateway_responses + +## Overview + + + + + + + +
Namegateway_responses_list_only
TypeResource
DescriptionThe AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all gateway_responses in a region. +```sql +SELECT +region, +id +FROM aws.apigateway.gateway_responses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the gateway_responses_list_only resource, see gateway_responses + diff --git a/website/docs/services/apigateway/index.md b/website/docs/services/apigateway/index.md new file mode 100644 index 0000000..80b533f --- /dev/null +++ b/website/docs/services/apigateway/index.md @@ -0,0 +1,86 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The apigateway service documentation. + +:::info Service Summary + +
+
+total resources: 51
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/apigateway/methods/index.md b/website/docs/services/apigateway/methods/index.md new file mode 100644 index 0000000..efa2d0a --- /dev/null +++ b/website/docs/services/apigateway/methods/index.md @@ -0,0 +1,282 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a method resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectIntegration is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.
string
object
string
array
string
object
array
string
string
boolean
stringThe 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*.
If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::Method. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual method. +```sql +SELECT +region, +integration, +operation_name, +request_models, +rest_api_id, +authorization_scopes, +request_validator_id, +request_parameters, +method_responses, +authorizer_id, +resource_id, +api_key_required, +authorization_type, +http_method +FROM aws.apigateway.methods +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new method resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.methods ( + RestApiId, + ResourceId, + HttpMethod, + region +) +SELECT +'{{ RestApiId }}', + '{{ ResourceId }}', + '{{ HttpMethod }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.methods ( + Integration, + OperationName, + RequestModels, + RestApiId, + AuthorizationScopes, + RequestValidatorId, + RequestParameters, + MethodResponses, + AuthorizerId, + ResourceId, + ApiKeyRequired, + AuthorizationType, + HttpMethod, + region +) +SELECT + '{{ Integration }}', + '{{ OperationName }}', + '{{ RequestModels }}', + '{{ RestApiId }}', + '{{ AuthorizationScopes }}', + '{{ RequestValidatorId }}', + '{{ RequestParameters }}', + '{{ MethodResponses }}', + '{{ AuthorizerId }}', + '{{ ResourceId }}', + '{{ ApiKeyRequired }}', + '{{ AuthorizationType }}', + '{{ HttpMethod }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: method + props: + - name: Integration + value: + CacheNamespace: '{{ CacheNamespace }}' + ConnectionType: '{{ ConnectionType }}' + IntegrationResponses: + - ResponseTemplates: {} + SelectionPattern: '{{ SelectionPattern }}' + ContentHandling: '{{ ContentHandling }}' + ResponseParameters: {} + StatusCode: '{{ StatusCode }}' + IntegrationHttpMethod: '{{ IntegrationHttpMethod }}' + Uri: '{{ Uri }}' + PassthroughBehavior: '{{ PassthroughBehavior }}' + RequestParameters: {} + ConnectionId: '{{ ConnectionId }}' + Type: '{{ Type }}' + CacheKeyParameters: + - '{{ CacheKeyParameters[0] }}' + ContentHandling: '{{ ContentHandling }}' + RequestTemplates: {} + TimeoutInMillis: '{{ TimeoutInMillis }}' + Credentials: '{{ Credentials }}' + - name: OperationName + value: '{{ OperationName }}' + - name: RequestModels + value: {} + - name: RestApiId + value: '{{ RestApiId }}' + - name: AuthorizationScopes + value: + - '{{ AuthorizationScopes[0] }}' + - name: RequestValidatorId + value: '{{ RequestValidatorId }}' + - name: RequestParameters + value: {} + - name: MethodResponses + value: + - ResponseParameters: {} + StatusCode: '{{ StatusCode }}' + ResponseModels: {} + - name: AuthorizerId + value: '{{ AuthorizerId }}' + - name: ResourceId + value: '{{ ResourceId }}' + - name: ApiKeyRequired + value: '{{ ApiKeyRequired }}' + - name: AuthorizationType + value: '{{ AuthorizationType }}' + - name: HttpMethod + value: '{{ HttpMethod }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.methods +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the methods resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Create +```json +apigateway:PUT, +apigateway:GET, +iam:PassRole +``` + +### Update +```json +apigateway:GET, +apigateway:DELETE, +apigateway:PUT, +iam:PassRole +``` + +### Delete +```json +apigateway:DELETE +``` diff --git a/website/docs/services/apigateway/models/index.md b/website/docs/services/apigateway/models/index.md new file mode 100644 index 0000000..f9d5708 --- /dev/null +++ b/website/docs/services/apigateway/models/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a model resource or lists 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.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
stringA name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
string
object
stringAWS region.
+ +For more information, see AWS::ApiGateway::Model. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all models in a region. +```sql +SELECT +region, +content_type, +description, +name, +rest_api_id, +schema +FROM aws.apigateway.models +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual model. +```sql +SELECT +region, +content_type, +description, +name, +rest_api_id, +schema +FROM aws.apigateway.models +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.models ( + RestApiId, + region +) +SELECT +'{{ RestApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.models ( + ContentType, + Description, + Name, + RestApiId, + Schema, + region +) +SELECT + '{{ ContentType }}', + '{{ Description }}', + '{{ Name }}', + '{{ RestApiId }}', + '{{ Schema }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: model + props: + - name: ContentType + value: '{{ ContentType }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: RestApiId + value: '{{ RestApiId }}' + - name: Schema + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.models +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the models resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/models_list_only/index.md b/website/docs/services/apigateway/models_list_only/index.md new file mode 100644 index 0000000..8bbc5c4 --- /dev/null +++ b/website/docs/services/apigateway/models_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: models_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - models_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists models in a region or regions, for all properties use models + +## Overview + + + + + + + +
Namemodels_list_only
TypeResource
DescriptionThe AWS::ApiGateway::Model resource defines the structure of a request or response payload for an API method.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all models in a region. +```sql +SELECT +region, +rest_api_id, +name +FROM aws.apigateway.models_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the models_list_only resource, see models + diff --git a/website/docs/services/apigateway/request_validators/index.md b/website/docs/services/apigateway/request_validators/index.md new file mode 100644 index 0000000..81a753a --- /dev/null +++ b/website/docs/services/apigateway/request_validators/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a request_validator resource or lists 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*.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
boolean
stringAWS region.
+ +For more information, see AWS::ApiGateway::RequestValidator. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all request_validators in a region. +```sql +SELECT +region, +request_validator_id, +name, +rest_api_id, +validate_request_body, +validate_request_parameters +FROM aws.apigateway.request_validators +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual request_validator. +```sql +SELECT +region, +request_validator_id, +name, +rest_api_id, +validate_request_body, +validate_request_parameters +FROM aws.apigateway.request_validators +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new request_validator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.request_validators ( + RestApiId, + region +) +SELECT +'{{ RestApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.request_validators ( + Name, + RestApiId, + ValidateRequestBody, + ValidateRequestParameters, + region +) +SELECT + '{{ Name }}', + '{{ RestApiId }}', + '{{ ValidateRequestBody }}', + '{{ ValidateRequestParameters }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: request_validator + props: + - name: Name + value: '{{ Name }}' + - name: RestApiId + value: '{{ RestApiId }}' + - name: ValidateRequestBody + value: '{{ ValidateRequestBody }}' + - name: ValidateRequestParameters + value: '{{ ValidateRequestParameters }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.request_validators +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the request_validators resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET +``` + +### Delete +```json +apigateway:DELETE +``` + +### Read +```json +apigateway:GET +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/request_validators_list_only/index.md b/website/docs/services/apigateway/request_validators_list_only/index.md new file mode 100644 index 0000000..94b95df --- /dev/null +++ b/website/docs/services/apigateway/request_validators_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: request_validators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - request_validators_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists request_validators in a region or regions, for all properties use request_validators + +## Overview + + + + + + + +
Namerequest_validators_list_only
TypeResource
DescriptionThe AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all request_validators in a region. +```sql +SELECT +region, +rest_api_id, +request_validator_id +FROM aws.apigateway.request_validators_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the request_validators_list_only resource, see request_validators + diff --git a/website/docs/services/apigateway/resources/index.md b/website/docs/services/apigateway/resources/index.md new file mode 100644 index 0000000..ddfeab0 --- /dev/null +++ b/website/docs/services/apigateway/resources/index.md @@ -0,0 +1,216 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource resource or lists resources in a region + +## Overview + + + + + + + +
Nameresources
TypeResource
DescriptionThe AWS::ApiGateway::Resource resource creates a resource in an API.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::Resource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resources in a region. +```sql +SELECT +region, +parent_id, +path_part, +resource_id, +rest_api_id +FROM aws.apigateway.resources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource. +```sql +SELECT +region, +parent_id, +path_part, +resource_id, +rest_api_id +FROM aws.apigateway.resources +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.resources ( + ParentId, + PathPart, + RestApiId, + region +) +SELECT +'{{ ParentId }}', + '{{ PathPart }}', + '{{ RestApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.resources ( + ParentId, + PathPart, + RestApiId, + region +) +SELECT + '{{ ParentId }}', + '{{ PathPart }}', + '{{ RestApiId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource + props: + - name: ParentId + value: '{{ ParentId }}' + - name: PathPart + value: '{{ PathPart }}' + - name: RestApiId + value: '{{ RestApiId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.resources +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resources resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Create +```json +apigateway:POST +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH +``` + +### List +```json +apigateway:GET +``` + +### Delete +```json +apigateway:DELETE +``` diff --git a/website/docs/services/apigateway/resources_list_only/index.md b/website/docs/services/apigateway/resources_list_only/index.md new file mode 100644 index 0000000..05eaa1d --- /dev/null +++ b/website/docs/services/apigateway/resources_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: resources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resources_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resources in a region or regions, for all properties use resources + +## Overview + + + + + + + +
Nameresources_list_only
TypeResource
DescriptionThe AWS::ApiGateway::Resource resource creates a resource in an API.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resources in a region. +```sql +SELECT +region, +rest_api_id, +resource_id +FROM aws.apigateway.resources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resources_list_only resource, see resources + diff --git a/website/docs/services/apigateway/rest_api_tags/index.md b/website/docs/services/apigateway/rest_api_tags/index.md new file mode 100644 index 0000000..c3b1f78 --- /dev/null +++ b/website/docs/services/apigateway/rest_api_tags/index.md @@ -0,0 +1,107 @@ +--- +title: rest_api_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rest_api_tags + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rest_apis in a region + +## Overview + + + + + + + +
Namerest_api_tags
TypeResource
DescriptionThe AWS::ApiGateway::RestApi resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.
On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA policy document that contains the permissions for the RestApi resource. To set the ARN for the policy, use the !Join intrinsic function with "" as delimiter and values of "execute-api:/" and "*".
objectThe Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
string
integer
object
string
stringThis property applies only when you use OpenAPI to define your REST API. The Mode determines how API Gateway handles resource updates.
Valid values are overwrite or merge.
For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged.
For merge, the new API definition is merged with the existing API.
If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is overwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
Use the default mode to define top-level RestApi properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
string
boolean
boolean
array
stringThe name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
string
string
objectA list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property.
objectAn OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rest_apis in a region. +```sql +SELECT +region, +policy, +body_s3_location, +description, +minimum_compression_size, +parameters, +clone_from, +mode, +rest_api_id, +disable_execute_api_endpoint, +fail_on_warnings, +binary_media_types, +name, +root_resource_id, +api_key_source_type, +endpoint_configuration, +body, +tag_key, +tag_value +FROM aws.apigateway.rest_api_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rest_api_tags resource, see rest_apis + diff --git a/website/docs/services/apigateway/rest_apis/index.md b/website/docs/services/apigateway/rest_apis/index.md new file mode 100644 index 0000000..e495f1f --- /dev/null +++ b/website/docs/services/apigateway/rest_apis/index.md @@ -0,0 +1,349 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a rest_api resource or lists 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*.
On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA policy document that contains the permissions for the RestApi resource. To set the ARN for the policy, use the !Join intrinsic function with "" as delimiter and values of "execute-api:/" and "*".
objectThe Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
string
integer
object
string
stringThis property applies only when you use OpenAPI to define your REST API. The Mode determines how API Gateway handles resource updates.
Valid values are overwrite or merge.
For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged.
For merge, the new API definition is merged with the existing API.
If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is overwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
Use the default mode to define top-level RestApi properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
string
boolean
boolean
array
stringThe name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
string
string
objectA list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property.
objectAn OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
array
stringAWS region.
+ +For more information, see AWS::ApiGateway::RestApi. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rest_apis in a region. +```sql +SELECT +region, +policy, +body_s3_location, +description, +minimum_compression_size, +parameters, +clone_from, +mode, +rest_api_id, +disable_execute_api_endpoint, +fail_on_warnings, +binary_media_types, +name, +root_resource_id, +api_key_source_type, +endpoint_configuration, +body, +tags +FROM aws.apigateway.rest_apis +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual rest_api. +```sql +SELECT +region, +policy, +body_s3_location, +description, +minimum_compression_size, +parameters, +clone_from, +mode, +rest_api_id, +disable_execute_api_endpoint, +fail_on_warnings, +binary_media_types, +name, +root_resource_id, +api_key_source_type, +endpoint_configuration, +body, +tags +FROM aws.apigateway.rest_apis +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rest_api resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.rest_apis ( + Policy, + BodyS3Location, + Description, + MinimumCompressionSize, + Parameters, + CloneFrom, + Mode, + DisableExecuteApiEndpoint, + FailOnWarnings, + BinaryMediaTypes, + Name, + ApiKeySourceType, + EndpointConfiguration, + Body, + Tags, + region +) +SELECT +'{{ Policy }}', + '{{ BodyS3Location }}', + '{{ Description }}', + '{{ MinimumCompressionSize }}', + '{{ Parameters }}', + '{{ CloneFrom }}', + '{{ Mode }}', + '{{ DisableExecuteApiEndpoint }}', + '{{ FailOnWarnings }}', + '{{ BinaryMediaTypes }}', + '{{ Name }}', + '{{ ApiKeySourceType }}', + '{{ EndpointConfiguration }}', + '{{ Body }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.rest_apis ( + Policy, + BodyS3Location, + Description, + MinimumCompressionSize, + Parameters, + CloneFrom, + Mode, + DisableExecuteApiEndpoint, + FailOnWarnings, + BinaryMediaTypes, + Name, + ApiKeySourceType, + EndpointConfiguration, + Body, + Tags, + region +) +SELECT + '{{ Policy }}', + '{{ BodyS3Location }}', + '{{ Description }}', + '{{ MinimumCompressionSize }}', + '{{ Parameters }}', + '{{ CloneFrom }}', + '{{ Mode }}', + '{{ DisableExecuteApiEndpoint }}', + '{{ FailOnWarnings }}', + '{{ BinaryMediaTypes }}', + '{{ Name }}', + '{{ ApiKeySourceType }}', + '{{ EndpointConfiguration }}', + '{{ Body }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: rest_api + props: + - name: Policy + value: {} + - name: BodyS3Location + value: + Bucket: '{{ Bucket }}' + ETag: '{{ ETag }}' + Version: '{{ Version }}' + Key: '{{ Key }}' + - name: Description + value: '{{ Description }}' + - name: MinimumCompressionSize + value: '{{ MinimumCompressionSize }}' + - name: Parameters + value: {} + - name: CloneFrom + value: '{{ CloneFrom }}' + - name: Mode + value: '{{ Mode }}' + - name: DisableExecuteApiEndpoint + value: '{{ DisableExecuteApiEndpoint }}' + - name: FailOnWarnings + value: '{{ FailOnWarnings }}' + - name: BinaryMediaTypes + value: + - '{{ BinaryMediaTypes[0] }}' + - name: Name + value: '{{ Name }}' + - name: ApiKeySourceType + value: '{{ ApiKeySourceType }}' + - name: EndpointConfiguration + value: + Types: + - '{{ Types[0] }}' + VpcEndpointIds: + - '{{ VpcEndpointIds[0] }}' + - name: Body + value: {} + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.rest_apis +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the rest_apis resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Create +```json +apigateway:GET, +apigateway:POST, +apigateway:PUT, +apigateway:PATCH, +apigateway:UpdateRestApiPolicy, +s3:GetObject, +iam:PassRole +``` + +### Update +```json +apigateway:GET, +apigateway:DELETE, +apigateway:PATCH, +apigateway:PUT, +apigateway:UpdateRestApiPolicy, +s3:GetObject, +iam:PassRole +``` + +### List +```json +apigateway:GET +``` + +### Delete +```json +apigateway:DELETE +``` diff --git a/website/docs/services/apigateway/rest_apis_list_only/index.md b/website/docs/services/apigateway/rest_apis_list_only/index.md new file mode 100644 index 0000000..987a585 --- /dev/null +++ b/website/docs/services/apigateway/rest_apis_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: rest_apis_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rest_apis_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rest_apis in a region or regions, for all properties use rest_apis + +## Overview + + + + + + + +
Namerest_apis_list_only
TypeResource
DescriptionThe AWS::ApiGateway::RestApi resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.
On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rest_apis in a region. +```sql +SELECT +region, +rest_api_id +FROM aws.apigateway.rest_apis_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rest_apis_list_only resource, see rest_apis + diff --git a/website/docs/services/apigateway/stage_tags/index.md b/website/docs/services/apigateway/stage_tags/index.md new file mode 100644 index 0000000..6705de2 --- /dev/null +++ b/website/docs/services/apigateway/stage_tags/index.md @@ -0,0 +1,101 @@ +--- +title: stage_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stage_tags + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stages in a region + +## Overview + + + + + + + +
Namestage_tags
TypeResource
DescriptionThe AWS::ApiGateway::Stage resource creates a stage for a deployment.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe AccessLogSetting property type specifies settings for logging access in this stage.
AccessLogSetting is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.
boolean
string
object
string
string
string
string
array
string
string
boolean
objectA map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stages in a region. +```sql +SELECT +region, +access_log_setting, +cache_cluster_enabled, +cache_cluster_size, +canary_setting, +client_certificate_id, +deployment_id, +description, +documentation_version, +method_settings, +rest_api_id, +stage_name, +tracing_enabled, +variables, +tag_key, +tag_value +FROM aws.apigateway.stage_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stage_tags resource, see stages + diff --git a/website/docs/services/apigateway/stages/index.md b/website/docs/services/apigateway/stages/index.md new file mode 100644 index 0000000..1a1e2f2 --- /dev/null +++ b/website/docs/services/apigateway/stages/index.md @@ -0,0 +1,309 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a stage resource or lists stages in a region + +## Overview + + + + + + + +
Namestages
TypeResource
DescriptionThe AWS::ApiGateway::Stage resource creates a stage for a deployment.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe AccessLogSetting property type specifies settings for logging access in this stage.
AccessLogSetting is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.
boolean
string
object
string
string
string
string
array
string
string
array
boolean
objectA map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
stringAWS region.
+ +For more information, see AWS::ApiGateway::Stage. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all stages in a region. +```sql +SELECT +region, +access_log_setting, +cache_cluster_enabled, +cache_cluster_size, +canary_setting, +client_certificate_id, +deployment_id, +description, +documentation_version, +method_settings, +rest_api_id, +stage_name, +tags, +tracing_enabled, +variables +FROM aws.apigateway.stages +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual stage. +```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.stages +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stage resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.stages ( + RestApiId, + region +) +SELECT +'{{ RestApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.stages ( + AccessLogSetting, + CacheClusterEnabled, + CacheClusterSize, + CanarySetting, + ClientCertificateId, + DeploymentId, + Description, + DocumentationVersion, + MethodSettings, + RestApiId, + StageName, + Tags, + TracingEnabled, + Variables, + region +) +SELECT + '{{ AccessLogSetting }}', + '{{ CacheClusterEnabled }}', + '{{ CacheClusterSize }}', + '{{ CanarySetting }}', + '{{ ClientCertificateId }}', + '{{ DeploymentId }}', + '{{ Description }}', + '{{ DocumentationVersion }}', + '{{ MethodSettings }}', + '{{ RestApiId }}', + '{{ StageName }}', + '{{ Tags }}', + '{{ TracingEnabled }}', + '{{ Variables }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: stage + props: + - name: AccessLogSetting + value: + DestinationArn: '{{ DestinationArn }}' + Format: '{{ Format }}' + - name: CacheClusterEnabled + value: '{{ CacheClusterEnabled }}' + - name: CacheClusterSize + value: '{{ CacheClusterSize }}' + - name: CanarySetting + value: + DeploymentId: '{{ DeploymentId }}' + PercentTraffic: null + StageVariableOverrides: {} + UseStageCache: '{{ UseStageCache }}' + - name: ClientCertificateId + value: '{{ ClientCertificateId }}' + - name: DeploymentId + value: '{{ DeploymentId }}' + - name: Description + value: '{{ Description }}' + - name: DocumentationVersion + value: '{{ DocumentationVersion }}' + - name: MethodSettings + value: + - CacheDataEncrypted: '{{ CacheDataEncrypted }}' + CacheTtlInSeconds: '{{ CacheTtlInSeconds }}' + CachingEnabled: '{{ CachingEnabled }}' + DataTraceEnabled: '{{ DataTraceEnabled }}' + HttpMethod: '{{ HttpMethod }}' + LoggingLevel: '{{ LoggingLevel }}' + MetricsEnabled: '{{ MetricsEnabled }}' + ResourcePath: '{{ ResourcePath }}' + ThrottlingBurstLimit: '{{ ThrottlingBurstLimit }}' + ThrottlingRateLimit: null + - name: RestApiId + value: '{{ RestApiId }}' + - name: StageName + value: '{{ StageName }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: TracingEnabled + value: '{{ TracingEnabled }}' + - name: Variables + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.stages +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH, +apigateway:PUT, +apigateway:DELETE +``` + +### Delete +```json +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/stages_list_only/index.md b/website/docs/services/apigateway/stages_list_only/index.md new file mode 100644 index 0000000..40a73de --- /dev/null +++ b/website/docs/services/apigateway/stages_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: stages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stages_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stages in a region or regions, for all properties use stages + +## Overview + + + + + + + +
Namestages_list_only
TypeResource
DescriptionThe AWS::ApiGateway::Stage resource creates a stage for a deployment.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stages in a region. +```sql +SELECT +region, +rest_api_id, +stage_name +FROM aws.apigateway.stages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stages_list_only resource, see stages + diff --git a/website/docs/services/apigateway/usage_plan_keys/index.md b/website/docs/services/apigateway/usage_plan_keys/index.md new file mode 100644 index 0000000..d507dc4 --- /dev/null +++ b/website/docs/services/apigateway/usage_plan_keys/index.md @@ -0,0 +1,207 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an usage_plan_key resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Id of the UsagePlanKey resource.
string
stringThe Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::UsagePlanKey. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all usage_plan_keys in a region. +```sql +SELECT +region, +key_id, +key_type, +usage_plan_id, +id +FROM aws.apigateway.usage_plan_keys +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual usage_plan_key. +```sql +SELECT +region, +key_id, +key_type, +usage_plan_id, +id +FROM aws.apigateway.usage_plan_keys +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new usage_plan_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.usage_plan_keys ( + KeyId, + KeyType, + UsagePlanId, + region +) +SELECT +'{{ KeyId }}', + '{{ KeyType }}', + '{{ UsagePlanId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.usage_plan_keys ( + KeyId, + KeyType, + UsagePlanId, + region +) +SELECT + '{{ KeyId }}', + '{{ KeyType }}', + '{{ UsagePlanId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: usage_plan_key + props: + - name: KeyId + value: '{{ KeyId }}' + - name: KeyType + value: '{{ KeyType }}' + - name: UsagePlanId + value: '{{ UsagePlanId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.usage_plan_keys +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the usage_plan_keys resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:DELETE, +apigateway:GET +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/usage_plan_keys_list_only/index.md b/website/docs/services/apigateway/usage_plan_keys_list_only/index.md new file mode 100644 index 0000000..6bcb183 --- /dev/null +++ b/website/docs/services/apigateway/usage_plan_keys_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: usage_plan_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - usage_plan_keys_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists usage_plan_keys in a region or regions, for all properties use usage_plan_keys + +## Overview + + + + + + + +
Nameusage_plan_keys_list_only
TypeResource
DescriptionThe AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all usage_plan_keys in a region. +```sql +SELECT +region, +id +FROM aws.apigateway.usage_plan_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the usage_plan_keys_list_only resource, see usage_plan_keys + diff --git a/website/docs/services/apigateway/usage_plan_tags/index.md b/website/docs/services/apigateway/usage_plan_tags/index.md new file mode 100644 index 0000000..58b0f87 --- /dev/null +++ b/website/docs/services/apigateway/usage_plan_tags/index.md @@ -0,0 +1,87 @@ +--- +title: usage_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - usage_plan_tags + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for usage_plans in a region + +## Overview + + + + + + + +
Nameusage_plan_tags
TypeResource
DescriptionThe AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.
In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
array
string
objectQuotaSettings is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.
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.
objectThrottleSettings is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all usage_plans in a region. +```sql +SELECT +region, +id, +api_stages, +description, +quota, +throttle, +usage_plan_name, +tag_key, +tag_value +FROM aws.apigateway.usage_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the usage_plan_tags resource, see usage_plans + diff --git a/website/docs/services/apigateway/usage_plans/index.md b/website/docs/services/apigateway/usage_plans/index.md new file mode 100644 index 0000000..5b8357e --- /dev/null +++ b/website/docs/services/apigateway/usage_plans/index.md @@ -0,0 +1,259 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an usage_plan resource or lists 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*.
In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
array
string
objectQuotaSettings is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.
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.
array
objectThrottleSettings is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::UsagePlan. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all usage_plans in a region. +```sql +SELECT +region, +id, +api_stages, +description, +quota, +tags, +throttle, +usage_plan_name +FROM aws.apigateway.usage_plans +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual usage_plan. +```sql +SELECT +region, +id, +api_stages, +description, +quota, +tags, +throttle, +usage_plan_name +FROM aws.apigateway.usage_plans +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new usage_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.usage_plans ( + ApiStages, + Description, + Quota, + Tags, + Throttle, + UsagePlanName, + region +) +SELECT +'{{ ApiStages }}', + '{{ Description }}', + '{{ Quota }}', + '{{ Tags }}', + '{{ Throttle }}', + '{{ UsagePlanName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.usage_plans ( + ApiStages, + Description, + Quota, + Tags, + Throttle, + UsagePlanName, + region +) +SELECT + '{{ ApiStages }}', + '{{ Description }}', + '{{ Quota }}', + '{{ Tags }}', + '{{ Throttle }}', + '{{ UsagePlanName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: usage_plan + props: + - name: ApiStages + value: + - ApiId: '{{ ApiId }}' + Stage: '{{ Stage }}' + Throttle: {} + - name: Description + value: '{{ Description }}' + - name: Quota + value: + Limit: '{{ Limit }}' + Offset: '{{ Offset }}' + Period: '{{ Period }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Throttle + value: + BurstLimit: '{{ BurstLimit }}' + RateLimit: null + - name: UsagePlanName + value: '{{ UsagePlanName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.usage_plans +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:DELETE, +apigateway:PATCH, +apigateway:PUT +``` + +### Delete +```json +apigateway:DELETE, +apigateway:GET, +apigateway:PATCH +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigateway/usage_plans_list_only/index.md b/website/docs/services/apigateway/usage_plans_list_only/index.md new file mode 100644 index 0000000..61c845e --- /dev/null +++ b/website/docs/services/apigateway/usage_plans_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: usage_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - usage_plans_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists usage_plans in a region or regions, for all properties use usage_plans + +## Overview + + + + + + + +
Nameusage_plans_list_only
TypeResource
DescriptionThe AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.
In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all usage_plans in a region. +```sql +SELECT +region, +id +FROM aws.apigateway.usage_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the usage_plans_list_only resource, see usage_plans + diff --git a/website/docs/services/apigateway/vpc_link_tags/index.md b/website/docs/services/apigateway/vpc_link_tags/index.md new file mode 100644 index 0000000..f13f5e1 --- /dev/null +++ b/website/docs/services/apigateway/vpc_link_tags/index.md @@ -0,0 +1,83 @@ +--- +title: vpc_link_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_link_tags + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_links in a region + +## Overview + + + + + + + +
Namevpc_link_tags
TypeResource
DescriptionThe AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the Amazon API Gateway REST API Reference.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_links in a region. +```sql +SELECT +region, +name, +description, +target_arns, +vpc_link_id, +tag_key, +tag_value +FROM aws.apigateway.vpc_link_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_link_tags resource, see vpc_links + diff --git a/website/docs/services/apigateway/vpc_links/index.md b/website/docs/services/apigateway/vpc_links/index.md new file mode 100644 index 0000000..0004b94 --- /dev/null +++ b/website/docs/services/apigateway/vpc_links/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_link resource or lists vpc_links in a region + +## Overview + + + + + + + +
Namevpc_links
TypeResource
DescriptionThe AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the Amazon API Gateway REST API Reference.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
arrayAn array of arbitrary tags (key-value pairs) to associate with the VPC link.
array
string
stringAWS region.
+ +For more information, see AWS::ApiGateway::VpcLink. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_links in a region. +```sql +SELECT +region, +name, +description, +tags, +target_arns, +vpc_link_id +FROM aws.apigateway.vpc_links +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_link. +```sql +SELECT +region, +name, +description, +tags, +target_arns, +vpc_link_id +FROM aws.apigateway.vpc_links +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_link resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.vpc_links ( + Name, + TargetArns, + region +) +SELECT +'{{ Name }}', + '{{ TargetArns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigateway.vpc_links ( + Name, + Description, + Tags, + TargetArns, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Tags }}', + '{{ TargetArns }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_link + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: TargetArns + value: + - '{{ TargetArns[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigateway.vpc_links +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```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/website/docs/services/apigateway/vpc_links_list_only/index.md b/website/docs/services/apigateway/vpc_links_list_only/index.md new file mode 100644 index 0000000..52716e7 --- /dev/null +++ b/website/docs/services/apigateway/vpc_links_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_links_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_links_list_only + - apigateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_links in a region or regions, for all properties use vpc_links + +## Overview + + + + + + + +
Namevpc_links_list_only
TypeResource
DescriptionThe AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the Amazon API Gateway REST API Reference.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_links in a region. +```sql +SELECT +region, +vpc_link_id +FROM aws.apigateway.vpc_links_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_links_list_only resource, see vpc_links + diff --git a/website/docs/services/apigatewayv2/api_mappings/index.md b/website/docs/services/apigatewayv2/api_mappings/index.md new file mode 100644 index 0000000..7c422c6 --- /dev/null +++ b/website/docs/services/apigatewayv2/api_mappings/index.md @@ -0,0 +1,224 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an api_mapping resource or lists 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*.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringThe domain name.
stringThe API stage.
stringThe API mapping key.
stringThe identifier of the API.
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::ApiMapping. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all api_mappings in a region. +```sql +SELECT +region, +api_mapping_id, +domain_name, +stage, +api_mapping_key, +api_id +FROM aws.apigatewayv2.api_mappings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual api_mapping. +```sql +SELECT +region, +api_mapping_id, +domain_name, +stage, +api_mapping_key, +api_id +FROM aws.apigatewayv2.api_mappings +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new api_mapping resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.api_mappings ( + DomainName, + Stage, + ApiId, + region +) +SELECT +'{{ DomainName }}', + '{{ Stage }}', + '{{ ApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.api_mappings ( + DomainName, + Stage, + ApiMappingKey, + ApiId, + region +) +SELECT + '{{ DomainName }}', + '{{ Stage }}', + '{{ ApiMappingKey }}', + '{{ ApiId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: api_mapping + props: + - name: DomainName + value: '{{ DomainName }}' + - name: Stage + value: '{{ Stage }}' + - name: ApiMappingKey + value: '{{ ApiMappingKey }}' + - name: ApiId + value: '{{ ApiId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.api_mappings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the api_mappings resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigatewayv2/api_mappings_list_only/index.md b/website/docs/services/apigatewayv2/api_mappings_list_only/index.md new file mode 100644 index 0000000..d5f8655 --- /dev/null +++ b/website/docs/services/apigatewayv2/api_mappings_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: api_mappings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - api_mappings_list_only + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists api_mappings in a region or regions, for all properties use api_mappings + +## Overview + + + + + + + +
Nameapi_mappings_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe domain name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all api_mappings in a region. +```sql +SELECT +region, +api_mapping_id, +domain_name +FROM aws.apigatewayv2.api_mappings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_mappings_list_only resource, see api_mappings + diff --git a/website/docs/services/apigatewayv2/api_tags/index.md b/website/docs/services/apigatewayv2/api_tags/index.md new file mode 100644 index 0000000..1b94c3e --- /dev/null +++ b/website/docs/services/apigatewayv2/api_tags/index.md @@ -0,0 +1,111 @@ +--- +title: api_tags +hide_title: false +hide_table_of_contents: false +keywords: + - api_tags + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for apis in a region + +## Overview + + + + + + + +
Nameapi_tags
TypeResource
DescriptionThe AWS::ApiGatewayV2::Api resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
objectThe S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
stringThe description of the API.
string
stringSpecifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
booleanSpecifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
booleanSpecifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
booleanAvoid validating models when creating a deployment. Supported only for WebSocket APIs.
stringThe name of the API. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
stringThis property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
stringThis property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
objectA CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
stringA version identifier for the API.
stringThe API protocol. Valid values are WEBSOCKET or HTTP. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
stringThis property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
string
objectThe OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
stringAn API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all apis in a region. +```sql +SELECT +region, +route_selection_expression, +body_s3_location, +description, +api_endpoint, +base_path, +fail_on_warnings, +disable_execute_api_endpoint, +disable_schema_validation, +name, +target, +credentials_arn, +cors_configuration, +version, +protocol_type, +route_key, +api_id, +body, +api_key_selection_expression, +tag_key, +tag_value +FROM aws.apigatewayv2.api_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_tags resource, see apis + diff --git a/website/docs/services/apigatewayv2/apis/index.md b/website/docs/services/apigatewayv2/apis/index.md new file mode 100644 index 0000000..eabf564 --- /dev/null +++ b/website/docs/services/apigatewayv2/apis/index.md @@ -0,0 +1,368 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an api resource or lists 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.*
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
objectThe S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
stringThe description of the API.
string
stringSpecifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
booleanSpecifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
booleanSpecifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
booleanAvoid validating models when creating a deployment. Supported only for WebSocket APIs.
stringThe name of the API. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
stringThis property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
stringThis property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
objectA CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
stringA version identifier for the API.
stringThe API protocol. Valid values are WEBSOCKET or HTTP. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
stringThis property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
string
objectThe OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
objectThe collection of tags. Each tag element is associated with a given resource.
stringAn API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::Api. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all apis in a region. +```sql +SELECT +region, +route_selection_expression, +body_s3_location, +description, +api_endpoint, +base_path, +fail_on_warnings, +disable_execute_api_endpoint, +disable_schema_validation, +name, +target, +credentials_arn, +cors_configuration, +version, +protocol_type, +route_key, +api_id, +body, +tags, +api_key_selection_expression +FROM aws.apigatewayv2.apis +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual api. +```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.apis +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new api resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.apis ( + RouteSelectionExpression, + BodyS3Location, + Description, + BasePath, + FailOnWarnings, + DisableExecuteApiEndpoint, + DisableSchemaValidation, + Name, + Target, + CredentialsArn, + CorsConfiguration, + Version, + ProtocolType, + RouteKey, + Body, + Tags, + ApiKeySelectionExpression, + region +) +SELECT +'{{ RouteSelectionExpression }}', + '{{ BodyS3Location }}', + '{{ Description }}', + '{{ BasePath }}', + '{{ FailOnWarnings }}', + '{{ DisableExecuteApiEndpoint }}', + '{{ DisableSchemaValidation }}', + '{{ Name }}', + '{{ Target }}', + '{{ CredentialsArn }}', + '{{ CorsConfiguration }}', + '{{ Version }}', + '{{ ProtocolType }}', + '{{ RouteKey }}', + '{{ Body }}', + '{{ Tags }}', + '{{ ApiKeySelectionExpression }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.apis ( + RouteSelectionExpression, + BodyS3Location, + Description, + BasePath, + FailOnWarnings, + DisableExecuteApiEndpoint, + DisableSchemaValidation, + Name, + Target, + CredentialsArn, + CorsConfiguration, + Version, + ProtocolType, + RouteKey, + Body, + Tags, + ApiKeySelectionExpression, + region +) +SELECT + '{{ RouteSelectionExpression }}', + '{{ BodyS3Location }}', + '{{ Description }}', + '{{ BasePath }}', + '{{ FailOnWarnings }}', + '{{ DisableExecuteApiEndpoint }}', + '{{ DisableSchemaValidation }}', + '{{ Name }}', + '{{ Target }}', + '{{ CredentialsArn }}', + '{{ CorsConfiguration }}', + '{{ Version }}', + '{{ ProtocolType }}', + '{{ RouteKey }}', + '{{ Body }}', + '{{ Tags }}', + '{{ ApiKeySelectionExpression }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: api + props: + - name: RouteSelectionExpression + value: '{{ RouteSelectionExpression }}' + - name: BodyS3Location + value: + Etag: '{{ Etag }}' + Bucket: '{{ Bucket }}' + Version: '{{ Version }}' + Key: '{{ Key }}' + - name: Description + value: '{{ Description }}' + - name: BasePath + value: '{{ BasePath }}' + - name: FailOnWarnings + value: '{{ FailOnWarnings }}' + - name: DisableExecuteApiEndpoint + value: '{{ DisableExecuteApiEndpoint }}' + - name: DisableSchemaValidation + value: '{{ DisableSchemaValidation }}' + - name: Name + value: '{{ Name }}' + - name: Target + value: '{{ Target }}' + - name: CredentialsArn + value: '{{ CredentialsArn }}' + - name: CorsConfiguration + value: + AllowOrigins: + - '{{ AllowOrigins[0] }}' + AllowCredentials: '{{ AllowCredentials }}' + ExposeHeaders: + - '{{ ExposeHeaders[0] }}' + AllowHeaders: + - '{{ AllowHeaders[0] }}' + MaxAge: '{{ MaxAge }}' + AllowMethods: + - '{{ AllowMethods[0] }}' + - name: Version + value: '{{ Version }}' + - name: ProtocolType + value: '{{ ProtocolType }}' + - name: RouteKey + value: '{{ RouteKey }}' + - name: Body + value: {} + - name: Tags + value: {} + - name: ApiKeySelectionExpression + value: '{{ ApiKeySelectionExpression }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.apis +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the apis resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:PUT, +s3:getObject +``` + +### 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 +``` + +### List +```json +apigateway:GET, +s3:getObject +``` diff --git a/website/docs/services/apigatewayv2/apis_list_only/index.md b/website/docs/services/apigatewayv2/apis_list_only/index.md new file mode 100644 index 0000000..63efec8 --- /dev/null +++ b/website/docs/services/apigatewayv2/apis_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: apis_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - apis_list_only + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists apis in a region or regions, for all properties use apis + +## Overview + + + + + + + +
Nameapis_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Api resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all apis in a region. +```sql +SELECT +region, +api_id +FROM aws.apigatewayv2.apis_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the apis_list_only resource, see apis + diff --git a/website/docs/services/apigatewayv2/authorizers/index.md b/website/docs/services/apigatewayv2/authorizers/index.md new file mode 100644 index 0000000..4fcb372 --- /dev/null +++ b/website/docs/services/apigatewayv2/authorizers/index.md @@ -0,0 +1,280 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an authorizer resource or lists 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*.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis parameter is not used.
stringThe authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
stringSpecifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
stringThe authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
objectThe JWTConfiguration property specifies the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
integerThe time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
arrayThe identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
stringSpecifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
stringThe API identifier.
booleanSpecifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
string
stringThe name of the authorizer.
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::Authorizer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all authorizers in a region. +```sql +SELECT +region, +identity_validation_expression, +authorizer_uri, +authorizer_credentials_arn, +authorizer_type, +jwt_configuration, +authorizer_result_ttl_in_seconds, +identity_source, +authorizer_payload_format_version, +api_id, +enable_simple_responses, +authorizer_id, +name +FROM aws.apigatewayv2.authorizers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual authorizer. +```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.authorizers +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new authorizer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.authorizers ( + AuthorizerType, + ApiId, + Name, + region +) +SELECT +'{{ AuthorizerType }}', + '{{ ApiId }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.authorizers ( + IdentityValidationExpression, + AuthorizerUri, + AuthorizerCredentialsArn, + AuthorizerType, + JwtConfiguration, + AuthorizerResultTtlInSeconds, + IdentitySource, + AuthorizerPayloadFormatVersion, + ApiId, + EnableSimpleResponses, + Name, + region +) +SELECT + '{{ IdentityValidationExpression }}', + '{{ AuthorizerUri }}', + '{{ AuthorizerCredentialsArn }}', + '{{ AuthorizerType }}', + '{{ JwtConfiguration }}', + '{{ AuthorizerResultTtlInSeconds }}', + '{{ IdentitySource }}', + '{{ AuthorizerPayloadFormatVersion }}', + '{{ ApiId }}', + '{{ EnableSimpleResponses }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: authorizer + props: + - name: IdentityValidationExpression + value: '{{ IdentityValidationExpression }}' + - name: AuthorizerUri + value: '{{ AuthorizerUri }}' + - name: AuthorizerCredentialsArn + value: '{{ AuthorizerCredentialsArn }}' + - name: AuthorizerType + value: '{{ AuthorizerType }}' + - name: JwtConfiguration + value: + Issuer: '{{ Issuer }}' + Audience: + - '{{ Audience[0] }}' + - name: AuthorizerResultTtlInSeconds + value: '{{ AuthorizerResultTtlInSeconds }}' + - name: IdentitySource + value: + - '{{ IdentitySource[0] }}' + - name: AuthorizerPayloadFormatVersion + value: '{{ AuthorizerPayloadFormatVersion }}' + - name: ApiId + value: '{{ ApiId }}' + - name: EnableSimpleResponses + value: '{{ EnableSimpleResponses }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.authorizers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the authorizers resource, the following permissions are required: + +### Create +```json +apigateway:POST, +iam:PassRole +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT, +iam:PassRole +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigatewayv2/authorizers_list_only/index.md b/website/docs/services/apigatewayv2/authorizers_list_only/index.md new file mode 100644 index 0000000..e325193 --- /dev/null +++ b/website/docs/services/apigatewayv2/authorizers_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: authorizers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - authorizers_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists authorizers in a region or regions, for all properties use authorizers + +## Overview + + + + + + + +
Nameauthorizers_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Authorizer resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe API identifier.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all authorizers in a region. +```sql +SELECT +region, +authorizer_id, +api_id +FROM aws.apigatewayv2.authorizers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the authorizers_list_only resource, see authorizers + diff --git a/website/docs/services/apigatewayv2/deployments/index.md b/website/docs/services/apigatewayv2/deployments/index.md new file mode 100644 index 0000000..ce67dbf --- /dev/null +++ b/website/docs/services/apigatewayv2/deployments/index.md @@ -0,0 +1,214 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a deployment resource or lists deployments in a region + +## Overview + + + + + + + +
Namedeployments
TypeResource
DescriptionThe AWS::ApiGatewayV2::Deployment resource creates a deployment for an API.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringThe description for the deployment resource.
stringThe name of an existing stage to associate with the deployment.
stringThe API identifier.
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::Deployment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all deployments in a region. +```sql +SELECT +region, +deployment_id, +description, +stage_name, +api_id +FROM aws.apigatewayv2.deployments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual deployment. +```sql +SELECT +region, +deployment_id, +description, +stage_name, +api_id +FROM aws.apigatewayv2.deployments +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new deployment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.deployments ( + ApiId, + region +) +SELECT +'{{ ApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.deployments ( + Description, + StageName, + ApiId, + region +) +SELECT + '{{ Description }}', + '{{ StageName }}', + '{{ ApiId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: deployment + props: + - name: Description + value: '{{ Description }}' + - name: StageName + value: '{{ StageName }}' + - name: ApiId + value: '{{ ApiId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.deployments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigatewayv2/deployments_list_only/index.md b/website/docs/services/apigatewayv2/deployments_list_only/index.md new file mode 100644 index 0000000..56259fe --- /dev/null +++ b/website/docs/services/apigatewayv2/deployments_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: deployments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_list_only + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployments in a region or regions, for all properties use deployments + +## Overview + + + + + + + +
Namedeployments_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Deployment resource creates a deployment for an API.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe API identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployments in a region. +```sql +SELECT +region, +api_id, +deployment_id +FROM aws.apigatewayv2.deployments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployments_list_only resource, see deployments + diff --git a/website/docs/services/apigatewayv2/domain_name_tags/index.md b/website/docs/services/apigatewayv2/domain_name_tags/index.md new file mode 100644 index 0000000..3347266 --- /dev/null +++ b/website/docs/services/apigatewayv2/domain_name_tags/index.md @@ -0,0 +1,85 @@ +--- +title: domain_name_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_tags + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domain_names in a region + +## Overview + + + + + + + +
Namedomain_name_tags
TypeResource
DescriptionThe AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).
You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThe mutual TLS authentication configuration for a custom domain name.
string
string
stringThe custom domain name for your API in Amazon API Gateway. Uppercase letters and the underscore (_) character are not supported.
arrayThe domain name configurations.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domain_names in a region. +```sql +SELECT +region, +mutual_tls_authentication, +regional_hosted_zone_id, +regional_domain_name, +domain_name, +domain_name_configurations, +tag_key, +tag_value +FROM aws.apigatewayv2.domain_name_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_name_tags resource, see domain_names + diff --git a/website/docs/services/apigatewayv2/domain_names/index.md b/website/docs/services/apigatewayv2/domain_names/index.md new file mode 100644 index 0000000..3ff7700 --- /dev/null +++ b/website/docs/services/apigatewayv2/domain_names/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain_name resource or lists 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).
You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectThe mutual TLS authentication configuration for a custom domain name.
string
string
stringThe custom domain name for your API in Amazon API Gateway. Uppercase letters and the underscore (_) character are not supported.
arrayThe domain name configurations.
objectThe collection of tags associated with a domain name.
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::DomainName. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domain_names in a region. +```sql +SELECT +region, +mutual_tls_authentication, +regional_hosted_zone_id, +regional_domain_name, +domain_name, +domain_name_configurations, +tags +FROM aws.apigatewayv2.domain_names +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain_name. +```sql +SELECT +region, +mutual_tls_authentication, +regional_hosted_zone_id, +regional_domain_name, +domain_name, +domain_name_configurations, +tags +FROM aws.apigatewayv2.domain_names +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain_name resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.domain_names ( + DomainName, + region +) +SELECT +'{{ DomainName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.domain_names ( + MutualTlsAuthentication, + DomainName, + DomainNameConfigurations, + Tags, + region +) +SELECT + '{{ MutualTlsAuthentication }}', + '{{ DomainName }}', + '{{ DomainNameConfigurations }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain_name + props: + - name: MutualTlsAuthentication + value: + TruststoreVersion: '{{ TruststoreVersion }}' + TruststoreUri: '{{ TruststoreUri }}' + - name: DomainName + value: '{{ DomainName }}' + - name: DomainNameConfigurations + value: + - OwnershipVerificationCertificateArn: '{{ OwnershipVerificationCertificateArn }}' + EndpointType: '{{ EndpointType }}' + CertificateName: '{{ CertificateName }}' + SecurityPolicy: '{{ SecurityPolicy }}' + CertificateArn: '{{ CertificateArn }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.domain_names +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigatewayv2/domain_names_list_only/index.md b/website/docs/services/apigatewayv2/domain_names_list_only/index.md new file mode 100644 index 0000000..d8409b5 --- /dev/null +++ b/website/docs/services/apigatewayv2/domain_names_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domain_names_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domain_names_list_only + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domain_names in a region or regions, for all properties use domain_names + +## Overview + + + + + + + +
Namedomain_names_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).
You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe custom domain name for your API in Amazon API Gateway. Uppercase letters and the underscore (_) character are not supported.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domain_names in a region. +```sql +SELECT +region, +domain_name +FROM aws.apigatewayv2.domain_names_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_names_list_only resource, see domain_names + diff --git a/website/docs/services/apigatewayv2/index.md b/website/docs/services/apigatewayv2/index.md new file mode 100644 index 0000000..bf9f619 --- /dev/null +++ b/website/docs/services/apigatewayv2/index.md @@ -0,0 +1,60 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The apigatewayv2 service documentation. + +:::info Service Summary + +
+
+total resources: 25
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/apigatewayv2/integration_responses/index.md b/website/docs/services/apigatewayv2/integration_responses/index.md new file mode 100644 index 0000000..d902c6f --- /dev/null +++ b/website/docs/services/apigatewayv2/integration_responses/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an integration_response resource or lists 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*.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
objectThe collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
stringThe template selection expression for the integration response. Supported only for WebSocket APIs.
objectA key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
stringSupported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
stringThe integration ID.
stringThe integration response key.
stringThe API identifier.
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::IntegrationResponse. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all integration_responses in a region. +```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_responses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual integration_response. +```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_responses +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new integration_response resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.integration_responses ( + IntegrationId, + IntegrationResponseKey, + ApiId, + region +) +SELECT +'{{ IntegrationId }}', + '{{ IntegrationResponseKey }}', + '{{ ApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.integration_responses ( + ResponseTemplates, + TemplateSelectionExpression, + ResponseParameters, + ContentHandlingStrategy, + IntegrationId, + IntegrationResponseKey, + ApiId, + region +) +SELECT + '{{ ResponseTemplates }}', + '{{ TemplateSelectionExpression }}', + '{{ ResponseParameters }}', + '{{ ContentHandlingStrategy }}', + '{{ IntegrationId }}', + '{{ IntegrationResponseKey }}', + '{{ ApiId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: integration_response + props: + - name: ResponseTemplates + value: {} + - name: TemplateSelectionExpression + value: '{{ TemplateSelectionExpression }}' + - name: ResponseParameters + value: {} + - name: ContentHandlingStrategy + value: '{{ ContentHandlingStrategy }}' + - name: IntegrationId + value: '{{ IntegrationId }}' + - name: IntegrationResponseKey + value: '{{ IntegrationResponseKey }}' + - name: ApiId + value: '{{ ApiId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.integration_responses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the integration_responses resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:PATCH, +apigateway:PUT, +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigatewayv2/integration_responses_list_only/index.md b/website/docs/services/apigatewayv2/integration_responses_list_only/index.md new file mode 100644 index 0000000..04afa54 --- /dev/null +++ b/website/docs/services/apigatewayv2/integration_responses_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: integration_responses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integration_responses_list_only + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integration_responses in a region or regions, for all properties use integration_responses + +## Overview + + + + + + + +
Nameintegration_responses_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringThe integration ID.
stringThe API identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integration_responses in a region. +```sql +SELECT +region, +api_id, +integration_id, +integration_response_id +FROM aws.apigatewayv2.integration_responses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integration_responses_list_only resource, see integration_responses + diff --git a/website/docs/services/apigatewayv2/integrations/index.md b/website/docs/services/apigatewayv2/integrations/index.md new file mode 100644 index 0000000..f736ecd --- /dev/null +++ b/website/docs/services/apigatewayv2/integrations/index.md @@ -0,0 +1,322 @@ +--- +title: integrations +hide_title: false +hide_table_of_contents: false +keywords: + - integrations + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an integration resource or lists integrations in a region + +## Overview + + + + + + + +
Nameintegrations
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe API identifier.
stringThe ID of the VPC link for a private integration. Supported only for HTTP APIs.
stringThe type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
stringSupported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT.
stringSpecifies the credentials required for the integration, if any. For AWS integrations, 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 the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter.
stringThe description of the integration.
stringSpecifies the integration's HTTP method type.
stringSupported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.
stringThe integration ID.
stringThe integration type of an integration.
stringFor a Lambda integration, specify the URI of a Lambda function. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service.
stringSpecifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
stringSpecifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 For all other integrations, 1.0 is the only supported value.
objectA key-value map specifying parameters.
objectA map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
objectParameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.
stringThe template selection expression for the integration. Supported only for WebSocket APIs.
integerCustom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
objectThe TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::Integration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all integrations in a region. +```sql +SELECT +region, +api_id, +connection_id, +connection_type, +content_handling_strategy, +credentials_arn, +description, +integration_method, +integration_subtype, +integration_id, +integration_type, +integration_uri, +passthrough_behavior, +payload_format_version, +request_parameters, +request_templates, +response_parameters, +template_selection_expression, +timeout_in_millis, +tls_config +FROM aws.apigatewayv2.integrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual integration. +```sql +SELECT +region, +api_id, +connection_id, +connection_type, +content_handling_strategy, +credentials_arn, +description, +integration_method, +integration_subtype, +integration_id, +integration_type, +integration_uri, +passthrough_behavior, +payload_format_version, +request_parameters, +request_templates, +response_parameters, +template_selection_expression, +timeout_in_millis, +tls_config +FROM aws.apigatewayv2.integrations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.integrations ( + ApiId, + IntegrationType, + region +) +SELECT +'{{ ApiId }}', + '{{ IntegrationType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.integrations ( + ApiId, + ConnectionId, + ConnectionType, + ContentHandlingStrategy, + CredentialsArn, + Description, + IntegrationMethod, + IntegrationSubtype, + IntegrationType, + IntegrationUri, + PassthroughBehavior, + PayloadFormatVersion, + RequestParameters, + RequestTemplates, + ResponseParameters, + TemplateSelectionExpression, + TimeoutInMillis, + TlsConfig, + region +) +SELECT + '{{ ApiId }}', + '{{ ConnectionId }}', + '{{ ConnectionType }}', + '{{ ContentHandlingStrategy }}', + '{{ CredentialsArn }}', + '{{ Description }}', + '{{ IntegrationMethod }}', + '{{ IntegrationSubtype }}', + '{{ IntegrationType }}', + '{{ IntegrationUri }}', + '{{ PassthroughBehavior }}', + '{{ PayloadFormatVersion }}', + '{{ RequestParameters }}', + '{{ RequestTemplates }}', + '{{ ResponseParameters }}', + '{{ TemplateSelectionExpression }}', + '{{ TimeoutInMillis }}', + '{{ TlsConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: integration + props: + - name: ApiId + value: '{{ ApiId }}' + - name: ConnectionId + value: '{{ ConnectionId }}' + - name: ConnectionType + value: '{{ ConnectionType }}' + - name: ContentHandlingStrategy + value: '{{ ContentHandlingStrategy }}' + - name: CredentialsArn + value: '{{ CredentialsArn }}' + - name: Description + value: '{{ Description }}' + - name: IntegrationMethod + value: '{{ IntegrationMethod }}' + - name: IntegrationSubtype + value: '{{ IntegrationSubtype }}' + - name: IntegrationType + value: '{{ IntegrationType }}' + - name: IntegrationUri + value: '{{ IntegrationUri }}' + - name: PassthroughBehavior + value: '{{ PassthroughBehavior }}' + - name: PayloadFormatVersion + value: '{{ PayloadFormatVersion }}' + - name: RequestParameters + value: {} + - name: RequestTemplates + value: {} + - name: ResponseParameters + value: {} + - name: TemplateSelectionExpression + value: '{{ TemplateSelectionExpression }}' + - name: TimeoutInMillis + value: '{{ TimeoutInMillis }}' + - name: TlsConfig + value: + ServerNameToVerify: '{{ ServerNameToVerify }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.integrations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the integrations resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigatewayv2/integrations_list_only/index.md b/website/docs/services/apigatewayv2/integrations_list_only/index.md new file mode 100644 index 0000000..6d95d91 --- /dev/null +++ b/website/docs/services/apigatewayv2/integrations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integrations_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integrations in a region or regions, for all properties use integrations + +## Overview + + + + + + + +
Nameintegrations_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe API identifier.
stringThe integration ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integrations in a region. +```sql +SELECT +region, +api_id, +integration_id +FROM aws.apigatewayv2.integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integrations_list_only resource, see integrations + diff --git a/website/docs/services/apigatewayv2/models/index.md b/website/docs/services/apigatewayv2/models/index.md new file mode 100644 index 0000000..716d484 --- /dev/null +++ b/website/docs/services/apigatewayv2/models/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a model resource or lists 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*.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringThe description of the model.
stringThe content-type for the model, for example, "application/json".
objectThe schema for the model. For application/json models, this should be JSON schema draft 4 model.
stringThe API identifier.
stringThe name of the model.
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::Model. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all models in a region. +```sql +SELECT +region, +model_id, +description, +content_type, +schema, +api_id, +name +FROM aws.apigatewayv2.models +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual model. +```sql +SELECT +region, +model_id, +description, +content_type, +schema, +api_id, +name +FROM aws.apigatewayv2.models +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.models ( + Schema, + ApiId, + Name, + region +) +SELECT +'{{ Schema }}', + '{{ ApiId }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.models ( + Description, + ContentType, + Schema, + ApiId, + Name, + region +) +SELECT + '{{ Description }}', + '{{ ContentType }}', + '{{ Schema }}', + '{{ ApiId }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: model + props: + - name: Description + value: '{{ Description }}' + - name: ContentType + value: '{{ ContentType }}' + - name: Schema + value: {} + - name: ApiId + value: '{{ ApiId }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.models +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the models resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigatewayv2/models_list_only/index.md b/website/docs/services/apigatewayv2/models_list_only/index.md new file mode 100644 index 0000000..8be86e3 --- /dev/null +++ b/website/docs/services/apigatewayv2/models_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: models_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - models_list_only + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists models in a region or regions, for all properties use models + +## Overview + + + + + + + +
Namemodels_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Model resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe API identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all models in a region. +```sql +SELECT +region, +api_id, +model_id +FROM aws.apigatewayv2.models_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the models_list_only resource, see models + diff --git a/website/docs/services/apigatewayv2/route_responses/index.md b/website/docs/services/apigatewayv2/route_responses/index.md new file mode 100644 index 0000000..691d359 --- /dev/null +++ b/website/docs/services/apigatewayv2/route_responses/index.md @@ -0,0 +1,239 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a route_response resource or lists 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*.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe route response key.
undefinedThe route response parameters.
stringThe route ID.
stringThe model selection expression for the route response. Supported only for WebSocket APIs.
stringThe API identifier.
objectThe response models for the route response.
string
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::RouteResponse. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all route_responses in a region. +```sql +SELECT +region, +route_response_key, +response_parameters, +route_id, +model_selection_expression, +api_id, +response_models, +route_response_id +FROM aws.apigatewayv2.route_responses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual route_response. +```sql +SELECT +region, +route_response_key, +response_parameters, +route_id, +model_selection_expression, +api_id, +response_models, +route_response_id +FROM aws.apigatewayv2.route_responses +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new route_response resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.route_responses ( + RouteResponseKey, + RouteId, + ApiId, + region +) +SELECT +'{{ RouteResponseKey }}', + '{{ RouteId }}', + '{{ ApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.route_responses ( + RouteResponseKey, + ResponseParameters, + RouteId, + ModelSelectionExpression, + ApiId, + ResponseModels, + region +) +SELECT + '{{ RouteResponseKey }}', + '{{ ResponseParameters }}', + '{{ RouteId }}', + '{{ ModelSelectionExpression }}', + '{{ ApiId }}', + '{{ ResponseModels }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: route_response + props: + - name: RouteResponseKey + value: '{{ RouteResponseKey }}' + - name: ResponseParameters + value: null + - name: RouteId + value: '{{ RouteId }}' + - name: ModelSelectionExpression + value: '{{ ModelSelectionExpression }}' + - name: ApiId + value: '{{ ApiId }}' + - name: ResponseModels + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.route_responses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the route_responses resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigatewayv2/route_responses_list_only/index.md b/website/docs/services/apigatewayv2/route_responses_list_only/index.md new file mode 100644 index 0000000..82c5ef1 --- /dev/null +++ b/website/docs/services/apigatewayv2/route_responses_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: route_responses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - route_responses_list_only + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists route_responses in a region or regions, for all properties use route_responses + +## Overview + + + + + + + +
Nameroute_responses_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe route ID.
stringThe API identifier.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all route_responses in a region. +```sql +SELECT +region, +api_id, +route_id, +route_response_id +FROM aws.apigatewayv2.route_responses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_responses_list_only resource, see route_responses + diff --git a/website/docs/services/apigatewayv2/routes/index.md b/website/docs/services/apigatewayv2/routes/index.md new file mode 100644 index 0000000..ae8569c --- /dev/null +++ b/website/docs/services/apigatewayv2/routes/index.md @@ -0,0 +1,280 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a route resource or lists routes in a region + +## Overview + + + + + + + +
Nameroutes
TypeResource
DescriptionThe AWS::ApiGatewayV2::Route resource creates a route for an API.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe route response selection expression for the route. Supported only for WebSocket APIs.
objectThe request models for the route. Supported only for WebSocket APIs.
stringThe operation name for the route.
arrayThe authorization scopes supported by this route.
booleanSpecifies whether an API key is required for the route. Supported only for WebSocket APIs.
stringThe route key for the route. For HTTP APIs, the route key can be either $default, or a combination of an HTTP method and resource path, for example, GET /pets.
stringThe authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
stringThe model selection expression for the route. Supported only for WebSocket APIs.
stringThe API identifier.
objectThe request parameters for the route. Supported only for WebSocket APIs.
stringThe target for the route.
stringThe identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::Route. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all routes in a region. +```sql +SELECT +region, +route_id, +route_response_selection_expression, +request_models, +operation_name, +authorization_scopes, +api_key_required, +route_key, +authorization_type, +model_selection_expression, +api_id, +request_parameters, +target, +authorizer_id +FROM aws.apigatewayv2.routes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual route. +```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.routes +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.routes ( + RouteKey, + ApiId, + region +) +SELECT +'{{ RouteKey }}', + '{{ ApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.routes ( + RouteResponseSelectionExpression, + RequestModels, + OperationName, + AuthorizationScopes, + ApiKeyRequired, + RouteKey, + AuthorizationType, + ModelSelectionExpression, + ApiId, + RequestParameters, + Target, + AuthorizerId, + region +) +SELECT + '{{ RouteResponseSelectionExpression }}', + '{{ RequestModels }}', + '{{ OperationName }}', + '{{ AuthorizationScopes }}', + '{{ ApiKeyRequired }}', + '{{ RouteKey }}', + '{{ AuthorizationType }}', + '{{ ModelSelectionExpression }}', + '{{ ApiId }}', + '{{ RequestParameters }}', + '{{ Target }}', + '{{ AuthorizerId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: route + props: + - name: RouteResponseSelectionExpression + value: '{{ RouteResponseSelectionExpression }}' + - name: RequestModels + value: {} + - name: OperationName + value: '{{ OperationName }}' + - name: AuthorizationScopes + value: + - '{{ AuthorizationScopes[0] }}' + - name: ApiKeyRequired + value: '{{ ApiKeyRequired }}' + - name: RouteKey + value: '{{ RouteKey }}' + - name: AuthorizationType + value: '{{ AuthorizationType }}' + - name: ModelSelectionExpression + value: '{{ ModelSelectionExpression }}' + - name: ApiId + value: '{{ ApiId }}' + - name: RequestParameters + value: {} + - name: Target + value: '{{ Target }}' + - name: AuthorizerId + value: '{{ AuthorizerId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.routes +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the routes resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + +### List +```json +apigateway:GET +``` diff --git a/website/docs/services/apigatewayv2/routes_list_only/index.md b/website/docs/services/apigatewayv2/routes_list_only/index.md new file mode 100644 index 0000000..fb4bb10 --- /dev/null +++ b/website/docs/services/apigatewayv2/routes_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - routes_list_only + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists routes in a region or regions, for all properties use routes + +## Overview + + + + + + + +
Nameroutes_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Route resource creates a route for an API.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe API identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all routes in a region. +```sql +SELECT +region, +api_id, +route_id +FROM aws.apigatewayv2.routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routes_list_only resource, see routes + diff --git a/website/docs/services/apigatewayv2/vpc_link_tags/index.md b/website/docs/services/apigatewayv2/vpc_link_tags/index.md new file mode 100644 index 0000000..c448518 --- /dev/null +++ b/website/docs/services/apigatewayv2/vpc_link_tags/index.md @@ -0,0 +1,83 @@ +--- +title: vpc_link_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_link_tags + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_links in a region + +## Overview + + + + + + + +
Namevpc_link_tags
TypeResource
DescriptionThe AWS::ApiGatewayV2::VpcLink resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from PENDING to AVAILABLE to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
arrayA list of subnet IDs to include in the VPC link.
arrayA list of security group IDs for the VPC link.
stringThe name of the VPC link.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_links in a region. +```sql +SELECT +region, +vpc_link_id, +subnet_ids, +security_group_ids, +name, +tag_key, +tag_value +FROM aws.apigatewayv2.vpc_link_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_link_tags resource, see vpc_links + diff --git a/website/docs/services/apigatewayv2/vpc_links/index.md b/website/docs/services/apigatewayv2/vpc_links/index.md new file mode 100644 index 0000000..5d19afe --- /dev/null +++ b/website/docs/services/apigatewayv2/vpc_links/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_link resource or lists 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*.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
arrayA list of subnet IDs to include in the VPC link.
arrayA list of security group IDs for the VPC link.
objectThe collection of tags. Each tag element is associated with a given resource.
stringThe name of the VPC link.
stringAWS region.
+ +For more information, see AWS::ApiGatewayV2::VpcLink. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_links in a region. +```sql +SELECT +region, +vpc_link_id, +subnet_ids, +security_group_ids, +tags, +name +FROM aws.apigatewayv2.vpc_links +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_link. +```sql +SELECT +region, +vpc_link_id, +subnet_ids, +security_group_ids, +tags, +name +FROM aws.apigatewayv2.vpc_links +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_link resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.vpc_links ( + SubnetIds, + Name, + region +) +SELECT +'{{ SubnetIds }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apigatewayv2.vpc_links ( + SubnetIds, + SecurityGroupIds, + Tags, + Name, + region +) +SELECT + '{{ SubnetIds }}', + '{{ SecurityGroupIds }}', + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_link + props: + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: Tags + value: {} + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apigatewayv2.vpc_links +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +apigateway:GET, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` diff --git a/website/docs/services/apigatewayv2/vpc_links_list_only/index.md b/website/docs/services/apigatewayv2/vpc_links_list_only/index.md new file mode 100644 index 0000000..4ade1a2 --- /dev/null +++ b/website/docs/services/apigatewayv2/vpc_links_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_links_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_links_list_only + - apigatewayv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_links in a region or regions, for all properties use vpc_links + +## Overview + + + + + + + +
Namevpc_links_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::VpcLink resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from PENDING to AVAILABLE to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_links in a region. +```sql +SELECT +region, +vpc_link_id +FROM aws.apigatewayv2.vpc_links_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_links_list_only resource, see vpc_links + diff --git a/website/docs/services/appconfig/application_tags/index.md b/website/docs/services/appconfig/application_tags/index.md new file mode 100644 index 0000000..c627874 --- /dev/null +++ b/website/docs/services/appconfig/application_tags/index.md @@ -0,0 +1,81 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Application
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringA description of the application.
stringThe application Id
stringA name for the application.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +description, +application_id, +name, +tag_key, +tag_value +FROM aws.appconfig.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/appconfig/applications/index.md b/website/docs/services/appconfig/applications/index.md new file mode 100644 index 0000000..f7c55c3 --- /dev/null +++ b/website/docs/services/appconfig/applications/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Application
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringA description of the application.
stringThe application Id
arrayMetadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
stringA name for the application.
stringAWS region.
+ +For more information, see AWS::AppConfig::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +description, +application_id, +tags, +name +FROM aws.appconfig.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +description, +application_id, +tags, +name +FROM aws.appconfig.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.applications ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.applications ( + Description, + Tags, + Name, + region +) +SELECT + '{{ Description }}', + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appconfig.applications +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +appconfig:GetApplication, +appconfig:ListTagsForResource +``` + +### Update +```json +appconfig:UpdateApplication, +appconfig:TagResource, +appconfig:UntagResource +``` + +### Delete +```json +appconfig:GetApplication, +appconfig:DeleteApplication +``` + +### List +```json +appconfig:ListApplications +``` diff --git a/website/docs/services/appconfig/applications_list_only/index.md b/website/docs/services/appconfig/applications_list_only/index.md new file mode 100644 index 0000000..ebcb665 --- /dev/null +++ b/website/docs/services/appconfig/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe application Id
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_id +FROM aws.appconfig.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/appconfig/configuration_profile_tags/index.md b/website/docs/services/appconfig/configuration_profile_tags/index.md new file mode 100644 index 0000000..2c778bd --- /dev/null +++ b/website/docs/services/appconfig/configuration_profile_tags/index.md @@ -0,0 +1,97 @@ +--- +title: configuration_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_profile_tags + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configuration_profiles in a region + +## Overview + + + + + + + +
Nameconfiguration_profile_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe configuration profile ID
stringA URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object.
stringThe type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
stringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
stringA description of the configuration profile.
stringThe Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
arrayA list of methods for validating the configuration.
stringThe ARN of an IAM role with permission to access the configuration at the specified LocationUri.
stringOn resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
stringThe application ID.
stringA name for the configuration profile.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configuration_profiles in a region. +```sql +SELECT +region, +configuration_profile_id, +location_uri, +type, +kms_key_identifier, +description, +kms_key_arn, +validators, +retrieval_role_arn, +deletion_protection_check, +application_id, +name, +tag_key, +tag_value +FROM aws.appconfig.configuration_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_profile_tags resource, see configuration_profiles + diff --git a/website/docs/services/appconfig/configuration_profiles/index.md b/website/docs/services/appconfig/configuration_profiles/index.md new file mode 100644 index 0000000..38f198b --- /dev/null +++ b/website/docs/services/appconfig/configuration_profiles/index.md @@ -0,0 +1,279 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configuration_profile resource or lists configuration_profiles in a region + +## Overview + + + + + + + +
Nameconfiguration_profiles
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe configuration profile ID
stringA URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object.
stringThe type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
stringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
stringA description of the configuration profile.
stringThe Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
arrayA list of methods for validating the configuration.
stringThe ARN of an IAM role with permission to access the configuration at the specified LocationUri.
stringOn resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
stringThe application ID.
arrayMetadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
stringA name for the configuration profile.
stringAWS region.
+ +For more information, see AWS::AppConfig::ConfigurationProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configuration_profiles in a region. +```sql +SELECT +region, +configuration_profile_id, +location_uri, +type, +kms_key_identifier, +description, +kms_key_arn, +validators, +retrieval_role_arn, +deletion_protection_check, +application_id, +tags, +name +FROM aws.appconfig.configuration_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual configuration_profile. +```sql +SELECT +region, +configuration_profile_id, +location_uri, +type, +kms_key_identifier, +description, +kms_key_arn, +validators, +retrieval_role_arn, +deletion_protection_check, +application_id, +tags, +name +FROM aws.appconfig.configuration_profiles +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configuration_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.configuration_profiles ( + LocationUri, + ApplicationId, + Name, + region +) +SELECT +'{{ LocationUri }}', + '{{ ApplicationId }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.configuration_profiles ( + LocationUri, + Type, + KmsKeyIdentifier, + Description, + Validators, + RetrievalRoleArn, + DeletionProtectionCheck, + ApplicationId, + Tags, + Name, + region +) +SELECT + '{{ LocationUri }}', + '{{ Type }}', + '{{ KmsKeyIdentifier }}', + '{{ Description }}', + '{{ Validators }}', + '{{ RetrievalRoleArn }}', + '{{ DeletionProtectionCheck }}', + '{{ ApplicationId }}', + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configuration_profile + props: + - name: LocationUri + value: '{{ LocationUri }}' + - name: Type + value: '{{ Type }}' + - name: KmsKeyIdentifier + value: '{{ KmsKeyIdentifier }}' + - name: Description + value: '{{ Description }}' + - name: Validators + value: + - Type: '{{ Type }}' + Content: '{{ Content }}' + - name: RetrievalRoleArn + value: '{{ RetrievalRoleArn }}' + - name: DeletionProtectionCheck + value: '{{ DeletionProtectionCheck }}' + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appconfig.configuration_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the configuration_profiles resource, the following permissions are required: + +### Read +```json +appconfig:GetConfigurationProfile, +appconfig:ListTagsForResource +``` + +### Create +```json +appconfig:CreateConfigurationProfile, +appconfig:GetConfigurationProfile, +appconfig:TagResource, +appconfig:ListTagsForResource, +iam:PassRole +``` + +### Update +```json +appconfig:UpdateConfigurationProfile, +appconfig:TagResource, +appconfig:UntagResource, +iam:PassRole +``` + +### List +```json +appconfig:ListConfigurationProfiles +``` + +### Delete +```json +appconfig:DeleteConfigurationProfile +``` diff --git a/website/docs/services/appconfig/configuration_profiles_list_only/index.md b/website/docs/services/appconfig/configuration_profiles_list_only/index.md new file mode 100644 index 0000000..69359e4 --- /dev/null +++ b/website/docs/services/appconfig/configuration_profiles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: configuration_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_profiles_list_only + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_profiles in a region or regions, for all properties use configuration_profiles + +## Overview + + + + + + + +
Nameconfiguration_profiles_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe configuration profile ID
stringThe application ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_profiles in a region. +```sql +SELECT +region, +application_id, +configuration_profile_id +FROM aws.appconfig.configuration_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_profiles_list_only resource, see configuration_profiles + diff --git a/website/docs/services/appconfig/deployment_strategies/index.md b/website/docs/services/appconfig/deployment_strategies/index.md new file mode 100644 index 0000000..c9b3c58 --- /dev/null +++ b/website/docs/services/appconfig/deployment_strategies/index.md @@ -0,0 +1,258 @@ +--- +title: deployment_strategies +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_strategies + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a deployment_strategy resource or lists deployment_strategies in a region + +## Overview + + + + + + + +
Namedeployment_strategies
TypeResource
DescriptionResource Type definition for AWS::AppConfig::DeploymentStrategy
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
numberTotal amount of time for a deployment to last.
stringA description of the deployment strategy.
numberSpecifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AWS AppConfig rolls back the deployment. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AWS AppConfig User Guide.
numberThe percentage of targets to receive a deployed configuration during each interval.
stringThe algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:
Linear: For this type, AWS AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.
Exponential: For this type, AWS AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:
2*(2^0)
2*(2^1)
2*(2^2)
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
stringA name for the deployment strategy.
stringSave the deployment strategy to a Systems Manager (SSM) document.
arrayAssigns metadata to an AWS AppConfig resource. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
stringThe deployment strategy ID.
stringAWS region.
+ +For more information, see AWS::AppConfig::DeploymentStrategy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all deployment_strategies in a region. +```sql +SELECT +region, +deployment_duration_in_minutes, +description, +final_bake_time_in_minutes, +growth_factor, +growth_type, +name, +replicate_to, +tags, +id +FROM aws.appconfig.deployment_strategies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual deployment_strategy. +```sql +SELECT +region, +deployment_duration_in_minutes, +description, +final_bake_time_in_minutes, +growth_factor, +growth_type, +name, +replicate_to, +tags, +id +FROM aws.appconfig.deployment_strategies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new deployment_strategy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.deployment_strategies ( + DeploymentDurationInMinutes, + GrowthFactor, + Name, + ReplicateTo, + region +) +SELECT +'{{ DeploymentDurationInMinutes }}', + '{{ GrowthFactor }}', + '{{ Name }}', + '{{ ReplicateTo }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.deployment_strategies ( + DeploymentDurationInMinutes, + Description, + FinalBakeTimeInMinutes, + GrowthFactor, + GrowthType, + Name, + ReplicateTo, + Tags, + region +) +SELECT + '{{ DeploymentDurationInMinutes }}', + '{{ Description }}', + '{{ FinalBakeTimeInMinutes }}', + '{{ GrowthFactor }}', + '{{ GrowthType }}', + '{{ Name }}', + '{{ ReplicateTo }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: deployment_strategy + props: + - name: DeploymentDurationInMinutes + value: null + - name: Description + value: '{{ Description }}' + - name: FinalBakeTimeInMinutes + value: null + - name: GrowthFactor + value: null + - name: GrowthType + value: '{{ GrowthType }}' + - name: Name + value: '{{ Name }}' + - name: ReplicateTo + value: '{{ ReplicateTo }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appconfig.deployment_strategies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the deployment_strategies resource, the following permissions are required: + +### Create +```json +appconfig:CreateDeploymentStrategy, +appconfig:TagResource +``` + +### Read +```json +appconfig:GetDeploymentStrategy, +appconfig:ListTagsForResource +``` + +### Update +```json +appconfig:UpdateDeploymentStrategy, +appconfig:TagResource, +appconfig:UntagResource +``` + +### Delete +```json +appconfig:DeleteDeploymentStrategy +``` + +### List +```json +appconfig:ListDeploymentStrategies +``` diff --git a/website/docs/services/appconfig/deployment_strategies_list_only/index.md b/website/docs/services/appconfig/deployment_strategies_list_only/index.md new file mode 100644 index 0000000..6808cb5 --- /dev/null +++ b/website/docs/services/appconfig/deployment_strategies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: deployment_strategies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_strategies_list_only + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployment_strategies in a region or regions, for all properties use deployment_strategies + +## Overview + + + + + + + +
Namedeployment_strategies_list_only
TypeResource
DescriptionResource Type definition for AWS::AppConfig::DeploymentStrategy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe deployment strategy ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployment_strategies in a region. +```sql +SELECT +region, +id +FROM aws.appconfig.deployment_strategies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployment_strategies_list_only resource, see deployment_strategies + diff --git a/website/docs/services/appconfig/deployment_strategy_tags/index.md b/website/docs/services/appconfig/deployment_strategy_tags/index.md new file mode 100644 index 0000000..a579314 --- /dev/null +++ b/website/docs/services/appconfig/deployment_strategy_tags/index.md @@ -0,0 +1,91 @@ +--- +title: deployment_strategy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_strategy_tags + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for deployment_strategies in a region + +## Overview + + + + + + + +
Namedeployment_strategy_tags
TypeResource
DescriptionResource Type definition for AWS::AppConfig::DeploymentStrategy
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
numberTotal amount of time for a deployment to last.
stringA description of the deployment strategy.
numberSpecifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AWS AppConfig rolls back the deployment. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AWS AppConfig User Guide.
numberThe percentage of targets to receive a deployed configuration during each interval.
stringThe algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:
Linear: For this type, AWS AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.
Exponential: For this type, AWS AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:
2*(2^0)
2*(2^1)
2*(2^2)
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
stringA name for the deployment strategy.
stringSave the deployment strategy to a Systems Manager (SSM) document.
stringThe deployment strategy ID.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all deployment_strategies in a region. +```sql +SELECT +region, +deployment_duration_in_minutes, +description, +final_bake_time_in_minutes, +growth_factor, +growth_type, +name, +replicate_to, +id, +tag_key, +tag_value +FROM aws.appconfig.deployment_strategy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployment_strategy_tags resource, see deployment_strategies + diff --git a/website/docs/services/appconfig/deployment_tags/index.md b/website/docs/services/appconfig/deployment_tags/index.md new file mode 100644 index 0000000..2eab9ae --- /dev/null +++ b/website/docs/services/appconfig/deployment_tags/index.md @@ -0,0 +1,93 @@ +--- +title: deployment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_tags + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for deployments in a region + +## Overview + + + + + + + +
Namedeployment_tags
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Deployment
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe deployment strategy ID.
stringThe configuration profile ID.
stringThe environment ID.
stringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
stringA description of the deployment.
stringThe configuration version to deploy. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.
stringThe sequence number of the deployment.
stringThe application ID.
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all deployments in a region. +```sql +SELECT +region, +deployment_strategy_id, +configuration_profile_id, +environment_id, +kms_key_identifier, +description, +configuration_version, +deployment_number, +application_id, +dynamic_extension_parameters, +tag_key, +tag_value +FROM aws.appconfig.deployment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployment_tags resource, see deployments + diff --git a/website/docs/services/appconfig/deployments/index.md b/website/docs/services/appconfig/deployments/index.md new file mode 100644 index 0000000..df314dc --- /dev/null +++ b/website/docs/services/appconfig/deployments/index.md @@ -0,0 +1,261 @@ +--- +title: deployments +hide_title: false +hide_table_of_contents: false +keywords: + - deployments + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a deployment resource or lists deployments in a region + +## Overview + + + + + + + +
Namedeployments
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Deployment
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe deployment strategy ID.
stringThe configuration profile ID.
stringThe environment ID.
stringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
stringA description of the deployment.
stringThe configuration version to deploy. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.
stringThe sequence number of the deployment.
stringThe application ID.
array
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::AppConfig::Deployment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all deployments in a region. +```sql +SELECT +region, +deployment_strategy_id, +configuration_profile_id, +environment_id, +kms_key_identifier, +description, +configuration_version, +deployment_number, +application_id, +dynamic_extension_parameters, +tags +FROM aws.appconfig.deployments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual deployment. +```sql +SELECT +region, +deployment_strategy_id, +configuration_profile_id, +environment_id, +kms_key_identifier, +description, +configuration_version, +deployment_number, +application_id, +dynamic_extension_parameters, +tags +FROM aws.appconfig.deployments +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new deployment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.deployments ( + DeploymentStrategyId, + ConfigurationProfileId, + EnvironmentId, + ConfigurationVersion, + ApplicationId, + region +) +SELECT +'{{ DeploymentStrategyId }}', + '{{ ConfigurationProfileId }}', + '{{ EnvironmentId }}', + '{{ ConfigurationVersion }}', + '{{ ApplicationId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.deployments ( + DeploymentStrategyId, + ConfigurationProfileId, + EnvironmentId, + KmsKeyIdentifier, + Description, + ConfigurationVersion, + ApplicationId, + DynamicExtensionParameters, + Tags, + region +) +SELECT + '{{ DeploymentStrategyId }}', + '{{ ConfigurationProfileId }}', + '{{ EnvironmentId }}', + '{{ KmsKeyIdentifier }}', + '{{ Description }}', + '{{ ConfigurationVersion }}', + '{{ ApplicationId }}', + '{{ DynamicExtensionParameters }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: deployment + props: + - name: DeploymentStrategyId + value: '{{ DeploymentStrategyId }}' + - name: ConfigurationProfileId + value: '{{ ConfigurationProfileId }}' + - name: EnvironmentId + value: '{{ EnvironmentId }}' + - name: KmsKeyIdentifier + value: '{{ KmsKeyIdentifier }}' + - name: Description + value: '{{ Description }}' + - name: ConfigurationVersion + value: '{{ ConfigurationVersion }}' + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: DynamicExtensionParameters + value: + - ParameterValue: '{{ ParameterValue }}' + ExtensionReference: '{{ ExtensionReference }}' + ParameterName: '{{ ParameterName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appconfig.deployments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Read +```json +appconfig:GetDeployment, +appconfig:ListTagsForResource +``` + +### Create +```json +appconfig:StartDeployment, +appconfig:GetDeployment, +appconfig:TagResource, +appconfig:ListTagsForResource, +kms:GenerateDataKey +``` + +### List +```json +appconfig:ListDeployments +``` + +### Delete +```json +appconfig:StopDeployment +``` diff --git a/website/docs/services/appconfig/deployments_list_only/index.md b/website/docs/services/appconfig/deployments_list_only/index.md new file mode 100644 index 0000000..0963ca4 --- /dev/null +++ b/website/docs/services/appconfig/deployments_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: deployments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_list_only + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployments in a region or regions, for all properties use deployments + +## Overview + + + + + + + +
Namedeployments_list_only
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Deployment
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe environment ID.
stringThe sequence number of the deployment.
stringThe application ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployments in a region. +```sql +SELECT +region, +application_id, +environment_id, +deployment_number +FROM aws.appconfig.deployments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployments_list_only resource, see deployments + diff --git a/website/docs/services/appconfig/environment_tags/index.md b/website/docs/services/appconfig/environment_tags/index.md new file mode 100644 index 0000000..b23988b --- /dev/null +++ b/website/docs/services/appconfig/environment_tags/index.md @@ -0,0 +1,87 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + + + +
Nameenvironment_tags
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Environment
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe environment ID.
stringA description of the environment.
arrayAmazon CloudWatch alarms to monitor during the deployment process.
stringOn resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
stringThe application ID.
stringA name for the environment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +environment_id, +description, +monitors, +deletion_protection_check, +application_id, +name, +tag_key, +tag_value +FROM aws.appconfig.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + diff --git a/website/docs/services/appconfig/environments/index.md b/website/docs/services/appconfig/environments/index.md new file mode 100644 index 0000000..122935f --- /dev/null +++ b/website/docs/services/appconfig/environments/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment resource or lists environments in a region + +## Overview + + + + + + + +
Nameenvironments
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Environment
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe environment ID.
stringA description of the environment.
arrayAmazon CloudWatch alarms to monitor during the deployment process.
stringOn resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
stringThe application ID.
arrayMetadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
stringA name for the environment.
stringAWS region.
+ +For more information, see AWS::AppConfig::Environment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environments in a region. +```sql +SELECT +region, +environment_id, +description, +monitors, +deletion_protection_check, +application_id, +tags, +name +FROM aws.appconfig.environments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment. +```sql +SELECT +region, +environment_id, +description, +monitors, +deletion_protection_check, +application_id, +tags, +name +FROM aws.appconfig.environments +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.environments ( + ApplicationId, + Name, + region +) +SELECT +'{{ ApplicationId }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.environments ( + Description, + Monitors, + DeletionProtectionCheck, + ApplicationId, + Tags, + Name, + region +) +SELECT + '{{ Description }}', + '{{ Monitors }}', + '{{ DeletionProtectionCheck }}', + '{{ ApplicationId }}', + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment + props: + - name: Description + value: '{{ Description }}' + - name: Monitors + value: + - AlarmArn: '{{ AlarmArn }}' + AlarmRoleArn: '{{ AlarmRoleArn }}' + - name: DeletionProtectionCheck + value: '{{ DeletionProtectionCheck }}' + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appconfig.environments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Read +```json +appconfig:GetEnvironment, +appconfig:ListTagsForResource +``` + +### Create +```json +appconfig:CreateEnvironment, +appconfig:GetEnvironment, +appconfig:ListTagsForResource, +appconfig:TagResource, +iam:PassRole +``` + +### Update +```json +appconfig:UpdateEnvironment, +appconfig:TagResource, +appconfig:UntagResource, +iam:PassRole +``` + +### List +```json +appconfig:ListEnvironments +``` + +### Delete +```json +appconfig:GetEnvironment, +appconfig:DeleteEnvironment +``` diff --git a/website/docs/services/appconfig/environments_list_only/index.md b/website/docs/services/appconfig/environments_list_only/index.md new file mode 100644 index 0000000..d50c2e0 --- /dev/null +++ b/website/docs/services/appconfig/environments_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Environment
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe environment ID.
stringThe application ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +application_id, +environment_id +FROM aws.appconfig.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + diff --git a/website/docs/services/appconfig/extension_association_tags/index.md b/website/docs/services/appconfig/extension_association_tags/index.md new file mode 100644 index 0000000..d46e37e --- /dev/null +++ b/website/docs/services/appconfig/extension_association_tags/index.md @@ -0,0 +1,91 @@ +--- +title: extension_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - extension_association_tags + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for extension_associations in a region + +## Overview + + + + + + + +
Nameextension_association_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
integer
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all extension_associations in a region. +```sql +SELECT +region, +id, +arn, +extension_arn, +resource_arn, +extension_identifier, +resource_identifier, +extension_version_number, +parameters, +tag_key, +tag_value +FROM aws.appconfig.extension_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the extension_association_tags resource, see extension_associations + diff --git a/website/docs/services/appconfig/extension_associations/index.md b/website/docs/services/appconfig/extension_associations/index.md new file mode 100644 index 0000000..746838a --- /dev/null +++ b/website/docs/services/appconfig/extension_associations/index.md @@ -0,0 +1,248 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an extension_association resource or lists extension_associations in a region + +## Overview + + + + + + + +
Nameextension_associations
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
integer
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::AppConfig::ExtensionAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all extension_associations in a region. +```sql +SELECT +region, +id, +arn, +extension_arn, +resource_arn, +extension_identifier, +resource_identifier, +extension_version_number, +parameters, +tags +FROM aws.appconfig.extension_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual extension_association. +```sql +SELECT +region, +id, +arn, +extension_arn, +resource_arn, +extension_identifier, +resource_identifier, +extension_version_number, +parameters, +tags +FROM aws.appconfig.extension_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new extension_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.extension_associations ( + ExtensionIdentifier, + ResourceIdentifier, + ExtensionVersionNumber, + Parameters, + Tags, + region +) +SELECT +'{{ ExtensionIdentifier }}', + '{{ ResourceIdentifier }}', + '{{ ExtensionVersionNumber }}', + '{{ Parameters }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.extension_associations ( + ExtensionIdentifier, + ResourceIdentifier, + ExtensionVersionNumber, + Parameters, + Tags, + region +) +SELECT + '{{ ExtensionIdentifier }}', + '{{ ResourceIdentifier }}', + '{{ ExtensionVersionNumber }}', + '{{ Parameters }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: extension_association + props: + - name: ExtensionIdentifier + value: '{{ ExtensionIdentifier }}' + - name: ResourceIdentifier + value: '{{ ResourceIdentifier }}' + - name: ExtensionVersionNumber + value: '{{ ExtensionVersionNumber }}' + - name: Parameters + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appconfig.extension_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the extension_associations resource, the following permissions are required: + +### Create +```json +appconfig:CreateExtensionAssociation, +appconfig:TagResource +``` + +### Read +```json +appconfig:GetExtensionAssociation +``` + +### Update +```json +appconfig:UpdateExtensionAssociation, +appconfig:TagResource, +appconfig:UntagResource +``` + +### Delete +```json +appconfig:DeleteExtensionAssociation, +appconfig:UntagResource +``` + +### List +```json +appconfig:ListExtensionAssociations +``` diff --git a/website/docs/services/appconfig/extension_associations_list_only/index.md b/website/docs/services/appconfig/extension_associations_list_only/index.md new file mode 100644 index 0000000..4a6c686 --- /dev/null +++ b/website/docs/services/appconfig/extension_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: extension_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - extension_associations_list_only + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists extension_associations in a region or regions, for all properties use extension_associations + +## Overview + + + + + + + +
Nameextension_associations_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all extension_associations in a region. +```sql +SELECT +region, +id +FROM aws.appconfig.extension_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the extension_associations_list_only resource, see extension_associations + diff --git a/website/docs/services/appconfig/extension_tags/index.md b/website/docs/services/appconfig/extension_tags/index.md new file mode 100644 index 0000000..9daf772 --- /dev/null +++ b/website/docs/services/appconfig/extension_tags/index.md @@ -0,0 +1,91 @@ +--- +title: extension_tags +hide_title: false +hide_table_of_contents: false +keywords: + - extension_tags + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for extensions in a region + +## Overview + + + + + + + +
Nameextension_tags
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Extension
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
stringName of the extension.
stringDescription of the extension.
object
object
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all extensions in a region. +```sql +SELECT +region, +id, +arn, +version_number, +name, +description, +actions, +parameters, +latest_version_number, +tag_key, +tag_value +FROM aws.appconfig.extension_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the extension_tags resource, see extensions + diff --git a/website/docs/services/appconfig/extensions/index.md b/website/docs/services/appconfig/extensions/index.md new file mode 100644 index 0000000..1b27eaf --- /dev/null +++ b/website/docs/services/appconfig/extensions/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an extension resource or lists extensions in a region + +## Overview + + + + + + + +
Nameextensions
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Extension
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
stringName of the extension.
stringDescription of the extension.
object
object
integer
arrayAn array of key-value tags to apply to this resource.
stringAWS region.
+ +For more information, see AWS::AppConfig::Extension. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all extensions in a region. +```sql +SELECT +region, +id, +arn, +version_number, +name, +description, +actions, +parameters, +latest_version_number, +tags +FROM aws.appconfig.extensions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual extension. +```sql +SELECT +region, +id, +arn, +version_number, +name, +description, +actions, +parameters, +latest_version_number, +tags +FROM aws.appconfig.extensions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new extension resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.extensions ( + Name, + Actions, + region +) +SELECT +'{{ Name }}', + '{{ Actions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.extensions ( + Name, + Description, + Actions, + Parameters, + LatestVersionNumber, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Actions }}', + '{{ Parameters }}', + '{{ LatestVersionNumber }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: extension + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Actions + value: {} + - name: Parameters + value: {} + - name: LatestVersionNumber + value: '{{ LatestVersionNumber }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appconfig.extensions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the extensions resource, the following permissions are required: + +### Create +```json +appconfig:CreateExtension, +appconfig:TagResource, +iam:PassRole +``` + +### Read +```json +appconfig:GetExtension +``` + +### Update +```json +appconfig:UpdateExtension, +appconfig:TagResource, +appconfig:UntagResource +``` + +### Delete +```json +appconfig:DeleteExtension, +appconfig:UntagResource +``` + +### List +```json +appconfig:ListExtensions +``` diff --git a/website/docs/services/appconfig/extensions_list_only/index.md b/website/docs/services/appconfig/extensions_list_only/index.md new file mode 100644 index 0000000..7b575ed --- /dev/null +++ b/website/docs/services/appconfig/extensions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: extensions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - extensions_list_only + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists extensions in a region or regions, for all properties use extensions + +## Overview + + + + + + + +
Nameextensions_list_only
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Extension
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all extensions in a region. +```sql +SELECT +region, +id +FROM aws.appconfig.extensions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the extensions_list_only resource, see extensions + diff --git a/website/docs/services/appconfig/hosted_configuration_versions/index.md b/website/docs/services/appconfig/hosted_configuration_versions/index.md new file mode 100644 index 0000000..815edc8 --- /dev/null +++ b/website/docs/services/appconfig/hosted_configuration_versions/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a hosted_configuration_version resource or lists hosted_configuration_versions in a region + +## Overview + + + + + + + +
Namehosted_configuration_versions
TypeResource
DescriptionResource Type definition for AWS::AppConfig::HostedConfigurationVersion
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe configuration profile ID.
stringA description of the hosted configuration version.
stringA standard MIME type describing the format of the configuration content.
integerAn optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.
stringThe content of the configuration or the configuration data.
stringA user-defined label for an AWS AppConfig hosted configuration version.
stringThe application ID.
stringCurrent version number of hosted configuration version.
stringAWS region.
+ +For more information, see AWS::AppConfig::HostedConfigurationVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all hosted_configuration_versions in a region. +```sql +SELECT +region, +configuration_profile_id, +description, +content_type, +latest_version_number, +content, +version_label, +application_id, +version_number +FROM aws.appconfig.hosted_configuration_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual hosted_configuration_version. +```sql +SELECT +region, +configuration_profile_id, +description, +content_type, +latest_version_number, +content, +version_label, +application_id, +version_number +FROM aws.appconfig.hosted_configuration_versions +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new hosted_configuration_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.hosted_configuration_versions ( + ConfigurationProfileId, + ContentType, + Content, + ApplicationId, + region +) +SELECT +'{{ ConfigurationProfileId }}', + '{{ ContentType }}', + '{{ Content }}', + '{{ ApplicationId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appconfig.hosted_configuration_versions ( + ConfigurationProfileId, + Description, + ContentType, + LatestVersionNumber, + Content, + VersionLabel, + ApplicationId, + region +) +SELECT + '{{ ConfigurationProfileId }}', + '{{ Description }}', + '{{ ContentType }}', + '{{ LatestVersionNumber }}', + '{{ Content }}', + '{{ VersionLabel }}', + '{{ ApplicationId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: hosted_configuration_version + props: + - name: ConfigurationProfileId + value: '{{ ConfigurationProfileId }}' + - name: Description + value: '{{ Description }}' + - name: ContentType + value: '{{ ContentType }}' + - name: LatestVersionNumber + value: '{{ LatestVersionNumber }}' + - name: Content + value: '{{ Content }}' + - name: VersionLabel + value: '{{ VersionLabel }}' + - name: ApplicationId + value: '{{ ApplicationId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appconfig.hosted_configuration_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the hosted_configuration_versions resource, the following permissions are required: + +### Read +```json +appconfig:GetHostedConfigurationVersion +``` + +### Create +```json +appconfig:CreateHostedConfigurationVersion +``` + +### List +```json +appconfig:ListHostedConfigurationVersions +``` + +### Delete +```json +appconfig:DeleteHostedConfigurationVersion +``` diff --git a/website/docs/services/appconfig/hosted_configuration_versions_list_only/index.md b/website/docs/services/appconfig/hosted_configuration_versions_list_only/index.md new file mode 100644 index 0000000..8c3c69b --- /dev/null +++ b/website/docs/services/appconfig/hosted_configuration_versions_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: hosted_configuration_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hosted_configuration_versions_list_only + - appconfig + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hosted_configuration_versions in a region or regions, for all properties use hosted_configuration_versions + +## Overview + + + + + + + +
Namehosted_configuration_versions_list_only
TypeResource
DescriptionResource Type definition for AWS::AppConfig::HostedConfigurationVersion
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe configuration profile ID.
stringThe application ID.
stringCurrent version number of hosted configuration version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hosted_configuration_versions in a region. +```sql +SELECT +region, +application_id, +configuration_profile_id, +version_number +FROM aws.appconfig.hosted_configuration_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hosted_configuration_versions_list_only resource, see hosted_configuration_versions + diff --git a/website/docs/services/appconfig/index.md b/website/docs/services/appconfig/index.md new file mode 100644 index 0000000..461e048 --- /dev/null +++ b/website/docs/services/appconfig/index.md @@ -0,0 +1,58 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The appconfig service documentation. + +:::info Service Summary + +
+
+total resources: 23
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/appflow/connector_profiles/index.md b/website/docs/services/appflow/connector_profiles/index.md new file mode 100644 index 0000000..c9b5df5 --- /dev/null +++ b/website/docs/services/appflow/connector_profiles/index.md @@ -0,0 +1,410 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connector_profile resource or lists connector_profiles in a region + +## Overview + + + + + + + +
Nameconnector_profiles
TypeResource
DescriptionResource Type definition for AWS::AppFlow::ConnectorProfile
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier for connector profile resources
stringThe label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.
stringThe maximum number of items to retrieve in a single batch.
stringThe ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
stringList of Saas providers that need connector profile to be created
stringMode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular
objectConnector specific configurations needed to create connector profile
stringA unique Arn for Connector-Profile resource
stringAWS region.
+ +For more information, see AWS::AppFlow::ConnectorProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connector_profiles in a region. +```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_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connector_profile. +```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_profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connector_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appflow.connector_profiles ( + ConnectorProfileName, + ConnectorType, + ConnectionMode, + region +) +SELECT +'{{ ConnectorProfileName }}', + '{{ ConnectorType }}', + '{{ ConnectionMode }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appflow.connector_profiles ( + ConnectorLabel, + ConnectorProfileName, + KMSArn, + ConnectorType, + ConnectionMode, + ConnectorProfileConfig, + region +) +SELECT + '{{ ConnectorLabel }}', + '{{ ConnectorProfileName }}', + '{{ KMSArn }}', + '{{ ConnectorType }}', + '{{ ConnectionMode }}', + '{{ ConnectorProfileConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connector_profile + props: + - name: ConnectorLabel + value: '{{ ConnectorLabel }}' + - name: ConnectorProfileName + value: '{{ ConnectorProfileName }}' + - name: KMSArn + value: '{{ KMSArn }}' + - name: ConnectorType + value: '{{ ConnectorType }}' + - name: ConnectionMode + value: '{{ ConnectionMode }}' + - name: ConnectorProfileConfig + value: + ConnectorProfileProperties: + Datadog: + InstanceUrl: '{{ InstanceUrl }}' + Dynatrace: + InstanceUrl: null + InforNexus: + InstanceUrl: null + Marketo: + InstanceUrl: null + Redshift: + DatabaseUrl: '{{ DatabaseUrl }}' + BucketName: '{{ BucketName }}' + BucketPrefix: '{{ BucketPrefix }}' + RoleArn: '{{ RoleArn }}' + IsRedshiftServerless: '{{ IsRedshiftServerless }}' + DataApiRoleArn: '{{ DataApiRoleArn }}' + ClusterIdentifier: '{{ ClusterIdentifier }}' + WorkgroupName: '{{ WorkgroupName }}' + DatabaseName: '{{ DatabaseName }}' + SAPOData: + ApplicationHostUrl: '{{ ApplicationHostUrl }}' + ApplicationServicePath: '{{ ApplicationServicePath }}' + PortNumber: '{{ PortNumber }}' + ClientNumber: '{{ ClientNumber }}' + LogonLanguage: '{{ LogonLanguage }}' + PrivateLinkServiceName: '{{ PrivateLinkServiceName }}' + OAuthProperties: + AuthCodeUrl: '{{ AuthCodeUrl }}' + TokenUrl: '{{ TokenUrl }}' + OAuthScopes: + - '{{ OAuthScopes[0] }}' + DisableSSO: '{{ DisableSSO }}' + Salesforce: + InstanceUrl: null + isSandboxEnvironment: '{{ isSandboxEnvironment }}' + usePrivateLinkForMetadataAndAuthorization: '{{ usePrivateLinkForMetadataAndAuthorization }}' + Pardot: + InstanceUrl: null + IsSandboxEnvironment: '{{ IsSandboxEnvironment }}' + BusinessUnitId: '{{ BusinessUnitId }}' + ServiceNow: + InstanceUrl: null + Slack: + InstanceUrl: null + Snowflake: + Warehouse: '{{ Warehouse }}' + Stage: '{{ Stage }}' + BucketName: null + BucketPrefix: null + PrivateLinkServiceName: null + AccountName: '{{ AccountName }}' + Region: '{{ Region }}' + Veeva: + InstanceUrl: null + Zendesk: + InstanceUrl: null + CustomConnector: + ProfileProperties: {} + OAuth2Properties: + TokenUrl: '{{ TokenUrl }}' + OAuth2GrantType: '{{ OAuth2GrantType }}' + TokenUrlCustomProperties: {} + ConnectorProfileCredentials: + Amplitude: + ApiKey: '{{ ApiKey }}' + SecretKey: '{{ SecretKey }}' + Datadog: + ApiKey: null + ApplicationKey: '{{ ApplicationKey }}' + Dynatrace: + ApiToken: '{{ ApiToken }}' + GoogleAnalytics: + ClientId: '{{ ClientId }}' + ClientSecret: '{{ ClientSecret }}' + AccessToken: '{{ AccessToken }}' + RefreshToken: '{{ RefreshToken }}' + ConnectorOAuthRequest: + AuthCode: '{{ AuthCode }}' + RedirectUri: '{{ RedirectUri }}' + InforNexus: + AccessKeyId: '{{ AccessKeyId }}' + UserId: '{{ UserId }}' + SecretAccessKey: '{{ SecretAccessKey }}' + Datakey: null + Marketo: + ClientId: null + ClientSecret: null + AccessToken: null + ConnectorOAuthRequest: null + Redshift: + Username: null + Password: '{{ Password }}' + SAPOData: + BasicAuthCredentials: + Username: null + Password: null + OAuthCredentials: + AccessToken: null + RefreshToken: null + ConnectorOAuthRequest: null + ClientId: null + ClientSecret: null + Salesforce: + AccessToken: null + RefreshToken: null + ConnectorOAuthRequest: null + ClientCredentialsArn: '{{ ClientCredentialsArn }}' + OAuth2GrantType: null + JwtToken: '{{ JwtToken }}' + Pardot: + AccessToken: null + RefreshToken: null + ConnectorOAuthRequest: null + ClientCredentialsArn: null + ServiceNow: + Username: null + Password: null + OAuth2Credentials: + ClientId: null + ClientSecret: null + AccessToken: null + RefreshToken: null + OAuthRequest: null + Singular: + ApiKey: null + Slack: + ClientId: null + ClientSecret: null + AccessToken: null + ConnectorOAuthRequest: null + Snowflake: + Username: null + Password: null + Trendmicro: + ApiSecretKey: '{{ ApiSecretKey }}' + Veeva: + Username: null + Password: null + Zendesk: + ClientId: null + ClientSecret: null + AccessToken: null + ConnectorOAuthRequest: null + CustomConnector: + AuthenticationType: '{{ AuthenticationType }}' + Basic: null + Oauth2: null + ApiKey: + ApiKey: null + ApiSecretKey: null + Custom: + CustomAuthenticationType: '{{ CustomAuthenticationType }}' + CredentialsMap: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appflow.connector_profiles +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +appflow:DeleteConnectorProfile +``` + +### List +```json +appflow:DescribeConnectorProfiles +``` + +### 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/website/docs/services/appflow/connector_profiles_list_only/index.md b/website/docs/services/appflow/connector_profiles_list_only/index.md new file mode 100644 index 0000000..fbb7e36 --- /dev/null +++ b/website/docs/services/appflow/connector_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connector_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connector_profiles_list_only + - appflow + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connector_profiles in a region or regions, for all properties use connector_profiles + +## Overview + + + + + + + +
Nameconnector_profiles_list_only
TypeResource
DescriptionResource Type definition for AWS::AppFlow::ConnectorProfile
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe maximum number of items to retrieve in a single batch.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connector_profiles in a region. +```sql +SELECT +region, +connector_profile_name +FROM aws.appflow.connector_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connector_profiles_list_only resource, see connector_profiles + diff --git a/website/docs/services/appflow/connectors/index.md b/website/docs/services/appflow/connectors/index.md new file mode 100644 index 0000000..c91484b --- /dev/null +++ b/website/docs/services/appflow/connectors/index.md @@ -0,0 +1,224 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connector resource or lists connectors in a region + +## Overview + + + + + + + +
Nameconnectors
TypeResource
DescriptionResource schema for AWS::AppFlow::Connector
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
stringThe arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account.
stringThe provisioning type of the connector. Currently the only supported value is LAMBDA.
objectContains information about the configuration of the connector being registered.
stringA description about the connector that's being registered.
stringAWS region.
+ +For more information, see AWS::AppFlow::Connector. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connectors in a region. +```sql +SELECT +region, +connector_label, +connector_arn, +connector_provisioning_type, +connector_provisioning_config, +description +FROM aws.appflow.connectors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connector. +```sql +SELECT +region, +connector_label, +connector_arn, +connector_provisioning_type, +connector_provisioning_config, +description +FROM aws.appflow.connectors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appflow.connectors ( + ConnectorProvisioningType, + ConnectorProvisioningConfig, + region +) +SELECT +'{{ ConnectorProvisioningType }}', + '{{ ConnectorProvisioningConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appflow.connectors ( + ConnectorLabel, + ConnectorProvisioningType, + ConnectorProvisioningConfig, + Description, + region +) +SELECT + '{{ ConnectorLabel }}', + '{{ ConnectorProvisioningType }}', + '{{ ConnectorProvisioningConfig }}', + '{{ Description }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connector + props: + - name: ConnectorLabel + value: '{{ ConnectorLabel }}' + - name: ConnectorProvisioningType + value: '{{ ConnectorProvisioningType }}' + - name: ConnectorProvisioningConfig + value: + Lambda: + LambdaArn: '{{ LambdaArn }}' + - name: Description + value: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appflow.connectors +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +```json +appflow:RegisterConnector, +lambda:InvokeFunction +``` + +### Read +```json +appflow:DescribeConnector +``` + +### Delete +```json +appflow:UnRegisterConnector +``` + +### List +```json +appflow:ListConnectors +``` + +### Update +```json +appflow:UpdateConnectorRegistration, +lambda:InvokeFunction +``` diff --git a/website/docs/services/appflow/connectors_list_only/index.md b/website/docs/services/appflow/connectors_list_only/index.md new file mode 100644 index 0000000..84f918b --- /dev/null +++ b/website/docs/services/appflow/connectors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connectors_list_only + - appflow + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connectors in a region or regions, for all properties use connectors + +## Overview + + + + + + + +
Nameconnectors_list_only
TypeResource
DescriptionResource schema for AWS::AppFlow::Connector
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connectors in a region. +```sql +SELECT +region, +connector_label +FROM aws.appflow.connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connectors_list_only resource, see connectors + diff --git a/website/docs/services/appflow/flow_tags/index.md b/website/docs/services/appflow/flow_tags/index.md new file mode 100644 index 0000000..da4d720 --- /dev/null +++ b/website/docs/services/appflow/flow_tags/index.md @@ -0,0 +1,95 @@ +--- +title: flow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - flow_tags + - appflow + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for flows in a region + +## Overview + + + + + + + +
Nameflow_tags
TypeResource
DescriptionResource schema for AWS::AppFlow::Flow.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringARN identifier of the flow.
stringName of the flow.
stringDescription of the flow.
stringThe ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
objectTrigger settings of the flow.
stringFlow activation status for Scheduled- and Event-triggered flows
objectConfigurations of Source connector of the flow.
arrayList of Destination connectors of the flow.
arrayList of tasks for the flow.
objectConfigurations of metadata catalog of the flow.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all flows in a region. +```sql +SELECT +region, +flow_arn, +flow_name, +description, +kms_arn, +trigger_config, +flow_status, +source_flow_config, +destination_flow_config_list, +tasks, +metadata_catalog_config, +tag_key, +tag_value +FROM aws.appflow.flow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_tags resource, see flows + diff --git a/website/docs/services/appflow/flows/index.md b/website/docs/services/appflow/flows/index.md new file mode 100644 index 0000000..f56dc68 --- /dev/null +++ b/website/docs/services/appflow/flows/index.md @@ -0,0 +1,471 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flow resource or lists flows in a region + +## Overview + + + + + + + +
Nameflows
TypeResource
DescriptionResource schema for AWS::AppFlow::Flow.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringARN identifier of the flow.
stringName of the flow.
stringDescription of the flow.
stringThe ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
objectTrigger settings of the flow.
stringFlow activation status for Scheduled- and Event-triggered flows
objectConfigurations of Source connector of the flow.
arrayList of Destination connectors of the flow.
arrayList of tasks for the flow.
arrayList of Tags.
objectConfigurations of metadata catalog of the flow.
stringAWS region.
+ +For more information, see AWS::AppFlow::Flow. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flows in a region. +```sql +SELECT +region, +flow_arn, +flow_name, +description, +kms_arn, +trigger_config, +flow_status, +source_flow_config, +destination_flow_config_list, +tasks, +tags, +metadata_catalog_config +FROM aws.appflow.flows +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flow. +```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.flows +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appflow.flows ( + FlowName, + TriggerConfig, + SourceFlowConfig, + DestinationFlowConfigList, + Tasks, + region +) +SELECT +'{{ FlowName }}', + '{{ TriggerConfig }}', + '{{ SourceFlowConfig }}', + '{{ DestinationFlowConfigList }}', + '{{ Tasks }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appflow.flows ( + FlowName, + Description, + KMSArn, + TriggerConfig, + FlowStatus, + SourceFlowConfig, + DestinationFlowConfigList, + Tasks, + Tags, + MetadataCatalogConfig, + region +) +SELECT + '{{ FlowName }}', + '{{ Description }}', + '{{ KMSArn }}', + '{{ TriggerConfig }}', + '{{ FlowStatus }}', + '{{ SourceFlowConfig }}', + '{{ DestinationFlowConfigList }}', + '{{ Tasks }}', + '{{ Tags }}', + '{{ MetadataCatalogConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flow + props: + - name: FlowName + value: '{{ FlowName }}' + - name: Description + value: '{{ Description }}' + - name: KMSArn + value: '{{ KMSArn }}' + - name: TriggerConfig + value: + TriggerType: '{{ TriggerType }}' + TriggerProperties: + ScheduleExpression: '{{ ScheduleExpression }}' + DataPullMode: '{{ DataPullMode }}' + ScheduleStartTime: null + ScheduleEndTime: null + FirstExecutionFrom: null + TimeZone: '{{ TimeZone }}' + ScheduleOffset: null + FlowErrorDeactivationThreshold: '{{ FlowErrorDeactivationThreshold }}' + - name: FlowStatus + value: '{{ FlowStatus }}' + - name: SourceFlowConfig + value: + ConnectorType: '{{ ConnectorType }}' + ApiVersion: '{{ ApiVersion }}' + ConnectorProfileName: '{{ ConnectorProfileName }}' + SourceConnectorProperties: + Amplitude: + Object: '{{ Object }}' + Datadog: + Object: null + Dynatrace: + Object: null + GoogleAnalytics: + Object: null + InforNexus: + Object: null + Marketo: + Object: null + S3: + BucketName: '{{ BucketName }}' + BucketPrefix: '{{ BucketPrefix }}' + S3InputFormatConfig: + S3InputFileType: '{{ S3InputFileType }}' + SAPOData: + ObjectPath: null + parallelismConfig: + maxParallelism: '{{ maxParallelism }}' + paginationConfig: + maxPageSize: '{{ maxPageSize }}' + Salesforce: + Object: null + EnableDynamicFieldUpdate: '{{ EnableDynamicFieldUpdate }}' + IncludeDeletedRecords: '{{ IncludeDeletedRecords }}' + DataTransferApi: '{{ DataTransferApi }}' + Pardot: + Object: null + ServiceNow: + Object: null + Singular: + Object: null + Slack: + Object: null + Trendmicro: + Object: null + Veeva: + Object: null + DocumentType: '{{ DocumentType }}' + IncludeSourceFiles: '{{ IncludeSourceFiles }}' + IncludeRenditions: '{{ IncludeRenditions }}' + IncludeAllVersions: '{{ IncludeAllVersions }}' + Zendesk: + Object: null + CustomConnector: + EntityName: '{{ EntityName }}' + CustomProperties: {} + DataTransferApi: + Name: '{{ Name }}' + Type: '{{ Type }}' + IncrementalPullConfig: + DatetimeTypeFieldName: '{{ DatetimeTypeFieldName }}' + - name: DestinationFlowConfigList + value: + - ConnectorType: null + ApiVersion: null + ConnectorProfileName: null + DestinationConnectorProperties: + Redshift: + Object: null + IntermediateBucketName: null + BucketPrefix: null + ErrorHandlingConfig: + FailOnFirstError: '{{ FailOnFirstError }}' + BucketPrefix: null + BucketName: null + S3: + BucketName: null + BucketPrefix: null + S3OutputFormatConfig: + FileType: '{{ FileType }}' + PrefixConfig: + PrefixType: '{{ PrefixType }}' + PrefixFormat: '{{ PrefixFormat }}' + PathPrefixHierarchy: + - '{{ PathPrefixHierarchy[0] }}' + AggregationConfig: + AggregationType: '{{ AggregationType }}' + TargetFileSize: '{{ TargetFileSize }}' + PreserveSourceDataTyping: '{{ PreserveSourceDataTyping }}' + Salesforce: + Object: null + ErrorHandlingConfig: null + IdFieldNames: + - '{{ IdFieldNames[0] }}' + WriteOperationType: '{{ WriteOperationType }}' + DataTransferApi: null + Snowflake: + Object: null + IntermediateBucketName: null + BucketPrefix: null + ErrorHandlingConfig: null + EventBridge: + Object: null + ErrorHandlingConfig: null + Upsolver: + BucketName: '{{ BucketName }}' + BucketPrefix: null + S3OutputFormatConfig: + FileType: null + PrefixConfig: null + AggregationConfig: null + LookoutMetrics: + Object: null + Marketo: + Object: null + ErrorHandlingConfig: null + Zendesk: + Object: null + ErrorHandlingConfig: null + IdFieldNames: + - '{{ IdFieldNames[0] }}' + WriteOperationType: null + CustomConnector: + EntityName: null + ErrorHandlingConfig: null + WriteOperationType: null + IdFieldNames: + - '{{ IdFieldNames[0] }}' + CustomProperties: null + SAPOData: + ObjectPath: null + ErrorHandlingConfig: null + SuccessResponseHandlingConfig: + BucketPrefix: null + BucketName: null + IdFieldNames: + - '{{ IdFieldNames[0] }}' + WriteOperationType: null + - name: Tasks + value: + - SourceFields: + - '{{ SourceFields[0] }}' + ConnectorOperator: + Amplitude: '{{ Amplitude }}' + Datadog: '{{ Datadog }}' + Dynatrace: '{{ Dynatrace }}' + GoogleAnalytics: '{{ GoogleAnalytics }}' + InforNexus: '{{ InforNexus }}' + Marketo: '{{ Marketo }}' + S3: '{{ S3 }}' + SAPOData: '{{ SAPOData }}' + Salesforce: '{{ Salesforce }}' + Pardot: '{{ Pardot }}' + ServiceNow: '{{ ServiceNow }}' + Singular: '{{ Singular }}' + Slack: '{{ Slack }}' + Trendmicro: '{{ Trendmicro }}' + Veeva: '{{ Veeva }}' + Zendesk: '{{ Zendesk }}' + CustomConnector: '{{ CustomConnector }}' + DestinationField: '{{ DestinationField }}' + TaskType: '{{ TaskType }}' + TaskProperties: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: MetadataCatalogConfig + value: + GlueDataCatalog: + RoleArn: '{{ RoleArn }}' + DatabaseName: '{{ DatabaseName }}' + TablePrefix: '{{ TablePrefix }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appflow.flows +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +appflow:ListFlows +``` diff --git a/website/docs/services/appflow/flows_list_only/index.md b/website/docs/services/appflow/flows_list_only/index.md new file mode 100644 index 0000000..2d557f4 --- /dev/null +++ b/website/docs/services/appflow/flows_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: flows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flows_list_only + - appflow + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flows in a region or regions, for all properties use flows + +## Overview + + + + + + + +
Nameflows_list_only
TypeResource
DescriptionResource schema for AWS::AppFlow::Flow.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the flow.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flows in a region. +```sql +SELECT +region, +flow_name +FROM aws.appflow.flows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flows_list_only resource, see flows + diff --git a/website/docs/services/appflow/index.md b/website/docs/services/appflow/index.md new file mode 100644 index 0000000..bd98142 --- /dev/null +++ b/website/docs/services/appflow/index.md @@ -0,0 +1,42 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The appflow service documentation. + +:::info Service Summary + +
+
+total resources: 7
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/appintegrations/application_tags/index.md b/website/docs/services/appintegrations/application_tags/index.md new file mode 100644 index 0000000..0eff491 --- /dev/null +++ b/website/docs/services/appintegrations/application_tags/index.md @@ -0,0 +1,89 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - appintegrations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource Type definition for AWS:AppIntegrations::Application
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the application.
stringThe id of the application.
stringThe namespace of the application.
stringThe application description.
stringThe Amazon Resource Name (ARN) of the application.
objectApplication source config
arrayThe configuration of events or requests that the application has access to.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +name, +id, +namespace, +description, +application_arn, +application_source_config, +permissions, +tag_key, +tag_value +FROM aws.appintegrations.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/appintegrations/applications/index.md b/website/docs/services/appintegrations/applications/index.md new file mode 100644 index 0000000..3739421 --- /dev/null +++ b/website/docs/services/appintegrations/applications/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionResource Type definition for AWS:AppIntegrations::Application
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the application.
stringThe id of the application.
stringThe namespace of the application.
stringThe application description.
stringThe Amazon Resource Name (ARN) of the application.
objectApplication source config
arrayThe configuration of events or requests that the application has access to.
arrayThe tags (keys and values) associated with the application.
stringAWS region.
+ +For more information, see AWS::AppIntegrations::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +name, +id, +namespace, +description, +application_arn, +application_source_config, +permissions, +tags +FROM aws.appintegrations.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +name, +id, +namespace, +description, +application_arn, +application_source_config, +permissions, +tags +FROM aws.appintegrations.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appintegrations.applications ( + Name, + Namespace, + Description, + ApplicationSourceConfig, + region +) +SELECT +'{{ Name }}', + '{{ Namespace }}', + '{{ Description }}', + '{{ ApplicationSourceConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appintegrations.applications ( + Name, + Namespace, + Description, + ApplicationSourceConfig, + Permissions, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Namespace }}', + '{{ Description }}', + '{{ ApplicationSourceConfig }}', + '{{ Permissions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: Name + value: '{{ Name }}' + - name: Namespace + value: '{{ Namespace }}' + - name: Description + value: '{{ Description }}' + - name: ApplicationSourceConfig + value: + ExternalUrlConfig: + AccessUrl: '{{ AccessUrl }}' + ApprovedOrigins: + - '{{ ApprovedOrigins[0] }}' + - name: Permissions + value: + - '{{ Permissions[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appintegrations.applications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +app-integrations:CreateApplication, +app-integrations:TagResource +``` + +### Read +```json +app-integrations:GetApplication +``` + +### List +```json +app-integrations:ListApplications, +app-integrations:ListTagsForResource +``` + +### Update +```json +app-integrations:GetApplication, +app-integrations:UpdateApplication, +app-integrations:TagResource, +app-integrations:UntagResource +``` + +### Delete +```json +app-integrations:DeleteApplication +``` diff --git a/website/docs/services/appintegrations/applications_list_only/index.md b/website/docs/services/appintegrations/applications_list_only/index.md new file mode 100644 index 0000000..b0f188b --- /dev/null +++ b/website/docs/services/appintegrations/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - appintegrations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource Type definition for AWS:AppIntegrations::Application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_arn +FROM aws.appintegrations.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/appintegrations/data_integration_tags/index.md b/website/docs/services/appintegrations/data_integration_tags/index.md new file mode 100644 index 0000000..cf359b9 --- /dev/null +++ b/website/docs/services/appintegrations/data_integration_tags/index.md @@ -0,0 +1,93 @@ +--- +title: data_integration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_integration_tags + - appintegrations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_integrations in a region + +## Overview + + + + + + + +
Namedata_integration_tags
TypeResource
DescriptionResource Type definition for AWS::AppIntegrations::DataIntegration
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe data integration description.
stringThe unique identifer of the data integration.
stringThe Amazon Resource Name (ARN) of the data integration.
stringThe name of the data integration.
stringThe KMS key of the data integration.
objectThe name of the data and how often it should be pulled from the source.
stringThe URI of the data source.
objectThe configuration for what files should be pulled from the source.
objectThe configuration for what data should be pulled from the source.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_integrations in a region. +```sql +SELECT +region, +description, +id, +data_integration_arn, +name, +kms_key, +schedule_config, +source_uri, +file_configuration, +object_configuration, +tag_key, +tag_value +FROM aws.appintegrations.data_integration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_integration_tags resource, see data_integrations + diff --git a/website/docs/services/appintegrations/data_integrations/index.md b/website/docs/services/appintegrations/data_integrations/index.md new file mode 100644 index 0000000..88ed111 --- /dev/null +++ b/website/docs/services/appintegrations/data_integrations/index.md @@ -0,0 +1,304 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_integration resource or lists data_integrations in a region + +## Overview + + + + + + + +
Namedata_integrations
TypeResource
DescriptionResource Type definition for AWS::AppIntegrations::DataIntegration
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe data integration description.
stringThe unique identifer of the data integration.
stringThe Amazon Resource Name (ARN) of the data integration.
stringThe name of the data integration.
stringThe KMS key of the data integration.
objectThe name of the data and how often it should be pulled from the source.
stringThe URI of the data source.
arrayThe tags (keys and values) associated with the data integration.
objectThe configuration for what files should be pulled from the source.
objectThe configuration for what data should be pulled from the source.
stringAWS region.
+ +For more information, see AWS::AppIntegrations::DataIntegration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_integrations in a region. +```sql +SELECT +region, +description, +id, +data_integration_arn, +name, +kms_key, +schedule_config, +source_uri, +tags, +file_configuration, +object_configuration +FROM aws.appintegrations.data_integrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_integration. +```sql +SELECT +region, +description, +id, +data_integration_arn, +name, +kms_key, +schedule_config, +source_uri, +tags, +file_configuration, +object_configuration +FROM aws.appintegrations.data_integrations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appintegrations.data_integrations ( + Name, + KmsKey, + SourceURI, + region +) +SELECT +'{{ Name }}', + '{{ KmsKey }}', + '{{ SourceURI }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appintegrations.data_integrations ( + Description, + Name, + KmsKey, + ScheduleConfig, + SourceURI, + Tags, + FileConfiguration, + ObjectConfiguration, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ KmsKey }}', + '{{ ScheduleConfig }}', + '{{ SourceURI }}', + '{{ Tags }}', + '{{ FileConfiguration }}', + '{{ ObjectConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_integration + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: KmsKey + value: '{{ KmsKey }}' + - name: ScheduleConfig + value: + FirstExecutionFrom: '{{ FirstExecutionFrom }}' + Object: '{{ Object }}' + ScheduleExpression: '{{ ScheduleExpression }}' + - name: SourceURI + value: '{{ SourceURI }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: FileConfiguration + value: + Folders: + - '{{ Folders[0] }}' + Filters: {} + - name: ObjectConfiguration + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appintegrations.data_integrations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +app-integrations:GetDataIntegration, +app-integrations:ListTagsForResource +``` + +### List +```json +app-integrations:ListDataIntegrations +``` + +### 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/website/docs/services/appintegrations/data_integrations_list_only/index.md b/website/docs/services/appintegrations/data_integrations_list_only/index.md new file mode 100644 index 0000000..c05effd --- /dev/null +++ b/website/docs/services/appintegrations/data_integrations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: data_integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_integrations_list_only + - appintegrations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_integrations in a region or regions, for all properties use data_integrations + +## Overview + + + + + + + +
Namedata_integrations_list_only
TypeResource
DescriptionResource Type definition for AWS::AppIntegrations::DataIntegration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifer of the data integration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_integrations in a region. +```sql +SELECT +region, +id +FROM aws.appintegrations.data_integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_integrations_list_only resource, see data_integrations + diff --git a/website/docs/services/appintegrations/event_integration_tags/index.md b/website/docs/services/appintegrations/event_integration_tags/index.md new file mode 100644 index 0000000..f61ec39 --- /dev/null +++ b/website/docs/services/appintegrations/event_integration_tags/index.md @@ -0,0 +1,85 @@ +--- +title: event_integration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_integration_tags + - appintegrations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_integrations in a region + +## Overview + + + + + + + +
Nameevent_integration_tags
TypeResource
DescriptionResource Type definition for AWS::AppIntegrations::EventIntegration
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe event integration description.
stringThe Amazon Resource Name (ARN) of the event integration.
stringThe name of the event integration.
stringThe Amazon Eventbridge bus for the event integration.
objectThe EventFilter (source) associated with the event integration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_integrations in a region. +```sql +SELECT +region, +description, +event_integration_arn, +name, +event_bridge_bus, +event_filter, +tag_key, +tag_value +FROM aws.appintegrations.event_integration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_integration_tags resource, see event_integrations + diff --git a/website/docs/services/appintegrations/event_integrations/index.md b/website/docs/services/appintegrations/event_integrations/index.md new file mode 100644 index 0000000..4e42fbf --- /dev/null +++ b/website/docs/services/appintegrations/event_integrations/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_integration resource or lists event_integrations in a region + +## Overview + + + + + + + +
Nameevent_integrations
TypeResource
DescriptionResource Type definition for AWS::AppIntegrations::EventIntegration
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe event integration description.
stringThe Amazon Resource Name (ARN) of the event integration.
stringThe name of the event integration.
stringThe Amazon Eventbridge bus for the event integration.
objectThe EventFilter (source) associated with the event integration.
arrayThe tags (keys and values) associated with the event integration.
stringAWS region.
+ +For more information, see AWS::AppIntegrations::EventIntegration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_integrations in a region. +```sql +SELECT +region, +description, +event_integration_arn, +name, +event_bridge_bus, +event_filter, +tags +FROM aws.appintegrations.event_integrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_integration. +```sql +SELECT +region, +description, +event_integration_arn, +name, +event_bridge_bus, +event_filter, +tags +FROM aws.appintegrations.event_integrations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appintegrations.event_integrations ( + Name, + EventBridgeBus, + EventFilter, + region +) +SELECT +'{{ Name }}', + '{{ EventBridgeBus }}', + '{{ EventFilter }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appintegrations.event_integrations ( + Description, + Name, + EventBridgeBus, + EventFilter, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ EventBridgeBus }}', + '{{ EventFilter }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_integration + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: EventBridgeBus + value: '{{ EventBridgeBus }}' + - name: EventFilter + value: + Source: '{{ Source }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appintegrations.event_integrations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +app-integrations:GetEventIntegration, +app-integrations:ListTagsForResource +``` + +### List +```json +app-integrations:ListEventIntegrations +``` + +### Update +```json +app-integrations:GetEventIntegration, +app-integrations:UpdateEventIntegration, +app-integrations:TagResource, +app-integrations:UntagResource +``` + +### Delete +```json +app-integrations:DeleteEventIntegration +``` diff --git a/website/docs/services/appintegrations/event_integrations_list_only/index.md b/website/docs/services/appintegrations/event_integrations_list_only/index.md new file mode 100644 index 0000000..f887012 --- /dev/null +++ b/website/docs/services/appintegrations/event_integrations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: event_integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_integrations_list_only + - appintegrations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_integrations in a region or regions, for all properties use event_integrations + +## Overview + + + + + + + +
Nameevent_integrations_list_only
TypeResource
DescriptionResource Type definition for AWS::AppIntegrations::EventIntegration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the event integration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_integrations in a region. +```sql +SELECT +region, +name +FROM aws.appintegrations.event_integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_integrations_list_only resource, see event_integrations + diff --git a/website/docs/services/appintegrations/index.md b/website/docs/services/appintegrations/index.md new file mode 100644 index 0000000..14ebd41 --- /dev/null +++ b/website/docs/services/appintegrations/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The appintegrations service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/applicationautoscaling/index.md b/website/docs/services/applicationautoscaling/index.md new file mode 100644 index 0000000..6b7310f --- /dev/null +++ b/website/docs/services/applicationautoscaling/index.md @@ -0,0 +1,39 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The applicationautoscaling service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/applicationautoscaling/scalable_targets/index.md b/website/docs/services/applicationautoscaling/scalable_targets/index.md new file mode 100644 index 0000000..4c26f42 --- /dev/null +++ b/website/docs/services/applicationautoscaling/scalable_targets/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a scalable_target resource or lists scalable_targets in a region + +## Overview + + + + + + + +
Namescalable_targets
TypeResource
DescriptionThe AWS::ApplicationAutoScaling::ScalableTarget resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource.
For more information, see [Getting started](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the *Application Auto Scaling User Guide*.
If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe scheduled actions for the scalable target. Duplicates aren't allowed.
stringThe identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
+ ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
+ Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
+ EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
+ AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
+ DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
+ DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
+ Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
+ SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
+ Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource).
+ Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
+ Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
+ Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
+ Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
+ Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
+ Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
+ Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
+ SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
+ SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
stringThe namespace of the AWS service that provides the resource, or a custom-resource.
stringThe scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
+ ecs:service:DesiredCount - The desired task count of an ECS service.
+ elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
+ ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
+ appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
+ dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
+ dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
+ dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
+ dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
+ rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
+ sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
+ custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
+ comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
+ comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
+ lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
+ cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
+ cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
+ kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
+ neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
+ sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
+ sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
objectAn embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
*Suspension Outcomes*
+ For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
+ For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
+ For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
string
integerThe minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
stringSpecify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*.
To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide*. Look for the ARN in the table at the bottom of the page.
integerThe maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
stringAWS region.
+ +For more information, see AWS::ApplicationAutoScaling::ScalableTarget. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scalable_targets in a region. +```sql +SELECT +region, +scheduled_actions, +resource_id, +service_namespace, +scalable_dimension, +suspended_state, +id, +min_capacity, +role_arn, +max_capacity +FROM aws.applicationautoscaling.scalable_targets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual scalable_target. +```sql +SELECT +region, +scheduled_actions, +resource_id, +service_namespace, +scalable_dimension, +suspended_state, +id, +min_capacity, +role_arn, +max_capacity +FROM aws.applicationautoscaling.scalable_targets +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scalable_target resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.applicationautoscaling.scalable_targets ( + ResourceId, + ServiceNamespace, + ScalableDimension, + MinCapacity, + MaxCapacity, + region +) +SELECT +'{{ ResourceId }}', + '{{ ServiceNamespace }}', + '{{ ScalableDimension }}', + '{{ MinCapacity }}', + '{{ MaxCapacity }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.applicationautoscaling.scalable_targets ( + ScheduledActions, + ResourceId, + ServiceNamespace, + ScalableDimension, + SuspendedState, + MinCapacity, + RoleARN, + MaxCapacity, + region +) +SELECT + '{{ ScheduledActions }}', + '{{ ResourceId }}', + '{{ ServiceNamespace }}', + '{{ ScalableDimension }}', + '{{ SuspendedState }}', + '{{ MinCapacity }}', + '{{ RoleARN }}', + '{{ MaxCapacity }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: scalable_target + props: + - name: ScheduledActions + value: + - Timezone: '{{ Timezone }}' + ScheduledActionName: '{{ ScheduledActionName }}' + EndTime: '{{ EndTime }}' + Schedule: '{{ Schedule }}' + StartTime: '{{ StartTime }}' + ScalableTargetAction: + MinCapacity: '{{ MinCapacity }}' + MaxCapacity: '{{ MaxCapacity }}' + - name: ResourceId + value: '{{ ResourceId }}' + - name: ServiceNamespace + value: '{{ ServiceNamespace }}' + - name: ScalableDimension + value: '{{ ScalableDimension }}' + - name: SuspendedState + value: + DynamicScalingOutSuspended: '{{ DynamicScalingOutSuspended }}' + ScheduledScalingSuspended: '{{ ScheduledScalingSuspended }}' + DynamicScalingInSuspended: '{{ DynamicScalingInSuspended }}' + - name: MinCapacity + value: '{{ MinCapacity }}' + - name: RoleARN + value: '{{ RoleARN }}' + - name: MaxCapacity + value: '{{ MaxCapacity }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.applicationautoscaling.scalable_targets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the scalable_targets resource, the following permissions are required: + +### Read +```json +application-autoscaling:DescribeScalableTargets, +application-autoscaling:DescribeScheduledActions +``` + +### 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 +``` + +### 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 +``` + +### List +```json +application-autoscaling:DescribeScalableTargets +``` + +### Delete +```json +application-autoscaling:DeregisterScalableTarget +``` diff --git a/website/docs/services/applicationautoscaling/scalable_targets_list_only/index.md b/website/docs/services/applicationautoscaling/scalable_targets_list_only/index.md new file mode 100644 index 0000000..af4f705 --- /dev/null +++ b/website/docs/services/applicationautoscaling/scalable_targets_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: scalable_targets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scalable_targets_list_only + - applicationautoscaling + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scalable_targets in a region or regions, for all properties use scalable_targets + +## Overview + + + + + + + +
Namescalable_targets_list_only
TypeResource
DescriptionThe AWS::ApplicationAutoScaling::ScalableTarget resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource.
For more information, see [Getting started](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the *Application Auto Scaling User Guide*.
If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
+ ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
+ Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
+ EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
+ AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
+ DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
+ DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
+ Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
+ SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
+ Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource).
+ Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
+ Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
+ Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
+ Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
+ Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
+ Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
+ Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
+ SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
+ SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
stringThe namespace of the AWS service that provides the resource, or a custom-resource.
stringThe scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
+ ecs:service:DesiredCount - The desired task count of an ECS service.
+ elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
+ ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
+ appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
+ dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
+ dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
+ dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
+ dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
+ rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
+ sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
+ custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
+ comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
+ comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
+ lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
+ cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
+ cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
+ kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
+ neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
+ sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
+ sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scalable_targets in a region. +```sql +SELECT +region, +resource_id, +scalable_dimension, +service_namespace +FROM aws.applicationautoscaling.scalable_targets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scalable_targets_list_only resource, see scalable_targets + diff --git a/website/docs/services/applicationautoscaling/scaling_policies/index.md b/website/docs/services/applicationautoscaling/scaling_policies/index.md new file mode 100644 index 0000000..43b415f --- /dev/null +++ b/website/docs/services/applicationautoscaling/scaling_policies/index.md @@ -0,0 +1,333 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a scaling_policy resource or lists scaling_policies in a region + +## Overview + + + + + + + +
Namescaling_policies
TypeResource
DescriptionThe AWS::ApplicationAutoScaling::ScalingPolicy resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target.
For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe scaling policy type.
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMR
StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
stringThe identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
+ ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
+ Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
+ EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
+ AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
+ DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
+ DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
+ Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
+ SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
+ Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource).
+ Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
+ Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
+ Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
+ Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
+ Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
+ Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
+ Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
+ SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
+ SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
+ Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
stringThe CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource.
You must specify either the ScalingTargetId property, or the ResourceId, ScalableDimension, and ServiceNamespace properties, but not both.
stringThe name of the scaling policy.
Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.
stringThe namespace of the AWS service that provides the resource, or a custom-resource.
stringThe scalable dimension. This string consists of the service namespace, resource type, and scaling property.
+ ecs:service:DesiredCount - The task count of an ECS service.
+ elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
+ ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
+ appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
+ dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
+ dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
+ dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
+ dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
+ rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
+ sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
+ custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
+ comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
+ comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
+ lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
+ cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
+ cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
+ kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
+ neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
+ sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
+ sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
+ workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
objectA target tracking scaling policy.
string
objectA step scaling policy.
objectThe predictive scaling policy configuration.
stringAWS region.
+ +For more information, see AWS::ApplicationAutoScaling::ScalingPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scaling_policies in a region. +```sql +SELECT +region, +policy_type, +resource_id, +scaling_target_id, +policy_name, +service_namespace, +scalable_dimension, +target_tracking_scaling_policy_configuration, +arn, +step_scaling_policy_configuration, +predictive_scaling_policy_configuration +FROM aws.applicationautoscaling.scaling_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual scaling_policy. +```sql +SELECT +region, +policy_type, +resource_id, +scaling_target_id, +policy_name, +service_namespace, +scalable_dimension, +target_tracking_scaling_policy_configuration, +arn, +step_scaling_policy_configuration, +predictive_scaling_policy_configuration +FROM aws.applicationautoscaling.scaling_policies +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scaling_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.applicationautoscaling.scaling_policies ( + PolicyType, + PolicyName, + region +) +SELECT +'{{ PolicyType }}', + '{{ PolicyName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.applicationautoscaling.scaling_policies ( + PolicyType, + ResourceId, + ScalingTargetId, + PolicyName, + ServiceNamespace, + ScalableDimension, + TargetTrackingScalingPolicyConfiguration, + StepScalingPolicyConfiguration, + PredictiveScalingPolicyConfiguration, + region +) +SELECT + '{{ PolicyType }}', + '{{ ResourceId }}', + '{{ ScalingTargetId }}', + '{{ PolicyName }}', + '{{ ServiceNamespace }}', + '{{ ScalableDimension }}', + '{{ TargetTrackingScalingPolicyConfiguration }}', + '{{ StepScalingPolicyConfiguration }}', + '{{ PredictiveScalingPolicyConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: scaling_policy + props: + - name: PolicyType + value: '{{ PolicyType }}' + - name: ResourceId + value: '{{ ResourceId }}' + - name: ScalingTargetId + value: '{{ ScalingTargetId }}' + - name: PolicyName + value: '{{ PolicyName }}' + - name: ServiceNamespace + value: '{{ ServiceNamespace }}' + - name: ScalableDimension + value: '{{ ScalableDimension }}' + - name: TargetTrackingScalingPolicyConfiguration + value: + ScaleOutCooldown: '{{ ScaleOutCooldown }}' + TargetValue: null + CustomizedMetricSpecification: + MetricName: '{{ MetricName }}' + Metrics: + - ReturnData: '{{ ReturnData }}' + Expression: '{{ Expression }}' + Label: '{{ Label }}' + MetricStat: + Stat: '{{ Stat }}' + Metric: + MetricName: '{{ MetricName }}' + Dimensions: + - Value: '{{ Value }}' + Name: '{{ Name }}' + Namespace: '{{ Namespace }}' + Unit: '{{ Unit }}' + Id: '{{ Id }}' + Statistic: '{{ Statistic }}' + Dimensions: + - Value: '{{ Value }}' + Name: '{{ Name }}' + Unit: '{{ Unit }}' + Namespace: '{{ Namespace }}' + DisableScaleIn: '{{ DisableScaleIn }}' + ScaleInCooldown: '{{ ScaleInCooldown }}' + PredefinedMetricSpecification: + PredefinedMetricType: '{{ PredefinedMetricType }}' + ResourceLabel: '{{ ResourceLabel }}' + - name: StepScalingPolicyConfiguration + value: + MetricAggregationType: '{{ MetricAggregationType }}' + Cooldown: '{{ Cooldown }}' + StepAdjustments: + - MetricIntervalUpperBound: null + MetricIntervalLowerBound: null + ScalingAdjustment: '{{ ScalingAdjustment }}' + MinAdjustmentMagnitude: '{{ MinAdjustmentMagnitude }}' + AdjustmentType: '{{ AdjustmentType }}' + - name: PredictiveScalingPolicyConfiguration + value: + MaxCapacityBreachBehavior: '{{ MaxCapacityBreachBehavior }}' + MaxCapacityBuffer: '{{ MaxCapacityBuffer }}' + Mode: '{{ Mode }}' + MetricSpecifications: + - CustomizedLoadMetricSpecification: + MetricDataQueries: + - ReturnData: '{{ ReturnData }}' + Expression: '{{ Expression }}' + Label: '{{ Label }}' + MetricStat: + Stat: '{{ Stat }}' + Metric: + MetricName: '{{ MetricName }}' + Dimensions: + - Value: '{{ Value }}' + Name: '{{ Name }}' + Namespace: '{{ Namespace }}' + Unit: '{{ Unit }}' + Id: '{{ Id }}' + PredefinedLoadMetricSpecification: + PredefinedMetricType: '{{ PredefinedMetricType }}' + ResourceLabel: '{{ ResourceLabel }}' + TargetValue: null + PredefinedScalingMetricSpecification: + PredefinedMetricType: '{{ PredefinedMetricType }}' + ResourceLabel: '{{ ResourceLabel }}' + CustomizedCapacityMetricSpecification: + MetricDataQueries: + - null + CustomizedScalingMetricSpecification: + MetricDataQueries: + - null + PredefinedMetricPairSpecification: + PredefinedMetricType: '{{ PredefinedMetricType }}' + ResourceLabel: '{{ ResourceLabel }}' + SchedulingBufferTime: '{{ SchedulingBufferTime }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.applicationautoscaling.scaling_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the scaling_policies resource, the following permissions are required: + +### Read +```json +application-autoscaling:DescribeScalingPolicies +``` + +### Create +```json +application-autoscaling:DescribeScalingPolicies, +application-autoscaling:PutScalingPolicy, +cloudwatch:GetMetricData +``` + +### Update +```json +application-autoscaling:DescribeScalingPolicies, +application-autoscaling:PutScalingPolicy, +cloudwatch:GetMetricData +``` + +### List +```json +application-autoscaling:DescribeScalingPolicies +``` + +### Delete +```json +application-autoscaling:DescribeScalingPolicies, +application-autoscaling:DeleteScalingPolicy +``` diff --git a/website/docs/services/applicationautoscaling/scaling_policies_list_only/index.md b/website/docs/services/applicationautoscaling/scaling_policies_list_only/index.md new file mode 100644 index 0000000..21ccc6d --- /dev/null +++ b/website/docs/services/applicationautoscaling/scaling_policies_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: scaling_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scaling_policies_list_only + - applicationautoscaling + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scaling_policies in a region or regions, for all properties use scaling_policies + +## Overview + + + + + + + +
Namescaling_policies_list_only
TypeResource
DescriptionThe AWS::ApplicationAutoScaling::ScalingPolicy resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target.
For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe scalable dimension. This string consists of the service namespace, resource type, and scaling property.
+ ecs:service:DesiredCount - The task count of an ECS service.
+ elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
+ ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
+ appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
+ dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
+ dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
+ dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
+ dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
+ rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
+ sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
+ custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
+ comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
+ comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
+ lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
+ cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
+ cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
+ kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
+ neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
+ sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
+ sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
+ workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scaling_policies in a region. +```sql +SELECT +region, +arn, +scalable_dimension +FROM aws.applicationautoscaling.scaling_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scaling_policies_list_only resource, see scaling_policies + diff --git a/website/docs/services/applicationinsights/application_tags/index.md b/website/docs/services/applicationinsights/application_tags/index.md new file mode 100644 index 0000000..9a06959 --- /dev/null +++ b/website/docs/services/applicationinsights/application_tags/index.md @@ -0,0 +1,99 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - applicationinsights + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource schema for AWS::ApplicationInsights::Application
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource group.
stringThe ARN of the ApplicationInsights application.
booleanIndicates whether Application Insights can listen to CloudWatch events for the application resources.
booleanWhen set to true, creates opsItems for any problems detected on an application.
stringThe SNS topic provided to Application Insights that is associated to the created opsItem.
stringApplication Insights sends notifications to this SNS topic whenever there is a problem update in the associated application.
arrayThe custom grouped components.
arrayThe log pattern sets.
booleanIf set to true, application will be configured with recommended monitoring configuration.
arrayThe monitoring settings of the components.
stringThe grouping type of the application
booleanIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +resource_group_name, +application_arn, +cwe_monitor_enabled, +ops_center_enabled, +ops_item_sns_topic_arn, +sns_notification_arn, +custom_components, +log_pattern_sets, +auto_configuration_enabled, +component_monitoring_settings, +grouping_type, +attach_missing_permission, +tag_key, +tag_value +FROM aws.applicationinsights.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/applicationinsights/applications/index.md b/website/docs/services/applicationinsights/applications/index.md new file mode 100644 index 0000000..9022b3e --- /dev/null +++ b/website/docs/services/applicationinsights/applications/index.md @@ -0,0 +1,408 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionResource schema for AWS::ApplicationInsights::Application
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource group.
stringThe ARN of the ApplicationInsights application.
booleanIndicates whether Application Insights can listen to CloudWatch events for the application resources.
booleanWhen set to true, creates opsItems for any problems detected on an application.
stringThe SNS topic provided to Application Insights that is associated to the created opsItem.
stringApplication Insights sends notifications to this SNS topic whenever there is a problem update in the associated application.
arrayThe tags of Application Insights application.
arrayThe custom grouped components.
arrayThe log pattern sets.
booleanIf set to true, application will be configured with recommended monitoring configuration.
arrayThe monitoring settings of the components.
stringThe grouping type of the application
booleanIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing
stringAWS region.
+ +For more information, see AWS::ApplicationInsights::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +resource_group_name, +application_arn, +cwe_monitor_enabled, +ops_center_enabled, +ops_item_sns_topic_arn, +sns_notification_arn, +tags, +custom_components, +log_pattern_sets, +auto_configuration_enabled, +component_monitoring_settings, +grouping_type, +attach_missing_permission +FROM aws.applicationinsights.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +resource_group_name, +application_arn, +cwe_monitor_enabled, +ops_center_enabled, +ops_item_sns_topic_arn, +sns_notification_arn, +tags, +custom_components, +log_pattern_sets, +auto_configuration_enabled, +component_monitoring_settings, +grouping_type, +attach_missing_permission +FROM aws.applicationinsights.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.applicationinsights.applications ( + ResourceGroupName, + region +) +SELECT +'{{ ResourceGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.applicationinsights.applications ( + ResourceGroupName, + CWEMonitorEnabled, + OpsCenterEnabled, + OpsItemSNSTopicArn, + SNSNotificationArn, + Tags, + CustomComponents, + LogPatternSets, + AutoConfigurationEnabled, + ComponentMonitoringSettings, + GroupingType, + AttachMissingPermission, + region +) +SELECT + '{{ ResourceGroupName }}', + '{{ CWEMonitorEnabled }}', + '{{ OpsCenterEnabled }}', + '{{ OpsItemSNSTopicArn }}', + '{{ SNSNotificationArn }}', + '{{ Tags }}', + '{{ CustomComponents }}', + '{{ LogPatternSets }}', + '{{ AutoConfigurationEnabled }}', + '{{ ComponentMonitoringSettings }}', + '{{ GroupingType }}', + '{{ AttachMissingPermission }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: ResourceGroupName + value: '{{ ResourceGroupName }}' + - name: CWEMonitorEnabled + value: '{{ CWEMonitorEnabled }}' + - name: OpsCenterEnabled + value: '{{ OpsCenterEnabled }}' + - name: OpsItemSNSTopicArn + value: '{{ OpsItemSNSTopicArn }}' + - name: SNSNotificationArn + value: '{{ SNSNotificationArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CustomComponents + value: + - ComponentName: '{{ ComponentName }}' + ResourceList: + - '{{ ResourceList[0] }}' + - name: LogPatternSets + value: + - PatternSetName: '{{ PatternSetName }}' + LogPatterns: + - PatternName: '{{ PatternName }}' + Pattern: '{{ Pattern }}' + Rank: '{{ Rank }}' + - name: AutoConfigurationEnabled + value: '{{ AutoConfigurationEnabled }}' + - name: ComponentMonitoringSettings + value: + - ComponentName: '{{ ComponentName }}' + ComponentARN: '{{ ComponentARN }}' + Tier: '{{ Tier }}' + ComponentConfigurationMode: '{{ ComponentConfigurationMode }}' + DefaultOverwriteComponentConfiguration: + ConfigurationDetails: + AlarmMetrics: + - AlarmMetricName: '{{ AlarmMetricName }}' + Logs: + - LogGroupName: '{{ LogGroupName }}' + LogPath: '{{ LogPath }}' + LogType: '{{ LogType }}' + Encoding: '{{ Encoding }}' + PatternSet: '{{ PatternSet }}' + WindowsEvents: + - LogGroupName: '{{ LogGroupName }}' + EventName: '{{ EventName }}' + EventLevels: + - '{{ EventLevels[0] }}' + PatternSet: '{{ PatternSet }}' + Processes: + - ProcessName: '{{ ProcessName }}' + AlarmMetrics: + - null + Alarms: + - AlarmName: '{{ AlarmName }}' + Severity: '{{ Severity }}' + JMXPrometheusExporter: + JMXURL: '{{ JMXURL }}' + HostPort: '{{ HostPort }}' + PrometheusPort: '{{ PrometheusPort }}' + HANAPrometheusExporter: + HANASID: '{{ HANASID }}' + HANAPort: '{{ HANAPort }}' + HANASecretName: '{{ HANASecretName }}' + AgreeToInstallHANADBClient: '{{ AgreeToInstallHANADBClient }}' + PrometheusPort: '{{ PrometheusPort }}' + HAClusterPrometheusExporter: + PrometheusPort: '{{ PrometheusPort }}' + NetWeaverPrometheusExporter: + SAPSID: '{{ SAPSID }}' + InstanceNumbers: + - '{{ InstanceNumbers[0] }}' + PrometheusPort: '{{ PrometheusPort }}' + SQLServerPrometheusExporter: + PrometheusPort: '{{ PrometheusPort }}' + SQLSecretName: '{{ SQLSecretName }}' + SubComponentTypeConfigurations: + - SubComponentType: '{{ SubComponentType }}' + SubComponentConfigurationDetails: + AlarmMetrics: + - null + Logs: + - null + WindowsEvents: + - null + Processes: + - null + CustomComponentConfiguration: null + - name: GroupingType + value: '{{ GroupingType }}' + - name: AttachMissingPermission + value: '{{ AttachMissingPermission }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.applicationinsights.applications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +applicationinsights:CreateApplication, +applicationinsights:DescribeApplication, +applicationinsights:CreateComponent, +applicationinsights:DescribeComponent, +applicationinsights:CreateLogPattern, +applicationinsights:DescribeLogPattern, +applicationinsights:DescribeComponentConfigurationRecommendation, +applicationinsights:UpdateComponentConfiguration, +applicationinsights:ListComponents, +applicationinsights:TagResource, +ec2:DescribeInstances, +ec2:DescribeVolumes, +rds:DescribeDBInstances, +rds:DescribeDBClusters, +sqs:ListQueues, +elasticloadbalancing:DescribeLoadBalancers, +elasticloadbalancing:DescribeTargetGroups, +elasticloadbalancing:DescribeTargetHealth, +autoscaling:DescribeAutoScalingGroups, +lambda:ListFunctions, +dynamodb:ListTables, +s3:ListAllMyBuckets, +sns:ListTopics, +states:ListStateMachines, +apigateway:GET, +ecs:ListClusters, +ecs:DescribeTaskDefinition, +ecs:ListServices, +ecs:ListTasks, +eks:ListClusters, +eks:ListNodegroups, +fsx:DescribeFileSystems, +logs:DescribeLogGroups, +elasticfilesystem:DescribeFileSystems +``` + +### Read +```json +applicationinsights:DescribeApplication, +applicationinsights:ListTagsForResource, +applicationinsights:DescribeComponent, +applicationinsights:ListComponents, +applicationinsights:DescribeLogPattern, +applicationinsights:ListLogPatterns, +applicationinsights:ListLogPatternSets +``` + +### Update +```json +applicationinsights:CreateApplication, +applicationinsights:DescribeApplication, +applicationinsights:UpdateApplication, +applicationinsights:TagResource, +applicationinsights:UntagResource, +applicationinsights:ListTagsForResource, +applicationinsights:CreateComponent, +applicationinsights:DescribeComponent, +applicationinsights:DeleteComponent, +applicationinsights:ListComponents, +applicationinsights:CreateLogPattern, +applicationinsights:DeleteLogPattern, +applicationinsights:DescribeLogPattern, +applicationinsights:ListLogPatterns, +applicationinsights:ListLogPatternSets, +applicationinsights:UpdateLogPattern, +applicationinsights:DescribeComponentConfiguration, +applicationinsights:DescribeComponentConfigurationRecommendation, +applicationinsights:UpdateComponentConfiguration +``` + +### Delete +```json +applicationinsights:DeleteApplication, +applicationinsights:DescribeApplication +``` + +### List +```json +applicationinsights:ListApplications, +applicationinsights:DescribeApplication, +applicationinsights:ListTagsForResource, +applicationinsights:DescribeComponent, +applicationinsights:ListComponents, +applicationinsights:DescribeLogPattern, +applicationinsights:ListLogPatterns, +applicationinsights:ListLogPatternSets +``` diff --git a/website/docs/services/applicationinsights/applications_list_only/index.md b/website/docs/services/applicationinsights/applications_list_only/index.md new file mode 100644 index 0000000..a058813 --- /dev/null +++ b/website/docs/services/applicationinsights/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - applicationinsights + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource schema for AWS::ApplicationInsights::Application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the ApplicationInsights application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_arn +FROM aws.applicationinsights.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/applicationinsights/index.md b/website/docs/services/applicationinsights/index.md new file mode 100644 index 0000000..6a15266 --- /dev/null +++ b/website/docs/services/applicationinsights/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The applicationinsights service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/applicationsignals/index.md b/website/docs/services/applicationsignals/index.md new file mode 100644 index 0000000..411c248 --- /dev/null +++ b/website/docs/services/applicationsignals/index.md @@ -0,0 +1,38 @@ +--- +title: applicationsignals +hide_title: false +hide_table_of_contents: false +keywords: + - applicationsignals + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The applicationsignals service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/applicationsignals/service_level_objective_tags/index.md b/website/docs/services/applicationsignals/service_level_objective_tags/index.md new file mode 100644 index 0000000..0027a4c --- /dev/null +++ b/website/docs/services/applicationsignals/service_level_objective_tags/index.md @@ -0,0 +1,95 @@ +--- +title: service_level_objective_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_level_objective_tags + - applicationsignals + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_level_objectives in a region + +## Overview + + + + + + + +
Nameservice_level_objective_tags
TypeResource
DescriptionResource Type definition for AWS::ApplicationSignals::ServiceLevelObjective
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of this SLO.
stringThe name of this SLO.
stringAn optional description for this SLO. Default is 'No description'
integerEpoch time in seconds of the time that this SLO was created
integerEpoch time in seconds of the time that this SLO was most recently updated
objectThis structure contains information about the performance metric that an SLO monitors.
objectThis structure contains information about the performance metric that a request-based SLO monitors.
stringDisplays whether this is a period-based SLO or a request-based SLO.
objectA structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.
arrayEach object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_level_objectives in a region. +```sql +SELECT +region, +arn, +name, +description, +created_time, +last_updated_time, +sli, +request_based_sli, +evaluation_type, +goal, +burn_rate_configurations, +tag_key, +tag_value +FROM aws.applicationsignals.service_level_objective_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_level_objective_tags resource, see service_level_objectives + diff --git a/website/docs/services/applicationsignals/service_level_objectives/index.md b/website/docs/services/applicationsignals/service_level_objectives/index.md new file mode 100644 index 0000000..47838de --- /dev/null +++ b/website/docs/services/applicationsignals/service_level_objectives/index.md @@ -0,0 +1,309 @@ +--- +title: service_level_objectives +hide_title: false +hide_table_of_contents: false +keywords: + - service_level_objectives + - applicationsignals + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_level_objective resource or lists service_level_objectives in a region + +## Overview + + + + + + + +
Nameservice_level_objectives
TypeResource
DescriptionResource Type definition for AWS::ApplicationSignals::ServiceLevelObjective
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of this SLO.
stringThe name of this SLO.
stringAn optional description for this SLO. Default is 'No description'
integerEpoch time in seconds of the time that this SLO was created
integerEpoch time in seconds of the time that this SLO was most recently updated
objectThis structure contains information about the performance metric that an SLO monitors.
objectThis structure contains information about the performance metric that a request-based SLO monitors.
stringDisplays whether this is a period-based SLO or a request-based SLO.
objectA structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.
arrayThe list of tag keys and values associated with the resource you specified
arrayEach object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.
stringAWS region.
+ +For more information, see AWS::ApplicationSignals::ServiceLevelObjective. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all service_level_objectives in a region. +```sql +SELECT +region, +arn, +name, +description, +created_time, +last_updated_time, +sli, +request_based_sli, +evaluation_type, +goal, +tags, +burn_rate_configurations +FROM aws.applicationsignals.service_level_objectives +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service_level_objective. +```sql +SELECT +region, +arn, +name, +description, +created_time, +last_updated_time, +sli, +request_based_sli, +evaluation_type, +goal, +tags, +burn_rate_configurations +FROM aws.applicationsignals.service_level_objectives +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_level_objective resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.applicationsignals.service_level_objectives ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.applicationsignals.service_level_objectives ( + Name, + Description, + Sli, + RequestBasedSli, + Goal, + Tags, + BurnRateConfigurations, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Sli }}', + '{{ RequestBasedSli }}', + '{{ Goal }}', + '{{ Tags }}', + '{{ BurnRateConfigurations }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_level_objective + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Sli + value: + SliMetric: + KeyAttributes: null + OperationName: '{{ OperationName }}' + MetricType: '{{ MetricType }}' + Statistic: '{{ Statistic }}' + PeriodSeconds: '{{ PeriodSeconds }}' + MetricDataQueries: + - MetricStat: + Period: '{{ Period }}' + Metric: + MetricName: '{{ MetricName }}' + Dimensions: + - Value: '{{ Value }}' + Name: '{{ Name }}' + Namespace: '{{ Namespace }}' + Stat: '{{ Stat }}' + Unit: '{{ Unit }}' + Id: '{{ Id }}' + ReturnData: '{{ ReturnData }}' + Expression: '{{ Expression }}' + AccountId: '{{ AccountId }}' + MetricThreshold: null + ComparisonOperator: '{{ ComparisonOperator }}' + - name: RequestBasedSli + value: + RequestBasedSliMetric: + KeyAttributes: null + OperationName: '{{ OperationName }}' + MetricType: '{{ MetricType }}' + TotalRequestCountMetric: null + MonitoredRequestCountMetric: + GoodCountMetric: null + BadCountMetric: null + MetricThreshold: null + ComparisonOperator: '{{ ComparisonOperator }}' + - name: Goal + value: + Interval: + RollingInterval: + DurationUnit: '{{ DurationUnit }}' + Duration: '{{ Duration }}' + CalendarInterval: + StartTime: '{{ StartTime }}' + DurationUnit: null + Duration: null + AttainmentGoal: null + WarningThreshold: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: BurnRateConfigurations + value: + - LookBackWindowMinutes: '{{ LookBackWindowMinutes }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.applicationsignals.service_level_objectives +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the service_level_objectives resource, the following permissions are required: + +### Create +```json +application-signals:CreateServiceLevelObjective, +cloudwatch:GetMetricData, +application-signals:TagResource, +application-signals:GetServiceLevelObjective, +application-signals:ListTagsForResource, +iam:GetRole, +iam:CreateServiceLinkedRole +``` + +### Read +```json +application-signals:GetServiceLevelObjective, +application-signals:ListTagsForResource +``` + +### Update +```json +application-signals:UpdateServiceLevelObjective, +cloudwatch:GetMetricData, +application-signals:TagResource, +application-signals:UntagResource, +application-signals:GetServiceLevelObjective, +application-signals:ListTagsForResource +``` + +### Delete +```json +application-signals:DeleteServiceLevelObjective, +application-signals:UntagResource, +application-signals:GetServiceLevelObjective +``` + +### List +```json +application-signals:ListServiceLevelObjectives, +application-signals:ListTagsForResource +``` diff --git a/website/docs/services/applicationsignals/service_level_objectives_list_only/index.md b/website/docs/services/applicationsignals/service_level_objectives_list_only/index.md new file mode 100644 index 0000000..421f6e1 --- /dev/null +++ b/website/docs/services/applicationsignals/service_level_objectives_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: service_level_objectives_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_level_objectives_list_only + - applicationsignals + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_level_objectives in a region or regions, for all properties use service_level_objectives + +## Overview + + + + + + + +
Nameservice_level_objectives_list_only
TypeResource
DescriptionResource Type definition for AWS::ApplicationSignals::ServiceLevelObjective
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of this SLO.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_level_objectives in a region. +```sql +SELECT +region, +arn +FROM aws.applicationsignals.service_level_objectives_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_level_objectives_list_only resource, see service_level_objectives + diff --git a/website/docs/services/apprunner/auto_scaling_configuration_tags/index.md b/website/docs/services/apprunner/auto_scaling_configuration_tags/index.md new file mode 100644 index 0000000..e0337de --- /dev/null +++ b/website/docs/services/apprunner/auto_scaling_configuration_tags/index.md @@ -0,0 +1,89 @@ +--- +title: auto_scaling_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_configuration_tags + - apprunner + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for auto_scaling_configurations in a region + +## Overview + + + + + + + +
Nameauto_scaling_configuration_tags
TypeResource
DescriptionDescribes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this auto scaling configuration.
stringThe customer-provided auto scaling configuration name. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. The auto scaling configuration name can be used in multiple revisions of a configuration.
integerThe revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.
integerThe maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up to use more instances to process the requests.
integerThe maximum number of instances that an App Runner service scales up to. At most MaxSize instances actively serve traffic for your service.
integerThe minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.
booleanIt's set to true for the configuration with the highest Revision among all configurations that share the same AutoScalingConfigurationName. It's set to false otherwise. App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all auto_scaling_configurations in a region. +```sql +SELECT +region, +auto_scaling_configuration_arn, +auto_scaling_configuration_name, +auto_scaling_configuration_revision, +max_concurrency, +max_size, +min_size, +latest, +tag_key, +tag_value +FROM aws.apprunner.auto_scaling_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the auto_scaling_configuration_tags resource, see auto_scaling_configurations + diff --git a/website/docs/services/apprunner/auto_scaling_configurations/index.md b/website/docs/services/apprunner/auto_scaling_configurations/index.md new file mode 100644 index 0000000..728f103 --- /dev/null +++ b/website/docs/services/apprunner/auto_scaling_configurations/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an auto_scaling_configuration resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this auto scaling configuration.
stringThe customer-provided auto scaling configuration name. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. The auto scaling configuration name can be used in multiple revisions of a configuration.
integerThe revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.
integerThe maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up to use more instances to process the requests.
integerThe maximum number of instances that an App Runner service scales up to. At most MaxSize instances actively serve traffic for your service.
integerThe minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.
booleanIt's set to true for the configuration with the highest Revision among all configurations that share the same AutoScalingConfigurationName. It's set to false otherwise. App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
arrayA list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.
stringAWS region.
+ +For more information, see AWS::AppRunner::AutoScalingConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all auto_scaling_configurations in a region. +```sql +SELECT +region, +auto_scaling_configuration_arn, +auto_scaling_configuration_name, +auto_scaling_configuration_revision, +max_concurrency, +max_size, +min_size, +latest, +tags +FROM aws.apprunner.auto_scaling_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual auto_scaling_configuration. +```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_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new auto_scaling_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apprunner.auto_scaling_configurations ( + AutoScalingConfigurationName, + MaxConcurrency, + MaxSize, + MinSize, + Tags, + region +) +SELECT +'{{ AutoScalingConfigurationName }}', + '{{ MaxConcurrency }}', + '{{ MaxSize }}', + '{{ MinSize }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apprunner.auto_scaling_configurations ( + AutoScalingConfigurationName, + MaxConcurrency, + MaxSize, + MinSize, + Tags, + region +) +SELECT + '{{ AutoScalingConfigurationName }}', + '{{ MaxConcurrency }}', + '{{ MaxSize }}', + '{{ MinSize }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: auto_scaling_configuration + props: + - name: AutoScalingConfigurationName + value: '{{ AutoScalingConfigurationName }}' + - name: MaxConcurrency + value: '{{ MaxConcurrency }}' + - name: MaxSize + value: '{{ MaxSize }}' + - name: MinSize + value: '{{ MinSize }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apprunner.auto_scaling_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +apprunner:DescribeAutoScalingConfiguration +``` + +### Delete +```json +apprunner:DeleteAutoScalingConfiguration +``` + +### List +```json +apprunner:ListAutoScalingConfiguration +``` diff --git a/website/docs/services/apprunner/auto_scaling_configurations_list_only/index.md b/website/docs/services/apprunner/auto_scaling_configurations_list_only/index.md new file mode 100644 index 0000000..a87dee0 --- /dev/null +++ b/website/docs/services/apprunner/auto_scaling_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: auto_scaling_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_configurations_list_only + - apprunner + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists auto_scaling_configurations in a region or regions, for all properties use auto_scaling_configurations + +## Overview + + + + + + + +
Nameauto_scaling_configurations_list_only
TypeResource
DescriptionDescribes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this auto scaling configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all auto_scaling_configurations in a region. +```sql +SELECT +region, +auto_scaling_configuration_arn +FROM aws.apprunner.auto_scaling_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the auto_scaling_configurations_list_only resource, see auto_scaling_configurations + diff --git a/website/docs/services/apprunner/index.md b/website/docs/services/apprunner/index.md new file mode 100644 index 0000000..7f6d232 --- /dev/null +++ b/website/docs/services/apprunner/index.md @@ -0,0 +1,50 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The apprunner service documentation. + +:::info Service Summary + +
+
+total resources: 15
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/apprunner/observability_configuration_tags/index.md b/website/docs/services/apprunner/observability_configuration_tags/index.md new file mode 100644 index 0000000..443578e --- /dev/null +++ b/website/docs/services/apprunner/observability_configuration_tags/index.md @@ -0,0 +1,85 @@ +--- +title: observability_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - observability_configuration_tags + - apprunner + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for observability_configurations in a region + +## Overview + + + + + + + +
Nameobservability_configuration_tags
TypeResource
DescriptionThe AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
stringA name for the observability configuration. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
integerThe revision of this observability configuration. It's unique among all the active configurations ('Status': 'ACTIVE') that share the same ObservabilityConfigurationName.
booleanIt's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.
objectThe configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all observability_configurations in a region. +```sql +SELECT +region, +observability_configuration_arn, +observability_configuration_name, +observability_configuration_revision, +latest, +trace_configuration, +tag_key, +tag_value +FROM aws.apprunner.observability_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the observability_configuration_tags resource, see observability_configurations + diff --git a/website/docs/services/apprunner/observability_configurations/index.md b/website/docs/services/apprunner/observability_configurations/index.md new file mode 100644 index 0000000..050f2ad --- /dev/null +++ b/website/docs/services/apprunner/observability_configurations/index.md @@ -0,0 +1,212 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an observability_configuration resource or lists 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
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
stringA name for the observability configuration. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
integerThe revision of this observability configuration. It's unique among all the active configurations ('Status': 'ACTIVE') that share the same ObservabilityConfigurationName.
booleanIt's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.
objectThe configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.
arrayA list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.
stringAWS region.
+ +For more information, see AWS::AppRunner::ObservabilityConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all observability_configurations in a region. +```sql +SELECT +region, +observability_configuration_arn, +observability_configuration_name, +observability_configuration_revision, +latest, +trace_configuration, +tags +FROM aws.apprunner.observability_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual observability_configuration. +```sql +SELECT +region, +observability_configuration_arn, +observability_configuration_name, +observability_configuration_revision, +latest, +trace_configuration, +tags +FROM aws.apprunner.observability_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new observability_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apprunner.observability_configurations ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apprunner.observability_configurations ( + ObservabilityConfigurationName, + TraceConfiguration, + Tags, + region +) +SELECT + '{{ ObservabilityConfigurationName }}', + '{{ TraceConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: observability_configuration + props: + - name: ObservabilityConfigurationName + value: '{{ ObservabilityConfigurationName }}' + - name: TraceConfiguration + value: + Vendor: '{{ Vendor }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apprunner.observability_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +apprunner:DescribeObservabilityConfiguration +``` + +### Delete +```json +apprunner:DeleteObservabilityConfiguration +``` + +### List +```json +apprunner:ListObservabilityConfigurations +``` diff --git a/website/docs/services/apprunner/observability_configurations_list_only/index.md b/website/docs/services/apprunner/observability_configurations_list_only/index.md new file mode 100644 index 0000000..9269a12 --- /dev/null +++ b/website/docs/services/apprunner/observability_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: observability_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - observability_configurations_list_only + - apprunner + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists observability_configurations in a region or regions, for all properties use observability_configurations + +## Overview + + + + + + + +
Nameobservability_configurations_list_only
TypeResource
DescriptionThe AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all observability_configurations in a region. +```sql +SELECT +region, +observability_configuration_arn +FROM aws.apprunner.observability_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the observability_configurations_list_only resource, see observability_configurations + diff --git a/website/docs/services/apprunner/service_tags/index.md b/website/docs/services/apprunner/service_tags/index.md new file mode 100644 index 0000000..a7cfb13 --- /dev/null +++ b/website/docs/services/apprunner/service_tags/index.md @@ -0,0 +1,99 @@ +--- +title: service_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_tags + - apprunner + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for services in a region + +## Overview + + + + + + + +
Nameservice_tags
TypeResource
DescriptionThe AWS::AppRunner::Service resource specifies an AppRunner Service.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AppRunner Service Name.
stringThe AppRunner Service Id
stringThe Amazon Resource Name (ARN) of the AppRunner Service.
stringThe Service Url of the AppRunner Service.
stringAppRunner Service status.
objectSource Code configuration
objectInstance Configuration
objectEncryption configuration (KMS key)
objectHealth check configuration
objectService observability configuration
stringAutoscaling configuration ARN
objectNetwork configuration
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all services in a region. +```sql +SELECT +region, +service_name, +service_id, +service_arn, +service_url, +status, +source_configuration, +instance_configuration, +encryption_configuration, +health_check_configuration, +observability_configuration, +auto_scaling_configuration_arn, +network_configuration, +tag_key, +tag_value +FROM aws.apprunner.service_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_tags resource, see services + diff --git a/website/docs/services/apprunner/services/index.md b/website/docs/services/apprunner/services/index.md new file mode 100644 index 0000000..471b096 --- /dev/null +++ b/website/docs/services/apprunner/services/index.md @@ -0,0 +1,326 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service resource or lists services in a region + +## Overview + + + + + + + +
Nameservices
TypeResource
DescriptionThe AWS::AppRunner::Service resource specifies an AppRunner Service.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AppRunner Service Name.
stringThe AppRunner Service Id
stringThe Amazon Resource Name (ARN) of the AppRunner Service.
stringThe Service Url of the AppRunner Service.
stringAppRunner Service status.
objectSource Code configuration
objectInstance Configuration
array
objectEncryption configuration (KMS key)
objectHealth check configuration
objectService observability configuration
stringAutoscaling configuration ARN
objectNetwork configuration
stringAWS region.
+ +For more information, see AWS::AppRunner::Service. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all services in a region. +```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.services +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service. +```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.services +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apprunner.services ( + SourceConfiguration, + region +) +SELECT +'{{ SourceConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apprunner.services ( + ServiceName, + SourceConfiguration, + InstanceConfiguration, + Tags, + EncryptionConfiguration, + HealthCheckConfiguration, + ObservabilityConfiguration, + AutoScalingConfigurationArn, + NetworkConfiguration, + region +) +SELECT + '{{ ServiceName }}', + '{{ SourceConfiguration }}', + '{{ InstanceConfiguration }}', + '{{ Tags }}', + '{{ EncryptionConfiguration }}', + '{{ HealthCheckConfiguration }}', + '{{ ObservabilityConfiguration }}', + '{{ AutoScalingConfigurationArn }}', + '{{ NetworkConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service + props: + - name: ServiceName + value: '{{ ServiceName }}' + - name: SourceConfiguration + value: + CodeRepository: + RepositoryUrl: '{{ RepositoryUrl }}' + SourceCodeVersion: + Type: '{{ Type }}' + Value: '{{ Value }}' + CodeConfiguration: + ConfigurationSource: '{{ ConfigurationSource }}' + CodeConfigurationValues: + Runtime: '{{ Runtime }}' + BuildCommand: '{{ BuildCommand }}' + StartCommand: '{{ StartCommand }}' + Port: '{{ Port }}' + RuntimeEnvironmentVariables: + - Name: '{{ Name }}' + Value: '{{ Value }}' + RuntimeEnvironmentSecrets: + - null + SourceDirectory: '{{ SourceDirectory }}' + ImageRepository: + ImageIdentifier: '{{ ImageIdentifier }}' + ImageConfiguration: + StartCommand: '{{ StartCommand }}' + Port: '{{ Port }}' + RuntimeEnvironmentVariables: + - null + RuntimeEnvironmentSecrets: + - null + ImageRepositoryType: '{{ ImageRepositoryType }}' + AutoDeploymentsEnabled: '{{ AutoDeploymentsEnabled }}' + AuthenticationConfiguration: + ConnectionArn: '{{ ConnectionArn }}' + AccessRoleArn: '{{ AccessRoleArn }}' + - name: InstanceConfiguration + value: + Cpu: '{{ Cpu }}' + Memory: '{{ Memory }}' + InstanceRoleArn: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: EncryptionConfiguration + value: + KmsKey: '{{ KmsKey }}' + - name: HealthCheckConfiguration + value: + Protocol: '{{ Protocol }}' + Path: '{{ Path }}' + Interval: '{{ Interval }}' + Timeout: '{{ Timeout }}' + HealthyThreshold: '{{ HealthyThreshold }}' + UnhealthyThreshold: '{{ UnhealthyThreshold }}' + - name: ObservabilityConfiguration + value: + ObservabilityEnabled: '{{ ObservabilityEnabled }}' + ObservabilityConfigurationArn: '{{ ObservabilityConfigurationArn }}' + - name: AutoScalingConfigurationArn + value: '{{ AutoScalingConfigurationArn }}' + - name: NetworkConfiguration + value: + EgressConfiguration: + EgressType: '{{ EgressType }}' + VpcConnectorArn: '{{ VpcConnectorArn }}' + IngressConfiguration: + IsPubliclyAccessible: '{{ IsPubliclyAccessible }}' + IpAddressType: '{{ IpAddressType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apprunner.services +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +apprunner:DescribeService +``` + +### Update +```json +apprunner:UpdateService, +iam:PassRole +``` + +### Delete +```json +apprunner:DeleteService +``` + +### List +```json +apprunner:ListServices, +iam:PassRole +``` diff --git a/website/docs/services/apprunner/services_list_only/index.md b/website/docs/services/apprunner/services_list_only/index.md new file mode 100644 index 0000000..775bff9 --- /dev/null +++ b/website/docs/services/apprunner/services_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: services_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - services_list_only + - apprunner + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists services in a region or regions, for all properties use services + +## Overview + + + + + + + +
Nameservices_list_only
TypeResource
DescriptionThe AWS::AppRunner::Service resource specifies an AppRunner Service.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the AppRunner Service.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all services in a region. +```sql +SELECT +region, +service_arn +FROM aws.apprunner.services_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the services_list_only resource, see services + diff --git a/website/docs/services/apprunner/vpc_connector_tags/index.md b/website/docs/services/apprunner/vpc_connector_tags/index.md new file mode 100644 index 0000000..20562a1 --- /dev/null +++ b/website/docs/services/apprunner/vpc_connector_tags/index.md @@ -0,0 +1,85 @@ +--- +title: vpc_connector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connector_tags + - apprunner + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_connectors in a region + +## Overview + + + + + + + +
Namevpc_connector_tags
TypeResource
DescriptionThe AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
stringThe Amazon Resource Name (ARN) of this VPC connector.
integerThe revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
arrayA list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
arrayA list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_connectors in a region. +```sql +SELECT +region, +vpc_connector_name, +vpc_connector_arn, +vpc_connector_revision, +subnets, +security_groups, +tag_key, +tag_value +FROM aws.apprunner.vpc_connector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connector_tags resource, see vpc_connectors + diff --git a/website/docs/services/apprunner/vpc_connectors/index.md b/website/docs/services/apprunner/vpc_connectors/index.md new file mode 100644 index 0000000..e1274e9 --- /dev/null +++ b/website/docs/services/apprunner/vpc_connectors/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_connector resource or lists vpc_connectors in a region + +## Overview + + + + + + + +
Namevpc_connectors
TypeResource
DescriptionThe AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
stringThe Amazon Resource Name (ARN) of this VPC connector.
integerThe revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
arrayA list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
arrayA list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
arrayA list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
stringAWS region.
+ +For more information, see AWS::AppRunner::VpcConnector. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_connectors in a region. +```sql +SELECT +region, +vpc_connector_name, +vpc_connector_arn, +vpc_connector_revision, +subnets, +security_groups, +tags +FROM aws.apprunner.vpc_connectors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_connector. +```sql +SELECT +region, +vpc_connector_name, +vpc_connector_arn, +vpc_connector_revision, +subnets, +security_groups, +tags +FROM aws.apprunner.vpc_connectors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apprunner.vpc_connectors ( + Subnets, + region +) +SELECT +'{{ Subnets }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apprunner.vpc_connectors ( + VpcConnectorName, + Subnets, + SecurityGroups, + Tags, + region +) +SELECT + '{{ VpcConnectorName }}', + '{{ Subnets }}', + '{{ SecurityGroups }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_connector + props: + - name: VpcConnectorName + value: '{{ VpcConnectorName }}' + - name: Subnets + value: + - '{{ Subnets[0] }}' + - name: SecurityGroups + value: + - '{{ SecurityGroups[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apprunner.vpc_connectors +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +apprunner:DescribeVpcConnector +``` + +### Delete +```json +apprunner:DeleteVpcConnector +``` + +### List +```json +apprunner:ListVpcConnectors +``` diff --git a/website/docs/services/apprunner/vpc_connectors_list_only/index.md b/website/docs/services/apprunner/vpc_connectors_list_only/index.md new file mode 100644 index 0000000..4f62cf8 --- /dev/null +++ b/website/docs/services/apprunner/vpc_connectors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connectors_list_only + - apprunner + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_connectors in a region or regions, for all properties use vpc_connectors + +## Overview + + + + + + + +
Namevpc_connectors_list_only
TypeResource
DescriptionThe AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this VPC connector.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_connectors in a region. +```sql +SELECT +region, +vpc_connector_arn +FROM aws.apprunner.vpc_connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connectors_list_only resource, see vpc_connectors + diff --git a/website/docs/services/apprunner/vpc_ingress_connection_tags/index.md b/website/docs/services/apprunner/vpc_ingress_connection_tags/index.md new file mode 100644 index 0000000..eb27da8 --- /dev/null +++ b/website/docs/services/apprunner/vpc_ingress_connection_tags/index.md @@ -0,0 +1,87 @@ +--- +title: vpc_ingress_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_ingress_connection_tags + - apprunner + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_ingress_connections in a region + +## Overview + + + + + + + +
Namevpc_ingress_connection_tags
TypeResource
DescriptionThe AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
stringThe customer-provided Vpc Ingress Connection name.
stringThe Amazon Resource Name (ARN) of the service.
stringThe current status of the VpcIngressConnection.
stringThe Domain name associated with the VPC Ingress Connection.
objectThe configuration of customer’s VPC and related VPC endpoint
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_ingress_connections in a region. +```sql +SELECT +region, +vpc_ingress_connection_arn, +vpc_ingress_connection_name, +service_arn, +status, +domain_name, +ingress_vpc_configuration, +tag_key, +tag_value +FROM aws.apprunner.vpc_ingress_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_ingress_connection_tags resource, see vpc_ingress_connections + diff --git a/website/docs/services/apprunner/vpc_ingress_connections/index.md b/website/docs/services/apprunner/vpc_ingress_connections/index.md new file mode 100644 index 0000000..b567ebc --- /dev/null +++ b/website/docs/services/apprunner/vpc_ingress_connections/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_ingress_connection resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
stringThe customer-provided Vpc Ingress Connection name.
stringThe Amazon Resource Name (ARN) of the service.
stringThe current status of the VpcIngressConnection.
stringThe Domain name associated with the VPC Ingress Connection.
objectThe configuration of customer’s VPC and related VPC endpoint
array
stringAWS region.
+ +For more information, see AWS::AppRunner::VpcIngressConnection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_ingress_connections in a region. +```sql +SELECT +region, +vpc_ingress_connection_arn, +vpc_ingress_connection_name, +service_arn, +status, +domain_name, +ingress_vpc_configuration, +tags +FROM aws.apprunner.vpc_ingress_connections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_ingress_connection. +```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_connections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_ingress_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apprunner.vpc_ingress_connections ( + ServiceArn, + IngressVpcConfiguration, + region +) +SELECT +'{{ ServiceArn }}', + '{{ IngressVpcConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apprunner.vpc_ingress_connections ( + VpcIngressConnectionName, + ServiceArn, + IngressVpcConfiguration, + Tags, + region +) +SELECT + '{{ VpcIngressConnectionName }}', + '{{ ServiceArn }}', + '{{ IngressVpcConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_ingress_connection + props: + - name: VpcIngressConnectionName + value: '{{ VpcIngressConnectionName }}' + - name: ServiceArn + value: '{{ ServiceArn }}' + - name: IngressVpcConfiguration + value: + VpcId: '{{ VpcId }}' + VpcEndpointId: '{{ VpcEndpointId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apprunner.vpc_ingress_connections +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +apprunner:DescribeVpcIngressConnection +``` + +### Update +```json +apprunner:UpdateVpcIngressConnection +``` + +### Delete +```json +apprunner:DeleteVpcIngressConnection +``` + +### List +```json +apprunner:ListVpcIngressConnections +``` diff --git a/website/docs/services/apprunner/vpc_ingress_connections_list_only/index.md b/website/docs/services/apprunner/vpc_ingress_connections_list_only/index.md new file mode 100644 index 0000000..620f148 --- /dev/null +++ b/website/docs/services/apprunner/vpc_ingress_connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_ingress_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_ingress_connections_list_only + - apprunner + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_ingress_connections in a region or regions, for all properties use vpc_ingress_connections + +## Overview + + + + + + + +
Namevpc_ingress_connections_list_only
TypeResource
DescriptionThe AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_ingress_connections in a region. +```sql +SELECT +region, +vpc_ingress_connection_arn +FROM aws.apprunner.vpc_ingress_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_ingress_connections_list_only resource, see vpc_ingress_connections + diff --git a/website/docs/services/appstream/app_block_builder_tags/index.md b/website/docs/services/appstream/app_block_builder_tags/index.md new file mode 100644 index 0000000..b48cf27 --- /dev/null +++ b/website/docs/services/appstream/app_block_builder_tags/index.md @@ -0,0 +1,99 @@ +--- +title: app_block_builder_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_block_builder_tags + - appstream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for app_block_builders in a region + +## Overview + + + + + + + +
Nameapp_block_builder_tags
TypeResource
DescriptionResource Type definition for AWS::AppStream::AppBlockBuilder.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
object
boolean
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all app_block_builders in a region. +```sql +SELECT +region, +name, +arn, +description, +display_name, +platform, +access_endpoints, +vpc_config, +enable_default_internet_access, +iam_role_arn, +created_time, +instance_type, +app_block_arns, +tag_key, +tag_value +FROM aws.appstream.app_block_builder_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_block_builder_tags resource, see app_block_builders + diff --git a/website/docs/services/appstream/app_block_builders/index.md b/website/docs/services/appstream/app_block_builders/index.md new file mode 100644 index 0000000..186636d --- /dev/null +++ b/website/docs/services/appstream/app_block_builders/index.md @@ -0,0 +1,304 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an app_block_builder resource or lists app_block_builders in a region + +## Overview + + + + + + + +
Nameapp_block_builders
TypeResource
DescriptionResource Type definition for AWS::AppStream::AppBlockBuilder.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
array
object
boolean
string
string
string
array
stringAWS region.
+ +For more information, see AWS::AppStream::AppBlockBuilder. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all app_block_builders in a region. +```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_builders +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual app_block_builder. +```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_builders +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new app_block_builder resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.app_block_builders ( + Name, + Platform, + VpcConfig, + InstanceType, + region +) +SELECT +'{{ Name }}', + '{{ Platform }}', + '{{ VpcConfig }}', + '{{ InstanceType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.app_block_builders ( + Name, + Description, + DisplayName, + Platform, + AccessEndpoints, + Tags, + VpcConfig, + EnableDefaultInternetAccess, + IamRoleArn, + InstanceType, + AppBlockArns, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ Platform }}', + '{{ AccessEndpoints }}', + '{{ Tags }}', + '{{ VpcConfig }}', + '{{ EnableDefaultInternetAccess }}', + '{{ IamRoleArn }}', + '{{ InstanceType }}', + '{{ AppBlockArns }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: app_block_builder + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: Platform + value: '{{ Platform }}' + - name: AccessEndpoints + value: + - EndpointType: '{{ EndpointType }}' + VpceId: '{{ VpceId }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: VpcConfig + value: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: EnableDefaultInternetAccess + value: '{{ EnableDefaultInternetAccess }}' + - name: IamRoleArn + value: '{{ IamRoleArn }}' + - name: InstanceType + value: '{{ InstanceType }}' + - name: AppBlockArns + value: + - '{{ AppBlockArns[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appstream.app_block_builders +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +appstream:DescribeAppBlockBuilders +``` diff --git a/website/docs/services/appstream/app_block_builders_list_only/index.md b/website/docs/services/appstream/app_block_builders_list_only/index.md new file mode 100644 index 0000000..95ee90f --- /dev/null +++ b/website/docs/services/appstream/app_block_builders_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: app_block_builders_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - app_block_builders_list_only + - appstream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists app_block_builders in a region or regions, for all properties use app_block_builders + +## Overview + + + + + + + +
Nameapp_block_builders_list_only
TypeResource
DescriptionResource Type definition for AWS::AppStream::AppBlockBuilder.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all app_block_builders in a region. +```sql +SELECT +region, +name +FROM aws.appstream.app_block_builders_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_block_builders_list_only resource, see app_block_builders + diff --git a/website/docs/services/appstream/app_blocks/index.md b/website/docs/services/appstream/app_blocks/index.md new file mode 100644 index 0000000..6f7cb27 --- /dev/null +++ b/website/docs/services/appstream/app_blocks/index.md @@ -0,0 +1,227 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an app_block resource or lists app_blocks in a region + +## Overview + + + + + + + +
Nameapp_blocks
TypeResource
DescriptionResource Type definition for AWS::AppStream::AppBlock
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
array
string
string
object
stringAWS region.
+ +For more information, see AWS::AppStream::AppBlock. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual app_block. +```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_blocks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new app_block resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.app_blocks ( + Name, + SourceS3Location, + region +) +SELECT +'{{ Name }}', + '{{ SourceS3Location }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.app_blocks ( + Name, + Description, + DisplayName, + SourceS3Location, + SetupScriptDetails, + Tags, + PackagingType, + PostSetupScriptDetails, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ SourceS3Location }}', + '{{ SetupScriptDetails }}', + '{{ Tags }}', + '{{ PackagingType }}', + '{{ PostSetupScriptDetails }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: app_block + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: SourceS3Location + value: + S3Bucket: '{{ S3Bucket }}' + S3Key: '{{ S3Key }}' + - name: SetupScriptDetails + value: + ScriptS3Location: null + ExecutablePath: '{{ ExecutablePath }}' + ExecutableParameters: '{{ ExecutableParameters }}' + TimeoutInSeconds: '{{ TimeoutInSeconds }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: PackagingType + value: '{{ PackagingType }}' + - name: PostSetupScriptDetails + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appstream.app_blocks +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +appstream:DescribeAppBlocks +``` + +### Delete +```json +appstream:DeleteAppBlock +``` diff --git a/website/docs/services/appstream/application_entitlement_associations/index.md b/website/docs/services/appstream/application_entitlement_associations/index.md new file mode 100644 index 0000000..3bf22e1 --- /dev/null +++ b/website/docs/services/appstream/application_entitlement_associations/index.md @@ -0,0 +1,185 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application_entitlement_association resource or lists application_entitlement_associations in a region + +## Overview + + + + + + + +
Nameapplication_entitlement_associations
TypeResource
DescriptionResource Type definition for AWS::AppStream::ApplicationEntitlementAssociation
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +For more information, see AWS::AppStream::ApplicationEntitlementAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual application_entitlement_association. +```sql +SELECT +region, +stack_name, +entitlement_name, +application_identifier +FROM aws.appstream.application_entitlement_associations +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application_entitlement_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.application_entitlement_associations ( + StackName, + EntitlementName, + ApplicationIdentifier, + region +) +SELECT +'{{ StackName }}', + '{{ EntitlementName }}', + '{{ ApplicationIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.application_entitlement_associations ( + StackName, + EntitlementName, + ApplicationIdentifier, + region +) +SELECT + '{{ StackName }}', + '{{ EntitlementName }}', + '{{ ApplicationIdentifier }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application_entitlement_association + props: + - name: StackName + value: '{{ StackName }}' + - name: EntitlementName + value: '{{ EntitlementName }}' + - name: ApplicationIdentifier + value: '{{ ApplicationIdentifier }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appstream.application_entitlement_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the application_entitlement_associations resource, the following permissions are required: + +### Create +```json +appstream:AssociateApplicationToEntitlement, +appstream:ListEntitledApplications +``` + +### Read +```json +appstream:ListEntitledApplications +``` + +### Delete +```json +appstream:DisassociateApplicationFromEntitlement, +appstream:ListEntitledApplications +``` diff --git a/website/docs/services/appstream/application_fleet_associations/index.md b/website/docs/services/appstream/application_fleet_associations/index.md new file mode 100644 index 0000000..1d38471 --- /dev/null +++ b/website/docs/services/appstream/application_fleet_associations/index.md @@ -0,0 +1,177 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application_fleet_association resource or lists application_fleet_associations in a region + +## Overview + + + + + + + +
Nameapplication_fleet_associations
TypeResource
DescriptionResource Type definition for AWS::AppStream::ApplicationFleetAssociation
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +For more information, see AWS::AppStream::ApplicationFleetAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual application_fleet_association. +```sql +SELECT +region, +fleet_name, +application_arn +FROM aws.appstream.application_fleet_associations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application_fleet_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.application_fleet_associations ( + FleetName, + ApplicationArn, + region +) +SELECT +'{{ FleetName }}', + '{{ ApplicationArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.application_fleet_associations ( + FleetName, + ApplicationArn, + region +) +SELECT + '{{ FleetName }}', + '{{ ApplicationArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application_fleet_association + props: + - name: FleetName + value: '{{ FleetName }}' + - name: ApplicationArn + value: '{{ ApplicationArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appstream.application_fleet_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the application_fleet_associations resource, the following permissions are required: + +### Create +```json +appstream:AssociateApplicationFleet, +appstream:DescribeApplicationFleetAssociations +``` + +### Read +```json +appstream:DescribeApplicationFleetAssociations +``` + +### Delete +```json +appstream:DisassociateApplicationFleet, +appstream:DescribeApplicationFleetAssociations +``` diff --git a/website/docs/services/appstream/applications/index.md b/website/docs/services/appstream/applications/index.md new file mode 100644 index 0000000..c8eb40a --- /dev/null +++ b/website/docs/services/appstream/applications/index.md @@ -0,0 +1,267 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionResource Type definition for AWS::AppStream::Application
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
object
string
string
array
array
array
string
stringAWS region.
+ +For more information, see AWS::AppStream::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual application. +```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.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.applications ( + Name, + LaunchPath, + InstanceFamilies, + IconS3Location, + AppBlockArn, + Platforms, + region +) +SELECT +'{{ Name }}', + '{{ LaunchPath }}', + '{{ InstanceFamilies }}', + '{{ IconS3Location }}', + '{{ AppBlockArn }}', + '{{ Platforms }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.applications ( + Name, + DisplayName, + Description, + LaunchPath, + LaunchParameters, + WorkingDirectory, + InstanceFamilies, + IconS3Location, + AppBlockArn, + Platforms, + Tags, + AttributesToDelete, + region +) +SELECT + '{{ Name }}', + '{{ DisplayName }}', + '{{ Description }}', + '{{ LaunchPath }}', + '{{ LaunchParameters }}', + '{{ WorkingDirectory }}', + '{{ InstanceFamilies }}', + '{{ IconS3Location }}', + '{{ AppBlockArn }}', + '{{ Platforms }}', + '{{ Tags }}', + '{{ AttributesToDelete }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: Name + value: '{{ Name }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: Description + value: '{{ Description }}' + - name: LaunchPath + value: '{{ LaunchPath }}' + - name: LaunchParameters + value: '{{ LaunchParameters }}' + - name: WorkingDirectory + value: '{{ WorkingDirectory }}' + - name: InstanceFamilies + value: + - '{{ InstanceFamilies[0] }}' + - name: IconS3Location + value: + S3Bucket: '{{ S3Bucket }}' + S3Key: '{{ S3Key }}' + - name: AppBlockArn + value: '{{ AppBlockArn }}' + - name: Platforms + value: + - '{{ Platforms[0] }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: AttributesToDelete + value: + - '{{ AttributesToDelete[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appstream.applications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +s3:GetObject, +appstream:CreateApplication, +appstream:TagResource +``` + +### Read +```json +appstream:DescribeApplications +``` + +### Update +```json +appstream:UpdateApplication, +s3:GetObject +``` + +### Delete +```json +appstream:DeleteApplication +``` diff --git a/website/docs/services/appstream/directory_configs/index.md b/website/docs/services/appstream/directory_configs/index.md new file mode 100644 index 0000000..432a83f --- /dev/null +++ b/website/docs/services/appstream/directory_configs/index.md @@ -0,0 +1,254 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a directory_config resource or lists directory_configs in a region + +## Overview + + + + + + + +
Namedirectory_configs
TypeResource
DescriptionResource Type definition for AWS::AppStream::DirectoryConfig
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
array
object
string
object
stringAWS region.
+ +For more information, see AWS::AppStream::DirectoryConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all directory_configs in a region. +```sql +SELECT +region, +organizational_unit_distinguished_names, +service_account_credentials, +directory_name, +certificate_based_auth_properties +FROM aws.appstream.directory_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual directory_config. +```sql +SELECT +region, +organizational_unit_distinguished_names, +service_account_credentials, +directory_name, +certificate_based_auth_properties +FROM aws.appstream.directory_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new directory_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.directory_configs ( + OrganizationalUnitDistinguishedNames, + ServiceAccountCredentials, + DirectoryName, + region +) +SELECT +'{{ OrganizationalUnitDistinguishedNames }}', + '{{ ServiceAccountCredentials }}', + '{{ DirectoryName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.directory_configs ( + OrganizationalUnitDistinguishedNames, + ServiceAccountCredentials, + DirectoryName, + CertificateBasedAuthProperties, + region +) +SELECT + '{{ OrganizationalUnitDistinguishedNames }}', + '{{ ServiceAccountCredentials }}', + '{{ DirectoryName }}', + '{{ CertificateBasedAuthProperties }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: directory_config + props: + - name: OrganizationalUnitDistinguishedNames + value: + - '{{ OrganizationalUnitDistinguishedNames[0] }}' + - name: ServiceAccountCredentials + value: + AccountName: '{{ AccountName }}' + AccountPassword: '{{ AccountPassword }}' + - name: DirectoryName + value: '{{ DirectoryName }}' + - name: CertificateBasedAuthProperties + value: + Status: '{{ Status }}' + CertificateAuthorityArn: '{{ CertificateAuthorityArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appstream.directory_configs +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +appstream:CreateDirectoryConfig, +appstream:DeleteDirectoryConfig, +appstream:DescribeDirectoryConfigs, +appstream:UpdateDirectoryConfig, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` diff --git a/website/docs/services/appstream/directory_configs_list_only/index.md b/website/docs/services/appstream/directory_configs_list_only/index.md new file mode 100644 index 0000000..bb21063 --- /dev/null +++ b/website/docs/services/appstream/directory_configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: directory_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - directory_configs_list_only + - appstream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists directory_configs in a region or regions, for all properties use directory_configs + +## Overview + + + + + + + +
Namedirectory_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::AppStream::DirectoryConfig
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all directory_configs in a region. +```sql +SELECT +region, +directory_name +FROM aws.appstream.directory_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the directory_configs_list_only resource, see directory_configs + diff --git a/website/docs/services/appstream/entitlements/index.md b/website/docs/services/appstream/entitlements/index.md new file mode 100644 index 0000000..4384852 --- /dev/null +++ b/website/docs/services/appstream/entitlements/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an entitlement resource or lists entitlements in a region + +## Overview + + + + + + + +
Nameentitlements
TypeResource
DescriptionResource Type definition for AWS::AppStream::Entitlement
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
string
string
stringAWS region.
+ +For more information, see AWS::AppStream::Entitlement. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual entitlement. +```sql +SELECT +region, +name, +stack_name, +description, +app_visibility, +attributes, +created_time, +last_modified_time +FROM aws.appstream.entitlements +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new entitlement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.entitlements ( + Name, + StackName, + AppVisibility, + Attributes, + region +) +SELECT +'{{ Name }}', + '{{ StackName }}', + '{{ AppVisibility }}', + '{{ Attributes }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.entitlements ( + Name, + StackName, + Description, + AppVisibility, + Attributes, + region +) +SELECT + '{{ Name }}', + '{{ StackName }}', + '{{ Description }}', + '{{ AppVisibility }}', + '{{ Attributes }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: entitlement + props: + - name: Name + value: '{{ Name }}' + - name: StackName + value: '{{ StackName }}' + - name: Description + value: '{{ Description }}' + - name: AppVisibility + value: '{{ AppVisibility }}' + - name: Attributes + value: + - Name: '{{ Name }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appstream.entitlements +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the entitlements resource, the following permissions are required: + +### Create +```json +appstream:CreateEntitlement +``` + +### Read +```json +appstream:DescribeEntitlements +``` + +### Update +```json +appstream:UpdateEntitlement +``` + +### Delete +```json +appstream:DeleteEntitlement +``` diff --git a/website/docs/services/appstream/image_builder_tags/index.md b/website/docs/services/appstream/image_builder_tags/index.md new file mode 100644 index 0000000..15c4aa7 --- /dev/null +++ b/website/docs/services/appstream/image_builder_tags/index.md @@ -0,0 +1,101 @@ +--- +title: image_builder_tags +hide_title: false +hide_table_of_contents: false +keywords: + - image_builder_tags + - appstream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for image_builders in a region + +## Overview + + + + + + + +
Nameimage_builder_tags
TypeResource
DescriptionResource Type definition for AWS::AppStream::ImageBuilder
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
boolean
object
string
string
string
string
string
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all image_builders in a region. +```sql +SELECT +region, +description, +vpc_config, +enable_default_internet_access, +domain_join_info, +appstream_agent_version, +name, +image_name, +display_name, +iam_role_arn, +instance_type, +streaming_url, +image_arn, +access_endpoints, +tag_key, +tag_value +FROM aws.appstream.image_builder_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_builder_tags resource, see image_builders + diff --git a/website/docs/services/appstream/image_builders/index.md b/website/docs/services/appstream/image_builders/index.md new file mode 100644 index 0000000..e97c68c --- /dev/null +++ b/website/docs/services/appstream/image_builders/index.md @@ -0,0 +1,319 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an image_builder resource or lists image_builders in a region + +## Overview + + + + + + + +
Nameimage_builders
TypeResource
DescriptionResource Type definition for AWS::AppStream::ImageBuilder
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
boolean
object
string
string
string
string
string
string
array
string
string
array
stringAWS region.
+ +For more information, see AWS::AppStream::ImageBuilder. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all image_builders in a region. +```sql +SELECT +region, +description, +vpc_config, +enable_default_internet_access, +domain_join_info, +appstream_agent_version, +name, +image_name, +display_name, +iam_role_arn, +instance_type, +tags, +streaming_url, +image_arn, +access_endpoints +FROM aws.appstream.image_builders +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual image_builder. +```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_builders +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new image_builder resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.image_builders ( + Name, + InstanceType, + region +) +SELECT +'{{ Name }}', + '{{ InstanceType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appstream.image_builders ( + Description, + VpcConfig, + EnableDefaultInternetAccess, + DomainJoinInfo, + AppstreamAgentVersion, + Name, + ImageName, + DisplayName, + IamRoleArn, + InstanceType, + Tags, + ImageArn, + AccessEndpoints, + region +) +SELECT + '{{ Description }}', + '{{ VpcConfig }}', + '{{ EnableDefaultInternetAccess }}', + '{{ DomainJoinInfo }}', + '{{ AppstreamAgentVersion }}', + '{{ Name }}', + '{{ ImageName }}', + '{{ DisplayName }}', + '{{ IamRoleArn }}', + '{{ InstanceType }}', + '{{ Tags }}', + '{{ ImageArn }}', + '{{ AccessEndpoints }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: image_builder + props: + - name: Description + value: '{{ Description }}' + - name: VpcConfig + value: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: EnableDefaultInternetAccess + value: '{{ EnableDefaultInternetAccess }}' + - name: DomainJoinInfo + value: + OrganizationalUnitDistinguishedName: '{{ OrganizationalUnitDistinguishedName }}' + DirectoryName: '{{ DirectoryName }}' + - name: AppstreamAgentVersion + value: '{{ AppstreamAgentVersion }}' + - name: Name + value: '{{ Name }}' + - name: ImageName + value: '{{ ImageName }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: IamRoleArn + value: '{{ IamRoleArn }}' + - name: InstanceType + value: '{{ InstanceType }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: ImageArn + value: '{{ ImageArn }}' + - name: AccessEndpoints + value: + - EndpointType: '{{ EndpointType }}' + VpceId: '{{ VpceId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appstream.image_builders +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### 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/website/docs/services/appstream/image_builders_list_only/index.md b/website/docs/services/appstream/image_builders_list_only/index.md new file mode 100644 index 0000000..a0d3244 --- /dev/null +++ b/website/docs/services/appstream/image_builders_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: image_builders_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - image_builders_list_only + - appstream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists image_builders in a region or regions, for all properties use image_builders + +## Overview + + + + + + + +
Nameimage_builders_list_only
TypeResource
DescriptionResource Type definition for AWS::AppStream::ImageBuilder
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all image_builders in a region. +```sql +SELECT +region, +name +FROM aws.appstream.image_builders_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_builders_list_only resource, see image_builders + diff --git a/website/docs/services/appstream/index.md b/website/docs/services/appstream/index.md new file mode 100644 index 0000000..d0ae123 --- /dev/null +++ b/website/docs/services/appstream/index.md @@ -0,0 +1,48 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The appstream service documentation. + +:::info Service Summary + +
+
+total resources: 13
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/appsync/api_tags/index.md b/website/docs/services/appsync/api_tags/index.md new file mode 100644 index 0000000..cb8af46 --- /dev/null +++ b/website/docs/services/appsync/api_tags/index.md @@ -0,0 +1,87 @@ +--- +title: api_tags +hide_title: false +hide_table_of_contents: false +keywords: + - api_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for apis in a region + +## Overview + + + + + + + +
Nameapi_tags
TypeResource
DescriptionResource schema for AppSync Api
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the AppSync Api generated by the service
stringThe Amazon Resource Name (ARN) of the AppSync Api
stringThe name of the AppSync API.
stringThe owner contact information for an API resource.
objectA map of DNS names for the AppSync API.
objectThe configuration for an Event Api
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all apis in a region. +```sql +SELECT +region, +api_id, +api_arn, +name, +owner_contact, +dns, +event_config, +tag_key, +tag_value +FROM aws.appsync.api_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_tags resource, see apis + diff --git a/website/docs/services/appsync/apis/index.md b/website/docs/services/appsync/apis/index.md new file mode 100644 index 0000000..4d5c7ef --- /dev/null +++ b/website/docs/services/appsync/apis/index.md @@ -0,0 +1,257 @@ +--- +title: apis +hide_title: false +hide_table_of_contents: false +keywords: + - apis + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an api resource or lists apis in a region + +## Overview + + + + + + + +
Nameapis
TypeResource
DescriptionResource schema for AppSync Api
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the AppSync Api generated by the service
stringThe Amazon Resource Name (ARN) of the AppSync Api
stringThe name of the AppSync API.
stringThe owner contact information for an API resource.
objectA map of DNS names for the AppSync API.
objectThe configuration for an Event Api
arrayAn arbitrary set of tags (key-value pairs) for this AppSync API.
stringAWS region.
+ +For more information, see AWS::AppSync::Api. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all apis in a region. +```sql +SELECT +region, +api_id, +api_arn, +name, +owner_contact, +dns, +event_config, +tags +FROM aws.appsync.apis +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual api. +```sql +SELECT +region, +api_id, +api_arn, +name, +owner_contact, +dns, +event_config, +tags +FROM aws.appsync.apis +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new api resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.apis ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.apis ( + Name, + OwnerContact, + EventConfig, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ OwnerContact }}', + '{{ EventConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: api + props: + - name: Name + value: '{{ Name }}' + - name: OwnerContact + value: '{{ OwnerContact }}' + - name: EventConfig + value: + AuthProviders: + - AuthType: '{{ AuthType }}' + OpenIDConnectConfig: + ClientId: '{{ ClientId }}' + AuthTTL: null + Issuer: '{{ Issuer }}' + IatTTL: null + CognitoConfig: + AppIdClientRegex: '{{ AppIdClientRegex }}' + UserPoolId: '{{ UserPoolId }}' + AwsRegion: '{{ AwsRegion }}' + LambdaAuthorizerConfig: + IdentityValidationExpression: '{{ IdentityValidationExpression }}' + AuthorizerUri: '{{ AuthorizerUri }}' + AuthorizerResultTtlInSeconds: '{{ AuthorizerResultTtlInSeconds }}' + ConnectionAuthModes: + - AuthType: null + DefaultPublishAuthModes: null + DefaultSubscribeAuthModes: null + LogConfig: + LogLevel: '{{ LogLevel }}' + CloudWatchLogsRoleArn: '{{ CloudWatchLogsRoleArn }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appsync.apis +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the apis resource, the following permissions are required: + +### Create +```json +appsync:CreateApi, +appsync:TagResource, +appsync:GetApi, +iam:PassRole +``` + +### Read +```json +appsync:GetApi, +appsync:ListTagsForResource +``` + +### Update +```json +appsync:UpdateApi, +appsync:TagResource, +appsync:UntagResource, +appsync:GetApi, +iam:PassRole +``` + +### Delete +```json +appsync:DeleteApi, +appsync:UntagResource +``` + +### List +```json +appsync:ListApis +``` diff --git a/website/docs/services/appsync/apis_list_only/index.md b/website/docs/services/appsync/apis_list_only/index.md new file mode 100644 index 0000000..42048b2 --- /dev/null +++ b/website/docs/services/appsync/apis_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: apis_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - apis_list_only + - appsync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists apis in a region or regions, for all properties use apis + +## Overview + + + + + + + +
Nameapis_list_only
TypeResource
DescriptionResource schema for AppSync Api
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the AppSync Api
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all apis in a region. +```sql +SELECT +region, +api_arn +FROM aws.appsync.apis_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the apis_list_only resource, see apis + diff --git a/website/docs/services/appsync/channel_namespace_tags/index.md b/website/docs/services/appsync/channel_namespace_tags/index.md new file mode 100644 index 0000000..461f0ef --- /dev/null +++ b/website/docs/services/appsync/channel_namespace_tags/index.md @@ -0,0 +1,89 @@ +--- +title: channel_namespace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_namespace_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channel_namespaces in a region + +## Overview + + + + + + + +
Namechannel_namespace_tags
TypeResource
DescriptionResource schema for AppSync ChannelNamespace
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringAppSync Api Id that this Channel Namespace belongs to.
stringNamespace indentifier.
arrayList of AuthModes supported for Subscribe operations.
arrayList of AuthModes supported for Publish operations.
stringString of APPSYNC_JS code to be used by the handlers.
stringThe Amazon S3 endpoint where the code is located.
stringThe Amazon Resource Name (ARN) for the Channel Namespace.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channel_namespaces in a region. +```sql +SELECT +region, +api_id, +name, +subscribe_auth_modes, +publish_auth_modes, +code_handlers, +code_s3_location, +channel_namespace_arn, +tag_key, +tag_value +FROM aws.appsync.channel_namespace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_namespace_tags resource, see channel_namespaces + diff --git a/website/docs/services/appsync/channel_namespaces/index.md b/website/docs/services/appsync/channel_namespaces/index.md new file mode 100644 index 0000000..531368e --- /dev/null +++ b/website/docs/services/appsync/channel_namespaces/index.md @@ -0,0 +1,253 @@ +--- +title: channel_namespaces +hide_title: false +hide_table_of_contents: false +keywords: + - channel_namespaces + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a channel_namespace resource or lists channel_namespaces in a region + +## Overview + + + + + + + +
Namechannel_namespaces
TypeResource
DescriptionResource schema for AppSync ChannelNamespace
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringAppSync Api Id that this Channel Namespace belongs to.
stringNamespace indentifier.
arrayList of AuthModes supported for Subscribe operations.
arrayList of AuthModes supported for Publish operations.
stringString of APPSYNC_JS code to be used by the handlers.
stringThe Amazon S3 endpoint where the code is located.
stringThe Amazon Resource Name (ARN) for the Channel Namespace.
arrayAn arbitrary set of tags (key-value pairs) for this AppSync API.
stringAWS region.
+ +For more information, see AWS::AppSync::ChannelNamespace. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all channel_namespaces in a region. +```sql +SELECT +region, +api_id, +name, +subscribe_auth_modes, +publish_auth_modes, +code_handlers, +code_s3_location, +channel_namespace_arn, +tags +FROM aws.appsync.channel_namespaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual channel_namespace. +```sql +SELECT +region, +api_id, +name, +subscribe_auth_modes, +publish_auth_modes, +code_handlers, +code_s3_location, +channel_namespace_arn, +tags +FROM aws.appsync.channel_namespaces +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new channel_namespace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.channel_namespaces ( + ApiId, + Name, + region +) +SELECT +'{{ ApiId }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.channel_namespaces ( + ApiId, + Name, + SubscribeAuthModes, + PublishAuthModes, + CodeHandlers, + CodeS3Location, + Tags, + region +) +SELECT + '{{ ApiId }}', + '{{ Name }}', + '{{ SubscribeAuthModes }}', + '{{ PublishAuthModes }}', + '{{ CodeHandlers }}', + '{{ CodeS3Location }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: channel_namespace + props: + - name: ApiId + value: '{{ ApiId }}' + - name: Name + value: '{{ Name }}' + - name: SubscribeAuthModes + value: + - AuthType: '{{ AuthType }}' + - name: PublishAuthModes + value: null + - name: CodeHandlers + value: '{{ CodeHandlers }}' + - name: CodeS3Location + value: '{{ CodeS3Location }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appsync.channel_namespaces +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the channel_namespaces resource, the following permissions are required: + +### Create +```json +appsync:CreateChannelNamespace, +appsync:TagResource, +appsync:GetChannelNamespace, +s3:GetObject +``` + +### Read +```json +appsync:GetChannelNamespace, +appsync:ListTagsForResource +``` + +### Update +```json +appsync:UpdateChannelNamespace, +appsync:TagResource, +appsync:UntagResource, +appsync:GetChannelNamespace, +s3:GetObject +``` + +### Delete +```json +appsync:DeleteChannelNamespace, +appsync:UntagResource +``` + +### List +```json +appsync:ListChannelNamespaces +``` diff --git a/website/docs/services/appsync/channel_namespaces_list_only/index.md b/website/docs/services/appsync/channel_namespaces_list_only/index.md new file mode 100644 index 0000000..60706a8 --- /dev/null +++ b/website/docs/services/appsync/channel_namespaces_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: channel_namespaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channel_namespaces_list_only + - appsync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channel_namespaces in a region or regions, for all properties use channel_namespaces + +## Overview + + + + + + + +
Namechannel_namespaces_list_only
TypeResource
DescriptionResource schema for AppSync ChannelNamespace
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringNamespace indentifier.
stringThe Amazon Resource Name (ARN) for the Channel Namespace.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channel_namespaces in a region. +```sql +SELECT +region, +channel_namespace_arn +FROM aws.appsync.channel_namespaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_namespaces_list_only resource, see channel_namespaces + diff --git a/website/docs/services/appsync/data_sources/index.md b/website/docs/services/appsync/data_sources/index.md new file mode 100644 index 0000000..0500709 --- /dev/null +++ b/website/docs/services/appsync/data_sources/index.md @@ -0,0 +1,316 @@ +--- +title: data_sources +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_source resource or lists data_sources in a region + +## Overview + + + + + + + +
Namedata_sources
TypeResource
DescriptionResource Type definition for AWS::AppSync::DataSource
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique AWS AppSync GraphQL API identifier where this data source will be created.
stringThe description of the data source.
objectAWS Region and TableName for an Amazon DynamoDB table in your account.
objectAWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
As of September 2021, Amazon Elasticsearch Service is Amazon OpenSearch Service. This property is deprecated. For new data sources, use OpenSearchServiceConfig to specify an OpenSearch Service data source.
objectARN for the EventBridge bus.
objectEndpoints for an HTTP data source.
objectAn ARN of a Lambda function in valid ARN format. This can be the ARN of a Lambda function that exists in the current account or in another account.
stringFriendly name for you to identify your AppSync data source after creation.
objectAWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
objectRelational Database configuration of the relational database data source.
stringThe AWS Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source.
stringThe type of the data source.
stringThe Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename.
string
stringAWS region.
+ +For more information, see AWS::AppSync::DataSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_sources in a region. +```sql +SELECT +region, +api_id, +description, +dynamo_db_config, +elasticsearch_config, +event_bridge_config, +http_config, +lambda_config, +name, +open_search_service_config, +relational_database_config, +service_role_arn, +type, +data_source_arn, +metrics_config +FROM aws.appsync.data_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_source. +```sql +SELECT +region, +api_id, +description, +dynamo_db_config, +elasticsearch_config, +event_bridge_config, +http_config, +lambda_config, +name, +open_search_service_config, +relational_database_config, +service_role_arn, +type, +data_source_arn, +metrics_config +FROM aws.appsync.data_sources +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.data_sources ( + ApiId, + Name, + Type, + region +) +SELECT +'{{ ApiId }}', + '{{ Name }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.data_sources ( + ApiId, + Description, + DynamoDBConfig, + ElasticsearchConfig, + EventBridgeConfig, + HttpConfig, + LambdaConfig, + Name, + OpenSearchServiceConfig, + RelationalDatabaseConfig, + ServiceRoleArn, + Type, + MetricsConfig, + region +) +SELECT + '{{ ApiId }}', + '{{ Description }}', + '{{ DynamoDBConfig }}', + '{{ ElasticsearchConfig }}', + '{{ EventBridgeConfig }}', + '{{ HttpConfig }}', + '{{ LambdaConfig }}', + '{{ Name }}', + '{{ OpenSearchServiceConfig }}', + '{{ RelationalDatabaseConfig }}', + '{{ ServiceRoleArn }}', + '{{ Type }}', + '{{ MetricsConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_source + props: + - name: ApiId + value: '{{ ApiId }}' + - name: Description + value: '{{ Description }}' + - name: DynamoDBConfig + value: + TableName: '{{ TableName }}' + DeltaSyncConfig: + BaseTableTTL: '{{ BaseTableTTL }}' + DeltaSyncTableTTL: '{{ DeltaSyncTableTTL }}' + DeltaSyncTableName: '{{ DeltaSyncTableName }}' + UseCallerCredentials: '{{ UseCallerCredentials }}' + AwsRegion: '{{ AwsRegion }}' + Versioned: '{{ Versioned }}' + - name: ElasticsearchConfig + value: + AwsRegion: '{{ AwsRegion }}' + Endpoint: '{{ Endpoint }}' + - name: EventBridgeConfig + value: + EventBusArn: '{{ EventBusArn }}' + - name: HttpConfig + value: + Endpoint: '{{ Endpoint }}' + AuthorizationConfig: + AuthorizationType: '{{ AuthorizationType }}' + AwsIamConfig: + SigningRegion: '{{ SigningRegion }}' + SigningServiceName: '{{ SigningServiceName }}' + - name: LambdaConfig + value: + LambdaFunctionArn: '{{ LambdaFunctionArn }}' + - name: Name + value: '{{ Name }}' + - name: OpenSearchServiceConfig + value: + AwsRegion: '{{ AwsRegion }}' + Endpoint: '{{ Endpoint }}' + - name: RelationalDatabaseConfig + value: + RdsHttpEndpointConfig: + DatabaseName: '{{ DatabaseName }}' + AwsRegion: '{{ AwsRegion }}' + DbClusterIdentifier: '{{ DbClusterIdentifier }}' + AwsSecretStoreArn: '{{ AwsSecretStoreArn }}' + Schema: '{{ Schema }}' + RelationalDatabaseSourceType: '{{ RelationalDatabaseSourceType }}' + - name: ServiceRoleArn + value: '{{ ServiceRoleArn }}' + - name: Type + value: '{{ Type }}' + - name: MetricsConfig + value: '{{ MetricsConfig }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appsync.data_sources +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the data_sources resource, the following permissions are required: + +### Create +```json +appsync:CreateDataSource, +appsync:GetDataSource, +iam:PassRole +``` + +### Read +```json +appsync:GetDataSource +``` + +### Update +```json +appsync:UpdateDataSource, +iam:PassRole +``` + +### Delete +```json +appsync:DeleteDataSource, +appsync:GetDataSource +``` + +### List +```json +appsync:ListDataSources +``` diff --git a/website/docs/services/appsync/data_sources_list_only/index.md b/website/docs/services/appsync/data_sources_list_only/index.md new file mode 100644 index 0000000..87877f9 --- /dev/null +++ b/website/docs/services/appsync/data_sources_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - appsync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionResource Type definition for AWS::AppSync::DataSource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +data_source_arn +FROM aws.appsync.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + diff --git a/website/docs/services/appsync/domain_name_api_associations/index.md b/website/docs/services/appsync/domain_name_api_associations/index.md new file mode 100644 index 0000000..d2f48f9 --- /dev/null +++ b/website/docs/services/appsync/domain_name_api_associations/index.md @@ -0,0 +1,190 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain_name_api_association resource or lists domain_name_api_associations in a region + +## Overview + + + + + + + +
Namedomain_name_api_associations
TypeResource
DescriptionResource Type definition for AWS::AppSync::DomainNameApiAssociation
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +For more information, see AWS::AppSync::DomainNameApiAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual domain_name_api_association. +```sql +SELECT +region, +domain_name, +api_id, +api_association_identifier +FROM aws.appsync.domain_name_api_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain_name_api_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.domain_name_api_associations ( + DomainName, + ApiId, + region +) +SELECT +'{{ DomainName }}', + '{{ ApiId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.domain_name_api_associations ( + DomainName, + ApiId, + region +) +SELECT + '{{ DomainName }}', + '{{ ApiId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain_name_api_association + props: + - name: DomainName + value: '{{ DomainName }}' + - name: ApiId + value: '{{ ApiId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appsync.domain_name_api_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +appsync:DisassociateApi, +appsync:GetApiAssociation +``` + +### Update +```json +appsync:AssociateApi, +appsync:GetApiAssociation +``` + +### Read +```json +appsync:GetApiAssociation +``` diff --git a/website/docs/services/appsync/domain_names/index.md b/website/docs/services/appsync/domain_names/index.md new file mode 100644 index 0000000..704aad0 --- /dev/null +++ b/website/docs/services/appsync/domain_names/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain_name resource or lists domain_names in a region + +## Overview + + + + + + + +
Namedomain_names
TypeResource
DescriptionResource Type definition for AWS::AppSync::DomainName
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringAWS region.
+ +For more information, see AWS::AppSync::DomainName. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domain_names in a region. +```sql +SELECT +region, +domain_name, +description, +certificate_arn, +app_sync_domain_name, +hosted_zone_id +FROM aws.appsync.domain_names +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain_name. +```sql +SELECT +region, +domain_name, +description, +certificate_arn, +app_sync_domain_name, +hosted_zone_id +FROM aws.appsync.domain_names +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain_name resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.domain_names ( + DomainName, + CertificateArn, + region +) +SELECT +'{{ DomainName }}', + '{{ CertificateArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.domain_names ( + DomainName, + Description, + CertificateArn, + region +) +SELECT + '{{ DomainName }}', + '{{ Description }}', + '{{ CertificateArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain_name + props: + - name: DomainName + value: '{{ DomainName }}' + - name: Description + value: '{{ Description }}' + - name: CertificateArn + value: '{{ CertificateArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appsync.domain_names +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +appsync:GetDomainName, +appsync:DeleteDomainName +``` + +### Update +```json +appsync:UpdateDomainName +``` + +### Read +```json +appsync:GetDomainName +``` + +### List +```json +appsync:ListDomainNames +``` diff --git a/website/docs/services/appsync/domain_names_list_only/index.md b/website/docs/services/appsync/domain_names_list_only/index.md new file mode 100644 index 0000000..cd0f38b --- /dev/null +++ b/website/docs/services/appsync/domain_names_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domain_names_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domain_names_list_only + - appsync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domain_names in a region or regions, for all properties use domain_names + +## Overview + + + + + + + +
Namedomain_names_list_only
TypeResource
DescriptionResource Type definition for AWS::AppSync::DomainName
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domain_names in a region. +```sql +SELECT +region, +domain_name +FROM aws.appsync.domain_names_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_names_list_only resource, see domain_names + diff --git a/website/docs/services/appsync/function_configurations/index.md b/website/docs/services/appsync/function_configurations/index.md new file mode 100644 index 0000000..b628488 --- /dev/null +++ b/website/docs/services/appsync/function_configurations/index.md @@ -0,0 +1,303 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a function_configuration resource or lists function_configurations in a region + +## Overview + + + + + + + +
Namefunction_configurations
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the function generated by the service
stringThe ARN for the function generated by the service
stringThe AWS AppSync GraphQL API that you want to attach using this function.
stringThe resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
stringThe Amazon S3 endpoint (where the code is located??).
stringThe name of data source this function will attach.
stringThe function description.
stringThe version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
integerThe maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
stringThe name of the function.
stringThe Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
stringDescribes a Sync configuration for a resolver. Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.
stringThe Function response mapping template.
stringThe location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
objectDescribes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
objectDescribes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
stringAWS region.
+ +For more information, see AWS::AppSync::FunctionConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all function_configurations in a region. +```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_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual function_configuration. +```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_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new function_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.function_configurations ( + ApiId, + DataSourceName, + Name, + region +) +SELECT +'{{ ApiId }}', + '{{ DataSourceName }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.function_configurations ( + ApiId, + Code, + CodeS3Location, + DataSourceName, + Description, + FunctionVersion, + MaxBatchSize, + Name, + RequestMappingTemplate, + RequestMappingTemplateS3Location, + ResponseMappingTemplate, + ResponseMappingTemplateS3Location, + Runtime, + SyncConfig, + region +) +SELECT + '{{ ApiId }}', + '{{ Code }}', + '{{ CodeS3Location }}', + '{{ DataSourceName }}', + '{{ Description }}', + '{{ FunctionVersion }}', + '{{ MaxBatchSize }}', + '{{ Name }}', + '{{ RequestMappingTemplate }}', + '{{ RequestMappingTemplateS3Location }}', + '{{ ResponseMappingTemplate }}', + '{{ ResponseMappingTemplateS3Location }}', + '{{ Runtime }}', + '{{ SyncConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: function_configuration + props: + - name: ApiId + value: '{{ ApiId }}' + - name: Code + value: '{{ Code }}' + - name: CodeS3Location + value: '{{ CodeS3Location }}' + - name: DataSourceName + value: '{{ DataSourceName }}' + - name: Description + value: '{{ Description }}' + - name: FunctionVersion + value: '{{ FunctionVersion }}' + - name: MaxBatchSize + value: '{{ MaxBatchSize }}' + - name: Name + value: '{{ Name }}' + - name: RequestMappingTemplate + value: '{{ RequestMappingTemplate }}' + - name: RequestMappingTemplateS3Location + value: '{{ RequestMappingTemplateS3Location }}' + - name: ResponseMappingTemplate + value: '{{ ResponseMappingTemplate }}' + - name: ResponseMappingTemplateS3Location + value: '{{ ResponseMappingTemplateS3Location }}' + - name: Runtime + value: + RuntimeVersion: '{{ RuntimeVersion }}' + Name: '{{ Name }}' + - name: SyncConfig + value: + ConflictHandler: '{{ ConflictHandler }}' + ConflictDetection: '{{ ConflictDetection }}' + LambdaConflictHandlerConfig: + LambdaConflictHandlerArn: '{{ LambdaConflictHandlerArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appsync.function_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the function_configurations resource, the following permissions are required: + +### Create +```json +s3:GetObject, +appsync:CreateFunction +``` + +### Read +```json +appsync:GetFunction +``` + +### Update +```json +s3:GetObject, +appsync:UpdateFunction +``` + +### Delete +```json +appsync:DeleteFunction +``` + +### List +```json +appsync:ListFunctions +``` diff --git a/website/docs/services/appsync/function_configurations_list_only/index.md b/website/docs/services/appsync/function_configurations_list_only/index.md new file mode 100644 index 0000000..06b3ebd --- /dev/null +++ b/website/docs/services/appsync/function_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: function_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - function_configurations_list_only + - appsync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists function_configurations in a region or regions, for all properties use function_configurations + +## Overview + + + + + + + +
Namefunction_configurations_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN for the function generated by the service
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all function_configurations in a region. +```sql +SELECT +region, +function_arn +FROM aws.appsync.function_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the function_configurations_list_only resource, see function_configurations + diff --git a/website/docs/services/appsync/graphql_api_tags/index.md b/website/docs/services/appsync/graphql_api_tags/index.md new file mode 100644 index 0000000..14761b9 --- /dev/null +++ b/website/docs/services/appsync/graphql_api_tags/index.md @@ -0,0 +1,123 @@ +--- +title: graphql_api_tags +hide_title: false +hide_table_of_contents: false +keywords: + - graphql_api_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for graphql_apis in a region + +## Overview + + + + + + + +
Namegraphql_api_tags
TypeResource
DescriptionResource Type definition for AWS::AppSync::GraphQLApi
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayA list of additional authentication providers for the GraphqlApi API.
stringUnique AWS AppSync GraphQL API identifier.
stringThe value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
stringThe Amazon Resource Name (ARN) of the API key
stringSecurity configuration for your GraphQL API
objectEnables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
objectA map containing the list of resources with their properties and environment variables.
stringThe fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
stringThe GraphQL endpoint ARN.
stringThe Endpoint URL of your GraphQL API.
stringSets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
objectA LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
objectThe Amazon CloudWatch Logs configuration.
stringThe AWS Identity and Access Management service role ARN for a merged API.
stringThe API name
objectThe OpenID Connect configuration.
stringThe owner contact information for an API resource.
integerThe maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query.
stringThe fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
stringThe GraphQL API real-time endpoint URL.
integerThe maximum number of resolvers that can be invoked in a single request.
objectOptional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
stringSets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided.
booleanA flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all graphql_apis in a region. +```sql +SELECT +region, +additional_authentication_providers, +api_id, +api_type, +arn, +authentication_type, +enhanced_metrics_config, +environment_variables, +graph_ql_dns, +graph_ql_endpoint_arn, +graph_ql_url, +introspection_config, +lambda_authorizer_config, +log_config, +merged_api_execution_role_arn, +name, +open_id_connect_config, +owner_contact, +query_depth_limit, +realtime_dns, +realtime_url, +resolver_count_limit, +user_pool_config, +visibility, +xray_enabled, +tag_key, +tag_value +FROM aws.appsync.graphql_api_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the graphql_api_tags resource, see graphql_apis + diff --git a/website/docs/services/appsync/graphql_apis/index.md b/website/docs/services/appsync/graphql_apis/index.md new file mode 100644 index 0000000..9e8345f --- /dev/null +++ b/website/docs/services/appsync/graphql_apis/index.md @@ -0,0 +1,368 @@ +--- +title: graphql_apis +hide_title: false +hide_table_of_contents: false +keywords: + - graphql_apis + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a graphql_api resource or lists graphql_apis in a region + +## Overview + + + + + + + +
Namegraphql_apis
TypeResource
DescriptionResource Type definition for AWS::AppSync::GraphQLApi
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayA list of additional authentication providers for the GraphqlApi API.
stringUnique AWS AppSync GraphQL API identifier.
stringThe value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
stringThe Amazon Resource Name (ARN) of the API key
stringSecurity configuration for your GraphQL API
objectEnables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
objectA map containing the list of resources with their properties and environment variables.
stringThe fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
stringThe GraphQL endpoint ARN.
stringThe Endpoint URL of your GraphQL API.
stringSets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
objectA LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
objectThe Amazon CloudWatch Logs configuration.
stringThe AWS Identity and Access Management service role ARN for a merged API.
stringThe API name
objectThe OpenID Connect configuration.
stringThe owner contact information for an API resource.
integerThe maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query.
stringThe fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
stringThe GraphQL API real-time endpoint URL.
integerThe maximum number of resolvers that can be invoked in a single request.
arrayAn arbitrary set of tags (key-value pairs) for this GraphQL API.
objectOptional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
stringSets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided.
booleanA flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.
stringAWS region.
+ +For more information, see AWS::AppSync::GraphQLApi. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all graphql_apis in a region. +```sql +SELECT +region, +additional_authentication_providers, +api_id, +api_type, +arn, +authentication_type, +enhanced_metrics_config, +environment_variables, +graph_ql_dns, +graph_ql_endpoint_arn, +graph_ql_url, +introspection_config, +lambda_authorizer_config, +log_config, +merged_api_execution_role_arn, +name, +open_id_connect_config, +owner_contact, +query_depth_limit, +realtime_dns, +realtime_url, +resolver_count_limit, +tags, +user_pool_config, +visibility, +xray_enabled +FROM aws.appsync.graphql_apis +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual graphql_api. +```sql +SELECT +region, +additional_authentication_providers, +api_id, +api_type, +arn, +authentication_type, +enhanced_metrics_config, +environment_variables, +graph_ql_dns, +graph_ql_endpoint_arn, +graph_ql_url, +introspection_config, +lambda_authorizer_config, +log_config, +merged_api_execution_role_arn, +name, +open_id_connect_config, +owner_contact, +query_depth_limit, +realtime_dns, +realtime_url, +resolver_count_limit, +tags, +user_pool_config, +visibility, +xray_enabled +FROM aws.appsync.graphql_apis +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new graphql_api resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.graphql_apis ( + AuthenticationType, + Name, + region +) +SELECT +'{{ AuthenticationType }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.graphql_apis ( + AdditionalAuthenticationProviders, + ApiType, + AuthenticationType, + EnhancedMetricsConfig, + EnvironmentVariables, + IntrospectionConfig, + LambdaAuthorizerConfig, + LogConfig, + MergedApiExecutionRoleArn, + Name, + OpenIDConnectConfig, + OwnerContact, + QueryDepthLimit, + ResolverCountLimit, + Tags, + UserPoolConfig, + Visibility, + XrayEnabled, + region +) +SELECT + '{{ AdditionalAuthenticationProviders }}', + '{{ ApiType }}', + '{{ AuthenticationType }}', + '{{ EnhancedMetricsConfig }}', + '{{ EnvironmentVariables }}', + '{{ IntrospectionConfig }}', + '{{ LambdaAuthorizerConfig }}', + '{{ LogConfig }}', + '{{ MergedApiExecutionRoleArn }}', + '{{ Name }}', + '{{ OpenIDConnectConfig }}', + '{{ OwnerContact }}', + '{{ QueryDepthLimit }}', + '{{ ResolverCountLimit }}', + '{{ Tags }}', + '{{ UserPoolConfig }}', + '{{ Visibility }}', + '{{ XrayEnabled }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: graphql_api + props: + - name: AdditionalAuthenticationProviders + value: + - LambdaAuthorizerConfig: + IdentityValidationExpression: '{{ IdentityValidationExpression }}' + AuthorizerUri: '{{ AuthorizerUri }}' + AuthorizerResultTtlInSeconds: '{{ AuthorizerResultTtlInSeconds }}' + OpenIDConnectConfig: + ClientId: '{{ ClientId }}' + AuthTTL: null + Issuer: '{{ Issuer }}' + IatTTL: null + UserPoolConfig: + AppIdClientRegex: '{{ AppIdClientRegex }}' + UserPoolId: '{{ UserPoolId }}' + AwsRegion: '{{ AwsRegion }}' + AuthenticationType: '{{ AuthenticationType }}' + - name: ApiType + value: '{{ ApiType }}' + - name: AuthenticationType + value: '{{ AuthenticationType }}' + - name: EnhancedMetricsConfig + value: + OperationLevelMetricsConfig: '{{ OperationLevelMetricsConfig }}' + ResolverLevelMetricsBehavior: '{{ ResolverLevelMetricsBehavior }}' + DataSourceLevelMetricsBehavior: '{{ DataSourceLevelMetricsBehavior }}' + - name: EnvironmentVariables + value: {} + - name: IntrospectionConfig + value: '{{ IntrospectionConfig }}' + - name: LambdaAuthorizerConfig + value: null + - name: LogConfig + value: + ExcludeVerboseContent: '{{ ExcludeVerboseContent }}' + FieldLogLevel: '{{ FieldLogLevel }}' + CloudWatchLogsRoleArn: '{{ CloudWatchLogsRoleArn }}' + - name: MergedApiExecutionRoleArn + value: '{{ MergedApiExecutionRoleArn }}' + - name: Name + value: '{{ Name }}' + - name: OpenIDConnectConfig + value: null + - name: OwnerContact + value: '{{ OwnerContact }}' + - name: QueryDepthLimit + value: '{{ QueryDepthLimit }}' + - name: ResolverCountLimit + value: '{{ ResolverCountLimit }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: UserPoolConfig + value: + AppIdClientRegex: '{{ AppIdClientRegex }}' + UserPoolId: '{{ UserPoolId }}' + AwsRegion: '{{ AwsRegion }}' + DefaultAction: '{{ DefaultAction }}' + - name: Visibility + value: '{{ Visibility }}' + - name: XrayEnabled + value: '{{ XrayEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appsync.graphql_apis +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the graphql_apis resource, the following permissions are required: + +### Create +```json +appsync:CreateGraphqlApi, +appsync:TagResource +``` + +### Read +```json +appsync:GetGraphqlApi, +appsync:GetGraphqlApiEnvironmentVariables, +appsync:ListTagsForResource +``` + +### Update +```json +appsync:GetGraphqlApi, +appsync:UpdateGraphqlApi, +appsync:TagResource, +appsync:UntagResource +``` + +### Delete +```json +appsync:DeleteGraphqlApi +``` + +### List +```json +appsync:ListGraphqlApis +``` diff --git a/website/docs/services/appsync/graphql_apis_list_only/index.md b/website/docs/services/appsync/graphql_apis_list_only/index.md new file mode 100644 index 0000000..4fd5324 --- /dev/null +++ b/website/docs/services/appsync/graphql_apis_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: graphql_apis_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - graphql_apis_list_only + - appsync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists graphql_apis in a region or regions, for all properties use graphql_apis + +## Overview + + + + + + + +
Namegraphql_apis_list_only
TypeResource
DescriptionResource Type definition for AWS::AppSync::GraphQLApi
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique AWS AppSync GraphQL API identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all graphql_apis in a region. +```sql +SELECT +region, +api_id +FROM aws.appsync.graphql_apis_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the graphql_apis_list_only resource, see graphql_apis + diff --git a/website/docs/services/appsync/index.md b/website/docs/services/appsync/index.md new file mode 100644 index 0000000..4988a77 --- /dev/null +++ b/website/docs/services/appsync/index.md @@ -0,0 +1,55 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The appsync service documentation. + +:::info Service Summary + +
+
+total resources: 20
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/appsync/resolvers/index.md b/website/docs/services/appsync/resolvers/index.md new file mode 100644 index 0000000..ab2486a --- /dev/null +++ b/website/docs/services/appsync/resolvers/index.md @@ -0,0 +1,327 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resolver resource or lists 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).
When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.
See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe APSYlong GraphQL API to which you want to attach this resolver.
objectThe caching configuration for the resolver.
stringThe resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
stringThe Amazon S3 endpoint.
stringThe resolver data source name.
stringThe GraphQL field on a type that invokes the resolver.
stringThe resolver type.
+ *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
+ *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
integerThe maximum number of resolver request inputs that will be sent to a single LAMlong function in a BatchInvoke operation.
objectFunctions linked with the pipeline resolver.
stringThe request mapping template.
Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
stringThe location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
string
stringThe response mapping template.
stringThe location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
objectDescribes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
objectThe SyncConfig for a resolver attached to a versioned data source.
stringThe GraphQL type that invokes this resolver.
stringEnables or disables enhanced resolver metrics for specified resolvers. Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.
stringAWS region.
+ +For more information, see AWS::AppSync::Resolver. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resolvers in a region. +```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.resolvers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resolver. +```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.resolvers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resolver resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.resolvers ( + ApiId, + FieldName, + TypeName, + region +) +SELECT +'{{ ApiId }}', + '{{ FieldName }}', + '{{ TypeName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.resolvers ( + ApiId, + CachingConfig, + Code, + CodeS3Location, + DataSourceName, + FieldName, + Kind, + MaxBatchSize, + PipelineConfig, + RequestMappingTemplate, + RequestMappingTemplateS3Location, + ResponseMappingTemplate, + ResponseMappingTemplateS3Location, + Runtime, + SyncConfig, + TypeName, + MetricsConfig, + region +) +SELECT + '{{ ApiId }}', + '{{ CachingConfig }}', + '{{ Code }}', + '{{ CodeS3Location }}', + '{{ DataSourceName }}', + '{{ FieldName }}', + '{{ Kind }}', + '{{ MaxBatchSize }}', + '{{ PipelineConfig }}', + '{{ RequestMappingTemplate }}', + '{{ RequestMappingTemplateS3Location }}', + '{{ ResponseMappingTemplate }}', + '{{ ResponseMappingTemplateS3Location }}', + '{{ Runtime }}', + '{{ SyncConfig }}', + '{{ TypeName }}', + '{{ MetricsConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resolver + props: + - name: ApiId + value: '{{ ApiId }}' + - name: CachingConfig + value: + CachingKeys: + - '{{ CachingKeys[0] }}' + Ttl: null + - name: Code + value: '{{ Code }}' + - name: CodeS3Location + value: '{{ CodeS3Location }}' + - name: DataSourceName + value: '{{ DataSourceName }}' + - name: FieldName + value: '{{ FieldName }}' + - name: Kind + value: '{{ Kind }}' + - name: MaxBatchSize + value: '{{ MaxBatchSize }}' + - name: PipelineConfig + value: + Functions: + - '{{ Functions[0] }}' + - name: RequestMappingTemplate + value: '{{ RequestMappingTemplate }}' + - name: RequestMappingTemplateS3Location + value: '{{ RequestMappingTemplateS3Location }}' + - name: ResponseMappingTemplate + value: '{{ ResponseMappingTemplate }}' + - name: ResponseMappingTemplateS3Location + value: '{{ ResponseMappingTemplateS3Location }}' + - name: Runtime + value: + RuntimeVersion: '{{ RuntimeVersion }}' + Name: '{{ Name }}' + - name: SyncConfig + value: + ConflictHandler: '{{ ConflictHandler }}' + ConflictDetection: '{{ ConflictDetection }}' + LambdaConflictHandlerConfig: + LambdaConflictHandlerArn: '{{ LambdaConflictHandlerArn }}' + - name: TypeName + value: '{{ TypeName }}' + - name: MetricsConfig + value: '{{ MetricsConfig }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appsync.resolvers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resolvers resource, the following permissions are required: + +### Create +```json +s3:GetObject, +appsync:CreateResolver, +appsync:GetResolver +``` + +### Read +```json +appsync:GetResolver +``` + +### Update +```json +s3:GetObject, +appsync:UpdateResolver +``` + +### Delete +```json +appsync:DeleteResolver +``` + +### List +```json +appsync:ListResolvers +``` diff --git a/website/docs/services/appsync/resolvers_list_only/index.md b/website/docs/services/appsync/resolvers_list_only/index.md new file mode 100644 index 0000000..4ec1f54 --- /dev/null +++ b/website/docs/services/appsync/resolvers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resolvers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolvers_list_only + - appsync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolvers in a region or regions, for all properties use resolvers + +## Overview + + + + + + + +
Nameresolvers_list_only
TypeResource
DescriptionThe AWS::AppSync::Resolver resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).
When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.
See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolvers in a region. +```sql +SELECT +region, +resolver_arn +FROM aws.appsync.resolvers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolvers_list_only resource, see resolvers + diff --git a/website/docs/services/appsync/source_api_associations/index.md b/website/docs/services/appsync/source_api_associations/index.md new file mode 100644 index 0000000..b67d273 --- /dev/null +++ b/website/docs/services/appsync/source_api_associations/index.md @@ -0,0 +1,256 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a source_api_association resource or lists source_api_associations in a region + +## Overview + + + + + + + +
Namesource_api_associations
TypeResource
DescriptionResource Type definition for AWS::AppSync::SourceApiAssociation
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIdentifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
stringIdentifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
stringDescription of the SourceApiAssociation.
undefinedCustomized configuration for SourceApiAssociation.
stringId of the SourceApiAssociation.
stringARN of the SourceApiAssociation.
stringGraphQLApiId of the source API in the association.
stringARN of the source API in the association.
stringGraphQLApiId of the Merged API in the association.
stringARN of the Merged API in the association.
stringCurrent status of SourceApiAssociation.
stringCurrent SourceApiAssociation status details.
stringDate of last schema successful merge.
stringAWS region.
+ +For more information, see AWS::AppSync::SourceApiAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all source_api_associations in a region. +```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_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual source_api_association. +```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_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new source_api_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.source_api_associations ( + SourceApiIdentifier, + MergedApiIdentifier, + Description, + SourceApiAssociationConfig, + region +) +SELECT +'{{ SourceApiIdentifier }}', + '{{ MergedApiIdentifier }}', + '{{ Description }}', + '{{ SourceApiAssociationConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.appsync.source_api_associations ( + SourceApiIdentifier, + MergedApiIdentifier, + Description, + SourceApiAssociationConfig, + region +) +SELECT + '{{ SourceApiIdentifier }}', + '{{ MergedApiIdentifier }}', + '{{ Description }}', + '{{ SourceApiAssociationConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: source_api_association + props: + - name: SourceApiIdentifier + value: '{{ SourceApiIdentifier }}' + - name: MergedApiIdentifier + value: '{{ MergedApiIdentifier }}' + - name: Description + value: '{{ Description }}' + - name: SourceApiAssociationConfig + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.appsync.source_api_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +appsync:GetSourceApiAssociation, +appsync:ListSourceApiAssociations +``` + +### Update +```json +appsync:GetSourceApiAssociation, +appsync:UpdateSourceApiAssociation, +appsync:GetSourceApiAssociation +``` + +### Delete +```json +appsync:GetSourceApiAssociation, +appsync:DisassociateSourceGraphqlApi, +appsync:DisassociateMergedGraphqlApi, +appsync:ListSourceApiAssociations +``` + +### List +```json +appsync:ListSourceApiAssociations +``` diff --git a/website/docs/services/appsync/source_api_associations_list_only/index.md b/website/docs/services/appsync/source_api_associations_list_only/index.md new file mode 100644 index 0000000..c82c9da --- /dev/null +++ b/website/docs/services/appsync/source_api_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: source_api_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - source_api_associations_list_only + - appsync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists source_api_associations in a region or regions, for all properties use source_api_associations + +## Overview + + + + + + + +
Namesource_api_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::AppSync::SourceApiAssociation
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringARN of the SourceApiAssociation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all source_api_associations in a region. +```sql +SELECT +region, +association_arn +FROM aws.appsync.source_api_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the source_api_associations_list_only resource, see source_api_associations + diff --git a/website/docs/services/apptest/index.md b/website/docs/services/apptest/index.md new file mode 100644 index 0000000..25d7506 --- /dev/null +++ b/website/docs/services/apptest/index.md @@ -0,0 +1,38 @@ +--- +title: apptest +hide_title: false +hide_table_of_contents: false +keywords: + - apptest + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The apptest service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/apptest/test_case_tags/index.md b/website/docs/services/apptest/test_case_tags/index.md new file mode 100644 index 0000000..bea6726 --- /dev/null +++ b/website/docs/services/apptest/test_case_tags/index.md @@ -0,0 +1,95 @@ +--- +title: test_case_tags +hide_title: false +hide_table_of_contents: false +keywords: + - test_case_tags + - apptest + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for test_cases in a region + +## Overview + + + + + + + +
Nametest_case_tags
TypeResource
DescriptionRepresents a Test Case that can be captured and executed
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
string
array
string
string
number
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all test_cases in a region. +```sql +SELECT +region, +creation_time, +description, +last_update_time, +latest_version, +name, +status, +steps, +test_case_arn, +test_case_id, +test_case_version, +tag_key, +tag_value +FROM aws.apptest.test_case_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the test_case_tags resource, see test_cases + diff --git a/website/docs/services/apptest/test_cases/index.md b/website/docs/services/apptest/test_cases/index.md new file mode 100644 index 0000000..d5e2944 --- /dev/null +++ b/website/docs/services/apptest/test_cases/index.md @@ -0,0 +1,250 @@ +--- +title: test_cases +hide_title: false +hide_table_of_contents: false +keywords: + - test_cases + - apptest + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a test_case resource or lists test_cases in a region + +## Overview + + + + + + + +
Nametest_cases
TypeResource
DescriptionRepresents a Test Case that can be captured and executed
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
string
array
object
string
string
number
stringAWS region.
+ +For more information, see AWS::AppTest::TestCase. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all test_cases in a region. +```sql +SELECT +region, +creation_time, +description, +last_update_time, +latest_version, +name, +status, +steps, +tags, +test_case_arn, +test_case_id, +test_case_version +FROM aws.apptest.test_cases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual test_case. +```sql +SELECT +region, +creation_time, +description, +last_update_time, +latest_version, +name, +status, +steps, +tags, +test_case_arn, +test_case_id, +test_case_version +FROM aws.apptest.test_cases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new test_case resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.apptest.test_cases ( + Name, + Steps, + region +) +SELECT +'{{ Name }}', + '{{ Steps }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.apptest.test_cases ( + Description, + Name, + Steps, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ Steps }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: test_case + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Steps + value: + - Name: '{{ Name }}' + Description: '{{ Description }}' + Action: null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.apptest.test_cases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the test_cases resource, the following permissions are required: + +### Create +```json +apptest:CreateTestCase, +apptest:GetTestCase, +apptest:ListTagsForResource +``` + +### Read +```json +apptest:GetTestCase, +apptest:ListTagsForResource +``` + +### Update +```json +apptest:UpdateTestCase, +apptest:GetTestCase, +apptest:TagResource, +apptest:UnTagResource, +apptest:ListTagsForResource +``` + +### Delete +```json +apptest:GetTestCase, +apptest:ListTagsForResource, +apptest:DeleteTestCase +``` + +### List +```json +apptest:ListTestCases +``` diff --git a/website/docs/services/apptest/test_cases_list_only/index.md b/website/docs/services/apptest/test_cases_list_only/index.md new file mode 100644 index 0000000..dcf94a7 --- /dev/null +++ b/website/docs/services/apptest/test_cases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: test_cases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - test_cases_list_only + - apptest + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists test_cases in a region or regions, for all properties use test_cases + +## Overview + + + + + + + +
Nametest_cases_list_only
TypeResource
DescriptionRepresents a Test Case that can be captured and executed
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all test_cases in a region. +```sql +SELECT +region, +test_case_id +FROM aws.apptest.test_cases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the test_cases_list_only resource, see test_cases + diff --git a/website/docs/services/aps/index.md b/website/docs/services/aps/index.md new file mode 100644 index 0000000..e783d91 --- /dev/null +++ b/website/docs/services/aps/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The aps service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/aps/rule_groups_namespace_tags/index.md b/website/docs/services/aps/rule_groups_namespace_tags/index.md new file mode 100644 index 0000000..7015327 --- /dev/null +++ b/website/docs/services/aps/rule_groups_namespace_tags/index.md @@ -0,0 +1,83 @@ +--- +title: rule_groups_namespace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups_namespace_tags + - aps + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rule_groups_namespaces in a region + +## Overview + + + + + + + +
Namerule_groups_namespace_tags
TypeResource
DescriptionRuleGroupsNamespace schema for cloudformation.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific APS Workspace associated with this RuleGroupsNamespace.
stringThe RuleGroupsNamespace name.
stringThe RuleGroupsNamespace data.
stringThe RuleGroupsNamespace ARN.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rule_groups_namespaces in a region. +```sql +SELECT +region, +workspace, +name, +data, +arn, +tag_key, +tag_value +FROM aws.aps.rule_groups_namespace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_groups_namespace_tags resource, see rule_groups_namespaces + diff --git a/website/docs/services/aps/rule_groups_namespaces/index.md b/website/docs/services/aps/rule_groups_namespaces/index.md new file mode 100644 index 0000000..5355923 --- /dev/null +++ b/website/docs/services/aps/rule_groups_namespaces/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a rule_groups_namespace resource or lists rule_groups_namespaces in a region + +## Overview + + + + + + + +
Namerule_groups_namespaces
TypeResource
DescriptionRuleGroupsNamespace schema for cloudformation.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific APS Workspace associated with this RuleGroupsNamespace.
stringThe RuleGroupsNamespace name.
stringThe RuleGroupsNamespace data.
stringThe RuleGroupsNamespace ARN.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::APS::RuleGroupsNamespace. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rule_groups_namespaces in a region. +```sql +SELECT +region, +workspace, +name, +data, +arn, +tags +FROM aws.aps.rule_groups_namespaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual rule_groups_namespace. +```sql +SELECT +region, +workspace, +name, +data, +arn, +tags +FROM aws.aps.rule_groups_namespaces +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rule_groups_namespace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.aps.rule_groups_namespaces ( + Workspace, + Name, + Data, + region +) +SELECT +'{{ Workspace }}', + '{{ Name }}', + '{{ Data }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.aps.rule_groups_namespaces ( + Workspace, + Name, + Data, + Tags, + region +) +SELECT + '{{ Workspace }}', + '{{ Name }}', + '{{ Data }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: rule_groups_namespace + props: + - name: Workspace + value: '{{ Workspace }}' + - name: Name + value: '{{ Name }}' + - name: Data + value: '{{ Data }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.aps.rule_groups_namespaces +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +aps:DescribeRuleGroupsNamespace, +aps:ListTagsForResource +``` + +### Update +```json +aps:PutRuleGroupsNamespace, +aps:DescribeRuleGroupsNamespace, +aps:TagResource, +aps:UntagResource, +aps:ListTagsForResource +``` + +### Delete +```json +aps:DeleteRuleGroupsNamespace, +aps:DescribeRuleGroupsNamespace +``` + +### List +```json +aps:ListRuleGroupsNamespaces, +aps:ListTagsForResource +``` diff --git a/website/docs/services/aps/rule_groups_namespaces_list_only/index.md b/website/docs/services/aps/rule_groups_namespaces_list_only/index.md new file mode 100644 index 0000000..d80e21f --- /dev/null +++ b/website/docs/services/aps/rule_groups_namespaces_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: rule_groups_namespaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups_namespaces_list_only + - aps + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rule_groups_namespaces in a region or regions, for all properties use rule_groups_namespaces + +## Overview + + + + + + + +
Namerule_groups_namespaces_list_only
TypeResource
DescriptionRuleGroupsNamespace schema for cloudformation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe RuleGroupsNamespace ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rule_groups_namespaces in a region. +```sql +SELECT +region, +arn +FROM aws.aps.rule_groups_namespaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_groups_namespaces_list_only resource, see rule_groups_namespaces + diff --git a/website/docs/services/aps/scraper_tags/index.md b/website/docs/services/aps/scraper_tags/index.md new file mode 100644 index 0000000..f3e9332 --- /dev/null +++ b/website/docs/services/aps/scraper_tags/index.md @@ -0,0 +1,89 @@ +--- +title: scraper_tags +hide_title: false +hide_table_of_contents: false +keywords: + - scraper_tags + - aps + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scrapers in a region + +## Overview + + + + + + + +
Namescraper_tags
TypeResource
DescriptionResource Type definition for AWS::APS::Scraper
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific scraper.
stringScraper alias.
stringScraper ARN.
stringIAM role ARN for the scraper.
objectScraper configuration
objectScraper metrics source
objectScraper metrics destination
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scrapers in a region. +```sql +SELECT +region, +scraper_id, +alias, +arn, +role_arn, +scrape_configuration, +source, +destination, +tag_key, +tag_value +FROM aws.aps.scraper_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scraper_tags resource, see scrapers + diff --git a/website/docs/services/aps/scrapers/index.md b/website/docs/services/aps/scrapers/index.md new file mode 100644 index 0000000..d0dba0c --- /dev/null +++ b/website/docs/services/aps/scrapers/index.md @@ -0,0 +1,270 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a scraper resource or lists scrapers in a region + +## Overview + + + + + + + +
Namescrapers
TypeResource
DescriptionResource Type definition for AWS::APS::Scraper
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific scraper.
stringScraper alias.
stringScraper ARN.
stringIAM role ARN for the scraper.
objectScraper configuration
objectScraper metrics source
objectScraper metrics destination
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::APS::Scraper. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scrapers in a region. +```sql +SELECT +region, +scraper_id, +alias, +arn, +role_arn, +scrape_configuration, +source, +destination, +tags +FROM aws.aps.scrapers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual scraper. +```sql +SELECT +region, +scraper_id, +alias, +arn, +role_arn, +scrape_configuration, +source, +destination, +tags +FROM aws.aps.scrapers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scraper resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.aps.scrapers ( + ScrapeConfiguration, + Source, + Destination, + region +) +SELECT +'{{ ScrapeConfiguration }}', + '{{ Source }}', + '{{ Destination }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.aps.scrapers ( + Alias, + ScrapeConfiguration, + Source, + Destination, + Tags, + region +) +SELECT + '{{ Alias }}', + '{{ ScrapeConfiguration }}', + '{{ Source }}', + '{{ Destination }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: scraper + props: + - name: Alias + value: '{{ Alias }}' + - name: ScrapeConfiguration + value: + ConfigurationBlob: '{{ ConfigurationBlob }}' + - name: Source + value: + EksConfiguration: + ClusterArn: '{{ ClusterArn }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: Destination + value: + AmpConfiguration: + WorkspaceArn: '{{ WorkspaceArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.aps.scrapers +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +aps:DescribeScraper, +aps:ListTagsForResource +``` + +### Update +```json +aps:CreateScraper, +aps:DescribeScraper, +aps:UpdateScraper, +aps:DescribeWorkspace, +aps:TagResource, +aps:UntagResource, +aps:ListTagsForResource +``` + +### Delete +```json +aps:DeleteScraper, +aps:DescribeScraper, +aps:DescribeWorkspace, +eks:AssociateAccessPolicy, +eks:DescribeCluster, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +iam:DeleteServiceLinkedRole +``` + +### List +```json +aps:ListScrapers, +aps:ListTagsForResource +``` diff --git a/website/docs/services/aps/scrapers_list_only/index.md b/website/docs/services/aps/scrapers_list_only/index.md new file mode 100644 index 0000000..cd4df65 --- /dev/null +++ b/website/docs/services/aps/scrapers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: scrapers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scrapers_list_only + - aps + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scrapers in a region or regions, for all properties use scrapers + +## Overview + + + + + + + +
Namescrapers_list_only
TypeResource
DescriptionResource Type definition for AWS::APS::Scraper
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringScraper ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scrapers in a region. +```sql +SELECT +region, +arn +FROM aws.aps.scrapers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scrapers_list_only resource, see scrapers + diff --git a/website/docs/services/aps/workspace_tags/index.md b/website/docs/services/aps/workspace_tags/index.md new file mode 100644 index 0000000..71c4730 --- /dev/null +++ b/website/docs/services/aps/workspace_tags/index.md @@ -0,0 +1,89 @@ +--- +title: workspace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workspace_tags + - aps + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workspaces in a region + +## Overview + + + + + + + +
Nameworkspace_tags
TypeResource
DescriptionResource Type definition for AWS::APS::Workspace
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific APS Workspace.
stringAMP Workspace alias.
stringWorkspace arn.
stringThe AMP Workspace alert manager definition data
stringAMP Workspace prometheus endpoint
objectLogging configuration
stringKMS Key ARN used to encrypt and decrypt AMP workspace data.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workspaces in a region. +```sql +SELECT +region, +workspace_id, +alias, +arn, +alert_manager_definition, +prometheus_endpoint, +logging_configuration, +kms_key_arn, +tag_key, +tag_value +FROM aws.aps.workspace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspace_tags resource, see workspaces + diff --git a/website/docs/services/aps/workspaces/index.md b/website/docs/services/aps/workspaces/index.md new file mode 100644 index 0000000..2bf4463 --- /dev/null +++ b/website/docs/services/aps/workspaces/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a workspace resource or lists workspaces in a region + +## Overview + + + + + + + +
Nameworkspaces
TypeResource
DescriptionResource Type definition for AWS::APS::Workspace
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific APS Workspace.
stringAMP Workspace alias.
stringWorkspace arn.
stringThe AMP Workspace alert manager definition data
stringAMP Workspace prometheus endpoint
objectLogging configuration
stringKMS Key ARN used to encrypt and decrypt AMP workspace data.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::APS::Workspace. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all workspaces in a region. +```sql +SELECT +region, +workspace_id, +alias, +arn, +alert_manager_definition, +prometheus_endpoint, +logging_configuration, +kms_key_arn, +tags +FROM aws.aps.workspaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual workspace. +```sql +SELECT +region, +workspace_id, +alias, +arn, +alert_manager_definition, +prometheus_endpoint, +logging_configuration, +kms_key_arn, +tags +FROM aws.aps.workspaces +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workspace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.aps.workspaces ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.aps.workspaces ( + Alias, + AlertManagerDefinition, + LoggingConfiguration, + KmsKeyArn, + Tags, + region +) +SELECT + '{{ Alias }}', + '{{ AlertManagerDefinition }}', + '{{ LoggingConfiguration }}', + '{{ KmsKeyArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: workspace + props: + - name: Alias + value: '{{ Alias }}' + - name: AlertManagerDefinition + value: '{{ AlertManagerDefinition }}' + - name: LoggingConfiguration + value: + LogGroupArn: '{{ LogGroupArn }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.aps.workspaces +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +aps:ListWorkspaces, +aps:ListTagsForResource +``` diff --git a/website/docs/services/aps/workspaces_list_only/index.md b/website/docs/services/aps/workspaces_list_only/index.md new file mode 100644 index 0000000..90a7fd0 --- /dev/null +++ b/website/docs/services/aps/workspaces_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: workspaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces_list_only + - aps + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workspaces in a region or regions, for all properties use workspaces + +## Overview + + + + + + + +
Nameworkspaces_list_only
TypeResource
DescriptionResource Type definition for AWS::APS::Workspace
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringWorkspace arn.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workspaces in a region. +```sql +SELECT +region, +arn +FROM aws.aps.workspaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspaces_list_only resource, see workspaces + diff --git a/website/docs/services/arczonalshift/autoshift_observer_notification_statuses/index.md b/website/docs/services/arczonalshift/autoshift_observer_notification_statuses/index.md new file mode 100644 index 0000000..ddf2ced --- /dev/null +++ b/website/docs/services/arczonalshift/autoshift_observer_notification_statuses/index.md @@ -0,0 +1,192 @@ +--- +title: autoshift_observer_notification_statuses +hide_title: false +hide_table_of_contents: false +keywords: + - autoshift_observer_notification_statuses + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an autoshift_observer_notification_status resource or lists autoshift_observer_notification_statuses in a region + +## Overview + + + + + + + +
Nameautoshift_observer_notification_statuses
TypeResource
DescriptionDefinition of AWS::ARCZonalShift::AutoshiftObserverNotificationStatus Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectDefinition of AWS::ARCZonalShift::AutoshiftObserverNotificationStatus Resource Type
stringUser account id, used as part of the primary identifier for the resource
stringRegion, used as part of the primary identifier for the resource
stringAWS region.
+ +For more information, see AWS::ARCZonalShift::AutoshiftObserverNotificationStatus. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all autoshift_observer_notification_statuses in a region. +```sql +SELECT +region, +status, +account_id, +region +FROM aws.arczonalshift.autoshift_observer_notification_statuses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual autoshift_observer_notification_status. +```sql +SELECT +region, +status, +account_id, +region +FROM aws.arczonalshift.autoshift_observer_notification_statuses +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new autoshift_observer_notification_status resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.arczonalshift.autoshift_observer_notification_statuses ( + Status, + region +) +SELECT +'{{ Status }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.arczonalshift.autoshift_observer_notification_statuses ( + Status, + region +) +SELECT + '{{ Status }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: autoshift_observer_notification_status + props: + - name: Status + value: + Status: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.arczonalshift.autoshift_observer_notification_statuses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the autoshift_observer_notification_statuses resource, the following permissions are required: + +### Create +```json +arc-zonal-shift:UpdateAutoshiftObserverNotificationStatus +``` + +### Read +```json +arc-zonal-shift:GetAutoshiftObserverNotificationStatus +``` + +### Delete +```json +arc-zonal-shift:UpdateAutoshiftObserverNotificationStatus, +arc-zonal-shift:GetAutoshiftObserverNotificationStatus +``` + +### List +```json +arc-zonal-shift:GetAutoshiftObserverNotificationStatus +``` diff --git a/website/docs/services/arczonalshift/autoshift_observer_notification_statuses_list_only/index.md b/website/docs/services/arczonalshift/autoshift_observer_notification_statuses_list_only/index.md new file mode 100644 index 0000000..855603f --- /dev/null +++ b/website/docs/services/arczonalshift/autoshift_observer_notification_statuses_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: autoshift_observer_notification_statuses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - autoshift_observer_notification_statuses_list_only + - arczonalshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists autoshift_observer_notification_statuses in a region or regions, for all properties use autoshift_observer_notification_statuses + +## Overview + + + + + + + +
Nameautoshift_observer_notification_statuses_list_only
TypeResource
DescriptionDefinition of AWS::ARCZonalShift::AutoshiftObserverNotificationStatus Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringUser account id, used as part of the primary identifier for the resource
stringRegion, used as part of the primary identifier for the resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all autoshift_observer_notification_statuses in a region. +```sql +SELECT +region, +account_id, +region +FROM aws.arczonalshift.autoshift_observer_notification_statuses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the autoshift_observer_notification_statuses_list_only resource, see autoshift_observer_notification_statuses + diff --git a/website/docs/services/arczonalshift/index.md b/website/docs/services/arczonalshift/index.md new file mode 100644 index 0000000..05923fe --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The arczonalshift service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/arczonalshift/zonal_autoshift_configurations/index.md b/website/docs/services/arczonalshift/zonal_autoshift_configurations/index.md new file mode 100644 index 0000000..ea5f9b4 --- /dev/null +++ b/website/docs/services/arczonalshift/zonal_autoshift_configurations/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a zonal_autoshift_configuration resource or lists zonal_autoshift_configurations in a region + +## Overview + + + + + + + +
Namezonal_autoshift_configurations
TypeResource
DescriptionDefinition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
object
string
stringAWS region.
+ +For more information, see AWS::ARCZonalShift::ZonalAutoshiftConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all zonal_autoshift_configurations in a region. +```sql +SELECT +region, +zonal_autoshift_status, +practice_run_configuration, +resource_identifier +FROM aws.arczonalshift.zonal_autoshift_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual zonal_autoshift_configuration. +```sql +SELECT +region, +zonal_autoshift_status, +practice_run_configuration, +resource_identifier +FROM aws.arczonalshift.zonal_autoshift_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new zonal_autoshift_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.arczonalshift.zonal_autoshift_configurations ( + ZonalAutoshiftStatus, + PracticeRunConfiguration, + ResourceIdentifier, + region +) +SELECT +'{{ ZonalAutoshiftStatus }}', + '{{ PracticeRunConfiguration }}', + '{{ ResourceIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.arczonalshift.zonal_autoshift_configurations ( + ZonalAutoshiftStatus, + PracticeRunConfiguration, + ResourceIdentifier, + region +) +SELECT + '{{ ZonalAutoshiftStatus }}', + '{{ PracticeRunConfiguration }}', + '{{ ResourceIdentifier }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: zonal_autoshift_configuration + props: + - name: ZonalAutoshiftStatus + value: '{{ ZonalAutoshiftStatus }}' + - name: PracticeRunConfiguration + value: + BlockingAlarms: + - Type: '{{ Type }}' + AlarmIdentifier: '{{ AlarmIdentifier }}' + OutcomeAlarms: + - null + BlockedDates: + - '{{ BlockedDates[0] }}' + BlockedWindows: + - '{{ BlockedWindows[0] }}' + - name: ResourceIdentifier + value: '{{ ResourceIdentifier }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.arczonalshift.zonal_autoshift_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +arc-zonal-shift:ListManagedResources +``` diff --git a/website/docs/services/arczonalshift/zonal_autoshift_configurations_list_only/index.md b/website/docs/services/arczonalshift/zonal_autoshift_configurations_list_only/index.md new file mode 100644 index 0000000..fb67d9f --- /dev/null +++ b/website/docs/services/arczonalshift/zonal_autoshift_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: zonal_autoshift_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - zonal_autoshift_configurations_list_only + - arczonalshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists zonal_autoshift_configurations in a region or regions, for all properties use zonal_autoshift_configurations + +## Overview + + + + + + + +
Namezonal_autoshift_configurations_list_only
TypeResource
DescriptionDefinition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all zonal_autoshift_configurations in a region. +```sql +SELECT +region, +resource_identifier +FROM aws.arczonalshift.zonal_autoshift_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the zonal_autoshift_configurations_list_only resource, see zonal_autoshift_configurations + diff --git a/website/docs/services/athena/capacity_reservation_tags/index.md b/website/docs/services/athena/capacity_reservation_tags/index.md new file mode 100644 index 0000000..a952d84 --- /dev/null +++ b/website/docs/services/athena/capacity_reservation_tags/index.md @@ -0,0 +1,91 @@ +--- +title: capacity_reservation_tags +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservation_tags + - athena + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for capacity_reservations in a region + +## Overview + + + + + + + +
Namecapacity_reservation_tags
TypeResource
DescriptionResource schema for AWS::Athena::CapacityReservation
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified capacity reservation
stringThe reservation name.
stringThe status of the reservation.
integerThe number of DPUs to request to be allocated to the reservation.
integerThe number of DPUs Athena has provisioned and allocated for the reservation
objectAssignment configuration to assign workgroups to a reservation
stringThe date and time the reservation was created.
stringThe timestamp when the last successful allocated was made
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all capacity_reservations in a region. +```sql +SELECT +region, +arn, +name, +status, +target_dpus, +allocated_dpus, +capacity_assignment_configuration, +creation_time, +last_successful_allocation_time, +tag_key, +tag_value +FROM aws.athena.capacity_reservation_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capacity_reservation_tags resource, see capacity_reservations + diff --git a/website/docs/services/athena/capacity_reservations/index.md b/website/docs/services/athena/capacity_reservations/index.md new file mode 100644 index 0000000..1ee1327 --- /dev/null +++ b/website/docs/services/athena/capacity_reservations/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a capacity_reservation resource or lists capacity_reservations in a region + +## Overview + + + + + + + +
Namecapacity_reservations
TypeResource
DescriptionResource schema for AWS::Athena::CapacityReservation
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified capacity reservation
stringThe reservation name.
stringThe status of the reservation.
integerThe number of DPUs to request to be allocated to the reservation.
integerThe number of DPUs Athena has provisioned and allocated for the reservation
objectAssignment configuration to assign workgroups to a reservation
stringThe date and time the reservation was created.
stringThe timestamp when the last successful allocated was made
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Athena::CapacityReservation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all capacity_reservations in a region. +```sql +SELECT +region, +arn, +name, +status, +target_dpus, +allocated_dpus, +capacity_assignment_configuration, +creation_time, +last_successful_allocation_time, +tags +FROM aws.athena.capacity_reservations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual capacity_reservation. +```sql +SELECT +region, +arn, +name, +status, +target_dpus, +allocated_dpus, +capacity_assignment_configuration, +creation_time, +last_successful_allocation_time, +tags +FROM aws.athena.capacity_reservations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new capacity_reservation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.athena.capacity_reservations ( + Name, + TargetDpus, + region +) +SELECT +'{{ Name }}', + '{{ TargetDpus }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.athena.capacity_reservations ( + Name, + TargetDpus, + CapacityAssignmentConfiguration, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ TargetDpus }}', + '{{ CapacityAssignmentConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: capacity_reservation + props: + - name: Name + value: '{{ Name }}' + - name: TargetDpus + value: '{{ TargetDpus }}' + - name: CapacityAssignmentConfiguration + value: + CapacityAssignments: + - WorkgroupNames: + - '{{ WorkgroupNames[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.athena.capacity_reservations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +athena:ListCapacityReservations, +athena:GetCapacityReservation +``` diff --git a/website/docs/services/athena/capacity_reservations_list_only/index.md b/website/docs/services/athena/capacity_reservations_list_only/index.md new file mode 100644 index 0000000..b4d857f --- /dev/null +++ b/website/docs/services/athena/capacity_reservations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: capacity_reservations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservations_list_only + - athena + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists capacity_reservations in a region or regions, for all properties use capacity_reservations + +## Overview + + + + + + + +
Namecapacity_reservations_list_only
TypeResource
DescriptionResource schema for AWS::Athena::CapacityReservation
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified capacity reservation
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all capacity_reservations in a region. +```sql +SELECT +region, +arn +FROM aws.athena.capacity_reservations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capacity_reservations_list_only resource, see capacity_reservations + diff --git a/website/docs/services/athena/data_catalog_tags/index.md b/website/docs/services/athena/data_catalog_tags/index.md new file mode 100644 index 0000000..1e9a695 --- /dev/null +++ b/website/docs/services/athena/data_catalog_tags/index.md @@ -0,0 +1,83 @@ +--- +title: data_catalog_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_catalog_tags + - athena + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_catalogs in a region + +## Overview + + + + + + + +
Namedata_catalog_tags
TypeResource
DescriptionResource schema for AWS::Athena::DataCatalog
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
stringA description of the data catalog to be created.
objectSpecifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
stringThe type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_catalogs in a region. +```sql +SELECT +region, +name, +description, +parameters, +type, +tag_key, +tag_value +FROM aws.athena.data_catalog_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_catalog_tags resource, see data_catalogs + diff --git a/website/docs/services/athena/data_catalogs/index.md b/website/docs/services/athena/data_catalogs/index.md new file mode 100644 index 0000000..600ce0d --- /dev/null +++ b/website/docs/services/athena/data_catalogs/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_catalog resource or lists data_catalogs in a region + +## Overview + + + + + + + +
Namedata_catalogs
TypeResource
DescriptionResource schema for AWS::Athena::DataCatalog
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
stringA description of the data catalog to be created.
objectSpecifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
arrayA list of comma separated tags to add to the data catalog that is created.
stringThe type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
stringAWS region.
+ +For more information, see AWS::Athena::DataCatalog. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_catalogs in a region. +```sql +SELECT +region, +name, +description, +parameters, +tags, +type +FROM aws.athena.data_catalogs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_catalog. +```sql +SELECT +region, +name, +description, +parameters, +tags, +type +FROM aws.athena.data_catalogs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_catalog resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.athena.data_catalogs ( + Name, + Type, + region +) +SELECT +'{{ Name }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.athena.data_catalogs ( + Name, + Description, + Parameters, + Tags, + Type, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Parameters }}', + '{{ Tags }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_catalog + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Parameters + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.athena.data_catalogs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the data_catalogs resource, the following permissions are required: + +### Create +```json +athena:CreateDataCatalog, +athena:TagResource +``` + +### Read +```json +athena:GetDataCatalog, +athena:ListTagsForResource +``` + +### Update +```json +athena:UpdateDataCatalog, +athena:TagResource, +athena:GetDataCatalog, +athena:UntagResource, +athena:ListTagsForResource +``` + +### Delete +```json +athena:DeleteDataCatalog +``` + +### List +```json +athena:ListDataCatalog +``` diff --git a/website/docs/services/athena/data_catalogs_list_only/index.md b/website/docs/services/athena/data_catalogs_list_only/index.md new file mode 100644 index 0000000..2636e3a --- /dev/null +++ b/website/docs/services/athena/data_catalogs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: data_catalogs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_catalogs_list_only + - athena + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_catalogs in a region or regions, for all properties use data_catalogs + +## Overview + + + + + + + +
Namedata_catalogs_list_only
TypeResource
DescriptionResource schema for AWS::Athena::DataCatalog
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_catalogs in a region. +```sql +SELECT +region, +name +FROM aws.athena.data_catalogs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_catalogs_list_only resource, see data_catalogs + diff --git a/website/docs/services/athena/index.md b/website/docs/services/athena/index.md new file mode 100644 index 0000000..c428341 --- /dev/null +++ b/website/docs/services/athena/index.md @@ -0,0 +1,48 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The athena service documentation. + +:::info Service Summary + +
+
+total resources: 13
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/athena/named_queries/index.md b/website/docs/services/athena/named_queries/index.md new file mode 100644 index 0000000..a2e2255 --- /dev/null +++ b/website/docs/services/athena/named_queries/index.md @@ -0,0 +1,217 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a named_query resource or lists named_queries in a region + +## Overview + + + + + + + +
Namenamed_queries
TypeResource
DescriptionResource schema for AWS::Athena::NamedQuery
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe query name.
stringThe database to which the query belongs.
stringThe query description.
stringThe contents of the query with all query statements.
stringThe name of the workgroup that contains the named query.
stringThe unique ID of the query.
stringAWS region.
+ +For more information, see AWS::Athena::NamedQuery. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all named_queries in a region. +```sql +SELECT +region, +name, +database, +description, +query_string, +work_group, +named_query_id +FROM aws.athena.named_queries +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual named_query. +```sql +SELECT +region, +name, +database, +description, +query_string, +work_group, +named_query_id +FROM aws.athena.named_queries +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new named_query resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.athena.named_queries ( + Database, + QueryString, + region +) +SELECT +'{{ Database }}', + '{{ QueryString }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.athena.named_queries ( + Name, + Database, + Description, + QueryString, + WorkGroup, + region +) +SELECT + '{{ Name }}', + '{{ Database }}', + '{{ Description }}', + '{{ QueryString }}', + '{{ WorkGroup }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: named_query + props: + - name: Name + value: '{{ Name }}' + - name: Database + value: '{{ Database }}' + - name: Description + value: '{{ Description }}' + - name: QueryString + value: '{{ QueryString }}' + - name: WorkGroup + value: '{{ WorkGroup }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.athena.named_queries +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the named_queries resource, the following permissions are required: + +### Create +```json +athena:CreateNamedQuery +``` + +### Read +```json +athena:GetNamedQuery +``` + +### List +```json +athena:ListNamedQueries +``` + +### Delete +```json +athena:DeleteNamedQuery +``` diff --git a/website/docs/services/athena/named_queries_list_only/index.md b/website/docs/services/athena/named_queries_list_only/index.md new file mode 100644 index 0000000..e34d2b4 --- /dev/null +++ b/website/docs/services/athena/named_queries_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: named_queries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - named_queries_list_only + - athena + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists named_queries in a region or regions, for all properties use named_queries + +## Overview + + + + + + + +
Namenamed_queries_list_only
TypeResource
DescriptionResource schema for AWS::Athena::NamedQuery
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe query name.
stringThe unique ID of the query.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all named_queries in a region. +```sql +SELECT +region, +named_query_id +FROM aws.athena.named_queries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the named_queries_list_only resource, see named_queries + diff --git a/website/docs/services/athena/prepared_statements/index.md b/website/docs/services/athena/prepared_statements/index.md new file mode 100644 index 0000000..d010f9b --- /dev/null +++ b/website/docs/services/athena/prepared_statements/index.md @@ -0,0 +1,221 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a prepared_statement resource or lists prepared_statements in a region + +## Overview + + + + + + + +
Nameprepared_statements
TypeResource
DescriptionResource schema for AWS::Athena::PreparedStatement
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the prepared statement.
stringThe name of the workgroup to which the prepared statement belongs.
stringThe description of the prepared statement.
stringThe query string for the prepared statement.
stringAWS region.
+ +For more information, see AWS::Athena::PreparedStatement. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all prepared_statements in a region. +```sql +SELECT +region, +statement_name, +work_group, +description, +query_statement +FROM aws.athena.prepared_statements +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual prepared_statement. +```sql +SELECT +region, +statement_name, +work_group, +description, +query_statement +FROM aws.athena.prepared_statements +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new prepared_statement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.athena.prepared_statements ( + StatementName, + WorkGroup, + QueryStatement, + region +) +SELECT +'{{ StatementName }}', + '{{ WorkGroup }}', + '{{ QueryStatement }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.athena.prepared_statements ( + StatementName, + WorkGroup, + Description, + QueryStatement, + region +) +SELECT + '{{ StatementName }}', + '{{ WorkGroup }}', + '{{ Description }}', + '{{ QueryStatement }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: prepared_statement + props: + - name: StatementName + value: '{{ StatementName }}' + - name: WorkGroup + value: '{{ WorkGroup }}' + - name: Description + value: '{{ Description }}' + - name: QueryStatement + value: '{{ QueryStatement }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.athena.prepared_statements +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the prepared_statements resource, the following permissions are required: + +### Create +```json +athena:CreatePreparedStatement, +athena:GetPreparedStatement +``` + +### Read +```json +athena:GetPreparedStatement +``` + +### Update +```json +athena:UpdatePreparedStatement +``` + +### Delete +```json +athena:DeletePreparedStatement, +athena:GetPreparedStatement +``` + +### List +```json +athena:ListPreparedStatements +``` diff --git a/website/docs/services/athena/prepared_statements_list_only/index.md b/website/docs/services/athena/prepared_statements_list_only/index.md new file mode 100644 index 0000000..c9ee90b --- /dev/null +++ b/website/docs/services/athena/prepared_statements_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: prepared_statements_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - prepared_statements_list_only + - athena + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists prepared_statements in a region or regions, for all properties use prepared_statements + +## Overview + + + + + + + +
Nameprepared_statements_list_only
TypeResource
DescriptionResource schema for AWS::Athena::PreparedStatement
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the prepared statement.
stringThe name of the workgroup to which the prepared statement belongs.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all prepared_statements in a region. +```sql +SELECT +region, +statement_name, +work_group +FROM aws.athena.prepared_statements_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prepared_statements_list_only resource, see prepared_statements + diff --git a/website/docs/services/athena/work_group_tags/index.md b/website/docs/services/athena/work_group_tags/index.md new file mode 100644 index 0000000..d6c0756 --- /dev/null +++ b/website/docs/services/athena/work_group_tags/index.md @@ -0,0 +1,89 @@ +--- +title: work_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - work_group_tags + - athena + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for work_groups in a region + +## Overview + + + + + + + +
Namework_group_tags
TypeResource
DescriptionResource schema for AWS::Athena::WorkGroup
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe workGroup name.
stringThe workgroup description.
objectThe workgroup configuration
objectThe workgroup configuration update object
stringThe date and time the workgroup was created.
stringThe state of the workgroup: ENABLED or DISABLED.
booleanThe option to delete the workgroup and its contents even if the workgroup contains any named queries.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all work_groups in a region. +```sql +SELECT +region, +name, +description, +work_group_configuration, +work_group_configuration_updates, +creation_time, +state, +recursive_delete_option, +tag_key, +tag_value +FROM aws.athena.work_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the work_group_tags resource, see work_groups + diff --git a/website/docs/services/athena/work_groups/index.md b/website/docs/services/athena/work_groups/index.md new file mode 100644 index 0000000..e0acf3a --- /dev/null +++ b/website/docs/services/athena/work_groups/index.md @@ -0,0 +1,305 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a work_group resource or lists work_groups in a region + +## Overview + + + + + + + +
Namework_groups
TypeResource
DescriptionResource schema for AWS::Athena::WorkGroup
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe workGroup name.
stringThe workgroup description.
arrayOne or more tags, separated by commas, that you want to attach to the workgroup as you create it
objectThe workgroup configuration
objectThe workgroup configuration update object
stringThe date and time the workgroup was created.
stringThe state of the workgroup: ENABLED or DISABLED.
booleanThe option to delete the workgroup and its contents even if the workgroup contains any named queries.
stringAWS region.
+ +For more information, see AWS::Athena::WorkGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all work_groups in a region. +```sql +SELECT +region, +name, +description, +tags, +work_group_configuration, +work_group_configuration_updates, +creation_time, +state, +recursive_delete_option +FROM aws.athena.work_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual work_group. +```sql +SELECT +region, +name, +description, +tags, +work_group_configuration, +work_group_configuration_updates, +creation_time, +state, +recursive_delete_option +FROM aws.athena.work_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new work_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.athena.work_groups ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.athena.work_groups ( + Name, + Description, + Tags, + WorkGroupConfiguration, + WorkGroupConfigurationUpdates, + State, + RecursiveDeleteOption, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Tags }}', + '{{ WorkGroupConfiguration }}', + '{{ WorkGroupConfigurationUpdates }}', + '{{ State }}', + '{{ RecursiveDeleteOption }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: work_group + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: WorkGroupConfiguration + value: + BytesScannedCutoffPerQuery: '{{ BytesScannedCutoffPerQuery }}' + EnforceWorkGroupConfiguration: '{{ EnforceWorkGroupConfiguration }}' + PublishCloudWatchMetricsEnabled: '{{ PublishCloudWatchMetricsEnabled }}' + RequesterPaysEnabled: '{{ RequesterPaysEnabled }}' + ResultConfiguration: + EncryptionConfiguration: + EncryptionOption: '{{ EncryptionOption }}' + KmsKey: '{{ KmsKey }}' + OutputLocation: '{{ OutputLocation }}' + ExpectedBucketOwner: '{{ ExpectedBucketOwner }}' + AclConfiguration: + S3AclOption: '{{ S3AclOption }}' + EngineVersion: + SelectedEngineVersion: '{{ SelectedEngineVersion }}' + EffectiveEngineVersion: '{{ EffectiveEngineVersion }}' + AdditionalConfiguration: '{{ AdditionalConfiguration }}' + ExecutionRole: '{{ ExecutionRole }}' + CustomerContentEncryptionConfiguration: + KmsKey: null + - name: WorkGroupConfigurationUpdates + value: + BytesScannedCutoffPerQuery: null + EnforceWorkGroupConfiguration: null + PublishCloudWatchMetricsEnabled: null + RequesterPaysEnabled: null + ResultConfigurationUpdates: + EncryptionConfiguration: null + OutputLocation: null + ExpectedBucketOwner: null + AclConfiguration: null + RemoveEncryptionConfiguration: '{{ RemoveEncryptionConfiguration }}' + RemoveOutputLocation: '{{ RemoveOutputLocation }}' + RemoveExpectedBucketOwner: '{{ RemoveExpectedBucketOwner }}' + RemoveAclConfiguration: '{{ RemoveAclConfiguration }}' + RemoveBytesScannedCutoffPerQuery: '{{ RemoveBytesScannedCutoffPerQuery }}' + EngineVersion: null + AdditionalConfiguration: null + ExecutionRole: null + CustomerContentEncryptionConfiguration: null + RemoveCustomerContentEncryptionConfiguration: '{{ RemoveCustomerContentEncryptionConfiguration }}' + - name: State + value: '{{ State }}' + - name: RecursiveDeleteOption + value: '{{ RecursiveDeleteOption }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.athena.work_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +athena:GetWorkGroup, +athena:ListTagsForResource +``` + +### List +```json +athena:ListWorkGroups +``` + +### 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/website/docs/services/athena/work_groups_list_only/index.md b/website/docs/services/athena/work_groups_list_only/index.md new file mode 100644 index 0000000..401cece --- /dev/null +++ b/website/docs/services/athena/work_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: work_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - work_groups_list_only + - athena + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists work_groups in a region or regions, for all properties use work_groups + +## Overview + + + + + + + +
Namework_groups_list_only
TypeResource
DescriptionResource schema for AWS::Athena::WorkGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe workGroup name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all work_groups in a region. +```sql +SELECT +region, +name +FROM aws.athena.work_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the work_groups_list_only resource, see work_groups + diff --git a/website/docs/services/auditmanager/assessment_tags/index.md b/website/docs/services/auditmanager/assessment_tags/index.md new file mode 100644 index 0000000..631beab --- /dev/null +++ b/website/docs/services/auditmanager/assessment_tags/index.md @@ -0,0 +1,99 @@ +--- +title: assessment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - assessment_tags + - auditmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for assessments in a region + +## Overview + + + + + + + +
Nameassessment_tags
TypeResource
DescriptionAn entity that defines the scope of audit evidence collected by AWS Audit Manager.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the specified framework.
string
objectThe AWS account associated with the assessment.
stringThe Amazon Resource Name (ARN) of the assessment.
arrayThe list of delegations.
arrayThe list of roles for the specified assessment.
objectThe wrapper that contains the AWS accounts and AWS services in scope for the assessment.
objectThe destination in which evidence reports are stored for the specified assessment.
stringThe status of the specified assessment.
numberThe sequence of characters that identifies when the event occurred.
stringThe name of the related assessment.
stringThe description of the specified assessment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all assessments in a region. +```sql +SELECT +region, +framework_id, +assessment_id, +aws_account, +arn, +delegations, +roles, +scope, +assessment_reports_destination, +status, +creation_time, +name, +description, +tag_key, +tag_value +FROM aws.auditmanager.assessment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assessment_tags resource, see assessments + diff --git a/website/docs/services/auditmanager/assessments/index.md b/website/docs/services/auditmanager/assessments/index.md new file mode 100644 index 0000000..203efb5 --- /dev/null +++ b/website/docs/services/auditmanager/assessments/index.md @@ -0,0 +1,299 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an assessment resource or lists assessments in a region + +## Overview + + + + + + + +
Nameassessments
TypeResource
DescriptionAn entity that defines the scope of audit evidence collected by AWS Audit Manager.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the specified framework.
string
objectThe AWS account associated with the assessment.
stringThe Amazon Resource Name (ARN) of the assessment.
arrayThe tags associated with the assessment.
arrayThe list of delegations.
arrayThe list of roles for the specified assessment.
objectThe wrapper that contains the AWS accounts and AWS services in scope for the assessment.
objectThe destination in which evidence reports are stored for the specified assessment.
stringThe status of the specified assessment.
numberThe sequence of characters that identifies when the event occurred.
stringThe name of the related assessment.
stringThe description of the specified assessment.
stringAWS region.
+ +For more information, see AWS::AuditManager::Assessment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all assessments in a region. +```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.assessments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual assessment. +```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.assessments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new assessment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.auditmanager.assessments ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.auditmanager.assessments ( + FrameworkId, + AwsAccount, + Tags, + Delegations, + Roles, + Scope, + AssessmentReportsDestination, + Status, + Name, + Description, + region +) +SELECT + '{{ FrameworkId }}', + '{{ AwsAccount }}', + '{{ Tags }}', + '{{ Delegations }}', + '{{ Roles }}', + '{{ Scope }}', + '{{ AssessmentReportsDestination }}', + '{{ Status }}', + '{{ Name }}', + '{{ Description }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: assessment + props: + - name: FrameworkId + value: '{{ FrameworkId }}' + - name: AwsAccount + value: + Id: '{{ Id }}' + EmailAddress: '{{ EmailAddress }}' + Name: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Delegations + value: + - LastUpdated: null + ControlSetId: '{{ ControlSetId }}' + CreationTime: null + CreatedBy: '{{ CreatedBy }}' + RoleArn: '{{ RoleArn }}' + AssessmentName: '{{ AssessmentName }}' + Comment: '{{ Comment }}' + Id: '{{ Id }}' + RoleType: '{{ RoleType }}' + AssessmentId: null + Status: '{{ Status }}' + - name: Roles + value: + - RoleArn: null + RoleType: null + - name: Scope + value: + AwsAccounts: + - null + AwsServices: + - ServiceName: '{{ ServiceName }}' + - name: AssessmentReportsDestination + value: + Destination: '{{ Destination }}' + DestinationType: '{{ DestinationType }}' + - name: Status + value: '{{ Status }}' + - name: Name + value: null + - name: Description + value: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.auditmanager.assessments +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +auditmanager:GetAssessment +``` + +### Update +```json +auditmanager:UpdateAssessment, +auditmanager:UpdateAssessmentStatus, +auditmanager:BatchCreateDelegationByAssessment, +auditmanager:BatchDeleteDelegationByAssessment +``` + +### Delete +```json +auditmanager:DeleteAssessment, +auditmanager:UntagResource +``` + +### List +```json +auditmanager:ListAssessments, +auditmanager:ListTagsForResource +``` diff --git a/website/docs/services/auditmanager/assessments_list_only/index.md b/website/docs/services/auditmanager/assessments_list_only/index.md new file mode 100644 index 0000000..a2c2101 --- /dev/null +++ b/website/docs/services/auditmanager/assessments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: assessments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assessments_list_only + - auditmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assessments in a region or regions, for all properties use assessments + +## Overview + + + + + + + +
Nameassessments_list_only
TypeResource
DescriptionAn entity that defines the scope of audit evidence collected by AWS Audit Manager.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assessments in a region. +```sql +SELECT +region, +assessment_id +FROM aws.auditmanager.assessments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assessments_list_only resource, see assessments + diff --git a/website/docs/services/auditmanager/index.md b/website/docs/services/auditmanager/index.md new file mode 100644 index 0000000..223d458 --- /dev/null +++ b/website/docs/services/auditmanager/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The auditmanager service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/autoscaling/auto_scaling_group_tags/index.md b/website/docs/services/autoscaling/auto_scaling_group_tags/index.md new file mode 100644 index 0000000..289dae7 --- /dev/null +++ b/website/docs/services/autoscaling/auto_scaling_group_tags/index.md @@ -0,0 +1,143 @@ +--- +title: auto_scaling_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_group_tags + - autoscaling + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for auto_scaling_groups in a region + +## Overview + + + + + + + +
Nameauto_scaling_group_tags
TypeResource
DescriptionThe AWS::AutoScaling::AutoScalingGroup resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management.
For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html).
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) in the *Amazon EC2 Auto Scaling User Guide*.
For help migrating from launch configurations to launch templates, see [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayOne or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
arrayA list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs property instead.
stringThe name of the launch configuration to use to launch instances.
Required only if you don't specify LaunchTemplate, MixedInstancesPolicy, or InstanceId.
stringThe Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.
objectThe Availability Zone impairment policy.
arrayThe Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
string*Only needed if you use simple scaling policies.*
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*.
Default: 300 seconds
arrayConfigures an Auto Scaling group to send notifications when specified events take place.
stringThe desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.
The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.
CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
integerThe amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.
Default: 0 seconds
integerThe amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.
Default: None
boolean
booleanIndicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.
objectInformation used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a MixedInstancesPolicy. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.
If you omit this property, you must specify MixedInstancesPolicy, LaunchConfigurationName, or InstanceId.
objectAn embedded object that specifies a mixed instances policy.
The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.
For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
arrayA list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).
When you update VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).
Required to launch instances into a nondefault VPC. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones.
stringReserved.
booleanIndicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*.
stringThe ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*.
If you specify LaunchTemplate, MixedInstancesPolicy, or LaunchConfigurationName, don't specify InstanceId.
arrayA list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the VPCZoneIdentifier property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
objectA structure that specifies an Amazon SNS notification configuration for the NotificationConfigurations property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
For an example template snippet, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).
For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
objectThe instance capacity distribution across Availability Zones.
arrayEnables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
objectAn instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringThe maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
stringThe minimum size of the group.
arrayA policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
stringThe name of the Auto Scaling group. This name must be unique per Region per account.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
arrayThe traffic sources associated with this Auto Scaling group.
stringThe unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
stringThe name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.
A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
object
stringA comma-separated value string of one or more health check types.
The valid values are EC2, EBS, ELB, and VPC_LATTICE. EC2 is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*.
Only specify EC2 if you must clear a value that was previously set.
integerThe maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all auto_scaling_groups in a region. +```sql +SELECT +region, +lifecycle_hook_specification_list, +load_balancer_names, +launch_configuration_name, +service_linked_role_arn, +availability_zone_impairment_policy, +target_group_arns, +cooldown, +notification_configurations, +desired_capacity, +health_check_grace_period, +default_instance_warmup, +skip_zonal_shift_validation, +new_instances_protected_from_scale_in, +launch_template, +mixed_instances_policy, +vpc_zone_identifier, +context, +capacity_rebalance, +instance_id, +availability_zones, +notification_configuration, +availability_zone_distribution, +metrics_collection, +instance_maintenance_policy, +max_size, +min_size, +termination_policies, +auto_scaling_group_name, +traffic_sources, +desired_capacity_type, +placement_group, +capacity_reservation_specification, +health_check_type, +max_instance_lifetime, +tag_key, +tag_value +FROM aws.autoscaling.auto_scaling_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the auto_scaling_group_tags resource, see auto_scaling_groups + diff --git a/website/docs/services/autoscaling/auto_scaling_groups/index.md b/website/docs/services/autoscaling/auto_scaling_groups/index.md new file mode 100644 index 0000000..ec89aeb --- /dev/null +++ b/website/docs/services/autoscaling/auto_scaling_groups/index.md @@ -0,0 +1,596 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an auto_scaling_group resource or lists 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.
For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html).
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) in the *Amazon EC2 Auto Scaling User Guide*.
For help migrating from launch configurations to launch templates, see [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayOne or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
arrayA list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs property instead.
stringThe name of the launch configuration to use to launch instances.
Required only if you don't specify LaunchTemplate, MixedInstancesPolicy, or InstanceId.
stringThe Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.
objectThe Availability Zone impairment policy.
arrayThe Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
string*Only needed if you use simple scaling policies.*
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*.
Default: 300 seconds
arrayConfigures an Auto Scaling group to send notifications when specified events take place.
stringThe desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.
The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.
CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
integerThe amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.
Default: 0 seconds
integerThe amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.
Default: None
boolean
booleanIndicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.
objectInformation used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a MixedInstancesPolicy. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.
If you omit this property, you must specify MixedInstancesPolicy, LaunchConfigurationName, or InstanceId.
objectAn embedded object that specifies a mixed instances policy.
The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.
For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
arrayA list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).
When you update VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).
Required to launch instances into a nondefault VPC. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones.
arrayOne or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringReserved.
booleanIndicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*.
stringThe ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*.
If you specify LaunchTemplate, MixedInstancesPolicy, or LaunchConfigurationName, don't specify InstanceId.
arrayA list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the VPCZoneIdentifier property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
objectA structure that specifies an Amazon SNS notification configuration for the NotificationConfigurations property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
For an example template snippet, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).
For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
objectThe instance capacity distribution across Availability Zones.
arrayEnables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
objectAn instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringThe maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
stringThe minimum size of the group.
arrayA policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
stringThe name of the Auto Scaling group. This name must be unique per Region per account.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
arrayThe traffic sources associated with this Auto Scaling group.
stringThe unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
stringThe name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.
A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
object
stringA comma-separated value string of one or more health check types.
The valid values are EC2, EBS, ELB, and VPC_LATTICE. EC2 is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*.
Only specify EC2 if you must clear a value that was previously set.
integerThe maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringAWS region.
+ +For more information, see AWS::AutoScaling::AutoScalingGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all auto_scaling_groups in a region. +```sql +SELECT +region, +lifecycle_hook_specification_list, +load_balancer_names, +launch_configuration_name, +service_linked_role_arn, +availability_zone_impairment_policy, +target_group_arns, +cooldown, +notification_configurations, +desired_capacity, +health_check_grace_period, +default_instance_warmup, +skip_zonal_shift_validation, +new_instances_protected_from_scale_in, +launch_template, +mixed_instances_policy, +vpc_zone_identifier, +tags, +context, +capacity_rebalance, +instance_id, +availability_zones, +notification_configuration, +availability_zone_distribution, +metrics_collection, +instance_maintenance_policy, +max_size, +min_size, +termination_policies, +auto_scaling_group_name, +traffic_sources, +desired_capacity_type, +placement_group, +capacity_reservation_specification, +health_check_type, +max_instance_lifetime +FROM aws.autoscaling.auto_scaling_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual auto_scaling_group. +```sql +SELECT +region, +lifecycle_hook_specification_list, +load_balancer_names, +launch_configuration_name, +service_linked_role_arn, +availability_zone_impairment_policy, +target_group_arns, +cooldown, +notification_configurations, +desired_capacity, +health_check_grace_period, +default_instance_warmup, +skip_zonal_shift_validation, +new_instances_protected_from_scale_in, +launch_template, +mixed_instances_policy, +vpc_zone_identifier, +tags, +context, +capacity_rebalance, +instance_id, +availability_zones, +notification_configuration, +availability_zone_distribution, +metrics_collection, +instance_maintenance_policy, +max_size, +min_size, +termination_policies, +auto_scaling_group_name, +traffic_sources, +desired_capacity_type, +placement_group, +capacity_reservation_specification, +health_check_type, +max_instance_lifetime +FROM aws.autoscaling.auto_scaling_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new auto_scaling_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.auto_scaling_groups ( + MaxSize, + MinSize, + region +) +SELECT +'{{ MaxSize }}', + '{{ MinSize }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.auto_scaling_groups ( + LifecycleHookSpecificationList, + LoadBalancerNames, + LaunchConfigurationName, + ServiceLinkedRoleARN, + AvailabilityZoneImpairmentPolicy, + TargetGroupARNs, + Cooldown, + NotificationConfigurations, + DesiredCapacity, + HealthCheckGracePeriod, + DefaultInstanceWarmup, + SkipZonalShiftValidation, + NewInstancesProtectedFromScaleIn, + LaunchTemplate, + MixedInstancesPolicy, + VPCZoneIdentifier, + Tags, + Context, + CapacityRebalance, + InstanceId, + AvailabilityZones, + NotificationConfiguration, + AvailabilityZoneDistribution, + MetricsCollection, + InstanceMaintenancePolicy, + MaxSize, + MinSize, + TerminationPolicies, + AutoScalingGroupName, + TrafficSources, + DesiredCapacityType, + PlacementGroup, + CapacityReservationSpecification, + HealthCheckType, + MaxInstanceLifetime, + region +) +SELECT + '{{ LifecycleHookSpecificationList }}', + '{{ LoadBalancerNames }}', + '{{ LaunchConfigurationName }}', + '{{ ServiceLinkedRoleARN }}', + '{{ AvailabilityZoneImpairmentPolicy }}', + '{{ TargetGroupARNs }}', + '{{ Cooldown }}', + '{{ NotificationConfigurations }}', + '{{ DesiredCapacity }}', + '{{ HealthCheckGracePeriod }}', + '{{ DefaultInstanceWarmup }}', + '{{ SkipZonalShiftValidation }}', + '{{ NewInstancesProtectedFromScaleIn }}', + '{{ LaunchTemplate }}', + '{{ MixedInstancesPolicy }}', + '{{ VPCZoneIdentifier }}', + '{{ Tags }}', + '{{ Context }}', + '{{ CapacityRebalance }}', + '{{ InstanceId }}', + '{{ AvailabilityZones }}', + '{{ NotificationConfiguration }}', + '{{ AvailabilityZoneDistribution }}', + '{{ MetricsCollection }}', + '{{ InstanceMaintenancePolicy }}', + '{{ MaxSize }}', + '{{ MinSize }}', + '{{ TerminationPolicies }}', + '{{ AutoScalingGroupName }}', + '{{ TrafficSources }}', + '{{ DesiredCapacityType }}', + '{{ PlacementGroup }}', + '{{ CapacityReservationSpecification }}', + '{{ HealthCheckType }}', + '{{ MaxInstanceLifetime }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: auto_scaling_group + props: + - name: LifecycleHookSpecificationList + value: + - LifecycleHookName: '{{ LifecycleHookName }}' + LifecycleTransition: '{{ LifecycleTransition }}' + HeartbeatTimeout: '{{ HeartbeatTimeout }}' + NotificationMetadata: '{{ NotificationMetadata }}' + DefaultResult: '{{ DefaultResult }}' + NotificationTargetARN: '{{ NotificationTargetARN }}' + RoleARN: '{{ RoleARN }}' + - name: LoadBalancerNames + value: + - '{{ LoadBalancerNames[0] }}' + - name: LaunchConfigurationName + value: '{{ LaunchConfigurationName }}' + - name: ServiceLinkedRoleARN + value: '{{ ServiceLinkedRoleARN }}' + - name: AvailabilityZoneImpairmentPolicy + value: + ZonalShiftEnabled: '{{ ZonalShiftEnabled }}' + ImpairedZoneHealthCheckBehavior: '{{ ImpairedZoneHealthCheckBehavior }}' + - name: TargetGroupARNs + value: + - '{{ TargetGroupARNs[0] }}' + - name: Cooldown + value: '{{ Cooldown }}' + - name: NotificationConfigurations + value: + - TopicARN: + - '{{ TopicARN[0] }}' + NotificationTypes: + - '{{ NotificationTypes[0] }}' + - name: DesiredCapacity + value: '{{ DesiredCapacity }}' + - name: HealthCheckGracePeriod + value: '{{ HealthCheckGracePeriod }}' + - name: DefaultInstanceWarmup + value: '{{ DefaultInstanceWarmup }}' + - name: SkipZonalShiftValidation + value: '{{ SkipZonalShiftValidation }}' + - name: NewInstancesProtectedFromScaleIn + value: '{{ NewInstancesProtectedFromScaleIn }}' + - name: LaunchTemplate + value: + LaunchTemplateName: '{{ LaunchTemplateName }}' + Version: '{{ Version }}' + LaunchTemplateId: '{{ LaunchTemplateId }}' + - name: MixedInstancesPolicy + value: + InstancesDistribution: + OnDemandAllocationStrategy: '{{ OnDemandAllocationStrategy }}' + OnDemandBaseCapacity: '{{ OnDemandBaseCapacity }}' + OnDemandPercentageAboveBaseCapacity: '{{ OnDemandPercentageAboveBaseCapacity }}' + SpotInstancePools: '{{ SpotInstancePools }}' + SpotAllocationStrategy: '{{ SpotAllocationStrategy }}' + SpotMaxPrice: '{{ SpotMaxPrice }}' + LaunchTemplate: + LaunchTemplateSpecification: null + Overrides: + - LaunchTemplateSpecification: null + WeightedCapacity: '{{ WeightedCapacity }}' + InstanceRequirements: + InstanceGenerations: + - '{{ InstanceGenerations[0] }}' + AcceleratorTypes: + - '{{ AcceleratorTypes[0] }}' + MemoryGiBPerVCpu: + Min: null + Max: null + AcceleratorManufacturers: + - '{{ AcceleratorManufacturers[0] }}' + VCpuCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + LocalStorage: '{{ LocalStorage }}' + CpuManufacturers: + - '{{ CpuManufacturers[0] }}' + BareMetal: '{{ BareMetal }}' + RequireHibernateSupport: '{{ RequireHibernateSupport }}' + MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: '{{ MaxSpotPriceAsPercentageOfOptimalOnDemandPrice }}' + OnDemandMaxPricePercentageOverLowestPrice: '{{ OnDemandMaxPricePercentageOverLowestPrice }}' + MemoryMiB: + Min: '{{ Min }}' + Max: '{{ Max }}' + LocalStorageTypes: + - '{{ LocalStorageTypes[0] }}' + NetworkInterfaceCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + ExcludedInstanceTypes: + - '{{ ExcludedInstanceTypes[0] }}' + AllowedInstanceTypes: + - '{{ AllowedInstanceTypes[0] }}' + AcceleratorCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + NetworkBandwidthGbps: + Min: null + Max: null + BaselinePerformanceFactors: + Cpu: + References: + - InstanceFamily: '{{ InstanceFamily }}' + BaselineEbsBandwidthMbps: + Min: '{{ Min }}' + Max: '{{ Max }}' + SpotMaxPricePercentageOverLowestPrice: '{{ SpotMaxPricePercentageOverLowestPrice }}' + AcceleratorNames: + - '{{ AcceleratorNames[0] }}' + AcceleratorTotalMemoryMiB: + Min: '{{ Min }}' + Max: '{{ Max }}' + BurstablePerformance: '{{ BurstablePerformance }}' + TotalLocalStorageGB: + Min: null + Max: null + InstanceType: '{{ InstanceType }}' + - name: VPCZoneIdentifier + value: + - '{{ VPCZoneIdentifier[0] }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + PropagateAtLaunch: '{{ PropagateAtLaunch }}' + - name: Context + value: '{{ Context }}' + - name: CapacityRebalance + value: '{{ CapacityRebalance }}' + - name: InstanceId + value: '{{ InstanceId }}' + - name: AvailabilityZones + value: + - '{{ AvailabilityZones[0] }}' + - name: NotificationConfiguration + value: null + - name: AvailabilityZoneDistribution + value: + CapacityDistributionStrategy: '{{ CapacityDistributionStrategy }}' + - name: MetricsCollection + value: + - Metrics: + - '{{ Metrics[0] }}' + Granularity: '{{ Granularity }}' + - name: InstanceMaintenancePolicy + value: + MaxHealthyPercentage: '{{ MaxHealthyPercentage }}' + MinHealthyPercentage: '{{ MinHealthyPercentage }}' + - name: MaxSize + value: '{{ MaxSize }}' + - name: MinSize + value: '{{ MinSize }}' + - name: TerminationPolicies + value: + - '{{ TerminationPolicies[0] }}' + - name: AutoScalingGroupName + value: '{{ AutoScalingGroupName }}' + - name: TrafficSources + value: + - Type: '{{ Type }}' + Identifier: '{{ Identifier }}' + - name: DesiredCapacityType + value: '{{ DesiredCapacityType }}' + - name: PlacementGroup + value: '{{ PlacementGroup }}' + - name: CapacityReservationSpecification + value: + CapacityReservationPreference: '{{ CapacityReservationPreference }}' + CapacityReservationTarget: + CapacityReservationIds: + - '{{ CapacityReservationIds[0] }}' + CapacityReservationResourceGroupArns: + - '{{ CapacityReservationResourceGroupArns[0] }}' + - name: HealthCheckType + value: '{{ HealthCheckType }}' + - name: MaxInstanceLifetime + value: '{{ MaxInstanceLifetime }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.autoscaling.auto_scaling_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the auto_scaling_groups resource, the following permissions are required: + +### Read +```json +autoscaling:Describe*, +managed-fleets:Get* +``` + +### 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*, +vpc-lattice:DeregisterTargets, +vpc-lattice:GetTargetGroup, +vpc-lattice:ListTargets, +vpc-lattice:RegisterTargets +``` + +### 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*, +vpc-lattice:DeregisterTargets, +vpc-lattice:GetTargetGroup, +vpc-lattice:ListTargets, +vpc-lattice:RegisterTargets +``` + +### List +```json +autoscaling:Describe* +``` + +### Delete +```json +autoscaling:DeleteAutoScalingGroup, +autoscaling:UpdateAutoScalingGroup, +autoscaling:Describe*, +managed-fleets:Get*, +managed-fleets:DeleteAutoScalingGroup +``` diff --git a/website/docs/services/autoscaling/auto_scaling_groups_list_only/index.md b/website/docs/services/autoscaling/auto_scaling_groups_list_only/index.md new file mode 100644 index 0000000..642e1b8 --- /dev/null +++ b/website/docs/services/autoscaling/auto_scaling_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: auto_scaling_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_groups_list_only + - autoscaling + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists auto_scaling_groups in a region or regions, for all properties use auto_scaling_groups + +## Overview + + + + + + + +
Nameauto_scaling_groups_list_only
TypeResource
DescriptionThe AWS::AutoScaling::AutoScalingGroup resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management.
For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html).
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) in the *Amazon EC2 Auto Scaling User Guide*.
For help migrating from launch configurations to launch templates, see [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Auto Scaling group. This name must be unique per Region per account.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all auto_scaling_groups in a region. +```sql +SELECT +region, +auto_scaling_group_name +FROM aws.autoscaling.auto_scaling_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the auto_scaling_groups_list_only resource, see auto_scaling_groups + diff --git a/website/docs/services/autoscaling/index.md b/website/docs/services/autoscaling/index.md new file mode 100644 index 0000000..11f3e2f --- /dev/null +++ b/website/docs/services/autoscaling/index.md @@ -0,0 +1,47 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The autoscaling service documentation. + +:::info Service Summary + +
+
+total resources: 12
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/autoscaling/launch_configurations/index.md b/website/docs/services/autoscaling/launch_configurations/index.md new file mode 100644 index 0000000..745f7f3 --- /dev/null +++ b/website/docs/services/autoscaling/launch_configurations/index.md @@ -0,0 +1,331 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a launch_configuration resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe tenancy of the instance, either default or dedicated.
arrayA list that contains the security groups to assign to the instances in the Auto Scaling group.
stringThe name of the launch configuration. This name must be unique per Region per account.
objectThe metadata options for the instances.
stringThe ID of the Amazon EC2 instance you want to use to create the launch configuration.
stringThe Base64-encoded user data to make available to the launched EC2 instances.
arrayThe IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.
arraySpecifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
stringProvides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
stringProvides the ID of the kernel associated with the EC2 AMI.
booleanFor Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances.
stringThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
booleanSpecifies whether the launch configuration is optimized for EBS I/O (true) or not (false).
stringProvides the name of the EC2 key pair.
stringThe maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.
stringProvides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
stringSpecifies the instance type of the EC2 instance.
stringThe ID of the RAM disk to select.
booleanControls whether instances in this group are launched with detailed (true) or basic (false) monitoring.
stringAWS region.
+ +For more information, see AWS::AutoScaling::LaunchConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all launch_configurations in a region. +```sql +SELECT +region, +placement_tenancy, +security_groups, +launch_configuration_name, +metadata_options, +instance_id, +user_data, +classic_link_vpc_security_groups, +block_device_mappings, +iam_instance_profile, +kernel_id, +associate_public_ip_address, +classic_link_vpc_id, +ebs_optimized, +key_name, +spot_price, +image_id, +instance_type, +ram_disk_id, +instance_monitoring +FROM aws.autoscaling.launch_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual launch_configuration. +```sql +SELECT +region, +placement_tenancy, +security_groups, +launch_configuration_name, +metadata_options, +instance_id, +user_data, +classic_link_vpc_security_groups, +block_device_mappings, +iam_instance_profile, +kernel_id, +associate_public_ip_address, +classic_link_vpc_id, +ebs_optimized, +key_name, +spot_price, +image_id, +instance_type, +ram_disk_id, +instance_monitoring +FROM aws.autoscaling.launch_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new launch_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.launch_configurations ( + ImageId, + InstanceType, + region +) +SELECT +'{{ ImageId }}', + '{{ InstanceType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.launch_configurations ( + PlacementTenancy, + SecurityGroups, + LaunchConfigurationName, + MetadataOptions, + InstanceId, + UserData, + ClassicLinkVPCSecurityGroups, + BlockDeviceMappings, + IamInstanceProfile, + KernelId, + AssociatePublicIpAddress, + ClassicLinkVPCId, + EbsOptimized, + KeyName, + SpotPrice, + ImageId, + InstanceType, + RamDiskId, + InstanceMonitoring, + region +) +SELECT + '{{ PlacementTenancy }}', + '{{ SecurityGroups }}', + '{{ LaunchConfigurationName }}', + '{{ MetadataOptions }}', + '{{ InstanceId }}', + '{{ UserData }}', + '{{ ClassicLinkVPCSecurityGroups }}', + '{{ BlockDeviceMappings }}', + '{{ IamInstanceProfile }}', + '{{ KernelId }}', + '{{ AssociatePublicIpAddress }}', + '{{ ClassicLinkVPCId }}', + '{{ EbsOptimized }}', + '{{ KeyName }}', + '{{ SpotPrice }}', + '{{ ImageId }}', + '{{ InstanceType }}', + '{{ RamDiskId }}', + '{{ InstanceMonitoring }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: launch_configuration + props: + - name: PlacementTenancy + value: '{{ PlacementTenancy }}' + - name: SecurityGroups + value: + - '{{ SecurityGroups[0] }}' + - name: LaunchConfigurationName + value: '{{ LaunchConfigurationName }}' + - name: MetadataOptions + value: + HttpPutResponseHopLimit: '{{ HttpPutResponseHopLimit }}' + HttpTokens: '{{ HttpTokens }}' + HttpEndpoint: '{{ HttpEndpoint }}' + - name: InstanceId + value: '{{ InstanceId }}' + - name: UserData + value: '{{ UserData }}' + - name: ClassicLinkVPCSecurityGroups + value: + - '{{ ClassicLinkVPCSecurityGroups[0] }}' + - name: BlockDeviceMappings + value: + - Ebs: + SnapshotId: '{{ SnapshotId }}' + VolumeType: '{{ VolumeType }}' + Encrypted: '{{ Encrypted }}' + Throughput: '{{ Throughput }}' + Iops: '{{ Iops }}' + VolumeSize: '{{ VolumeSize }}' + DeleteOnTermination: '{{ DeleteOnTermination }}' + NoDevice: '{{ NoDevice }}' + VirtualName: '{{ VirtualName }}' + DeviceName: '{{ DeviceName }}' + - name: IamInstanceProfile + value: '{{ IamInstanceProfile }}' + - name: KernelId + value: '{{ KernelId }}' + - name: AssociatePublicIpAddress + value: '{{ AssociatePublicIpAddress }}' + - name: ClassicLinkVPCId + value: '{{ ClassicLinkVPCId }}' + - name: EbsOptimized + value: '{{ EbsOptimized }}' + - name: KeyName + value: '{{ KeyName }}' + - name: SpotPrice + value: '{{ SpotPrice }}' + - name: ImageId + value: '{{ ImageId }}' + - name: InstanceType + value: '{{ InstanceType }}' + - name: RamDiskId + value: '{{ RamDiskId }}' + - name: InstanceMonitoring + value: '{{ InstanceMonitoring }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.autoscaling.launch_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the launch_configurations resource, the following permissions are required: + +### Read +```json +autoscaling:DescribeLaunchConfigurations +``` + +### Create +```json +autoscaling:CreateLaunchConfiguration, +autoscaling:DescribeLaunchConfigurations, +iam:PassRole +``` + +### List +```json +autoscaling:DescribeLaunchConfigurations +``` + +### Delete +```json +autoscaling:DeleteLaunchConfiguration, +autoscaling:DescribeLaunchConfigurations +``` diff --git a/website/docs/services/autoscaling/launch_configurations_list_only/index.md b/website/docs/services/autoscaling/launch_configurations_list_only/index.md new file mode 100644 index 0000000..9471451 --- /dev/null +++ b/website/docs/services/autoscaling/launch_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: launch_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - launch_configurations_list_only + - autoscaling + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists launch_configurations in a region or regions, for all properties use launch_configurations + +## Overview + + + + + + + +
Namelaunch_configurations_list_only
TypeResource
DescriptionThe AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the launch configuration. This name must be unique per Region per account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all launch_configurations in a region. +```sql +SELECT +region, +launch_configuration_name +FROM aws.autoscaling.launch_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the launch_configurations_list_only resource, see launch_configurations + diff --git a/website/docs/services/autoscaling/lifecycle_hooks/index.md b/website/docs/services/autoscaling/lifecycle_hooks/index.md new file mode 100644 index 0000000..60de616 --- /dev/null +++ b/website/docs/services/autoscaling/lifecycle_hooks/index.md @@ -0,0 +1,250 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a lifecycle_hook resource or lists lifecycle_hooks in a region + +## Overview + + + + + + + +
Namelifecycle_hooks
TypeResource
DescriptionResource Type definition for AWS::AutoScaling::LifecycleHook
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Auto Scaling group for the lifecycle hook.
stringThe action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).
integerThe maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.
stringThe name of the lifecycle hook.
stringThe instance state to which you want to attach the lifecycle hook.
stringAdditional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
stringThe Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.
stringThe ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
stringAWS region.
+ +For more information, see AWS::AutoScaling::LifecycleHook. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all lifecycle_hooks in a region. +```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_hooks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual lifecycle_hook. +```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_hooks +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new lifecycle_hook resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.lifecycle_hooks ( + AutoScalingGroupName, + LifecycleTransition, + region +) +SELECT +'{{ AutoScalingGroupName }}', + '{{ LifecycleTransition }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.lifecycle_hooks ( + AutoScalingGroupName, + DefaultResult, + HeartbeatTimeout, + LifecycleHookName, + LifecycleTransition, + NotificationMetadata, + NotificationTargetARN, + RoleARN, + region +) +SELECT + '{{ AutoScalingGroupName }}', + '{{ DefaultResult }}', + '{{ HeartbeatTimeout }}', + '{{ LifecycleHookName }}', + '{{ LifecycleTransition }}', + '{{ NotificationMetadata }}', + '{{ NotificationTargetARN }}', + '{{ RoleARN }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: lifecycle_hook + props: + - name: AutoScalingGroupName + value: '{{ AutoScalingGroupName }}' + - name: DefaultResult + value: '{{ DefaultResult }}' + - name: HeartbeatTimeout + value: '{{ HeartbeatTimeout }}' + - name: LifecycleHookName + value: '{{ LifecycleHookName }}' + - name: LifecycleTransition + value: '{{ LifecycleTransition }}' + - name: NotificationMetadata + value: '{{ NotificationMetadata }}' + - name: NotificationTargetARN + value: '{{ NotificationTargetARN }}' + - name: RoleARN + value: '{{ RoleARN }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.autoscaling.lifecycle_hooks +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +autoscaling:DescribeLifecycleHooks +``` + +### Update +```json +autoscaling:PutLifecycleHook, +autoscaling:DescribeLifecycleHooks, +iam:PassRole +``` + +### Delete +```json +autoscaling:DeleteLifecycleHook, +autoscaling:DescribeLifecycleHooks +``` + +### List +```json +autoscaling:DescribeLifecycleHooks +``` diff --git a/website/docs/services/autoscaling/lifecycle_hooks_list_only/index.md b/website/docs/services/autoscaling/lifecycle_hooks_list_only/index.md new file mode 100644 index 0000000..6969db3 --- /dev/null +++ b/website/docs/services/autoscaling/lifecycle_hooks_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: lifecycle_hooks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_hooks_list_only + - autoscaling + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists lifecycle_hooks in a region or regions, for all properties use lifecycle_hooks + +## Overview + + + + + + + +
Namelifecycle_hooks_list_only
TypeResource
DescriptionResource Type definition for AWS::AutoScaling::LifecycleHook
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the Auto Scaling group for the lifecycle hook.
stringThe name of the lifecycle hook.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all lifecycle_hooks in a region. +```sql +SELECT +region, +auto_scaling_group_name, +lifecycle_hook_name +FROM aws.autoscaling.lifecycle_hooks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lifecycle_hooks_list_only resource, see lifecycle_hooks + diff --git a/website/docs/services/autoscaling/scaling_policies/index.md b/website/docs/services/autoscaling/scaling_policies/index.md new file mode 100644 index 0000000..067b1ca --- /dev/null +++ b/website/docs/services/autoscaling/scaling_policies/index.md @@ -0,0 +1,338 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a scaling_policy resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.
string
stringOne of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
objectA predictive scaling policy. Includes support for predefined metrics only.
integerThe amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)
stringThe duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
arrayA set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)
stringThe name of the Auto Scaling group.
integerThe minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
objectA target tracking scaling policy. Includes support for predefined or customized metrics.
integerThe estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.
stringSpecifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
stringThe ARN of the AutoScaling scaling policy
stringAWS region.
+ +For more information, see AWS::AutoScaling::ScalingPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scaling_policies in a region. +```sql +SELECT +region, +metric_aggregation_type, +policy_name, +policy_type, +predictive_scaling_configuration, +scaling_adjustment, +cooldown, +step_adjustments, +auto_scaling_group_name, +min_adjustment_magnitude, +target_tracking_configuration, +estimated_instance_warmup, +adjustment_type, +arn +FROM aws.autoscaling.scaling_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual scaling_policy. +```sql +SELECT +region, +metric_aggregation_type, +policy_name, +policy_type, +predictive_scaling_configuration, +scaling_adjustment, +cooldown, +step_adjustments, +auto_scaling_group_name, +min_adjustment_magnitude, +target_tracking_configuration, +estimated_instance_warmup, +adjustment_type, +arn +FROM aws.autoscaling.scaling_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scaling_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.scaling_policies ( + AutoScalingGroupName, + region +) +SELECT +'{{ AutoScalingGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.scaling_policies ( + MetricAggregationType, + PolicyType, + PredictiveScalingConfiguration, + ScalingAdjustment, + Cooldown, + StepAdjustments, + AutoScalingGroupName, + MinAdjustmentMagnitude, + TargetTrackingConfiguration, + EstimatedInstanceWarmup, + AdjustmentType, + region +) +SELECT + '{{ MetricAggregationType }}', + '{{ PolicyType }}', + '{{ PredictiveScalingConfiguration }}', + '{{ ScalingAdjustment }}', + '{{ Cooldown }}', + '{{ StepAdjustments }}', + '{{ AutoScalingGroupName }}', + '{{ MinAdjustmentMagnitude }}', + '{{ TargetTrackingConfiguration }}', + '{{ EstimatedInstanceWarmup }}', + '{{ AdjustmentType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: scaling_policy + props: + - name: MetricAggregationType + value: '{{ MetricAggregationType }}' + - name: PolicyType + value: '{{ PolicyType }}' + - name: PredictiveScalingConfiguration + value: + MetricSpecifications: + - CustomizedCapacityMetricSpecification: + MetricDataQueries: + - Label: '{{ Label }}' + MetricStat: + Metric: + MetricName: '{{ MetricName }}' + Dimensions: + - Value: '{{ Value }}' + Name: '{{ Name }}' + Namespace: '{{ Namespace }}' + Stat: '{{ Stat }}' + Unit: '{{ Unit }}' + Id: '{{ Id }}' + ReturnData: '{{ ReturnData }}' + Expression: '{{ Expression }}' + CustomizedLoadMetricSpecification: + MetricDataQueries: + - null + CustomizedScalingMetricSpecification: + MetricDataQueries: + - null + PredefinedLoadMetricSpecification: + ResourceLabel: '{{ ResourceLabel }}' + PredefinedMetricType: '{{ PredefinedMetricType }}' + TargetValue: null + PredefinedScalingMetricSpecification: + ResourceLabel: '{{ ResourceLabel }}' + PredefinedMetricType: '{{ PredefinedMetricType }}' + PredefinedMetricPairSpecification: + ResourceLabel: '{{ ResourceLabel }}' + PredefinedMetricType: '{{ PredefinedMetricType }}' + MaxCapacityBreachBehavior: '{{ MaxCapacityBreachBehavior }}' + MaxCapacityBuffer: '{{ MaxCapacityBuffer }}' + SchedulingBufferTime: '{{ SchedulingBufferTime }}' + Mode: '{{ Mode }}' + - name: ScalingAdjustment + value: '{{ ScalingAdjustment }}' + - name: Cooldown + value: '{{ Cooldown }}' + - name: StepAdjustments + value: + - MetricIntervalUpperBound: null + MetricIntervalLowerBound: null + ScalingAdjustment: '{{ ScalingAdjustment }}' + - name: AutoScalingGroupName + value: '{{ AutoScalingGroupName }}' + - name: MinAdjustmentMagnitude + value: '{{ MinAdjustmentMagnitude }}' + - name: TargetTrackingConfiguration + value: + CustomizedMetricSpecification: + MetricName: '{{ MetricName }}' + Dimensions: + - null + Metrics: + - Label: '{{ Label }}' + MetricStat: + Metric: null + Stat: '{{ Stat }}' + Unit: '{{ Unit }}' + Period: '{{ Period }}' + Id: '{{ Id }}' + ReturnData: '{{ ReturnData }}' + Expression: '{{ Expression }}' + Period: '{{ Period }}' + Statistic: '{{ Statistic }}' + Unit: '{{ Unit }}' + Namespace: '{{ Namespace }}' + Period: '{{ Period }}' + TargetValue: null + DisableScaleIn: '{{ DisableScaleIn }}' + PredefinedMetricSpecification: + ResourceLabel: '{{ ResourceLabel }}' + PredefinedMetricType: '{{ PredefinedMetricType }}' + - name: EstimatedInstanceWarmup + value: '{{ EstimatedInstanceWarmup }}' + - name: AdjustmentType + value: '{{ AdjustmentType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.autoscaling.scaling_policies +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +autoscaling:DescribePolicies +``` + +### Update +```json +autoscaling:DescribePolicies, +autoscaling:PutScalingPolicy, +cloudwatch:GetMetricData +``` + +### Delete +```json +autoscaling:DeletePolicy, +autoscaling:DescribePolicies +``` + +### List +```json +autoscaling:DescribePolicies +``` diff --git a/website/docs/services/autoscaling/scaling_policies_list_only/index.md b/website/docs/services/autoscaling/scaling_policies_list_only/index.md new file mode 100644 index 0000000..495c6a6 --- /dev/null +++ b/website/docs/services/autoscaling/scaling_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: scaling_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scaling_policies_list_only + - autoscaling + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scaling_policies in a region or regions, for all properties use scaling_policies + +## Overview + + + + + + + +
Namescaling_policies_list_only
TypeResource
DescriptionThe AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the AutoScaling scaling policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scaling_policies in a region. +```sql +SELECT +region, +arn +FROM aws.autoscaling.scaling_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scaling_policies_list_only resource, see scaling_policies + diff --git a/website/docs/services/autoscaling/scheduled_actions/index.md b/website/docs/services/autoscaling/scheduled_actions/index.md new file mode 100644 index 0000000..2009a0f --- /dev/null +++ b/website/docs/services/autoscaling/scheduled_actions/index.md @@ -0,0 +1,248 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a scheduled_action resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringAuto-generated unique identifier
integerThe minimum size of the Auto Scaling group.
stringThe recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
stringThe time zone for the cron expression.
stringThe latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
stringThe name of the Auto Scaling group.
stringThe earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
integerThe desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
integerThe minimum size of the Auto Scaling group.
stringAWS region.
+ +For more information, see AWS::AutoScaling::ScheduledAction. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scheduled_actions in a region. +```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_actions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual scheduled_action. +```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_actions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scheduled_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.scheduled_actions ( + AutoScalingGroupName, + region +) +SELECT +'{{ AutoScalingGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.scheduled_actions ( + MinSize, + Recurrence, + TimeZone, + EndTime, + AutoScalingGroupName, + StartTime, + DesiredCapacity, + MaxSize, + region +) +SELECT + '{{ MinSize }}', + '{{ Recurrence }}', + '{{ TimeZone }}', + '{{ EndTime }}', + '{{ AutoScalingGroupName }}', + '{{ StartTime }}', + '{{ DesiredCapacity }}', + '{{ MaxSize }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: scheduled_action + props: + - name: MinSize + value: '{{ MinSize }}' + - name: Recurrence + value: '{{ Recurrence }}' + - name: TimeZone + value: '{{ TimeZone }}' + - name: EndTime + value: '{{ EndTime }}' + - name: AutoScalingGroupName + value: '{{ AutoScalingGroupName }}' + - name: StartTime + value: '{{ StartTime }}' + - name: DesiredCapacity + value: '{{ DesiredCapacity }}' + - name: MaxSize + value: '{{ MaxSize }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.autoscaling.scheduled_actions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the scheduled_actions resource, the following permissions are required: + +### Create +```json +autoscaling:PutScheduledUpdateGroupAction, +autoscaling:DescribeScheduledActions +``` + +### Read +```json +autoscaling:DescribeScheduledActions +``` + +### Update +```json +autoscaling:PutScheduledUpdateGroupAction +``` + +### Delete +```json +autoscaling:DeleteScheduledAction, +autoscaling:DescribeScheduledActions +``` + +### List +```json +autoscaling:DescribeScheduledActions +``` diff --git a/website/docs/services/autoscaling/scheduled_actions_list_only/index.md b/website/docs/services/autoscaling/scheduled_actions_list_only/index.md new file mode 100644 index 0000000..61ef538 --- /dev/null +++ b/website/docs/services/autoscaling/scheduled_actions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: scheduled_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_actions_list_only + - autoscaling + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scheduled_actions in a region or regions, for all properties use scheduled_actions + +## Overview + + + + + + + +
Namescheduled_actions_list_only
TypeResource
DescriptionThe AWS::AutoScaling::ScheduledAction resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringAuto-generated unique identifier
stringThe name of the Auto Scaling group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scheduled_actions in a region. +```sql +SELECT +region, +scheduled_action_name, +auto_scaling_group_name +FROM aws.autoscaling.scheduled_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_actions_list_only resource, see scheduled_actions + diff --git a/website/docs/services/autoscaling/warm_pools/index.md b/website/docs/services/autoscaling/warm_pools/index.md new file mode 100644 index 0000000..e163c24 --- /dev/null +++ b/website/docs/services/autoscaling/warm_pools/index.md @@ -0,0 +1,207 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a warm_pool resource or lists warm_pools in a region + +## Overview + + + + + + + +
Namewarm_pools
TypeResource
DescriptionResource schema for AWS::AutoScaling::WarmPool.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
integer
integer
string
object
stringAWS region.
+ +For more information, see AWS::AutoScaling::WarmPool. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual warm_pool. +```sql +SELECT +region, +auto_scaling_group_name, +max_group_prepared_capacity, +min_size, +pool_state, +instance_reuse_policy +FROM aws.autoscaling.warm_pools +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new warm_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.warm_pools ( + AutoScalingGroupName, + region +) +SELECT +'{{ AutoScalingGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.autoscaling.warm_pools ( + AutoScalingGroupName, + MaxGroupPreparedCapacity, + MinSize, + PoolState, + InstanceReusePolicy, + region +) +SELECT + '{{ AutoScalingGroupName }}', + '{{ MaxGroupPreparedCapacity }}', + '{{ MinSize }}', + '{{ PoolState }}', + '{{ InstanceReusePolicy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: warm_pool + props: + - name: AutoScalingGroupName + value: '{{ AutoScalingGroupName }}' + - name: MaxGroupPreparedCapacity + value: '{{ MaxGroupPreparedCapacity }}' + - name: MinSize + value: '{{ MinSize }}' + - name: PoolState + value: '{{ PoolState }}' + - name: InstanceReusePolicy + value: + ReuseOnScaleIn: '{{ ReuseOnScaleIn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.autoscaling.warm_pools +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +autoscaling:DeleteWarmPool, +autoscaling:DescribeWarmPool +``` + +### Read +```json +autoscaling:DescribeWarmPool +``` + +### Update +```json +autoscaling:PutWarmPool, +autoscaling:DescribeWarmPool, +autoscaling:DescribeAutoScalingGroups +``` diff --git a/website/docs/services/b2bi/capabilities/index.md b/website/docs/services/b2bi/capabilities/index.md new file mode 100644 index 0000000..43b8dc5 --- /dev/null +++ b/website/docs/services/b2bi/capabilities/index.md @@ -0,0 +1,260 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a capability resource or lists capabilities in a region + +## Overview + + + + + + + +
Namecapabilities
TypeResource
DescriptionDefinition of AWS::B2BI::Capability Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
array
string
string
array
string
stringAWS region.
+ +For more information, see AWS::B2BI::Capability. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all capabilities in a region. +```sql +SELECT +region, +capability_arn, +capability_id, +configuration, +created_at, +instructions_documents, +modified_at, +name, +tags, +type +FROM aws.b2bi.capabilities +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual capability. +```sql +SELECT +region, +capability_arn, +capability_id, +configuration, +created_at, +instructions_documents, +modified_at, +name, +tags, +type +FROM aws.b2bi.capabilities +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new capability resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.b2bi.capabilities ( + Configuration, + Name, + Type, + region +) +SELECT +'{{ Configuration }}', + '{{ Name }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.b2bi.capabilities ( + Configuration, + InstructionsDocuments, + Name, + Tags, + Type, + region +) +SELECT + '{{ Configuration }}', + '{{ InstructionsDocuments }}', + '{{ Name }}', + '{{ Tags }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: capability + props: + - name: Configuration + value: null + - name: InstructionsDocuments + value: + - BucketName: '{{ BucketName }}' + Key: '{{ Key }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.b2bi.capabilities +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +b2bi:GetCapability, +b2bi:ListTagsForResource +``` + +### Update +```json +b2bi:TagResource, +b2bi:UntagResource, +b2bi:UpdateCapability +``` + +### Delete +```json +b2bi:DeleteCapability +``` + +### List +```json +b2bi:ListCapabilities +``` diff --git a/website/docs/services/b2bi/capabilities_list_only/index.md b/website/docs/services/b2bi/capabilities_list_only/index.md new file mode 100644 index 0000000..4780fe2 --- /dev/null +++ b/website/docs/services/b2bi/capabilities_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: capabilities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - capabilities_list_only + - b2bi + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists capabilities in a region or regions, for all properties use capabilities + +## Overview + + + + + + + +
Namecapabilities_list_only
TypeResource
DescriptionDefinition of AWS::B2BI::Capability Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all capabilities in a region. +```sql +SELECT +region, +capability_id +FROM aws.b2bi.capabilities_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capabilities_list_only resource, see capabilities + diff --git a/website/docs/services/b2bi/capability_tags/index.md b/website/docs/services/b2bi/capability_tags/index.md new file mode 100644 index 0000000..cc077ac --- /dev/null +++ b/website/docs/services/b2bi/capability_tags/index.md @@ -0,0 +1,91 @@ +--- +title: capability_tags +hide_title: false +hide_table_of_contents: false +keywords: + - capability_tags + - b2bi + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for capabilities in a region + +## Overview + + + + + + + +
Namecapability_tags
TypeResource
DescriptionDefinition of AWS::B2BI::Capability Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
array
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all capabilities in a region. +```sql +SELECT +region, +capability_arn, +capability_id, +configuration, +created_at, +instructions_documents, +modified_at, +name, +type, +tag_key, +tag_value +FROM aws.b2bi.capability_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capability_tags resource, see capabilities + diff --git a/website/docs/services/b2bi/index.md b/website/docs/services/b2bi/index.md new file mode 100644 index 0000000..86ff0ac --- /dev/null +++ b/website/docs/services/b2bi/index.md @@ -0,0 +1,47 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The b2bi service documentation. + +:::info Service Summary + +
+
+total resources: 12
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/b2bi/partnership_tags/index.md b/website/docs/services/b2bi/partnership_tags/index.md new file mode 100644 index 0000000..c51e8f3 --- /dev/null +++ b/website/docs/services/b2bi/partnership_tags/index.md @@ -0,0 +1,97 @@ +--- +title: partnership_tags +hide_title: false +hide_table_of_contents: false +keywords: + - partnership_tags + - b2bi + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for partnerships in a region + +## Overview + + + + + + + +
Namepartnership_tags
TypeResource
DescriptionDefinition of AWS::B2BI::Partnership Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
object
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all partnerships in a region. +```sql +SELECT +region, +capabilities, +capability_options, +created_at, +email, +modified_at, +name, +partnership_arn, +partnership_id, +phone, +profile_id, +trading_partner_id, +tag_key, +tag_value +FROM aws.b2bi.partnership_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the partnership_tags resource, see partnerships + diff --git a/website/docs/services/b2bi/partnerships/index.md b/website/docs/services/b2bi/partnerships/index.md new file mode 100644 index 0000000..fabff0b --- /dev/null +++ b/website/docs/services/b2bi/partnerships/index.md @@ -0,0 +1,266 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a partnership resource or lists partnerships in a region + +## Overview + + + + + + + +
Namepartnerships
TypeResource
DescriptionDefinition of AWS::B2BI::Partnership Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
object
string
string
string
string
string
string
string
string
array
string
stringAWS region.
+ +For more information, see AWS::B2BI::Partnership. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all partnerships in a region. +```sql +SELECT +region, +capabilities, +capability_options, +created_at, +email, +modified_at, +name, +partnership_arn, +partnership_id, +phone, +profile_id, +tags, +trading_partner_id +FROM aws.b2bi.partnerships +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual partnership. +```sql +SELECT +region, +capabilities, +capability_options, +created_at, +email, +modified_at, +name, +partnership_arn, +partnership_id, +phone, +profile_id, +tags, +trading_partner_id +FROM aws.b2bi.partnerships +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new partnership resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.b2bi.partnerships ( + Capabilities, + Email, + Name, + ProfileId, + region +) +SELECT +'{{ Capabilities }}', + '{{ Email }}', + '{{ Name }}', + '{{ ProfileId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.b2bi.partnerships ( + Capabilities, + CapabilityOptions, + Email, + Name, + Phone, + ProfileId, + Tags, + region +) +SELECT + '{{ Capabilities }}', + '{{ CapabilityOptions }}', + '{{ Email }}', + '{{ Name }}', + '{{ Phone }}', + '{{ ProfileId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: partnership + props: + - name: Capabilities + value: + - '{{ Capabilities[0] }}' + - name: CapabilityOptions + value: + OutboundEdi: null + - name: Email + value: '{{ Email }}' + - name: Name + value: '{{ Name }}' + - name: Phone + value: '{{ Phone }}' + - name: ProfileId + value: '{{ ProfileId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.b2bi.partnerships +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the partnerships resource, the following permissions are required: + +### Create +```json +b2bi:CreatePartnership, +b2bi:TagResource, +s3:PutObject +``` + +### Read +```json +b2bi:GetPartnership, +b2bi:ListTagsForResource +``` + +### Update +```json +b2bi:TagResource, +b2bi:UntagResource, +b2bi:UpdatePartnership +``` + +### Delete +```json +b2bi:DeletePartnership +``` + +### List +```json +b2bi:ListPartnerships +``` diff --git a/website/docs/services/b2bi/partnerships_list_only/index.md b/website/docs/services/b2bi/partnerships_list_only/index.md new file mode 100644 index 0000000..559c92e --- /dev/null +++ b/website/docs/services/b2bi/partnerships_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: partnerships_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - partnerships_list_only + - b2bi + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists partnerships in a region or regions, for all properties use partnerships + +## Overview + + + + + + + +
Namepartnerships_list_only
TypeResource
DescriptionDefinition of AWS::B2BI::Partnership Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all partnerships in a region. +```sql +SELECT +region, +partnership_id +FROM aws.b2bi.partnerships_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the partnerships_list_only resource, see partnerships + diff --git a/website/docs/services/b2bi/profile_tags/index.md b/website/docs/services/b2bi/profile_tags/index.md new file mode 100644 index 0000000..aae472b --- /dev/null +++ b/website/docs/services/b2bi/profile_tags/index.md @@ -0,0 +1,95 @@ +--- +title: profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profile_tags + - b2bi + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profiles in a region + +## Overview + + + + + + + +
Nameprofile_tags
TypeResource
DescriptionDefinition of AWS::B2BI::Profile Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profiles in a region. +```sql +SELECT +region, +business_name, +created_at, +email, +log_group_name, +logging, +modified_at, +name, +phone, +profile_arn, +profile_id, +tag_key, +tag_value +FROM aws.b2bi.profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_tags resource, see profiles + diff --git a/website/docs/services/b2bi/profiles/index.md b/website/docs/services/b2bi/profiles/index.md new file mode 100644 index 0000000..d7e3730 --- /dev/null +++ b/website/docs/services/b2bi/profiles/index.md @@ -0,0 +1,267 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a profile resource or lists profiles in a region + +## Overview + + + + + + + +
Nameprofiles
TypeResource
DescriptionDefinition of AWS::B2BI::Profile Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::B2BI::Profile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all profiles in a region. +```sql +SELECT +region, +business_name, +created_at, +email, +log_group_name, +logging, +modified_at, +name, +phone, +profile_arn, +profile_id, +tags +FROM aws.b2bi.profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual profile. +```sql +SELECT +region, +business_name, +created_at, +email, +log_group_name, +logging, +modified_at, +name, +phone, +profile_arn, +profile_id, +tags +FROM aws.b2bi.profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.b2bi.profiles ( + BusinessName, + Logging, + Name, + Phone, + region +) +SELECT +'{{ BusinessName }}', + '{{ Logging }}', + '{{ Name }}', + '{{ Phone }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.b2bi.profiles ( + BusinessName, + Email, + Logging, + Name, + Phone, + Tags, + region +) +SELECT + '{{ BusinessName }}', + '{{ Email }}', + '{{ Logging }}', + '{{ Name }}', + '{{ Phone }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: profile + props: + - name: BusinessName + value: '{{ BusinessName }}' + - name: Email + value: '{{ Email }}' + - name: Logging + value: '{{ Logging }}' + - name: Name + value: '{{ Name }}' + - name: Phone + value: '{{ Phone }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.b2bi.profiles +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +b2bi:GetProfile, +b2bi:ListTagsForResource +``` + +### Update +```json +b2bi:TagResource, +b2bi:UntagResource, +b2bi:UpdateProfile +``` + +### Delete +```json +b2bi:DeleteProfile, +logs:DeleteLogDelivery, +logs:ListLogDeliveries +``` + +### List +```json +b2bi:ListProfiles +``` diff --git a/website/docs/services/b2bi/profiles_list_only/index.md b/website/docs/services/b2bi/profiles_list_only/index.md new file mode 100644 index 0000000..adc230a --- /dev/null +++ b/website/docs/services/b2bi/profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profiles_list_only + - b2bi + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profiles in a region or regions, for all properties use profiles + +## Overview + + + + + + + +
Nameprofiles_list_only
TypeResource
DescriptionDefinition of AWS::B2BI::Profile Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profiles in a region. +```sql +SELECT +region, +profile_id +FROM aws.b2bi.profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiles_list_only resource, see profiles + diff --git a/website/docs/services/b2bi/transformer_tags/index.md b/website/docs/services/b2bi/transformer_tags/index.md new file mode 100644 index 0000000..64ddbfd --- /dev/null +++ b/website/docs/services/b2bi/transformer_tags/index.md @@ -0,0 +1,103 @@ +--- +title: transformer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transformer_tags + - b2bi + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transformers in a region + +## Overview + + + + + + + +
Nametransformer_tags
TypeResource
DescriptionDefinition of AWS::B2BI::Transformer Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
object
object
stringThis shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.
string
string
object
stringThis shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.
object
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transformers in a region. +```sql +SELECT +region, +created_at, +edi_type, +file_format, +input_conversion, +mapping, +mapping_template, +modified_at, +name, +output_conversion, +sample_document, +sample_documents, +status, +transformer_arn, +transformer_id, +tag_key, +tag_value +FROM aws.b2bi.transformer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transformer_tags resource, see transformers + diff --git a/website/docs/services/b2bi/transformers/index.md b/website/docs/services/b2bi/transformers/index.md new file mode 100644 index 0000000..6dce229 --- /dev/null +++ b/website/docs/services/b2bi/transformers/index.md @@ -0,0 +1,306 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transformer resource or lists transformers in a region + +## Overview + + + + + + + +
Nametransformers
TypeResource
DescriptionDefinition of AWS::B2BI::Transformer Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
object
object
stringThis shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.
string
string
object
stringThis shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.
object
string
array
string
string
stringAWS region.
+ +For more information, see AWS::B2BI::Transformer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transformers in a region. +```sql +SELECT +region, +created_at, +edi_type, +file_format, +input_conversion, +mapping, +mapping_template, +modified_at, +name, +output_conversion, +sample_document, +sample_documents, +status, +tags, +transformer_arn, +transformer_id +FROM aws.b2bi.transformers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transformer. +```sql +SELECT +region, +created_at, +edi_type, +file_format, +input_conversion, +mapping, +mapping_template, +modified_at, +name, +output_conversion, +sample_document, +sample_documents, +status, +tags, +transformer_arn, +transformer_id +FROM aws.b2bi.transformers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transformer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.b2bi.transformers ( + Name, + Status, + region +) +SELECT +'{{ Name }}', + '{{ Status }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.b2bi.transformers ( + EdiType, + FileFormat, + InputConversion, + Mapping, + MappingTemplate, + Name, + OutputConversion, + SampleDocument, + SampleDocuments, + Status, + Tags, + region +) +SELECT + '{{ EdiType }}', + '{{ FileFormat }}', + '{{ InputConversion }}', + '{{ Mapping }}', + '{{ MappingTemplate }}', + '{{ Name }}', + '{{ OutputConversion }}', + '{{ SampleDocument }}', + '{{ SampleDocuments }}', + '{{ Status }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transformer + props: + - name: EdiType + value: null + - name: FileFormat + value: '{{ FileFormat }}' + - name: InputConversion + value: + FromFormat: '{{ FromFormat }}' + FormatOptions: null + - name: Mapping + value: + TemplateLanguage: '{{ TemplateLanguage }}' + Template: '{{ Template }}' + - name: MappingTemplate + value: '{{ MappingTemplate }}' + - name: Name + value: '{{ Name }}' + - name: OutputConversion + value: + ToFormat: '{{ ToFormat }}' + FormatOptions: null + - name: SampleDocument + value: '{{ SampleDocument }}' + - name: SampleDocuments + value: + BucketName: '{{ BucketName }}' + Keys: + - Input: '{{ Input }}' + Output: '{{ Output }}' + - name: Status + value: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.b2bi.transformers +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +b2bi:GetTransformer, +b2bi:ListTagsForResource +``` + +### Update +```json +b2bi:TagResource, +b2bi:UntagResource, +b2bi:UpdateTransformer +``` + +### Delete +```json +b2bi:DeleteTransformer, +logs:DeleteLogDelivery, +logs:ListLogDeliveries +``` + +### List +```json +b2bi:ListTransformers +``` diff --git a/website/docs/services/b2bi/transformers_list_only/index.md b/website/docs/services/b2bi/transformers_list_only/index.md new file mode 100644 index 0000000..58db4fa --- /dev/null +++ b/website/docs/services/b2bi/transformers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transformers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transformers_list_only + - b2bi + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transformers in a region or regions, for all properties use transformers + +## Overview + + + + + + + +
Nametransformers_list_only
TypeResource
DescriptionDefinition of AWS::B2BI::Transformer Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transformers in a region. +```sql +SELECT +region, +transformer_id +FROM aws.b2bi.transformers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transformers_list_only resource, see transformers + diff --git a/website/docs/services/backup/backup_plans/index.md b/website/docs/services/backup/backup_plans/index.md new file mode 100644 index 0000000..97ed661 --- /dev/null +++ b/website/docs/services/backup/backup_plans/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a backup_plan resource or lists backup_plans in a region + +## Overview + + + + + + + +
Namebackup_plans
TypeResource
DescriptionResource Type definition for AWS::Backup::BackupPlan
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
object
object
string
string
string
stringAWS region.
+ +For more information, see AWS::Backup::BackupPlan. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all backup_plans in a region. +```sql +SELECT +region, +backup_plan, +backup_plan_tags, +backup_plan_arn, +backup_plan_id, +version_id +FROM aws.backup.backup_plans +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual backup_plan. +```sql +SELECT +region, +backup_plan, +backup_plan_tags, +backup_plan_arn, +backup_plan_id, +version_id +FROM aws.backup.backup_plans +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new backup_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.backup.backup_plans ( + BackupPlan, + region +) +SELECT +'{{ BackupPlan }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.backup.backup_plans ( + BackupPlan, + BackupPlanTags, + region +) +SELECT + '{{ BackupPlan }}', + '{{ BackupPlanTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: backup_plan + props: + - name: BackupPlan + value: + BackupPlanName: '{{ BackupPlanName }}' + AdvancedBackupSettings: + - BackupOptions: {} + ResourceType: '{{ ResourceType }}' + BackupPlanRule: + - RuleName: '{{ RuleName }}' + TargetBackupVault: '{{ TargetBackupVault }}' + StartWindowMinutes: null + CompletionWindowMinutes: null + ScheduleExpression: '{{ ScheduleExpression }}' + ScheduleExpressionTimezone: '{{ ScheduleExpressionTimezone }}' + RecoveryPointTags: {} + CopyActions: + - Lifecycle: + MoveToColdStorageAfterDays: null + DeleteAfterDays: null + OptInToArchiveForSupportedResources: '{{ OptInToArchiveForSupportedResources }}' + DestinationBackupVaultArn: '{{ DestinationBackupVaultArn }}' + Lifecycle: null + EnableContinuousBackup: '{{ EnableContinuousBackup }}' + - name: BackupPlanTags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.backup.backup_plans +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the backup_plans resource, the following permissions are required: + +### Read +```json +backup:GetBackupPlan, +backup:ListTags +``` + +### Create +```json +backup:GetBackupPlan, +backup:TagResource, +backup:CreateBackupPlan +``` + +### Delete +```json +backup:GetBackupPlan, +backup:DeleteBackupPlan +``` + +### Update +```json +backup:UpdateBackupPlan, +backup:ListTags, +backup:TagResource, +backup:UntagResource +``` + +### List +```json +backup:ListBackupPlans +``` diff --git a/website/docs/services/backup/backup_plans_list_only/index.md b/website/docs/services/backup/backup_plans_list_only/index.md new file mode 100644 index 0000000..ab96d58 --- /dev/null +++ b/website/docs/services/backup/backup_plans_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: backup_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - backup_plans_list_only + - backup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists backup_plans in a region or regions, for all properties use backup_plans + +## Overview + + + + + + + +
Namebackup_plans_list_only
TypeResource
DescriptionResource Type definition for AWS::Backup::BackupPlan
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all backup_plans in a region. +```sql +SELECT +region, +backup_plan_id +FROM aws.backup.backup_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the backup_plans_list_only resource, see backup_plans + diff --git a/website/docs/services/backup/backup_selections/index.md b/website/docs/services/backup/backup_selections/index.md new file mode 100644 index 0000000..ca63568 --- /dev/null +++ b/website/docs/services/backup/backup_selections/index.md @@ -0,0 +1,224 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a backup_selection resource or lists backup_selections in a region + +## Overview + + + + + + + +
Namebackup_selections
TypeResource
DescriptionResource Type definition for AWS::Backup::BackupSelection
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
object
string
stringAWS region.
+ +For more information, see AWS::Backup::BackupSelection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all backup_selections in a region. +```sql +SELECT +region, +id, +backup_plan_id, +backup_selection, +selection_id +FROM aws.backup.backup_selections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual backup_selection. +```sql +SELECT +region, +id, +backup_plan_id, +backup_selection, +selection_id +FROM aws.backup.backup_selections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new backup_selection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.backup.backup_selections ( + BackupPlanId, + BackupSelection, + region +) +SELECT +'{{ BackupPlanId }}', + '{{ BackupSelection }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.backup.backup_selections ( + BackupPlanId, + BackupSelection, + region +) +SELECT + '{{ BackupPlanId }}', + '{{ BackupSelection }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: backup_selection + props: + - name: BackupPlanId + value: '{{ BackupPlanId }}' + - name: BackupSelection + value: + IamRoleArn: '{{ IamRoleArn }}' + ListOfTags: + - ConditionKey: '{{ ConditionKey }}' + ConditionValue: '{{ ConditionValue }}' + ConditionType: '{{ ConditionType }}' + Resources: + - '{{ Resources[0] }}' + SelectionName: '{{ SelectionName }}' + NotResources: + - '{{ NotResources[0] }}' + Conditions: + StringEquals: + - ConditionKey: '{{ ConditionKey }}' + ConditionValue: '{{ ConditionValue }}' + StringNotEquals: + - null + StringLike: + - null + StringNotLike: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.backup.backup_selections +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the backup_selections resource, the following permissions are required: + +### Delete +```json +backup:GetBackupSelection, +backup:DeleteBackupSelection +``` + +### Read +```json +backup:GetBackupSelection +``` + +### Create +```json +backup:CreateBackupSelection, +iam:GetRole, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### List +```json +backup:ListBackupSelections, +backup:ListBackupPlans +``` diff --git a/website/docs/services/backup/backup_selections_list_only/index.md b/website/docs/services/backup/backup_selections_list_only/index.md new file mode 100644 index 0000000..782dbdf --- /dev/null +++ b/website/docs/services/backup/backup_selections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: backup_selections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - backup_selections_list_only + - backup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists backup_selections in a region or regions, for all properties use backup_selections + +## Overview + + + + + + + +
Namebackup_selections_list_only
TypeResource
DescriptionResource Type definition for AWS::Backup::BackupSelection
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all backup_selections in a region. +```sql +SELECT +region, +id +FROM aws.backup.backup_selections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the backup_selections_list_only resource, see backup_selections + diff --git a/website/docs/services/backup/backup_vaults/index.md b/website/docs/services/backup/backup_vaults/index.md new file mode 100644 index 0000000..b3418d5 --- /dev/null +++ b/website/docs/services/backup/backup_vaults/index.md @@ -0,0 +1,261 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a backup_vault resource or lists backup_vaults in a region + +## Overview + + + + + + + +
Namebackup_vaults
TypeResource
DescriptionResource Type definition for AWS::Backup::BackupVault
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
object
string
object
string
object
object
string
stringAWS region.
+ +For more information, see AWS::Backup::BackupVault. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all backup_vaults in a region. +```sql +SELECT +region, +access_policy, +backup_vault_name, +backup_vault_tags, +encryption_key_arn, +notifications, +lock_configuration, +backup_vault_arn +FROM aws.backup.backup_vaults +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual backup_vault. +```sql +SELECT +region, +access_policy, +backup_vault_name, +backup_vault_tags, +encryption_key_arn, +notifications, +lock_configuration, +backup_vault_arn +FROM aws.backup.backup_vaults +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new backup_vault resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.backup.backup_vaults ( + BackupVaultName, + region +) +SELECT +'{{ BackupVaultName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.backup.backup_vaults ( + AccessPolicy, + BackupVaultName, + BackupVaultTags, + EncryptionKeyArn, + Notifications, + LockConfiguration, + region +) +SELECT + '{{ AccessPolicy }}', + '{{ BackupVaultName }}', + '{{ BackupVaultTags }}', + '{{ EncryptionKeyArn }}', + '{{ Notifications }}', + '{{ LockConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: backup_vault + props: + - name: AccessPolicy + value: {} + - name: BackupVaultName + value: '{{ BackupVaultName }}' + - name: BackupVaultTags + value: {} + - name: EncryptionKeyArn + value: '{{ EncryptionKeyArn }}' + - name: Notifications + value: + BackupVaultEvents: + - '{{ BackupVaultEvents[0] }}' + SNSTopicArn: '{{ SNSTopicArn }}' + - name: LockConfiguration + value: + MinRetentionDays: '{{ MinRetentionDays }}' + MaxRetentionDays: '{{ MaxRetentionDays }}' + ChangeableForDays: '{{ ChangeableForDays }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.backup.backup_vaults +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +backup:ListBackupVaults +``` diff --git a/website/docs/services/backup/backup_vaults_list_only/index.md b/website/docs/services/backup/backup_vaults_list_only/index.md new file mode 100644 index 0000000..9e47f6c --- /dev/null +++ b/website/docs/services/backup/backup_vaults_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: backup_vaults_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - backup_vaults_list_only + - backup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists backup_vaults in a region or regions, for all properties use backup_vaults + +## Overview + + + + + + + +
Namebackup_vaults_list_only
TypeResource
DescriptionResource Type definition for AWS::Backup::BackupVault
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all backup_vaults in a region. +```sql +SELECT +region, +backup_vault_name +FROM aws.backup.backup_vaults_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the backup_vaults_list_only resource, see backup_vaults + diff --git a/website/docs/services/backup/frameworks/index.md b/website/docs/services/backup/frameworks/index.md new file mode 100644 index 0000000..83302d8 --- /dev/null +++ b/website/docs/services/backup/frameworks/index.md @@ -0,0 +1,250 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a framework resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
stringAn optional description of the framework with a maximum 1,024 characters.
stringAn Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
stringThe deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`
stringThe date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
arrayContains detailed information about all of the controls of a framework. Each framework must contain at least one control.
stringA framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn AWS Config recording on or off for each resource. The statuses are:
`ACTIVE` when recording is turned on for all resources governed by the framework.
`PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.
`INACTIVE` when recording is turned off for all resources governed by the framework.
`UNAVAILABLE` when AWS Backup is unable to validate recording status at this time.
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
+ +For more information, see AWS::Backup::Framework. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all frameworks in a region. +```sql +SELECT +region, +framework_name, +framework_description, +framework_arn, +deployment_status, +creation_time, +framework_controls, +framework_status, +framework_tags +FROM aws.backup.frameworks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual framework. +```sql +SELECT +region, +framework_name, +framework_description, +framework_arn, +deployment_status, +creation_time, +framework_controls, +framework_status, +framework_tags +FROM aws.backup.frameworks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new framework resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.backup.frameworks ( + FrameworkControls, + region +) +SELECT +'{{ FrameworkControls }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.backup.frameworks ( + FrameworkName, + FrameworkDescription, + FrameworkControls, + FrameworkTags, + region +) +SELECT + '{{ FrameworkName }}', + '{{ FrameworkDescription }}', + '{{ FrameworkControls }}', + '{{ FrameworkTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: framework + props: + - name: FrameworkName + value: '{{ FrameworkName }}' + - name: FrameworkDescription + value: '{{ FrameworkDescription }}' + - name: FrameworkControls + value: + - ControlName: '{{ ControlName }}' + ControlInputParameters: + - ParameterName: '{{ ParameterName }}' + ParameterValue: '{{ ParameterValue }}' + ControlScope: + ComplianceResourceIds: + - '{{ ComplianceResourceIds[0] }}' + ComplianceResourceTypes: + - '{{ ComplianceResourceTypes[0] }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: FrameworkTags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.backup.frameworks +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +backup:DescribeFramework, +backup:ListTags +``` + +### Update +```json +backup:DescribeFramework, +backup:UpdateFramework, +backup:ListTags, +backup:TagResource, +backup:UntagResource +``` + +### Delete +```json +backup:DeleteFramework, +backup:DescribeFramework +``` + +### List +```json +backup:ListFrameworks +``` diff --git a/website/docs/services/backup/frameworks_list_only/index.md b/website/docs/services/backup/frameworks_list_only/index.md new file mode 100644 index 0000000..bd94a02 --- /dev/null +++ b/website/docs/services/backup/frameworks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: frameworks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - frameworks_list_only + - backup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists frameworks in a region or regions, for all properties use frameworks + +## Overview + + + + + + + +
Nameframeworks_list_only
TypeResource
DescriptionContains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAn Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all frameworks in a region. +```sql +SELECT +region, +framework_arn +FROM aws.backup.frameworks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the frameworks_list_only resource, see frameworks + diff --git a/website/docs/services/backup/index.md b/website/docs/services/backup/index.md new file mode 100644 index 0000000..bf5042a --- /dev/null +++ b/website/docs/services/backup/index.md @@ -0,0 +1,52 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The backup service documentation. + +:::info Service Summary + +
+
+total resources: 17
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/backup/logically_air_gapped_backup_vaults/index.md b/website/docs/services/backup/logically_air_gapped_backup_vaults/index.md new file mode 100644 index 0000000..dc085fe --- /dev/null +++ b/website/docs/services/backup/logically_air_gapped_backup_vaults/index.md @@ -0,0 +1,267 @@ +--- +title: logically_air_gapped_backup_vaults +hide_title: false +hide_table_of_contents: false +keywords: + - logically_air_gapped_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a logically_air_gapped_backup_vault resource or lists logically_air_gapped_backup_vaults in a region + +## Overview + + + + + + + +
Namelogically_air_gapped_backup_vaults
TypeResource
DescriptionResource Type definition for AWS::Backup::LogicallyAirGappedBackupVault
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
integer
integer
object
object
string
string
string
string
stringAWS region.
+ +For more information, see AWS::Backup::LogicallyAirGappedBackupVault. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all logically_air_gapped_backup_vaults in a region. +```sql +SELECT +region, +access_policy, +backup_vault_name, +min_retention_days, +max_retention_days, +backup_vault_tags, +notifications, +encryption_key_arn, +backup_vault_arn, +vault_state, +vault_type +FROM aws.backup.logically_air_gapped_backup_vaults +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual logically_air_gapped_backup_vault. +```sql +SELECT +region, +access_policy, +backup_vault_name, +min_retention_days, +max_retention_days, +backup_vault_tags, +notifications, +encryption_key_arn, +backup_vault_arn, +vault_state, +vault_type +FROM aws.backup.logically_air_gapped_backup_vaults +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new logically_air_gapped_backup_vault resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.backup.logically_air_gapped_backup_vaults ( + BackupVaultName, + MinRetentionDays, + MaxRetentionDays, + region +) +SELECT +'{{ BackupVaultName }}', + '{{ MinRetentionDays }}', + '{{ MaxRetentionDays }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.backup.logically_air_gapped_backup_vaults ( + AccessPolicy, + BackupVaultName, + MinRetentionDays, + MaxRetentionDays, + BackupVaultTags, + Notifications, + region +) +SELECT + '{{ AccessPolicy }}', + '{{ BackupVaultName }}', + '{{ MinRetentionDays }}', + '{{ MaxRetentionDays }}', + '{{ BackupVaultTags }}', + '{{ Notifications }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: logically_air_gapped_backup_vault + props: + - name: AccessPolicy + value: {} + - name: BackupVaultName + value: '{{ BackupVaultName }}' + - name: MinRetentionDays + value: '{{ MinRetentionDays }}' + - name: MaxRetentionDays + value: '{{ MaxRetentionDays }}' + - name: BackupVaultTags + value: {} + - name: Notifications + value: + BackupVaultEvents: + - '{{ BackupVaultEvents[0] }}' + SNSTopicArn: '{{ SNSTopicArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.backup.logically_air_gapped_backup_vaults +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the logically_air_gapped_backup_vaults resource, the following permissions are required: + +### Create +```json +backup:TagResource, +backup:CreateLogicallyAirGappedBackupVault, +backup:PutBackupVaultAccessPolicy, +backup:PutBackupVaultNotifications, +backup-storage:Mount, +backup-storage:MountCapsule, +backup:DescribeBackupVault +``` + +### Read +```json +backup:DescribeBackupVault, +backup:GetBackupVaultNotifications, +backup:GetBackupVaultAccessPolicy, +backup:ListTags +``` + +### Update +```json +backup:DescribeBackupVault, +backup:DeleteBackupVaultAccessPolicy, +backup:DeleteBackupVaultNotifications, +backup:DeleteBackupVaultLockConfiguration, +backup:GetBackupVaultAccessPolicy, +backup:ListTags, +backup:TagResource, +backup:UntagResource, +backup:PutBackupVaultAccessPolicy, +backup:PutBackupVaultNotifications, +backup:PutBackupVaultLockConfiguration +``` + +### Delete +```json +backup:DeleteBackupVault +``` + +### List +```json +backup:ListBackupVaults +``` diff --git a/website/docs/services/backup/logically_air_gapped_backup_vaults_list_only/index.md b/website/docs/services/backup/logically_air_gapped_backup_vaults_list_only/index.md new file mode 100644 index 0000000..73368ff --- /dev/null +++ b/website/docs/services/backup/logically_air_gapped_backup_vaults_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: logically_air_gapped_backup_vaults_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - logically_air_gapped_backup_vaults_list_only + - backup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists logically_air_gapped_backup_vaults in a region or regions, for all properties use logically_air_gapped_backup_vaults + +## Overview + + + + + + + +
Namelogically_air_gapped_backup_vaults_list_only
TypeResource
DescriptionResource Type definition for AWS::Backup::LogicallyAirGappedBackupVault
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all logically_air_gapped_backup_vaults in a region. +```sql +SELECT +region, +backup_vault_name +FROM aws.backup.logically_air_gapped_backup_vaults_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the logically_air_gapped_backup_vaults_list_only resource, see logically_air_gapped_backup_vaults + diff --git a/website/docs/services/backup/report_plans/index.md b/website/docs/services/backup/report_plans/index.md new file mode 100644 index 0000000..a7a3a9f --- /dev/null +++ b/website/docs/services/backup/report_plans/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a report_plan resource or lists report_plans in a region + +## Overview + + + + + + + +
Namereport_plans
TypeResource
DescriptionContains detailed information about a report plan in AWS Backup Audit Manager.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
stringAn Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
stringAn optional description of the report plan with a maximum of 1,024 characters.
arrayMetadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
objectA structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
objectIdentifies the report template for the report. Reports are built using a report template.
stringAWS region.
+ +For more information, see AWS::Backup::ReportPlan. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all report_plans in a region. +```sql +SELECT +region, +report_plan_name, +report_plan_arn, +report_plan_description, +report_plan_tags, +report_delivery_channel, +report_setting +FROM aws.backup.report_plans +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual report_plan. +```sql +SELECT +region, +report_plan_name, +report_plan_arn, +report_plan_description, +report_plan_tags, +report_delivery_channel, +report_setting +FROM aws.backup.report_plans +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new report_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.backup.report_plans ( + ReportDeliveryChannel, + ReportSetting, + region +) +SELECT +'{{ ReportDeliveryChannel }}', + '{{ ReportSetting }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.backup.report_plans ( + ReportPlanName, + ReportPlanDescription, + ReportPlanTags, + ReportDeliveryChannel, + ReportSetting, + region +) +SELECT + '{{ ReportPlanName }}', + '{{ ReportPlanDescription }}', + '{{ ReportPlanTags }}', + '{{ ReportDeliveryChannel }}', + '{{ ReportSetting }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: report_plan + props: + - name: ReportPlanName + value: '{{ ReportPlanName }}' + - name: ReportPlanDescription + value: '{{ ReportPlanDescription }}' + - name: ReportPlanTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ReportDeliveryChannel + value: + Formats: + - '{{ Formats[0] }}' + S3BucketName: '{{ S3BucketName }}' + S3KeyPrefix: '{{ S3KeyPrefix }}' + - name: ReportSetting + value: + ReportTemplate: '{{ ReportTemplate }}' + FrameworkArns: + - '{{ FrameworkArns[0] }}' + Accounts: + - '{{ Accounts[0] }}' + OrganizationUnits: + - '{{ OrganizationUnits[0] }}' + Regions: + - '{{ Regions[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.backup.report_plans +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +backup:DescribeReportPlan, +backup:ListTags +``` + +### Update +```json +backup:DescribeReportPlan, +backup:UpdateReportPlan, +backup:ListTags, +backup:UntagResource, +backup:TagResource +``` + +### Delete +```json +backup:DeleteReportPlan, +backup:DescribeReportPlan +``` + +### List +```json +backup:ListReportPlans +``` diff --git a/website/docs/services/backup/report_plans_list_only/index.md b/website/docs/services/backup/report_plans_list_only/index.md new file mode 100644 index 0000000..29fb534 --- /dev/null +++ b/website/docs/services/backup/report_plans_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: report_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - report_plans_list_only + - backup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists report_plans in a region or regions, for all properties use report_plans + +## Overview + + + + + + + +
Namereport_plans_list_only
TypeResource
DescriptionContains detailed information about a report plan in AWS Backup Audit Manager.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAn Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all report_plans in a region. +```sql +SELECT +region, +report_plan_arn +FROM aws.backup.report_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the report_plans_list_only resource, see report_plans + diff --git a/website/docs/services/backup/restore_testing_plan_tags/index.md b/website/docs/services/backup/restore_testing_plan_tags/index.md new file mode 100644 index 0000000..0243162 --- /dev/null +++ b/website/docs/services/backup/restore_testing_plan_tags/index.md @@ -0,0 +1,89 @@ +--- +title: restore_testing_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - restore_testing_plan_tags + - backup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for restore_testing_plans in a region + +## Overview + + + + + + + +
Namerestore_testing_plan_tags
TypeResource
DescriptionDefinition of AWS::Backup::RestoreTestingPlan Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all restore_testing_plans in a region. +```sql +SELECT +region, +recovery_point_selection, +restore_testing_plan_arn, +restore_testing_plan_name, +schedule_expression, +schedule_expression_timezone, +schedule_status, +start_window_hours, +tag_key, +tag_value +FROM aws.backup.restore_testing_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the restore_testing_plan_tags resource, see restore_testing_plans + diff --git a/website/docs/services/backup/restore_testing_plans/index.md b/website/docs/services/backup/restore_testing_plans/index.md new file mode 100644 index 0000000..d1f0da3 --- /dev/null +++ b/website/docs/services/backup/restore_testing_plans/index.md @@ -0,0 +1,264 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a restore_testing_plan resource or lists restore_testing_plans in a region + +## Overview + + + + + + + +
Namerestore_testing_plans
TypeResource
DescriptionDefinition of AWS::Backup::RestoreTestingPlan Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
integer
array
stringAWS region.
+ +For more information, see AWS::Backup::RestoreTestingPlan. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all restore_testing_plans in a region. +```sql +SELECT +region, +recovery_point_selection, +restore_testing_plan_arn, +restore_testing_plan_name, +schedule_expression, +schedule_expression_timezone, +schedule_status, +start_window_hours, +tags +FROM aws.backup.restore_testing_plans +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual restore_testing_plan. +```sql +SELECT +region, +recovery_point_selection, +restore_testing_plan_arn, +restore_testing_plan_name, +schedule_expression, +schedule_expression_timezone, +schedule_status, +start_window_hours, +tags +FROM aws.backup.restore_testing_plans +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new restore_testing_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.backup.restore_testing_plans ( + RecoveryPointSelection, + RestoreTestingPlanName, + ScheduleExpression, + region +) +SELECT +'{{ RecoveryPointSelection }}', + '{{ RestoreTestingPlanName }}', + '{{ ScheduleExpression }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.backup.restore_testing_plans ( + RecoveryPointSelection, + RestoreTestingPlanName, + ScheduleExpression, + ScheduleExpressionTimezone, + ScheduleStatus, + StartWindowHours, + Tags, + region +) +SELECT + '{{ RecoveryPointSelection }}', + '{{ RestoreTestingPlanName }}', + '{{ ScheduleExpression }}', + '{{ ScheduleExpressionTimezone }}', + '{{ ScheduleStatus }}', + '{{ StartWindowHours }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: restore_testing_plan + props: + - name: RecoveryPointSelection + value: + Algorithm: '{{ Algorithm }}' + SelectionWindowDays: '{{ SelectionWindowDays }}' + RecoveryPointTypes: + - '{{ RecoveryPointTypes[0] }}' + IncludeVaults: + - '{{ IncludeVaults[0] }}' + ExcludeVaults: + - '{{ ExcludeVaults[0] }}' + - name: RestoreTestingPlanName + value: '{{ RestoreTestingPlanName }}' + - name: ScheduleExpression + value: '{{ ScheduleExpression }}' + - name: ScheduleExpressionTimezone + value: '{{ ScheduleExpressionTimezone }}' + - name: ScheduleStatus + value: '{{ ScheduleStatus }}' + - name: StartWindowHours + value: '{{ StartWindowHours }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.backup.restore_testing_plans +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the restore_testing_plans resource, the following permissions are required: + +### Create +```json +backup:CreateRestoreTestingPlan, +backup:UpdateRestoreTestingPlanScheduleStatus, +backup:TagResource, +backup:GetRestoreTestingPlan, +backup:ListTags +``` + +### Read +```json +backup:GetRestoreTestingPlan, +backup:ListTags +``` + +### Update +```json +backup:UpdateRestoreTestingPlan, +backup:UpdateRestoreTestingPlanScheduleStatus, +backup:TagResource, +backup:UntagResource, +backup:GetRestoreTestingPlan, +backup:ListTags +``` + +### Delete +```json +backup:DeleteRestoreTestingPlan, +backup:GetRestoreTestingPlan +``` + +### List +```json +backup:ListRestoreTestingPlans +``` diff --git a/website/docs/services/backup/restore_testing_plans_list_only/index.md b/website/docs/services/backup/restore_testing_plans_list_only/index.md new file mode 100644 index 0000000..8b3fa3a --- /dev/null +++ b/website/docs/services/backup/restore_testing_plans_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: restore_testing_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - restore_testing_plans_list_only + - backup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists restore_testing_plans in a region or regions, for all properties use restore_testing_plans + +## Overview + + + + + + + +
Namerestore_testing_plans_list_only
TypeResource
DescriptionDefinition of AWS::Backup::RestoreTestingPlan Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all restore_testing_plans in a region. +```sql +SELECT +region, +restore_testing_plan_name +FROM aws.backup.restore_testing_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the restore_testing_plans_list_only resource, see restore_testing_plans + diff --git a/website/docs/services/backup/restore_testing_selections/index.md b/website/docs/services/backup/restore_testing_selections/index.md new file mode 100644 index 0000000..da9dcca --- /dev/null +++ b/website/docs/services/backup/restore_testing_selections/index.md @@ -0,0 +1,261 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a restore_testing_selection resource or lists restore_testing_selections in a region + +## Overview + + + + + + + +
Namerestore_testing_selections
TypeResource
DescriptionResource Type definition for AWS::Backup::RestoreTestingSelection
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
array
object
string
object
string
string
integer
stringAWS region.
+ +For more information, see AWS::Backup::RestoreTestingSelection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all restore_testing_selections in a region. +```sql +SELECT +region, +iam_role_arn, +protected_resource_arns, +protected_resource_conditions, +protected_resource_type, +restore_metadata_overrides, +restore_testing_plan_name, +restore_testing_selection_name, +validation_window_hours +FROM aws.backup.restore_testing_selections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual restore_testing_selection. +```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_selections +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new restore_testing_selection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.backup.restore_testing_selections ( + IamRoleArn, + ProtectedResourceType, + RestoreTestingPlanName, + RestoreTestingSelectionName, + region +) +SELECT +'{{ IamRoleArn }}', + '{{ ProtectedResourceType }}', + '{{ RestoreTestingPlanName }}', + '{{ RestoreTestingSelectionName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.backup.restore_testing_selections ( + IamRoleArn, + ProtectedResourceArns, + ProtectedResourceConditions, + ProtectedResourceType, + RestoreMetadataOverrides, + RestoreTestingPlanName, + RestoreTestingSelectionName, + ValidationWindowHours, + region +) +SELECT + '{{ IamRoleArn }}', + '{{ ProtectedResourceArns }}', + '{{ ProtectedResourceConditions }}', + '{{ ProtectedResourceType }}', + '{{ RestoreMetadataOverrides }}', + '{{ RestoreTestingPlanName }}', + '{{ RestoreTestingSelectionName }}', + '{{ ValidationWindowHours }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: restore_testing_selection + props: + - name: IamRoleArn + value: '{{ IamRoleArn }}' + - name: ProtectedResourceArns + value: + - '{{ ProtectedResourceArns[0] }}' + - name: ProtectedResourceConditions + value: + StringEquals: + - Key: '{{ Key }}' + Value: '{{ Value }}' + StringNotEquals: + - null + - name: ProtectedResourceType + value: '{{ ProtectedResourceType }}' + - name: RestoreMetadataOverrides + value: {} + - name: RestoreTestingPlanName + value: '{{ RestoreTestingPlanName }}' + - name: RestoreTestingSelectionName + value: '{{ RestoreTestingSelectionName }}' + - name: ValidationWindowHours + value: '{{ ValidationWindowHours }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.backup.restore_testing_selections +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +backup:GetRestoreTestingSelection +``` + +### Update +```json +backup:UpdateRestoreTestingSelection, +backup:GetRestoreTestingSelection, +iam:PassRole +``` + +### Delete +```json +backup:DeleteRestoreTestingSelection, +backup:GetRestoreTestingSelection +``` + +### List +```json +backup:ListRestoreTestingSelections, +backup:ListRestoreTestingPlans +``` diff --git a/website/docs/services/backup/restore_testing_selections_list_only/index.md b/website/docs/services/backup/restore_testing_selections_list_only/index.md new file mode 100644 index 0000000..68071cc --- /dev/null +++ b/website/docs/services/backup/restore_testing_selections_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: restore_testing_selections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - restore_testing_selections_list_only + - backup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists restore_testing_selections in a region or regions, for all properties use restore_testing_selections + +## Overview + + + + + + + +
Namerestore_testing_selections_list_only
TypeResource
DescriptionResource Type definition for AWS::Backup::RestoreTestingSelection
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all restore_testing_selections in a region. +```sql +SELECT +region, +restore_testing_plan_name, +restore_testing_selection_name +FROM aws.backup.restore_testing_selections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the restore_testing_selections_list_only resource, see restore_testing_selections + diff --git a/website/docs/services/backupgateway/hypervisor_tags/index.md b/website/docs/services/backupgateway/hypervisor_tags/index.md new file mode 100644 index 0000000..483f19c --- /dev/null +++ b/website/docs/services/backupgateway/hypervisor_tags/index.md @@ -0,0 +1,89 @@ +--- +title: hypervisor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - hypervisor_tags + - backupgateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for hypervisors in a region + +## Overview + + + + + + + +
Namehypervisor_tags
TypeResource
DescriptionDefinition of AWS::BackupGateway::Hypervisor Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all hypervisors in a region. +```sql +SELECT +region, +host, +hypervisor_arn, +kms_key_arn, +log_group_arn, +name, +password, +username, +tag_key, +tag_value +FROM aws.backupgateway.hypervisor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hypervisor_tags resource, see hypervisors + diff --git a/website/docs/services/backupgateway/hypervisors/index.md b/website/docs/services/backupgateway/hypervisors/index.md new file mode 100644 index 0000000..ee9683c --- /dev/null +++ b/website/docs/services/backupgateway/hypervisors/index.md @@ -0,0 +1,266 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a hypervisor resource or lists hypervisors in a region + +## Overview + + + + + + + +
Namehypervisors
TypeResource
DescriptionDefinition of AWS::BackupGateway::Hypervisor Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
string
stringAWS region.
+ +For more information, see AWS::BackupGateway::Hypervisor. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all hypervisors in a region. +```sql +SELECT +region, +host, +hypervisor_arn, +kms_key_arn, +log_group_arn, +name, +password, +tags, +username +FROM aws.backupgateway.hypervisors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual hypervisor. +```sql +SELECT +region, +host, +hypervisor_arn, +kms_key_arn, +log_group_arn, +name, +password, +tags, +username +FROM aws.backupgateway.hypervisors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new hypervisor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.backupgateway.hypervisors ( + Host, + KmsKeyArn, + LogGroupArn, + Name, + Password, + Tags, + Username, + region +) +SELECT +'{{ Host }}', + '{{ KmsKeyArn }}', + '{{ LogGroupArn }}', + '{{ Name }}', + '{{ Password }}', + '{{ Tags }}', + '{{ Username }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.backupgateway.hypervisors ( + Host, + KmsKeyArn, + LogGroupArn, + Name, + Password, + Tags, + Username, + region +) +SELECT + '{{ Host }}', + '{{ KmsKeyArn }}', + '{{ LogGroupArn }}', + '{{ Name }}', + '{{ Password }}', + '{{ Tags }}', + '{{ Username }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: hypervisor + props: + - name: Host + value: '{{ Host }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: LogGroupArn + value: '{{ LogGroupArn }}' + - name: Name + value: '{{ Name }}' + - name: Password + value: '{{ Password }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Username + value: '{{ Username }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.backupgateway.hypervisors +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +backup-gateway:ListHypervisors +``` diff --git a/website/docs/services/backupgateway/hypervisors_list_only/index.md b/website/docs/services/backupgateway/hypervisors_list_only/index.md new file mode 100644 index 0000000..e7be94b --- /dev/null +++ b/website/docs/services/backupgateway/hypervisors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: hypervisors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hypervisors_list_only + - backupgateway + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hypervisors in a region or regions, for all properties use hypervisors + +## Overview + + + + + + + +
Namehypervisors_list_only
TypeResource
DescriptionDefinition of AWS::BackupGateway::Hypervisor Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hypervisors in a region. +```sql +SELECT +region, +hypervisor_arn +FROM aws.backupgateway.hypervisors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hypervisors_list_only resource, see hypervisors + diff --git a/website/docs/services/backupgateway/index.md b/website/docs/services/backupgateway/index.md new file mode 100644 index 0000000..6d1d080 --- /dev/null +++ b/website/docs/services/backupgateway/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The backupgateway service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/batch/compute_environment_tags/index.md b/website/docs/services/batch/compute_environment_tags/index.md new file mode 100644 index 0000000..11edaad --- /dev/null +++ b/website/docs/services/batch/compute_environment_tags/index.md @@ -0,0 +1,97 @@ +--- +title: compute_environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - compute_environment_tags + - batch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for compute_environments in a region + +## Overview + + + + + + + +
Namecompute_environment_tags
TypeResource
DescriptionResource Type definition for AWS::Batch::ComputeEnvironment
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
boolean
string
string
string
object
integer
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all compute_environments in a region. +```sql +SELECT +region, +compute_environment_arn, +compute_environment_name, +compute_resources, +replace_compute_environment, +service_role, +state, +type, +update_policy, +unmanagedv_cpus, +eks_configuration, +context, +tag_key, +tag_value +FROM aws.batch.compute_environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the compute_environment_tags resource, see compute_environments + diff --git a/website/docs/services/batch/compute_environments/index.md b/website/docs/services/batch/compute_environments/index.md new file mode 100644 index 0000000..8a71e9f --- /dev/null +++ b/website/docs/services/batch/compute_environments/index.md @@ -0,0 +1,318 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a compute_environment resource or lists compute_environments in a region + +## Overview + + + + + + + +
Namecompute_environments
TypeResource
DescriptionResource Type definition for AWS::Batch::ComputeEnvironment
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
boolean
string
string
objectA key-value pair to associate with a resource.
string
object
integer
object
string
stringAWS region.
+ +For more information, see AWS::Batch::ComputeEnvironment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all compute_environments in a region. +```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, +context +FROM aws.batch.compute_environments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual compute_environment. +```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, +context +FROM aws.batch.compute_environments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new compute_environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.batch.compute_environments ( + Type, + region +) +SELECT +'{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.batch.compute_environments ( + ComputeEnvironmentName, + ComputeResources, + ReplaceComputeEnvironment, + ServiceRole, + State, + Tags, + Type, + UpdatePolicy, + UnmanagedvCpus, + EksConfiguration, + Context, + region +) +SELECT + '{{ ComputeEnvironmentName }}', + '{{ ComputeResources }}', + '{{ ReplaceComputeEnvironment }}', + '{{ ServiceRole }}', + '{{ State }}', + '{{ Tags }}', + '{{ Type }}', + '{{ UpdatePolicy }}', + '{{ UnmanagedvCpus }}', + '{{ EksConfiguration }}', + '{{ Context }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: compute_environment + props: + - name: ComputeEnvironmentName + value: '{{ ComputeEnvironmentName }}' + - name: ComputeResources + value: + AllocationStrategy: '{{ AllocationStrategy }}' + BidPercentage: '{{ BidPercentage }}' + DesiredvCpus: '{{ DesiredvCpus }}' + Ec2Configuration: + - ImageIdOverride: '{{ ImageIdOverride }}' + ImageType: '{{ ImageType }}' + ImageKubernetesVersion: '{{ ImageKubernetesVersion }}' + Ec2KeyPair: '{{ Ec2KeyPair }}' + ImageId: '{{ ImageId }}' + InstanceRole: '{{ InstanceRole }}' + InstanceTypes: + - '{{ InstanceTypes[0] }}' + LaunchTemplate: + LaunchTemplateId: '{{ LaunchTemplateId }}' + LaunchTemplateName: '{{ LaunchTemplateName }}' + Version: '{{ Version }}' + Overrides: + - LaunchTemplateId: '{{ LaunchTemplateId }}' + LaunchTemplateName: '{{ LaunchTemplateName }}' + Version: '{{ Version }}' + TargetInstanceTypes: + - '{{ TargetInstanceTypes[0] }}' + MaxvCpus: '{{ MaxvCpus }}' + MinvCpus: '{{ MinvCpus }}' + PlacementGroup: '{{ PlacementGroup }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SpotIamFleetRole: '{{ SpotIamFleetRole }}' + Subnets: + - '{{ Subnets[0] }}' + Tags: {} + Type: '{{ Type }}' + UpdateToLatestImageVersion: '{{ UpdateToLatestImageVersion }}' + - name: ReplaceComputeEnvironment + value: '{{ ReplaceComputeEnvironment }}' + - name: ServiceRole + value: '{{ ServiceRole }}' + - name: State + value: '{{ State }}' + - name: Tags + value: {} + - name: Type + value: '{{ Type }}' + - name: UpdatePolicy + value: + TerminateJobsOnUpdate: '{{ TerminateJobsOnUpdate }}' + JobExecutionTimeoutMinutes: '{{ JobExecutionTimeoutMinutes }}' + - name: UnmanagedvCpus + value: '{{ UnmanagedvCpus }}' + - name: EksConfiguration + value: + EksClusterArn: '{{ EksClusterArn }}' + KubernetesNamespace: '{{ KubernetesNamespace }}' + - name: Context + value: '{{ Context }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.batch.compute_environments +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +Batch:DescribeComputeEnvironments +``` diff --git a/website/docs/services/batch/compute_environments_list_only/index.md b/website/docs/services/batch/compute_environments_list_only/index.md new file mode 100644 index 0000000..5a0536a --- /dev/null +++ b/website/docs/services/batch/compute_environments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: compute_environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - compute_environments_list_only + - batch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists compute_environments in a region or regions, for all properties use compute_environments + +## Overview + + + + + + + +
Namecompute_environments_list_only
TypeResource
DescriptionResource Type definition for AWS::Batch::ComputeEnvironment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all compute_environments in a region. +```sql +SELECT +region, +compute_environment_arn +FROM aws.batch.compute_environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the compute_environments_list_only resource, see compute_environments + diff --git a/website/docs/services/batch/index.md b/website/docs/services/batch/index.md new file mode 100644 index 0000000..e32674b --- /dev/null +++ b/website/docs/services/batch/index.md @@ -0,0 +1,47 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The batch service documentation. + +:::info Service Summary + +
+
+total resources: 12
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/batch/job_definition_tags/index.md b/website/docs/services/batch/job_definition_tags/index.md new file mode 100644 index 0000000..a047f9a --- /dev/null +++ b/website/docs/services/batch/job_definition_tags/index.md @@ -0,0 +1,99 @@ +--- +title: job_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - job_definition_tags + - batch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for job_definitions in a region + +## Overview + + + + + + + +
Namejob_definition_tags
TypeResource
DescriptionResource Type definition for AWS::Batch::JobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
object
string
boolean
array
object
string
object
integer
object
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all job_definitions in a region. +```sql +SELECT +region, +parameters, +timeout, +job_definition_name, +propagate_tags, +platform_capabilities, +eks_properties, +type, +node_properties, +scheduling_priority, +container_properties, +ecs_properties, +retry_strategy, +tag_key, +tag_value +FROM aws.batch.job_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_definition_tags resource, see job_definitions + diff --git a/website/docs/services/batch/job_definitions/index.md b/website/docs/services/batch/job_definitions/index.md new file mode 100644 index 0000000..16cfcd9 --- /dev/null +++ b/website/docs/services/batch/job_definitions/index.md @@ -0,0 +1,494 @@ +--- +title: job_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - job_definitions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a job_definition resource or lists job_definitions in a region + +## Overview + + + + + + + +
Namejob_definitions
TypeResource
DescriptionResource Type definition for AWS::Batch::JobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
object
string
boolean
array
object
string
object
integer
object
object
object
objectA key-value pair to associate with a resource.
stringAWS region.
+ +For more information, see AWS::Batch::JobDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all job_definitions in a region. +```sql +SELECT +region, +parameters, +timeout, +job_definition_name, +propagate_tags, +platform_capabilities, +eks_properties, +type, +node_properties, +scheduling_priority, +container_properties, +ecs_properties, +retry_strategy, +tags +FROM aws.batch.job_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual job_definition. +```sql +SELECT +region, +parameters, +timeout, +job_definition_name, +propagate_tags, +platform_capabilities, +eks_properties, +type, +node_properties, +scheduling_priority, +container_properties, +ecs_properties, +retry_strategy, +tags +FROM aws.batch.job_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new job_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.batch.job_definitions ( + Type, + region +) +SELECT +'{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.batch.job_definitions ( + Parameters, + Timeout, + JobDefinitionName, + PropagateTags, + PlatformCapabilities, + EksProperties, + Type, + NodeProperties, + SchedulingPriority, + ContainerProperties, + EcsProperties, + RetryStrategy, + Tags, + region +) +SELECT + '{{ Parameters }}', + '{{ Timeout }}', + '{{ JobDefinitionName }}', + '{{ PropagateTags }}', + '{{ PlatformCapabilities }}', + '{{ EksProperties }}', + '{{ Type }}', + '{{ NodeProperties }}', + '{{ SchedulingPriority }}', + '{{ ContainerProperties }}', + '{{ EcsProperties }}', + '{{ RetryStrategy }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: job_definition + props: + - name: Parameters + value: {} + - name: Timeout + value: + AttemptDurationSeconds: '{{ AttemptDurationSeconds }}' + - name: JobDefinitionName + value: '{{ JobDefinitionName }}' + - name: PropagateTags + value: '{{ PropagateTags }}' + - name: PlatformCapabilities + value: + - '{{ PlatformCapabilities[0] }}' + - name: EksProperties + value: + PodProperties: + InitContainers: + - Args: + - '{{ Args[0] }}' + VolumeMounts: + - MountPath: '{{ MountPath }}' + ReadOnly: '{{ ReadOnly }}' + Name: '{{ Name }}' + ImagePullPolicy: '{{ ImagePullPolicy }}' + Command: + - '{{ Command[0] }}' + SecurityContext: + RunAsUser: '{{ RunAsUser }}' + AllowPrivilegeEscalation: '{{ AllowPrivilegeEscalation }}' + RunAsNonRoot: '{{ RunAsNonRoot }}' + Privileged: '{{ Privileged }}' + ReadOnlyRootFilesystem: '{{ ReadOnlyRootFilesystem }}' + RunAsGroup: '{{ RunAsGroup }}' + Resources: + Limits: {} + Requests: {} + Image: '{{ Image }}' + Env: + - Value: '{{ Value }}' + Name: '{{ Name }}' + Name: '{{ Name }}' + Volumes: + - Secret: + SecretName: '{{ SecretName }}' + Optional: '{{ Optional }}' + EmptyDir: + Medium: '{{ Medium }}' + SizeLimit: '{{ SizeLimit }}' + HostPath: + Path: '{{ Path }}' + Name: '{{ Name }}' + DnsPolicy: '{{ DnsPolicy }}' + Containers: + - null + Metadata: + Labels: {} + ServiceAccountName: '{{ ServiceAccountName }}' + ImagePullSecrets: + - Name: '{{ Name }}' + HostNetwork: '{{ HostNetwork }}' + ShareProcessNamespace: '{{ ShareProcessNamespace }}' + - name: Type + value: '{{ Type }}' + - name: NodeProperties + value: + MainNode: '{{ MainNode }}' + NodeRangeProperties: + - Container: + RepositoryCredentials: + CredentialsParameter: '{{ CredentialsParameter }}' + User: '{{ User }}' + Secrets: + - ValueFrom: '{{ ValueFrom }}' + Name: '{{ Name }}' + Memory: '{{ Memory }}' + Privileged: '{{ Privileged }}' + LinuxParameters: + Swappiness: '{{ Swappiness }}' + Tmpfs: + - Size: '{{ Size }}' + ContainerPath: '{{ ContainerPath }}' + MountOptions: + - '{{ MountOptions[0] }}' + SharedMemorySize: '{{ SharedMemorySize }}' + Devices: + - HostPath: '{{ HostPath }}' + Permissions: + - '{{ Permissions[0] }}' + ContainerPath: '{{ ContainerPath }}' + InitProcessEnabled: '{{ InitProcessEnabled }}' + MaxSwap: '{{ MaxSwap }}' + JobRoleArn: '{{ JobRoleArn }}' + ReadonlyRootFilesystem: '{{ ReadonlyRootFilesystem }}' + Vcpus: '{{ Vcpus }}' + Image: '{{ Image }}' + ResourceRequirements: + - Type: '{{ Type }}' + Value: '{{ Value }}' + LogConfiguration: + SecretOptions: + - null + Options: {} + LogDriver: '{{ LogDriver }}' + MountPoints: + - ReadOnly: '{{ ReadOnly }}' + SourceVolume: '{{ SourceVolume }}' + ContainerPath: '{{ ContainerPath }}' + ExecutionRoleArn: '{{ ExecutionRoleArn }}' + RuntimePlatform: + OperatingSystemFamily: '{{ OperatingSystemFamily }}' + CpuArchitecture: '{{ CpuArchitecture }}' + Volumes: + - Host: + SourcePath: '{{ SourcePath }}' + EfsVolumeConfiguration: + TransitEncryption: '{{ TransitEncryption }}' + AuthorizationConfig: + Iam: '{{ Iam }}' + AccessPointId: '{{ AccessPointId }}' + FileSystemId: '{{ FileSystemId }}' + RootDirectory: '{{ RootDirectory }}' + TransitEncryptionPort: '{{ TransitEncryptionPort }}' + Name: '{{ Name }}' + Command: + - '{{ Command[0] }}' + Environment: + - Value: '{{ Value }}' + Name: '{{ Name }}' + Ulimits: + - SoftLimit: '{{ SoftLimit }}' + HardLimit: '{{ HardLimit }}' + Name: '{{ Name }}' + InstanceType: '{{ InstanceType }}' + EphemeralStorage: + SizeInGiB: '{{ SizeInGiB }}' + TargetNodes: '{{ TargetNodes }}' + EcsProperties: + TaskProperties: + - ExecutionRoleArn: '{{ ExecutionRoleArn }}' + TaskRoleArn: '{{ TaskRoleArn }}' + IpcMode: '{{ IpcMode }}' + Volumes: + - null + Containers: + - RepositoryCredentials: null + User: '{{ User }}' + Secrets: + - null + Privileged: '{{ Privileged }}' + LinuxParameters: null + ReadonlyRootFilesystem: '{{ ReadonlyRootFilesystem }}' + Image: '{{ Image }}' + LogConfiguration: null + Essential: '{{ Essential }}' + ResourceRequirements: + - null + Name: '{{ Name }}' + MountPoints: + - null + DependsOn: + - Condition: '{{ Condition }}' + ContainerName: '{{ ContainerName }}' + Command: + - '{{ Command[0] }}' + Environment: + - null + Ulimits: + - null + PidMode: '{{ PidMode }}' + InstanceTypes: + - '{{ InstanceTypes[0] }}' + EksProperties: null + NumNodes: '{{ NumNodes }}' + - name: SchedulingPriority + value: '{{ SchedulingPriority }}' + - name: ContainerProperties + value: + RepositoryCredentials: null + User: '{{ User }}' + Secrets: + - null + Memory: '{{ Memory }}' + Privileged: '{{ Privileged }}' + LinuxParameters: null + FargatePlatformConfiguration: + PlatformVersion: '{{ PlatformVersion }}' + JobRoleArn: '{{ JobRoleArn }}' + ReadonlyRootFilesystem: '{{ ReadonlyRootFilesystem }}' + Vcpus: '{{ Vcpus }}' + Image: '{{ Image }}' + ResourceRequirements: + - null + LogConfiguration: null + MountPoints: + - null + ExecutionRoleArn: '{{ ExecutionRoleArn }}' + RuntimePlatform: null + Volumes: + - null + Command: + - '{{ Command[0] }}' + Environment: + - null + Ulimits: + - null + NetworkConfiguration: + AssignPublicIp: '{{ AssignPublicIp }}' + EphemeralStorage: null + - name: EcsProperties + value: + TaskProperties: + - PlatformVersion: '{{ PlatformVersion }}' + ExecutionRoleArn: '{{ ExecutionRoleArn }}' + RuntimePlatform: null + TaskRoleArn: '{{ TaskRoleArn }}' + IpcMode: '{{ IpcMode }}' + Volumes: + - null + Containers: + - null + NetworkConfiguration: null + PidMode: '{{ PidMode }}' + EphemeralStorage: null + - name: RetryStrategy + value: + EvaluateOnExit: + - Action: '{{ Action }}' + OnExitCode: '{{ OnExitCode }}' + OnReason: '{{ OnReason }}' + OnStatusReason: '{{ OnStatusReason }}' + Attempts: '{{ Attempts }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.batch.job_definitions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the job_definitions resource, the following permissions are required: + +### Read +```json +Batch:DescribeJobDefinitions +``` + +### Create +```json +Batch:RegisterJobDefinition, +Batch:TagResource, +Batch:DescribeJobDefinitions, +Iam:PassRole +``` + +### Update +```json +Batch:DescribeJobDefinitions, +Batch:RegisterJobDefinition, +Batch:DeregisterJobDefinition, +Batch:TagResource, +Batch:UntagResource, +Iam:PassRole +``` + +### List +```json +Batch:DescribeJobDefinitions +``` + +### Delete +```json +Batch:DescribeJobDefinitions, +Batch:DeregisterJobDefinition, +Iam:PassRole +``` diff --git a/website/docs/services/batch/job_definitions_list_only/index.md b/website/docs/services/batch/job_definitions_list_only/index.md new file mode 100644 index 0000000..a3ec2fb --- /dev/null +++ b/website/docs/services/batch/job_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: job_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - job_definitions_list_only + - batch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists job_definitions in a region or regions, for all properties use job_definitions + +## Overview + + + + + + + +
Namejob_definitions_list_only
TypeResource
DescriptionResource Type definition for AWS::Batch::JobDefinition
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all job_definitions in a region. +```sql +SELECT +region, +job_definition_name +FROM aws.batch.job_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_definitions_list_only resource, see job_definitions + diff --git a/website/docs/services/batch/job_queue_tags/index.md b/website/docs/services/batch/job_queue_tags/index.md new file mode 100644 index 0000000..da5b342 --- /dev/null +++ b/website/docs/services/batch/job_queue_tags/index.md @@ -0,0 +1,89 @@ +--- +title: job_queue_tags +hide_title: false +hide_table_of_contents: false +keywords: + - job_queue_tags + - batch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for job_queues in a region + +## Overview + + + + + + + +
Namejob_queue_tags
TypeResource
DescriptionResource Type definition for AWS::Batch::JobQueue
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringARN of the Scheduling Policy.
array
array
integer
string
stringARN of the Scheduling Policy.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all job_queues in a region. +```sql +SELECT +region, +job_queue_name, +job_queue_arn, +compute_environment_order, +job_state_time_limit_actions, +priority, +state, +scheduling_policy_arn, +tag_key, +tag_value +FROM aws.batch.job_queue_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_queue_tags resource, see job_queues + diff --git a/website/docs/services/batch/job_queues/index.md b/website/docs/services/batch/job_queues/index.md new file mode 100644 index 0000000..ff57f96 --- /dev/null +++ b/website/docs/services/batch/job_queues/index.md @@ -0,0 +1,254 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a job_queue resource or lists job_queues in a region + +## Overview + + + + + + + +
Namejob_queues
TypeResource
DescriptionResource Type definition for AWS::Batch::JobQueue
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
stringARN of the Scheduling Policy.
array
array
integer
string
stringARN of the Scheduling Policy.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +For more information, see AWS::Batch::JobQueue. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all job_queues in a region. +```sql +SELECT +region, +job_queue_name, +job_queue_arn, +compute_environment_order, +job_state_time_limit_actions, +priority, +state, +scheduling_policy_arn, +tags +FROM aws.batch.job_queues +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual job_queue. +```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_queues +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new job_queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.batch.job_queues ( + ComputeEnvironmentOrder, + Priority, + region +) +SELECT +'{{ ComputeEnvironmentOrder }}', + '{{ Priority }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.batch.job_queues ( + JobQueueName, + ComputeEnvironmentOrder, + JobStateTimeLimitActions, + Priority, + State, + SchedulingPolicyArn, + Tags, + region +) +SELECT + '{{ JobQueueName }}', + '{{ ComputeEnvironmentOrder }}', + '{{ JobStateTimeLimitActions }}', + '{{ Priority }}', + '{{ State }}', + '{{ SchedulingPolicyArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: job_queue + props: + - name: JobQueueName + value: '{{ JobQueueName }}' + - name: ComputeEnvironmentOrder + value: + - ComputeEnvironment: '{{ ComputeEnvironment }}' + Order: '{{ Order }}' + - name: JobStateTimeLimitActions + value: + - Action: '{{ Action }}' + MaxTimeSeconds: '{{ MaxTimeSeconds }}' + Reason: '{{ Reason }}' + State: '{{ State }}' + - name: Priority + value: '{{ Priority }}' + - name: State + value: '{{ State }}' + - name: SchedulingPolicyArn + value: '{{ SchedulingPolicyArn }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.batch.job_queues +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +Batch:DescribeJobQueues +``` + +### Update +```json +Batch:DescribeJobQueues, +Batch:UpdateJobQueue, +Batch:TagResource, +Batch:UnTagResource +``` + +### Delete +```json +Batch:UpdateJobQueue, +Batch:DescribeJobQueues, +Batch:DeleteJobQueue +``` + +### List +```json +Batch:DescribeJobQueues +``` diff --git a/website/docs/services/batch/job_queues_list_only/index.md b/website/docs/services/batch/job_queues_list_only/index.md new file mode 100644 index 0000000..7c5f4c8 --- /dev/null +++ b/website/docs/services/batch/job_queues_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: job_queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - job_queues_list_only + - batch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists job_queues in a region or regions, for all properties use job_queues + +## Overview + + + + + + + +
Namejob_queues_list_only
TypeResource
DescriptionResource Type definition for AWS::Batch::JobQueue
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringARN of the Scheduling Policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all job_queues in a region. +```sql +SELECT +region, +job_queue_arn +FROM aws.batch.job_queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_queues_list_only resource, see job_queues + diff --git a/website/docs/services/batch/scheduling_policies/index.md b/website/docs/services/batch/scheduling_policies/index.md new file mode 100644 index 0000000..5881687 --- /dev/null +++ b/website/docs/services/batch/scheduling_policies/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a scheduling_policy resource or lists scheduling_policies in a region + +## Overview + + + + + + + +
Namescheduling_policies
TypeResource
DescriptionResource Type schema for AWS::Batch::SchedulingPolicy
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of Scheduling Policy.
stringARN of the Scheduling Policy.
objectFair Share Policy for the Job Queue.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +For more information, see AWS::Batch::SchedulingPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scheduling_policies in a region. +```sql +SELECT +region, +name, +arn, +fairshare_policy, +tags +FROM aws.batch.scheduling_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual scheduling_policy. +```sql +SELECT +region, +name, +arn, +fairshare_policy, +tags +FROM aws.batch.scheduling_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scheduling_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.batch.scheduling_policies ( + Name, + FairsharePolicy, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ FairsharePolicy }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.batch.scheduling_policies ( + Name, + FairsharePolicy, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ FairsharePolicy }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: scheduling_policy + props: + - name: Name + value: '{{ Name }}' + - name: FairsharePolicy + value: + ShareDecaySeconds: null + ComputeReservation: null + ShareDistribution: + - ShareIdentifier: '{{ ShareIdentifier }}' + WeightFactor: null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.batch.scheduling_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the scheduling_policies resource, the following permissions are required: + +### Create +```json +Batch:CreateSchedulingPolicy, +Batch:TagResource +``` + +### Read +```json +Batch:DescribeSchedulingPolicies +``` + +### Update +```json +Batch:UpdateSchedulingPolicy, +Batch:TagResource, +Batch:UnTagResource +``` + +### Delete +```json +Batch:DescribeSchedulingPolicies, +Batch:DeleteSchedulingPolicy +``` + +### List +```json +Batch:ListSchedulingPolicies, +Batch:DescribeSchedulingPolicies +``` diff --git a/website/docs/services/batch/scheduling_policies_list_only/index.md b/website/docs/services/batch/scheduling_policies_list_only/index.md new file mode 100644 index 0000000..8c5c636 --- /dev/null +++ b/website/docs/services/batch/scheduling_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: scheduling_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scheduling_policies_list_only + - batch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scheduling_policies in a region or regions, for all properties use scheduling_policies + +## Overview + + + + + + + +
Namescheduling_policies_list_only
TypeResource
DescriptionResource Type schema for AWS::Batch::SchedulingPolicy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringARN of the Scheduling Policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scheduling_policies in a region. +```sql +SELECT +region, +arn +FROM aws.batch.scheduling_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduling_policies_list_only resource, see scheduling_policies + diff --git a/website/docs/services/batch/scheduling_policy_tags/index.md b/website/docs/services/batch/scheduling_policy_tags/index.md new file mode 100644 index 0000000..e3d7ecc --- /dev/null +++ b/website/docs/services/batch/scheduling_policy_tags/index.md @@ -0,0 +1,81 @@ +--- +title: scheduling_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - scheduling_policy_tags + - batch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scheduling_policies in a region + +## Overview + + + + + + + +
Namescheduling_policy_tags
TypeResource
DescriptionResource Type schema for AWS::Batch::SchedulingPolicy
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of Scheduling Policy.
stringARN of the Scheduling Policy.
objectFair Share Policy for the Job Queue.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scheduling_policies in a region. +```sql +SELECT +region, +name, +arn, +fairshare_policy, +tag_key, +tag_value +FROM aws.batch.scheduling_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduling_policy_tags resource, see scheduling_policies + diff --git a/website/docs/services/bcmdataexports/export_tags/index.md b/website/docs/services/bcmdataexports/export_tags/index.md new file mode 100644 index 0000000..cb4212a --- /dev/null +++ b/website/docs/services/bcmdataexports/export_tags/index.md @@ -0,0 +1,79 @@ +--- +title: export_tags +hide_title: false +hide_table_of_contents: false +keywords: + - export_tags + - bcmdataexports + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for exports in a region + +## Overview + + + + + + + +
Nameexport_tags
TypeResource
DescriptionDefinition of AWS::BCMDataExports::Export Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectDefinition of AWS::BCMDataExports::Export Resource Type
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all exports in a region. +```sql +SELECT +region, +export, +export_arn, +tag_key, +tag_value +FROM aws.bcmdataexports.export_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the export_tags resource, see exports + diff --git a/website/docs/services/bcmdataexports/exports/index.md b/website/docs/services/bcmdataexports/exports/index.md new file mode 100644 index 0000000..f686148 --- /dev/null +++ b/website/docs/services/bcmdataexports/exports/index.md @@ -0,0 +1,218 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an export resource or lists exports in a region + +## Overview + + + + + + + +
Nameexports
TypeResource
DescriptionDefinition of AWS::BCMDataExports::Export Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectDefinition of AWS::BCMDataExports::Export Resource Type
string
array
stringAWS region.
+ +For more information, see AWS::BCMDataExports::Export. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all exports in a region. +```sql +SELECT +region, +export, +export_arn, +tags +FROM aws.bcmdataexports.exports +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual export. +```sql +SELECT +region, +export, +export_arn, +tags +FROM aws.bcmdataexports.exports +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new export resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bcmdataexports.exports ( + Export, + region +) +SELECT +'{{ Export }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bcmdataexports.exports ( + Export, + Tags, + region +) +SELECT + '{{ Export }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: export + props: + - name: Export + value: + Export: null + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bcmdataexports.exports +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +bcm-data-exports:ListExports +``` diff --git a/website/docs/services/bcmdataexports/exports_list_only/index.md b/website/docs/services/bcmdataexports/exports_list_only/index.md new file mode 100644 index 0000000..9edcb7c --- /dev/null +++ b/website/docs/services/bcmdataexports/exports_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: exports_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - exports_list_only + - bcmdataexports + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists exports in a region or regions, for all properties use exports + +## Overview + + + + + + + +
Nameexports_list_only
TypeResource
DescriptionDefinition of AWS::BCMDataExports::Export Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectDefinition of AWS::BCMDataExports::Export Resource Type
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all exports in a region. +```sql +SELECT +region, +export_arn +FROM aws.bcmdataexports.exports_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the exports_list_only resource, see exports + diff --git a/website/docs/services/bcmdataexports/index.md b/website/docs/services/bcmdataexports/index.md new file mode 100644 index 0000000..ade7eaf --- /dev/null +++ b/website/docs/services/bcmdataexports/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The bcmdataexports service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/bedrock/agent_alias_tags/index.md b/website/docs/services/bedrock/agent_alias_tags/index.md new file mode 100644 index 0000000..e76cea8 --- /dev/null +++ b/website/docs/services/bedrock/agent_alias_tags/index.md @@ -0,0 +1,95 @@ +--- +title: agent_alias_tags +hide_title: false +hide_table_of_contents: false +keywords: + - agent_alias_tags + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for agent_aliases in a region + +## Overview + + + + + + + +
Nameagent_alias_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::AgentAlias Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn representation of the Agent Alias.
arrayThe list of history events for an alias for an Agent.
stringId for an Agent Alias generated at the server side.
stringName for a resource.
stringThe statuses an Agent Alias can be in.
stringIdentifier for a resource.
stringTime Stamp.
stringDescription of the Resource.
arrayRouting configuration for an Agent alias.
stringTime Stamp.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all agent_aliases in a region. +```sql +SELECT +region, +agent_alias_arn, +agent_alias_history_events, +agent_alias_id, +agent_alias_name, +agent_alias_status, +agent_id, +created_at, +description, +routing_configuration, +updated_at, +tag_key, +tag_value +FROM aws.bedrock.agent_alias_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agent_alias_tags resource, see agent_aliases + diff --git a/website/docs/services/bedrock/agent_aliases/index.md b/website/docs/services/bedrock/agent_aliases/index.md new file mode 100644 index 0000000..07ed4cb --- /dev/null +++ b/website/docs/services/bedrock/agent_aliases/index.md @@ -0,0 +1,255 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an agent_alias resource or lists agent_aliases in a region + +## Overview + + + + + + + +
Nameagent_aliases
TypeResource
DescriptionDefinition of AWS::Bedrock::AgentAlias Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn representation of the Agent Alias.
arrayThe list of history events for an alias for an Agent.
stringId for an Agent Alias generated at the server side.
stringName for a resource.
stringThe statuses an Agent Alias can be in.
stringIdentifier for a resource.
stringTime Stamp.
stringDescription of the Resource.
arrayRouting configuration for an Agent alias.
objectA map of tag keys and values
stringTime Stamp.
stringAWS region.
+ +For more information, see AWS::Bedrock::AgentAlias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all agent_aliases in a region. +```sql +SELECT +region, +agent_alias_arn, +agent_alias_history_events, +agent_alias_id, +agent_alias_name, +agent_alias_status, +agent_id, +created_at, +description, +routing_configuration, +tags, +updated_at +FROM aws.bedrock.agent_aliases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual agent_alias. +```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_aliases +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new agent_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.agent_aliases ( + AgentAliasName, + AgentId, + region +) +SELECT +'{{ AgentAliasName }}', + '{{ AgentId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.agent_aliases ( + AgentAliasName, + AgentId, + Description, + RoutingConfiguration, + Tags, + region +) +SELECT + '{{ AgentAliasName }}', + '{{ AgentId }}', + '{{ Description }}', + '{{ RoutingConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: agent_alias + props: + - name: AgentAliasName + value: '{{ AgentAliasName }}' + - name: AgentId + value: '{{ AgentId }}' + - name: Description + value: '{{ Description }}' + - name: RoutingConfiguration + value: + - AgentVersion: '{{ AgentVersion }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.agent_aliases +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +bedrock:ListAgentAliases +``` diff --git a/website/docs/services/bedrock/agent_aliases_list_only/index.md b/website/docs/services/bedrock/agent_aliases_list_only/index.md new file mode 100644 index 0000000..37313df --- /dev/null +++ b/website/docs/services/bedrock/agent_aliases_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: agent_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - agent_aliases_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists agent_aliases in a region or regions, for all properties use agent_aliases + +## Overview + + + + + + + +
Nameagent_aliases_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::AgentAlias Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringId for an Agent Alias generated at the server side.
stringIdentifier for a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all agent_aliases in a region. +```sql +SELECT +region, +agent_id, +agent_alias_id +FROM aws.bedrock.agent_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agent_aliases_list_only resource, see agent_aliases + diff --git a/website/docs/services/bedrock/agent_tags/index.md b/website/docs/services/bedrock/agent_tags/index.md new file mode 100644 index 0000000..0f30d04 --- /dev/null +++ b/website/docs/services/bedrock/agent_tags/index.md @@ -0,0 +1,121 @@ +--- +title: agent_tags +hide_title: false +hide_table_of_contents: false +keywords: + - agent_tags + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for agents in a region + +## Overview + + + + + + + +
Nameagent_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::Agent Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayList of ActionGroups
stringArn representation of the Agent.
stringIdentifier for a resource.
stringName for a resource.
stringARN of a IAM role.
stringSchema Type for Action APIs.
stringDraft Agent Version.
booleanSpecifies whether to automatically prepare after creating or updating the agent.
stringTime Stamp.
stringA KMS key ARN
booleanSpecifies whether to allow deleting agent while it is in use.
stringDescription of the Resource.
arrayFailure Reasons for Error.
stringARN or name of a Bedrock model.
objectConfiguration for a guardrail
numberMax Session Time.
stringInstruction for the agent.
arrayList of Agent Knowledge Bases
stringTime Stamp.
objectConfiguration for prompt override.
arrayThe recommended actions users can take to resolve an error in failureReasons.
objectA map of tag keys and values
stringTime Stamp.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all agents in a region. +```sql +SELECT +region, +action_groups, +agent_arn, +agent_id, +agent_name, +agent_resource_role_arn, +agent_status, +agent_version, +auto_prepare, +created_at, +customer_encryption_key_arn, +skip_resource_in_use_check_on_delete, +description, +failure_reasons, +foundation_model, +guardrail_configuration, +idle_session_ttl_in_seconds, +instruction, +knowledge_bases, +prepared_at, +prompt_override_configuration, +recommended_actions, +test_alias_tags, +updated_at, +tag_key, +tag_value +FROM aws.bedrock.agent_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agent_tags resource, see agents + diff --git a/website/docs/services/bedrock/agents/index.md b/website/docs/services/bedrock/agents/index.md new file mode 100644 index 0000000..6efff0b --- /dev/null +++ b/website/docs/services/bedrock/agents/index.md @@ -0,0 +1,395 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an agent resource or lists agents in a region + +## Overview + + + + + + + +
Nameagents
TypeResource
DescriptionDefinition of AWS::Bedrock::Agent Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayList of ActionGroups
stringArn representation of the Agent.
stringIdentifier for a resource.
stringName for a resource.
stringARN of a IAM role.
stringSchema Type for Action APIs.
stringDraft Agent Version.
booleanSpecifies whether to automatically prepare after creating or updating the agent.
stringTime Stamp.
stringA KMS key ARN
booleanSpecifies whether to allow deleting agent while it is in use.
stringDescription of the Resource.
arrayFailure Reasons for Error.
stringARN or name of a Bedrock model.
objectConfiguration for a guardrail
numberMax Session Time.
stringInstruction for the agent.
arrayList of Agent Knowledge Bases
stringTime Stamp.
objectConfiguration for prompt override.
arrayThe recommended actions users can take to resolve an error in failureReasons.
objectA map of tag keys and values
objectA map of tag keys and values
stringTime Stamp.
stringAWS region.
+ +For more information, see AWS::Bedrock::Agent. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all agents in a region. +```sql +SELECT +region, +action_groups, +agent_arn, +agent_id, +agent_name, +agent_resource_role_arn, +agent_status, +agent_version, +auto_prepare, +created_at, +customer_encryption_key_arn, +skip_resource_in_use_check_on_delete, +description, +failure_reasons, +foundation_model, +guardrail_configuration, +idle_session_ttl_in_seconds, +instruction, +knowledge_bases, +prepared_at, +prompt_override_configuration, +recommended_actions, +tags, +test_alias_tags, +updated_at +FROM aws.bedrock.agents +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual agent. +```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, +guardrail_configuration, +idle_session_ttl_in_seconds, +instruction, +knowledge_bases, +prepared_at, +prompt_override_configuration, +recommended_actions, +tags, +test_alias_tags, +updated_at +FROM aws.bedrock.agents +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new agent resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.agents ( + AgentName, + region +) +SELECT +'{{ AgentName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.agents ( + ActionGroups, + AgentName, + AgentResourceRoleArn, + AutoPrepare, + CustomerEncryptionKeyArn, + SkipResourceInUseCheckOnDelete, + Description, + FoundationModel, + GuardrailConfiguration, + IdleSessionTTLInSeconds, + Instruction, + KnowledgeBases, + PromptOverrideConfiguration, + Tags, + TestAliasTags, + region +) +SELECT + '{{ ActionGroups }}', + '{{ AgentName }}', + '{{ AgentResourceRoleArn }}', + '{{ AutoPrepare }}', + '{{ CustomerEncryptionKeyArn }}', + '{{ SkipResourceInUseCheckOnDelete }}', + '{{ Description }}', + '{{ FoundationModel }}', + '{{ GuardrailConfiguration }}', + '{{ IdleSessionTTLInSeconds }}', + '{{ Instruction }}', + '{{ KnowledgeBases }}', + '{{ PromptOverrideConfiguration }}', + '{{ Tags }}', + '{{ TestAliasTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: agent + props: + - name: ActionGroups + value: + - ActionGroupName: '{{ ActionGroupName }}' + Description: '{{ Description }}' + ParentActionGroupSignature: '{{ ParentActionGroupSignature }}' + ActionGroupExecutor: null + ApiSchema: null + ActionGroupState: '{{ ActionGroupState }}' + FunctionSchema: + Functions: + - Name: '{{ Name }}' + Description: '{{ Description }}' + Parameters: {} + RequireConfirmation: '{{ RequireConfirmation }}' + SkipResourceInUseCheckOnDelete: '{{ SkipResourceInUseCheckOnDelete }}' + - name: AgentName + value: '{{ AgentName }}' + - name: AgentResourceRoleArn + value: '{{ AgentResourceRoleArn }}' + - name: AutoPrepare + value: '{{ AutoPrepare }}' + - name: CustomerEncryptionKeyArn + value: '{{ CustomerEncryptionKeyArn }}' + - name: SkipResourceInUseCheckOnDelete + value: '{{ SkipResourceInUseCheckOnDelete }}' + - name: Description + value: '{{ Description }}' + - name: FoundationModel + value: '{{ FoundationModel }}' + - name: GuardrailConfiguration + value: + GuardrailIdentifier: '{{ GuardrailIdentifier }}' + GuardrailVersion: '{{ GuardrailVersion }}' + - name: IdleSessionTTLInSeconds + value: null + - name: Instruction + value: '{{ Instruction }}' + - name: KnowledgeBases + value: + - KnowledgeBaseId: '{{ KnowledgeBaseId }}' + Description: '{{ Description }}' + KnowledgeBaseState: '{{ KnowledgeBaseState }}' + - name: PromptOverrideConfiguration + value: + PromptConfigurations: + - PromptType: '{{ PromptType }}' + PromptCreationMode: '{{ PromptCreationMode }}' + PromptState: '{{ PromptState }}' + BasePromptTemplate: '{{ BasePromptTemplate }}' + InferenceConfiguration: + Temperature: null + TopP: null + TopK: null + MaximumLength: null + StopSequences: + - '{{ StopSequences[0] }}' + ParserMode: null + OverrideLambda: '{{ OverrideLambda }}' + - name: Tags + value: {} + - name: TestAliasTags + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.agents +WHERE data__Identifier = '' +AND 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, +bedrock:CreateGuardrail, +bedrock:CreateGuardrailVersion, +bedrock:GetGuardrail, +iam:PassRole +``` + +### Read +```json +bedrock:GetAgent, +bedrock:GetAgentActionGroup, +bedrock:ListAgentActionGroups, +bedrock:GetAgentKnowledgeBase, +bedrock:ListAgentKnowledgeBases, +bedrock:ListTagsForResource, +bedrock:GetGuardrail, +kms:Decrypt +``` + +### 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, +bedrock:UpdateGuardrail, +bedrock:GetGuardrail, +kms:Decrypt, +iam:PassRole +``` + +### Delete +```json +bedrock:GetAgent, +bedrock:DeleteAgent, +bedrock:DeleteGuardrail, +bedrock:GetGuardrail +``` + +### List +```json +bedrock:ListAgents, +bedrock:ListGuardrails +``` diff --git a/website/docs/services/bedrock/agents_list_only/index.md b/website/docs/services/bedrock/agents_list_only/index.md new file mode 100644 index 0000000..79e6852 --- /dev/null +++ b/website/docs/services/bedrock/agents_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: agents_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - agents_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists agents in a region or regions, for all properties use agents + +## Overview + + + + + + + +
Nameagents_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::Agent Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringIdentifier for a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all agents in a region. +```sql +SELECT +region, +agent_id +FROM aws.bedrock.agents_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agents_list_only resource, see agents + diff --git a/website/docs/services/bedrock/application_inference_profile_tags/index.md b/website/docs/services/bedrock/application_inference_profile_tags/index.md new file mode 100644 index 0000000..74182ca --- /dev/null +++ b/website/docs/services/bedrock/application_inference_profile_tags/index.md @@ -0,0 +1,97 @@ +--- +title: application_inference_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_inference_profile_tags + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for application_inference_profiles in a region + +## Overview + + + + + + + +
Nameapplication_inference_profile_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::ApplicationInferenceProfile Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringTime Stamp
stringDescription of the inference profile
string
string
stringInference profile identifier. Supports both system-defined inference profile ids, and inference profile ARNs.
string
undefinedVarious ways to encode a list of models in a CreateInferenceProfile request
arrayList of model configuration
stringStatus of the Inference Profile
stringType of the Inference Profile
stringTime Stamp
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all application_inference_profiles in a region. +```sql +SELECT +region, +created_at, +description, +inference_profile_arn, +inference_profile_id, +inference_profile_identifier, +inference_profile_name, +model_source, +models, +status, +type, +updated_at, +tag_key, +tag_value +FROM aws.bedrock.application_inference_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_inference_profile_tags resource, see application_inference_profiles + diff --git a/website/docs/services/bedrock/application_inference_profiles/index.md b/website/docs/services/bedrock/application_inference_profiles/index.md new file mode 100644 index 0000000..891c522 --- /dev/null +++ b/website/docs/services/bedrock/application_inference_profiles/index.md @@ -0,0 +1,249 @@ +--- +title: application_inference_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - application_inference_profiles + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application_inference_profile resource or lists application_inference_profiles in a region + +## Overview + + + + + + + +
Nameapplication_inference_profiles
TypeResource
DescriptionDefinition of AWS::Bedrock::ApplicationInferenceProfile Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringTime Stamp
stringDescription of the inference profile
string
string
stringInference profile identifier. Supports both system-defined inference profile ids, and inference profile ARNs.
string
undefinedVarious ways to encode a list of models in a CreateInferenceProfile request
arrayList of model configuration
stringStatus of the Inference Profile
arrayList of Tags
stringType of the Inference Profile
stringTime Stamp
stringAWS region.
+ +For more information, see AWS::Bedrock::ApplicationInferenceProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all application_inference_profiles in a region. +```sql +SELECT +region, +created_at, +description, +inference_profile_arn, +inference_profile_id, +inference_profile_identifier, +inference_profile_name, +model_source, +models, +status, +tags, +type, +updated_at +FROM aws.bedrock.application_inference_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application_inference_profile. +```sql +SELECT +region, +created_at, +description, +inference_profile_arn, +inference_profile_id, +inference_profile_identifier, +inference_profile_name, +model_source, +models, +status, +tags, +type, +updated_at +FROM aws.bedrock.application_inference_profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application_inference_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.application_inference_profiles ( + InferenceProfileName, + region +) +SELECT +'{{ InferenceProfileName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.application_inference_profiles ( + Description, + InferenceProfileName, + ModelSource, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ InferenceProfileName }}', + '{{ ModelSource }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application_inference_profile + props: + - name: Description + value: '{{ Description }}' + - name: InferenceProfileName + value: '{{ InferenceProfileName }}' + - name: ModelSource + value: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.application_inference_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the application_inference_profiles resource, the following permissions are required: + +### Create +```json +bedrock:CreateInferenceProfile, +bedrock:GetInferenceProfile, +bedrock:TagResource, +bedrock:ListTagsForResource +``` + +### Read +```json +bedrock:GetInferenceProfile, +bedrock:ListTagsForResource +``` + +### Update +```json +bedrock:GetInferenceProfile, +bedrock:ListTagsForResource, +bedrock:TagResource, +bedrock:UntagResource +``` + +### Delete +```json +bedrock:DeleteInferenceProfile, +bedrock:GetInferenceProfile +``` + +### List +```json +bedrock:ListInferenceProfiles +``` diff --git a/website/docs/services/bedrock/application_inference_profiles_list_only/index.md b/website/docs/services/bedrock/application_inference_profiles_list_only/index.md new file mode 100644 index 0000000..b2943aa --- /dev/null +++ b/website/docs/services/bedrock/application_inference_profiles_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: application_inference_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - application_inference_profiles_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists application_inference_profiles in a region or regions, for all properties use application_inference_profiles + +## Overview + + + + + + + +
Nameapplication_inference_profiles_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::ApplicationInferenceProfile Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringInference profile identifier. Supports both system-defined inference profile ids, and inference profile ARNs.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all application_inference_profiles in a region. +```sql +SELECT +region, +inference_profile_identifier +FROM aws.bedrock.application_inference_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_inference_profiles_list_only resource, see application_inference_profiles + diff --git a/website/docs/services/bedrock/data_sources/index.md b/website/docs/services/bedrock/data_sources/index.md new file mode 100644 index 0000000..2b9ccb8 --- /dev/null +++ b/website/docs/services/bedrock/data_sources/index.md @@ -0,0 +1,341 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_source resource or lists data_sources in a region + +## Overview + + + + + + + +
Namedata_sources
TypeResource
DescriptionDefinition of AWS::Bedrock::DataSource Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectSpecifies a raw data source location to ingest.
stringIdentifier for a resource.
stringDescription of the Resource.
stringThe unique identifier of the knowledge base to which to add the data source.
stringThe status of a data source.
stringThe name of the data source.
objectContains details about the server-side encryption for the data source.
objectDetails about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
stringThe deletion policy for the data source.
stringThe time at which the data source was created.
stringThe time at which the knowledge base was last updated.
arrayThe details of the failure reasons related to the data source.
stringAWS region.
+ +For more information, see AWS::Bedrock::DataSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_sources in a region. +```sql +SELECT +region, +data_source_configuration, +data_source_id, +description, +knowledge_base_id, +data_source_status, +name, +server_side_encryption_configuration, +vector_ingestion_configuration, +data_deletion_policy, +created_at, +updated_at, +failure_reasons +FROM aws.bedrock.data_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_source. +```sql +SELECT +region, +data_source_configuration, +data_source_id, +description, +knowledge_base_id, +data_source_status, +name, +server_side_encryption_configuration, +vector_ingestion_configuration, +data_deletion_policy, +created_at, +updated_at, +failure_reasons +FROM aws.bedrock.data_sources +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.data_sources ( + DataSourceConfiguration, + KnowledgeBaseId, + Name, + region +) +SELECT +'{{ DataSourceConfiguration }}', + '{{ KnowledgeBaseId }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.data_sources ( + DataSourceConfiguration, + Description, + KnowledgeBaseId, + Name, + ServerSideEncryptionConfiguration, + VectorIngestionConfiguration, + DataDeletionPolicy, + region +) +SELECT + '{{ DataSourceConfiguration }}', + '{{ Description }}', + '{{ KnowledgeBaseId }}', + '{{ Name }}', + '{{ ServerSideEncryptionConfiguration }}', + '{{ VectorIngestionConfiguration }}', + '{{ DataDeletionPolicy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_source + props: + - name: DataSourceConfiguration + value: + Type: '{{ Type }}' + S3Configuration: + BucketArn: '{{ BucketArn }}' + InclusionPrefixes: + - '{{ InclusionPrefixes[0] }}' + BucketOwnerAccountId: '{{ BucketOwnerAccountId }}' + ConfluenceConfiguration: + SourceConfiguration: + HostUrl: '{{ HostUrl }}' + HostType: '{{ HostType }}' + AuthType: '{{ AuthType }}' + CredentialsSecretArn: '{{ CredentialsSecretArn }}' + CrawlerConfiguration: + FilterConfiguration: + Type: '{{ Type }}' + PatternObjectFilter: + Filters: + - ObjectType: '{{ ObjectType }}' + InclusionFilters: + - '{{ InclusionFilters[0] }}' + ExclusionFilters: null + SalesforceConfiguration: + SourceConfiguration: + HostUrl: '{{ HostUrl }}' + AuthType: '{{ AuthType }}' + CredentialsSecretArn: '{{ CredentialsSecretArn }}' + CrawlerConfiguration: + FilterConfiguration: null + SharePointConfiguration: + SourceConfiguration: + SiteUrls: + - '{{ SiteUrls[0] }}' + HostType: '{{ HostType }}' + AuthType: '{{ AuthType }}' + CredentialsSecretArn: '{{ CredentialsSecretArn }}' + TenantId: '{{ TenantId }}' + Domain: '{{ Domain }}' + CrawlerConfiguration: + FilterConfiguration: null + WebConfiguration: + SourceConfiguration: + UrlConfiguration: + SeedUrls: + - Url: '{{ Url }}' + CrawlerConfiguration: + CrawlerLimits: + RateLimit: '{{ RateLimit }}' + InclusionFilters: null + ExclusionFilters: null + Scope: '{{ Scope }}' + - name: Description + value: '{{ Description }}' + - name: KnowledgeBaseId + value: '{{ KnowledgeBaseId }}' + - name: Name + value: '{{ Name }}' + - name: ServerSideEncryptionConfiguration + value: + KmsKeyArn: '{{ KmsKeyArn }}' + - name: VectorIngestionConfiguration + value: + ChunkingConfiguration: + ChunkingStrategy: '{{ ChunkingStrategy }}' + FixedSizeChunkingConfiguration: + MaxTokens: '{{ MaxTokens }}' + OverlapPercentage: '{{ OverlapPercentage }}' + HierarchicalChunkingConfiguration: + LevelConfigurations: + - MaxTokens: '{{ MaxTokens }}' + OverlapTokens: '{{ OverlapTokens }}' + SemanticChunkingConfiguration: + BreakpointPercentileThreshold: '{{ BreakpointPercentileThreshold }}' + BufferSize: '{{ BufferSize }}' + MaxTokens: '{{ MaxTokens }}' + CustomTransformationConfiguration: + IntermediateStorage: + S3Location: + URI: '{{ URI }}' + Transformations: + - StepToApply: '{{ StepToApply }}' + TransformationFunction: + TransformationLambdaConfiguration: + LambdaArn: '{{ LambdaArn }}' + ParsingConfiguration: + ParsingStrategy: '{{ ParsingStrategy }}' + BedrockFoundationModelConfiguration: + ModelArn: '{{ ModelArn }}' + ParsingPrompt: + ParsingPromptText: '{{ ParsingPromptText }}' + ParsingModality: '{{ ParsingModality }}' + BedrockDataAutomationConfiguration: + ParsingModality: null + - name: DataDeletionPolicy + value: '{{ DataDeletionPolicy }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.data_sources +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +bedrock:GetDataSource +``` + +### Update +```json +bedrock:GetDataSource, +bedrock:UpdateDataSource +``` + +### Delete +```json +bedrock:GetDataSource, +bedrock:DeleteDataSource +``` + +### List +```json +bedrock:ListDataSources +``` diff --git a/website/docs/services/bedrock/data_sources_list_only/index.md b/website/docs/services/bedrock/data_sources_list_only/index.md new file mode 100644 index 0000000..5652c16 --- /dev/null +++ b/website/docs/services/bedrock/data_sources_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::DataSource Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringIdentifier for a resource.
stringThe unique identifier of the knowledge base to which to add the data source.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +knowledge_base_id, +data_source_id +FROM aws.bedrock.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + diff --git a/website/docs/services/bedrock/flow_alias_tags/index.md b/website/docs/services/bedrock/flow_alias_tags/index.md new file mode 100644 index 0000000..1e92dd6 --- /dev/null +++ b/website/docs/services/bedrock/flow_alias_tags/index.md @@ -0,0 +1,93 @@ +--- +title: flow_alias_tags +hide_title: false +hide_table_of_contents: false +keywords: + - flow_alias_tags + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for flow_aliases in a region + +## Overview + + + + + + + +
Nameflow_alias_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::FlowAlias Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn of the Flow Alias
stringArn representation of the Flow
stringTime Stamp.
stringDescription of the Resource.
stringIdentifier for a flow resource.
stringId for a Flow Alias generated at the server side.
stringName for a resource.
arrayRouting configuration for a Flow alias.
stringTime Stamp.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all flow_aliases in a region. +```sql +SELECT +region, +arn, +flow_arn, +created_at, +description, +flow_id, +id, +name, +routing_configuration, +updated_at, +tag_key, +tag_value +FROM aws.bedrock.flow_alias_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_alias_tags resource, see flow_aliases + diff --git a/website/docs/services/bedrock/flow_aliases/index.md b/website/docs/services/bedrock/flow_aliases/index.md new file mode 100644 index 0000000..6d072f1 --- /dev/null +++ b/website/docs/services/bedrock/flow_aliases/index.md @@ -0,0 +1,250 @@ +--- +title: flow_aliases +hide_title: false +hide_table_of_contents: false +keywords: + - flow_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flow_alias resource or lists flow_aliases in a region + +## Overview + + + + + + + +
Nameflow_aliases
TypeResource
DescriptionDefinition of AWS::Bedrock::FlowAlias Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn of the Flow Alias
stringArn representation of the Flow
stringTime Stamp.
stringDescription of the Resource.
stringIdentifier for a flow resource.
stringId for a Flow Alias generated at the server side.
stringName for a resource.
arrayRouting configuration for a Flow alias.
stringTime Stamp.
objectA map of tag keys and values
stringAWS region.
+ +For more information, see AWS::Bedrock::FlowAlias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flow_aliases in a region. +```sql +SELECT +region, +arn, +flow_arn, +created_at, +description, +flow_id, +id, +name, +routing_configuration, +updated_at, +tags +FROM aws.bedrock.flow_aliases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flow_alias. +```sql +SELECT +region, +arn, +flow_arn, +created_at, +description, +flow_id, +id, +name, +routing_configuration, +updated_at, +tags +FROM aws.bedrock.flow_aliases +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flow_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.flow_aliases ( + FlowArn, + Name, + RoutingConfiguration, + region +) +SELECT +'{{ FlowArn }}', + '{{ Name }}', + '{{ RoutingConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.flow_aliases ( + FlowArn, + Description, + Name, + RoutingConfiguration, + Tags, + region +) +SELECT + '{{ FlowArn }}', + '{{ Description }}', + '{{ Name }}', + '{{ RoutingConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flow_alias + props: + - name: FlowArn + value: '{{ FlowArn }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: RoutingConfiguration + value: + - FlowVersion: '{{ FlowVersion }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.flow_aliases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the flow_aliases resource, the following permissions are required: + +### Create +```json +bedrock:CreateFlowAlias, +bedrock:GetFlowAlias, +bedrock:TagResource, +bedrock:ListTagsForResource +``` + +### Read +```json +bedrock:GetFlowAlias, +bedrock:ListTagsForResource +``` + +### Update +```json +bedrock:UpdateFlowAlias, +bedrock:GetFlowAlias, +bedrock:TagResource, +bedrock:UntagResource, +bedrock:ListTagsForResource +``` + +### Delete +```json +bedrock:DeleteFlowAlias +``` + +### List +```json +bedrock:ListFlowAliases +``` diff --git a/website/docs/services/bedrock/flow_aliases_list_only/index.md b/website/docs/services/bedrock/flow_aliases_list_only/index.md new file mode 100644 index 0000000..bc6f6d9 --- /dev/null +++ b/website/docs/services/bedrock/flow_aliases_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: flow_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_aliases_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_aliases in a region or regions, for all properties use flow_aliases + +## Overview + + + + + + + +
Nameflow_aliases_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::FlowAlias Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringArn of the Flow Alias
stringArn representation of the Flow
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_aliases in a region. +```sql +SELECT +region, +arn, +flow_arn +FROM aws.bedrock.flow_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_aliases_list_only resource, see flow_aliases + diff --git a/website/docs/services/bedrock/flow_tags/index.md b/website/docs/services/bedrock/flow_tags/index.md new file mode 100644 index 0000000..87399b4 --- /dev/null +++ b/website/docs/services/bedrock/flow_tags/index.md @@ -0,0 +1,107 @@ +--- +title: flow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - flow_tags + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for flows in a region + +## Overview + + + + + + + +
Nameflow_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::Flow Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn representation of the Flow
stringTime Stamp.
objectFlow definition
stringA JSON string containing a Definition with the same schema as the Definition property of this resource
objectAn Amazon S3 location.
objectWhen supplied with DefinitionString or DefinitionS3Location, substrings in the definition matching ${keyname} will be replaced with the associated value from this map
stringDescription of the flow
stringARN of a IAM role
stringIdentifier for a Flow
stringName for the flow
stringSchema Type for Flow APIs
stringTime Stamp.
stringA KMS key ARN
arrayList of flow validations
stringDraft Version.
objectA map of tag keys and values
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all flows in a region. +```sql +SELECT +region, +arn, +created_at, +definition, +definition_string, +definition_s3_location, +definition_substitutions, +description, +execution_role_arn, +id, +name, +status, +updated_at, +customer_encryption_key_arn, +validations, +version, +test_alias_tags, +tag_key, +tag_value +FROM aws.bedrock.flow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_tags resource, see flows + diff --git a/website/docs/services/bedrock/flow_versions/index.md b/website/docs/services/bedrock/flow_versions/index.md new file mode 100644 index 0000000..b652395 --- /dev/null +++ b/website/docs/services/bedrock/flow_versions/index.md @@ -0,0 +1,237 @@ +--- +title: flow_versions +hide_title: false +hide_table_of_contents: false +keywords: + - flow_versions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flow_version resource or lists flow_versions in a region + +## Overview + + + + + + + +
Nameflow_versions
TypeResource
DescriptionDefinition of AWS::Bedrock::FlowVersion Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn representation of the Flow
stringTime Stamp.
objectFlow definition
stringDescription of the flow version
stringARN of a IAM role
stringIdentifier for a Flow
stringName for the flow
stringSchema Type for Flow APIs
stringNumerical Version.
stringA KMS key ARN
stringAWS region.
+ +For more information, see AWS::Bedrock::FlowVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flow_versions in a region. +```sql +SELECT +region, +flow_arn, +created_at, +definition, +description, +execution_role_arn, +flow_id, +name, +status, +version, +customer_encryption_key_arn +FROM aws.bedrock.flow_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flow_version. +```sql +SELECT +region, +flow_arn, +created_at, +definition, +description, +execution_role_arn, +flow_id, +name, +status, +version, +customer_encryption_key_arn +FROM aws.bedrock.flow_versions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flow_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.flow_versions ( + FlowArn, + region +) +SELECT +'{{ FlowArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.flow_versions ( + FlowArn, + Description, + region +) +SELECT + '{{ FlowArn }}', + '{{ Description }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flow_version + props: + - name: FlowArn + value: '{{ FlowArn }}' + - name: Description + value: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.flow_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the flow_versions resource, the following permissions are required: + +### Create +```json +bedrock:CreateFlowVersion, +bedrock:GetFlowVersion, +kms:GenerateDataKey, +kms:Decrypt, +bedrock:CreateGuardrail, +bedrock:CreateGuardrailVersion, +bedrock:GetGuardrail +``` + +### Read +```json +bedrock:GetFlowVersion, +kms:Decrypt, +bedrock:GetGuardrail +``` + +### Delete +```json +bedrock:DeleteFlowVersion, +bedrock:GetFlowVersion, +bedrock:DeleteGuardrail, +bedrock:GetGuardrail +``` + +### List +```json +bedrock:ListFlowVersions, +bedrock:ListGuardrails +``` + +### Update +```json +noservice:NoAction +``` diff --git a/website/docs/services/bedrock/flow_versions_list_only/index.md b/website/docs/services/bedrock/flow_versions_list_only/index.md new file mode 100644 index 0000000..a475cb5 --- /dev/null +++ b/website/docs/services/bedrock/flow_versions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: flow_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_versions_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_versions in a region or regions, for all properties use flow_versions + +## Overview + + + + + + + +
Nameflow_versions_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::FlowVersion Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringArn representation of the Flow
stringNumerical Version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_versions in a region. +```sql +SELECT +region, +flow_arn, +version +FROM aws.bedrock.flow_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_versions_list_only resource, see flow_versions + diff --git a/website/docs/services/bedrock/flows/index.md b/website/docs/services/bedrock/flows/index.md new file mode 100644 index 0000000..34396ea --- /dev/null +++ b/website/docs/services/bedrock/flows/index.md @@ -0,0 +1,329 @@ +--- +title: flows +hide_title: false +hide_table_of_contents: false +keywords: + - flows + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flow resource or lists flows in a region + +## Overview + + + + + + + +
Nameflows
TypeResource
DescriptionDefinition of AWS::Bedrock::Flow Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn representation of the Flow
stringTime Stamp.
objectFlow definition
stringA JSON string containing a Definition with the same schema as the Definition property of this resource
objectAn Amazon S3 location.
objectWhen supplied with DefinitionString or DefinitionS3Location, substrings in the definition matching ${keyname} will be replaced with the associated value from this map
stringDescription of the flow
stringARN of a IAM role
stringIdentifier for a Flow
stringName for the flow
stringSchema Type for Flow APIs
stringTime Stamp.
stringA KMS key ARN
arrayList of flow validations
stringDraft Version.
objectA map of tag keys and values
objectA map of tag keys and values
stringAWS region.
+ +For more information, see AWS::Bedrock::Flow. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flows in a region. +```sql +SELECT +region, +arn, +created_at, +definition, +definition_string, +definition_s3_location, +definition_substitutions, +description, +execution_role_arn, +id, +name, +status, +updated_at, +customer_encryption_key_arn, +validations, +version, +tags, +test_alias_tags +FROM aws.bedrock.flows +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flow. +```sql +SELECT +region, +arn, +created_at, +definition, +definition_string, +definition_s3_location, +definition_substitutions, +description, +execution_role_arn, +id, +name, +status, +updated_at, +customer_encryption_key_arn, +validations, +version, +tags, +test_alias_tags +FROM aws.bedrock.flows +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.flows ( + ExecutionRoleArn, + Name, + region +) +SELECT +'{{ ExecutionRoleArn }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.flows ( + Definition, + DefinitionString, + DefinitionS3Location, + DefinitionSubstitutions, + Description, + ExecutionRoleArn, + Name, + CustomerEncryptionKeyArn, + Tags, + TestAliasTags, + region +) +SELECT + '{{ Definition }}', + '{{ DefinitionString }}', + '{{ DefinitionS3Location }}', + '{{ DefinitionSubstitutions }}', + '{{ Description }}', + '{{ ExecutionRoleArn }}', + '{{ Name }}', + '{{ CustomerEncryptionKeyArn }}', + '{{ Tags }}', + '{{ TestAliasTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flow + props: + - name: Definition + value: + Nodes: + - Name: '{{ Name }}' + Type: '{{ Type }}' + Configuration: null + Inputs: + - Name: '{{ Name }}' + Type: '{{ Type }}' + Expression: '{{ Expression }}' + Outputs: + - Name: '{{ Name }}' + Type: null + Connections: + - Type: '{{ Type }}' + Name: '{{ Name }}' + Source: '{{ Source }}' + Target: '{{ Target }}' + Configuration: null + - name: DefinitionString + value: '{{ DefinitionString }}' + - name: DefinitionS3Location + value: + URI: '{{ URI }}' + - name: DefinitionSubstitutions + value: {} + - name: Description + value: '{{ Description }}' + - name: ExecutionRoleArn + value: '{{ ExecutionRoleArn }}' + - name: Name + value: '{{ Name }}' + - name: CustomerEncryptionKeyArn + value: '{{ CustomerEncryptionKeyArn }}' + - name: Tags + value: {} + - name: TestAliasTags + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.flows +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the flows resource, the following permissions are required: + +### Create +```json +bedrock:CreateFlow, +bedrock:GetFlow, +bedrock:PrepareFlow, +iam:PassRole, +s3:GetObject, +s3:GetObjectVersion, +bedrock:TagResource, +bedrock:ListTagsForResource, +kms:GenerateDataKey, +kms:Decrypt, +bedrock:CreateGuardrail, +bedrock:CreateGuardrailVersion, +bedrock:GetGuardrail +``` + +### Read +```json +bedrock:GetFlow, +bedrock:ListTagsForResource, +kms:Decrypt, +bedrock:GetGuardrail +``` + +### Update +```json +bedrock:UpdateFlow, +bedrock:GetFlow, +bedrock:PrepareFlow, +iam:PassRole, +s3:GetObject, +s3:GetObjectVersion, +bedrock:TagResource, +bedrock:UntagResource, +bedrock:ListTagsForResource, +kms:GenerateDataKey, +kms:Decrypt, +bedrock:UpdateGuardrail, +bedrock:GetGuardrail +``` + +### Delete +```json +bedrock:DeleteFlow, +bedrock:GetFlow, +bedrock:DeleteGuardrail, +bedrock:GetGuardrail +``` + +### List +```json +bedrock:ListFlows, +bedrock:ListGuardrails +``` diff --git a/website/docs/services/bedrock/flows_list_only/index.md b/website/docs/services/bedrock/flows_list_only/index.md new file mode 100644 index 0000000..a9eb2af --- /dev/null +++ b/website/docs/services/bedrock/flows_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: flows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flows_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flows in a region or regions, for all properties use flows + +## Overview + + + + + + + +
Nameflows_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::Flow Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringArn representation of the Flow
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flows in a region. +```sql +SELECT +region, +arn +FROM aws.bedrock.flows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flows_list_only resource, see flows + diff --git a/website/docs/services/bedrock/guardrail_tags/index.md b/website/docs/services/bedrock/guardrail_tags/index.md new file mode 100644 index 0000000..a5e9f8d --- /dev/null +++ b/website/docs/services/bedrock/guardrail_tags/index.md @@ -0,0 +1,111 @@ +--- +title: guardrail_tags +hide_title: false +hide_table_of_contents: false +keywords: + - guardrail_tags + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for guardrails in a region + +## Overview + + + + + + + +
Nameguardrail_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::Guardrail Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringMessaging for when violations are detected in text
stringMessaging for when violations are detected in text
objectContent policy config for a guardrail.
objectContextual grounding policy config for a guardrail.
stringTime Stamp
stringDescription of the guardrail or its version
arrayList of failure recommendations
stringArn representation for the guardrail
stringUnique id for the guardrail
stringThe KMS key with which the guardrail was encrypted at rest
stringName of the guardrail
objectSensitive information policy config for a guardrail.
stringStatus of the guardrail
arrayList of status reasons
objectTopic policy config for a guardrail.
stringTime Stamp
stringGuardrail version
objectWord policy config for a guardrail.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all guardrails in a region. +```sql +SELECT +region, +blocked_input_messaging, +blocked_outputs_messaging, +content_policy_config, +contextual_grounding_policy_config, +created_at, +description, +failure_recommendations, +guardrail_arn, +guardrail_id, +kms_key_arn, +name, +sensitive_information_policy_config, +status, +status_reasons, +topic_policy_config, +updated_at, +version, +word_policy_config, +tag_key, +tag_value +FROM aws.bedrock.guardrail_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the guardrail_tags resource, see guardrails + diff --git a/website/docs/services/bedrock/guardrail_versions/index.md b/website/docs/services/bedrock/guardrail_versions/index.md new file mode 100644 index 0000000..a59c56f --- /dev/null +++ b/website/docs/services/bedrock/guardrail_versions/index.md @@ -0,0 +1,185 @@ +--- +title: guardrail_versions +hide_title: false +hide_table_of_contents: false +keywords: + - guardrail_versions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a guardrail_version resource or lists guardrail_versions in a region + +## Overview + + + + + + + +
Nameguardrail_versions
TypeResource
DescriptionDefinition of AWS::Bedrock::GuardrailVersion Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringDescription of the Guardrail version
stringArn representation for the guardrail
stringUnique id for the guardrail
stringIdentifier (GuardrailId or GuardrailArn) for the guardrail
stringGuardrail version
stringAWS region.
+ +For more information, see AWS::Bedrock::GuardrailVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual guardrail_version. +```sql +SELECT +region, +description, +guardrail_arn, +guardrail_id, +guardrail_identifier, +version +FROM aws.bedrock.guardrail_versions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new guardrail_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.guardrail_versions ( + GuardrailIdentifier, + region +) +SELECT +'{{ GuardrailIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.guardrail_versions ( + Description, + GuardrailIdentifier, + region +) +SELECT + '{{ Description }}', + '{{ GuardrailIdentifier }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: guardrail_version + props: + - name: Description + value: '{{ Description }}' + - name: GuardrailIdentifier + value: '{{ GuardrailIdentifier }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.guardrail_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the guardrail_versions resource, the following permissions are required: + +### Create +```json +bedrock:CreateGuardrailVersion, +bedrock:GetGuardrail, +kms:CreateGrant, +kms:Decrypt +``` + +### Read +```json +bedrock:GetGuardrail, +kms:Decrypt +``` + +### Delete +```json +bedrock:DeleteGuardrail, +bedrock:GetGuardrail, +kms:RetireGrant +``` diff --git a/website/docs/services/bedrock/guardrails/index.md b/website/docs/services/bedrock/guardrails/index.md new file mode 100644 index 0000000..cf4b56c --- /dev/null +++ b/website/docs/services/bedrock/guardrails/index.md @@ -0,0 +1,339 @@ +--- +title: guardrails +hide_title: false +hide_table_of_contents: false +keywords: + - guardrails + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a guardrail resource or lists guardrails in a region + +## Overview + + + + + + + +
Nameguardrails
TypeResource
DescriptionDefinition of AWS::Bedrock::Guardrail Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringMessaging for when violations are detected in text
stringMessaging for when violations are detected in text
objectContent policy config for a guardrail.
objectContextual grounding policy config for a guardrail.
stringTime Stamp
stringDescription of the guardrail or its version
arrayList of failure recommendations
stringArn representation for the guardrail
stringUnique id for the guardrail
stringThe KMS key with which the guardrail was encrypted at rest
stringName of the guardrail
objectSensitive information policy config for a guardrail.
stringStatus of the guardrail
arrayList of status reasons
arrayList of Tags
objectTopic policy config for a guardrail.
stringTime Stamp
stringGuardrail version
objectWord policy config for a guardrail.
stringAWS region.
+ +For more information, see AWS::Bedrock::Guardrail. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all guardrails in a region. +```sql +SELECT +region, +blocked_input_messaging, +blocked_outputs_messaging, +content_policy_config, +contextual_grounding_policy_config, +created_at, +description, +failure_recommendations, +guardrail_arn, +guardrail_id, +kms_key_arn, +name, +sensitive_information_policy_config, +status, +status_reasons, +tags, +topic_policy_config, +updated_at, +version, +word_policy_config +FROM aws.bedrock.guardrails +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual guardrail. +```sql +SELECT +region, +blocked_input_messaging, +blocked_outputs_messaging, +content_policy_config, +contextual_grounding_policy_config, +created_at, +description, +failure_recommendations, +guardrail_arn, +guardrail_id, +kms_key_arn, +name, +sensitive_information_policy_config, +status, +status_reasons, +tags, +topic_policy_config, +updated_at, +version, +word_policy_config +FROM aws.bedrock.guardrails +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new guardrail resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.guardrails ( + BlockedInputMessaging, + BlockedOutputsMessaging, + Name, + region +) +SELECT +'{{ BlockedInputMessaging }}', + '{{ BlockedOutputsMessaging }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.guardrails ( + BlockedInputMessaging, + BlockedOutputsMessaging, + ContentPolicyConfig, + ContextualGroundingPolicyConfig, + Description, + KmsKeyArn, + Name, + SensitiveInformationPolicyConfig, + Tags, + TopicPolicyConfig, + WordPolicyConfig, + region +) +SELECT + '{{ BlockedInputMessaging }}', + '{{ BlockedOutputsMessaging }}', + '{{ ContentPolicyConfig }}', + '{{ ContextualGroundingPolicyConfig }}', + '{{ Description }}', + '{{ KmsKeyArn }}', + '{{ Name }}', + '{{ SensitiveInformationPolicyConfig }}', + '{{ Tags }}', + '{{ TopicPolicyConfig }}', + '{{ WordPolicyConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: guardrail + props: + - name: BlockedInputMessaging + value: '{{ BlockedInputMessaging }}' + - name: BlockedOutputsMessaging + value: '{{ BlockedOutputsMessaging }}' + - name: ContentPolicyConfig + value: + FiltersConfig: + - Type: '{{ Type }}' + InputStrength: '{{ InputStrength }}' + OutputStrength: null + - name: ContextualGroundingPolicyConfig + value: + FiltersConfig: + - Type: '{{ Type }}' + Threshold: null + - name: Description + value: '{{ Description }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: Name + value: '{{ Name }}' + - name: SensitiveInformationPolicyConfig + value: + PiiEntitiesConfig: + - Type: '{{ Type }}' + Action: '{{ Action }}' + RegexesConfig: + - Name: '{{ Name }}' + Description: '{{ Description }}' + Pattern: '{{ Pattern }}' + Action: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TopicPolicyConfig + value: + TopicsConfig: + - Name: '{{ Name }}' + Definition: '{{ Definition }}' + Examples: + - '{{ Examples[0] }}' + Type: '{{ Type }}' + - name: WordPolicyConfig + value: + WordsConfig: + - Text: '{{ Text }}' + ManagedWordListsConfig: + - Type: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.guardrails +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the guardrails resource, the following permissions are required: + +### Create +```json +bedrock:CreateGuardrail, +bedrock:GetGuardrail, +kms:DescribeKey, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt, +bedrock:TagResource, +bedrock:ListTagsForResource +``` + +### Read +```json +bedrock:GetGuardrail, +kms:Decrypt, +bedrock:ListTagsForResource +``` + +### Update +```json +bedrock:UpdateGuardrail, +bedrock:GetGuardrail, +bedrock:ListTagsForResource, +bedrock:TagResource, +bedrock:UntagResource, +kms:DescribeKey, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +bedrock:DeleteGuardrail, +bedrock:GetGuardrail, +kms:Decrypt, +kms:RetireGrant +``` + +### List +```json +bedrock:ListGuardrails +``` diff --git a/website/docs/services/bedrock/guardrails_list_only/index.md b/website/docs/services/bedrock/guardrails_list_only/index.md new file mode 100644 index 0000000..c559c36 --- /dev/null +++ b/website/docs/services/bedrock/guardrails_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: guardrails_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - guardrails_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists guardrails in a region or regions, for all properties use guardrails + +## Overview + + + + + + + +
Nameguardrails_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::Guardrail Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringArn representation for the guardrail
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all guardrails in a region. +```sql +SELECT +region, +guardrail_arn +FROM aws.bedrock.guardrails_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the guardrails_list_only resource, see guardrails + diff --git a/website/docs/services/bedrock/index.md b/website/docs/services/bedrock/index.md new file mode 100644 index 0000000..ca3c573 --- /dev/null +++ b/website/docs/services/bedrock/index.md @@ -0,0 +1,67 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The bedrock service documentation. + +:::info Service Summary + +
+
+total resources: 32
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/bedrock/knowledge_base_tags/index.md b/website/docs/services/bedrock/knowledge_base_tags/index.md new file mode 100644 index 0000000..3c22a9d --- /dev/null +++ b/website/docs/services/bedrock/knowledge_base_tags/index.md @@ -0,0 +1,97 @@ +--- +title: knowledge_base_tags +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_base_tags + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for knowledge_bases in a region + +## Overview + + + + + + + +
Nameknowledge_base_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::KnowledgeBase Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringDescription of the Resource.
objectContains details about the embeddings model used for the knowledge base.
stringThe unique identifier of the knowledge base.
stringThe ARN of the knowledge base.
stringThe name of the knowledge base.
stringThe status of a knowledge base.
stringThe ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
stringThe time at which the knowledge base was created.
arrayA list of reasons that the API operation on the knowledge base failed.
stringThe time at which the knowledge base was last updated.
objectThe vector store service in which the knowledge base is stored.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all knowledge_bases in a region. +```sql +SELECT +region, +description, +knowledge_base_configuration, +knowledge_base_id, +knowledge_base_arn, +name, +status, +role_arn, +created_at, +failure_reasons, +updated_at, +storage_configuration, +tag_key, +tag_value +FROM aws.bedrock.knowledge_base_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the knowledge_base_tags resource, see knowledge_bases + diff --git a/website/docs/services/bedrock/knowledge_bases/index.md b/website/docs/services/bedrock/knowledge_bases/index.md new file mode 100644 index 0000000..4653359 --- /dev/null +++ b/website/docs/services/bedrock/knowledge_bases/index.md @@ -0,0 +1,314 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a knowledge_base resource or lists knowledge_bases in a region + +## Overview + + + + + + + +
Nameknowledge_bases
TypeResource
DescriptionDefinition of AWS::Bedrock::KnowledgeBase Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringDescription of the Resource.
objectContains details about the embeddings model used for the knowledge base.
stringThe unique identifier of the knowledge base.
stringThe ARN of the knowledge base.
stringThe name of the knowledge base.
stringThe status of a knowledge base.
stringThe ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
stringThe time at which the knowledge base was created.
arrayA list of reasons that the API operation on the knowledge base failed.
stringThe time at which the knowledge base was last updated.
objectThe vector store service in which the knowledge base is stored.
objectA map of tag keys and values
stringAWS region.
+ +For more information, see AWS::Bedrock::KnowledgeBase. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all knowledge_bases in a region. +```sql +SELECT +region, +description, +knowledge_base_configuration, +knowledge_base_id, +knowledge_base_arn, +name, +status, +role_arn, +created_at, +failure_reasons, +updated_at, +storage_configuration, +tags +FROM aws.bedrock.knowledge_bases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual knowledge_base. +```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_bases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new knowledge_base resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.knowledge_bases ( + KnowledgeBaseConfiguration, + Name, + RoleArn, + region +) +SELECT +'{{ KnowledgeBaseConfiguration }}', + '{{ Name }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.knowledge_bases ( + Description, + KnowledgeBaseConfiguration, + Name, + RoleArn, + StorageConfiguration, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ KnowledgeBaseConfiguration }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ StorageConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: knowledge_base + props: + - name: Description + value: '{{ Description }}' + - name: KnowledgeBaseConfiguration + value: + Type: '{{ Type }}' + VectorKnowledgeBaseConfiguration: + EmbeddingModelArn: '{{ EmbeddingModelArn }}' + EmbeddingModelConfiguration: + BedrockEmbeddingModelConfiguration: + Dimensions: '{{ Dimensions }}' + SupplementalDataStorageConfiguration: + SupplementalDataStorageLocations: + - SupplementalDataStorageLocationType: '{{ SupplementalDataStorageLocationType }}' + S3Location: + URI: '{{ URI }}' + KendraKnowledgeBaseConfiguration: + KendraIndexArn: '{{ KendraIndexArn }}' + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: StorageConfiguration + value: + Type: '{{ Type }}' + OpensearchServerlessConfiguration: + CollectionArn: '{{ CollectionArn }}' + VectorIndexName: '{{ VectorIndexName }}' + FieldMapping: + VectorField: '{{ VectorField }}' + TextField: '{{ TextField }}' + MetadataField: '{{ MetadataField }}' + PineconeConfiguration: + ConnectionString: '{{ ConnectionString }}' + CredentialsSecretArn: '{{ CredentialsSecretArn }}' + Namespace: '{{ Namespace }}' + FieldMapping: + TextField: '{{ TextField }}' + MetadataField: '{{ MetadataField }}' + RdsConfiguration: + ResourceArn: '{{ ResourceArn }}' + CredentialsSecretArn: '{{ CredentialsSecretArn }}' + DatabaseName: '{{ DatabaseName }}' + TableName: '{{ TableName }}' + FieldMapping: + PrimaryKeyField: '{{ PrimaryKeyField }}' + VectorField: '{{ VectorField }}' + TextField: '{{ TextField }}' + MetadataField: '{{ MetadataField }}' + MongoDbAtlasConfiguration: + Endpoint: '{{ Endpoint }}' + CredentialsSecretArn: '{{ CredentialsSecretArn }}' + DatabaseName: '{{ DatabaseName }}' + CollectionName: '{{ CollectionName }}' + VectorIndexName: '{{ VectorIndexName }}' + EndpointServiceName: '{{ EndpointServiceName }}' + FieldMapping: + VectorField: '{{ VectorField }}' + TextField: '{{ TextField }}' + MetadataField: '{{ MetadataField }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.knowledge_bases +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +bedrock:ListKnowledgeBases +``` diff --git a/website/docs/services/bedrock/knowledge_bases_list_only/index.md b/website/docs/services/bedrock/knowledge_bases_list_only/index.md new file mode 100644 index 0000000..8804d3e --- /dev/null +++ b/website/docs/services/bedrock/knowledge_bases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: knowledge_bases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_bases_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists knowledge_bases in a region or regions, for all properties use knowledge_bases + +## Overview + + + + + + + +
Nameknowledge_bases_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::KnowledgeBase Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier of the knowledge base.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all knowledge_bases in a region. +```sql +SELECT +region, +knowledge_base_id +FROM aws.bedrock.knowledge_bases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the knowledge_bases_list_only resource, see knowledge_bases + diff --git a/website/docs/services/bedrock/prompt_tags/index.md b/website/docs/services/bedrock/prompt_tags/index.md new file mode 100644 index 0000000..12d9cc7 --- /dev/null +++ b/website/docs/services/bedrock/prompt_tags/index.md @@ -0,0 +1,95 @@ +--- +title: prompt_tags +hide_title: false +hide_table_of_contents: false +keywords: + - prompt_tags + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for prompts in a region + +## Overview + + + + + + + +
Nameprompt_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::Prompt Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringARN of a prompt resource possibly with a version
stringTime Stamp.
stringName for a variant.
stringName for a prompt resource.
stringIdentifier for a Prompt
stringName for a prompt resource.
stringTime Stamp.
arrayList of prompt variants
stringA KMS key ARN
stringDraft Version.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all prompts in a region. +```sql +SELECT +region, +arn, +created_at, +default_variant, +description, +id, +name, +updated_at, +variants, +customer_encryption_key_arn, +version, +tag_key, +tag_value +FROM aws.bedrock.prompt_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prompt_tags resource, see prompts + diff --git a/website/docs/services/bedrock/prompt_version_tags/index.md b/website/docs/services/bedrock/prompt_version_tags/index.md new file mode 100644 index 0000000..8e03491 --- /dev/null +++ b/website/docs/services/bedrock/prompt_version_tags/index.md @@ -0,0 +1,97 @@ +--- +title: prompt_version_tags +hide_title: false +hide_table_of_contents: false +keywords: + - prompt_version_tags + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for prompt_versions in a region + +## Overview + + + + + + + +
Nameprompt_version_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::PromptVersion Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringARN of a prompt resource possibly with a version
stringARN of a prompt version resource
stringTime Stamp.
stringIdentifier for a Prompt
stringTime Stamp.
stringVersion.
arrayList of prompt variants
stringName for a variant.
stringDescription for a prompt version resource.
stringA KMS key ARN
stringName for a prompt resource.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all prompt_versions in a region. +```sql +SELECT +region, +prompt_arn, +arn, +created_at, +prompt_id, +updated_at, +version, +variants, +default_variant, +description, +customer_encryption_key_arn, +name, +tag_key, +tag_value +FROM aws.bedrock.prompt_version_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prompt_version_tags resource, see prompt_versions + diff --git a/website/docs/services/bedrock/prompt_versions/index.md b/website/docs/services/bedrock/prompt_versions/index.md new file mode 100644 index 0000000..039e20b --- /dev/null +++ b/website/docs/services/bedrock/prompt_versions/index.md @@ -0,0 +1,233 @@ +--- +title: prompt_versions +hide_title: false +hide_table_of_contents: false +keywords: + - prompt_versions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a prompt_version resource or lists prompt_versions in a region + +## Overview + + + + + + + +
Nameprompt_versions
TypeResource
DescriptionDefinition of AWS::Bedrock::PromptVersion Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringARN of a prompt resource possibly with a version
stringARN of a prompt version resource
stringTime Stamp.
stringIdentifier for a Prompt
stringTime Stamp.
stringVersion.
arrayList of prompt variants
stringName for a variant.
stringDescription for a prompt version resource.
stringA KMS key ARN
stringName for a prompt resource.
objectA map of tag keys and values
stringAWS region.
+ +For more information, see AWS::Bedrock::PromptVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all prompt_versions in a region. +```sql +SELECT +region, +prompt_arn, +arn, +created_at, +prompt_id, +updated_at, +version, +variants, +default_variant, +description, +customer_encryption_key_arn, +name, +tags +FROM aws.bedrock.prompt_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual prompt_version. +```sql +SELECT +region, +prompt_arn, +arn, +created_at, +prompt_id, +updated_at, +version, +variants, +default_variant, +description, +customer_encryption_key_arn, +name, +tags +FROM aws.bedrock.prompt_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new prompt_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.prompt_versions ( + PromptArn, + region +) +SELECT +'{{ PromptArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.prompt_versions ( + PromptArn, + Description, + Tags, + region +) +SELECT + '{{ PromptArn }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: prompt_version + props: + - name: PromptArn + value: '{{ PromptArn }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.prompt_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the prompt_versions resource, the following permissions are required: + +### Create +```json +bedrock:CreatePromptVersion, +bedrock:GetPrompt, +bedrock:TagResource, +bedrock:ListTagsForResource, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Read +```json +bedrock:GetPrompt, +bedrock:ListTagsForResource, +kms:Decrypt +``` + +### Delete +```json +bedrock:DeletePrompt, +bedrock:GetPrompt +``` + +### List +```json +bedrock:ListPrompts +``` diff --git a/website/docs/services/bedrock/prompt_versions_list_only/index.md b/website/docs/services/bedrock/prompt_versions_list_only/index.md new file mode 100644 index 0000000..87e54ef --- /dev/null +++ b/website/docs/services/bedrock/prompt_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: prompt_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - prompt_versions_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists prompt_versions in a region or regions, for all properties use prompt_versions + +## Overview + + + + + + + +
Nameprompt_versions_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::PromptVersion Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringARN of a prompt version resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all prompt_versions in a region. +```sql +SELECT +region, +arn +FROM aws.bedrock.prompt_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prompt_versions_list_only resource, see prompt_versions + diff --git a/website/docs/services/bedrock/prompts/index.md b/website/docs/services/bedrock/prompts/index.md new file mode 100644 index 0000000..22e8c84 --- /dev/null +++ b/website/docs/services/bedrock/prompts/index.md @@ -0,0 +1,267 @@ +--- +title: prompts +hide_title: false +hide_table_of_contents: false +keywords: + - prompts + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a prompt resource or lists prompts in a region + +## Overview + + + + + + + +
Nameprompts
TypeResource
DescriptionDefinition of AWS::Bedrock::Prompt Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringARN of a prompt resource possibly with a version
stringTime Stamp.
stringName for a variant.
stringName for a prompt resource.
stringIdentifier for a Prompt
stringName for a prompt resource.
stringTime Stamp.
arrayList of prompt variants
objectA map of tag keys and values
stringA KMS key ARN
stringDraft Version.
stringAWS region.
+ +For more information, see AWS::Bedrock::Prompt. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all prompts in a region. +```sql +SELECT +region, +arn, +created_at, +default_variant, +description, +id, +name, +updated_at, +variants, +tags, +customer_encryption_key_arn, +version +FROM aws.bedrock.prompts +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual prompt. +```sql +SELECT +region, +arn, +created_at, +default_variant, +description, +id, +name, +updated_at, +variants, +tags, +customer_encryption_key_arn, +version +FROM aws.bedrock.prompts +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new prompt resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.prompts ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.bedrock.prompts ( + DefaultVariant, + Description, + Name, + Variants, + Tags, + CustomerEncryptionKeyArn, + region +) +SELECT + '{{ DefaultVariant }}', + '{{ Description }}', + '{{ Name }}', + '{{ Variants }}', + '{{ Tags }}', + '{{ CustomerEncryptionKeyArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: prompt + props: + - name: DefaultVariant + value: '{{ DefaultVariant }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Variants + value: + - Name: '{{ Name }}' + TemplateType: '{{ TemplateType }}' + TemplateConfiguration: null + ModelId: '{{ ModelId }}' + InferenceConfiguration: null + - name: Tags + value: {} + - name: CustomerEncryptionKeyArn + value: '{{ CustomerEncryptionKeyArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.bedrock.prompts +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the prompts resource, the following permissions are required: + +### Create +```json +bedrock:CreatePrompt, +bedrock:GetPrompt, +s3:GetObject, +s3:GetObjectVersion, +bedrock:TagResource, +bedrock:ListTagsForResource, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Read +```json +bedrock:GetPrompt, +bedrock:ListTagsForResource, +kms:Decrypt +``` + +### Update +```json +bedrock:UpdatePrompt, +bedrock:GetPrompt, +s3:GetObject, +s3:GetObjectVersion, +bedrock:TagResource, +bedrock:UntagResource, +bedrock:ListTagsForResource, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +bedrock:DeletePrompt, +bedrock:GetPrompt +``` + +### List +```json +bedrock:ListPrompts +``` diff --git a/website/docs/services/bedrock/prompts_list_only/index.md b/website/docs/services/bedrock/prompts_list_only/index.md new file mode 100644 index 0000000..8578810 --- /dev/null +++ b/website/docs/services/bedrock/prompts_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: prompts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - prompts_list_only + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists prompts in a region or regions, for all properties use prompts + +## Overview + + + + + + + +
Nameprompts_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::Prompt Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringARN of a prompt resource possibly with a version
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all prompts in a region. +```sql +SELECT +region, +arn +FROM aws.bedrock.prompts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prompts_list_only resource, see prompts + diff --git a/website/docs/services/billingconductor/billing_group_tags/index.md b/website/docs/services/billingconductor/billing_group_tags/index.md new file mode 100644 index 0000000..934f4e8 --- /dev/null +++ b/website/docs/services/billingconductor/billing_group_tags/index.md @@ -0,0 +1,97 @@ +--- +title: billing_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - billing_group_tags + - billingconductor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for billing_groups in a region + +## Overview + + + + + + + +
Namebilling_group_tags
TypeResource
DescriptionA billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringBilling Group ARN
string
string
stringThis account will act as a virtual payer account of the billing group
object
object
integerNumber of accounts in the billing group
string
string
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all billing_groups in a region. +```sql +SELECT +region, +arn, +name, +description, +primary_account_id, +computation_preference, +account_grouping, +size, +status, +status_reason, +creation_time, +last_modified_time, +tag_key, +tag_value +FROM aws.billingconductor.billing_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the billing_group_tags resource, see billing_groups + diff --git a/website/docs/services/billingconductor/billing_groups/index.md b/website/docs/services/billingconductor/billing_groups/index.md new file mode 100644 index 0000000..b3868c5 --- /dev/null +++ b/website/docs/services/billingconductor/billing_groups/index.md @@ -0,0 +1,279 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a billing_group resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringBilling Group ARN
string
string
stringThis account will act as a virtual payer account of the billing group
object
object
integerNumber of accounts in the billing group
string
string
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
array
stringAWS region.
+ +For more information, see AWS::BillingConductor::BillingGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all billing_groups in a region. +```sql +SELECT +region, +arn, +name, +description, +primary_account_id, +computation_preference, +account_grouping, +size, +status, +status_reason, +creation_time, +last_modified_time, +tags +FROM aws.billingconductor.billing_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual billing_group. +```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_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new billing_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.billingconductor.billing_groups ( + Name, + PrimaryAccountId, + ComputationPreference, + AccountGrouping, + region +) +SELECT +'{{ Name }}', + '{{ PrimaryAccountId }}', + '{{ ComputationPreference }}', + '{{ AccountGrouping }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.billingconductor.billing_groups ( + Name, + Description, + PrimaryAccountId, + ComputationPreference, + AccountGrouping, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ PrimaryAccountId }}', + '{{ ComputationPreference }}', + '{{ AccountGrouping }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: billing_group + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: PrimaryAccountId + value: '{{ PrimaryAccountId }}' + - name: ComputationPreference + value: + PricingPlanArn: '{{ PricingPlanArn }}' + - name: AccountGrouping + value: + LinkedAccountIds: + - '{{ LinkedAccountIds[0] }}' + AutoAssociate: '{{ AutoAssociate }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.billingconductor.billing_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +billingconductor:ListBillingGroups, +billingconductor:ListAccountAssociations, +organizations:ListAccounts, +billingconductor:ListTagsForResource +``` + +### List +```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/website/docs/services/billingconductor/billing_groups_list_only/index.md b/website/docs/services/billingconductor/billing_groups_list_only/index.md new file mode 100644 index 0000000..d2deec7 --- /dev/null +++ b/website/docs/services/billingconductor/billing_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: billing_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - billing_groups_list_only + - billingconductor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists billing_groups in a region or regions, for all properties use billing_groups + +## Overview + + + + + + + +
Namebilling_groups_list_only
TypeResource
DescriptionA billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringBilling Group ARN
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all billing_groups in a region. +```sql +SELECT +region, +arn +FROM aws.billingconductor.billing_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the billing_groups_list_only resource, see billing_groups + diff --git a/website/docs/services/billingconductor/custom_line_item_tags/index.md b/website/docs/services/billingconductor/custom_line_item_tags/index.md new file mode 100644 index 0000000..764d415 --- /dev/null +++ b/website/docs/services/billingconductor/custom_line_item_tags/index.md @@ -0,0 +1,99 @@ +--- +title: custom_line_item_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_line_item_tags + - billingconductor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_line_items in a region + +## Overview + + + + + + + +
Namecustom_line_item_tags
TypeResource
DescriptionA custom line item is an one time charge that is applied to a specific billing group's bill.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringBilling Group ARN
object
stringARN
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
integerNumber of source values associated to this custom line item
string
string
stringThe account which this custom line item will be charged to
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_line_items in a region. +```sql +SELECT +region, +name, +description, +custom_line_item_charge_details, +billing_group_arn, +billing_period_range, +arn, +creation_time, +last_modified_time, +association_size, +product_code, +currency_code, +account_id, +tag_key, +tag_value +FROM aws.billingconductor.custom_line_item_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_line_item_tags resource, see custom_line_items + diff --git a/website/docs/services/billingconductor/custom_line_items/index.md b/website/docs/services/billingconductor/custom_line_items/index.md new file mode 100644 index 0000000..7a9bfd2 --- /dev/null +++ b/website/docs/services/billingconductor/custom_line_items/index.md @@ -0,0 +1,291 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a custom_line_item resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringBilling Group ARN
object
stringARN
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
integerNumber of source values associated to this custom line item
string
string
stringThe account which this custom line item will be charged to
array
stringAWS region.
+ +For more information, see AWS::BillingConductor::CustomLineItem. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all custom_line_items in a region. +```sql +SELECT +region, +name, +description, +custom_line_item_charge_details, +billing_group_arn, +billing_period_range, +arn, +creation_time, +last_modified_time, +association_size, +product_code, +currency_code, +account_id, +tags +FROM aws.billingconductor.custom_line_items +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual custom_line_item. +```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_items +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new custom_line_item resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.billingconductor.custom_line_items ( + Name, + BillingGroupArn, + region +) +SELECT +'{{ Name }}', + '{{ BillingGroupArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.billingconductor.custom_line_items ( + Name, + Description, + CustomLineItemChargeDetails, + BillingGroupArn, + BillingPeriodRange, + AccountId, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ CustomLineItemChargeDetails }}', + '{{ BillingGroupArn }}', + '{{ BillingPeriodRange }}', + '{{ AccountId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: custom_line_item + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: CustomLineItemChargeDetails + value: + Flat: + ChargeValue: null + Percentage: + ChildAssociatedResources: + - '{{ ChildAssociatedResources[0] }}' + PercentageValue: null + Type: '{{ Type }}' + LineItemFilters: + - Attribute: '{{ Attribute }}' + MatchOption: '{{ MatchOption }}' + Values: + - '{{ Values[0] }}' + - name: BillingGroupArn + value: '{{ BillingGroupArn }}' + - name: BillingPeriodRange + value: + InclusiveStartBillingPeriod: '{{ InclusiveStartBillingPeriod }}' + ExclusiveEndBillingPeriod: '{{ ExclusiveEndBillingPeriod }}' + - name: AccountId + value: '{{ AccountId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.billingconductor.custom_line_items +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +billingconductor:ListCustomLineItems, +billingconductor:ListCustomLineItemVersions, +billingconductor:ListResourcesAssociatedToCustomLineItem, +billingconductor:ListTagsForResource +``` + +### List +```json +billingconductor:ListCustomLineItems, +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/website/docs/services/billingconductor/custom_line_items_list_only/index.md b/website/docs/services/billingconductor/custom_line_items_list_only/index.md new file mode 100644 index 0000000..a5a3a99 --- /dev/null +++ b/website/docs/services/billingconductor/custom_line_items_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: custom_line_items_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_line_items_list_only + - billingconductor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_line_items in a region or regions, for all properties use custom_line_items + +## Overview + + + + + + + +
Namecustom_line_items_list_only
TypeResource
DescriptionA custom line item is an one time charge that is applied to a specific billing group's bill.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringARN
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_line_items in a region. +```sql +SELECT +region, +arn +FROM aws.billingconductor.custom_line_items_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_line_items_list_only resource, see custom_line_items + diff --git a/website/docs/services/billingconductor/index.md b/website/docs/services/billingconductor/index.md new file mode 100644 index 0000000..9a15509 --- /dev/null +++ b/website/docs/services/billingconductor/index.md @@ -0,0 +1,47 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The billingconductor service documentation. + +:::info Service Summary + +
+
+total resources: 12
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/billingconductor/pricing_plan_tags/index.md b/website/docs/services/billingconductor/pricing_plan_tags/index.md new file mode 100644 index 0000000..333f6d3 --- /dev/null +++ b/website/docs/services/billingconductor/pricing_plan_tags/index.md @@ -0,0 +1,89 @@ +--- +title: pricing_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_plan_tags + - billingconductor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pricing_plans in a region + +## Overview + + + + + + + +
Namepricing_plan_tags
TypeResource
DescriptionPricing Plan enables you to customize your billing details consistent with the usage that accrues in each of your billing groups.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringPricing Plan ARN
string
array
integerNumber of associated pricing rules
string
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pricing_plans in a region. +```sql +SELECT +region, +arn, +name, +pricing_rule_arns, +size, +description, +creation_time, +last_modified_time, +tag_key, +tag_value +FROM aws.billingconductor.pricing_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pricing_plan_tags resource, see pricing_plans + diff --git a/website/docs/services/billingconductor/pricing_plans/index.md b/website/docs/services/billingconductor/pricing_plans/index.md new file mode 100644 index 0000000..a49cfb1 --- /dev/null +++ b/website/docs/services/billingconductor/pricing_plans/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a pricing_plan resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringPricing Plan ARN
string
array
integerNumber of associated pricing rules
string
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
array
stringAWS region.
+ +For more information, see AWS::BillingConductor::PricingPlan. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all pricing_plans in a region. +```sql +SELECT +region, +arn, +name, +pricing_rule_arns, +size, +description, +creation_time, +last_modified_time, +tags +FROM aws.billingconductor.pricing_plans +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual pricing_plan. +```sql +SELECT +region, +arn, +name, +pricing_rule_arns, +size, +description, +creation_time, +last_modified_time, +tags +FROM aws.billingconductor.pricing_plans +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pricing_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.billingconductor.pricing_plans ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.billingconductor.pricing_plans ( + Name, + PricingRuleArns, + Description, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ PricingRuleArns }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: pricing_plan + props: + - name: Name + value: '{{ Name }}' + - name: PricingRuleArns + value: + - '{{ PricingRuleArns[0] }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.billingconductor.pricing_plans +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +billingconductor:ListPricingPlans, +billingconductor:ListPricingRulesAssociatedToPricingPlan, +billingconductor:ListTagsForResource +``` + +### List +```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/website/docs/services/billingconductor/pricing_plans_list_only/index.md b/website/docs/services/billingconductor/pricing_plans_list_only/index.md new file mode 100644 index 0000000..a314008 --- /dev/null +++ b/website/docs/services/billingconductor/pricing_plans_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pricing_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_plans_list_only + - billingconductor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pricing_plans in a region or regions, for all properties use pricing_plans + +## Overview + + + + + + + +
Namepricing_plans_list_only
TypeResource
DescriptionPricing Plan enables you to customize your billing details consistent with the usage that accrues in each of your billing groups.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringPricing Plan ARN
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pricing_plans in a region. +```sql +SELECT +region, +arn +FROM aws.billingconductor.pricing_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pricing_plans_list_only resource, see pricing_plans + diff --git a/website/docs/services/billingconductor/pricing_rule_tags/index.md b/website/docs/services/billingconductor/pricing_rule_tags/index.md new file mode 100644 index 0000000..6c801ed --- /dev/null +++ b/website/docs/services/billingconductor/pricing_rule_tags/index.md @@ -0,0 +1,103 @@ +--- +title: pricing_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_rule_tags + - billingconductor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pricing_rules in a region + +## Overview + + + + + + + +
Namepricing_rule_tags
TypeResource
DescriptionA markup/discount that is defined for a specific set of services that can later be associated with a pricing plan.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringPricing rule ARN
stringPricing rule name
stringPricing rule description
stringA term used to categorize the granularity of a Pricing Rule.
stringOne of MARKUP, DISCOUNT or TIERING that describes the behaviour of the pricing rule.
numberPricing rule modifier percentage
stringThe service which a pricing rule is applied on
stringThe seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplaces. Supported billing entities are AWS, AWS Marketplace, and AISPL.
objectThe set of tiering configurations for the pricing rule.
stringThe UsageType which a SKU pricing rule is modifying
stringThe Operation which a SKU pricing rule is modifying
integerThe number of pricing plans associated with pricing rule
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pricing_rules in a region. +```sql +SELECT +region, +arn, +name, +description, +scope, +type, +modifier_percentage, +service, +billing_entity, +tiering, +usage_type, +operation, +associated_pricing_plan_count, +creation_time, +last_modified_time, +tag_key, +tag_value +FROM aws.billingconductor.pricing_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pricing_rule_tags resource, see pricing_rules + diff --git a/website/docs/services/billingconductor/pricing_rules/index.md b/website/docs/services/billingconductor/pricing_rules/index.md new file mode 100644 index 0000000..da6b755 --- /dev/null +++ b/website/docs/services/billingconductor/pricing_rules/index.md @@ -0,0 +1,294 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a pricing_rule resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringPricing rule ARN
stringPricing rule name
stringPricing rule description
stringA term used to categorize the granularity of a Pricing Rule.
stringOne of MARKUP, DISCOUNT or TIERING that describes the behaviour of the pricing rule.
numberPricing rule modifier percentage
stringThe service which a pricing rule is applied on
stringThe seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplaces. Supported billing entities are AWS, AWS Marketplace, and AISPL.
objectThe set of tiering configurations for the pricing rule.
stringThe UsageType which a SKU pricing rule is modifying
stringThe Operation which a SKU pricing rule is modifying
integerThe number of pricing plans associated with pricing rule
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
array
stringAWS region.
+ +For more information, see AWS::BillingConductor::PricingRule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all pricing_rules in a region. +```sql +SELECT +region, +arn, +name, +description, +scope, +type, +modifier_percentage, +service, +billing_entity, +tiering, +usage_type, +operation, +associated_pricing_plan_count, +creation_time, +last_modified_time, +tags +FROM aws.billingconductor.pricing_rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual pricing_rule. +```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_rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pricing_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.billingconductor.pricing_rules ( + Name, + Scope, + Type, + region +) +SELECT +'{{ Name }}', + '{{ Scope }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.billingconductor.pricing_rules ( + Name, + Description, + Scope, + Type, + ModifierPercentage, + Service, + BillingEntity, + Tiering, + UsageType, + Operation, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Scope }}', + '{{ Type }}', + '{{ ModifierPercentage }}', + '{{ Service }}', + '{{ BillingEntity }}', + '{{ Tiering }}', + '{{ UsageType }}', + '{{ Operation }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: pricing_rule + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Scope + value: '{{ Scope }}' + - name: Type + value: '{{ Type }}' + - name: ModifierPercentage + value: null + - name: Service + value: '{{ Service }}' + - name: BillingEntity + value: '{{ BillingEntity }}' + - name: Tiering + value: + FreeTier: + Activated: '{{ Activated }}' + - name: UsageType + value: '{{ UsageType }}' + - name: Operation + value: '{{ Operation }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.billingconductor.pricing_rules +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +billingconductor:ListPricingRules, +billingconductor:ListTagsForResource +``` + +### Update +```json +billingconductor:UpdatePricingRule, +billingconductor:ListPricingRules, +billingconductor:TagResource, +billingconductor:UntagResource +``` + +### Delete +```json +billingconductor:DeletePricingRule, +billingconductor:ListPricingRules, +billingconductor:UntagResource +``` + +### List +```json +billingconductor:ListPricingRules, +billingconductor:ListTagsForResource +``` diff --git a/website/docs/services/billingconductor/pricing_rules_list_only/index.md b/website/docs/services/billingconductor/pricing_rules_list_only/index.md new file mode 100644 index 0000000..57e75b4 --- /dev/null +++ b/website/docs/services/billingconductor/pricing_rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pricing_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_rules_list_only + - billingconductor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pricing_rules in a region or regions, for all properties use pricing_rules + +## Overview + + + + + + + +
Namepricing_rules_list_only
TypeResource
DescriptionA markup/discount that is defined for a specific set of services that can later be associated with a pricing plan.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringPricing rule ARN
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pricing_rules in a region. +```sql +SELECT +region, +arn +FROM aws.billingconductor.pricing_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pricing_rules_list_only resource, see pricing_rules + diff --git a/website/docs/services/budgets/budgets_actions/index.md b/website/docs/services/budgets/budgets_actions/index.md new file mode 100644 index 0000000..d2a9af5 --- /dev/null +++ b/website/docs/services/budgets/budgets_actions/index.md @@ -0,0 +1,296 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a budgets_action resource or lists budgets_actions in a region + +## Overview + + + + + + + +
Namebudgets_actions
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
string
string
array
object
array
stringAWS region.
+ +For more information, see AWS::Budgets::BudgetsAction. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all budgets_actions in a region. +```sql +SELECT +region, +action_id, +budget_name, +notification_type, +action_type, +action_threshold, +execution_role_arn, +approval_model, +subscribers, +definition, +resource_tags +FROM aws.budgets.budgets_actions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual budgets_action. +```sql +SELECT +region, +action_id, +budget_name, +notification_type, +action_type, +action_threshold, +execution_role_arn, +approval_model, +subscribers, +definition, +resource_tags +FROM aws.budgets.budgets_actions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new budgets_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.budgets.budgets_actions ( + BudgetName, + NotificationType, + ActionType, + ActionThreshold, + ExecutionRoleArn, + Subscribers, + Definition, + region +) +SELECT +'{{ BudgetName }}', + '{{ NotificationType }}', + '{{ ActionType }}', + '{{ ActionThreshold }}', + '{{ ExecutionRoleArn }}', + '{{ Subscribers }}', + '{{ Definition }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.budgets.budgets_actions ( + BudgetName, + NotificationType, + ActionType, + ActionThreshold, + ExecutionRoleArn, + ApprovalModel, + Subscribers, + Definition, + ResourceTags, + region +) +SELECT + '{{ BudgetName }}', + '{{ NotificationType }}', + '{{ ActionType }}', + '{{ ActionThreshold }}', + '{{ ExecutionRoleArn }}', + '{{ ApprovalModel }}', + '{{ Subscribers }}', + '{{ Definition }}', + '{{ ResourceTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: budgets_action + props: + - name: BudgetName + value: '{{ BudgetName }}' + - name: NotificationType + value: '{{ NotificationType }}' + - name: ActionType + value: '{{ ActionType }}' + - name: ActionThreshold + value: + Value: null + Type: '{{ Type }}' + - name: ExecutionRoleArn + value: '{{ ExecutionRoleArn }}' + - name: ApprovalModel + value: '{{ ApprovalModel }}' + - name: Subscribers + value: + - Type: '{{ Type }}' + Address: '{{ Address }}' + - name: Definition + value: + IamActionDefinition: + PolicyArn: '{{ PolicyArn }}' + Roles: + - '{{ Roles[0] }}' + Groups: + - '{{ Groups[0] }}' + Users: + - '{{ Users[0] }}' + ScpActionDefinition: + PolicyId: '{{ PolicyId }}' + TargetIds: + - '{{ TargetIds[0] }}' + SsmActionDefinition: + Subtype: '{{ Subtype }}' + Region: '{{ Region }}' + InstanceIds: + - '{{ InstanceIds[0] }}' + - name: ResourceTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.budgets.budgets_actions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the budgets_actions resource, the following permissions are required: + +### Create +```json +budgets:CreateBudgetAction, +iam:PassRole, +budgets:TagResource +``` + +### Read +```json +budgets:DescribeBudgetAction, +budgets:ListTagsForResource +``` + +### Update +```json +budgets:UpdateBudgetAction, +iam:PassRole, +budgets:TagResource, +budgets:UntagResource, +budgets:ListTagsForResource +``` + +### Delete +```json +budgets:DeleteBudgetAction +``` + +### List +```json +budgets:DescribeBudgetActionsForAccount, +budgets:DescribeBudgetActionsForBudget +``` diff --git a/website/docs/services/budgets/budgets_actions_list_only/index.md b/website/docs/services/budgets/budgets_actions_list_only/index.md new file mode 100644 index 0000000..3ce8fab --- /dev/null +++ b/website/docs/services/budgets/budgets_actions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: budgets_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - budgets_actions_list_only + - budgets + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists budgets_actions in a region or regions, for all properties use budgets_actions + +## Overview + + + + + + + +
Namebudgets_actions_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all budgets_actions in a region. +```sql +SELECT +region, +action_id, +budget_name +FROM aws.budgets.budgets_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the budgets_actions_list_only resource, see budgets_actions + diff --git a/website/docs/services/budgets/index.md b/website/docs/services/budgets/index.md new file mode 100644 index 0000000..56fd988 --- /dev/null +++ b/website/docs/services/budgets/index.md @@ -0,0 +1,37 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The budgets service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cassandra/index.md b/website/docs/services/cassandra/index.md new file mode 100644 index 0000000..43174f9 --- /dev/null +++ b/website/docs/services/cassandra/index.md @@ -0,0 +1,43 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cassandra service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cassandra/keyspace_tags/index.md b/website/docs/services/cassandra/keyspace_tags/index.md new file mode 100644 index 0000000..8cf0d91 --- /dev/null +++ b/website/docs/services/cassandra/keyspace_tags/index.md @@ -0,0 +1,81 @@ +--- +title: keyspace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - keyspace_tags + - cassandra + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for keyspaces in a region + +## Overview + + + + + + + +
Namekeyspace_tags
TypeResource
DescriptionResource schema for AWS::Cassandra::Keyspace
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName for Cassandra keyspace
object
booleanIndicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace. To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you enabled client-side timestamps for a table, you can’t disable it again.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all keyspaces in a region. +```sql +SELECT +region, +keyspace_name, +replication_specification, +client_side_timestamps_enabled, +tag_key, +tag_value +FROM aws.cassandra.keyspace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the keyspace_tags resource, see keyspaces + diff --git a/website/docs/services/cassandra/keyspaces/index.md b/website/docs/services/cassandra/keyspaces/index.md new file mode 100644 index 0000000..32c8611 --- /dev/null +++ b/website/docs/services/cassandra/keyspaces/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a keyspace resource or lists keyspaces in a region + +## Overview + + + + + + + +
Namekeyspaces
TypeResource
DescriptionResource schema for AWS::Cassandra::Keyspace
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName for Cassandra keyspace
array
object
booleanIndicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace. To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you enabled client-side timestamps for a table, you can’t disable it again.
stringAWS region.
+ +For more information, see AWS::Cassandra::Keyspace. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all keyspaces in a region. +```sql +SELECT +region, +keyspace_name, +tags, +replication_specification, +client_side_timestamps_enabled +FROM aws.cassandra.keyspaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual keyspace. +```sql +SELECT +region, +keyspace_name, +tags, +replication_specification, +client_side_timestamps_enabled +FROM aws.cassandra.keyspaces +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new keyspace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cassandra.keyspaces ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cassandra.keyspaces ( + KeyspaceName, + Tags, + ReplicationSpecification, + ClientSideTimestampsEnabled, + region +) +SELECT + '{{ KeyspaceName }}', + '{{ Tags }}', + '{{ ReplicationSpecification }}', + '{{ ClientSideTimestampsEnabled }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: keyspace + props: + - name: KeyspaceName + value: '{{ KeyspaceName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ReplicationSpecification + value: + ReplicationStrategy: '{{ ReplicationStrategy }}' + RegionList: + - '{{ RegionList[0] }}' + - name: ClientSideTimestampsEnabled + value: '{{ ClientSideTimestampsEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cassandra.keyspaces +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cassandra:Select, +cassandra:SelectMultiRegionResource +``` + +### Update +```json +cassandra:Alter, +cassandra:AlterMultiRegionResource, +cassandra:Modify, +cassandra:ModifyMultiRegionResource, +cassandra:Select, +cassandra:SelectMultiRegionResource, +cassandra:TagResource, +cassandra:TagMultiRegionResource, +cassandra:UntagResource, +cassandra:UntagMultiRegionResource, +application-autoscaling:RegisterScalableTarget, +application-autoscaling:DeregisterScalableTarget, +application-autoscaling:DescribeScalableTargets, +application-autoscaling:DescribeScalingPolicies, +application-autoscaling:PutScalingPolicy, +cloudwatch:DeleteAlarms, +cloudwatch:DescribeAlarms, +cloudwatch:PutMetricAlarm, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +cassandra:Drop, +cassandra:DropMultiRegionResource, +cassandra:Select, +cassandra:SelectMultiRegionResource +``` + +### List +```json +cassandra:Select, +cassandra:SelectMultiRegionResource +``` diff --git a/website/docs/services/cassandra/keyspaces_list_only/index.md b/website/docs/services/cassandra/keyspaces_list_only/index.md new file mode 100644 index 0000000..55e5216 --- /dev/null +++ b/website/docs/services/cassandra/keyspaces_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: keyspaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - keyspaces_list_only + - cassandra + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists keyspaces in a region or regions, for all properties use keyspaces + +## Overview + + + + + + + +
Namekeyspaces_list_only
TypeResource
DescriptionResource schema for AWS::Cassandra::Keyspace
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName for Cassandra keyspace
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all keyspaces in a region. +```sql +SELECT +region, +keyspace_name +FROM aws.cassandra.keyspaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the keyspaces_list_only resource, see keyspaces + diff --git a/website/docs/services/cassandra/table_tags/index.md b/website/docs/services/cassandra/table_tags/index.md new file mode 100644 index 0000000..d935e9a --- /dev/null +++ b/website/docs/services/cassandra/table_tags/index.md @@ -0,0 +1,99 @@ +--- +title: table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - table_tags + - cassandra + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for tables in a region + +## Overview + + + + + + + +
Nametable_tags
TypeResource
DescriptionResource schema for AWS::Cassandra::Table
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName for Cassandra keyspace
stringName for Cassandra table
arrayNon-key columns of the table
arrayPartition key columns of the table
arrayClustering key columns of the table
object
booleanIndicates whether point in time recovery is enabled (true) or disabled (false) on the table
booleanIndicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again.
integerDefault TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
objectRepresents the settings used to enable server-side encryption
objectRepresents the read and write settings used for AutoScaling.
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all tables in a region. +```sql +SELECT +region, +keyspace_name, +table_name, +regular_columns, +partition_key_columns, +clustering_key_columns, +billing_mode, +point_in_time_recovery_enabled, +client_side_timestamps_enabled, +default_time_to_live, +encryption_specification, +auto_scaling_specifications, +replica_specifications, +tag_key, +tag_value +FROM aws.cassandra.table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the table_tags resource, see tables + diff --git a/website/docs/services/cassandra/tables/index.md b/website/docs/services/cassandra/tables/index.md new file mode 100644 index 0000000..cc5530a --- /dev/null +++ b/website/docs/services/cassandra/tables/index.md @@ -0,0 +1,377 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a table resource or lists tables in a region + +## Overview + + + + + + + +
Nametables
TypeResource
DescriptionResource schema for AWS::Cassandra::Table
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName for Cassandra keyspace
stringName for Cassandra table
arrayNon-key columns of the table
arrayPartition key columns of the table
arrayClustering key columns of the table
object
booleanIndicates whether point in time recovery is enabled (true) or disabled (false) on the table
booleanIndicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again.
arrayAn array of key-value pairs to apply to this resource
integerDefault TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
objectRepresents the settings used to enable server-side encryption
objectRepresents the read and write settings used for AutoScaling.
array
stringAWS region.
+ +For more information, see AWS::Cassandra::Table. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all tables in a region. +```sql +SELECT +region, +keyspace_name, +table_name, +regular_columns, +partition_key_columns, +clustering_key_columns, +billing_mode, +point_in_time_recovery_enabled, +client_side_timestamps_enabled, +tags, +default_time_to_live, +encryption_specification, +auto_scaling_specifications, +replica_specifications +FROM aws.cassandra.tables +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual table. +```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.tables +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cassandra.tables ( + KeyspaceName, + PartitionKeyColumns, + region +) +SELECT +'{{ KeyspaceName }}', + '{{ PartitionKeyColumns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cassandra.tables ( + KeyspaceName, + TableName, + RegularColumns, + PartitionKeyColumns, + ClusteringKeyColumns, + BillingMode, + PointInTimeRecoveryEnabled, + ClientSideTimestampsEnabled, + Tags, + DefaultTimeToLive, + EncryptionSpecification, + AutoScalingSpecifications, + ReplicaSpecifications, + region +) +SELECT + '{{ KeyspaceName }}', + '{{ TableName }}', + '{{ RegularColumns }}', + '{{ PartitionKeyColumns }}', + '{{ ClusteringKeyColumns }}', + '{{ BillingMode }}', + '{{ PointInTimeRecoveryEnabled }}', + '{{ ClientSideTimestampsEnabled }}', + '{{ Tags }}', + '{{ DefaultTimeToLive }}', + '{{ EncryptionSpecification }}', + '{{ AutoScalingSpecifications }}', + '{{ ReplicaSpecifications }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: table + props: + - name: KeyspaceName + value: '{{ KeyspaceName }}' + - name: TableName + value: '{{ TableName }}' + - name: RegularColumns + value: + - ColumnName: '{{ ColumnName }}' + ColumnType: '{{ ColumnType }}' + - name: PartitionKeyColumns + value: + - null + - name: ClusteringKeyColumns + value: + - Column: null + OrderBy: '{{ OrderBy }}' + - name: BillingMode + value: + Mode: '{{ Mode }}' + ProvisionedThroughput: + ReadCapacityUnits: '{{ ReadCapacityUnits }}' + WriteCapacityUnits: '{{ WriteCapacityUnits }}' + - name: PointInTimeRecoveryEnabled + value: '{{ PointInTimeRecoveryEnabled }}' + - name: ClientSideTimestampsEnabled + value: '{{ ClientSideTimestampsEnabled }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: DefaultTimeToLive + value: '{{ DefaultTimeToLive }}' + - name: EncryptionSpecification + value: + EncryptionType: '{{ EncryptionType }}' + KmsKeyIdentifier: '{{ KmsKeyIdentifier }}' + - name: AutoScalingSpecifications + value: + WriteCapacityAutoScaling: + AutoScalingDisabled: '{{ AutoScalingDisabled }}' + MinimumUnits: '{{ MinimumUnits }}' + MaximumUnits: '{{ MaximumUnits }}' + ScalingPolicy: + TargetTrackingScalingPolicyConfiguration: + DisableScaleIn: '{{ DisableScaleIn }}' + ScaleInCooldown: '{{ ScaleInCooldown }}' + ScaleOutCooldown: '{{ ScaleOutCooldown }}' + TargetValue: '{{ TargetValue }}' + ReadCapacityAutoScaling: null + - name: ReplicaSpecifications + value: + - Region: '{{ Region }}' + ReadCapacityUnits: '{{ ReadCapacityUnits }}' + ReadCapacityAutoScaling: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cassandra.tables +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### 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/website/docs/services/cassandra/tables_list_only/index.md b/website/docs/services/cassandra/tables_list_only/index.md new file mode 100644 index 0000000..9f94922 --- /dev/null +++ b/website/docs/services/cassandra/tables_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tables_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tables in a region or regions, for all properties use tables + +## Overview + + + + + + + +
Nametables_list_only
TypeResource
DescriptionResource schema for AWS::Cassandra::Table
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringName for Cassandra keyspace
stringName for Cassandra table
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tables in a region. +```sql +SELECT +region, +keyspace_name, +table_name +FROM aws.cassandra.tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tables_list_only resource, see tables + diff --git a/website/docs/services/cassandra/types/index.md b/website/docs/services/cassandra/types/index.md new file mode 100644 index 0000000..d93cc53 --- /dev/null +++ b/website/docs/services/cassandra/types/index.md @@ -0,0 +1,221 @@ +--- +title: types +hide_title: false +hide_table_of_contents: false +keywords: + - types + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a type resource or lists types in a region + +## Overview + + + + + + + +
Nametypes
TypeResource
DescriptionResource schema for AWS::Cassandra::Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the Keyspace which contains the User-Defined Type.
stringName of the User-Defined Type.
arrayField definitions of the User-Defined Type
arrayList of Tables that directly reference the User-Defined Type in their columns.
arrayList of parent User-Defined Types that directly reference the User-Defined Type in their fields.
integerMaximum nesting depth of the User-Defined Type across the field types.
numberTimestamp of the last time the User-Defined Type's meta data was modified.
stringARN of the Keyspace which contains the User-Defined Type.
stringAWS region.
+ +For more information, see AWS::Cassandra::Type. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all types in a region. +```sql +SELECT +region, +keyspace_name, +type_name, +fields, +direct_referring_tables, +direct_parent_types, +max_nesting_depth, +last_modified_timestamp, +keyspace_arn +FROM aws.cassandra.types +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual type. +```sql +SELECT +region, +keyspace_name, +type_name, +fields, +direct_referring_tables, +direct_parent_types, +max_nesting_depth, +last_modified_timestamp, +keyspace_arn +FROM aws.cassandra.types +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cassandra.types ( + KeyspaceName, + TypeName, + Fields, + region +) +SELECT +'{{ KeyspaceName }}', + '{{ TypeName }}', + '{{ Fields }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cassandra.types ( + KeyspaceName, + TypeName, + Fields, + region +) +SELECT + '{{ KeyspaceName }}', + '{{ TypeName }}', + '{{ Fields }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: type + props: + - name: KeyspaceName + value: '{{ KeyspaceName }}' + - name: TypeName + value: '{{ TypeName }}' + - name: Fields + value: + - FieldName: '{{ FieldName }}' + FieldType: '{{ FieldType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cassandra.types +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the types resource, the following permissions are required: + +### Create +```json +cassandra:Create, +cassandra:Select +``` + +### Read +```json +cassandra:Select +``` + +### Delete +```json +cassandra:Drop, +cassandra:Select +``` + +### List +```json +cassandra:Select +``` diff --git a/website/docs/services/cassandra/types_list_only/index.md b/website/docs/services/cassandra/types_list_only/index.md new file mode 100644 index 0000000..47b55e9 --- /dev/null +++ b/website/docs/services/cassandra/types_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - types_list_only + - cassandra + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists types in a region or regions, for all properties use types + +## Overview + + + + + + + +
Nametypes_list_only
TypeResource
DescriptionResource schema for AWS::Cassandra::Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringName of the Keyspace which contains the User-Defined Type.
stringName of the User-Defined Type.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all types in a region. +```sql +SELECT +region, +keyspace_name, +type_name +FROM aws.cassandra.types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the types_list_only resource, see types + diff --git a/website/docs/services/ce/anomaly_monitors/index.md b/website/docs/services/ce/anomaly_monitors/index.md new file mode 100644 index 0000000..f2dd948 --- /dev/null +++ b/website/docs/services/ce/anomaly_monitors/index.md @@ -0,0 +1,242 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an anomaly_monitor resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSubscription ARN
string
stringThe name of the monitor.
stringThe date when the monitor was created.
stringThe date when the monitor last evaluated for anomalies.
stringThe date when the monitor was last updated.
stringThe dimensions to evaluate
string
integerThe value for evaluated dimensions.
arrayTags to assign to monitor.
stringAWS region.
+ +For more information, see AWS::CE::AnomalyMonitor. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all anomaly_monitors in a region. +```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_monitors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual anomaly_monitor. +```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_monitors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new anomaly_monitor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ce.anomaly_monitors ( + MonitorType, + MonitorName, + region +) +SELECT +'{{ MonitorType }}', + '{{ MonitorName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ce.anomaly_monitors ( + MonitorType, + MonitorName, + MonitorDimension, + MonitorSpecification, + ResourceTags, + region +) +SELECT + '{{ MonitorType }}', + '{{ MonitorName }}', + '{{ MonitorDimension }}', + '{{ MonitorSpecification }}', + '{{ ResourceTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: anomaly_monitor + props: + - name: MonitorType + value: '{{ MonitorType }}' + - name: MonitorName + value: '{{ MonitorName }}' + - name: MonitorDimension + value: '{{ MonitorDimension }}' + - name: MonitorSpecification + value: '{{ MonitorSpecification }}' + - name: ResourceTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ce.anomaly_monitors +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the anomaly_monitors resource, the following permissions are required: + +### Create +```json +ce:CreateAnomalyMonitor, +ce:TagResource +``` + +### Read +```json +ce:GetAnomalyMonitors +``` + +### Update +```json +ce:UpdateAnomalyMonitor +``` + +### Delete +```json +ce:DeleteAnomalyMonitor +``` + +### List +```json +ce:GetAnomalyMonitors +``` diff --git a/website/docs/services/ce/anomaly_monitors_list_only/index.md b/website/docs/services/ce/anomaly_monitors_list_only/index.md new file mode 100644 index 0000000..e4e0dc7 --- /dev/null +++ b/website/docs/services/ce/anomaly_monitors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: anomaly_monitors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_monitors_list_only + - ce + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists anomaly_monitors in a region or regions, for all properties use anomaly_monitors + +## Overview + + + + + + + +
Nameanomaly_monitors_list_only
TypeResource
DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. You can use Cost Anomaly Detection by creating monitor.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringSubscription ARN
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all anomaly_monitors in a region. +```sql +SELECT +region, +monitor_arn +FROM aws.ce.anomaly_monitors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the anomaly_monitors_list_only resource, see anomaly_monitors + diff --git a/website/docs/services/ce/anomaly_subscriptions/index.md b/website/docs/services/ce/anomaly_subscriptions/index.md new file mode 100644 index 0000000..7b2c38d --- /dev/null +++ b/website/docs/services/ce/anomaly_subscriptions/index.md @@ -0,0 +1,255 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an anomaly_subscription resource or lists 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
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringSubscription ARN
stringThe name of the subscription.
stringThe accountId
arrayA list of cost anomaly monitors.
arrayA list of subscriber
numberThe dollar value that triggers a notification if the threshold is exceeded.
stringAn Expression object in JSON String format used to specify the anomalies that you want to generate alerts for.
stringThe frequency at which anomaly reports are sent over email.
arrayTags to assign to subscription.
stringAWS region.
+ +For more information, see AWS::CE::AnomalySubscription. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all anomaly_subscriptions in a region. +```sql +SELECT +region, +subscription_arn, +subscription_name, +account_id, +monitor_arn_list, +subscribers, +threshold, +threshold_expression, +frequency, +resource_tags +FROM aws.ce.anomaly_subscriptions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual anomaly_subscription. +```sql +SELECT +region, +subscription_arn, +subscription_name, +account_id, +monitor_arn_list, +subscribers, +threshold, +threshold_expression, +frequency, +resource_tags +FROM aws.ce.anomaly_subscriptions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new anomaly_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ce.anomaly_subscriptions ( + SubscriptionName, + MonitorArnList, + Subscribers, + Frequency, + region +) +SELECT +'{{ SubscriptionName }}', + '{{ MonitorArnList }}', + '{{ Subscribers }}', + '{{ Frequency }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ce.anomaly_subscriptions ( + SubscriptionName, + MonitorArnList, + Subscribers, + Threshold, + ThresholdExpression, + Frequency, + ResourceTags, + region +) +SELECT + '{{ SubscriptionName }}', + '{{ MonitorArnList }}', + '{{ Subscribers }}', + '{{ Threshold }}', + '{{ ThresholdExpression }}', + '{{ Frequency }}', + '{{ ResourceTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: anomaly_subscription + props: + - name: SubscriptionName + value: '{{ SubscriptionName }}' + - name: MonitorArnList + value: + - '{{ MonitorArnList[0] }}' + - name: Subscribers + value: + - Address: '{{ Address }}' + Status: '{{ Status }}' + Type: '{{ Type }}' + - name: Threshold + value: null + - name: ThresholdExpression + value: '{{ ThresholdExpression }}' + - name: Frequency + value: '{{ Frequency }}' + - name: ResourceTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ce.anomaly_subscriptions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the anomaly_subscriptions resource, the following permissions are required: + +### Create +```json +ce:CreateAnomalySubscription, +ce:TagResource +``` + +### Read +```json +ce:GetAnomalySubscriptions +``` + +### Update +```json +ce:UpdateAnomalySubscription +``` + +### Delete +```json +ce:DeleteAnomalySubscription +``` + +### List +```json +ce:GetAnomalySubscriptions +``` diff --git a/website/docs/services/ce/anomaly_subscriptions_list_only/index.md b/website/docs/services/ce/anomaly_subscriptions_list_only/index.md new file mode 100644 index 0000000..abe0f78 --- /dev/null +++ b/website/docs/services/ce/anomaly_subscriptions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: anomaly_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_subscriptions_list_only + - ce + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists anomaly_subscriptions in a region or regions, for all properties use anomaly_subscriptions + +## Overview + + + + + + + +
Nameanomaly_subscriptions_list_only
TypeResource
DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. Create subscription to be notified
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringSubscription ARN
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all anomaly_subscriptions in a region. +```sql +SELECT +region, +subscription_arn +FROM aws.ce.anomaly_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the anomaly_subscriptions_list_only resource, see anomaly_subscriptions + diff --git a/website/docs/services/ce/cost_categories/index.md b/website/docs/services/ce/cost_categories/index.md new file mode 100644 index 0000000..5d982e5 --- /dev/null +++ b/website/docs/services/ce/cost_categories/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cost_category resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringCost category ARN
stringISO 8601 date time with offset format
string
string
stringJSON array format of Expression in Billing and Cost Management API
stringJson array format of CostCategorySplitChargeRule in Billing and Cost Management API
stringThe default value for the cost category
stringAWS region.
+ +For more information, see AWS::CE::CostCategory. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cost_categories in a region. +```sql +SELECT +region, +arn, +effective_start, +name, +rule_version, +rules, +split_charge_rules, +default_value +FROM aws.ce.cost_categories +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cost_category. +```sql +SELECT +region, +arn, +effective_start, +name, +rule_version, +rules, +split_charge_rules, +default_value +FROM aws.ce.cost_categories +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cost_category resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ce.cost_categories ( + Name, + RuleVersion, + Rules, + region +) +SELECT +'{{ Name }}', + '{{ RuleVersion }}', + '{{ Rules }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ce.cost_categories ( + Name, + RuleVersion, + Rules, + SplitChargeRules, + DefaultValue, + region +) +SELECT + '{{ Name }}', + '{{ RuleVersion }}', + '{{ Rules }}', + '{{ SplitChargeRules }}', + '{{ DefaultValue }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cost_category + props: + - name: Name + value: '{{ Name }}' + - name: RuleVersion + value: '{{ RuleVersion }}' + - name: Rules + value: '{{ Rules }}' + - name: SplitChargeRules + value: '{{ SplitChargeRules }}' + - name: DefaultValue + value: '{{ DefaultValue }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ce.cost_categories +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the cost_categories resource, the following permissions are required: + +### Create +```json +ce:CreateCostCategoryDefinition +``` + +### Read +```json +ce:DescribeCostCategoryDefinition +``` + +### Update +```json +ce:UpdateCostCategoryDefinition +``` + +### Delete +```json +ce:DeleteCostCategoryDefinition +``` + +### List +```json +ce:ListCostCategoryDefinitions +``` diff --git a/website/docs/services/ce/cost_categories_list_only/index.md b/website/docs/services/ce/cost_categories_list_only/index.md new file mode 100644 index 0000000..14a3572 --- /dev/null +++ b/website/docs/services/ce/cost_categories_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cost_categories_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cost_categories_list_only + - ce + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cost_categories in a region or regions, for all properties use cost_categories + +## Overview + + + + + + + +
Namecost_categories_list_only
TypeResource
DescriptionCost Category enables you to map your cost and usage into meaningful categories. You can use Cost Category to organize your costs using a rule-based engine.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringCost category ARN
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cost_categories in a region. +```sql +SELECT +region, +arn +FROM aws.ce.cost_categories_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cost_categories_list_only resource, see cost_categories + diff --git a/website/docs/services/ce/index.md b/website/docs/services/ce/index.md new file mode 100644 index 0000000..e4bcd5c --- /dev/null +++ b/website/docs/services/ce/index.md @@ -0,0 +1,41 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The ce service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/certificatemanager/accounts/index.md b/website/docs/services/certificatemanager/accounts/index.md new file mode 100644 index 0000000..7525004 --- /dev/null +++ b/website/docs/services/certificatemanager/accounts/index.md @@ -0,0 +1,183 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an account resource or lists accounts in a region + +## Overview + + + + + + + +
Nameaccounts
TypeResource
DescriptionResource schema for AWS::CertificateManager::Account.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
object
string
stringAWS region.
+ +For more information, see AWS::CertificateManager::Account. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual account. +```sql +SELECT +region, +expiry_events_configuration, +account_id +FROM aws.certificatemanager.accounts +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new account resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.certificatemanager.accounts ( + ExpiryEventsConfiguration, + region +) +SELECT +'{{ ExpiryEventsConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.certificatemanager.accounts ( + ExpiryEventsConfiguration, + region +) +SELECT + '{{ ExpiryEventsConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: account + props: + - name: ExpiryEventsConfiguration + value: + DaysBeforeExpiry: '{{ DaysBeforeExpiry }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.certificatemanager.accounts +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the accounts resource, the following permissions are required: + +### Create +```json +acm:GetAccountConfiguration, +acm:PutAccountConfiguration +``` + +### Read +```json +acm:GetAccountConfiguration +``` + +### Update +```json +acm:GetAccountConfiguration, +acm:PutAccountConfiguration +``` + +### Delete +```json +acm:GetAccountConfiguration, +acm:PutAccountConfiguration +``` diff --git a/website/docs/services/certificatemanager/index.md b/website/docs/services/certificatemanager/index.md new file mode 100644 index 0000000..a5e8b69 --- /dev/null +++ b/website/docs/services/certificatemanager/index.md @@ -0,0 +1,37 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The certificatemanager service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+ +
+ +
+
\ No newline at end of file diff --git a/website/docs/services/chatbot/custom_action_tags/index.md b/website/docs/services/chatbot/custom_action_tags/index.md new file mode 100644 index 0000000..e2aff6a --- /dev/null +++ b/website/docs/services/chatbot/custom_action_tags/index.md @@ -0,0 +1,85 @@ +--- +title: custom_action_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_action_tags + - chatbot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_actions in a region + +## Overview + + + + + + + +
Namecustom_action_tags
TypeResource
DescriptionDefinition of AWS::Chatbot::CustomAction Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_actions in a region. +```sql +SELECT +region, +action_name, +alias_name, +attachments, +custom_action_arn, +definition, +tag_key, +tag_value +FROM aws.chatbot.custom_action_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_action_tags resource, see custom_actions + diff --git a/website/docs/services/chatbot/custom_actions/index.md b/website/docs/services/chatbot/custom_actions/index.md new file mode 100644 index 0000000..14fc3ff --- /dev/null +++ b/website/docs/services/chatbot/custom_actions/index.md @@ -0,0 +1,245 @@ +--- +title: custom_actions +hide_title: false +hide_table_of_contents: false +keywords: + - custom_actions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a custom_action resource or lists custom_actions in a region + +## Overview + + + + + + + +
Namecustom_actions
TypeResource
DescriptionDefinition of AWS::Chatbot::CustomAction Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
object
array
stringAWS region.
+ +For more information, see AWS::Chatbot::CustomAction. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all custom_actions in a region. +```sql +SELECT +region, +action_name, +alias_name, +attachments, +custom_action_arn, +definition, +tags +FROM aws.chatbot.custom_actions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual custom_action. +```sql +SELECT +region, +action_name, +alias_name, +attachments, +custom_action_arn, +definition, +tags +FROM aws.chatbot.custom_actions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new custom_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.chatbot.custom_actions ( + ActionName, + Definition, + region +) +SELECT +'{{ ActionName }}', + '{{ Definition }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.chatbot.custom_actions ( + ActionName, + AliasName, + Attachments, + Definition, + Tags, + region +) +SELECT + '{{ ActionName }}', + '{{ AliasName }}', + '{{ Attachments }}', + '{{ Definition }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: custom_action + props: + - name: ActionName + value: '{{ ActionName }}' + - name: AliasName + value: '{{ AliasName }}' + - name: Attachments + value: + - NotificationType: '{{ NotificationType }}' + ButtonText: '{{ ButtonText }}' + Criteria: + - Operator: '{{ Operator }}' + VariableName: '{{ VariableName }}' + Value: '{{ Value }}' + Variables: {} + - name: Definition + value: + CommandText: '{{ CommandText }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.chatbot.custom_actions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the custom_actions resource, the following permissions are required: + +### Create +```json +chatbot:CreateCustomAction, +chatbot:GetCustomAction, +chatbot:TagResource, +chatbot:ListTagsForResource +``` + +### Read +```json +chatbot:GetCustomAction, +chatbot:ListTagsForResource +``` + +### Update +```json +chatbot:UpdateCustomAction, +chatbot:GetCustomAction, +chatbot:TagResource, +chatbot:UntagResource, +chatbot:ListTagsForResource +``` + +### Delete +```json +chatbot:DeleteCustomAction +``` + +### List +```json +chatbot:ListCustomActions +``` diff --git a/website/docs/services/chatbot/custom_actions_list_only/index.md b/website/docs/services/chatbot/custom_actions_list_only/index.md new file mode 100644 index 0000000..9819fc3 --- /dev/null +++ b/website/docs/services/chatbot/custom_actions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: custom_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_actions_list_only + - chatbot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_actions in a region or regions, for all properties use custom_actions + +## Overview + + + + + + + +
Namecustom_actions_list_only
TypeResource
DescriptionDefinition of AWS::Chatbot::CustomAction Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_actions in a region. +```sql +SELECT +region, +custom_action_arn +FROM aws.chatbot.custom_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_actions_list_only resource, see custom_actions + diff --git a/website/docs/services/chatbot/index.md b/website/docs/services/chatbot/index.md new file mode 100644 index 0000000..26c2101 --- /dev/null +++ b/website/docs/services/chatbot/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The chatbot service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/chatbot/microsoft_teams_channel_configuration_tags/index.md b/website/docs/services/chatbot/microsoft_teams_channel_configuration_tags/index.md new file mode 100644 index 0000000..1c08d14 --- /dev/null +++ b/website/docs/services/chatbot/microsoft_teams_channel_configuration_tags/index.md @@ -0,0 +1,97 @@ +--- +title: microsoft_teams_channel_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - microsoft_teams_channel_configuration_tags + - chatbot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for microsoft_teams_channel_configurations in a region + +## Overview + + + + + + + +
Namemicrosoft_teams_channel_configuration_tags
TypeResource
DescriptionResource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe id of the Microsoft Teams team
stringThe id of the Microsoft Teams channel
stringThe id of the Microsoft Teams tenant
stringThe name of the configuration
stringThe ARN of the IAM role that defines the permissions for AWS Chatbot
arrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
stringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
stringAmazon Resource Name (ARN) of the configuration
arrayThe list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
booleanEnables use of a user role requirement in your chat configuration
arrayARNs of Custom Actions to associate with notifications in the provided chat channel.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all microsoft_teams_channel_configurations in a region. +```sql +SELECT +region, +team_id, +teams_channel_id, +teams_tenant_id, +configuration_name, +iam_role_arn, +sns_topic_arns, +logging_level, +arn, +guardrail_policies, +user_role_required, +customization_resource_arns, +tag_key, +tag_value +FROM aws.chatbot.microsoft_teams_channel_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the microsoft_teams_channel_configuration_tags resource, see microsoft_teams_channel_configurations + diff --git a/website/docs/services/chatbot/microsoft_teams_channel_configurations/index.md b/website/docs/services/chatbot/microsoft_teams_channel_configurations/index.md new file mode 100644 index 0000000..4932c45 --- /dev/null +++ b/website/docs/services/chatbot/microsoft_teams_channel_configurations/index.md @@ -0,0 +1,297 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a microsoft_teams_channel_configuration resource or lists microsoft_teams_channel_configurations in a region + +## Overview + + + + + + + +
Namemicrosoft_teams_channel_configurations
TypeResource
DescriptionResource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe id of the Microsoft Teams team
stringThe id of the Microsoft Teams channel
stringThe id of the Microsoft Teams tenant
stringThe name of the configuration
stringThe ARN of the IAM role that defines the permissions for AWS Chatbot
arrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
stringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
stringAmazon Resource Name (ARN) of the configuration
arrayThe list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
booleanEnables use of a user role requirement in your chat configuration
arrayThe tags to add to the configuration
arrayARNs of Custom Actions to associate with notifications in the provided chat channel.
stringAWS region.
+ +For more information, see AWS::Chatbot::MicrosoftTeamsChannelConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all microsoft_teams_channel_configurations in a region. +```sql +SELECT +region, +team_id, +teams_channel_id, +teams_tenant_id, +configuration_name, +iam_role_arn, +sns_topic_arns, +logging_level, +arn, +guardrail_policies, +user_role_required, +tags, +customization_resource_arns +FROM aws.chatbot.microsoft_teams_channel_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual microsoft_teams_channel_configuration. +```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, +tags, +customization_resource_arns +FROM aws.chatbot.microsoft_teams_channel_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new microsoft_teams_channel_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.chatbot.microsoft_teams_channel_configurations ( + TeamId, + TeamsChannelId, + TeamsTenantId, + ConfigurationName, + IamRoleArn, + region +) +SELECT +'{{ TeamId }}', + '{{ TeamsChannelId }}', + '{{ TeamsTenantId }}', + '{{ ConfigurationName }}', + '{{ IamRoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.chatbot.microsoft_teams_channel_configurations ( + TeamId, + TeamsChannelId, + TeamsTenantId, + ConfigurationName, + IamRoleArn, + SnsTopicArns, + LoggingLevel, + GuardrailPolicies, + UserRoleRequired, + Tags, + CustomizationResourceArns, + region +) +SELECT + '{{ TeamId }}', + '{{ TeamsChannelId }}', + '{{ TeamsTenantId }}', + '{{ ConfigurationName }}', + '{{ IamRoleArn }}', + '{{ SnsTopicArns }}', + '{{ LoggingLevel }}', + '{{ GuardrailPolicies }}', + '{{ UserRoleRequired }}', + '{{ Tags }}', + '{{ CustomizationResourceArns }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: microsoft_teams_channel_configuration + props: + - name: TeamId + value: '{{ TeamId }}' + - name: TeamsChannelId + value: '{{ TeamsChannelId }}' + - name: TeamsTenantId + value: '{{ TeamsTenantId }}' + - name: ConfigurationName + value: '{{ ConfigurationName }}' + - name: IamRoleArn + value: '{{ IamRoleArn }}' + - name: SnsTopicArns + value: + - '{{ SnsTopicArns[0] }}' + - name: LoggingLevel + value: '{{ LoggingLevel }}' + - name: GuardrailPolicies + value: + - '{{ GuardrailPolicies[0] }}' + - name: UserRoleRequired + value: '{{ UserRoleRequired }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: CustomizationResourceArns + value: + - '{{ CustomizationResourceArns[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.chatbot.microsoft_teams_channel_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the microsoft_teams_channel_configurations resource, the following permissions are required: + +### Create +```json +chatbot:CreateMicrosoftTeamsChannelConfiguration, +chatbot:TagResource, +chatbot:AssociateToConfiguration, +chatbot:ListAssociations, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### Read +```json +chatbot:GetMicrosoftTeamsChannelConfiguration, +chatbot:ListAssociations +``` + +### Update +```json +chatbot:UpdateMicrosoftTeamsChannelConfiguration, +chatbot:TagResource, +chatbot:UntagResource, +chatbot:ListTagsForResource, +chatbot:AssociateToConfiguration, +chatbot:DisassociateFromConfiguration, +chatbot:ListAssociations, +iam:PassRole +``` + +### Delete +```json +chatbot:GetMicrosoftTeamsChannelConfiguration, +chatbot:DeleteMicrosoftTeamsChannelConfiguration, +chatbot:DisassociateFromConfiguration, +chatbot:ListAssociations +``` + +### List +```json +chatbot:ListMicrosoftTeamsChannelConfigurations, +chatbot:ListAssociations +``` diff --git a/website/docs/services/chatbot/microsoft_teams_channel_configurations_list_only/index.md b/website/docs/services/chatbot/microsoft_teams_channel_configurations_list_only/index.md new file mode 100644 index 0000000..5b5656d --- /dev/null +++ b/website/docs/services/chatbot/microsoft_teams_channel_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: microsoft_teams_channel_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - microsoft_teams_channel_configurations_list_only + - chatbot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists microsoft_teams_channel_configurations in a region or regions, for all properties use microsoft_teams_channel_configurations + +## Overview + + + + + + + +
Namemicrosoft_teams_channel_configurations_list_only
TypeResource
DescriptionResource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN) of the configuration
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all microsoft_teams_channel_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.chatbot.microsoft_teams_channel_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the microsoft_teams_channel_configurations_list_only resource, see microsoft_teams_channel_configurations + diff --git a/website/docs/services/chatbot/slack_channel_configuration_tags/index.md b/website/docs/services/chatbot/slack_channel_configuration_tags/index.md new file mode 100644 index 0000000..15ec424 --- /dev/null +++ b/website/docs/services/chatbot/slack_channel_configuration_tags/index.md @@ -0,0 +1,95 @@ +--- +title: slack_channel_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - slack_channel_configuration_tags + - chatbot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for slack_channel_configurations in a region + +## Overview + + + + + + + +
Nameslack_channel_configuration_tags
TypeResource
DescriptionResource schema for AWS::Chatbot::SlackChannelConfiguration.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe id of the Slack workspace
stringThe id of the Slack channel
stringThe name of the configuration
stringThe ARN of the IAM role that defines the permissions for AWS Chatbot
arrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
stringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
stringAmazon Resource Name (ARN) of the configuration
arrayThe list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
booleanEnables use of a user role requirement in your chat configuration
arrayARNs of Custom Actions to associate with notifications in the provided chat channel.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all slack_channel_configurations in a region. +```sql +SELECT +region, +slack_workspace_id, +slack_channel_id, +configuration_name, +iam_role_arn, +sns_topic_arns, +logging_level, +arn, +guardrail_policies, +user_role_required, +customization_resource_arns, +tag_key, +tag_value +FROM aws.chatbot.slack_channel_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the slack_channel_configuration_tags resource, see slack_channel_configurations + diff --git a/website/docs/services/chatbot/slack_channel_configurations/index.md b/website/docs/services/chatbot/slack_channel_configurations/index.md new file mode 100644 index 0000000..e1ac457 --- /dev/null +++ b/website/docs/services/chatbot/slack_channel_configurations/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a slack_channel_configuration resource or lists slack_channel_configurations in a region + +## Overview + + + + + + + +
Nameslack_channel_configurations
TypeResource
DescriptionResource schema for AWS::Chatbot::SlackChannelConfiguration.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe id of the Slack workspace
stringThe id of the Slack channel
stringThe name of the configuration
stringThe ARN of the IAM role that defines the permissions for AWS Chatbot
arrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
stringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
stringAmazon Resource Name (ARN) of the configuration
arrayThe list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
arrayThe tags to add to the configuration
booleanEnables use of a user role requirement in your chat configuration
arrayARNs of Custom Actions to associate with notifications in the provided chat channel.
stringAWS region.
+ +For more information, see AWS::Chatbot::SlackChannelConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all slack_channel_configurations in a region. +```sql +SELECT +region, +slack_workspace_id, +slack_channel_id, +configuration_name, +iam_role_arn, +sns_topic_arns, +logging_level, +arn, +guardrail_policies, +tags, +user_role_required, +customization_resource_arns +FROM aws.chatbot.slack_channel_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual slack_channel_configuration. +```sql +SELECT +region, +slack_workspace_id, +slack_channel_id, +configuration_name, +iam_role_arn, +sns_topic_arns, +logging_level, +arn, +guardrail_policies, +tags, +user_role_required, +customization_resource_arns +FROM aws.chatbot.slack_channel_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new slack_channel_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.chatbot.slack_channel_configurations ( + SlackWorkspaceId, + SlackChannelId, + ConfigurationName, + IamRoleArn, + region +) +SELECT +'{{ SlackWorkspaceId }}', + '{{ SlackChannelId }}', + '{{ ConfigurationName }}', + '{{ IamRoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.chatbot.slack_channel_configurations ( + SlackWorkspaceId, + SlackChannelId, + ConfigurationName, + IamRoleArn, + SnsTopicArns, + LoggingLevel, + GuardrailPolicies, + Tags, + UserRoleRequired, + CustomizationResourceArns, + region +) +SELECT + '{{ SlackWorkspaceId }}', + '{{ SlackChannelId }}', + '{{ ConfigurationName }}', + '{{ IamRoleArn }}', + '{{ SnsTopicArns }}', + '{{ LoggingLevel }}', + '{{ GuardrailPolicies }}', + '{{ Tags }}', + '{{ UserRoleRequired }}', + '{{ CustomizationResourceArns }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: slack_channel_configuration + props: + - name: SlackWorkspaceId + value: '{{ SlackWorkspaceId }}' + - name: SlackChannelId + value: '{{ SlackChannelId }}' + - name: ConfigurationName + value: '{{ ConfigurationName }}' + - name: IamRoleArn + value: '{{ IamRoleArn }}' + - name: SnsTopicArns + value: + - '{{ SnsTopicArns[0] }}' + - name: LoggingLevel + value: '{{ LoggingLevel }}' + - name: GuardrailPolicies + value: + - '{{ GuardrailPolicies[0] }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: UserRoleRequired + value: '{{ UserRoleRequired }}' + - name: CustomizationResourceArns + value: + - '{{ CustomizationResourceArns[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.chatbot.slack_channel_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the slack_channel_configurations resource, the following permissions are required: + +### Create +```json +chatbot:CreateSlackChannelConfiguration, +chatbot:TagResource, +chatbot:AssociateToConfiguration, +chatbot:ListAssociations, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### Read +```json +chatbot:DescribeSlackChannelConfigurations, +chatbot:ListAssociations +``` + +### Update +```json +chatbot:UpdateSlackChannelConfiguration, +chatbot:TagResource, +chatbot:UntagResource, +chatbot:ListTagsForResource, +chatbot:AssociateToConfiguration, +chatbot:DisassociateFromConfiguration, +chatbot:ListAssociations, +iam:PassRole +``` + +### Delete +```json +chatbot:DeleteSlackChannelConfiguration, +chatbot:DisassociateFromConfiguration, +chatbot:ListAssociations +``` + +### List +```json +chatbot:DescribeSlackChannelConfigurations, +chatbot:ListAssociations +``` diff --git a/website/docs/services/chatbot/slack_channel_configurations_list_only/index.md b/website/docs/services/chatbot/slack_channel_configurations_list_only/index.md new file mode 100644 index 0000000..8223f45 --- /dev/null +++ b/website/docs/services/chatbot/slack_channel_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: slack_channel_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - slack_channel_configurations_list_only + - chatbot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists slack_channel_configurations in a region or regions, for all properties use slack_channel_configurations + +## Overview + + + + + + + +
Nameslack_channel_configurations_list_only
TypeResource
DescriptionResource schema for AWS::Chatbot::SlackChannelConfiguration.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN) of the configuration
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all slack_channel_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.chatbot.slack_channel_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the slack_channel_configurations_list_only resource, see slack_channel_configurations + diff --git a/website/docs/services/cleanrooms/analysis_template_tags/index.md b/website/docs/services/cleanrooms/analysis_template_tags/index.md new file mode 100644 index 0000000..662991f --- /dev/null +++ b/website/docs/services/cleanrooms/analysis_template_tags/index.md @@ -0,0 +1,99 @@ +--- +title: analysis_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - analysis_template_tags + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for analysis_templates in a region + +## Overview + + + + + + + +
Nameanalysis_template_tags
TypeResource
DescriptionRepresents a stored analysis within a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
arrayThe member who can query can provide this placeholder for a literal data value in an analysis template
string
string
string
string
string
object
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all analysis_templates in a region. +```sql +SELECT +region, +arn, +collaboration_arn, +collaboration_identifier, +analysis_parameters, +analysis_template_identifier, +description, +membership_arn, +membership_identifier, +name, +schema, +source, +format, +tag_key, +tag_value +FROM aws.cleanrooms.analysis_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analysis_template_tags resource, see analysis_templates + diff --git a/website/docs/services/cleanrooms/analysis_templates/index.md b/website/docs/services/cleanrooms/analysis_templates/index.md new file mode 100644 index 0000000..9cf61b8 --- /dev/null +++ b/website/docs/services/cleanrooms/analysis_templates/index.md @@ -0,0 +1,279 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an analysis_template resource or lists analysis_templates in a region + +## Overview + + + + + + + +
Nameanalysis_templates
TypeResource
DescriptionRepresents a stored analysis within a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
arrayThe member who can query can provide this placeholder for a literal data value in an analysis template
string
string
string
string
string
object
object
string
stringAWS region.
+ +For more information, see AWS::CleanRooms::AnalysisTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all analysis_templates in a region. +```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_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual analysis_template. +```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_templates +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new analysis_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.analysis_templates ( + MembershipIdentifier, + Name, + Source, + Format, + region +) +SELECT +'{{ MembershipIdentifier }}', + '{{ Name }}', + '{{ Source }}', + '{{ Format }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.analysis_templates ( + Tags, + AnalysisParameters, + Description, + MembershipIdentifier, + Name, + Source, + Format, + region +) +SELECT + '{{ Tags }}', + '{{ AnalysisParameters }}', + '{{ Description }}', + '{{ MembershipIdentifier }}', + '{{ Name }}', + '{{ Source }}', + '{{ Format }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: analysis_template + props: + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AnalysisParameters + value: + - DefaultValue: '{{ DefaultValue }}' + Name: '{{ Name }}' + Type: '{{ Type }}' + - name: Description + value: '{{ Description }}' + - name: MembershipIdentifier + value: '{{ MembershipIdentifier }}' + - name: Name + value: '{{ Name }}' + - name: Source + value: + Text: '{{ Text }}' + - name: Format + value: '{{ Format }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cleanrooms.analysis_templates +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +cleanrooms:ListAnalysisTemplates +``` diff --git a/website/docs/services/cleanrooms/analysis_templates_list_only/index.md b/website/docs/services/cleanrooms/analysis_templates_list_only/index.md new file mode 100644 index 0000000..75c1608 --- /dev/null +++ b/website/docs/services/cleanrooms/analysis_templates_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: analysis_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - analysis_templates_list_only + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists analysis_templates in a region or regions, for all properties use analysis_templates + +## Overview + + + + + + + +
Nameanalysis_templates_list_only
TypeResource
DescriptionRepresents a stored analysis within a collaboration
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all analysis_templates in a region. +```sql +SELECT +region, +analysis_template_identifier, +membership_identifier +FROM aws.cleanrooms.analysis_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analysis_templates_list_only resource, see analysis_templates + diff --git a/website/docs/services/cleanrooms/collaboration_tags/index.md b/website/docs/services/cleanrooms/collaboration_tags/index.md new file mode 100644 index 0000000..854c718 --- /dev/null +++ b/website/docs/services/cleanrooms/collaboration_tags/index.md @@ -0,0 +1,99 @@ +--- +title: collaboration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - collaboration_tags + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for collaborations in a region + +## Overview + + + + + + + +
Namecollaboration_tags
TypeResource
DescriptionRepresents a collaboration between AWS accounts that allows for secure data collaboration
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
object
object
string
array
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all collaborations in a region. +```sql +SELECT +region, +arn, +collaboration_identifier, +creator_display_name, +creator_member_abilities, +creator_ml_member_abilities, +data_encryption_metadata, +description, +members, +name, +query_log_status, +analytics_engine, +creator_payment_configuration, +tag_key, +tag_value +FROM aws.cleanrooms.collaboration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collaboration_tags resource, see collaborations + diff --git a/website/docs/services/cleanrooms/collaborations/index.md b/website/docs/services/cleanrooms/collaborations/index.md new file mode 100644 index 0000000..639325d --- /dev/null +++ b/website/docs/services/cleanrooms/collaborations/index.md @@ -0,0 +1,319 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a collaboration resource or lists collaborations in a region + +## Overview + + + + + + + +
Namecollaborations
TypeResource
DescriptionRepresents a collaboration between AWS accounts that allows for secure data collaboration
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
string
string
array
object
object
string
array
string
string
string
object
stringAWS region.
+ +For more information, see AWS::CleanRooms::Collaboration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all collaborations in a region. +```sql +SELECT +region, +arn, +tags, +collaboration_identifier, +creator_display_name, +creator_member_abilities, +creator_ml_member_abilities, +data_encryption_metadata, +description, +members, +name, +query_log_status, +analytics_engine, +creator_payment_configuration +FROM aws.cleanrooms.collaborations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual collaboration. +```sql +SELECT +region, +arn, +tags, +collaboration_identifier, +creator_display_name, +creator_member_abilities, +creator_ml_member_abilities, +data_encryption_metadata, +description, +members, +name, +query_log_status, +analytics_engine, +creator_payment_configuration +FROM aws.cleanrooms.collaborations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new collaboration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.collaborations ( + CreatorDisplayName, + CreatorMemberAbilities, + Description, + Members, + Name, + QueryLogStatus, + region +) +SELECT +'{{ CreatorDisplayName }}', + '{{ CreatorMemberAbilities }}', + '{{ Description }}', + '{{ Members }}', + '{{ Name }}', + '{{ QueryLogStatus }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.collaborations ( + Tags, + CreatorDisplayName, + CreatorMemberAbilities, + CreatorMLMemberAbilities, + DataEncryptionMetadata, + Description, + Members, + Name, + QueryLogStatus, + AnalyticsEngine, + CreatorPaymentConfiguration, + region +) +SELECT + '{{ Tags }}', + '{{ CreatorDisplayName }}', + '{{ CreatorMemberAbilities }}', + '{{ CreatorMLMemberAbilities }}', + '{{ DataEncryptionMetadata }}', + '{{ Description }}', + '{{ Members }}', + '{{ Name }}', + '{{ QueryLogStatus }}', + '{{ AnalyticsEngine }}', + '{{ CreatorPaymentConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: collaboration + props: + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CreatorDisplayName + value: '{{ CreatorDisplayName }}' + - name: CreatorMemberAbilities + value: + - '{{ CreatorMemberAbilities[0] }}' + - name: CreatorMLMemberAbilities + value: + CustomMLMemberAbilities: + - '{{ CustomMLMemberAbilities[0] }}' + - name: DataEncryptionMetadata + value: + AllowCleartext: '{{ AllowCleartext }}' + AllowDuplicates: '{{ AllowDuplicates }}' + AllowJoinsOnColumnsWithDifferentNames: '{{ AllowJoinsOnColumnsWithDifferentNames }}' + PreserveNulls: '{{ PreserveNulls }}' + - name: Description + value: '{{ Description }}' + - name: Members + value: + - AccountId: '{{ AccountId }}' + MemberAbilities: null + MLMemberAbilities: null + DisplayName: null + PaymentConfiguration: + QueryCompute: + IsResponsible: '{{ IsResponsible }}' + MachineLearning: + ModelTraining: + IsResponsible: '{{ IsResponsible }}' + ModelInference: + IsResponsible: '{{ IsResponsible }}' + - name: Name + value: '{{ Name }}' + - name: QueryLogStatus + value: '{{ QueryLogStatus }}' + - name: AnalyticsEngine + value: '{{ AnalyticsEngine }}' + - name: CreatorPaymentConfiguration + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cleanrooms.collaborations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +cleanrooms:ListCollaborations +``` diff --git a/website/docs/services/cleanrooms/collaborations_list_only/index.md b/website/docs/services/cleanrooms/collaborations_list_only/index.md new file mode 100644 index 0000000..2b6c4d2 --- /dev/null +++ b/website/docs/services/cleanrooms/collaborations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: collaborations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - collaborations_list_only + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists collaborations in a region or regions, for all properties use collaborations + +## Overview + + + + + + + +
Namecollaborations_list_only
TypeResource
DescriptionRepresents a collaboration between AWS accounts that allows for secure data collaboration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all collaborations in a region. +```sql +SELECT +region, +collaboration_identifier +FROM aws.cleanrooms.collaborations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collaborations_list_only resource, see collaborations + diff --git a/website/docs/services/cleanrooms/configured_table_association_tags/index.md b/website/docs/services/cleanrooms/configured_table_association_tags/index.md new file mode 100644 index 0000000..e5261b2 --- /dev/null +++ b/website/docs/services/cleanrooms/configured_table_association_tags/index.md @@ -0,0 +1,91 @@ +--- +title: configured_table_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configured_table_association_tags + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configured_table_associations in a region + +## Overview + + + + + + + +
Nameconfigured_table_association_tags
TypeResource
DescriptionRepresents a table that can be queried within a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configured_table_associations in a region. +```sql +SELECT +region, +arn, +configured_table_association_identifier, +configured_table_identifier, +description, +membership_identifier, +name, +role_arn, +configured_table_association_analysis_rules, +tag_key, +tag_value +FROM aws.cleanrooms.configured_table_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configured_table_association_tags resource, see configured_table_associations + diff --git a/website/docs/services/cleanrooms/configured_table_associations/index.md b/website/docs/services/cleanrooms/configured_table_associations/index.md new file mode 100644 index 0000000..524a175 --- /dev/null +++ b/website/docs/services/cleanrooms/configured_table_associations/index.md @@ -0,0 +1,279 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configured_table_association resource or lists configured_table_associations in a region + +## Overview + + + + + + + +
Nameconfigured_table_associations
TypeResource
DescriptionRepresents a table that can be queried within a collaboration
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
string
string
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::CleanRooms::ConfiguredTableAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configured_table_associations in a region. +```sql +SELECT +region, +arn, +tags, +configured_table_association_identifier, +configured_table_identifier, +description, +membership_identifier, +name, +role_arn, +configured_table_association_analysis_rules +FROM aws.cleanrooms.configured_table_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual configured_table_association. +```sql +SELECT +region, +arn, +tags, +configured_table_association_identifier, +configured_table_identifier, +description, +membership_identifier, +name, +role_arn, +configured_table_association_analysis_rules +FROM aws.cleanrooms.configured_table_associations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configured_table_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.configured_table_associations ( + ConfiguredTableIdentifier, + MembershipIdentifier, + Name, + RoleArn, + region +) +SELECT +'{{ ConfiguredTableIdentifier }}', + '{{ MembershipIdentifier }}', + '{{ Name }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.configured_table_associations ( + Tags, + ConfiguredTableIdentifier, + Description, + MembershipIdentifier, + Name, + RoleArn, + ConfiguredTableAssociationAnalysisRules, + region +) +SELECT + '{{ Tags }}', + '{{ ConfiguredTableIdentifier }}', + '{{ Description }}', + '{{ MembershipIdentifier }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ ConfiguredTableAssociationAnalysisRules }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configured_table_association + props: + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ConfiguredTableIdentifier + value: '{{ ConfiguredTableIdentifier }}' + - name: Description + value: '{{ Description }}' + - name: MembershipIdentifier + value: '{{ MembershipIdentifier }}' + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: ConfiguredTableAssociationAnalysisRules + value: + - Type: '{{ Type }}' + Policy: + V1: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cleanrooms.configured_table_associations +WHERE data__Identifier = '' +AND 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, +cleanrooms:DeleteConfiguredTableAssociation, +cleanrooms:DeleteConfiguredTableAssociationAnalysisRule, +cleanrooms:CreateConfiguredTableAssociationAnalysisRule, +cleanrooms:GetConfiguredTableAssociationAnalysisRule +``` + +### Read +```json +cleanrooms:GetConfiguredTableAssociation, +cleanrooms:ListTagsForResource, +cleanrooms:GetConfiguredTableAssociationAnalysisRule +``` + +### Update +```json +cleanrooms:UpdateConfiguredTableAssociation, +cleanrooms:GetConfiguredTableAssociation, +iam:PassRole, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:UntagResource, +cleanrooms:DeleteConfiguredTableAssociationAnalysisRule, +cleanrooms:CreateConfiguredTableAssociationAnalysisRule, +cleanrooms:GetConfiguredTableAssociationAnalysisRule, +cleanrooms:UpdateConfiguredTableAssociationAnalysisRule +``` + +### Delete +```json +cleanrooms:DeleteConfiguredTableAssociation, +cleanrooms:GetConfiguredTableAssociation, +cleanrooms:ListConfiguredTableAssociations, +cleanrooms:ListTagsForResource, +cleanrooms:UntagResource, +cleanrooms:DeleteConfiguredTableAssociationAnalysisRule, +cleanrooms:GetConfiguredTableAssociationAnalysisRule +``` + +### List +```json +cleanrooms:ListConfiguredTableAssociations +``` diff --git a/website/docs/services/cleanrooms/configured_table_associations_list_only/index.md b/website/docs/services/cleanrooms/configured_table_associations_list_only/index.md new file mode 100644 index 0000000..ee2e0dc --- /dev/null +++ b/website/docs/services/cleanrooms/configured_table_associations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: configured_table_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configured_table_associations_list_only + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configured_table_associations in a region or regions, for all properties use configured_table_associations + +## Overview + + + + + + + +
Nameconfigured_table_associations_list_only
TypeResource
DescriptionRepresents a table that can be queried within a collaboration
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configured_table_associations in a region. +```sql +SELECT +region, +configured_table_association_identifier, +membership_identifier +FROM aws.cleanrooms.configured_table_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configured_table_associations_list_only resource, see configured_table_associations + diff --git a/website/docs/services/cleanrooms/configured_table_tags/index.md b/website/docs/services/cleanrooms/configured_table_tags/index.md new file mode 100644 index 0000000..ca38a2e --- /dev/null +++ b/website/docs/services/cleanrooms/configured_table_tags/index.md @@ -0,0 +1,91 @@ +--- +title: configured_table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configured_table_tags + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configured_tables in a region + +## Overview + + + + + + + +
Nameconfigured_table_tags
TypeResource
DescriptionRepresents a table that can be associated with collaborations
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
string
string
string
string
array
undefined
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configured_tables in a region. +```sql +SELECT +region, +arn, +allowed_columns, +analysis_method, +configured_table_identifier, +description, +name, +analysis_rules, +table_reference, +tag_key, +tag_value +FROM aws.cleanrooms.configured_table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configured_table_tags resource, see configured_tables + diff --git a/website/docs/services/cleanrooms/configured_tables/index.md b/website/docs/services/cleanrooms/configured_tables/index.md new file mode 100644 index 0000000..4ef4cea --- /dev/null +++ b/website/docs/services/cleanrooms/configured_tables/index.md @@ -0,0 +1,303 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configured_table resource or lists configured_tables in a region + +## Overview + + + + + + + +
Nameconfigured_tables
TypeResource
DescriptionRepresents a table that can be associated with collaborations
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
array
string
string
string
string
array
undefined
stringAWS region.
+ +For more information, see AWS::CleanRooms::ConfiguredTable. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configured_tables in a region. +```sql +SELECT +region, +arn, +tags, +allowed_columns, +analysis_method, +configured_table_identifier, +description, +name, +analysis_rules, +table_reference +FROM aws.cleanrooms.configured_tables +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual configured_table. +```sql +SELECT +region, +arn, +tags, +allowed_columns, +analysis_method, +configured_table_identifier, +description, +name, +analysis_rules, +table_reference +FROM aws.cleanrooms.configured_tables +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configured_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.configured_tables ( + AllowedColumns, + AnalysisMethod, + Name, + TableReference, + region +) +SELECT +'{{ AllowedColumns }}', + '{{ AnalysisMethod }}', + '{{ Name }}', + '{{ TableReference }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.configured_tables ( + Tags, + AllowedColumns, + AnalysisMethod, + Description, + Name, + AnalysisRules, + TableReference, + region +) +SELECT + '{{ Tags }}', + '{{ AllowedColumns }}', + '{{ AnalysisMethod }}', + '{{ Description }}', + '{{ Name }}', + '{{ AnalysisRules }}', + '{{ TableReference }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configured_table + props: + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AllowedColumns + value: + - '{{ AllowedColumns[0] }}' + - name: AnalysisMethod + value: '{{ AnalysisMethod }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: AnalysisRules + value: + - Type: '{{ Type }}' + Policy: + V1: null + - name: TableReference + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cleanrooms.configured_tables +WHERE data__Identifier = '' +AND 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, +athena:GetTableMetadata +``` + +### 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 +``` + +### List +```json +cleanrooms:ListConfiguredTables +``` diff --git a/website/docs/services/cleanrooms/configured_tables_list_only/index.md b/website/docs/services/cleanrooms/configured_tables_list_only/index.md new file mode 100644 index 0000000..9c28aa2 --- /dev/null +++ b/website/docs/services/cleanrooms/configured_tables_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: configured_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configured_tables_list_only + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configured_tables in a region or regions, for all properties use configured_tables + +## Overview + + + + + + + +
Nameconfigured_tables_list_only
TypeResource
DescriptionRepresents a table that can be associated with collaborations
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configured_tables in a region. +```sql +SELECT +region, +configured_table_identifier +FROM aws.cleanrooms.configured_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configured_tables_list_only resource, see configured_tables + diff --git a/website/docs/services/cleanrooms/id_mapping_table_tags/index.md b/website/docs/services/cleanrooms/id_mapping_table_tags/index.md new file mode 100644 index 0000000..29e68a7 --- /dev/null +++ b/website/docs/services/cleanrooms/id_mapping_table_tags/index.md @@ -0,0 +1,97 @@ +--- +title: id_mapping_table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - id_mapping_table_tags + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for id_mapping_tables in a region + +## Overview + + + + + + + +
Nameid_mapping_table_tags
TypeResource
DescriptionRepresents an association between an ID mapping workflow and a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all id_mapping_tables in a region. +```sql +SELECT +region, +id_mapping_table_identifier, +arn, +input_reference_config, +membership_identifier, +membership_arn, +collaboration_identifier, +collaboration_arn, +description, +name, +input_reference_properties, +kms_key_arn, +tag_key, +tag_value +FROM aws.cleanrooms.id_mapping_table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_mapping_table_tags resource, see id_mapping_tables + diff --git a/website/docs/services/cleanrooms/id_mapping_tables/index.md b/website/docs/services/cleanrooms/id_mapping_tables/index.md new file mode 100644 index 0000000..3482127 --- /dev/null +++ b/website/docs/services/cleanrooms/id_mapping_tables/index.md @@ -0,0 +1,283 @@ +--- +title: id_mapping_tables +hide_title: false +hide_table_of_contents: false +keywords: + - id_mapping_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an id_mapping_table resource or lists id_mapping_tables in a region + +## Overview + + + + + + + +
Nameid_mapping_tables
TypeResource
DescriptionRepresents an association between an ID mapping workflow and a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
string
object
string
array
stringAWS region.
+ +For more information, see AWS::CleanRooms::IdMappingTable. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all id_mapping_tables in a region. +```sql +SELECT +region, +id_mapping_table_identifier, +arn, +input_reference_config, +membership_identifier, +membership_arn, +collaboration_identifier, +collaboration_arn, +description, +name, +input_reference_properties, +kms_key_arn, +tags +FROM aws.cleanrooms.id_mapping_tables +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual id_mapping_table. +```sql +SELECT +region, +id_mapping_table_identifier, +arn, +input_reference_config, +membership_identifier, +membership_arn, +collaboration_identifier, +collaboration_arn, +description, +name, +input_reference_properties, +kms_key_arn, +tags +FROM aws.cleanrooms.id_mapping_tables +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new id_mapping_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.id_mapping_tables ( + InputReferenceConfig, + MembershipIdentifier, + Name, + region +) +SELECT +'{{ InputReferenceConfig }}', + '{{ MembershipIdentifier }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.id_mapping_tables ( + InputReferenceConfig, + MembershipIdentifier, + Description, + Name, + KmsKeyArn, + Tags, + region +) +SELECT + '{{ InputReferenceConfig }}', + '{{ MembershipIdentifier }}', + '{{ Description }}', + '{{ Name }}', + '{{ KmsKeyArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: id_mapping_table + props: + - name: InputReferenceConfig + value: + InputReferenceArn: '{{ InputReferenceArn }}' + ManageResourcePolicies: '{{ ManageResourcePolicies }}' + - name: MembershipIdentifier + value: '{{ MembershipIdentifier }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cleanrooms.id_mapping_tables +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the id_mapping_tables resource, the following permissions are required: + +### Create +```json +cleanrooms:CreateIdMappingTable, +cleanrooms:GetIdMappingTable, +cleanrooms:ListIdMappingTables, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:GetMembership, +cleanrooms:GetCollaboration, +entityresolution:GetIdMappingWorkflow, +entityresolution:AddPolicyStatement +``` + +### Read +```json +cleanrooms:GetIdMappingTable, +cleanrooms:ListTagsForResource, +cleanrooms:GetMembership, +cleanrooms:GetCollaboration +``` + +### Update +```json +cleanrooms:UpdateIdMappingTable, +cleanrooms:GetIdMappingTable, +cleanrooms:GetMembership, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:UntagResource, +entityresolution:GetIdMappingWorkflow, +entityresolution:AddPolicyStatement +``` + +### Delete +```json +cleanrooms:DeleteIdMappingTable, +cleanrooms:GetIdMappingTable, +cleanrooms:ListIdMappingTables, +cleanrooms:GetMembership, +cleanrooms:ListTagsForResource, +cleanrooms:UntagResource, +entityresolution:GetIdMappingWorkflow, +entityresolution:AddPolicyStatement, +entityresolution:DeletePolicyStatement +``` + +### List +```json +cleanrooms:ListIdMappingTables, +cleanrooms:GetMembership, +cleanrooms:GetCollaboration +``` diff --git a/website/docs/services/cleanrooms/id_mapping_tables_list_only/index.md b/website/docs/services/cleanrooms/id_mapping_tables_list_only/index.md new file mode 100644 index 0000000..02f63ec --- /dev/null +++ b/website/docs/services/cleanrooms/id_mapping_tables_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: id_mapping_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - id_mapping_tables_list_only + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists id_mapping_tables in a region or regions, for all properties use id_mapping_tables + +## Overview + + + + + + + +
Nameid_mapping_tables_list_only
TypeResource
DescriptionRepresents an association between an ID mapping workflow and a collaboration
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all id_mapping_tables in a region. +```sql +SELECT +region, +id_mapping_table_identifier, +membership_identifier +FROM aws.cleanrooms.id_mapping_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_mapping_tables_list_only resource, see id_mapping_tables + diff --git a/website/docs/services/cleanrooms/id_namespace_association_tags/index.md b/website/docs/services/cleanrooms/id_namespace_association_tags/index.md new file mode 100644 index 0000000..c455de0 --- /dev/null +++ b/website/docs/services/cleanrooms/id_namespace_association_tags/index.md @@ -0,0 +1,97 @@ +--- +title: id_namespace_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - id_namespace_association_tags + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for id_namespace_associations in a region + +## Overview + + + + + + + +
Nameid_namespace_association_tags
TypeResource
DescriptionRepresents an association between an ID namespace and a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
string
string
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all id_namespace_associations in a region. +```sql +SELECT +region, +id_namespace_association_identifier, +arn, +membership_identifier, +membership_arn, +collaboration_identifier, +collaboration_arn, +input_reference_config, +name, +description, +id_mapping_config, +input_reference_properties, +tag_key, +tag_value +FROM aws.cleanrooms.id_namespace_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_namespace_association_tags resource, see id_namespace_associations + diff --git a/website/docs/services/cleanrooms/id_namespace_associations/index.md b/website/docs/services/cleanrooms/id_namespace_associations/index.md new file mode 100644 index 0000000..ee4dbae --- /dev/null +++ b/website/docs/services/cleanrooms/id_namespace_associations/index.md @@ -0,0 +1,286 @@ +--- +title: id_namespace_associations +hide_title: false +hide_table_of_contents: false +keywords: + - id_namespace_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an id_namespace_association resource or lists id_namespace_associations in a region + +## Overview + + + + + + + +
Nameid_namespace_associations
TypeResource
DescriptionRepresents an association between an ID namespace and a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
array
string
string
object
object
stringAWS region.
+ +For more information, see AWS::CleanRooms::IdNamespaceAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all id_namespace_associations in a region. +```sql +SELECT +region, +id_namespace_association_identifier, +arn, +membership_identifier, +membership_arn, +collaboration_identifier, +collaboration_arn, +input_reference_config, +tags, +name, +description, +id_mapping_config, +input_reference_properties +FROM aws.cleanrooms.id_namespace_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual id_namespace_association. +```sql +SELECT +region, +id_namespace_association_identifier, +arn, +membership_identifier, +membership_arn, +collaboration_identifier, +collaboration_arn, +input_reference_config, +tags, +name, +description, +id_mapping_config, +input_reference_properties +FROM aws.cleanrooms.id_namespace_associations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new id_namespace_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.id_namespace_associations ( + MembershipIdentifier, + InputReferenceConfig, + Name, + region +) +SELECT +'{{ MembershipIdentifier }}', + '{{ InputReferenceConfig }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.id_namespace_associations ( + MembershipIdentifier, + InputReferenceConfig, + Tags, + Name, + Description, + IdMappingConfig, + region +) +SELECT + '{{ MembershipIdentifier }}', + '{{ InputReferenceConfig }}', + '{{ Tags }}', + '{{ Name }}', + '{{ Description }}', + '{{ IdMappingConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: id_namespace_association + props: + - name: MembershipIdentifier + value: '{{ MembershipIdentifier }}' + - name: InputReferenceConfig + value: + InputReferenceArn: '{{ InputReferenceArn }}' + ManageResourcePolicies: '{{ ManageResourcePolicies }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: IdMappingConfig + value: + AllowUseAsDimensionColumn: '{{ AllowUseAsDimensionColumn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cleanrooms.id_namespace_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the id_namespace_associations resource, the following permissions are required: + +### Create +```json +cleanrooms:CreateIdNamespaceAssociation, +cleanrooms:GetIdNamespaceAssociation, +cleanrooms:ListIdNamespaceAssociations, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:GetMembership, +cleanrooms:GetCollaboration, +entityresolution:GetIdNamespace, +entityresolution:AddPolicyStatement +``` + +### Read +```json +cleanrooms:GetIdNamespaceAssociation, +cleanrooms:ListTagsForResource, +cleanrooms:GetMembership, +cleanrooms:GetCollaboration, +entityresolution:GetIdNamespace +``` + +### Update +```json +cleanrooms:UpdateIdNamespaceAssociation, +cleanrooms:GetIdNamespaceAssociation, +cleanrooms:GetMembership, +cleanrooms:GetCollaboration, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:UntagResource, +entityresolution:GetIdNamespace, +entityresolution:AddPolicyStatement +``` + +### Delete +```json +cleanrooms:DeleteIdNamespaceAssociation, +cleanrooms:GetIdNamespaceAssociation, +cleanrooms:ListIdNamespaceAssociations, +cleanrooms:GetMembership, +cleanrooms:GetCollaboration, +cleanrooms:ListTagsForResource, +cleanrooms:UntagResource, +entityresolution:GetIdNamespace, +entityresolution:DeletePolicyStatement +``` + +### List +```json +cleanrooms:ListIdNamespaceAssociations, +cleanrooms:GetMembership, +cleanrooms:GetCollaboration +``` diff --git a/website/docs/services/cleanrooms/id_namespace_associations_list_only/index.md b/website/docs/services/cleanrooms/id_namespace_associations_list_only/index.md new file mode 100644 index 0000000..43dc9ed --- /dev/null +++ b/website/docs/services/cleanrooms/id_namespace_associations_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: id_namespace_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - id_namespace_associations_list_only + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists id_namespace_associations in a region or regions, for all properties use id_namespace_associations + +## Overview + + + + + + + +
Nameid_namespace_associations_list_only
TypeResource
DescriptionRepresents an association between an ID namespace and a collaboration
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all id_namespace_associations in a region. +```sql +SELECT +region, +id_namespace_association_identifier, +membership_identifier +FROM aws.cleanrooms.id_namespace_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_namespace_associations_list_only resource, see id_namespace_associations + diff --git a/website/docs/services/cleanrooms/index.md b/website/docs/services/cleanrooms/index.md new file mode 100644 index 0000000..9ce59b6 --- /dev/null +++ b/website/docs/services/cleanrooms/index.md @@ -0,0 +1,59 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cleanrooms service documentation. + +:::info Service Summary + +
+
+total resources: 24
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cleanrooms/membership_tags/index.md b/website/docs/services/cleanrooms/membership_tags/index.md new file mode 100644 index 0000000..252c5d0 --- /dev/null +++ b/website/docs/services/cleanrooms/membership_tags/index.md @@ -0,0 +1,91 @@ +--- +title: membership_tags +hide_title: false +hide_table_of_contents: false +keywords: + - membership_tags + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for memberships in a region + +## Overview + + + + + + + +
Namemembership_tags
TypeResource
DescriptionRepresents an AWS account that is a part of a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all memberships in a region. +```sql +SELECT +region, +arn, +collaboration_arn, +collaboration_creator_account_id, +collaboration_identifier, +membership_identifier, +query_log_status, +default_result_configuration, +payment_configuration, +tag_key, +tag_value +FROM aws.cleanrooms.membership_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the membership_tags resource, see memberships + diff --git a/website/docs/services/cleanrooms/memberships/index.md b/website/docs/services/cleanrooms/memberships/index.md new file mode 100644 index 0000000..c3ddd35 --- /dev/null +++ b/website/docs/services/cleanrooms/memberships/index.md @@ -0,0 +1,292 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a membership resource or lists memberships in a region + +## Overview + + + + + + + +
Namememberships
TypeResource
DescriptionRepresents an AWS account that is a part of a collaboration
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms membership.
string
string
string
string
string
object
object
stringAWS region.
+ +For more information, see AWS::CleanRooms::Membership. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all memberships in a region. +```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.memberships +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual membership. +```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.memberships +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new membership resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.memberships ( + CollaborationIdentifier, + QueryLogStatus, + region +) +SELECT +'{{ CollaborationIdentifier }}', + '{{ QueryLogStatus }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.memberships ( + Tags, + CollaborationIdentifier, + QueryLogStatus, + DefaultResultConfiguration, + PaymentConfiguration, + region +) +SELECT + '{{ Tags }}', + '{{ CollaborationIdentifier }}', + '{{ QueryLogStatus }}', + '{{ DefaultResultConfiguration }}', + '{{ PaymentConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: membership + props: + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CollaborationIdentifier + value: '{{ CollaborationIdentifier }}' + - name: QueryLogStatus + value: '{{ QueryLogStatus }}' + - name: DefaultResultConfiguration + value: + OutputConfiguration: + S3: + ResultFormat: '{{ ResultFormat }}' + Bucket: '{{ Bucket }}' + KeyPrefix: '{{ KeyPrefix }}' + SingleFileOutput: '{{ SingleFileOutput }}' + RoleArn: '{{ RoleArn }}' + - name: PaymentConfiguration + value: + QueryCompute: + IsResponsible: '{{ IsResponsible }}' + MachineLearning: + ModelTraining: + IsResponsible: '{{ IsResponsible }}' + ModelInference: + IsResponsible: '{{ IsResponsible }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cleanrooms.memberships +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +cleanrooms:ListMemberships +``` diff --git a/website/docs/services/cleanrooms/memberships_list_only/index.md b/website/docs/services/cleanrooms/memberships_list_only/index.md new file mode 100644 index 0000000..d2b6928 --- /dev/null +++ b/website/docs/services/cleanrooms/memberships_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: memberships_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - memberships_list_only + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists memberships in a region or regions, for all properties use memberships + +## Overview + + + + + + + +
Namememberships_list_only
TypeResource
DescriptionRepresents an AWS account that is a part of a collaboration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all memberships in a region. +```sql +SELECT +region, +membership_identifier +FROM aws.cleanrooms.memberships_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the memberships_list_only resource, see memberships + diff --git a/website/docs/services/cleanrooms/privacy_budget_template_tags/index.md b/website/docs/services/cleanrooms/privacy_budget_template_tags/index.md new file mode 100644 index 0000000..b8a9b33 --- /dev/null +++ b/website/docs/services/cleanrooms/privacy_budget_template_tags/index.md @@ -0,0 +1,93 @@ +--- +title: privacy_budget_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - privacy_budget_template_tags + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for privacy_budget_templates in a region + +## Overview + + + + + + + +
Nameprivacy_budget_template_tags
TypeResource
DescriptionRepresents a privacy budget within a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all privacy_budget_templates in a region. +```sql +SELECT +region, +arn, +collaboration_arn, +collaboration_identifier, +privacy_budget_template_identifier, +auto_refresh, +privacy_budget_type, +parameters, +membership_arn, +membership_identifier, +tag_key, +tag_value +FROM aws.cleanrooms.privacy_budget_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the privacy_budget_template_tags resource, see privacy_budget_templates + diff --git a/website/docs/services/cleanrooms/privacy_budget_templates/index.md b/website/docs/services/cleanrooms/privacy_budget_templates/index.md new file mode 100644 index 0000000..83011a4 --- /dev/null +++ b/website/docs/services/cleanrooms/privacy_budget_templates/index.md @@ -0,0 +1,260 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a privacy_budget_template resource or lists privacy_budget_templates in a region + +## Overview + + + + + + + +
Nameprivacy_budget_templates
TypeResource
DescriptionRepresents a privacy budget within a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
string
string
object
string
string
stringAWS region.
+ +For more information, see AWS::CleanRooms::PrivacyBudgetTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all privacy_budget_templates in a region. +```sql +SELECT +region, +arn, +collaboration_arn, +collaboration_identifier, +privacy_budget_template_identifier, +tags, +auto_refresh, +privacy_budget_type, +parameters, +membership_arn, +membership_identifier +FROM aws.cleanrooms.privacy_budget_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual privacy_budget_template. +```sql +SELECT +region, +arn, +collaboration_arn, +collaboration_identifier, +privacy_budget_template_identifier, +tags, +auto_refresh, +privacy_budget_type, +parameters, +membership_arn, +membership_identifier +FROM aws.cleanrooms.privacy_budget_templates +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new privacy_budget_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.privacy_budget_templates ( + AutoRefresh, + PrivacyBudgetType, + Parameters, + MembershipIdentifier, + region +) +SELECT +'{{ AutoRefresh }}', + '{{ PrivacyBudgetType }}', + '{{ Parameters }}', + '{{ MembershipIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cleanrooms.privacy_budget_templates ( + Tags, + AutoRefresh, + PrivacyBudgetType, + Parameters, + MembershipIdentifier, + region +) +SELECT + '{{ Tags }}', + '{{ AutoRefresh }}', + '{{ PrivacyBudgetType }}', + '{{ Parameters }}', + '{{ MembershipIdentifier }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: privacy_budget_template + props: + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AutoRefresh + value: '{{ AutoRefresh }}' + - name: PrivacyBudgetType + value: '{{ PrivacyBudgetType }}' + - name: Parameters + value: + Epsilon: '{{ Epsilon }}' + UsersNoisePerQuery: '{{ UsersNoisePerQuery }}' + - name: MembershipIdentifier + value: '{{ MembershipIdentifier }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cleanrooms.privacy_budget_templates +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +cleanrooms:ListPrivacyBudgetTemplates +``` diff --git a/website/docs/services/cleanrooms/privacy_budget_templates_list_only/index.md b/website/docs/services/cleanrooms/privacy_budget_templates_list_only/index.md new file mode 100644 index 0000000..1812532 --- /dev/null +++ b/website/docs/services/cleanrooms/privacy_budget_templates_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: privacy_budget_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - privacy_budget_templates_list_only + - cleanrooms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists privacy_budget_templates in a region or regions, for all properties use privacy_budget_templates + +## Overview + + + + + + + +
Nameprivacy_budget_templates_list_only
TypeResource
DescriptionRepresents a privacy budget within a collaboration
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all privacy_budget_templates in a region. +```sql +SELECT +region, +privacy_budget_template_identifier, +membership_identifier +FROM aws.cleanrooms.privacy_budget_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the privacy_budget_templates_list_only resource, see privacy_budget_templates + diff --git a/website/docs/services/cleanroomsml/index.md b/website/docs/services/cleanroomsml/index.md new file mode 100644 index 0000000..b69b3c2 --- /dev/null +++ b/website/docs/services/cleanroomsml/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cleanroomsml service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cleanroomsml/training_dataset_tags/index.md b/website/docs/services/cleanroomsml/training_dataset_tags/index.md new file mode 100644 index 0000000..a5cc124 --- /dev/null +++ b/website/docs/services/cleanroomsml/training_dataset_tags/index.md @@ -0,0 +1,87 @@ +--- +title: training_dataset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - training_dataset_tags + - cleanroomsml + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for training_datasets in a region + +## Overview + + + + + + + +
Nametraining_dataset_tags
TypeResource
DescriptionDefinition of AWS::CleanRoomsML::TrainingDataset Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all training_datasets in a region. +```sql +SELECT +region, +description, +name, +role_arn, +training_data, +training_dataset_arn, +status, +tag_key, +tag_value +FROM aws.cleanroomsml.training_dataset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the training_dataset_tags resource, see training_datasets + diff --git a/website/docs/services/cleanroomsml/training_datasets/index.md b/website/docs/services/cleanroomsml/training_datasets/index.md new file mode 100644 index 0000000..44400ca --- /dev/null +++ b/website/docs/services/cleanroomsml/training_datasets/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a training_dataset resource or lists training_datasets in a region + +## Overview + + + + + + + +
Nametraining_datasets
TypeResource
DescriptionDefinition of AWS::CleanRoomsML::TrainingDataset Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset.
array
string
string
stringAWS region.
+ +For more information, see AWS::CleanRoomsML::TrainingDataset. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all training_datasets in a region. +```sql +SELECT +region, +description, +name, +role_arn, +tags, +training_data, +training_dataset_arn, +status +FROM aws.cleanroomsml.training_datasets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual training_dataset. +```sql +SELECT +region, +description, +name, +role_arn, +tags, +training_data, +training_dataset_arn, +status +FROM aws.cleanroomsml.training_datasets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new training_dataset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cleanroomsml.training_datasets ( + Name, + RoleArn, + TrainingData, + region +) +SELECT +'{{ Name }}', + '{{ RoleArn }}', + '{{ TrainingData }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cleanroomsml.training_datasets ( + Description, + Name, + RoleArn, + Tags, + TrainingData, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ TrainingData }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: training_dataset + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TrainingData + value: + - Type: '{{ Type }}' + InputConfig: + Schema: + - ColumnName: '{{ ColumnName }}' + ColumnTypes: + - '{{ ColumnTypes[0] }}' + DataSource: + GlueDataSource: + TableName: '{{ TableName }}' + DatabaseName: '{{ DatabaseName }}' + CatalogId: '{{ CatalogId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cleanroomsml.training_datasets +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cleanrooms-ml:GetTrainingDataset +``` + +### Delete +```json +cleanrooms-ml:DeleteTrainingDataset +``` + +### List +```json +cleanrooms-ml:ListTrainingDatasets +``` + +### Update +```json +cleanrooms-ml:TagResource, +cleanrooms-ml:UntagResource +``` diff --git a/website/docs/services/cleanroomsml/training_datasets_list_only/index.md b/website/docs/services/cleanroomsml/training_datasets_list_only/index.md new file mode 100644 index 0000000..b2bb208 --- /dev/null +++ b/website/docs/services/cleanroomsml/training_datasets_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: training_datasets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - training_datasets_list_only + - cleanroomsml + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists training_datasets in a region or regions, for all properties use training_datasets + +## Overview + + + + + + + +
Nametraining_datasets_list_only
TypeResource
DescriptionDefinition of AWS::CleanRoomsML::TrainingDataset Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all training_datasets in a region. +```sql +SELECT +region, +training_dataset_arn +FROM aws.cleanroomsml.training_datasets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the training_datasets_list_only resource, see training_datasets + diff --git a/website/docs/services/cloud_control/index.md b/website/docs/services/cloud_control/index.md new file mode 100644 index 0000000..1905329 --- /dev/null +++ b/website/docs/services/cloud_control/index.md @@ -0,0 +1,39 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cloud_control service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cloud_control/resource/index.md b/website/docs/services/cloud_control/resource/index.md new file mode 100644 index 0000000..911ecd7 --- /dev/null +++ b/website/docs/services/cloud_control/resource/index.md @@ -0,0 +1,64 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Represents information about a provisioned resource. + +## Overview + + + + + + + +
Nameresource
TypeResource
DescriptionRepresents information about a provisioned resource.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ + + + + + diff --git a/website/docs/services/cloud_control/resource_request/index.md b/website/docs/services/cloud_control/resource_request/index.md new file mode 100644 index 0000000..f83b12b --- /dev/null +++ b/website/docs/services/cloud_control/resource_request/index.md @@ -0,0 +1,72 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide. + +## Overview + + + + + + + +
Nameresource_request
TypeResource
Descriptionresource_request
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
number
string
string
string
string
string
number
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ + + + + + diff --git a/website/docs/services/cloud_control/resource_requests/index.md b/website/docs/services/cloud_control/resource_requests/index.md new file mode 100644 index 0000000..de399ad --- /dev/null +++ b/website/docs/services/cloud_control/resource_requests/index.md @@ -0,0 +1,67 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide. + +## Overview + + + + + + + +
Nameresource_requests
TypeResource
Descriptionresource_requests
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
DELETE
+ + + + + + diff --git a/website/docs/services/cloud_control/resources/index.md b/website/docs/services/cloud_control/resources/index.md new file mode 100644 index 0000000..469b5e7 --- /dev/null +++ b/website/docs/services/cloud_control/resources/index.md @@ -0,0 +1,77 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide. + +## Overview + + + + + + + +
Nameresources
TypeResource
Descriptionresources
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
INSERT
DELETE
UPDATE
+ + + + + + diff --git a/website/docs/services/cloudformation/guard_hooks/index.md b/website/docs/services/cloudformation/guard_hooks/index.md new file mode 100644 index 0000000..1bf8508 --- /dev/null +++ b/website/docs/services/cloudformation/guard_hooks/index.md @@ -0,0 +1,298 @@ +--- +title: guard_hooks +hide_title: false +hide_table_of_contents: false +keywords: + - guard_hooks + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a guard_hook resource or lists guard_hooks in a region + +## Overview + + + + + + + +
Nameguard_hooks
TypeResource
DescriptionThis is a CloudFormation resource for activating the first-party AWS::Hooks::GuardHook.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectS3 Source Location for the Guard files.
stringS3 Bucket where the guard validate report will be uploaded to
stringAttribute to specify which stacks this hook applies to or should get invoked for
arrayWhich operations should this Hook run against? Resource changes, stacks or change sets.
stringAttribute to specify CloudFormation behavior on hook failure.
objectAttribute to specify which targets should invoke the hook
objectFilters to allow hooks to target specific stack attributes
stringThe typename alias for the hook.
stringThe Amazon Resource Name (ARN) of the activated hook
stringThe execution role ARN assumed by hooks to read Guard rules from S3 and write Guard outputs to S3.
stringAWS region.
+ +For more information, see AWS::CloudFormation::GuardHook. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all guard_hooks in a region. +```sql +SELECT +region, +rule_location, +log_bucket, +hook_status, +target_operations, +failure_mode, +target_filters, +stack_filters, +alias, +hook_arn, +execution_role, +options +FROM aws.cloudformation.guard_hooks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual guard_hook. +```sql +SELECT +region, +rule_location, +log_bucket, +hook_status, +target_operations, +failure_mode, +target_filters, +stack_filters, +alias, +hook_arn, +execution_role, +options +FROM aws.cloudformation.guard_hooks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new guard_hook resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.guard_hooks ( + RuleLocation, + HookStatus, + TargetOperations, + FailureMode, + Alias, + ExecutionRole, + region +) +SELECT +'{{ RuleLocation }}', + '{{ HookStatus }}', + '{{ TargetOperations }}', + '{{ FailureMode }}', + '{{ Alias }}', + '{{ ExecutionRole }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.guard_hooks ( + RuleLocation, + LogBucket, + HookStatus, + TargetOperations, + FailureMode, + TargetFilters, + StackFilters, + Alias, + ExecutionRole, + Options, + region +) +SELECT + '{{ RuleLocation }}', + '{{ LogBucket }}', + '{{ HookStatus }}', + '{{ TargetOperations }}', + '{{ FailureMode }}', + '{{ TargetFilters }}', + '{{ StackFilters }}', + '{{ Alias }}', + '{{ ExecutionRole }}', + '{{ Options }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: guard_hook + props: + - name: RuleLocation + value: + Uri: '{{ Uri }}' + VersionId: '{{ VersionId }}' + - name: LogBucket + value: '{{ LogBucket }}' + - name: HookStatus + value: '{{ HookStatus }}' + - name: TargetOperations + value: + - '{{ TargetOperations[0] }}' + - name: FailureMode + value: '{{ FailureMode }}' + - name: TargetFilters + value: {} + - name: StackFilters + value: + FilteringCriteria: '{{ FilteringCriteria }}' + StackNames: + Include: + - '{{ Include[0] }}' + Exclude: + - null + StackRoles: + Include: + - '{{ Include[0] }}' + Exclude: + - null + - name: Alias + value: '{{ Alias }}' + - name: ExecutionRole + value: null + - name: Options + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudformation.guard_hooks +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the guard_hooks resource, the following permissions are required: + +### Create +```json +cloudformation:ActivateType, +cloudformation:DescribeType, +cloudformation:ListTypes, +cloudformation:SetTypeConfiguration, +cloudformation:BatchDescribeTypeConfigurations, +iam:PassRole +``` + +### Read +```json +cloudformation:DescribeType, +cloudformation:BatchDescribeTypeConfigurations +``` + +### Update +```json +cloudformation:BatchDescribeTypeConfigurations, +cloudformation:DescribeType, +cloudformation:SetTypeConfiguration, +iam:PassRole +``` + +### Delete +```json +cloudformation:BatchDescribeTypeConfigurations, +cloudformation:DescribeType, +cloudformation:DeactivateType, +cloudformation:SetTypeConfiguration +``` + +### List +```json +cloudformation:ListTypes, +cloudformation:DescribeType, +cloudformation:BatchDescribeTypeConfigurations +``` diff --git a/website/docs/services/cloudformation/guard_hooks_list_only/index.md b/website/docs/services/cloudformation/guard_hooks_list_only/index.md new file mode 100644 index 0000000..968a365 --- /dev/null +++ b/website/docs/services/cloudformation/guard_hooks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: guard_hooks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - guard_hooks_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists guard_hooks in a region or regions, for all properties use guard_hooks + +## Overview + + + + + + + +
Nameguard_hooks_list_only
TypeResource
DescriptionThis is a CloudFormation resource for activating the first-party AWS::Hooks::GuardHook.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the activated hook
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all guard_hooks in a region. +```sql +SELECT +region, +hook_arn +FROM aws.cloudformation.guard_hooks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the guard_hooks_list_only resource, see guard_hooks + diff --git a/website/docs/services/cloudformation/hook_default_versions/index.md b/website/docs/services/cloudformation/hook_default_versions/index.md new file mode 100644 index 0000000..7ba0e4b --- /dev/null +++ b/website/docs/services/cloudformation/hook_default_versions/index.md @@ -0,0 +1,196 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a hook_default_version resource or lists hook_default_versions in a region + +## Overview + + + + + + + +
Namehook_default_versions
TypeResource
DescriptionSet a version as default version for a hook in CloudFormation Registry.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type version.
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion
stringThe ID of an existing version of the hook to set as the default.
stringAWS region.
+ +For more information, see AWS::CloudFormation::HookDefaultVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all hook_default_versions in a region. +```sql +SELECT +region, +type_version_arn, +type_name, +arn, +version_id +FROM aws.cloudformation.hook_default_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual hook_default_version. +```sql +SELECT +region, +type_version_arn, +type_name, +arn, +version_id +FROM aws.cloudformation.hook_default_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new hook_default_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.hook_default_versions ( + TypeVersionArn, + TypeName, + VersionId, + region +) +SELECT +'{{ TypeVersionArn }}', + '{{ TypeName }}', + '{{ VersionId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.hook_default_versions ( + TypeVersionArn, + TypeName, + VersionId, + region +) +SELECT + '{{ TypeVersionArn }}', + '{{ TypeName }}', + '{{ VersionId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: hook_default_version + props: + - name: TypeVersionArn + value: '{{ TypeVersionArn }}' + - name: TypeName + value: '{{ TypeName }}' + - name: VersionId + value: '{{ VersionId }}' + +``` + + + +## Permissions + +To operate on the hook_default_versions resource, the following permissions are required: + +### Create +```json +cloudformation:SetTypeDefaultVersion +``` + +### Read +```json +cloudformation:DescribeType +``` + +### Update +```json +cloudformation:SetTypeDefaultVersion +``` + +### List +```json +cloudformation:ListTypes +``` diff --git a/website/docs/services/cloudformation/hook_default_versions_list_only/index.md b/website/docs/services/cloudformation/hook_default_versions_list_only/index.md new file mode 100644 index 0000000..89f5ca9 --- /dev/null +++ b/website/docs/services/cloudformation/hook_default_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: hook_default_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hook_default_versions_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hook_default_versions in a region or regions, for all properties use hook_default_versions + +## Overview + + + + + + + +
Namehook_default_versions_list_only
TypeResource
DescriptionSet a version as default version for a hook in CloudFormation Registry.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hook_default_versions in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.hook_default_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hook_default_versions_list_only resource, see hook_default_versions + diff --git a/website/docs/services/cloudformation/hook_type_configs/index.md b/website/docs/services/cloudformation/hook_type_configs/index.md new file mode 100644 index 0000000..4053c5b --- /dev/null +++ b/website/docs/services/cloudformation/hook_type_configs/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a hook_type_config resource or lists hook_type_configs in a region + +## Overview + + + + + + + +
Namehook_type_configs
TypeResource
DescriptionSpecifies the configuration data for a registered hook in CloudFormation Registry.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type without version number.
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe Amazon Resource Name (ARN) for the configuration data, in this account and region.
stringThe configuration data for the extension, in this account and region.
stringAn alias by which to refer to this extension configuration data.
stringAWS region.
+ +For more information, see AWS::CloudFormation::HookTypeConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all hook_type_configs in a region. +```sql +SELECT +region, +type_arn, +type_name, +configuration_arn, +configuration, +configuration_alias +FROM aws.cloudformation.hook_type_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual hook_type_config. +```sql +SELECT +region, +type_arn, +type_name, +configuration_arn, +configuration, +configuration_alias +FROM aws.cloudformation.hook_type_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new hook_type_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.hook_type_configs ( + TypeArn, + TypeName, + Configuration, + ConfigurationAlias, + region +) +SELECT +'{{ TypeArn }}', + '{{ TypeName }}', + '{{ Configuration }}', + '{{ ConfigurationAlias }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.hook_type_configs ( + TypeArn, + TypeName, + Configuration, + ConfigurationAlias, + region +) +SELECT + '{{ TypeArn }}', + '{{ TypeName }}', + '{{ Configuration }}', + '{{ ConfigurationAlias }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: hook_type_config + props: + - name: TypeArn + value: '{{ TypeArn }}' + - name: TypeName + value: '{{ TypeName }}' + - name: Configuration + value: '{{ Configuration }}' + - name: ConfigurationAlias + value: '{{ ConfigurationAlias }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudformation.hook_type_configs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the hook_type_configs resource, the following permissions are required: + +### Create +```json +cloudformation:SetTypeConfiguration +``` + +### Read +```json +cloudformation:BatchDescribeTypeConfigurations +``` + +### Update +```json +cloudformation:SetTypeConfiguration +``` + +### Delete +```json +cloudformation:SetTypeConfiguration +``` + +### List +```json +cloudformation:ListTypes, +cloudformation:BatchDescribeTypeConfigurations +``` diff --git a/website/docs/services/cloudformation/hook_type_configs_list_only/index.md b/website/docs/services/cloudformation/hook_type_configs_list_only/index.md new file mode 100644 index 0000000..7d015f4 --- /dev/null +++ b/website/docs/services/cloudformation/hook_type_configs_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: hook_type_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hook_type_configs_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hook_type_configs in a region or regions, for all properties use hook_type_configs + +## Overview + + + + + + + +
Namehook_type_configs_list_only
TypeResource
DescriptionSpecifies the configuration data for a registered hook in CloudFormation Registry.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the configuration data, in this account and region.
stringThe configuration data for the extension, in this account and region.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hook_type_configs in a region. +```sql +SELECT +region, +configuration_arn +FROM aws.cloudformation.hook_type_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hook_type_configs_list_only resource, see hook_type_configs + diff --git a/website/docs/services/cloudformation/hook_versions/index.md b/website/docs/services/cloudformation/hook_versions/index.md new file mode 100644 index 0000000..8c819bc --- /dev/null +++ b/website/docs/services/cloudformation/hook_versions/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a hook_version resource or lists hook_versions in a region + +## Overview + + + + + + + +
Namehook_versions
TypeResource
DescriptionPublishes new or first hook version to AWS CloudFormation Registry.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource
stringThe Amazon Resource Name (ARN) of the type without the versionID.
stringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
booleanIndicates if this type version is the current default version
objectSpecifies logging configuration information for a type.
stringA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.
For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe ID of the version of the type represented by this hook instance.
stringThe scope at which the type is visible and usable in CloudFormation operations.
Valid values include:
PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.
PUBLIC: The type is publically visible and usable within any Amazon account.
stringAWS region.
+ +For more information, see AWS::CloudFormation::HookVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all hook_versions in a region. +```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_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual hook_version. +```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_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new hook_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.hook_versions ( + SchemaHandlerPackage, + TypeName, + region +) +SELECT +'{{ SchemaHandlerPackage }}', + '{{ TypeName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.hook_versions ( + ExecutionRoleArn, + LoggingConfig, + SchemaHandlerPackage, + TypeName, + region +) +SELECT + '{{ ExecutionRoleArn }}', + '{{ LoggingConfig }}', + '{{ SchemaHandlerPackage }}', + '{{ TypeName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: hook_version + props: + - name: ExecutionRoleArn + value: '{{ ExecutionRoleArn }}' + - name: LoggingConfig + value: + LogGroupName: '{{ LogGroupName }}' + LogRoleArn: '{{ LogRoleArn }}' + - name: SchemaHandlerPackage + value: '{{ SchemaHandlerPackage }}' + - name: TypeName + value: '{{ TypeName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudformation.hook_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cloudformation:DescribeType +``` + +### Delete +```json +cloudformation:DeregisterType, +cloudformation:DescribeType +``` + +### List +```json +cloudformation:ListTypes, +cloudformation:ListTypeVersions +``` diff --git a/website/docs/services/cloudformation/hook_versions_list_only/index.md b/website/docs/services/cloudformation/hook_versions_list_only/index.md new file mode 100644 index 0000000..8a974e4 --- /dev/null +++ b/website/docs/services/cloudformation/hook_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: hook_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hook_versions_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hook_versions in a region or regions, for all properties use hook_versions + +## Overview + + + + + + + +
Namehook_versions_list_only
TypeResource
DescriptionPublishes new or first hook version to AWS CloudFormation Registry.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hook_versions in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.hook_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hook_versions_list_only resource, see hook_versions + diff --git a/website/docs/services/cloudformation/index.md b/website/docs/services/cloudformation/index.md new file mode 100644 index 0000000..2ea85ed --- /dev/null +++ b/website/docs/services/cloudformation/index.md @@ -0,0 +1,64 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cloudformation service documentation. + +:::info Service Summary + +
+
+total resources: 29
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cloudformation/lambda_hooks/index.md b/website/docs/services/cloudformation/lambda_hooks/index.md new file mode 100644 index 0000000..ab9b83b --- /dev/null +++ b/website/docs/services/cloudformation/lambda_hooks/index.md @@ -0,0 +1,282 @@ +--- +title: lambda_hooks +hide_title: false +hide_table_of_contents: false +keywords: + - lambda_hooks + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a lambda_hook resource or lists lambda_hooks in a region + +## Overview + + + + + + + +
Namelambda_hooks
TypeResource
DescriptionThis is a CloudFormation resource for the first-party AWS::Hooks::LambdaHook.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
stringAttribute to specify which stacks this hook applies to or should get invoked for
arrayWhich operations should this Hook run against? Resource changes, stacks or change sets.
stringAttribute to specify CloudFormation behavior on hook failure.
objectAttribute to specify which targets should invoke the hook
objectFilters to allow hooks to target specific stack attributes
stringThe typename alias for the hook.
stringThe Amazon Resource Name (ARN) of the activated hook
stringThe execution role ARN assumed by Hooks to invoke Lambda.
stringAWS region.
+ +For more information, see AWS::CloudFormation::LambdaHook. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all lambda_hooks in a region. +```sql +SELECT +region, +lambda_function, +hook_status, +target_operations, +failure_mode, +target_filters, +stack_filters, +alias, +hook_arn, +execution_role +FROM aws.cloudformation.lambda_hooks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual lambda_hook. +```sql +SELECT +region, +lambda_function, +hook_status, +target_operations, +failure_mode, +target_filters, +stack_filters, +alias, +hook_arn, +execution_role +FROM aws.cloudformation.lambda_hooks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new lambda_hook resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.lambda_hooks ( + LambdaFunction, + HookStatus, + TargetOperations, + FailureMode, + Alias, + ExecutionRole, + region +) +SELECT +'{{ LambdaFunction }}', + '{{ HookStatus }}', + '{{ TargetOperations }}', + '{{ FailureMode }}', + '{{ Alias }}', + '{{ ExecutionRole }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.lambda_hooks ( + LambdaFunction, + HookStatus, + TargetOperations, + FailureMode, + TargetFilters, + StackFilters, + Alias, + ExecutionRole, + region +) +SELECT + '{{ LambdaFunction }}', + '{{ HookStatus }}', + '{{ TargetOperations }}', + '{{ FailureMode }}', + '{{ TargetFilters }}', + '{{ StackFilters }}', + '{{ Alias }}', + '{{ ExecutionRole }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: lambda_hook + props: + - name: LambdaFunction + value: '{{ LambdaFunction }}' + - name: HookStatus + value: '{{ HookStatus }}' + - name: TargetOperations + value: + - '{{ TargetOperations[0] }}' + - name: FailureMode + value: '{{ FailureMode }}' + - name: TargetFilters + value: {} + - name: StackFilters + value: + FilteringCriteria: '{{ FilteringCriteria }}' + StackNames: + Include: + - '{{ Include[0] }}' + Exclude: + - null + StackRoles: + Include: + - '{{ Include[0] }}' + Exclude: + - null + - name: Alias + value: '{{ Alias }}' + - name: ExecutionRole + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudformation.lambda_hooks +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the lambda_hooks resource, the following permissions are required: + +### Create +```json +cloudformation:ListTypes, +cloudformation:ActivateType, +cloudformation:BatchDescribeTypeConfigurations, +cloudformation:DescribeType, +cloudformation:SetTypeConfiguration, +iam:PassRole +``` + +### Read +```json +cloudformation:BatchDescribeTypeConfigurations, +cloudformation:DescribeType +``` + +### Update +```json +cloudformation:BatchDescribeTypeConfigurations, +cloudformation:DescribeType, +cloudformation:SetTypeConfiguration, +iam:PassRole +``` + +### Delete +```json +cloudformation:BatchDescribeTypeConfigurations, +cloudformation:DeactivateType, +cloudformation:DescribeType, +cloudformation:SetTypeConfiguration +``` + +### List +```json +cloudformation:ListTypes, +cloudformation:BatchDescribeTypeConfigurations, +cloudformation:DescribeType +``` diff --git a/website/docs/services/cloudformation/lambda_hooks_list_only/index.md b/website/docs/services/cloudformation/lambda_hooks_list_only/index.md new file mode 100644 index 0000000..f1c2633 --- /dev/null +++ b/website/docs/services/cloudformation/lambda_hooks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: lambda_hooks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - lambda_hooks_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists lambda_hooks in a region or regions, for all properties use lambda_hooks + +## Overview + + + + + + + +
Namelambda_hooks_list_only
TypeResource
DescriptionThis is a CloudFormation resource for the first-party AWS::Hooks::LambdaHook.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the activated hook
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all lambda_hooks in a region. +```sql +SELECT +region, +hook_arn +FROM aws.cloudformation.lambda_hooks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lambda_hooks_list_only resource, see lambda_hooks + diff --git a/website/docs/services/cloudformation/module_default_versions/index.md b/website/docs/services/cloudformation/module_default_versions/index.md new file mode 100644 index 0000000..94cd811 --- /dev/null +++ b/website/docs/services/cloudformation/module_default_versions/index.md @@ -0,0 +1,184 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a module_default_version resource or lists 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
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the module version to set as the default version.
stringThe name of a module existing in the registry.
stringThe ID of an existing version of the named module to set as the default.
stringAWS region.
+ +For more information, see AWS::CloudFormation::ModuleDefaultVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
SELECT
SELECT
+ +## `SELECT` examples +Gets all module_default_versions in a region. +```sql +SELECT +region, +arn, +module_name, +version_id +FROM aws.cloudformation.module_default_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual module_default_version. +```sql +SELECT +region, +arn, +module_name, +version_id +FROM aws.cloudformation.module_default_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new module_default_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.module_default_versions ( + Arn, + ModuleName, + VersionId, + region +) +SELECT +'{{ Arn }}', + '{{ ModuleName }}', + '{{ VersionId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.module_default_versions ( + Arn, + ModuleName, + VersionId, + region +) +SELECT + '{{ Arn }}', + '{{ ModuleName }}', + '{{ VersionId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: module_default_version + props: + - name: Arn + value: '{{ Arn }}' + - name: ModuleName + value: '{{ ModuleName }}' + - name: VersionId + value: '{{ VersionId }}' + +``` + + + +## Permissions + +To operate on the module_default_versions resource, the following permissions are required: + +### Create +```json +cloudformation:DescribeType, +cloudformation:SetTypeDefaultVersion +``` + +### Read +```json +cloudformation:DescribeType +``` + +### List +```json +cloudformation:ListTypes +``` diff --git a/website/docs/services/cloudformation/module_default_versions_list_only/index.md b/website/docs/services/cloudformation/module_default_versions_list_only/index.md new file mode 100644 index 0000000..7170d68 --- /dev/null +++ b/website/docs/services/cloudformation/module_default_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: module_default_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - module_default_versions_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists module_default_versions in a region or regions, for all properties use module_default_versions + +## Overview + + + + + + + +
Namemodule_default_versions_list_only
TypeResource
DescriptionA module that has been registered in the CloudFormation registry as the default version
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the module version to set as the default version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all module_default_versions in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.module_default_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the module_default_versions_list_only resource, see module_default_versions + diff --git a/website/docs/services/cloudformation/module_versions/index.md b/website/docs/services/cloudformation/module_versions/index.md new file mode 100644 index 0000000..878426c --- /dev/null +++ b/website/docs/services/cloudformation/module_versions/index.md @@ -0,0 +1,197 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a module_version resource or lists module_versions in a region + +## Overview + + + + + + + +
Namemodule_versions
TypeResource
DescriptionA module that has been registered in the CloudFormation registry.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the module.
stringThe description of the registered module.
stringThe URL of a page providing detailed documentation for this module.
stringThe name of the module being registered.
Recommended module naming pattern: company_or_organization::service::type::MODULE.
stringThe url to the S3 bucket containing the schema and template fragment for the module you want to register.
booleanIndicator of whether this module version is the current default version
stringThe schema defining input parameters to and resources generated by the module.
stringThe time that the specified module version was registered.
stringThe version ID of the module represented by this module instance.
stringThe scope at which the type is visible and usable in CloudFormation operations.
The only allowed value at present is:
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.
stringAWS region.
+ +For more information, see AWS::CloudFormation::ModuleVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual module_version. +```sql +SELECT +region, +arn, +description, +documentation_url, +module_name, +module_package, +is_default_version, +schema, +time_created, +version_id, +visibility +FROM aws.cloudformation.module_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new module_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.module_versions ( + ModuleName, + ModulePackage, + region +) +SELECT +'{{ ModuleName }}', + '{{ ModulePackage }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.module_versions ( + ModuleName, + ModulePackage, + region +) +SELECT + '{{ ModuleName }}', + '{{ ModulePackage }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: module_version + props: + - name: ModuleName + value: '{{ ModuleName }}' + - name: ModulePackage + value: '{{ ModulePackage }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudformation.module_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cloudformation:DescribeType +``` + +### Delete +```json +cloudformation:DeregisterType, +cloudformation:DescribeType +``` diff --git a/website/docs/services/cloudformation/public_type_versions/index.md b/website/docs/services/cloudformation/public_type_versions/index.md new file mode 100644 index 0000000..5ff3d14 --- /dev/null +++ b/website/docs/services/cloudformation/public_type_versions/index.md @@ -0,0 +1,216 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a public_type_version resource or lists public_type_versions in a region + +## Overview + + + + + + + +
Namepublic_type_versions
TypeResource
DescriptionTest and Publish a resource that has been registered in the CloudFormation Registry.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Number (ARN) of the extension.
stringThe Amazon Resource Number (ARN) of the extension with the versionId.
stringThe version number of a public third-party extension
stringThe publisher id assigned by CloudFormation for publishing in this region.
stringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringA url to the S3 bucket where logs for the testType run will be available
stringThe kind of extension
stringAWS region.
+ +For more information, see AWS::CloudFormation::PublicTypeVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
SELECT
SELECT
+ +## `SELECT` examples +Gets all public_type_versions in a region. +```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_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual public_type_version. +```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_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new public_type_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.public_type_versions ( + Arn, + PublicVersionNumber, + TypeName, + LogDeliveryBucket, + Type, + region +) +SELECT +'{{ Arn }}', + '{{ PublicVersionNumber }}', + '{{ TypeName }}', + '{{ LogDeliveryBucket }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.public_type_versions ( + Arn, + PublicVersionNumber, + TypeName, + LogDeliveryBucket, + Type, + region +) +SELECT + '{{ Arn }}', + '{{ PublicVersionNumber }}', + '{{ TypeName }}', + '{{ LogDeliveryBucket }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: public_type_version + props: + - name: Arn + value: '{{ Arn }}' + - name: PublicVersionNumber + value: '{{ PublicVersionNumber }}' + - name: TypeName + value: '{{ TypeName }}' + - name: LogDeliveryBucket + value: '{{ LogDeliveryBucket }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## 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 +``` + +### Read +```json +cloudformation:DescribeType, +cloudformation:DescribePublisher +``` + +### List +```json +cloudformation:ListTypes +``` diff --git a/website/docs/services/cloudformation/public_type_versions_list_only/index.md b/website/docs/services/cloudformation/public_type_versions_list_only/index.md new file mode 100644 index 0000000..4462f24 --- /dev/null +++ b/website/docs/services/cloudformation/public_type_versions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: public_type_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - public_type_versions_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists public_type_versions in a region or regions, for all properties use public_type_versions + +## Overview + + + + + + + +
Namepublic_type_versions_list_only
TypeResource
DescriptionTest and Publish a resource that has been registered in the CloudFormation Registry.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Number (ARN) of the extension.
stringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
stringThe kind of extension
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all public_type_versions in a region. +```sql +SELECT +region, +public_type_arn +FROM aws.cloudformation.public_type_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the public_type_versions_list_only resource, see public_type_versions + diff --git a/website/docs/services/cloudformation/publishers/index.md b/website/docs/services/cloudformation/publishers/index.md new file mode 100644 index 0000000..470b87f --- /dev/null +++ b/website/docs/services/cloudformation/publishers/index.md @@ -0,0 +1,187 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a publisher resource or lists publishers in a region + +## Overview + + + + + + + +
Namepublishers
TypeResource
DescriptionRegister as a publisher in the CloudFormation Registry.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
booleanWhether you accept the terms and conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to publish public extensions to the CloudFormation registry. The terms and conditions can be found at https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
stringThe publisher id assigned by CloudFormation for publishing in this region.
stringIf you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
stringWhether the publisher is verified.
stringThe URL to the publisher's profile with the identity provider.
stringThe type of account used as the identity provider when registering this publisher with CloudFormation.
stringAWS region.
+ +For more information, see AWS::CloudFormation::Publisher. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
SELECT
SELECT
+ +## `SELECT` examples +Gets all publishers in a region. +```sql +SELECT +region, +accept_terms_and_conditions, +publisher_id, +connection_arn, +publisher_status, +publisher_profile, +identity_provider +FROM aws.cloudformation.publishers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual publisher. +```sql +SELECT +region, +accept_terms_and_conditions, +publisher_id, +connection_arn, +publisher_status, +publisher_profile, +identity_provider +FROM aws.cloudformation.publishers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new publisher resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.publishers ( + AcceptTermsAndConditions, + region +) +SELECT +'{{ AcceptTermsAndConditions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.publishers ( + AcceptTermsAndConditions, + ConnectionArn, + region +) +SELECT + '{{ AcceptTermsAndConditions }}', + '{{ ConnectionArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: publisher + props: + - name: AcceptTermsAndConditions + value: '{{ AcceptTermsAndConditions }}' + - name: ConnectionArn + value: '{{ ConnectionArn }}' + +``` + + + +## Permissions + +To operate on the publishers resource, the following permissions are required: + +### Create +```json +cloudformation:RegisterPublisher, +cloudformation:DescribePublisher, +codestar-connections:GetConnection, +codestar-connections:UseConnection +``` + +### Read +```json +cloudformation:DescribePublisher +``` + +### List +```json +cloudformation:DescribePublisher +``` diff --git a/website/docs/services/cloudformation/publishers_list_only/index.md b/website/docs/services/cloudformation/publishers_list_only/index.md new file mode 100644 index 0000000..a71d72d --- /dev/null +++ b/website/docs/services/cloudformation/publishers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: publishers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - publishers_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists publishers in a region or regions, for all properties use publishers + +## Overview + + + + + + + +
Namepublishers_list_only
TypeResource
DescriptionRegister as a publisher in the CloudFormation Registry.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe publisher id assigned by CloudFormation for publishing in this region.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all publishers in a region. +```sql +SELECT +region, +publisher_id +FROM aws.cloudformation.publishers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the publishers_list_only resource, see publishers + diff --git a/website/docs/services/cloudformation/resource_default_versions/index.md b/website/docs/services/cloudformation/resource_default_versions/index.md new file mode 100644 index 0000000..a2a485d --- /dev/null +++ b/website/docs/services/cloudformation/resource_default_versions/index.md @@ -0,0 +1,215 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_default_version resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of an existing version of the resource to set as the default.
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion
stringThe Amazon Resource Name (ARN) of the type version.
stringAWS region.
+ +For more information, see AWS::CloudFormation::ResourceDefaultVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_default_versions in a region. +```sql +SELECT +region, +version_id, +type_name, +arn, +type_version_arn +FROM aws.cloudformation.resource_default_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_default_version. +```sql +SELECT +region, +version_id, +type_name, +arn, +type_version_arn +FROM aws.cloudformation.resource_default_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_default_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.resource_default_versions ( + VersionId, + TypeName, + TypeVersionArn, + region +) +SELECT +'{{ VersionId }}', + '{{ TypeName }}', + '{{ TypeVersionArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.resource_default_versions ( + VersionId, + TypeName, + TypeVersionArn, + region +) +SELECT + '{{ VersionId }}', + '{{ TypeName }}', + '{{ TypeVersionArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_default_version + props: + - name: VersionId + value: '{{ VersionId }}' + - name: TypeName + value: '{{ TypeName }}' + - name: TypeVersionArn + value: '{{ TypeVersionArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudformation.resource_default_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_default_versions resource, the following permissions are required: + +### Read +```json +cloudformation:DescribeType +``` + +### Create +```json +cloudformation:SetTypeDefaultVersion +``` + +### Update +```json +cloudformation:SetTypeDefaultVersion +``` + +### List +```json +cloudformation:ListTypeVersions +``` + +### Delete +```json + +``` diff --git a/website/docs/services/cloudformation/resource_default_versions_list_only/index.md b/website/docs/services/cloudformation/resource_default_versions_list_only/index.md new file mode 100644 index 0000000..fa15442 --- /dev/null +++ b/website/docs/services/cloudformation/resource_default_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_default_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_default_versions_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_default_versions in a region or regions, for all properties use resource_default_versions + +## Overview + + + + + + + +
Nameresource_default_versions_list_only
TypeResource
DescriptionThe default version of a resource that has been registered in the CloudFormation Registry.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_default_versions in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.resource_default_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_default_versions_list_only resource, see resource_default_versions + diff --git a/website/docs/services/cloudformation/resource_versions/index.md b/website/docs/services/cloudformation/resource_versions/index.md new file mode 100644 index 0000000..da2e92e --- /dev/null +++ b/website/docs/services/cloudformation/resource_versions/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_version resource or lists resource_versions in a region + +## Overview + + + + + + + +
Nameresource_versions
TypeResource
DescriptionA resource that has been registered in the CloudFormation Registry.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource
stringThe Amazon Resource Name (ARN) of the type without the versionID.
stringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
booleanIndicates if this type version is the current default version
objectSpecifies logging configuration information for a type.
stringThe provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
stringA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.
For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe ID of the version of the type represented by this resource instance.
stringThe scope at which the type is visible and usable in CloudFormation operations.
Valid values include:
PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.
PUBLIC: The type is publically visible and usable within any Amazon account.
stringAWS region.
+ +For more information, see AWS::CloudFormation::ResourceVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_versions in a region. +```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_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_version. +```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_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.resource_versions ( + SchemaHandlerPackage, + TypeName, + region +) +SELECT +'{{ SchemaHandlerPackage }}', + '{{ TypeName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.resource_versions ( + ExecutionRoleArn, + LoggingConfig, + SchemaHandlerPackage, + TypeName, + region +) +SELECT + '{{ ExecutionRoleArn }}', + '{{ LoggingConfig }}', + '{{ SchemaHandlerPackage }}', + '{{ TypeName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_version + props: + - name: ExecutionRoleArn + value: '{{ ExecutionRoleArn }}' + - name: LoggingConfig + value: + LogGroupName: '{{ LogGroupName }}' + LogRoleArn: '{{ LogRoleArn }}' + - name: SchemaHandlerPackage + value: '{{ SchemaHandlerPackage }}' + - name: TypeName + value: '{{ TypeName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudformation.resource_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cloudformation:DescribeType +``` + +### Delete +```json +cloudformation:DeregisterType, +cloudformation:DescribeType +``` + +### List +```json +cloudformation:ListTypes +``` diff --git a/website/docs/services/cloudformation/resource_versions_list_only/index.md b/website/docs/services/cloudformation/resource_versions_list_only/index.md new file mode 100644 index 0000000..0e24405 --- /dev/null +++ b/website/docs/services/cloudformation/resource_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_versions_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_versions in a region or regions, for all properties use resource_versions + +## Overview + + + + + + + +
Nameresource_versions_list_only
TypeResource
DescriptionA resource that has been registered in the CloudFormation Registry.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_versions in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.resource_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_versions_list_only resource, see resource_versions + diff --git a/website/docs/services/cloudformation/stack_set_tags/index.md b/website/docs/services/cloudformation/stack_set_tags/index.md new file mode 100644 index 0000000..d585822 --- /dev/null +++ b/website/docs/services/cloudformation/stack_set_tags/index.md @@ -0,0 +1,105 @@ +--- +title: stack_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stack_set_tags + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stack_sets in a region + +## Overview + + + + + + + +
Namestack_set_tags
TypeResource
DescriptionStackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name to associate with the stack set. The name must be unique in the Region where you create your stack set.
stringThe ID of the stack set that you're creating.
stringThe Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
objectDescribes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
arrayIn some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
stringA description of the stack set. You can use the description to identify the stack set's purpose or other important information.
stringThe name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
objectThe user-specified preferences for how AWS CloudFormation performs a stack set operation.
arrayA group of stack instances with parameters in some specific accounts and regions.
arrayThe input parameters for the stack set template.
stringDescribes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
stringThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
stringLocation of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
stringSpecifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
objectDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stack_sets in a region. +```sql +SELECT +region, +stack_set_name, +stack_set_id, +administration_role_arn, +auto_deployment, +capabilities, +description, +execution_role_name, +operation_preferences, +stack_instances_group, +parameters, +permission_model, +template_body, +template_url, +call_as, +managed_execution, +tag_key, +tag_value +FROM aws.cloudformation.stack_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stack_set_tags resource, see stack_sets + diff --git a/website/docs/services/cloudformation/stack_sets/index.md b/website/docs/services/cloudformation/stack_sets/index.md new file mode 100644 index 0000000..6cf2a1b --- /dev/null +++ b/website/docs/services/cloudformation/stack_sets/index.md @@ -0,0 +1,350 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a stack_set resource or lists stack_sets in a region + +## Overview + + + + + + + +
Namestack_sets
TypeResource
DescriptionStackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name to associate with the stack set. The name must be unique in the Region where you create your stack set.
stringThe ID of the stack set that you're creating.
stringThe Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
objectDescribes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
arrayIn some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
stringA description of the stack set. You can use the description to identify the stack set's purpose or other important information.
stringThe name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
objectThe user-specified preferences for how AWS CloudFormation performs a stack set operation.
arrayA group of stack instances with parameters in some specific accounts and regions.
arrayThe input parameters for the stack set template.
stringDescribes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
arrayThe key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
stringThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
stringLocation of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
stringSpecifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
objectDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
stringAWS region.
+ +For more information, see AWS::CloudFormation::StackSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all stack_sets in a region. +```sql +SELECT +region, +stack_set_name, +stack_set_id, +administration_role_arn, +auto_deployment, +capabilities, +description, +execution_role_name, +operation_preferences, +stack_instances_group, +parameters, +permission_model, +tags, +template_body, +template_url, +call_as, +managed_execution +FROM aws.cloudformation.stack_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual stack_set. +```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_sets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stack_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.stack_sets ( + StackSetName, + PermissionModel, + region +) +SELECT +'{{ StackSetName }}', + '{{ PermissionModel }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.stack_sets ( + StackSetName, + AdministrationRoleARN, + AutoDeployment, + Capabilities, + Description, + ExecutionRoleName, + OperationPreferences, + StackInstancesGroup, + Parameters, + PermissionModel, + Tags, + TemplateBody, + TemplateURL, + CallAs, + ManagedExecution, + region +) +SELECT + '{{ StackSetName }}', + '{{ AdministrationRoleARN }}', + '{{ AutoDeployment }}', + '{{ Capabilities }}', + '{{ Description }}', + '{{ ExecutionRoleName }}', + '{{ OperationPreferences }}', + '{{ StackInstancesGroup }}', + '{{ Parameters }}', + '{{ PermissionModel }}', + '{{ Tags }}', + '{{ TemplateBody }}', + '{{ TemplateURL }}', + '{{ CallAs }}', + '{{ ManagedExecution }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: stack_set + props: + - name: StackSetName + value: '{{ StackSetName }}' + - name: AdministrationRoleARN + value: '{{ AdministrationRoleARN }}' + - name: AutoDeployment + value: + Enabled: '{{ Enabled }}' + RetainStacksOnAccountRemoval: '{{ RetainStacksOnAccountRemoval }}' + - name: Capabilities + value: + - '{{ Capabilities[0] }}' + - name: Description + value: '{{ Description }}' + - name: ExecutionRoleName + value: '{{ ExecutionRoleName }}' + - name: OperationPreferences + value: + FailureToleranceCount: '{{ FailureToleranceCount }}' + FailureTolerancePercentage: '{{ FailureTolerancePercentage }}' + MaxConcurrentCount: '{{ MaxConcurrentCount }}' + MaxConcurrentPercentage: '{{ MaxConcurrentPercentage }}' + RegionOrder: + - '{{ RegionOrder[0] }}' + RegionConcurrencyType: '{{ RegionConcurrencyType }}' + ConcurrencyMode: '{{ ConcurrencyMode }}' + - name: StackInstancesGroup + value: + - DeploymentTargets: + Accounts: + - '{{ Accounts[0] }}' + AccountsUrl: '{{ AccountsUrl }}' + OrganizationalUnitIds: + - '{{ OrganizationalUnitIds[0] }}' + AccountFilterType: '{{ AccountFilterType }}' + Regions: + - null + ParameterOverrides: + - ParameterKey: '{{ ParameterKey }}' + ParameterValue: '{{ ParameterValue }}' + - name: Parameters + value: + - null + - name: PermissionModel + value: '{{ PermissionModel }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TemplateBody + value: '{{ TemplateBody }}' + - name: TemplateURL + value: '{{ TemplateURL }}' + - name: CallAs + value: '{{ CallAs }}' + - name: ManagedExecution + value: + Active: '{{ Active }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudformation.stack_sets +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +cloudformation:ListStackSets, +cloudformation:DescribeStackSet, +cloudformation:ListStackInstances, +cloudformation:DescribeStackInstance +``` diff --git a/website/docs/services/cloudformation/stack_sets_list_only/index.md b/website/docs/services/cloudformation/stack_sets_list_only/index.md new file mode 100644 index 0000000..42f6769 --- /dev/null +++ b/website/docs/services/cloudformation/stack_sets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: stack_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stack_sets_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stack_sets in a region or regions, for all properties use stack_sets + +## Overview + + + + + + + +
Namestack_sets_list_only
TypeResource
DescriptionStackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the stack set that you're creating.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stack_sets in a region. +```sql +SELECT +region, +stack_set_id +FROM aws.cloudformation.stack_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stack_sets_list_only resource, see stack_sets + diff --git a/website/docs/services/cloudformation/stack_tags/index.md b/website/docs/services/cloudformation/stack_tags/index.md new file mode 100644 index 0000000..e1a14e8 --- /dev/null +++ b/website/docs/services/cloudformation/stack_tags/index.md @@ -0,0 +1,119 @@ +--- +title: stack_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stack_tags + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stacks in a region + +## Overview + + + + + + + +
Namestack_tags
TypeResource
DescriptionThe AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
array
string
boolean
boolean
array
object
string
string
string
string
string
object
string
string
string
object
string
integer
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stacks in a region. +```sql +SELECT +region, +capabilities, +role_arn, +outputs, +description, +disable_rollback, +enable_termination_protection, +notification_arns, +parameters, +parent_id, +root_id, +change_set_id, +stack_name, +stack_id, +stack_policy_body, +stack_policy_url, +stack_status, +stack_status_reason, +template_body, +template_url, +timeout_in_minutes, +last_update_time, +creation_time, +tag_key, +tag_value +FROM aws.cloudformation.stack_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stack_tags resource, see stacks + diff --git a/website/docs/services/cloudformation/stacks/index.md b/website/docs/services/cloudformation/stacks/index.md new file mode 100644 index 0000000..db8b781 --- /dev/null +++ b/website/docs/services/cloudformation/stacks/index.md @@ -0,0 +1,329 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a stack resource or lists stacks in a region + +## Overview + + + + + + + +
Namestacks
TypeResource
DescriptionThe AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
array
string
boolean
boolean
array
object
string
string
string
string
string
object
string
string
string
array
object
string
integer
string
string
stringAWS region.
+ +For more information, see AWS::CloudFormation::Stack. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all stacks in a region. +```sql +SELECT +region, +capabilities, +role_arn, +outputs, +description, +disable_rollback, +enable_termination_protection, +notification_arns, +parameters, +parent_id, +root_id, +change_set_id, +stack_name, +stack_id, +stack_policy_body, +stack_policy_url, +stack_status, +stack_status_reason, +tags, +template_body, +template_url, +timeout_in_minutes, +last_update_time, +creation_time +FROM aws.cloudformation.stacks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual stack. +```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.stacks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stack resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.stacks ( + StackName, + region +) +SELECT +'{{ StackName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.stacks ( + Capabilities, + RoleARN, + Description, + DisableRollback, + EnableTerminationProtection, + NotificationARNs, + Parameters, + StackName, + StackPolicyBody, + StackPolicyURL, + StackStatusReason, + Tags, + TemplateBody, + TemplateURL, + TimeoutInMinutes, + region +) +SELECT + '{{ Capabilities }}', + '{{ RoleARN }}', + '{{ Description }}', + '{{ DisableRollback }}', + '{{ EnableTerminationProtection }}', + '{{ NotificationARNs }}', + '{{ Parameters }}', + '{{ StackName }}', + '{{ StackPolicyBody }}', + '{{ StackPolicyURL }}', + '{{ StackStatusReason }}', + '{{ Tags }}', + '{{ TemplateBody }}', + '{{ TemplateURL }}', + '{{ TimeoutInMinutes }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: stack + props: + - name: Capabilities + value: + - '{{ Capabilities[0] }}' + - name: RoleARN + value: '{{ RoleARN }}' + - name: Description + value: '{{ Description }}' + - name: DisableRollback + value: '{{ DisableRollback }}' + - name: EnableTerminationProtection + value: '{{ EnableTerminationProtection }}' + - name: NotificationARNs + value: + - '{{ NotificationARNs[0] }}' + - name: Parameters + value: {} + - name: StackName + value: '{{ StackName }}' + - name: StackPolicyBody + value: {} + - name: StackPolicyURL + value: '{{ StackPolicyURL }}' + - name: StackStatusReason + value: '{{ StackStatusReason }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TemplateBody + value: {} + - name: TemplateURL + value: '{{ TemplateURL }}' + - name: TimeoutInMinutes + value: '{{ TimeoutInMinutes }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudformation.stacks +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the stacks resource, the following permissions are required: + +### Create +```json +cloudformation:DescribeStacks, +cloudformation:CreateStack, +iam:PassRole +``` + +### 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 +``` + +### List +```json +cloudformation:ListStacks +``` diff --git a/website/docs/services/cloudformation/stacks_list_only/index.md b/website/docs/services/cloudformation/stacks_list_only/index.md new file mode 100644 index 0000000..3bbb00c --- /dev/null +++ b/website/docs/services/cloudformation/stacks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: stacks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stacks_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stacks in a region or regions, for all properties use stacks + +## Overview + + + + + + + +
Namestacks_list_only
TypeResource
DescriptionThe AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stacks in a region. +```sql +SELECT +region, +stack_id +FROM aws.cloudformation.stacks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stacks_list_only resource, see stacks + diff --git a/website/docs/services/cloudformation/type_activations/index.md b/website/docs/services/cloudformation/type_activations/index.md new file mode 100644 index 0000000..6adc9ad --- /dev/null +++ b/website/docs/services/cloudformation/type_activations/index.md @@ -0,0 +1,285 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a type_activation resource or lists type_activations in a region + +## Overview + + + + + + + +
Nametype_activations
TypeResource
DescriptionEnable a resource that has been published in the CloudFormation Registry.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the extension.
stringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
stringThe publisher id assigned by CloudFormation for publishing in this region.
objectSpecifies logging configuration information for a type.
stringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
booleanWhether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
stringAn alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.
stringManually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled
stringThe Major Version of the type you want to enable
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe kind of extension
stringAWS region.
+ +For more information, see AWS::CloudFormation::TypeActivation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all type_activations in a region. +```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_activations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual type_activation. +```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_activations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new type_activation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.type_activations ( + ExecutionRoleArn, + PublisherId, + LoggingConfig, + PublicTypeArn, + AutoUpdate, + TypeNameAlias, + VersionBump, + MajorVersion, + TypeName, + Type, + region +) +SELECT +'{{ ExecutionRoleArn }}', + '{{ PublisherId }}', + '{{ LoggingConfig }}', + '{{ PublicTypeArn }}', + '{{ AutoUpdate }}', + '{{ TypeNameAlias }}', + '{{ VersionBump }}', + '{{ MajorVersion }}', + '{{ TypeName }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudformation.type_activations ( + ExecutionRoleArn, + PublisherId, + LoggingConfig, + PublicTypeArn, + AutoUpdate, + TypeNameAlias, + VersionBump, + MajorVersion, + TypeName, + Type, + region +) +SELECT + '{{ ExecutionRoleArn }}', + '{{ PublisherId }}', + '{{ LoggingConfig }}', + '{{ PublicTypeArn }}', + '{{ AutoUpdate }}', + '{{ TypeNameAlias }}', + '{{ VersionBump }}', + '{{ MajorVersion }}', + '{{ TypeName }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: type_activation + props: + - name: ExecutionRoleArn + value: '{{ ExecutionRoleArn }}' + - name: PublisherId + value: '{{ PublisherId }}' + - name: LoggingConfig + value: + LogGroupName: '{{ LogGroupName }}' + LogRoleArn: '{{ LogRoleArn }}' + - name: PublicTypeArn + value: '{{ PublicTypeArn }}' + - name: AutoUpdate + value: '{{ AutoUpdate }}' + - name: TypeNameAlias + value: '{{ TypeNameAlias }}' + - name: VersionBump + value: '{{ VersionBump }}' + - name: MajorVersion + value: '{{ MajorVersion }}' + - name: TypeName + value: '{{ TypeName }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudformation.type_activations +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +cloudformation:ActivateType, +cloudformation:DescribeType, +iam:PassRole +``` + +### Read +```json +cloudformation:DescribeType +``` + +### Delete +```json +cloudformation:DeactivateType, +cloudformation:DescribeType +``` + +### List +```json +cloudformation:ListTypes +``` diff --git a/website/docs/services/cloudformation/type_activations_list_only/index.md b/website/docs/services/cloudformation/type_activations_list_only/index.md new file mode 100644 index 0000000..001ef95 --- /dev/null +++ b/website/docs/services/cloudformation/type_activations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: type_activations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - type_activations_list_only + - cloudformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists type_activations in a region or regions, for all properties use type_activations + +## Overview + + + + + + + +
Nametype_activations_list_only
TypeResource
DescriptionEnable a resource that has been published in the CloudFormation Registry.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the extension.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all type_activations in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.type_activations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the type_activations_list_only resource, see type_activations + diff --git a/website/docs/services/cloudfront/anycast_ip_list_tags/index.md b/website/docs/services/cloudfront/anycast_ip_list_tags/index.md new file mode 100644 index 0000000..d4e7710 --- /dev/null +++ b/website/docs/services/cloudfront/anycast_ip_list_tags/index.md @@ -0,0 +1,85 @@ +--- +title: anycast_ip_list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - anycast_ip_list_tags + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for anycast_ip_lists in a region + +## Overview + + + + + + + +
Nameanycast_ip_list_tags
TypeResource
DescriptionDefinition of AWS::CloudFront::AnycastIpList Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectDefinition of AWS::CloudFront::AnycastIpList Resource Type
string
string
integer
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all anycast_ip_lists in a region. +```sql +SELECT +region, +anycast_ip_list, +e_tag, +id, +ip_count, +name, +tag_key, +tag_value +FROM aws.cloudfront.anycast_ip_list_tags +; +``` + + +## Permissions + +For permissions required to operate on the anycast_ip_list_tags resource, see anycast_ip_lists + diff --git a/website/docs/services/cloudfront/anycast_ip_lists/index.md b/website/docs/services/cloudfront/anycast_ip_lists/index.md new file mode 100644 index 0000000..e33117a --- /dev/null +++ b/website/docs/services/cloudfront/anycast_ip_lists/index.md @@ -0,0 +1,215 @@ +--- +title: anycast_ip_lists +hide_title: false +hide_table_of_contents: false +keywords: + - anycast_ip_lists + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an anycast_ip_list resource or lists anycast_ip_lists in a region + +## Overview + + + + + + + +
Nameanycast_ip_lists
TypeResource
DescriptionDefinition of AWS::CloudFront::AnycastIpList Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectDefinition of AWS::CloudFront::AnycastIpList Resource Type
string
string
integer
string
object
stringAWS region.
+ +For more information, see AWS::CloudFront::AnycastIpList. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all anycast_ip_lists in a region. +```sql +SELECT +region, +anycast_ip_list, +e_tag, +id, +ip_count, +name, +tags +FROM aws.cloudfront.anycast_ip_lists +; +``` +Gets all properties from an individual anycast_ip_list. +```sql +SELECT +region, +anycast_ip_list, +e_tag, +id, +ip_count, +name, +tags +FROM aws.cloudfront.anycast_ip_lists +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new anycast_ip_list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.anycast_ip_lists ( + IpCount, + Name, + region +) +SELECT +'{{ IpCount }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.anycast_ip_lists ( + IpCount, + Name, + Tags, + region +) +SELECT + '{{ IpCount }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: anycast_ip_list + props: + - name: IpCount + value: '{{ IpCount }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + Items: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.anycast_ip_lists +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the anycast_ip_lists resource, the following permissions are required: + +### Create +```json +cloudfront:CreateAnycastIpList, +cloudfront:TagResource +``` + +### Delete +```json +cloudfront:DeleteAnycastIpList, +cloudfront:GetAnycastIpList +``` + +### List +```json +cloudfront:ListAnycastIpLists +``` + +### Read +```json +cloudfront:GetAnycastIpList, +cloudfront:ListTagsForResource +``` diff --git a/website/docs/services/cloudfront/anycast_ip_lists_list_only/index.md b/website/docs/services/cloudfront/anycast_ip_lists_list_only/index.md new file mode 100644 index 0000000..aa091f0 --- /dev/null +++ b/website/docs/services/cloudfront/anycast_ip_lists_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: anycast_ip_lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - anycast_ip_lists_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists anycast_ip_lists in a region or regions, for all properties use anycast_ip_lists + +## Overview + + + + + + + +
Nameanycast_ip_lists_list_only
TypeResource
DescriptionDefinition of AWS::CloudFront::AnycastIpList Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all anycast_ip_lists in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.anycast_ip_lists_list_only +; +``` + + +## Permissions + +For permissions required to operate on the anycast_ip_lists_list_only resource, see anycast_ip_lists + diff --git a/website/docs/services/cloudfront/cache_policies/index.md b/website/docs/services/cloudfront/cache_policies/index.md new file mode 100644 index 0000000..e75de01 --- /dev/null +++ b/website/docs/services/cloudfront/cache_policies/index.md @@ -0,0 +1,222 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cache_policy resource or lists cache_policies in a region + +## Overview + + + + + + + +
Namecache_policies
TypeResource
DescriptionA cache policy.
When it's attached to a cache behavior, the cache policy determines the following:
+ The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
+ The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use OriginRequestPolicy.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectThe cache policy configuration.
string
string
stringAWS region.
+ +For more information, see AWS::CloudFront::CachePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cache_policies in a region. +```sql +SELECT +region, +cache_policy_config, +id, +last_modified_time +FROM aws.cloudfront.cache_policies +; +``` +Gets all properties from an individual cache_policy. +```sql +SELECT +region, +cache_policy_config, +id, +last_modified_time +FROM aws.cloudfront.cache_policies +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cache_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.cache_policies ( + CachePolicyConfig, + region +) +SELECT +'{{ CachePolicyConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.cache_policies ( + CachePolicyConfig, + region +) +SELECT + '{{ CachePolicyConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cache_policy + props: + - name: CachePolicyConfig + value: + Comment: '{{ Comment }}' + DefaultTTL: null + MaxTTL: null + MinTTL: null + Name: '{{ Name }}' + ParametersInCacheKeyAndForwardedToOrigin: + CookiesConfig: + CookieBehavior: '{{ CookieBehavior }}' + Cookies: + - '{{ Cookies[0] }}' + EnableAcceptEncodingBrotli: '{{ EnableAcceptEncodingBrotli }}' + EnableAcceptEncodingGzip: '{{ EnableAcceptEncodingGzip }}' + HeadersConfig: + HeaderBehavior: '{{ HeaderBehavior }}' + Headers: + - '{{ Headers[0] }}' + QueryStringsConfig: + QueryStringBehavior: '{{ QueryStringBehavior }}' + QueryStrings: + - '{{ QueryStrings[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.cache_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the cache_policies resource, the following permissions are required: + +### Create +```json +cloudfront:CreateCachePolicy +``` + +### Delete +```json +cloudfront:DeleteCachePolicy, +cloudfront:GetCachePolicy +``` + +### List +```json +cloudfront:ListCachePolicies +``` + +### Read +```json +cloudfront:GetCachePolicy +``` + +### Update +```json +cloudfront:UpdateCachePolicy, +cloudfront:GetCachePolicy +``` diff --git a/website/docs/services/cloudfront/cache_policies_list_only/index.md b/website/docs/services/cloudfront/cache_policies_list_only/index.md new file mode 100644 index 0000000..6e0b638 --- /dev/null +++ b/website/docs/services/cloudfront/cache_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cache_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cache_policies_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cache_policies in a region or regions, for all properties use cache_policies + +## Overview + + + + + + + +
Namecache_policies_list_only
TypeResource
DescriptionA cache policy.
When it's attached to a cache behavior, the cache policy determines the following:
+ The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
+ The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use OriginRequestPolicy.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cache_policies in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.cache_policies_list_only +; +``` + + +## Permissions + +For permissions required to operate on the cache_policies_list_only resource, see cache_policies + diff --git a/website/docs/services/cloudfront/cloud_front_origin_access_identities/index.md b/website/docs/services/cloudfront/cloud_front_origin_access_identities/index.md new file mode 100644 index 0000000..82a8047 --- /dev/null +++ b/website/docs/services/cloudfront/cloud_front_origin_access_identities/index.md @@ -0,0 +1,203 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cloud_front_origin_access_identity resource or lists cloud_front_origin_access_identities in a region + +## Overview + + + + + + + +
Namecloud_front_origin_access_identities
TypeResource
DescriptionThe request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see [Restricting Access to Amazon S3 Content by Using an Origin Access Identity](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectThe current configuration information for the identity.
string
string
stringAWS region.
+ +For more information, see AWS::CloudFront::CloudFrontOriginAccessIdentity. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cloud_front_origin_access_identities in a region. +```sql +SELECT +region, +cloud_front_origin_access_identity_config, +id, +s3_canonical_user_id +FROM aws.cloudfront.cloud_front_origin_access_identities +; +``` +Gets all properties from an individual cloud_front_origin_access_identity. +```sql +SELECT +region, +cloud_front_origin_access_identity_config, +id, +s3_canonical_user_id +FROM aws.cloudfront.cloud_front_origin_access_identities +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cloud_front_origin_access_identity resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.cloud_front_origin_access_identities ( + CloudFrontOriginAccessIdentityConfig, + region +) +SELECT +'{{ CloudFrontOriginAccessIdentityConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.cloud_front_origin_access_identities ( + CloudFrontOriginAccessIdentityConfig, + region +) +SELECT + '{{ CloudFrontOriginAccessIdentityConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cloud_front_origin_access_identity + props: + - name: CloudFrontOriginAccessIdentityConfig + value: + Comment: '{{ Comment }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.cloud_front_origin_access_identities +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the cloud_front_origin_access_identities resource, the following permissions are required: + +### Create +```json +cloudfront:CreateCloudFrontOriginAccessIdentity +``` + +### Delete +```json +cloudfront:DeleteCloudFrontOriginAccessIdentity, +cloudfront:GetCloudFrontOriginAccessIdentity +``` + +### List +```json +cloudfront:ListCloudFrontOriginAccessIdentities +``` + +### Read +```json +cloudfront:GetCloudFrontOriginAccessIdentity +``` + +### Update +```json +cloudfront:UpdateCloudFrontOriginAccessIdentity, +cloudfront:GetCloudFrontOriginAccessIdentity +``` diff --git a/website/docs/services/cloudfront/cloud_front_origin_access_identities_list_only/index.md b/website/docs/services/cloudfront/cloud_front_origin_access_identities_list_only/index.md new file mode 100644 index 0000000..8e7438b --- /dev/null +++ b/website/docs/services/cloudfront/cloud_front_origin_access_identities_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cloud_front_origin_access_identities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_front_origin_access_identities_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cloud_front_origin_access_identities in a region or regions, for all properties use cloud_front_origin_access_identities + +## Overview + + + + + + + +
Namecloud_front_origin_access_identities_list_only
TypeResource
DescriptionThe request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see [Restricting Access to Amazon S3 Content by Using an Origin Access Identity](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cloud_front_origin_access_identities in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.cloud_front_origin_access_identities_list_only +; +``` + + +## Permissions + +For permissions required to operate on the cloud_front_origin_access_identities_list_only resource, see cloud_front_origin_access_identities + diff --git a/website/docs/services/cloudfront/continuous_deployment_policies/index.md b/website/docs/services/cloudfront/continuous_deployment_policies/index.md new file mode 100644 index 0000000..2ddc3af --- /dev/null +++ b/website/docs/services/cloudfront/continuous_deployment_policies/index.md @@ -0,0 +1,222 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a continuous_deployment_policy resource or lists continuous_deployment_policies in a region + +## Overview + + + + + + + +
Namecontinuous_deployment_policies
TypeResource
DescriptionCreates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution.
After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration.
For more information, see [Using CloudFront continuous deployment to safely test CDN configuration changes](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/continuous-deployment.html) in the *Amazon CloudFront Developer Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectContains the configuration for a continuous deployment policy.
string
string
stringAWS region.
+ +For more information, see AWS::CloudFront::ContinuousDeploymentPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all continuous_deployment_policies in a region. +```sql +SELECT +region, +continuous_deployment_policy_config, +id, +last_modified_time +FROM aws.cloudfront.continuous_deployment_policies +; +``` +Gets all properties from an individual continuous_deployment_policy. +```sql +SELECT +region, +continuous_deployment_policy_config, +id, +last_modified_time +FROM aws.cloudfront.continuous_deployment_policies +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new continuous_deployment_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.continuous_deployment_policies ( + ContinuousDeploymentPolicyConfig, + region +) +SELECT +'{{ ContinuousDeploymentPolicyConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.continuous_deployment_policies ( + ContinuousDeploymentPolicyConfig, + region +) +SELECT + '{{ ContinuousDeploymentPolicyConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: continuous_deployment_policy + props: + - name: ContinuousDeploymentPolicyConfig + value: + Enabled: '{{ Enabled }}' + SingleHeaderPolicyConfig: + Header: '{{ Header }}' + Value: '{{ Value }}' + SingleWeightPolicyConfig: + SessionStickinessConfig: + IdleTTL: '{{ IdleTTL }}' + MaximumTTL: '{{ MaximumTTL }}' + Weight: null + StagingDistributionDnsNames: + - '{{ StagingDistributionDnsNames[0] }}' + TrafficConfig: + SingleHeaderConfig: + Header: '{{ Header }}' + Value: '{{ Value }}' + SingleWeightConfig: + SessionStickinessConfig: null + Weight: null + Type: '{{ Type }}' + Type: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.continuous_deployment_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the continuous_deployment_policies resource, the following permissions are required: + +### Create +```json +cloudfront:CreateContinuousDeploymentPolicy +``` + +### Delete +```json +cloudfront:DeleteContinuousDeploymentPolicy, +cloudfront:GetContinuousDeploymentPolicy +``` + +### List +```json +cloudfront:ListContinuousDeploymentPolicies +``` + +### Read +```json +cloudfront:GetContinuousDeploymentPolicy +``` + +### Update +```json +cloudfront:UpdateContinuousDeploymentPolicy, +cloudfront:GetContinuousDeploymentPolicy +``` diff --git a/website/docs/services/cloudfront/continuous_deployment_policies_list_only/index.md b/website/docs/services/cloudfront/continuous_deployment_policies_list_only/index.md new file mode 100644 index 0000000..90cf38d --- /dev/null +++ b/website/docs/services/cloudfront/continuous_deployment_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: continuous_deployment_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - continuous_deployment_policies_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists continuous_deployment_policies in a region or regions, for all properties use continuous_deployment_policies + +## Overview + + + + + + + +
Namecontinuous_deployment_policies_list_only
TypeResource
DescriptionCreates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution.
After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration.
For more information, see [Using CloudFront continuous deployment to safely test CDN configuration changes](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/continuous-deployment.html) in the *Amazon CloudFront Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all continuous_deployment_policies in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.continuous_deployment_policies_list_only +; +``` + + +## Permissions + +For permissions required to operate on the continuous_deployment_policies_list_only resource, see continuous_deployment_policies + diff --git a/website/docs/services/cloudfront/distribution_tags/index.md b/website/docs/services/cloudfront/distribution_tags/index.md new file mode 100644 index 0000000..d5c3936 --- /dev/null +++ b/website/docs/services/cloudfront/distribution_tags/index.md @@ -0,0 +1,81 @@ +--- +title: distribution_tags +hide_title: false +hide_table_of_contents: false +keywords: + - distribution_tags + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for distributions in a region + +## Overview + + + + + + + +
Namedistribution_tags
TypeResource
DescriptionA distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
objectThe distribution's configuration.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all distributions in a region. +```sql +SELECT +region, +distribution_config, +domain_name, +id, +tag_key, +tag_value +FROM aws.cloudfront.distribution_tags +; +``` + + +## Permissions + +For permissions required to operate on the distribution_tags resource, see distributions + diff --git a/website/docs/services/cloudfront/distributions/index.md b/website/docs/services/cloudfront/distributions/index.md new file mode 100644 index 0000000..6e41889 --- /dev/null +++ b/website/docs/services/cloudfront/distributions/index.md @@ -0,0 +1,371 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a distribution resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectThe distribution's configuration.
string
string
arrayA complex type that contains zero or more Tag elements.
stringAWS region.
+ +For more information, see AWS::CloudFront::Distribution. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all distributions in a region. +```sql +SELECT +region, +distribution_config, +domain_name, +id, +tags +FROM aws.cloudfront.distributions +; +``` +Gets all properties from an individual distribution. +```sql +SELECT +region, +distribution_config, +domain_name, +id, +tags +FROM aws.cloudfront.distributions +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new distribution resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.distributions ( + DistributionConfig, + region +) +SELECT +'{{ DistributionConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.distributions ( + DistributionConfig, + Tags, + region +) +SELECT + '{{ DistributionConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: distribution + props: + - name: DistributionConfig + value: + Aliases: + - '{{ Aliases[0] }}' + AnycastIpListId: '{{ AnycastIpListId }}' + CNAMEs: + - '{{ CNAMEs[0] }}' + CacheBehaviors: + - AllowedMethods: + - '{{ AllowedMethods[0] }}' + CachePolicyId: '{{ CachePolicyId }}' + CachedMethods: + - '{{ CachedMethods[0] }}' + Compress: '{{ Compress }}' + DefaultTTL: null + FieldLevelEncryptionId: '{{ FieldLevelEncryptionId }}' + ForwardedValues: + Cookies: + Forward: '{{ Forward }}' + WhitelistedNames: + - '{{ WhitelistedNames[0] }}' + Headers: + - '{{ Headers[0] }}' + QueryString: '{{ QueryString }}' + QueryStringCacheKeys: + - '{{ QueryStringCacheKeys[0] }}' + FunctionAssociations: + - EventType: '{{ EventType }}' + FunctionARN: '{{ FunctionARN }}' + GrpcConfig: + Enabled: '{{ Enabled }}' + LambdaFunctionAssociations: + - EventType: '{{ EventType }}' + IncludeBody: '{{ IncludeBody }}' + LambdaFunctionARN: '{{ LambdaFunctionARN }}' + MaxTTL: null + MinTTL: null + OriginRequestPolicyId: '{{ OriginRequestPolicyId }}' + PathPattern: '{{ PathPattern }}' + RealtimeLogConfigArn: '{{ RealtimeLogConfigArn }}' + ResponseHeadersPolicyId: '{{ ResponseHeadersPolicyId }}' + SmoothStreaming: '{{ SmoothStreaming }}' + TargetOriginId: '{{ TargetOriginId }}' + TrustedKeyGroups: + - '{{ TrustedKeyGroups[0] }}' + TrustedSigners: + - '{{ TrustedSigners[0] }}' + ViewerProtocolPolicy: '{{ ViewerProtocolPolicy }}' + Comment: '{{ Comment }}' + ContinuousDeploymentPolicyId: '{{ ContinuousDeploymentPolicyId }}' + CustomErrorResponses: + - ErrorCachingMinTTL: null + ErrorCode: '{{ ErrorCode }}' + ResponseCode: '{{ ResponseCode }}' + ResponsePagePath: '{{ ResponsePagePath }}' + CustomOrigin: + DNSName: '{{ DNSName }}' + HTTPPort: '{{ HTTPPort }}' + HTTPSPort: '{{ HTTPSPort }}' + OriginProtocolPolicy: '{{ OriginProtocolPolicy }}' + OriginSSLProtocols: + - '{{ OriginSSLProtocols[0] }}' + DefaultCacheBehavior: + AllowedMethods: + - '{{ AllowedMethods[0] }}' + CachePolicyId: '{{ CachePolicyId }}' + CachedMethods: + - '{{ CachedMethods[0] }}' + Compress: '{{ Compress }}' + DefaultTTL: null + FieldLevelEncryptionId: '{{ FieldLevelEncryptionId }}' + ForwardedValues: null + FunctionAssociations: + - null + GrpcConfig: null + LambdaFunctionAssociations: + - null + MaxTTL: null + MinTTL: null + OriginRequestPolicyId: '{{ OriginRequestPolicyId }}' + RealtimeLogConfigArn: '{{ RealtimeLogConfigArn }}' + ResponseHeadersPolicyId: '{{ ResponseHeadersPolicyId }}' + SmoothStreaming: '{{ SmoothStreaming }}' + TargetOriginId: '{{ TargetOriginId }}' + TrustedKeyGroups: + - '{{ TrustedKeyGroups[0] }}' + TrustedSigners: + - '{{ TrustedSigners[0] }}' + ViewerProtocolPolicy: '{{ ViewerProtocolPolicy }}' + DefaultRootObject: '{{ DefaultRootObject }}' + Enabled: '{{ Enabled }}' + HttpVersion: '{{ HttpVersion }}' + IPV6Enabled: '{{ IPV6Enabled }}' + Logging: + Bucket: '{{ Bucket }}' + IncludeCookies: '{{ IncludeCookies }}' + Prefix: '{{ Prefix }}' + OriginGroups: + Items: + - FailoverCriteria: + StatusCodes: + Items: + - '{{ Items[0] }}' + Quantity: '{{ Quantity }}' + Id: '{{ Id }}' + Members: + Items: + - OriginId: '{{ OriginId }}' + Quantity: '{{ Quantity }}' + SelectionCriteria: '{{ SelectionCriteria }}' + Quantity: '{{ Quantity }}' + Origins: + - ConnectionAttempts: '{{ ConnectionAttempts }}' + ConnectionTimeout: '{{ ConnectionTimeout }}' + CustomOriginConfig: + HTTPPort: '{{ HTTPPort }}' + HTTPSPort: '{{ HTTPSPort }}' + OriginKeepaliveTimeout: '{{ OriginKeepaliveTimeout }}' + OriginProtocolPolicy: '{{ OriginProtocolPolicy }}' + OriginReadTimeout: '{{ OriginReadTimeout }}' + OriginSSLProtocols: + - '{{ OriginSSLProtocols[0] }}' + DomainName: '{{ DomainName }}' + Id: '{{ Id }}' + OriginAccessControlId: '{{ OriginAccessControlId }}' + OriginCustomHeaders: + - HeaderName: '{{ HeaderName }}' + HeaderValue: '{{ HeaderValue }}' + OriginPath: '{{ OriginPath }}' + OriginShield: + Enabled: '{{ Enabled }}' + OriginShieldRegion: '{{ OriginShieldRegion }}' + S3OriginConfig: + OriginAccessIdentity: '{{ OriginAccessIdentity }}' + PriceClass: '{{ PriceClass }}' + Restrictions: + GeoRestriction: + Locations: + - '{{ Locations[0] }}' + RestrictionType: '{{ RestrictionType }}' + S3Origin: + DNSName: '{{ DNSName }}' + OriginAccessIdentity: '{{ OriginAccessIdentity }}' + Staging: '{{ Staging }}' + ViewerCertificate: + AcmCertificateArn: '{{ AcmCertificateArn }}' + CloudFrontDefaultCertificate: '{{ CloudFrontDefaultCertificate }}' + IamCertificateId: '{{ IamCertificateId }}' + MinimumProtocolVersion: '{{ MinimumProtocolVersion }}' + SslSupportMethod: '{{ SslSupportMethod }}' + WebACLId: '{{ WebACLId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.distributions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the distributions resource, the following permissions are required: + +### Create +```json +cloudfront:CreateDistribution, +cloudfront:CreateDistributionWithTags, +cloudfront:GetDistribution, +cloudfront:GetDistributionConfig, +cloudfront:TagResource +``` + +### Delete +```json +cloudfront:DeleteDistribution, +cloudfront:GetDistribution, +cloudfront:GetDistributionConfig +``` + +### List +```json +cloudfront:ListDistributions +``` + +### 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/website/docs/services/cloudfront/distributions_list_only/index.md b/website/docs/services/cloudfront/distributions_list_only/index.md new file mode 100644 index 0000000..19c6c7f --- /dev/null +++ b/website/docs/services/cloudfront/distributions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: distributions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - distributions_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists distributions in a region or regions, for all properties use distributions + +## Overview + + + + + + + +
Namedistributions_list_only
TypeResource
DescriptionA distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all distributions in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.distributions_list_only +; +``` + + +## Permissions + +For permissions required to operate on the distributions_list_only resource, see distributions + diff --git a/website/docs/services/cloudfront/functions/index.md b/website/docs/services/cloudfront/functions/index.md new file mode 100644 index 0000000..dfcd734 --- /dev/null +++ b/website/docs/services/cloudfront/functions/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a function resource or lists functions in a region + +## Overview + + + + + + + +
Namefunctions
TypeResource
DescriptionCreates a CF function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function, and the function’s stage.
By default, when you create a function, it’s in the DEVELOPMENT stage. In this stage, you can [test the function](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/test-function.html) in the CF console (or with TestFunction in the CF API).
When you’re ready to use your function with a CF distribution, publish the function to the LIVE stage. You can do this in the CF console, with PublishFunction in the CF API, or by updating the AWS::CloudFront::Function resource with the AutoPublish property set to true. When the function is published to the LIVE stage, you can attach it to a distribution’s cache behavior, using the function’s ARN.
To automatically publish the function to the LIVE stage when it’s created, set the AutoPublish property to true.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
booleanA flag that determines whether to automatically publish the function to the LIVE stage when it’s created. To automatically publish to the LIVE stage, set this property to true.
string
stringThe function code. For more information about writing a CloudFront function, see [Writing function code for CloudFront Functions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) in the *Amazon CloudFront Developer Guide*.
objectContains configuration information about a CloudFront function.
objectContains metadata about a CloudFront function.
stringA name to identify the function.
string
stringAWS region.
+ +For more information, see AWS::CloudFront::Function. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all functions in a region. +```sql +SELECT +region, +auto_publish, +function_arn, +function_code, +function_config, +function_metadata, +name, +stage +FROM aws.cloudfront.functions +; +``` +Gets all properties from an individual function. +```sql +SELECT +region, +auto_publish, +function_arn, +function_code, +function_config, +function_metadata, +name, +stage +FROM aws.cloudfront.functions +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new function resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.functions ( + FunctionCode, + FunctionConfig, + Name, + region +) +SELECT +'{{ FunctionCode }}', + '{{ FunctionConfig }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.functions ( + AutoPublish, + FunctionCode, + FunctionConfig, + FunctionMetadata, + Name, + region +) +SELECT + '{{ AutoPublish }}', + '{{ FunctionCode }}', + '{{ FunctionConfig }}', + '{{ FunctionMetadata }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: function + props: + - name: AutoPublish + value: '{{ AutoPublish }}' + - name: FunctionCode + value: '{{ FunctionCode }}' + - name: FunctionConfig + value: + Comment: '{{ Comment }}' + Runtime: '{{ Runtime }}' + KeyValueStoreAssociations: + - KeyValueStoreARN: '{{ KeyValueStoreARN }}' + - name: FunctionMetadata + value: + FunctionARN: '{{ FunctionARN }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.functions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the functions resource, the following permissions are required: + +### Create +```json +cloudfront:CreateFunction, +cloudfront:PublishFunction, +cloudfront:DescribeFunction +``` + +### Delete +```json +cloudfront:DeleteFunction, +cloudfront:DescribeFunction +``` + +### List +```json +cloudfront:ListFunctions +``` + +### Read +```json +cloudfront:DescribeFunction, +cloudfront:GetFunction +``` + +### Update +```json +cloudfront:UpdateFunction, +cloudfront:PublishFunction, +cloudfront:DescribeFunction +``` diff --git a/website/docs/services/cloudfront/functions_list_only/index.md b/website/docs/services/cloudfront/functions_list_only/index.md new file mode 100644 index 0000000..493553c --- /dev/null +++ b/website/docs/services/cloudfront/functions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: functions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - functions_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists functions in a region or regions, for all properties use functions + +## Overview + + + + + + + +
Namefunctions_list_only
TypeResource
DescriptionCreates a CF function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function, and the function’s stage.
By default, when you create a function, it’s in the DEVELOPMENT stage. In this stage, you can [test the function](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/test-function.html) in the CF console (or with TestFunction in the CF API).
When you’re ready to use your function with a CF distribution, publish the function to the LIVE stage. You can do this in the CF console, with PublishFunction in the CF API, or by updating the AWS::CloudFront::Function resource with the AutoPublish property set to true. When the function is published to the LIVE stage, you can attach it to a distribution’s cache behavior, using the function’s ARN.
To automatically publish the function to the LIVE stage when it’s created, set the AutoPublish property to true.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all functions in a region. +```sql +SELECT +region, +function_arn +FROM aws.cloudfront.functions_list_only +; +``` + + +## Permissions + +For permissions required to operate on the functions_list_only resource, see functions + diff --git a/website/docs/services/cloudfront/index.md b/website/docs/services/cloudfront/index.md new file mode 100644 index 0000000..c628fe2 --- /dev/null +++ b/website/docs/services/cloudfront/index.md @@ -0,0 +1,64 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cloudfront service documentation. + +:::info Service Summary + +
+
+total resources: 29
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cloudfront/key_groups/index.md b/website/docs/services/cloudfront/key_groups/index.md new file mode 100644 index 0000000..71164de --- /dev/null +++ b/website/docs/services/cloudfront/key_groups/index.md @@ -0,0 +1,206 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a key_group resource or lists key_groups in a region + +## Overview + + + + + + + +
Namekey_groups
TypeResource
DescriptionA key group.
A key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html).
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
objectThe key group configuration.
string
stringAWS region.
+ +For more information, see AWS::CloudFront::KeyGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all key_groups in a region. +```sql +SELECT +region, +id, +key_group_config, +last_modified_time +FROM aws.cloudfront.key_groups +; +``` +Gets all properties from an individual key_group. +```sql +SELECT +region, +id, +key_group_config, +last_modified_time +FROM aws.cloudfront.key_groups +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new key_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.key_groups ( + KeyGroupConfig, + region +) +SELECT +'{{ KeyGroupConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.key_groups ( + KeyGroupConfig, + region +) +SELECT + '{{ KeyGroupConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: key_group + props: + - name: KeyGroupConfig + value: + Comment: '{{ Comment }}' + Items: + - '{{ Items[0] }}' + Name: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.key_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the key_groups resource, the following permissions are required: + +### Create +```json +cloudfront:CreateKeyGroup +``` + +### Delete +```json +cloudfront:DeleteKeyGroup, +cloudfront:GetKeyGroup +``` + +### List +```json +cloudfront:ListKeyGroups +``` + +### Read +```json +cloudfront:GetKeyGroup +``` + +### Update +```json +cloudfront:UpdateKeyGroup, +cloudfront:GetKeyGroup +``` diff --git a/website/docs/services/cloudfront/key_groups_list_only/index.md b/website/docs/services/cloudfront/key_groups_list_only/index.md new file mode 100644 index 0000000..c2fd688 --- /dev/null +++ b/website/docs/services/cloudfront/key_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: key_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - key_groups_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists key_groups in a region or regions, for all properties use key_groups + +## Overview + + + + + + + +
Namekey_groups_list_only
TypeResource
DescriptionA key group.
A key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all key_groups in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.key_groups_list_only +; +``` + + +## Permissions + +For permissions required to operate on the key_groups_list_only resource, see key_groups + diff --git a/website/docs/services/cloudfront/key_value_stores/index.md b/website/docs/services/cloudfront/key_value_stores/index.md new file mode 100644 index 0000000..9d072dc --- /dev/null +++ b/website/docs/services/cloudfront/key_value_stores/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a key_value_store resource or lists key_value_stores in a region + +## Overview + + + + + + + +
Namekey_value_stores
TypeResource
DescriptionThe key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
stringThe name of the key value store.
stringA comment for the key value store.
objectThe import source for the key value store.
stringAWS region.
+ +For more information, see AWS::CloudFront::KeyValueStore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all key_value_stores in a region. +```sql +SELECT +region, +arn, +id, +status, +name, +comment, +import_source +FROM aws.cloudfront.key_value_stores +; +``` +Gets all properties from an individual key_value_store. +```sql +SELECT +region, +arn, +id, +status, +name, +comment, +import_source +FROM aws.cloudfront.key_value_stores +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new key_value_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.key_value_stores ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.key_value_stores ( + Name, + Comment, + ImportSource, + region +) +SELECT + '{{ Name }}', + '{{ Comment }}', + '{{ ImportSource }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: key_value_store + props: + - name: Name + value: '{{ Name }}' + - name: Comment + value: '{{ Comment }}' + - name: ImportSource + value: + SourceType: '{{ SourceType }}' + SourceArn: '{{ SourceArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.key_value_stores +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### Delete +```json +cloudfront:DeleteKeyValueStore, +cloudfront:DescribeKeyValueStore +``` + +### List +```json +cloudfront:ListKeyValueStores +``` + +### Read +```json +cloudfront:DescribeKeyValueStore +``` + +### Update +```json +cloudfront:UpdateKeyValueStore, +cloudfront:DescribeKeyValueStore +``` diff --git a/website/docs/services/cloudfront/key_value_stores_list_only/index.md b/website/docs/services/cloudfront/key_value_stores_list_only/index.md new file mode 100644 index 0000000..c16c11b --- /dev/null +++ b/website/docs/services/cloudfront/key_value_stores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: key_value_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - key_value_stores_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists key_value_stores in a region or regions, for all properties use key_value_stores + +## Overview + + + + + + + +
Namekey_value_stores_list_only
TypeResource
DescriptionThe key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the key value store.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all key_value_stores in a region. +```sql +SELECT +region, +name +FROM aws.cloudfront.key_value_stores_list_only +; +``` + + +## Permissions + +For permissions required to operate on the key_value_stores_list_only resource, see key_value_stores + diff --git a/website/docs/services/cloudfront/monitoring_subscriptions/index.md b/website/docs/services/cloudfront/monitoring_subscriptions/index.md new file mode 100644 index 0000000..23bfdac --- /dev/null +++ b/website/docs/services/cloudfront/monitoring_subscriptions/index.md @@ -0,0 +1,177 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a monitoring_subscription resource or lists monitoring_subscriptions in a region + +## Overview + + + + + + + +
Namemonitoring_subscriptions
TypeResource
DescriptionA monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the distribution that you are enabling metrics for.
objectA subscription configuration for additional CloudWatch metrics.
stringAWS region.
+ +For more information, see AWS::CloudFront::MonitoringSubscription. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual monitoring_subscription. +```sql +SELECT +region, +distribution_id, +monitoring_subscription +FROM aws.cloudfront.monitoring_subscriptions +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new monitoring_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.monitoring_subscriptions ( + DistributionId, + MonitoringSubscription, + region +) +SELECT +'{{ DistributionId }}', + '{{ MonitoringSubscription }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.monitoring_subscriptions ( + DistributionId, + MonitoringSubscription, + region +) +SELECT + '{{ DistributionId }}', + '{{ MonitoringSubscription }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: monitoring_subscription + props: + - name: DistributionId + value: '{{ DistributionId }}' + - name: MonitoringSubscription + value: + DistributionId: '{{ DistributionId }}' + MonitoringSubscription: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.monitoring_subscriptions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the monitoring_subscriptions resource, the following permissions are required: + +### Create +```json +cloudfront:CreateMonitoringSubscription +``` + +### Delete +```json +cloudfront:DeleteMonitoringSubscription +``` + +### Read +```json +cloudfront:GetMonitoringSubscription +``` diff --git a/website/docs/services/cloudfront/origin_access_controls/index.md b/website/docs/services/cloudfront/origin_access_controls/index.md new file mode 100644 index 0000000..7724734 --- /dev/null +++ b/website/docs/services/cloudfront/origin_access_controls/index.md @@ -0,0 +1,204 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an origin_access_control resource or lists origin_access_controls in a region + +## Overview + + + + + + + +
Nameorigin_access_controls
TypeResource
DescriptionCreates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see [Restricting access to an origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
objectThe origin access control.
stringAWS region.
+ +For more information, see AWS::CloudFront::OriginAccessControl. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all origin_access_controls in a region. +```sql +SELECT +region, +id, +origin_access_control_config +FROM aws.cloudfront.origin_access_controls +; +``` +Gets all properties from an individual origin_access_control. +```sql +SELECT +region, +id, +origin_access_control_config +FROM aws.cloudfront.origin_access_controls +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new origin_access_control resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.origin_access_controls ( + OriginAccessControlConfig, + region +) +SELECT +'{{ OriginAccessControlConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.origin_access_controls ( + OriginAccessControlConfig, + region +) +SELECT + '{{ OriginAccessControlConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: origin_access_control + props: + - name: OriginAccessControlConfig + value: + Description: '{{ Description }}' + Name: '{{ Name }}' + OriginAccessControlOriginType: '{{ OriginAccessControlOriginType }}' + SigningBehavior: '{{ SigningBehavior }}' + SigningProtocol: '{{ SigningProtocol }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.origin_access_controls +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the origin_access_controls resource, the following permissions are required: + +### Create +```json +cloudfront:CreateOriginAccessControl +``` + +### Delete +```json +cloudfront:DeleteOriginAccessControl, +cloudfront:GetOriginAccessControl +``` + +### List +```json +cloudfront:ListOriginAccessControls +``` + +### Read +```json +cloudfront:GetOriginAccessControl +``` + +### Update +```json +cloudfront:UpdateOriginAccessControl, +cloudfront:GetOriginAccessControl +``` diff --git a/website/docs/services/cloudfront/origin_access_controls_list_only/index.md b/website/docs/services/cloudfront/origin_access_controls_list_only/index.md new file mode 100644 index 0000000..a96257d --- /dev/null +++ b/website/docs/services/cloudfront/origin_access_controls_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: origin_access_controls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - origin_access_controls_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists origin_access_controls in a region or regions, for all properties use origin_access_controls + +## Overview + + + + + + + +
Nameorigin_access_controls_list_only
TypeResource
DescriptionCreates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see [Restricting access to an origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all origin_access_controls in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.origin_access_controls_list_only +; +``` + + +## Permissions + +For permissions required to operate on the origin_access_controls_list_only resource, see origin_access_controls + diff --git a/website/docs/services/cloudfront/origin_request_policies/index.md b/website/docs/services/cloudfront/origin_request_policies/index.md new file mode 100644 index 0000000..0a3f3f8 --- /dev/null +++ b/website/docs/services/cloudfront/origin_request_policies/index.md @@ -0,0 +1,216 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an origin_request_policy resource or lists origin_request_policies in a region + +## Overview + + + + + + + +
Nameorigin_request_policies
TypeResource
DescriptionAn origin request policy.
When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
+ The request body and the URL path (without the domain name) from the viewer request.
+ The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.
+ All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
objectThe origin request policy configuration.
stringAWS region.
+ +For more information, see AWS::CloudFront::OriginRequestPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all origin_request_policies in a region. +```sql +SELECT +region, +id, +last_modified_time, +origin_request_policy_config +FROM aws.cloudfront.origin_request_policies +; +``` +Gets all properties from an individual origin_request_policy. +```sql +SELECT +region, +id, +last_modified_time, +origin_request_policy_config +FROM aws.cloudfront.origin_request_policies +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new origin_request_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.origin_request_policies ( + OriginRequestPolicyConfig, + region +) +SELECT +'{{ OriginRequestPolicyConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.origin_request_policies ( + OriginRequestPolicyConfig, + region +) +SELECT + '{{ OriginRequestPolicyConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: origin_request_policy + props: + - name: OriginRequestPolicyConfig + value: + Comment: '{{ Comment }}' + CookiesConfig: + CookieBehavior: '{{ CookieBehavior }}' + Cookies: + - '{{ Cookies[0] }}' + HeadersConfig: + HeaderBehavior: '{{ HeaderBehavior }}' + Headers: + - '{{ Headers[0] }}' + Name: '{{ Name }}' + QueryStringsConfig: + QueryStringBehavior: '{{ QueryStringBehavior }}' + QueryStrings: + - '{{ QueryStrings[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.origin_request_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the origin_request_policies resource, the following permissions are required: + +### Create +```json +cloudfront:CreateOriginRequestPolicy +``` + +### Delete +```json +cloudfront:DeleteOriginRequestPolicy, +cloudfront:GetOriginRequestPolicy +``` + +### List +```json +cloudfront:ListOriginRequestPolicies +``` + +### Read +```json +cloudfront:GetOriginRequestPolicy +``` + +### Update +```json +cloudfront:UpdateOriginRequestPolicy, +cloudfront:GetOriginRequestPolicy +``` diff --git a/website/docs/services/cloudfront/origin_request_policies_list_only/index.md b/website/docs/services/cloudfront/origin_request_policies_list_only/index.md new file mode 100644 index 0000000..6e39903 --- /dev/null +++ b/website/docs/services/cloudfront/origin_request_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: origin_request_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - origin_request_policies_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists origin_request_policies in a region or regions, for all properties use origin_request_policies + +## Overview + + + + + + + +
Nameorigin_request_policies_list_only
TypeResource
DescriptionAn origin request policy.
When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
+ The request body and the URL path (without the domain name) from the viewer request.
+ The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.
+ All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all origin_request_policies in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.origin_request_policies_list_only +; +``` + + +## Permissions + +For permissions required to operate on the origin_request_policies_list_only resource, see origin_request_policies + diff --git a/website/docs/services/cloudfront/public_keys/index.md b/website/docs/services/cloudfront/public_keys/index.md new file mode 100644 index 0000000..fce5769 --- /dev/null +++ b/website/docs/services/cloudfront/public_keys/index.md @@ -0,0 +1,206 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a public_key resource or lists public_keys in a region + +## Overview + + + + + + + +
Namepublic_keys
TypeResource
DescriptionA public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
objectConfiguration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).
stringAWS region.
+ +For more information, see AWS::CloudFront::PublicKey. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all public_keys in a region. +```sql +SELECT +region, +created_time, +id, +public_key_config +FROM aws.cloudfront.public_keys +; +``` +Gets all properties from an individual public_key. +```sql +SELECT +region, +created_time, +id, +public_key_config +FROM aws.cloudfront.public_keys +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new public_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.public_keys ( + PublicKeyConfig, + region +) +SELECT +'{{ PublicKeyConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.public_keys ( + PublicKeyConfig, + region +) +SELECT + '{{ PublicKeyConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: public_key + props: + - name: PublicKeyConfig + value: + CallerReference: '{{ CallerReference }}' + Comment: '{{ Comment }}' + EncodedKey: '{{ EncodedKey }}' + Name: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.public_keys +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the public_keys resource, the following permissions are required: + +### Create +```json +cloudfront:CreatePublicKey +``` + +### Delete +```json +cloudfront:DeletePublicKey, +cloudfront:GetPublicKey +``` + +### List +```json +cloudfront:ListPublicKeys +``` + +### Read +```json +cloudfront:GetPublicKey +``` + +### Update +```json +cloudfront:UpdatePublicKey, +cloudfront:GetPublicKey +``` diff --git a/website/docs/services/cloudfront/public_keys_list_only/index.md b/website/docs/services/cloudfront/public_keys_list_only/index.md new file mode 100644 index 0000000..4cb0a2c --- /dev/null +++ b/website/docs/services/cloudfront/public_keys_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: public_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - public_keys_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists public_keys in a region or regions, for all properties use public_keys + +## Overview + + + + + + + +
Namepublic_keys_list_only
TypeResource
DescriptionA public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all public_keys in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.public_keys_list_only +; +``` + + +## Permissions + +For permissions required to operate on the public_keys_list_only resource, see public_keys + diff --git a/website/docs/services/cloudfront/realtime_log_configs/index.md b/website/docs/services/cloudfront/realtime_log_configs/index.md new file mode 100644 index 0000000..9a51da7 --- /dev/null +++ b/website/docs/services/cloudfront/realtime_log_configs/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a realtime_log_config resource or lists realtime_log_configs in a region + +## Overview + + + + + + + +
Namerealtime_log_configs
TypeResource
DescriptionA real-time log configuration.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
arrayContains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
arrayA list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
For more information about fields, see [Real-time log configuration fields](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) in the *Amazon CloudFront Developer Guide*.
stringThe unique name of this real-time log configuration.
numberThe sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.
stringAWS region.
+ +For more information, see AWS::CloudFront::RealtimeLogConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all realtime_log_configs in a region. +```sql +SELECT +region, +arn, +end_points, +fields, +name, +sampling_rate +FROM aws.cloudfront.realtime_log_configs +; +``` +Gets all properties from an individual realtime_log_config. +```sql +SELECT +region, +arn, +end_points, +fields, +name, +sampling_rate +FROM aws.cloudfront.realtime_log_configs +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new realtime_log_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.realtime_log_configs ( + EndPoints, + Fields, + Name, + SamplingRate, + region +) +SELECT +'{{ EndPoints }}', + '{{ Fields }}', + '{{ Name }}', + '{{ SamplingRate }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.realtime_log_configs ( + EndPoints, + Fields, + Name, + SamplingRate, + region +) +SELECT + '{{ EndPoints }}', + '{{ Fields }}', + '{{ Name }}', + '{{ SamplingRate }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: realtime_log_config + props: + - name: EndPoints + value: + - KinesisStreamConfig: + RoleArn: '{{ RoleArn }}' + StreamArn: '{{ StreamArn }}' + StreamType: '{{ StreamType }}' + - name: Fields + value: + - '{{ Fields[0] }}' + - name: Name + value: '{{ Name }}' + - name: SamplingRate + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.realtime_log_configs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the realtime_log_configs resource, the following permissions are required: + +### Create +```json +cloudfront:CreateRealtimeLogConfig, +iam:PassRole +``` + +### Delete +```json +cloudfront:DeleteRealtimeLogConfig, +cloudfront:GetRealtimeLogConfig +``` + +### List +```json +cloudfront:ListRealtimeLogConfigs +``` + +### Read +```json +cloudfront:GetRealtimeLogConfig +``` + +### Update +```json +cloudfront:UpdateRealtimeLogConfig, +cloudfront:GetRealtimeLogConfig, +iam:PassRole +``` diff --git a/website/docs/services/cloudfront/realtime_log_configs_list_only/index.md b/website/docs/services/cloudfront/realtime_log_configs_list_only/index.md new file mode 100644 index 0000000..8705620 --- /dev/null +++ b/website/docs/services/cloudfront/realtime_log_configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: realtime_log_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - realtime_log_configs_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists realtime_log_configs in a region or regions, for all properties use realtime_log_configs + +## Overview + + + + + + + +
Namerealtime_log_configs_list_only
TypeResource
DescriptionA real-time log configuration.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all realtime_log_configs in a region. +```sql +SELECT +region, +arn +FROM aws.cloudfront.realtime_log_configs_list_only +; +``` + + +## Permissions + +For permissions required to operate on the realtime_log_configs_list_only resource, see realtime_log_configs + diff --git a/website/docs/services/cloudfront/response_headers_policies/index.md b/website/docs/services/cloudfront/response_headers_policies/index.md new file mode 100644 index 0000000..d18272a --- /dev/null +++ b/website/docs/services/cloudfront/response_headers_policies/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a response_headers_policy resource or lists response_headers_policies in a region + +## Overview + + + + + + + +
Nameresponse_headers_policies
TypeResource
DescriptionA response headers policy.
A response headers policy contains information about a set of HTTP response headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see [Adding or removing HTTP headers in CloudFront responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html) in the *Amazon CloudFront Developer Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
objectA response headers policy configuration.
stringAWS region.
+ +For more information, see AWS::CloudFront::ResponseHeadersPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all response_headers_policies in a region. +```sql +SELECT +region, +id, +last_modified_time, +response_headers_policy_config +FROM aws.cloudfront.response_headers_policies +; +``` +Gets all properties from an individual response_headers_policy. +```sql +SELECT +region, +id, +last_modified_time, +response_headers_policy_config +FROM aws.cloudfront.response_headers_policies +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new response_headers_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.response_headers_policies ( + ResponseHeadersPolicyConfig, + region +) +SELECT +'{{ ResponseHeadersPolicyConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudfront.response_headers_policies ( + ResponseHeadersPolicyConfig, + region +) +SELECT + '{{ ResponseHeadersPolicyConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: response_headers_policy + props: + - name: ResponseHeadersPolicyConfig + value: + Comment: '{{ Comment }}' + CorsConfig: + AccessControlAllowCredentials: '{{ AccessControlAllowCredentials }}' + AccessControlAllowHeaders: + Items: + - '{{ Items[0] }}' + AccessControlAllowMethods: + Items: + - '{{ Items[0] }}' + AccessControlAllowOrigins: + Items: + - '{{ Items[0] }}' + AccessControlExposeHeaders: + Items: + - '{{ Items[0] }}' + AccessControlMaxAgeSec: '{{ AccessControlMaxAgeSec }}' + OriginOverride: '{{ OriginOverride }}' + CustomHeadersConfig: + Items: + - Header: '{{ Header }}' + Override: '{{ Override }}' + Value: '{{ Value }}' + Name: '{{ Name }}' + RemoveHeadersConfig: + Items: + - Header: '{{ Header }}' + SecurityHeadersConfig: + ContentSecurityPolicy: + ContentSecurityPolicy: '{{ ContentSecurityPolicy }}' + Override: '{{ Override }}' + ContentTypeOptions: + Override: '{{ Override }}' + FrameOptions: + FrameOption: '{{ FrameOption }}' + Override: '{{ Override }}' + ReferrerPolicy: + Override: '{{ Override }}' + ReferrerPolicy: '{{ ReferrerPolicy }}' + StrictTransportSecurity: + AccessControlMaxAgeSec: '{{ AccessControlMaxAgeSec }}' + IncludeSubdomains: '{{ IncludeSubdomains }}' + Override: '{{ Override }}' + Preload: '{{ Preload }}' + XSSProtection: + ModeBlock: '{{ ModeBlock }}' + Override: '{{ Override }}' + Protection: '{{ Protection }}' + ReportUri: '{{ ReportUri }}' + ServerTimingHeadersConfig: + Enabled: '{{ Enabled }}' + SamplingRate: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudfront.response_headers_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the response_headers_policies resource, the following permissions are required: + +### Create +```json +cloudfront:CreateResponseHeadersPolicy +``` + +### Delete +```json +cloudfront:DeleteResponseHeadersPolicy, +cloudfront:GetResponseHeadersPolicy +``` + +### List +```json +cloudfront:ListResponseHeadersPolicies +``` + +### Read +```json +cloudfront:GetResponseHeadersPolicy +``` + +### Update +```json +cloudfront:UpdateResponseHeadersPolicy, +cloudfront:GetResponseHeadersPolicy +``` diff --git a/website/docs/services/cloudfront/response_headers_policies_list_only/index.md b/website/docs/services/cloudfront/response_headers_policies_list_only/index.md new file mode 100644 index 0000000..c7ccf9d --- /dev/null +++ b/website/docs/services/cloudfront/response_headers_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: response_headers_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - response_headers_policies_list_only + - cloudfront + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists response_headers_policies in a region or regions, for all properties use response_headers_policies + +## Overview + + + + + + + +
Nameresponse_headers_policies_list_only
TypeResource
DescriptionA response headers policy.
A response headers policy contains information about a set of HTTP response headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see [Adding or removing HTTP headers in CloudFront responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html) in the *Amazon CloudFront Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all response_headers_policies in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.response_headers_policies_list_only +; +``` + + +## Permissions + +For permissions required to operate on the response_headers_policies_list_only resource, see response_headers_policies + diff --git a/website/docs/services/cloudhsm/backups/index.md b/website/docs/services/cloudhsm/backups/index.md new file mode 100644 index 0000000..0c3889d --- /dev/null +++ b/website/docs/services/cloudhsm/backups/index.md @@ -0,0 +1,93 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter. + +## Overview + + + + + + + +
Namebackups
TypeResource
DescriptionContains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier (ID) of the backup.
stringThe state of the backup.
stringThe identifier (ID) of the cluster that was backed up.
stringThe date and time when the backup was created.
stringThe date and time when the backup was copied from a source backup.
booleanSpecifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
stringThe AWS Region that contains the source backup from which the new backup was copied.
stringThe identifier (ID) of the source backup from which the new backup was copied.
stringThe identifier (ID) of the cluster containing the source backup from which the new backup was copied.
stringThe date and time when the backup will be permanently deleted.
arrayThe list of tags for the backup.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
DELETE
EXEC
EXEC
EXEC
+ + + + + + diff --git a/website/docs/services/cloudhsm/clusters/index.md b/website/docs/services/cloudhsm/clusters/index.md new file mode 100644 index 0000000..fa1c818 --- /dev/null +++ b/website/docs/services/cloudhsm/clusters/index.md @@ -0,0 +1,97 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Contains information about an AWS CloudHSM cluster. + +## Overview + + + + + + + +
Nameclusters
TypeResource
DescriptionContains information about an AWS CloudHSM cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe cluster's backup policy.
objectA policy that defines how the service retains backups.
stringThe cluster's identifier (ID).
stringThe date and time when the cluster was created.
arrayContains information about the HSMs in the cluster.
stringThe type of HSM that the cluster contains.
stringThe default password for the cluster's Pre-Crypto Officer (PRECO) user.
stringThe identifier (ID) of the cluster's security group.
stringThe identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
stringThe cluster's state.
stringA description of the cluster's state.
objectA map from availability zone to the cluster’s subnet in that availability zone.
stringThe identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
objectContains one or more certificates or a certificate signing request (CSR).
arrayThe list of tags for the cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
INSERT
DELETE
EXEC
EXEC
+ + + + + + diff --git a/website/docs/services/cloudhsm/hsm/index.md b/website/docs/services/cloudhsm/hsm/index.md new file mode 100644 index 0000000..ac5f5b6 --- /dev/null +++ b/website/docs/services/cloudhsm/hsm/index.md @@ -0,0 +1,63 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster. + +## Overview + + + + + + + +
Namehsm
TypeResource
Descriptionhsm
Id
+ +## Fields +SELECT operation not supported for this resource. + +## Methods + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
+ + + + + + diff --git a/website/docs/services/cloudhsm/index.md b/website/docs/services/cloudhsm/index.md new file mode 100644 index 0000000..d3e0a9a --- /dev/null +++ b/website/docs/services/cloudhsm/index.md @@ -0,0 +1,39 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cloudhsm service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources +
+ +
+hsm
+tags +
+
\ No newline at end of file diff --git a/website/docs/services/cloudhsm/tags/index.md b/website/docs/services/cloudhsm/tags/index.md new file mode 100644 index 0000000..4a3dbdb --- /dev/null +++ b/website/docs/services/cloudhsm/tags/index.md @@ -0,0 +1,74 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Contains a tag. A tag is a key-value pair. + +## Overview + + + + + + + +
Nametags
TypeResource
DescriptionContains a tag. A tag is a key-value pair.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe key of the tag.
stringThe value of the tag.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
EXEC
EXEC
+ + + + + + diff --git a/website/docs/services/cloudtrail/channel_tags/index.md b/website/docs/services/cloudtrail/channel_tags/index.md new file mode 100644 index 0000000..31906ce --- /dev/null +++ b/website/docs/services/cloudtrail/channel_tags/index.md @@ -0,0 +1,83 @@ +--- +title: channel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_tags + - cloudtrail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channels in a region + +## Overview + + + + + + + +
Namechannel_tags
TypeResource
DescriptionA channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the channel.
stringThe ARN of an on-premises storage solution or application, or a partner event source.
arrayOne or more resources to which events arriving through a channel are logged and stored.
stringThe Amazon Resource Name (ARN) of a channel.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channels in a region. +```sql +SELECT +region, +name, +source, +destinations, +channel_arn, +tag_key, +tag_value +FROM aws.cloudtrail.channel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_tags resource, see channels + diff --git a/website/docs/services/cloudtrail/channels/index.md b/website/docs/services/cloudtrail/channels/index.md new file mode 100644 index 0000000..aa8ba6e --- /dev/null +++ b/website/docs/services/cloudtrail/channels/index.md @@ -0,0 +1,227 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a channel resource or lists 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.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the channel.
stringThe ARN of an on-premises storage solution or application, or a partner event source.
arrayOne or more resources to which events arriving through a channel are logged and stored.
stringThe Amazon Resource Name (ARN) of a channel.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::CloudTrail::Channel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all channels in a region. +```sql +SELECT +region, +name, +source, +destinations, +channel_arn, +tags +FROM aws.cloudtrail.channels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual channel. +```sql +SELECT +region, +name, +source, +destinations, +channel_arn, +tags +FROM aws.cloudtrail.channels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudtrail.channels ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudtrail.channels ( + Name, + Source, + Destinations, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Source }}', + '{{ Destinations }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: channel + props: + - name: Name + value: '{{ Name }}' + - name: Source + value: '{{ Source }}' + - name: Destinations + value: + - Type: '{{ Type }}' + Location: '{{ Location }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudtrail.channels +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +```json +CloudTrail:CreateChannel, +CloudTrail:AddTags +``` + +### Read +```json +CloudTrail:GetChannel, +CloudTrail:ListChannels +``` + +### Update +```json +CloudTrail:UpdateChannel, +CloudTrail:GetChannel, +CloudTrail:AddTags, +CloudTrail:RemoveTags +``` + +### Delete +```json +CloudTrail:DeleteChannel +``` + +### List +```json +CloudTrail:ListChannels +``` diff --git a/website/docs/services/cloudtrail/channels_list_only/index.md b/website/docs/services/cloudtrail/channels_list_only/index.md new file mode 100644 index 0000000..4d8f4c2 --- /dev/null +++ b/website/docs/services/cloudtrail/channels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channels_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channels in a region or regions, for all properties use channels + +## Overview + + + + + + + +
Namechannels_list_only
TypeResource
DescriptionA channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of a channel.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channels in a region. +```sql +SELECT +region, +channel_arn +FROM aws.cloudtrail.channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channels_list_only resource, see channels + diff --git a/website/docs/services/cloudtrail/dashboard_tags/index.md b/website/docs/services/cloudtrail/dashboard_tags/index.md new file mode 100644 index 0000000..b632094 --- /dev/null +++ b/website/docs/services/cloudtrail/dashboard_tags/index.md @@ -0,0 +1,93 @@ +--- +title: dashboard_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dashboard_tags + - cloudtrail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dashboards in a region + +## Overview + + + + + + + +
Namedashboard_tags
TypeResource
DescriptionThe Amazon CloudTrail dashboard resource allows customers to manage managed dashboards and create custom dashboards. You can manually refresh custom and managed dashboards. For custom dashboards, you can also set up an automatic refresh schedule and modify dashboard widgets.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayList of widgets on the dashboard
stringThe timestamp of the dashboard creation.
stringThe ARN of the dashboard.
objectConfigures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule.
stringThe name of the dashboard.
stringThe status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
booleanIndicates whether the dashboard is protected from termination.
stringThe type of the dashboard. Values are CUSTOM and MANAGED.
stringThe timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dashboards in a region. +```sql +SELECT +region, +widgets, +created_timestamp, +dashboard_arn, +refresh_schedule, +name, +status, +termination_protection_enabled, +type, +updated_timestamp, +tag_key, +tag_value +FROM aws.cloudtrail.dashboard_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboard_tags resource, see dashboards + diff --git a/website/docs/services/cloudtrail/dashboards/index.md b/website/docs/services/cloudtrail/dashboards/index.md new file mode 100644 index 0000000..f0228b2 --- /dev/null +++ b/website/docs/services/cloudtrail/dashboards/index.md @@ -0,0 +1,260 @@ +--- +title: dashboards +hide_title: false +hide_table_of_contents: false +keywords: + - dashboards + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dashboard resource or lists dashboards in a region + +## Overview + + + + + + + +
Namedashboards
TypeResource
DescriptionThe Amazon CloudTrail dashboard resource allows customers to manage managed dashboards and create custom dashboards. You can manually refresh custom and managed dashboards. For custom dashboards, you can also set up an automatic refresh schedule and modify dashboard widgets.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayList of widgets on the dashboard
stringThe timestamp of the dashboard creation.
stringThe ARN of the dashboard.
objectConfigures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule.
stringThe name of the dashboard.
stringThe status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
booleanIndicates whether the dashboard is protected from termination.
stringThe type of the dashboard. Values are CUSTOM and MANAGED.
stringThe timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
array
stringAWS region.
+ +For more information, see AWS::CloudTrail::Dashboard. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dashboards in a region. +```sql +SELECT +region, +widgets, +created_timestamp, +dashboard_arn, +refresh_schedule, +name, +status, +termination_protection_enabled, +type, +updated_timestamp, +tags +FROM aws.cloudtrail.dashboards +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dashboard. +```sql +SELECT +region, +widgets, +created_timestamp, +dashboard_arn, +refresh_schedule, +name, +status, +termination_protection_enabled, +type, +updated_timestamp, +tags +FROM aws.cloudtrail.dashboards +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dashboard resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudtrail.dashboards ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudtrail.dashboards ( + Widgets, + RefreshSchedule, + Name, + TerminationProtectionEnabled, + Tags, + region +) +SELECT + '{{ Widgets }}', + '{{ RefreshSchedule }}', + '{{ Name }}', + '{{ TerminationProtectionEnabled }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dashboard + props: + - name: Widgets + value: + - QueryStatement: '{{ QueryStatement }}' + QueryParameters: + - '{{ QueryParameters[0] }}' + ViewProperties: {} + - name: RefreshSchedule + value: + Frequency: + Unit: '{{ Unit }}' + Value: '{{ Value }}' + TimeOfDay: '{{ TimeOfDay }}' + Status: '{{ Status }}' + - name: Name + value: '{{ Name }}' + - name: TerminationProtectionEnabled + value: '{{ TerminationProtectionEnabled }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudtrail.dashboards +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the dashboards resource, the following permissions are required: + +### Create +```json +CloudTrail:CreateDashboard, +CloudTrail:AddTags, +CloudTrail:StartQuery, +CloudTrail:StartDashboardRefresh +``` + +### Read +```json +CloudTrail:GetDashboard, +CloudTrail:ListDashboards, +CloudTrail:ListTags +``` + +### Update +```json +CloudTrail:UpdateDashboard, +CloudTrail:AddTags, +CloudTrail:RemoveTags, +CloudTrail:StartQuery, +CloudTrail:StartDashboardRefresh +``` + +### Delete +```json +CloudTrail:DeleteDashboard, +CloudTrail:UpdateDashboard +``` + +### List +```json +CloudTrail:ListDashboards, +CloudTrail:GetDashboard, +CloudTrail:ListTags +``` diff --git a/website/docs/services/cloudtrail/dashboards_list_only/index.md b/website/docs/services/cloudtrail/dashboards_list_only/index.md new file mode 100644 index 0000000..4cb42e9 --- /dev/null +++ b/website/docs/services/cloudtrail/dashboards_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dashboards_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dashboards_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dashboards in a region or regions, for all properties use dashboards + +## Overview + + + + + + + +
Namedashboards_list_only
TypeResource
DescriptionThe Amazon CloudTrail dashboard resource allows customers to manage managed dashboards and create custom dashboards. You can manually refresh custom and managed dashboards. For custom dashboards, you can also set up an automatic refresh schedule and modify dashboard widgets.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the dashboard.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dashboards in a region. +```sql +SELECT +region, +dashboard_arn +FROM aws.cloudtrail.dashboards_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboards_list_only resource, see dashboards + diff --git a/website/docs/services/cloudtrail/event_data_store_tags/index.md b/website/docs/services/cloudtrail/event_data_store_tags/index.md new file mode 100644 index 0000000..78c8790 --- /dev/null +++ b/website/docs/services/cloudtrail/event_data_store_tags/index.md @@ -0,0 +1,109 @@ +--- +title: event_data_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_data_store_tags + - cloudtrail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_data_stores in a region + +## Overview + + + + + + + +
Nameevent_data_store_tags
TypeResource
DescriptionA storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe advanced event selectors that were used to select events for the data store.
stringThe timestamp of the event data store's creation.
stringThe ARN of the event data store.
booleanIndicates whether federation is enabled on an event data store.
stringThe ARN of the role used for event data store federation.
booleanIndicates whether the event data store includes events from all regions, or only from the region in which it was created.
stringThe name of the event data store.
booleanIndicates that an event data store is collecting logged events for an organization.
stringThe mode that the event data store will use to charge for event storage.
integerThe retention period, in days.
stringThe status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
booleanIndicates whether the event data store is protected from termination.
stringThe timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
stringSpecifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
arrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
stringSpecifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
booleanIndicates whether the event data store is ingesting events.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_data_stores in a region. +```sql +SELECT +region, +advanced_event_selectors, +created_timestamp, +event_data_store_arn, +federation_enabled, +federation_role_arn, +multi_region_enabled, +name, +organization_enabled, +billing_mode, +retention_period, +status, +termination_protection_enabled, +updated_timestamp, +kms_key_id, +insight_selectors, +insights_destination, +ingestion_enabled, +tag_key, +tag_value +FROM aws.cloudtrail.event_data_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_data_store_tags resource, see event_data_stores + diff --git a/website/docs/services/cloudtrail/event_data_stores/index.md b/website/docs/services/cloudtrail/event_data_stores/index.md new file mode 100644 index 0000000..4c03e31 --- /dev/null +++ b/website/docs/services/cloudtrail/event_data_stores/index.md @@ -0,0 +1,362 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_data_store resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe advanced event selectors that were used to select events for the data store.
stringThe timestamp of the event data store's creation.
stringThe ARN of the event data store.
booleanIndicates whether federation is enabled on an event data store.
stringThe ARN of the role used for event data store federation.
booleanIndicates whether the event data store includes events from all regions, or only from the region in which it was created.
stringThe name of the event data store.
booleanIndicates that an event data store is collecting logged events for an organization.
stringThe mode that the event data store will use to charge for event storage.
integerThe retention period, in days.
stringThe status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
booleanIndicates whether the event data store is protected from termination.
stringThe timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
stringSpecifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
array
arrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
stringSpecifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
booleanIndicates whether the event data store is ingesting events.
stringAWS region.
+ +For more information, see AWS::CloudTrail::EventDataStore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_data_stores in a region. +```sql +SELECT +region, +advanced_event_selectors, +created_timestamp, +event_data_store_arn, +federation_enabled, +federation_role_arn, +multi_region_enabled, +name, +organization_enabled, +billing_mode, +retention_period, +status, +termination_protection_enabled, +updated_timestamp, +kms_key_id, +tags, +insight_selectors, +insights_destination, +ingestion_enabled +FROM aws.cloudtrail.event_data_stores +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_data_store. +```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_stores +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_data_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudtrail.event_data_stores ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudtrail.event_data_stores ( + AdvancedEventSelectors, + FederationEnabled, + FederationRoleArn, + MultiRegionEnabled, + Name, + OrganizationEnabled, + BillingMode, + RetentionPeriod, + TerminationProtectionEnabled, + KmsKeyId, + Tags, + InsightSelectors, + InsightsDestination, + IngestionEnabled, + region +) +SELECT + '{{ AdvancedEventSelectors }}', + '{{ FederationEnabled }}', + '{{ FederationRoleArn }}', + '{{ MultiRegionEnabled }}', + '{{ Name }}', + '{{ OrganizationEnabled }}', + '{{ BillingMode }}', + '{{ RetentionPeriod }}', + '{{ TerminationProtectionEnabled }}', + '{{ KmsKeyId }}', + '{{ Tags }}', + '{{ InsightSelectors }}', + '{{ InsightsDestination }}', + '{{ IngestionEnabled }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_data_store + props: + - name: AdvancedEventSelectors + value: + - FieldSelectors: + - Field: '{{ Field }}' + Equals: + - '{{ Equals[0] }}' + NotStartsWith: + - '{{ NotStartsWith[0] }}' + NotEndsWith: + - '{{ NotEndsWith[0] }}' + StartsWith: + - '{{ StartsWith[0] }}' + EndsWith: + - '{{ EndsWith[0] }}' + NotEquals: + - '{{ NotEquals[0] }}' + Name: '{{ Name }}' + - name: FederationEnabled + value: '{{ FederationEnabled }}' + - name: FederationRoleArn + value: '{{ FederationRoleArn }}' + - name: MultiRegionEnabled + value: '{{ MultiRegionEnabled }}' + - name: Name + value: '{{ Name }}' + - name: OrganizationEnabled + value: '{{ OrganizationEnabled }}' + - name: BillingMode + value: '{{ BillingMode }}' + - name: RetentionPeriod + value: '{{ RetentionPeriod }}' + - name: TerminationProtectionEnabled + value: '{{ TerminationProtectionEnabled }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: InsightSelectors + value: + - InsightType: '{{ InsightType }}' + - name: InsightsDestination + value: '{{ InsightsDestination }}' + - name: IngestionEnabled + value: '{{ IngestionEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudtrail.event_data_stores +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +CloudTrail:ListEventDataStores, +CloudTrail:GetEventDataStore, +CloudTrail:GetInsightSelectors, +CloudTrail:ListTags +``` diff --git a/website/docs/services/cloudtrail/event_data_stores_list_only/index.md b/website/docs/services/cloudtrail/event_data_stores_list_only/index.md new file mode 100644 index 0000000..61803e9 --- /dev/null +++ b/website/docs/services/cloudtrail/event_data_stores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: event_data_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_data_stores_list_only + - cloudtrail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_data_stores in a region or regions, for all properties use event_data_stores + +## Overview + + + + + + + +
Nameevent_data_stores_list_only
TypeResource
DescriptionA storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the event data store.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_data_stores in a region. +```sql +SELECT +region, +event_data_store_arn +FROM aws.cloudtrail.event_data_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_data_stores_list_only resource, see event_data_stores + diff --git a/website/docs/services/cloudtrail/index.md b/website/docs/services/cloudtrail/index.md new file mode 100644 index 0000000..15cca57 --- /dev/null +++ b/website/docs/services/cloudtrail/index.md @@ -0,0 +1,48 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cloudtrail service documentation. + +:::info Service Summary + +
+
+total resources: 13
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cloudtrail/resource_policies/index.md b/website/docs/services/cloudtrail/resource_policies/index.md new file mode 100644 index 0000000..11ff17c --- /dev/null +++ b/website/docs/services/cloudtrail/resource_policies/index.md @@ -0,0 +1,187 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_policy resource or lists resource_policies in a region + +## Overview + + + + + + + +
Nameresource_policies
TypeResource
DescriptionResource Type definition for AWS::CloudTrail::ResourcePolicy
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ARN of the AWS CloudTrail resource to which the policy applies.
objectA 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.
stringAWS region.
+ +For more information, see AWS::CloudTrail::ResourcePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual resource_policy. +```sql +SELECT +region, +resource_arn, +resource_policy +FROM aws.cloudtrail.resource_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudtrail.resource_policies ( + ResourceArn, + ResourcePolicy, + region +) +SELECT +'{{ ResourceArn }}', + '{{ ResourcePolicy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudtrail.resource_policies ( + ResourceArn, + ResourcePolicy, + region +) +SELECT + '{{ ResourceArn }}', + '{{ ResourcePolicy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_policy + props: + - name: ResourceArn + value: '{{ ResourceArn }}' + - name: ResourcePolicy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudtrail.resource_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +CloudTrail:PutResourcePolicy, +CloudTrail:GetResourcePolicy +``` + +### Read +```json +CloudTrail:GetResourcePolicy +``` + +### Update +```json +CloudTrail:PutResourcePolicy, +CloudTrail:GetResourcePolicy +``` + +### Delete +```json +CloudTrail:DeleteResourcePolicy +``` diff --git a/website/docs/services/cloudtrail/trail_tags/index.md b/website/docs/services/cloudtrail/trail_tags/index.md new file mode 100644 index 0000000..6238a8d --- /dev/null +++ b/website/docs/services/cloudtrail/trail_tags/index.md @@ -0,0 +1,109 @@ +--- +title: trail_tags +hide_title: false +hide_table_of_contents: false +keywords: + - trail_tags + - cloudtrail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for trails in a region + +## Overview + + + + + + + +
Nametrail_tags
TypeResource
DescriptionCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanSpecifies whether the trail is publishing events from global services such as IAM to the log files.
arrayUse event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
stringSpecifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
stringSpecifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
stringSpecifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
arrayThe advanced event selectors that were used to select events for the data store.
string
booleanSpecifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
arrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
stringSpecifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
stringSpecifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
booleanSpecifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
stringSpecifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
string
booleanSpecifies whether log file validation is enabled. The default is false.
string
booleanWhether the CloudTrail is currently logging AWS API calls.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all trails in a region. +```sql +SELECT +region, +include_global_service_events, +event_selectors, +kms_key_id, +cloud_watch_logs_role_arn, +s3_key_prefix, +advanced_event_selectors, +trail_name, +is_organization_trail, +insight_selectors, +cloud_watch_logs_log_group_arn, +sns_topic_name, +is_multi_region_trail, +s3_bucket_name, +sns_topic_arn, +enable_log_file_validation, +arn, +is_logging, +tag_key, +tag_value +FROM aws.cloudtrail.trail_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trail_tags resource, see trails + diff --git a/website/docs/services/cloudtrail/trails/index.md b/website/docs/services/cloudtrail/trails/index.md new file mode 100644 index 0000000..bb31692 --- /dev/null +++ b/website/docs/services/cloudtrail/trails/index.md @@ -0,0 +1,366 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a trail resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanSpecifies whether the trail is publishing events from global services such as IAM to the log files.
arrayUse event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
stringSpecifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
stringSpecifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
stringSpecifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
arrayThe advanced event selectors that were used to select events for the data store.
string
booleanSpecifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
arrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
stringSpecifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
stringSpecifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
booleanSpecifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
stringSpecifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
string
booleanSpecifies whether log file validation is enabled. The default is false.
string
array
booleanWhether the CloudTrail is currently logging AWS API calls.
stringAWS region.
+ +For more information, see AWS::CloudTrail::Trail. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all trails in a region. +```sql +SELECT +region, +include_global_service_events, +event_selectors, +kms_key_id, +cloud_watch_logs_role_arn, +s3_key_prefix, +advanced_event_selectors, +trail_name, +is_organization_trail, +insight_selectors, +cloud_watch_logs_log_group_arn, +sns_topic_name, +is_multi_region_trail, +s3_bucket_name, +sns_topic_arn, +enable_log_file_validation, +arn, +tags, +is_logging +FROM aws.cloudtrail.trails +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual trail. +```sql +SELECT +region, +include_global_service_events, +event_selectors, +kms_key_id, +cloud_watch_logs_role_arn, +s3_key_prefix, +advanced_event_selectors, +trail_name, +is_organization_trail, +insight_selectors, +cloud_watch_logs_log_group_arn, +sns_topic_name, +is_multi_region_trail, +s3_bucket_name, +sns_topic_arn, +enable_log_file_validation, +arn, +tags, +is_logging +FROM aws.cloudtrail.trails +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new trail resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudtrail.trails ( + S3BucketName, + IsLogging, + region +) +SELECT +'{{ S3BucketName }}', + '{{ IsLogging }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudtrail.trails ( + IncludeGlobalServiceEvents, + EventSelectors, + KMSKeyId, + CloudWatchLogsRoleArn, + S3KeyPrefix, + AdvancedEventSelectors, + TrailName, + IsOrganizationTrail, + InsightSelectors, + CloudWatchLogsLogGroupArn, + SnsTopicName, + IsMultiRegionTrail, + S3BucketName, + EnableLogFileValidation, + Tags, + IsLogging, + region +) +SELECT + '{{ IncludeGlobalServiceEvents }}', + '{{ EventSelectors }}', + '{{ KMSKeyId }}', + '{{ CloudWatchLogsRoleArn }}', + '{{ S3KeyPrefix }}', + '{{ AdvancedEventSelectors }}', + '{{ TrailName }}', + '{{ IsOrganizationTrail }}', + '{{ InsightSelectors }}', + '{{ CloudWatchLogsLogGroupArn }}', + '{{ SnsTopicName }}', + '{{ IsMultiRegionTrail }}', + '{{ S3BucketName }}', + '{{ EnableLogFileValidation }}', + '{{ Tags }}', + '{{ IsLogging }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: trail + props: + - name: IncludeGlobalServiceEvents + value: '{{ IncludeGlobalServiceEvents }}' + - name: EventSelectors + value: + - IncludeManagementEvents: '{{ IncludeManagementEvents }}' + ReadWriteType: '{{ ReadWriteType }}' + ExcludeManagementEventSources: + - '{{ ExcludeManagementEventSources[0] }}' + DataResources: + - Type: '{{ Type }}' + Values: + - '{{ Values[0] }}' + - name: KMSKeyId + value: '{{ KMSKeyId }}' + - name: CloudWatchLogsRoleArn + value: '{{ CloudWatchLogsRoleArn }}' + - name: S3KeyPrefix + value: '{{ S3KeyPrefix }}' + - name: AdvancedEventSelectors + value: + - FieldSelectors: + - Field: '{{ Field }}' + Equals: + - '{{ Equals[0] }}' + NotStartsWith: + - '{{ NotStartsWith[0] }}' + NotEndsWith: + - '{{ NotEndsWith[0] }}' + StartsWith: + - '{{ StartsWith[0] }}' + EndsWith: + - '{{ EndsWith[0] }}' + NotEquals: + - '{{ NotEquals[0] }}' + Name: '{{ Name }}' + - name: TrailName + value: '{{ TrailName }}' + - name: IsOrganizationTrail + value: '{{ IsOrganizationTrail }}' + - name: InsightSelectors + value: + - InsightType: '{{ InsightType }}' + - name: CloudWatchLogsLogGroupArn + value: '{{ CloudWatchLogsLogGroupArn }}' + - name: SnsTopicName + value: '{{ SnsTopicName }}' + - name: IsMultiRegionTrail + value: '{{ IsMultiRegionTrail }}' + - name: S3BucketName + value: '{{ S3BucketName }}' + - name: EnableLogFileValidation + value: '{{ EnableLogFileValidation }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: IsLogging + value: '{{ IsLogging }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudtrail.trails +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the trails resource, the following permissions are required: + +### Read +```json +CloudTrail:GetTrail, +CloudTrail:GetTrailStatus, +CloudTrail:ListTags, +CloudTrail:GetEventSelectors, +CloudTrail:GetInsightSelectors, +CloudTrail:DescribeTrails +``` + +### Create +```json +CloudTrail:CreateTrail, +CloudTrail:StartLogging, +CloudTrail:AddTags, +CloudTrail:PutEventSelectors, +CloudTrail:PutInsightSelectors, +iam:GetRole, +iam:PassRole, +iam:CreateServiceLinkedRole, +organizations:DescribeOrganization, +organizations:ListAWSServiceAccessForOrganization +``` + +### 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 +``` + +### List +```json +CloudTrail:ListTrails, +CloudTrail:GetTrail, +CloudTrail:GetTrailStatus, +CloudTrail:ListTags, +CloudTrail:GetEventSelectors, +CloudTrail:GetInsightSelectors, +CloudTrail:DescribeTrails +``` + +### Delete +```json +CloudTrail:DeleteTrail +``` diff --git a/website/docs/services/cloudtrail/trails_list_only/index.md b/website/docs/services/cloudtrail/trails_list_only/index.md new file mode 100644 index 0000000..65729b4 --- /dev/null +++ b/website/docs/services/cloudtrail/trails_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: trails_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trails_list_only + - cloudtrail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trails in a region or regions, for all properties use trails + +## Overview + + + + + + + +
Nametrails_list_only
TypeResource
DescriptionCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trails in a region. +```sql +SELECT +region, +trail_name +FROM aws.cloudtrail.trails_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trails_list_only resource, see trails + diff --git a/website/docs/services/cloudwatch/alarm_tags/index.md b/website/docs/services/cloudwatch/alarm_tags/index.md new file mode 100644 index 0000000..ce3b650 --- /dev/null +++ b/website/docs/services/cloudwatch/alarm_tags/index.md @@ -0,0 +1,119 @@ +--- +title: alarm_tags +hide_title: false +hide_table_of_contents: false +keywords: + - alarm_tags + - cloudwatch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for alarms in a region + +## Overview + + + + + + + +
Namealarm_tags
TypeResource
DescriptionThe AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIn an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
stringUsed only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
stringThe percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
For an alarm based on a math expression, you can't specify ExtendedStatistic. Instead, you use Metrics.
stringThe arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
stringSets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.
If you omit this parameter, the default behavior of missing is used.
arrayThe dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
integerThe period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
For an alarm based on a math expression, you can't specify Period, and instead you use the Metrics parameter.
*Minimum:* 10
integerThe number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and DatapointsToAlarm is the M.
For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
stringThe unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a Metrics array.
You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
stringThe namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.
For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
arrayThe actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
arrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
stringThe name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.
booleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
arrayAn array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
If you specify the Metrics parameter, you cannot specify MetricName, Dimensions, Period, Namespace, Statistic, ExtendedStatistic, or Unit.
stringThe description of the alarm.
stringThe name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringThe statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.
arrayThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
string
integerThe number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for EvaluationPeriods is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
If you omit this parameter, CW uses the same value here that you set for EvaluationPeriods, and the alarm goes to alarm state if that many consecutive periods are breaching.
numberThe value to compare with the specified statistic.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all alarms in a region. +```sql +SELECT +region, +threshold_metric_id, +evaluate_low_sample_count_percentile, +extended_statistic, +comparison_operator, +treat_missing_data, +dimensions, +period, +evaluation_periods, +unit, +namespace, +ok_actions, +alarm_actions, +metric_name, +actions_enabled, +metrics, +alarm_description, +alarm_name, +statistic, +insufficient_data_actions, +arn, +datapoints_to_alarm, +threshold, +tag_key, +tag_value +FROM aws.cloudwatch.alarm_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alarm_tags resource, see alarms + diff --git a/website/docs/services/cloudwatch/alarms/index.md b/website/docs/services/cloudwatch/alarms/index.md new file mode 100644 index 0000000..d6511f3 --- /dev/null +++ b/website/docs/services/cloudwatch/alarms/index.md @@ -0,0 +1,375 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an alarm resource or lists 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.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIn an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
stringUsed only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
stringThe percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
For an alarm based on a math expression, you can't specify ExtendedStatistic. Instead, you use Metrics.
stringThe arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
stringSets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.
If you omit this parameter, the default behavior of missing is used.
arrayThe dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
integerThe period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
For an alarm based on a math expression, you can't specify Period, and instead you use the Metrics parameter.
*Minimum:* 10
integerThe number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and DatapointsToAlarm is the M.
For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
stringThe unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a Metrics array.
You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
stringThe namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.
For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
arrayThe actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
arrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
stringThe name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.
booleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
arrayAn array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
If you specify the Metrics parameter, you cannot specify MetricName, Dimensions, Period, Namespace, Statistic, ExtendedStatistic, or Unit.
stringThe description of the alarm.
stringThe name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringThe statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.
arrayThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
string
integerThe number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for EvaluationPeriods is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
If you omit this parameter, CW uses the same value here that you set for EvaluationPeriods, and the alarm goes to alarm state if that many consecutive periods are breaching.
numberThe value to compare with the specified statistic.
arrayA list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
stringAWS region.
+ +For more information, see AWS::CloudWatch::Alarm. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all alarms in a region. +```sql +SELECT +region, +threshold_metric_id, +evaluate_low_sample_count_percentile, +extended_statistic, +comparison_operator, +treat_missing_data, +dimensions, +period, +evaluation_periods, +unit, +namespace, +ok_actions, +alarm_actions, +metric_name, +actions_enabled, +metrics, +alarm_description, +alarm_name, +statistic, +insufficient_data_actions, +arn, +datapoints_to_alarm, +threshold, +tags +FROM aws.cloudwatch.alarms +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual alarm. +```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.alarms +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alarm resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudwatch.alarms ( + ComparisonOperator, + EvaluationPeriods, + region +) +SELECT +'{{ ComparisonOperator }}', + '{{ EvaluationPeriods }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudwatch.alarms ( + ThresholdMetricId, + EvaluateLowSampleCountPercentile, + ExtendedStatistic, + ComparisonOperator, + TreatMissingData, + Dimensions, + Period, + EvaluationPeriods, + Unit, + Namespace, + OKActions, + AlarmActions, + MetricName, + ActionsEnabled, + Metrics, + AlarmDescription, + AlarmName, + Statistic, + InsufficientDataActions, + DatapointsToAlarm, + Threshold, + Tags, + region +) +SELECT + '{{ ThresholdMetricId }}', + '{{ EvaluateLowSampleCountPercentile }}', + '{{ ExtendedStatistic }}', + '{{ ComparisonOperator }}', + '{{ TreatMissingData }}', + '{{ Dimensions }}', + '{{ Period }}', + '{{ EvaluationPeriods }}', + '{{ Unit }}', + '{{ Namespace }}', + '{{ OKActions }}', + '{{ AlarmActions }}', + '{{ MetricName }}', + '{{ ActionsEnabled }}', + '{{ Metrics }}', + '{{ AlarmDescription }}', + '{{ AlarmName }}', + '{{ Statistic }}', + '{{ InsufficientDataActions }}', + '{{ DatapointsToAlarm }}', + '{{ Threshold }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: alarm + props: + - name: ThresholdMetricId + value: '{{ ThresholdMetricId }}' + - name: EvaluateLowSampleCountPercentile + value: '{{ EvaluateLowSampleCountPercentile }}' + - name: ExtendedStatistic + value: '{{ ExtendedStatistic }}' + - name: ComparisonOperator + value: '{{ ComparisonOperator }}' + - name: TreatMissingData + value: '{{ TreatMissingData }}' + - name: Dimensions + value: + - Value: '{{ Value }}' + Name: '{{ Name }}' + - name: Period + value: '{{ Period }}' + - name: EvaluationPeriods + value: '{{ EvaluationPeriods }}' + - name: Unit + value: '{{ Unit }}' + - name: Namespace + value: '{{ Namespace }}' + - name: OKActions + value: + - '{{ OKActions[0] }}' + - name: AlarmActions + value: + - '{{ AlarmActions[0] }}' + - name: MetricName + value: '{{ MetricName }}' + - name: ActionsEnabled + value: '{{ ActionsEnabled }}' + - name: Metrics + value: + - Label: '{{ Label }}' + MetricStat: + Period: '{{ Period }}' + Metric: + MetricName: '{{ MetricName }}' + Dimensions: + - null + Namespace: '{{ Namespace }}' + Stat: '{{ Stat }}' + Unit: '{{ Unit }}' + Id: '{{ Id }}' + ReturnData: '{{ ReturnData }}' + Expression: '{{ Expression }}' + Period: '{{ Period }}' + AccountId: '{{ AccountId }}' + - name: AlarmDescription + value: '{{ AlarmDescription }}' + - name: AlarmName + value: '{{ AlarmName }}' + - name: Statistic + value: '{{ Statistic }}' + - name: InsufficientDataActions + value: + - '{{ InsufficientDataActions[0] }}' + - name: DatapointsToAlarm + value: '{{ DatapointsToAlarm }}' + - name: Threshold + value: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudwatch.alarms +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the alarms resource, the following permissions are required: + +### Create +```json +cloudwatch:PutMetricAlarm, +cloudwatch:DescribeAlarms, +cloudwatch:TagResource +``` + +### Update +```json +cloudwatch:PutMetricAlarm, +cloudwatch:DescribeAlarms, +cloudwatch:TagResource, +cloudwatch:UntagResource +``` + +### Delete +```json +cloudwatch:DeleteAlarms, +cloudwatch:DescribeAlarms +``` + +### List +```json +cloudwatch:DescribeAlarms +``` + +### Read +```json +cloudwatch:DescribeAlarms, +cloudwatch:ListTagsForResource +``` diff --git a/website/docs/services/cloudwatch/alarms_list_only/index.md b/website/docs/services/cloudwatch/alarms_list_only/index.md new file mode 100644 index 0000000..7d4e688 --- /dev/null +++ b/website/docs/services/cloudwatch/alarms_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: alarms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - alarms_list_only + - cloudwatch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists alarms in a region or regions, for all properties use alarms + +## Overview + + + + + + + +
Namealarms_list_only
TypeResource
DescriptionThe AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all alarms in a region. +```sql +SELECT +region, +alarm_name +FROM aws.cloudwatch.alarms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alarms_list_only resource, see alarms + diff --git a/website/docs/services/cloudwatch/composite_alarm_tags/index.md b/website/docs/services/cloudwatch/composite_alarm_tags/index.md new file mode 100644 index 0000000..ae9ea73 --- /dev/null +++ b/website/docs/services/cloudwatch/composite_alarm_tags/index.md @@ -0,0 +1,97 @@ +--- +title: composite_alarm_tags +hide_title: false +hide_table_of_contents: false +keywords: + - composite_alarm_tags + - cloudwatch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for composite_alarms in a region + +## Overview + + + + + + + +
Namecomposite_alarm_tags
TypeResource
DescriptionThe AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN) of the alarm
stringThe name of the Composite Alarm
stringExpression which aggregates the state of other Alarms (Metric or Composite Alarms)
stringThe description of the alarm
booleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
arrayThe actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
arrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).
arrayThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
stringActions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
integerActions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
integerActions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all composite_alarms in a region. +```sql +SELECT +region, +arn, +alarm_name, +alarm_rule, +alarm_description, +actions_enabled, +ok_actions, +alarm_actions, +insufficient_data_actions, +actions_suppressor, +actions_suppressor_wait_period, +actions_suppressor_extension_period, +tag_key, +tag_value +FROM aws.cloudwatch.composite_alarm_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the composite_alarm_tags resource, see composite_alarms + diff --git a/website/docs/services/cloudwatch/composite_alarms/index.md b/website/docs/services/cloudwatch/composite_alarms/index.md new file mode 100644 index 0000000..2ab2599 --- /dev/null +++ b/website/docs/services/cloudwatch/composite_alarms/index.md @@ -0,0 +1,279 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a composite_alarm resource or lists 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
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN) of the alarm
stringThe name of the Composite Alarm
stringExpression which aggregates the state of other Alarms (Metric or Composite Alarms)
stringThe description of the alarm
booleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
arrayThe actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
arrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).
arrayThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
stringActions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
integerActions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
integerActions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
arrayA list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
stringAWS region.
+ +For more information, see AWS::CloudWatch::CompositeAlarm. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all composite_alarms in a region. +```sql +SELECT +region, +arn, +alarm_name, +alarm_rule, +alarm_description, +actions_enabled, +ok_actions, +alarm_actions, +insufficient_data_actions, +actions_suppressor, +actions_suppressor_wait_period, +actions_suppressor_extension_period, +tags +FROM aws.cloudwatch.composite_alarms +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual composite_alarm. +```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_alarms +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new composite_alarm resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudwatch.composite_alarms ( + AlarmRule, + region +) +SELECT +'{{ AlarmRule }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudwatch.composite_alarms ( + AlarmName, + AlarmRule, + AlarmDescription, + ActionsEnabled, + OKActions, + AlarmActions, + InsufficientDataActions, + ActionsSuppressor, + ActionsSuppressorWaitPeriod, + ActionsSuppressorExtensionPeriod, + Tags, + region +) +SELECT + '{{ AlarmName }}', + '{{ AlarmRule }}', + '{{ AlarmDescription }}', + '{{ ActionsEnabled }}', + '{{ OKActions }}', + '{{ AlarmActions }}', + '{{ InsufficientDataActions }}', + '{{ ActionsSuppressor }}', + '{{ ActionsSuppressorWaitPeriod }}', + '{{ ActionsSuppressorExtensionPeriod }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: composite_alarm + props: + - name: AlarmName + value: '{{ AlarmName }}' + - name: AlarmRule + value: '{{ AlarmRule }}' + - name: AlarmDescription + value: '{{ AlarmDescription }}' + - name: ActionsEnabled + value: '{{ ActionsEnabled }}' + - name: OKActions + value: + - '{{ OKActions[0] }}' + - name: AlarmActions + value: + - '{{ AlarmActions[0] }}' + - name: InsufficientDataActions + value: + - '{{ InsufficientDataActions[0] }}' + - name: ActionsSuppressor + value: '{{ ActionsSuppressor }}' + - name: ActionsSuppressorWaitPeriod + value: '{{ ActionsSuppressorWaitPeriod }}' + - name: ActionsSuppressorExtensionPeriod + value: '{{ ActionsSuppressorExtensionPeriod }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudwatch.composite_alarms +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cloudwatch:DescribeAlarms, +cloudwatch:ListTagsForResource +``` + +### Update +```json +cloudwatch:DescribeAlarms, +cloudwatch:PutCompositeAlarm, +cloudwatch:TagResource, +cloudwatch:UntagResource +``` + +### Delete +```json +cloudwatch:DescribeAlarms, +cloudwatch:DeleteAlarms +``` + +### List +```json +cloudwatch:DescribeAlarms +``` diff --git a/website/docs/services/cloudwatch/composite_alarms_list_only/index.md b/website/docs/services/cloudwatch/composite_alarms_list_only/index.md new file mode 100644 index 0000000..5e04edc --- /dev/null +++ b/website/docs/services/cloudwatch/composite_alarms_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: composite_alarms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - composite_alarms_list_only + - cloudwatch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists composite_alarms in a region or regions, for all properties use composite_alarms + +## Overview + + + + + + + +
Namecomposite_alarms_list_only
TypeResource
DescriptionThe AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Composite Alarm
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all composite_alarms in a region. +```sql +SELECT +region, +alarm_name +FROM aws.cloudwatch.composite_alarms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the composite_alarms_list_only resource, see composite_alarms + diff --git a/website/docs/services/cloudwatch/dashboards/index.md b/website/docs/services/cloudwatch/dashboards/index.md new file mode 100644 index 0000000..8ca0a0d --- /dev/null +++ b/website/docs/services/cloudwatch/dashboards/index.md @@ -0,0 +1,203 @@ +--- +title: dashboards +hide_title: false +hide_table_of_contents: false +keywords: + - dashboards + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dashboard resource or lists dashboards in a region + +## Overview + + + + + + + +
Namedashboards
TypeResource
DescriptionResource Type definition for AWS::CloudWatch::Dashboard
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.
stringThe detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard
stringAWS region.
+ +For more information, see AWS::CloudWatch::Dashboard. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dashboards in a region. +```sql +SELECT +region, +dashboard_name, +dashboard_body +FROM aws.cloudwatch.dashboards +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dashboard. +```sql +SELECT +region, +dashboard_name, +dashboard_body +FROM aws.cloudwatch.dashboards +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dashboard resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudwatch.dashboards ( + DashboardBody, + region +) +SELECT +'{{ DashboardBody }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudwatch.dashboards ( + DashboardName, + DashboardBody, + region +) +SELECT + '{{ DashboardName }}', + '{{ DashboardBody }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dashboard + props: + - name: DashboardName + value: '{{ DashboardName }}' + - name: DashboardBody + value: '{{ DashboardBody }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudwatch.dashboards +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the dashboards resource, the following permissions are required: + +### Create +```json +cloudwatch:PutDashboard, +cloudwatch:GetDashboard +``` + +### Read +```json +cloudwatch:GetDashboard +``` + +### Update +```json +cloudwatch:PutDashboard +``` + +### Delete +```json +cloudwatch:DeleteDashboards, +cloudwatch:GetDashboard +``` + +### List +```json +cloudwatch:ListDashboards +``` diff --git a/website/docs/services/cloudwatch/dashboards_list_only/index.md b/website/docs/services/cloudwatch/dashboards_list_only/index.md new file mode 100644 index 0000000..b1e79e7 --- /dev/null +++ b/website/docs/services/cloudwatch/dashboards_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dashboards_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dashboards_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dashboards in a region or regions, for all properties use dashboards + +## Overview + + + + + + + +
Namedashboards_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudWatch::Dashboard
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dashboards in a region. +```sql +SELECT +region, +dashboard_name +FROM aws.cloudwatch.dashboards_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboards_list_only resource, see dashboards + diff --git a/website/docs/services/cloudwatch/index.md b/website/docs/services/cloudwatch/index.md new file mode 100644 index 0000000..ee0f88a --- /dev/null +++ b/website/docs/services/cloudwatch/index.md @@ -0,0 +1,49 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cloudwatch service documentation. + +:::info Service Summary + +
+
+total resources: 14
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cloudwatch/log_events/index.md b/website/docs/services/cloudwatch/log_events/index.md new file mode 100644 index 0000000..1918701 --- /dev/null +++ b/website/docs/services/cloudwatch/log_events/index.md @@ -0,0 +1,65 @@ +--- +title: log_events +hide_title: false +hide_table_of_contents: false +keywords: + - log_events + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Represents a log event. + +## Overview + + + + + + + +
Namelog_events
TypeResource
DescriptionRepresents a log event.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
integerThe time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
stringThe data contained in the log event.
integerThe time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ + + + + + diff --git a/website/docs/services/cloudwatch/log_groups/index.md b/website/docs/services/cloudwatch/log_groups/index.md new file mode 100644 index 0000000..54565b0 --- /dev/null +++ b/website/docs/services/cloudwatch/log_groups/index.md @@ -0,0 +1,81 @@ +--- +title: log_groups +hide_title: false +hide_table_of_contents: false +keywords: + - log_groups + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Represents a log group. + +## Overview + + + + + + + +
Namelog_groups
TypeResource
DescriptionRepresents a log group.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the log group.
integerThe creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
integer

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.

To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

integerThe number of metric filters.
stringThe Amazon Resource Name (ARN) of the log group.
integerThe number of bytes stored.
stringThe Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
stringDisplays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
arrayDisplays all the properties that this log group has inherited from account-level settings.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
INSERT
DELETE
+ + + + + + diff --git a/website/docs/services/cloudwatch/log_streams/index.md b/website/docs/services/cloudwatch/log_streams/index.md new file mode 100644 index 0000000..c90e30b --- /dev/null +++ b/website/docs/services/cloudwatch/log_streams/index.md @@ -0,0 +1,80 @@ +--- +title: log_streams +hide_title: false +hide_table_of_contents: false +keywords: + - log_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Represents a log stream, which is a sequence of log events from a single emitter of logs. + +## Overview + + + + + + + +
Namelog_streams
TypeResource
DescriptionRepresents a log stream, which is a sequence of log events from a single emitter of logs.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the log stream.
integerThe creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
integerThe time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
integerThe time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.
integerThe ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in rare situations might take longer.
string

The sequence token.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. You don't need to obtain uploadSequenceToken to use a PutLogEvents action.

stringThe Amazon Resource Name (ARN) of the log stream.
integer

The number of bytes stored.

Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.

Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
INSERT
DELETE
+ + + + + + diff --git a/website/docs/services/cloudwatch/metric_stream_tags/index.md b/website/docs/services/cloudwatch/metric_stream_tags/index.md new file mode 100644 index 0000000..5279040 --- /dev/null +++ b/website/docs/services/cloudwatch/metric_stream_tags/index.md @@ -0,0 +1,99 @@ +--- +title: metric_stream_tags +hide_title: false +hide_table_of_contents: false +keywords: + - metric_stream_tags + - cloudwatch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for metric_streams in a region + +## Overview + + + + + + + +
Namemetric_stream_tags
TypeResource
DescriptionResource Type definition for Metric Stream
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name of the metric stream.
stringThe date of creation of the metric stream.
arrayDefine which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
stringThe ARN of the Kinesis Firehose where to stream the data.
arrayDefine which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
stringThe date of the last update of the metric stream.
stringName of the metric stream.
stringThe ARN of the role that provides access to the Kinesis Firehose.
stringDisplays the state of the Metric Stream.
stringThe output format of the data streamed to the Kinesis Firehose.
arrayBy default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
booleanIf you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all metric_streams in a region. +```sql +SELECT +region, +arn, +creation_date, +exclude_filters, +firehose_arn, +include_filters, +last_update_date, +name, +role_arn, +state, +output_format, +statistics_configurations, +include_linked_accounts_metrics, +tag_key, +tag_value +FROM aws.cloudwatch.metric_stream_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the metric_stream_tags resource, see metric_streams + diff --git a/website/docs/services/cloudwatch/metric_streams/index.md b/website/docs/services/cloudwatch/metric_streams/index.md new file mode 100644 index 0000000..9c91749 --- /dev/null +++ b/website/docs/services/cloudwatch/metric_streams/index.md @@ -0,0 +1,297 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a metric_stream resource or lists metric_streams in a region + +## Overview + + + + + + + +
Namemetric_streams
TypeResource
DescriptionResource Type definition for Metric Stream
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name of the metric stream.
stringThe date of creation of the metric stream.
arrayDefine which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
stringThe ARN of the Kinesis Firehose where to stream the data.
arrayDefine which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
stringThe date of the last update of the metric stream.
stringName of the metric stream.
stringThe ARN of the role that provides access to the Kinesis Firehose.
stringDisplays the state of the Metric Stream.
stringThe output format of the data streamed to the Kinesis Firehose.
arrayBy default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
arrayA set of tags to assign to the delivery stream.
booleanIf you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.
stringAWS region.
+ +For more information, see AWS::CloudWatch::MetricStream. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all metric_streams in a region. +```sql +SELECT +region, +arn, +creation_date, +exclude_filters, +firehose_arn, +include_filters, +last_update_date, +name, +role_arn, +state, +output_format, +statistics_configurations, +tags, +include_linked_accounts_metrics +FROM aws.cloudwatch.metric_streams +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual metric_stream. +```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_streams +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new metric_stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cloudwatch.metric_streams ( + ExcludeFilters, + FirehoseArn, + IncludeFilters, + Name, + RoleArn, + OutputFormat, + StatisticsConfigurations, + Tags, + IncludeLinkedAccountsMetrics, + region +) +SELECT +'{{ ExcludeFilters }}', + '{{ FirehoseArn }}', + '{{ IncludeFilters }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ OutputFormat }}', + '{{ StatisticsConfigurations }}', + '{{ Tags }}', + '{{ IncludeLinkedAccountsMetrics }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cloudwatch.metric_streams ( + ExcludeFilters, + FirehoseArn, + IncludeFilters, + Name, + RoleArn, + OutputFormat, + StatisticsConfigurations, + Tags, + IncludeLinkedAccountsMetrics, + region +) +SELECT + '{{ ExcludeFilters }}', + '{{ FirehoseArn }}', + '{{ IncludeFilters }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ OutputFormat }}', + '{{ StatisticsConfigurations }}', + '{{ Tags }}', + '{{ IncludeLinkedAccountsMetrics }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: metric_stream + props: + - name: ExcludeFilters + value: + - Namespace: '{{ Namespace }}' + MetricNames: + - '{{ MetricNames[0] }}' + - name: FirehoseArn + value: '{{ FirehoseArn }}' + - name: IncludeFilters + value: + - null + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: OutputFormat + value: '{{ OutputFormat }}' + - name: StatisticsConfigurations + value: + - AdditionalStatistics: + - '{{ AdditionalStatistics[0] }}' + IncludeMetrics: + - MetricName: '{{ MetricName }}' + Namespace: '{{ Namespace }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: IncludeLinkedAccountsMetrics + value: '{{ IncludeLinkedAccountsMetrics }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cloudwatch.metric_streams +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +cloudwatch:PutMetricStream, +cloudwatch:GetMetricStream, +cloudwatch:TagResource, +cloudwatch:UntagResource, +iam:PassRole +``` + +### Delete +```json +cloudwatch:DeleteMetricStream, +cloudwatch:GetMetricStream +``` + +### List +```json +cloudwatch:ListMetricStreams +``` + +### Read +```json +cloudwatch:GetMetricStream +``` diff --git a/website/docs/services/cloudwatch/metric_streams_list_only/index.md b/website/docs/services/cloudwatch/metric_streams_list_only/index.md new file mode 100644 index 0000000..dd7991a --- /dev/null +++ b/website/docs/services/cloudwatch/metric_streams_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: metric_streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - metric_streams_list_only + - cloudwatch + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists metric_streams in a region or regions, for all properties use metric_streams + +## Overview + + + + + + + +
Namemetric_streams_list_only
TypeResource
DescriptionResource Type definition for Metric Stream
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the metric stream.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all metric_streams in a region. +```sql +SELECT +region, +name +FROM aws.cloudwatch.metric_streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the metric_streams_list_only resource, see metric_streams + diff --git a/website/docs/services/codeartifact/domain_tags/index.md b/website/docs/services/codeartifact/domain_tags/index.md new file mode 100644 index 0000000..69873c8 --- /dev/null +++ b/website/docs/services/codeartifact/domain_tags/index.md @@ -0,0 +1,87 @@ +--- +title: domain_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_tags + - codeartifact + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domains in a region + +## Overview + + + + + + + +
Namedomain_tags
TypeResource
DescriptionThe resource schema to create a CodeArtifact domain.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the domain.
stringThe name of the domain. This field is used for GetAtt
stringThe 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt
stringThe ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.
objectThe access control resource policy on the provided domain.
stringThe ARN of the domain.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domains in a region. +```sql +SELECT +region, +domain_name, +name, +owner, +encryption_key, +permissions_policy_document, +arn, +tag_key, +tag_value +FROM aws.codeartifact.domain_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_tags resource, see domains + diff --git a/website/docs/services/codeartifact/domains/index.md b/website/docs/services/codeartifact/domains/index.md new file mode 100644 index 0000000..ac63667 --- /dev/null +++ b/website/docs/services/codeartifact/domains/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain resource or lists domains in a region + +## Overview + + + + + + + +
Namedomains
TypeResource
DescriptionThe resource schema to create a CodeArtifact domain.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the domain.
stringThe name of the domain. This field is used for GetAtt
stringThe 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt
stringThe ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.
objectThe access control resource policy on the provided domain.
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the domain.
stringAWS region.
+ +For more information, see AWS::CodeArtifact::Domain. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domains in a region. +```sql +SELECT +region, +domain_name, +name, +owner, +encryption_key, +permissions_policy_document, +tags, +arn +FROM aws.codeartifact.domains +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain. +```sql +SELECT +region, +domain_name, +name, +owner, +encryption_key, +permissions_policy_document, +tags, +arn +FROM aws.codeartifact.domains +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codeartifact.domains ( + DomainName, + region +) +SELECT +'{{ DomainName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codeartifact.domains ( + DomainName, + PermissionsPolicyDocument, + Tags, + region +) +SELECT + '{{ DomainName }}', + '{{ PermissionsPolicyDocument }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain + props: + - name: DomainName + value: '{{ DomainName }}' + - name: PermissionsPolicyDocument + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codeartifact.domains +WHERE data__Identifier = '' +AND 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, +codeartifact:ListTagsForResource +``` + +### Read +```json +codeartifact:DescribeDomain, +codeartifact:GetDomainPermissionsPolicy, +codeartifact:ListTagsForResource +``` + +### Update +```json +codeartifact:DescribeDomain, +codeartifact:PutDomainPermissionsPolicy, +codeartifact:DeleteDomainPermissionsPolicy, +codeartifact:GetDomainPermissionsPolicy, +codeartifact:TagResource, +codeartifact:UntagResource, +codeartifact:ListTagsForResource +``` + +### Delete +```json +codeartifact:DeleteDomain, +codeartifact:DescribeDomain +``` + +### List +```json +codeartifact:ListDomains +``` diff --git a/website/docs/services/codeartifact/domains_list_only/index.md b/website/docs/services/codeartifact/domains_list_only/index.md new file mode 100644 index 0000000..af5d962 --- /dev/null +++ b/website/docs/services/codeartifact/domains_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domains_list_only + - codeartifact + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domains in a region or regions, for all properties use domains + +## Overview + + + + + + + +
Namedomains_list_only
TypeResource
DescriptionThe resource schema to create a CodeArtifact domain.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the domain.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domains in a region. +```sql +SELECT +region, +arn +FROM aws.codeartifact.domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domains_list_only resource, see domains + diff --git a/website/docs/services/codeartifact/index.md b/website/docs/services/codeartifact/index.md new file mode 100644 index 0000000..2cd017f --- /dev/null +++ b/website/docs/services/codeartifact/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The codeartifact service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/codeartifact/package_group_tags/index.md b/website/docs/services/codeartifact/package_group_tags/index.md new file mode 100644 index 0000000..55bda8f --- /dev/null +++ b/website/docs/services/codeartifact/package_group_tags/index.md @@ -0,0 +1,89 @@ +--- +title: package_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - package_group_tags + - codeartifact + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for package_groups in a region + +## Overview + + + + + + + +
Namepackage_group_tags
TypeResource
DescriptionThe resource schema to create a CodeArtifact package group.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the domain that contains the package group.
stringThe 12-digit account ID of the AWS account that owns the domain.
stringThe package group pattern that is used to gather packages.
stringThe contact info of the package group.
stringThe text description of the package group.
objectThe package origin configuration of the package group.
stringThe ARN of the package group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all package_groups in a region. +```sql +SELECT +region, +domain_name, +domain_owner, +pattern, +contact_info, +description, +origin_configuration, +arn, +tag_key, +tag_value +FROM aws.codeartifact.package_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the package_group_tags resource, see package_groups + diff --git a/website/docs/services/codeartifact/package_groups/index.md b/website/docs/services/codeartifact/package_groups/index.md new file mode 100644 index 0000000..0f3edfe --- /dev/null +++ b/website/docs/services/codeartifact/package_groups/index.md @@ -0,0 +1,265 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a package_group resource or lists package_groups in a region + +## Overview + + + + + + + +
Namepackage_groups
TypeResource
DescriptionThe resource schema to create a CodeArtifact package group.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the domain that contains the package group.
stringThe 12-digit account ID of the AWS account that owns the domain.
stringThe package group pattern that is used to gather packages.
stringThe contact info of the package group.
stringThe text description of the package group.
objectThe package origin configuration of the package group.
arrayAn array of key-value pairs to apply to the package group.
stringThe ARN of the package group.
stringAWS region.
+ +For more information, see AWS::CodeArtifact::PackageGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all package_groups in a region. +```sql +SELECT +region, +domain_name, +domain_owner, +pattern, +contact_info, +description, +origin_configuration, +tags, +arn +FROM aws.codeartifact.package_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual package_group. +```sql +SELECT +region, +domain_name, +domain_owner, +pattern, +contact_info, +description, +origin_configuration, +tags, +arn +FROM aws.codeartifact.package_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new package_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codeartifact.package_groups ( + DomainName, + Pattern, + region +) +SELECT +'{{ DomainName }}', + '{{ Pattern }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codeartifact.package_groups ( + DomainName, + DomainOwner, + Pattern, + ContactInfo, + Description, + OriginConfiguration, + Tags, + region +) +SELECT + '{{ DomainName }}', + '{{ DomainOwner }}', + '{{ Pattern }}', + '{{ ContactInfo }}', + '{{ Description }}', + '{{ OriginConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: package_group + props: + - name: DomainName + value: '{{ DomainName }}' + - name: DomainOwner + value: '{{ DomainOwner }}' + - name: Pattern + value: '{{ Pattern }}' + - name: ContactInfo + value: '{{ ContactInfo }}' + - name: Description + value: '{{ Description }}' + - name: OriginConfiguration + value: + Restrictions: + Publish: + RestrictionMode: '{{ RestrictionMode }}' + Repositories: + - '{{ Repositories[0] }}' + ExternalUpstream: null + InternalUpstream: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codeartifact.package_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +codeartifact:ListPackageGroups +``` diff --git a/website/docs/services/codeartifact/package_groups_list_only/index.md b/website/docs/services/codeartifact/package_groups_list_only/index.md new file mode 100644 index 0000000..dcbea1c --- /dev/null +++ b/website/docs/services/codeartifact/package_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: package_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - package_groups_list_only + - codeartifact + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists package_groups in a region or regions, for all properties use package_groups + +## Overview + + + + + + + +
Namepackage_groups_list_only
TypeResource
DescriptionThe resource schema to create a CodeArtifact package group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the package group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all package_groups in a region. +```sql +SELECT +region, +arn +FROM aws.codeartifact.package_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the package_groups_list_only resource, see package_groups + diff --git a/website/docs/services/codeartifact/repositories/index.md b/website/docs/services/codeartifact/repositories/index.md new file mode 100644 index 0000000..4e57188 --- /dev/null +++ b/website/docs/services/codeartifact/repositories/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a repository resource or lists repositories in a region + +## Overview + + + + + + + +
Namerepositories
TypeResource
DescriptionThe resource schema to create a CodeArtifact repository.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the repository.
stringThe name of the repository. This is used for GetAtt
stringThe name of the domain that contains the repository.
stringThe 12-digit account ID of the AWS account that owns the domain.
stringA text description of the repository.
stringThe ARN of the repository.
arrayA list of external connections associated with the repository.
arrayA list of upstream repositories associated with the repository.
objectThe access control resource policy on the provided repository.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::CodeArtifact::Repository. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all repositories in a region. +```sql +SELECT +region, +repository_name, +name, +domain_name, +domain_owner, +description, +arn, +external_connections, +upstreams, +permissions_policy_document, +tags +FROM aws.codeartifact.repositories +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual repository. +```sql +SELECT +region, +repository_name, +name, +domain_name, +domain_owner, +description, +arn, +external_connections, +upstreams, +permissions_policy_document, +tags +FROM aws.codeartifact.repositories +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new repository resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codeartifact.repositories ( + RepositoryName, + DomainName, + region +) +SELECT +'{{ RepositoryName }}', + '{{ DomainName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codeartifact.repositories ( + RepositoryName, + DomainName, + Description, + ExternalConnections, + Upstreams, + PermissionsPolicyDocument, + Tags, + region +) +SELECT + '{{ RepositoryName }}', + '{{ DomainName }}', + '{{ Description }}', + '{{ ExternalConnections }}', + '{{ Upstreams }}', + '{{ PermissionsPolicyDocument }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: repository + props: + - name: RepositoryName + value: '{{ RepositoryName }}' + - name: DomainName + value: '{{ DomainName }}' + - name: Description + value: '{{ Description }}' + - name: ExternalConnections + value: + - '{{ ExternalConnections[0] }}' + - name: Upstreams + value: + - '{{ Upstreams[0] }}' + - name: PermissionsPolicyDocument + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codeartifact.repositories +WHERE data__Identifier = '' +AND 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:GetRepositoryPermissionsPolicy, +codeartifact:AssociateExternalConnection, +codeartifact:AssociateWithDownstreamRepository, +codeartifact:TagResource, +codeartifact:ListTagsForResource +``` + +### Read +```json +codeartifact:DescribeRepository, +codeartifact:GetRepositoryPermissionsPolicy, +codeartifact:ListTagsForResource +``` + +### Update +```json +codeartifact:PutRepositoryPermissionsPolicy, +codeartifact:GetRepositoryPermissionsPolicy, +codeartifact:DeleteRepositoryPermissionsPolicy, +codeartifact:AssociateExternalConnection, +codeartifact:DisassociateExternalConnection, +codeartifact:UpdateRepository, +codeartifact:DescribeRepository, +codeartifact:AssociateWithDownstreamRepository, +codeartifact:TagResource, +codeartifact:UntagResource, +codeartifact:ListTagsForResource +``` + +### Delete +```json +codeartifact:DeleteRepository, +codeartifact:DescribeRepository +``` + +### List +```json +codeartifact:ListRepositories +``` diff --git a/website/docs/services/codeartifact/repositories_list_only/index.md b/website/docs/services/codeartifact/repositories_list_only/index.md new file mode 100644 index 0000000..f532427 --- /dev/null +++ b/website/docs/services/codeartifact/repositories_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: repositories_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - repositories_list_only + - codeartifact + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists repositories in a region or regions, for all properties use repositories + +## Overview + + + + + + + +
Namerepositories_list_only
TypeResource
DescriptionThe resource schema to create a CodeArtifact repository.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the repository.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all repositories in a region. +```sql +SELECT +region, +arn +FROM aws.codeartifact.repositories_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repositories_list_only resource, see repositories + diff --git a/website/docs/services/codeartifact/repository_tags/index.md b/website/docs/services/codeartifact/repository_tags/index.md new file mode 100644 index 0000000..38738fb --- /dev/null +++ b/website/docs/services/codeartifact/repository_tags/index.md @@ -0,0 +1,93 @@ +--- +title: repository_tags +hide_title: false +hide_table_of_contents: false +keywords: + - repository_tags + - codeartifact + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for repositories in a region + +## Overview + + + + + + + +
Namerepository_tags
TypeResource
DescriptionThe resource schema to create a CodeArtifact repository.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the repository.
stringThe name of the repository. This is used for GetAtt
stringThe name of the domain that contains the repository.
stringThe 12-digit account ID of the AWS account that owns the domain.
stringA text description of the repository.
stringThe ARN of the repository.
arrayA list of external connections associated with the repository.
arrayA list of upstream repositories associated with the repository.
objectThe access control resource policy on the provided repository.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all repositories in a region. +```sql +SELECT +region, +repository_name, +name, +domain_name, +domain_owner, +description, +arn, +external_connections, +upstreams, +permissions_policy_document, +tag_key, +tag_value +FROM aws.codeartifact.repository_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_tags resource, see repositories + diff --git a/website/docs/services/codebuild/fleet_tags/index.md b/website/docs/services/codebuild/fleet_tags/index.md new file mode 100644 index 0000000..cf3ca3a --- /dev/null +++ b/website/docs/services/codebuild/fleet_tags/index.md @@ -0,0 +1,99 @@ +--- +title: fleet_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_tags + - codebuild + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fleets in a region + +## Overview + + + + + + + +
Namefleet_tags
TypeResource
DescriptionResource Type definition for AWS::CodeBuild::Fleet
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
string
string
string
string
object
object
string
string
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fleets in a region. +```sql +SELECT +region, +name, +base_capacity, +environment_type, +compute_type, +overflow_behavior, +fleet_service_role, +fleet_vpc_config, +fleet_proxy_configuration, +arn, +image_id, +scaling_configuration, +compute_configuration, +tag_key, +tag_value +FROM aws.codebuild.fleet_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_tags resource, see fleets + diff --git a/website/docs/services/codebuild/fleets/index.md b/website/docs/services/codebuild/fleets/index.md new file mode 100644 index 0000000..f7f6c81 --- /dev/null +++ b/website/docs/services/codebuild/fleets/index.md @@ -0,0 +1,323 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a fleet resource or lists fleets in a region + +## Overview + + + + + + + +
Namefleets
TypeResource
DescriptionResource Type definition for AWS::CodeBuild::Fleet
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
string
string
string
string
object
object
array
string
string
object
object
stringAWS region.
+ +For more information, see AWS::CodeBuild::Fleet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all fleets in a region. +```sql +SELECT +region, +name, +base_capacity, +environment_type, +compute_type, +overflow_behavior, +fleet_service_role, +fleet_vpc_config, +fleet_proxy_configuration, +tags, +arn, +image_id, +scaling_configuration, +compute_configuration +FROM aws.codebuild.fleets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual fleet. +```sql +SELECT +region, +name, +base_capacity, +environment_type, +compute_type, +overflow_behavior, +fleet_service_role, +fleet_vpc_config, +fleet_proxy_configuration, +tags, +arn, +image_id, +scaling_configuration, +compute_configuration +FROM aws.codebuild.fleets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codebuild.fleets ( + Name, + BaseCapacity, + EnvironmentType, + ComputeType, + OverflowBehavior, + FleetServiceRole, + FleetVpcConfig, + FleetProxyConfiguration, + Tags, + ImageId, + ScalingConfiguration, + ComputeConfiguration, + region +) +SELECT +'{{ Name }}', + '{{ BaseCapacity }}', + '{{ EnvironmentType }}', + '{{ ComputeType }}', + '{{ OverflowBehavior }}', + '{{ FleetServiceRole }}', + '{{ FleetVpcConfig }}', + '{{ FleetProxyConfiguration }}', + '{{ Tags }}', + '{{ ImageId }}', + '{{ ScalingConfiguration }}', + '{{ ComputeConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codebuild.fleets ( + Name, + BaseCapacity, + EnvironmentType, + ComputeType, + OverflowBehavior, + FleetServiceRole, + FleetVpcConfig, + FleetProxyConfiguration, + Tags, + ImageId, + ScalingConfiguration, + ComputeConfiguration, + region +) +SELECT + '{{ Name }}', + '{{ BaseCapacity }}', + '{{ EnvironmentType }}', + '{{ ComputeType }}', + '{{ OverflowBehavior }}', + '{{ FleetServiceRole }}', + '{{ FleetVpcConfig }}', + '{{ FleetProxyConfiguration }}', + '{{ Tags }}', + '{{ ImageId }}', + '{{ ScalingConfiguration }}', + '{{ ComputeConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: fleet + props: + - name: Name + value: '{{ Name }}' + - name: BaseCapacity + value: '{{ BaseCapacity }}' + - name: EnvironmentType + value: '{{ EnvironmentType }}' + - name: ComputeType + value: '{{ ComputeType }}' + - name: OverflowBehavior + value: '{{ OverflowBehavior }}' + - name: FleetServiceRole + value: '{{ FleetServiceRole }}' + - name: FleetVpcConfig + value: + VpcId: '{{ VpcId }}' + Subnets: + - '{{ Subnets[0] }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + - name: FleetProxyConfiguration + value: + DefaultBehavior: '{{ DefaultBehavior }}' + OrderedProxyRules: + - Type: '{{ Type }}' + Effect: '{{ Effect }}' + Entities: + - '{{ Entities[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ImageId + value: '{{ ImageId }}' + - name: ScalingConfiguration + value: + MaxCapacity: '{{ MaxCapacity }}' + ScalingType: '{{ ScalingType }}' + TargetTrackingScalingConfigs: + - MetricType: '{{ MetricType }}' + TargetValue: null + - name: ComputeConfiguration + value: + vCpu: '{{ vCpu }}' + memory: '{{ memory }}' + disk: '{{ disk }}' + machineType: '{{ machineType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codebuild.fleets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +```json +codebuild:BatchGetFleets, +codebuild:CreateFleet, +iam:PassRole +``` + +### Delete +```json +codebuild:BatchGetFleets, +codebuild:DeleteFleet +``` + +### Read +```json +codebuild:BatchGetFleets +``` + +### List +```json +codebuild:ListFleets +``` + +### Update +```json +codebuild:BatchGetFleets, +codebuild:UpdateFleet, +iam:PassRole +``` diff --git a/website/docs/services/codebuild/fleets_list_only/index.md b/website/docs/services/codebuild/fleets_list_only/index.md new file mode 100644 index 0000000..28626bd --- /dev/null +++ b/website/docs/services/codebuild/fleets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleets_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleets in a region or regions, for all properties use fleets + +## Overview + + + + + + + +
Namefleets_list_only
TypeResource
DescriptionResource Type definition for AWS::CodeBuild::Fleet
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleets in a region. +```sql +SELECT +region, +arn +FROM aws.codebuild.fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleets_list_only resource, see fleets + diff --git a/website/docs/services/codebuild/index.md b/website/docs/services/codebuild/index.md new file mode 100644 index 0000000..ddebfff --- /dev/null +++ b/website/docs/services/codebuild/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The codebuild service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/codeconnections/connection_tags/index.md b/website/docs/services/codeconnections/connection_tags/index.md new file mode 100644 index 0000000..8707407 --- /dev/null +++ b/website/docs/services/codeconnections/connection_tags/index.md @@ -0,0 +1,87 @@ +--- +title: connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connection_tags + - codeconnections + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connections in a region + +## Overview + + + + + + + +
Nameconnection_tags
TypeResource
DescriptionSchema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the connection. Connection names must be unique in an AWS user account.
stringThe current status of the connection.
stringThe name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
stringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
stringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connections in a region. +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tag_key, +tag_value +FROM aws.codeconnections.connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connection_tags resource, see connections + diff --git a/website/docs/services/codeconnections/connections/index.md b/website/docs/services/codeconnections/connections/index.md new file mode 100644 index 0000000..15023d6 --- /dev/null +++ b/website/docs/services/codeconnections/connections/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connection resource or lists 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)
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the connection. Connection names must be unique in an AWS user account.
stringThe current status of the connection.
stringThe name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
stringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
stringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
arraySpecifies the tags applied to a connection.
stringAWS region.
+ +For more information, see AWS::CodeConnections::Connection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connections in a region. +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tags +FROM aws.codeconnections.connections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connection. +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tags +FROM aws.codeconnections.connections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codeconnections.connections ( + ConnectionName, + region +) +SELECT +'{{ ConnectionName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codeconnections.connections ( + ConnectionName, + ProviderType, + HostArn, + Tags, + region +) +SELECT + '{{ ConnectionName }}', + '{{ ProviderType }}', + '{{ HostArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connection + props: + - name: ConnectionName + value: '{{ ConnectionName }}' + - name: ProviderType + value: '{{ ProviderType }}' + - name: HostArn + value: '{{ HostArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codeconnections.connections +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the connections resource, the following permissions are required: + +### Create +```json +codeconnections:CreateConnection, +codeconnections:TagResource +``` + +### Read +```json +codeconnections:GetConnection, +codeconnections:ListTagsForResource +``` + +### Update +```json +codeconnections:ListTagsForResource, +codeconnections:TagResource, +codeconnections:UntagResource +``` + +### Delete +```json +codeconnections:DeleteConnection +``` + +### List +```json +codeconnections:ListConnections, +codeconnections:ListTagsForResource +``` diff --git a/website/docs/services/codeconnections/connections_list_only/index.md b/website/docs/services/codeconnections/connections_list_only/index.md new file mode 100644 index 0000000..fa66004 --- /dev/null +++ b/website/docs/services/codeconnections/connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connections_list_only + - codeconnections + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connections in a region or regions, for all properties use connections + +## Overview + + + + + + + +
Nameconnections_list_only
TypeResource
DescriptionSchema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connections in a region. +```sql +SELECT +region, +connection_arn +FROM aws.codeconnections.connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connections_list_only resource, see connections + diff --git a/website/docs/services/codeconnections/index.md b/website/docs/services/codeconnections/index.md new file mode 100644 index 0000000..0020515 --- /dev/null +++ b/website/docs/services/codeconnections/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The codeconnections service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/codedeploy/application_tags/index.md b/website/docs/services/codedeploy/application_tags/index.md new file mode 100644 index 0000000..c1b5b5d --- /dev/null +++ b/website/docs/services/codedeploy/application_tags/index.md @@ -0,0 +1,79 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - codedeploy + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionThe AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringA name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
stringThe compute platform that CodeDeploy deploys the application to.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_name, +compute_platform, +tag_key, +tag_value +FROM aws.codedeploy.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/codedeploy/applications/index.md b/website/docs/services/codedeploy/applications/index.md new file mode 100644 index 0000000..8c4bfe9 --- /dev/null +++ b/website/docs/services/codedeploy/applications/index.md @@ -0,0 +1,218 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionThe AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
stringThe compute platform that CodeDeploy deploys the application to.
arrayThe metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
stringAWS region.
+ +For more information, see AWS::CodeDeploy::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +application_name, +compute_platform, +tags +FROM aws.codedeploy.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +application_name, +compute_platform, +tags +FROM aws.codedeploy.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codedeploy.applications ( + ApplicationName, + ComputePlatform, + Tags, + region +) +SELECT +'{{ ApplicationName }}', + '{{ ComputePlatform }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codedeploy.applications ( + ApplicationName, + ComputePlatform, + Tags, + region +) +SELECT + '{{ ApplicationName }}', + '{{ ComputePlatform }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: ApplicationName + value: '{{ ApplicationName }}' + - name: ComputePlatform + value: '{{ ComputePlatform }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codedeploy.applications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +codedeploy:CreateApplication, +codedeploy:TagResource +``` + +### Read +```json +codedeploy:GetApplication, +codedeploy:ListTagsForResource +``` + +### Delete +```json +codedeploy:GetApplication, +codedeploy:DeleteApplication +``` + +### Update +```json +codedeploy:TagResource, +codedeploy:UntagResource +``` + +### List +```json +codedeploy:ListApplications +``` diff --git a/website/docs/services/codedeploy/applications_list_only/index.md b/website/docs/services/codedeploy/applications_list_only/index.md new file mode 100644 index 0000000..ce7a915 --- /dev/null +++ b/website/docs/services/codedeploy/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - codedeploy + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionThe AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_name +FROM aws.codedeploy.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/codedeploy/deployment_configs/index.md b/website/docs/services/codedeploy/deployment_configs/index.md new file mode 100644 index 0000000..3ee36e1 --- /dev/null +++ b/website/docs/services/codedeploy/deployment_configs/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a deployment_config resource or lists deployment_configs in a region + +## Overview + + + + + + + +
Namedeployment_configs
TypeResource
DescriptionResource Type definition for AWS::CodeDeploy::DeploymentConfig
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe destination platform type for the deployment (Lambda, Server, or ECS).
stringA name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type.
objectThe minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
objectThe zonal deployment config that specifies how the zonal deployment behaves
objectThe configuration that specifies how the deployment traffic is routed.
stringAWS region.
+ +For more information, see AWS::CodeDeploy::DeploymentConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all deployment_configs in a region. +```sql +SELECT +region, +compute_platform, +deployment_config_name, +minimum_healthy_hosts, +zonal_config, +traffic_routing_config +FROM aws.codedeploy.deployment_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual deployment_config. +```sql +SELECT +region, +compute_platform, +deployment_config_name, +minimum_healthy_hosts, +zonal_config, +traffic_routing_config +FROM aws.codedeploy.deployment_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new deployment_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codedeploy.deployment_configs ( + ComputePlatform, + DeploymentConfigName, + MinimumHealthyHosts, + ZonalConfig, + TrafficRoutingConfig, + region +) +SELECT +'{{ ComputePlatform }}', + '{{ DeploymentConfigName }}', + '{{ MinimumHealthyHosts }}', + '{{ ZonalConfig }}', + '{{ TrafficRoutingConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codedeploy.deployment_configs ( + ComputePlatform, + DeploymentConfigName, + MinimumHealthyHosts, + ZonalConfig, + TrafficRoutingConfig, + region +) +SELECT + '{{ ComputePlatform }}', + '{{ DeploymentConfigName }}', + '{{ MinimumHealthyHosts }}', + '{{ ZonalConfig }}', + '{{ TrafficRoutingConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: deployment_config + props: + - name: ComputePlatform + value: '{{ ComputePlatform }}' + - name: DeploymentConfigName + value: '{{ DeploymentConfigName }}' + - name: MinimumHealthyHosts + value: + Value: '{{ Value }}' + Type: '{{ Type }}' + - name: ZonalConfig + value: + FirstZoneMonitorDurationInSeconds: '{{ FirstZoneMonitorDurationInSeconds }}' + MonitorDurationInSeconds: '{{ MonitorDurationInSeconds }}' + MinimumHealthyHostsPerZone: + Value: '{{ Value }}' + Type: '{{ Type }}' + - name: TrafficRoutingConfig + value: + Type: '{{ Type }}' + TimeBasedLinear: + LinearInterval: '{{ LinearInterval }}' + LinearPercentage: '{{ LinearPercentage }}' + TimeBasedCanary: + CanaryPercentage: '{{ CanaryPercentage }}' + CanaryInterval: '{{ CanaryInterval }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codedeploy.deployment_configs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the deployment_configs resource, the following permissions are required: + +### Create +```json +codedeploy:CreateDeploymentConfig +``` + +### Read +```json +codedeploy:GetDeploymentConfig +``` + +### Delete +```json +codedeploy:GetDeploymentConfig, +codedeploy:DeleteDeploymentConfig +``` + +### List +```json +codedeploy:ListDeploymentConfigs +``` diff --git a/website/docs/services/codedeploy/deployment_configs_list_only/index.md b/website/docs/services/codedeploy/deployment_configs_list_only/index.md new file mode 100644 index 0000000..f8259b8 --- /dev/null +++ b/website/docs/services/codedeploy/deployment_configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: deployment_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_configs_list_only + - codedeploy + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployment_configs in a region or regions, for all properties use deployment_configs + +## Overview + + + + + + + +
Namedeployment_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::CodeDeploy::DeploymentConfig
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployment_configs in a region. +```sql +SELECT +region, +deployment_config_name +FROM aws.codedeploy.deployment_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployment_configs_list_only resource, see deployment_configs + diff --git a/website/docs/services/codedeploy/index.md b/website/docs/services/codedeploy/index.md new file mode 100644 index 0000000..538dba1 --- /dev/null +++ b/website/docs/services/codedeploy/index.md @@ -0,0 +1,40 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The codedeploy service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/codeguruprofiler/index.md b/website/docs/services/codeguruprofiler/index.md new file mode 100644 index 0000000..2aef4d9 --- /dev/null +++ b/website/docs/services/codeguruprofiler/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The codeguruprofiler service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/codeguruprofiler/profiling_group_tags/index.md b/website/docs/services/codeguruprofiler/profiling_group_tags/index.md new file mode 100644 index 0000000..94d5c7b --- /dev/null +++ b/website/docs/services/codeguruprofiler/profiling_group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: profiling_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profiling_group_tags + - codeguruprofiler + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profiling_groups in a region + +## Overview + + + + + + + +
Nameprofiling_group_tags
TypeResource
DescriptionThis resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the profiling group.
stringThe compute platform of the profiling group.
objectThe agent permissions attached to this profiling group.
arrayConfiguration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency
stringThe Amazon Resource Name (ARN) of the specified profiling group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profiling_groups in a region. +```sql +SELECT +region, +profiling_group_name, +compute_platform, +agent_permissions, +anomaly_detection_notification_configuration, +arn, +tag_key, +tag_value +FROM aws.codeguruprofiler.profiling_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiling_group_tags resource, see profiling_groups + diff --git a/website/docs/services/codeguruprofiler/profiling_groups/index.md b/website/docs/services/codeguruprofiler/profiling_groups/index.md new file mode 100644 index 0000000..0a43414 --- /dev/null +++ b/website/docs/services/codeguruprofiler/profiling_groups/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a profiling_group resource or lists profiling_groups in a region + +## Overview + + + + + + + +
Nameprofiling_groups
TypeResource
DescriptionThis resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the profiling group.
stringThe compute platform of the profiling group.
objectThe agent permissions attached to this profiling group.
arrayConfiguration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency
stringThe Amazon Resource Name (ARN) of the specified profiling group.
arrayThe tags associated with a profiling group.
stringAWS region.
+ +For more information, see AWS::CodeGuruProfiler::ProfilingGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all profiling_groups in a region. +```sql +SELECT +region, +profiling_group_name, +compute_platform, +agent_permissions, +anomaly_detection_notification_configuration, +arn, +tags +FROM aws.codeguruprofiler.profiling_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual profiling_group. +```sql +SELECT +region, +profiling_group_name, +compute_platform, +agent_permissions, +anomaly_detection_notification_configuration, +arn, +tags +FROM aws.codeguruprofiler.profiling_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new profiling_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codeguruprofiler.profiling_groups ( + ProfilingGroupName, + region +) +SELECT +'{{ ProfilingGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codeguruprofiler.profiling_groups ( + ProfilingGroupName, + ComputePlatform, + AgentPermissions, + AnomalyDetectionNotificationConfiguration, + Tags, + region +) +SELECT + '{{ ProfilingGroupName }}', + '{{ ComputePlatform }}', + '{{ AgentPermissions }}', + '{{ AnomalyDetectionNotificationConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: profiling_group + props: + - name: ProfilingGroupName + value: '{{ ProfilingGroupName }}' + - name: ComputePlatform + value: '{{ ComputePlatform }}' + - name: AgentPermissions + value: + Principals: + - '{{ Principals[0] }}' + - name: AnomalyDetectionNotificationConfiguration + value: + - channelId: '{{ channelId }}' + channelUri: '{{ channelUri }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codeguruprofiler.profiling_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +codeguru-profiler:DescribeProfilingGroup, +codeguru-profiler:ListTagsForResource, +codeguru-profiler:GetNotificationConfiguration, +codeguru-profiler:GetPolicy +``` + +### Update +```json +sns:Publish, +codeguru-profiler:DescribeProfilingGroup, +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 +``` + +### List +```json +codeguru-profiler:ListProfilingGroups, +codeguru-profiler:ListTagsForResource, +codeguru-profiler:GetNotificationConfiguration, +codeguru-profiler:GetPolicy +``` diff --git a/website/docs/services/codeguruprofiler/profiling_groups_list_only/index.md b/website/docs/services/codeguruprofiler/profiling_groups_list_only/index.md new file mode 100644 index 0000000..c818304 --- /dev/null +++ b/website/docs/services/codeguruprofiler/profiling_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: profiling_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profiling_groups_list_only + - codeguruprofiler + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profiling_groups in a region or regions, for all properties use profiling_groups + +## Overview + + + + + + + +
Nameprofiling_groups_list_only
TypeResource
DescriptionThis resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the profiling group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profiling_groups in a region. +```sql +SELECT +region, +profiling_group_name +FROM aws.codeguruprofiler.profiling_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiling_groups_list_only resource, see profiling_groups + diff --git a/website/docs/services/codegurureviewer/index.md b/website/docs/services/codegurureviewer/index.md new file mode 100644 index 0000000..e4a010d --- /dev/null +++ b/website/docs/services/codegurureviewer/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The codegurureviewer service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/codegurureviewer/repository_association_tags/index.md b/website/docs/services/codegurureviewer/repository_association_tags/index.md new file mode 100644 index 0000000..f4d57c5 --- /dev/null +++ b/website/docs/services/codegurureviewer/repository_association_tags/index.md @@ -0,0 +1,87 @@ +--- +title: repository_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - repository_association_tags + - codegurureviewer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for repository_associations in a region + +## Overview + + + + + + + +
Namerepository_association_tags
TypeResource
DescriptionThis resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the repository to be associated.
stringThe type of repository to be associated.
stringThe owner of the repository. For a Bitbucket repository, this is the username for the account that owns the repository.
stringThe name of the S3 bucket associated with an associated S3 repository. It must start with `codeguru-reviewer-`.
stringThe Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.
stringThe Amazon Resource Name (ARN) of the repository association.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all repository_associations in a region. +```sql +SELECT +region, +name, +type, +owner, +bucket_name, +connection_arn, +association_arn, +tag_key, +tag_value +FROM aws.codegurureviewer.repository_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_association_tags resource, see repository_associations + diff --git a/website/docs/services/codegurureviewer/repository_associations/index.md b/website/docs/services/codegurureviewer/repository_associations/index.md new file mode 100644 index 0000000..90faa1d --- /dev/null +++ b/website/docs/services/codegurureviewer/repository_associations/index.md @@ -0,0 +1,248 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a repository_association resource or lists repository_associations in a region + +## Overview + + + + + + + +
Namerepository_associations
TypeResource
DescriptionThis resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of the repository to be associated.
stringThe type of repository to be associated.
stringThe owner of the repository. For a Bitbucket repository, this is the username for the account that owns the repository.
stringThe name of the S3 bucket associated with an associated S3 repository. It must start with `codeguru-reviewer-`.
stringThe Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.
stringThe Amazon Resource Name (ARN) of the repository association.
arrayThe tags associated with a repository association.
stringAWS region.
+ +For more information, see AWS::CodeGuruReviewer::RepositoryAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all repository_associations in a region. +```sql +SELECT +region, +name, +type, +owner, +bucket_name, +connection_arn, +association_arn, +tags +FROM aws.codegurureviewer.repository_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual repository_association. +```sql +SELECT +region, +name, +type, +owner, +bucket_name, +connection_arn, +association_arn, +tags +FROM aws.codegurureviewer.repository_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new repository_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codegurureviewer.repository_associations ( + Name, + Type, + region +) +SELECT +'{{ Name }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codegurureviewer.repository_associations ( + Name, + Type, + Owner, + BucketName, + ConnectionArn, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Type }}', + '{{ Owner }}', + '{{ BucketName }}', + '{{ ConnectionArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: repository_association + props: + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: Owner + value: '{{ Owner }}' + - name: BucketName + value: '{{ BucketName }}' + - name: ConnectionArn + value: '{{ ConnectionArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codegurureviewer.repository_associations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +codeguru-reviewer:ListRepositoryAssociations +``` diff --git a/website/docs/services/codegurureviewer/repository_associations_list_only/index.md b/website/docs/services/codegurureviewer/repository_associations_list_only/index.md new file mode 100644 index 0000000..09ad2bc --- /dev/null +++ b/website/docs/services/codegurureviewer/repository_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: repository_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - repository_associations_list_only + - codegurureviewer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists repository_associations in a region or regions, for all properties use repository_associations + +## Overview + + + + + + + +
Namerepository_associations_list_only
TypeResource
DescriptionThis resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the repository association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all repository_associations in a region. +```sql +SELECT +region, +association_arn +FROM aws.codegurureviewer.repository_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_associations_list_only resource, see repository_associations + diff --git a/website/docs/services/codepipeline/custom_action_type_tags/index.md b/website/docs/services/codepipeline/custom_action_type_tags/index.md new file mode 100644 index 0000000..f50992f --- /dev/null +++ b/website/docs/services/codepipeline/custom_action_type_tags/index.md @@ -0,0 +1,91 @@ +--- +title: custom_action_type_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_action_type_tags + - codepipeline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_action_types in a region + +## Overview + + + + + + + +
Namecustom_action_type_tags
TypeResource
DescriptionThe AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe category of the custom action, such as a build action or a test action.
arrayThe configuration properties for the custom action.
objectThe details of the input artifact for the action, such as its commit ID.
objectThe details of the output artifact of the action, such as its commit ID.
stringThe provider of the service used in the custom action, such as AWS CodeDeploy.
objectURLs that provide users information about this custom action.
stringThe version identifier of the custom action.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_action_types in a region. +```sql +SELECT +region, +category, +configuration_properties, +input_artifact_details, +output_artifact_details, +provider, +settings, +version, +id, +tag_key, +tag_value +FROM aws.codepipeline.custom_action_type_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_action_type_tags resource, see custom_action_types + diff --git a/website/docs/services/codepipeline/custom_action_types/index.md b/website/docs/services/codepipeline/custom_action_types/index.md new file mode 100644 index 0000000..7e09d7d --- /dev/null +++ b/website/docs/services/codepipeline/custom_action_types/index.md @@ -0,0 +1,275 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a custom_action_type resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe category of the custom action, such as a build action or a test action.
arrayThe configuration properties for the custom action.
objectThe details of the input artifact for the action, such as its commit ID.
objectThe details of the output artifact of the action, such as its commit ID.
stringThe provider of the service used in the custom action, such as AWS CodeDeploy.
objectURLs that provide users information about this custom action.
arrayAny tags assigned to the custom action.
stringThe version identifier of the custom action.
string
stringAWS region.
+ +For more information, see AWS::CodePipeline::CustomActionType. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all custom_action_types in a region. +```sql +SELECT +region, +category, +configuration_properties, +input_artifact_details, +output_artifact_details, +provider, +settings, +tags, +version, +id +FROM aws.codepipeline.custom_action_types +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual custom_action_type. +```sql +SELECT +region, +category, +configuration_properties, +input_artifact_details, +output_artifact_details, +provider, +settings, +tags, +version, +id +FROM aws.codepipeline.custom_action_types +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new custom_action_type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codepipeline.custom_action_types ( + Category, + InputArtifactDetails, + OutputArtifactDetails, + Provider, + Version, + region +) +SELECT +'{{ Category }}', + '{{ InputArtifactDetails }}', + '{{ OutputArtifactDetails }}', + '{{ Provider }}', + '{{ Version }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codepipeline.custom_action_types ( + Category, + ConfigurationProperties, + InputArtifactDetails, + OutputArtifactDetails, + Provider, + Settings, + Tags, + Version, + region +) +SELECT + '{{ Category }}', + '{{ ConfigurationProperties }}', + '{{ InputArtifactDetails }}', + '{{ OutputArtifactDetails }}', + '{{ Provider }}', + '{{ Settings }}', + '{{ Tags }}', + '{{ Version }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: custom_action_type + props: + - name: Category + value: '{{ Category }}' + - name: ConfigurationProperties + value: + - Description: '{{ Description }}' + Key: '{{ Key }}' + Name: '{{ Name }}' + Queryable: '{{ Queryable }}' + Required: '{{ Required }}' + Secret: '{{ Secret }}' + Type: '{{ Type }}' + - name: InputArtifactDetails + value: + MaximumCount: '{{ MaximumCount }}' + MinimumCount: '{{ MinimumCount }}' + - name: OutputArtifactDetails + value: null + - name: Provider + value: '{{ Provider }}' + - name: Settings + value: + EntityUrlTemplate: '{{ EntityUrlTemplate }}' + ExecutionUrlTemplate: '{{ ExecutionUrlTemplate }}' + RevisionUrlTemplate: '{{ RevisionUrlTemplate }}' + ThirdPartyConfigurationUrl: '{{ ThirdPartyConfigurationUrl }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Version + value: '{{ Version }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codepipeline.custom_action_types +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +codepipeline:ListActionTypes, +codepipeline:ListTagsForResource +``` + +### Update +```json +codepipeline:ListActionTypes, +codepipeline:TagResource, +codepipeline:UntagResource +``` + +### Delete +```json +codepipeline:DeleteCustomActionType, +codepipeline:ListActionTypes +``` + +### List +```json +codepipeline:ListActionTypes +``` diff --git a/website/docs/services/codepipeline/custom_action_types_list_only/index.md b/website/docs/services/codepipeline/custom_action_types_list_only/index.md new file mode 100644 index 0000000..a658d97 --- /dev/null +++ b/website/docs/services/codepipeline/custom_action_types_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: custom_action_types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_action_types_list_only + - codepipeline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_action_types in a region or regions, for all properties use custom_action_types + +## Overview + + + + + + + +
Namecustom_action_types_list_only
TypeResource
DescriptionThe AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe category of the custom action, such as a build action or a test action.
stringThe provider of the service used in the custom action, such as AWS CodeDeploy.
stringThe version identifier of the custom action.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_action_types in a region. +```sql +SELECT +region, +category, +provider, +version +FROM aws.codepipeline.custom_action_types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_action_types_list_only resource, see custom_action_types + diff --git a/website/docs/services/codepipeline/index.md b/website/docs/services/codepipeline/index.md new file mode 100644 index 0000000..3af8a86 --- /dev/null +++ b/website/docs/services/codepipeline/index.md @@ -0,0 +1,41 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The codepipeline service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/codepipeline/pipeline_tags/index.md b/website/docs/services/codepipeline/pipeline_tags/index.md new file mode 100644 index 0000000..ef2acb4 --- /dev/null +++ b/website/docs/services/codepipeline/pipeline_tags/index.md @@ -0,0 +1,99 @@ +--- +title: pipeline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline_tags + - codepipeline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pipelines in a region + +## Overview + + + + + + + +
Namepipeline_tags
TypeResource
DescriptionThe AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayA mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
arrayRepresents the input of a DisableStageTransition action.
arrayRepresents information about a stage and its definition.
stringThe method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
booleanIndicates whether to rerun the CodePipeline pipeline after you update it.
arrayThe trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
stringThe Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn
stringThe name of the pipeline.
arrayA list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.
stringThe version of the pipeline.
objectThe S3 bucket where artifacts for the pipeline are stored.
stringCodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pipelines in a region. +```sql +SELECT +region, +artifact_stores, +disable_inbound_stage_transitions, +stages, +execution_mode, +restart_execution_on_update, +triggers, +role_arn, +name, +variables, +version, +artifact_store, +pipeline_type, +tag_key, +tag_value +FROM aws.codepipeline.pipeline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipeline_tags resource, see pipelines + diff --git a/website/docs/services/codepipeline/pipelines/index.md b/website/docs/services/codepipeline/pipelines/index.md new file mode 100644 index 0000000..7a934cf --- /dev/null +++ b/website/docs/services/codepipeline/pipelines/index.md @@ -0,0 +1,385 @@ +--- +title: pipelines +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a pipeline resource or lists pipelines in a region + +## Overview + + + + + + + +
Namepipelines
TypeResource
DescriptionThe AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayA mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
arrayRepresents the input of a DisableStageTransition action.
arrayRepresents information about a stage and its definition.
stringThe method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
booleanIndicates whether to rerun the CodePipeline pipeline after you update it.
arrayThe trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
stringThe Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn
stringThe name of the pipeline.
arrayA list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.
stringThe version of the pipeline.
objectThe S3 bucket where artifacts for the pipeline are stored.
stringCodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
arraySpecifies the tags applied to the pipeline.
stringAWS region.
+ +For more information, see AWS::CodePipeline::Pipeline. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all pipelines in a region. +```sql +SELECT +region, +artifact_stores, +disable_inbound_stage_transitions, +stages, +execution_mode, +restart_execution_on_update, +triggers, +role_arn, +name, +variables, +version, +artifact_store, +pipeline_type, +tags +FROM aws.codepipeline.pipelines +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual pipeline. +```sql +SELECT +region, +artifact_stores, +disable_inbound_stage_transitions, +stages, +execution_mode, +restart_execution_on_update, +triggers, +role_arn, +name, +variables, +version, +artifact_store, +pipeline_type, +tags +FROM aws.codepipeline.pipelines +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codepipeline.pipelines ( + Stages, + RoleArn, + region +) +SELECT +'{{ Stages }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codepipeline.pipelines ( + ArtifactStores, + DisableInboundStageTransitions, + Stages, + ExecutionMode, + RestartExecutionOnUpdate, + Triggers, + RoleArn, + Name, + Variables, + ArtifactStore, + PipelineType, + Tags, + region +) +SELECT + '{{ ArtifactStores }}', + '{{ DisableInboundStageTransitions }}', + '{{ Stages }}', + '{{ ExecutionMode }}', + '{{ RestartExecutionOnUpdate }}', + '{{ Triggers }}', + '{{ RoleArn }}', + '{{ Name }}', + '{{ Variables }}', + '{{ ArtifactStore }}', + '{{ PipelineType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: pipeline + props: + - name: ArtifactStores + value: + - ArtifactStore: + Type: '{{ Type }}' + EncryptionKey: + Type: '{{ Type }}' + Id: '{{ Id }}' + Location: '{{ Location }}' + Region: '{{ Region }}' + - name: DisableInboundStageTransitions + value: + - StageName: '{{ StageName }}' + Reason: '{{ Reason }}' + - name: Stages + value: + - Blockers: + - Name: '{{ Name }}' + Type: '{{ Type }}' + Actions: + - ActionTypeId: + Owner: '{{ Owner }}' + Category: '{{ Category }}' + Version: '{{ Version }}' + Provider: '{{ Provider }}' + Configuration: {} + InputArtifacts: + - Name: '{{ Name }}' + OutputArtifacts: + - Name: '{{ Name }}' + Files: + - '{{ Files[0] }}' + Commands: + - '{{ Commands[0] }}' + OutputVariables: + - '{{ OutputVariables[0] }}' + Region: '{{ Region }}' + Namespace: '{{ Namespace }}' + RoleArn: '{{ RoleArn }}' + RunOrder: '{{ RunOrder }}' + Name: '{{ Name }}' + TimeoutInMinutes: '{{ TimeoutInMinutes }}' + Name: '{{ Name }}' + OnFailure: + Result: '{{ Result }}' + RetryConfiguration: + RetryMode: '{{ RetryMode }}' + Conditions: + - Result: '{{ Result }}' + Rules: + - RuleTypeId: + Owner: '{{ Owner }}' + Category: '{{ Category }}' + Version: '{{ Version }}' + Provider: '{{ Provider }}' + Configuration: {} + InputArtifacts: + - null + Region: '{{ Region }}' + RoleArn: '{{ RoleArn }}' + Name: '{{ Name }}' + OnSuccess: + Conditions: + - null + BeforeEntry: + Conditions: + - null + - name: ExecutionMode + value: '{{ ExecutionMode }}' + - name: RestartExecutionOnUpdate + value: '{{ RestartExecutionOnUpdate }}' + - name: Triggers + value: + - GitConfiguration: + Push: + - FilePaths: + Includes: + - '{{ Includes[0] }}' + Excludes: + - '{{ Excludes[0] }}' + Branches: + Includes: + - '{{ Includes[0] }}' + Excludes: + - '{{ Excludes[0] }}' + Tags: + Includes: + - '{{ Includes[0] }}' + Excludes: + - '{{ Excludes[0] }}' + SourceActionName: '{{ SourceActionName }}' + PullRequest: + - FilePaths: null + Events: + - '{{ Events[0] }}' + Branches: null + ProviderType: '{{ ProviderType }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Name + value: '{{ Name }}' + - name: Variables + value: + - DefaultValue: '{{ DefaultValue }}' + Description: '{{ Description }}' + Name: '{{ Name }}' + - name: ArtifactStore + value: null + - name: PipelineType + value: '{{ PipelineType }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codepipeline.pipelines +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the pipelines resource, the following permissions are required: + +### Create +```json +iam:GetRole, +iam:PassRole, +codepipeline:GetPipeline, +codepipeline:CreatePipeline, +codepipeline:DisableStageTransition, +codepipeline:GetPipelineState, +codepipeline:TagResource, +codestar-connections:PassConnection +``` + +### Read +```json +codepipeline:GetPipeline, +codepipeline:ListTagsForResource, +codepipeline:GetPipelineState +``` + +### Update +```json +iam:GetRole, +iam:PassRole, +codepipeline:EnableStageTransition, +codepipeline:StartPipelineExecution, +codepipeline:GetPipeline, +codepipeline:UpdatePipeline, +codepipeline:GetPipelineState, +codepipeline:DisableStageTransition, +codepipeline:TagResource, +codepipeline:UntagResource, +codestar-connections:PassConnection +``` + +### Delete +```json +codepipeline:GetPipeline, +codepipeline:DeletePipeline +``` + +### List +```json +codepipeline:ListPipelines +``` diff --git a/website/docs/services/codepipeline/pipelines_list_only/index.md b/website/docs/services/codepipeline/pipelines_list_only/index.md new file mode 100644 index 0000000..0191935 --- /dev/null +++ b/website/docs/services/codepipeline/pipelines_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipelines in a region or regions, for all properties use pipelines + +## Overview + + + + + + + +
Namepipelines_list_only
TypeResource
DescriptionThe AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the pipeline.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipelines in a region. +```sql +SELECT +region, +name +FROM aws.codepipeline.pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipelines_list_only resource, see pipelines + diff --git a/website/docs/services/codestarconnections/connection_tags/index.md b/website/docs/services/codestarconnections/connection_tags/index.md new file mode 100644 index 0000000..c83052c --- /dev/null +++ b/website/docs/services/codestarconnections/connection_tags/index.md @@ -0,0 +1,87 @@ +--- +title: connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connection_tags + - codestarconnections + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connections in a region + +## Overview + + + + + + + +
Nameconnection_tags
TypeResource
DescriptionSchema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the connection. Connection names must be unique in an AWS user account.
stringThe current status of the connection.
stringThe name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
stringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
stringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connections in a region. +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tag_key, +tag_value +FROM aws.codestarconnections.connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connection_tags resource, see connections + diff --git a/website/docs/services/codestarconnections/connections/index.md b/website/docs/services/codestarconnections/connections/index.md new file mode 100644 index 0000000..6600539 --- /dev/null +++ b/website/docs/services/codestarconnections/connections/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connection resource or lists 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
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the connection. Connection names must be unique in an AWS user account.
stringThe current status of the connection.
stringThe name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
stringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
stringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
arraySpecifies the tags applied to a connection.
stringAWS region.
+ +For more information, see AWS::CodeStarConnections::Connection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connections in a region. +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tags +FROM aws.codestarconnections.connections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connection. +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tags +FROM aws.codestarconnections.connections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codestarconnections.connections ( + ConnectionName, + region +) +SELECT +'{{ ConnectionName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codestarconnections.connections ( + ConnectionName, + ProviderType, + HostArn, + Tags, + region +) +SELECT + '{{ ConnectionName }}', + '{{ ProviderType }}', + '{{ HostArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connection + props: + - name: ConnectionName + value: '{{ ConnectionName }}' + - name: ProviderType + value: '{{ ProviderType }}' + - name: HostArn + value: '{{ HostArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codestarconnections.connections +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the connections resource, the following permissions are required: + +### Create +```json +codestar-connections:CreateConnection, +codestar-connections:TagResource +``` + +### Read +```json +codestar-connections:GetConnection, +codestar-connections:ListTagsForResource +``` + +### Update +```json +codestar-connections:ListTagsForResource, +codestar-connections:TagResource, +codestar-connections:UntagResource +``` + +### Delete +```json +codestar-connections:DeleteConnection +``` + +### List +```json +codestar-connections:ListConnections, +codestar-connections:ListTagsForResource +``` diff --git a/website/docs/services/codestarconnections/connections_list_only/index.md b/website/docs/services/codestarconnections/connections_list_only/index.md new file mode 100644 index 0000000..2cdc673 --- /dev/null +++ b/website/docs/services/codestarconnections/connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connections_list_only + - codestarconnections + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connections in a region or regions, for all properties use connections + +## Overview + + + + + + + +
Nameconnections_list_only
TypeResource
DescriptionSchema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connections in a region. +```sql +SELECT +region, +connection_arn +FROM aws.codestarconnections.connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connections_list_only resource, see connections + diff --git a/website/docs/services/codestarconnections/index.md b/website/docs/services/codestarconnections/index.md new file mode 100644 index 0000000..cb84997 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The codestarconnections service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/codestarconnections/repository_link_tags/index.md b/website/docs/services/codestarconnections/repository_link_tags/index.md new file mode 100644 index 0000000..eb6ccea --- /dev/null +++ b/website/docs/services/codestarconnections/repository_link_tags/index.md @@ -0,0 +1,89 @@ +--- +title: repository_link_tags +hide_title: false +hide_table_of_contents: false +keywords: + - repository_link_tags + - codestarconnections + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for repository_links in a region + +## Overview + + + + + + + +
Namerepository_link_tags
TypeResource
DescriptionSchema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the external provider where your third-party code repository is configured.
stringthe ID of the entity that owns the repository.
stringThe repository for which the link is being created.
stringThe ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. If not specified, a default key will be used.
stringA UUID that uniquely identifies the RepositoryLink.
stringA unique Amazon Resource Name (ARN) to designate the repository link.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all repository_links in a region. +```sql +SELECT +region, +connection_arn, +provider_type, +owner_id, +repository_name, +encryption_key_arn, +repository_link_id, +repository_link_arn, +tag_key, +tag_value +FROM aws.codestarconnections.repository_link_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_link_tags resource, see repository_links + diff --git a/website/docs/services/codestarconnections/repository_links/index.md b/website/docs/services/codestarconnections/repository_links/index.md new file mode 100644 index 0000000..c52cdb7 --- /dev/null +++ b/website/docs/services/codestarconnections/repository_links/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a repository_link resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the external provider where your third-party code repository is configured.
stringthe ID of the entity that owns the repository.
stringThe repository for which the link is being created.
stringThe ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. If not specified, a default key will be used.
stringA UUID that uniquely identifies the RepositoryLink.
stringA unique Amazon Resource Name (ARN) to designate the repository link.
arraySpecifies the tags applied to a RepositoryLink.
stringAWS region.
+ +For more information, see AWS::CodeStarConnections::RepositoryLink. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all repository_links in a region. +```sql +SELECT +region, +connection_arn, +provider_type, +owner_id, +repository_name, +encryption_key_arn, +repository_link_id, +repository_link_arn, +tags +FROM aws.codestarconnections.repository_links +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual repository_link. +```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_links +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new repository_link resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codestarconnections.repository_links ( + ConnectionArn, + OwnerId, + RepositoryName, + region +) +SELECT +'{{ ConnectionArn }}', + '{{ OwnerId }}', + '{{ RepositoryName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codestarconnections.repository_links ( + ConnectionArn, + OwnerId, + RepositoryName, + EncryptionKeyArn, + Tags, + region +) +SELECT + '{{ ConnectionArn }}', + '{{ OwnerId }}', + '{{ RepositoryName }}', + '{{ EncryptionKeyArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: repository_link + props: + - name: ConnectionArn + value: '{{ ConnectionArn }}' + - name: OwnerId + value: '{{ OwnerId }}' + - name: RepositoryName + value: '{{ RepositoryName }}' + - name: EncryptionKeyArn + value: '{{ EncryptionKeyArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codestarconnections.repository_links +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the repository_links 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 +``` + +### Create +```json +codestar-connections:CreateRepositoryLink, +codestar-connections:TagResource, +codestar-connections:UseConnection, +codestar-connections:PassConnection, +codestar-connections:GetConnection, +iam:CreateServiceLinkedRole +``` + +### Read +```json +codestar-connections:GetRepositoryLink, +codestar-connections:ListTagsForResource, +codestar-connections:GetConnection +``` + +### Delete +```json +codestar-connections:GetRepositoryLink, +codestar-connections:DeleteRepositoryLink, +codestar-connections:GetConnection +``` + +### List +```json +codestar-connections:ListRepositoryLinks, +codestar-connections:ListTagsForResource +``` diff --git a/website/docs/services/codestarconnections/repository_links_list_only/index.md b/website/docs/services/codestarconnections/repository_links_list_only/index.md new file mode 100644 index 0000000..86ec0cf --- /dev/null +++ b/website/docs/services/codestarconnections/repository_links_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: repository_links_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - repository_links_list_only + - codestarconnections + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists repository_links in a region or regions, for all properties use repository_links + +## Overview + + + + + + + +
Namerepository_links_list_only
TypeResource
DescriptionSchema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique Amazon Resource Name (ARN) to designate the repository link.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all repository_links in a region. +```sql +SELECT +region, +repository_link_arn +FROM aws.codestarconnections.repository_links_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_links_list_only resource, see repository_links + diff --git a/website/docs/services/codestarconnections/sync_configurations/index.md b/website/docs/services/codestarconnections/sync_configurations/index.md new file mode 100644 index 0000000..a829e0d --- /dev/null +++ b/website/docs/services/codestarconnections/sync_configurations/index.md @@ -0,0 +1,268 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a sync_configuration resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringthe ID of the entity that owns the repository.
stringThe name of the resource that is being synchronized to the repository.
stringThe name of the repository that is being synced to.
stringThe name of the external provider where your third-party code repository is configured.
stringThe name of the branch of the repository from which resources are to be synchronized,
stringThe source provider repository path of the sync configuration file of the respective SyncType.
stringThe type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
stringThe IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
stringWhether to enable or disable publishing of deployment status to source providers.
stringWhen to trigger Git sync to begin the stack update.
stringA UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
stringAWS region.
+ +For more information, see AWS::CodeStarConnections::SyncConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all sync_configurations in a region. +```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_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual sync_configuration. +```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_configurations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new sync_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codestarconnections.sync_configurations ( + ResourceName, + Branch, + ConfigFile, + SyncType, + RoleArn, + RepositoryLinkId, + region +) +SELECT +'{{ ResourceName }}', + '{{ Branch }}', + '{{ ConfigFile }}', + '{{ SyncType }}', + '{{ RoleArn }}', + '{{ RepositoryLinkId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codestarconnections.sync_configurations ( + ResourceName, + Branch, + ConfigFile, + SyncType, + RoleArn, + PublishDeploymentStatus, + TriggerResourceUpdateOn, + RepositoryLinkId, + region +) +SELECT + '{{ ResourceName }}', + '{{ Branch }}', + '{{ ConfigFile }}', + '{{ SyncType }}', + '{{ RoleArn }}', + '{{ PublishDeploymentStatus }}', + '{{ TriggerResourceUpdateOn }}', + '{{ RepositoryLinkId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: sync_configuration + props: + - name: ResourceName + value: '{{ ResourceName }}' + - name: Branch + value: '{{ Branch }}' + - name: ConfigFile + value: '{{ ConfigFile }}' + - name: SyncType + value: '{{ SyncType }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: PublishDeploymentStatus + value: '{{ PublishDeploymentStatus }}' + - name: TriggerResourceUpdateOn + value: '{{ TriggerResourceUpdateOn }}' + - name: RepositoryLinkId + value: '{{ RepositoryLinkId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codestarconnections.sync_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +codestar-connections:GetSyncConfiguration +``` + +### Update +```json +codestar-connections:UpdateSyncConfiguration, +codestar-connections:PassRepository, +iam:PassRole +``` + +### Delete +```json +codestar-connections:DeleteSyncConfiguration, +codestar-connections:GetSyncConfiguration +``` + +### List +```json +codestar-connections:ListSyncConfigurations, +codestar-connections:ListRepositoryLinks +``` diff --git a/website/docs/services/codestarconnections/sync_configurations_list_only/index.md b/website/docs/services/codestarconnections/sync_configurations_list_only/index.md new file mode 100644 index 0000000..c9dce90 --- /dev/null +++ b/website/docs/services/codestarconnections/sync_configurations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: sync_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sync_configurations_list_only + - codestarconnections + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sync_configurations in a region or regions, for all properties use sync_configurations + +## Overview + + + + + + + +
Namesync_configurations_list_only
TypeResource
DescriptionSchema for AWS::CodeStarConnections::SyncConfiguration resource which is used to enables an AWS resource to be synchronized from a source-provider.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the resource that is being synchronized to the repository.
stringThe type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sync_configurations in a region. +```sql +SELECT +region, +resource_name, +sync_type +FROM aws.codestarconnections.sync_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sync_configurations_list_only resource, see sync_configurations + diff --git a/website/docs/services/codestarnotifications/index.md b/website/docs/services/codestarnotifications/index.md new file mode 100644 index 0000000..3fc10b9 --- /dev/null +++ b/website/docs/services/codestarnotifications/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The codestarnotifications service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/codestarnotifications/notification_rule_tags/index.md b/website/docs/services/codestarnotifications/notification_rule_tags/index.md new file mode 100644 index 0000000..7039038 --- /dev/null +++ b/website/docs/services/codestarnotifications/notification_rule_tags/index.md @@ -0,0 +1,95 @@ +--- +title: notification_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - notification_rule_tags + - codestarnotifications + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for notification_rules in a region + +## Overview + + + + + + + +
Namenotification_rule_tags
TypeResource
DescriptionResource Type definition for AWS::CodeStarNotifications::NotificationRule
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
string
string
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all notification_rules in a region. +```sql +SELECT +region, +event_type_id, +created_by, +target_address, +event_type_ids, +status, +detail_type, +resource, +targets, +name, +arn, +tag_key, +tag_value +FROM aws.codestarnotifications.notification_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the notification_rule_tags resource, see notification_rules + diff --git a/website/docs/services/codestarnotifications/notification_rules/index.md b/website/docs/services/codestarnotifications/notification_rules/index.md new file mode 100644 index 0000000..9e29795 --- /dev/null +++ b/website/docs/services/codestarnotifications/notification_rules/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a notification_rule resource or lists notification_rules in a region + +## Overview + + + + + + + +
Namenotification_rules
TypeResource
DescriptionResource Type definition for AWS::CodeStarNotifications::NotificationRule
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
string
string
array
object
string
string
stringAWS region.
+ +For more information, see AWS::CodeStarNotifications::NotificationRule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all notification_rules in a region. +```sql +SELECT +region, +event_type_id, +created_by, +target_address, +event_type_ids, +status, +detail_type, +resource, +targets, +tags, +name, +arn +FROM aws.codestarnotifications.notification_rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual notification_rule. +```sql +SELECT +region, +event_type_id, +created_by, +target_address, +event_type_ids, +status, +detail_type, +resource, +targets, +tags, +name, +arn +FROM aws.codestarnotifications.notification_rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new notification_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.codestarnotifications.notification_rules ( + EventTypeIds, + DetailType, + Resource, + Targets, + Name, + region +) +SELECT +'{{ EventTypeIds }}', + '{{ DetailType }}', + '{{ Resource }}', + '{{ Targets }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.codestarnotifications.notification_rules ( + EventTypeId, + CreatedBy, + TargetAddress, + EventTypeIds, + Status, + DetailType, + Resource, + Targets, + Tags, + Name, + region +) +SELECT + '{{ EventTypeId }}', + '{{ CreatedBy }}', + '{{ TargetAddress }}', + '{{ EventTypeIds }}', + '{{ Status }}', + '{{ DetailType }}', + '{{ Resource }}', + '{{ Targets }}', + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: notification_rule + props: + - name: EventTypeId + value: '{{ EventTypeId }}' + - name: CreatedBy + value: '{{ CreatedBy }}' + - name: TargetAddress + value: '{{ TargetAddress }}' + - name: EventTypeIds + value: + - '{{ EventTypeIds[0] }}' + - name: Status + value: '{{ Status }}' + - name: DetailType + value: '{{ DetailType }}' + - name: Resource + value: '{{ Resource }}' + - name: Targets + value: + - TargetType: '{{ TargetType }}' + TargetAddress: '{{ TargetAddress }}' + - name: Tags + value: {} + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.codestarnotifications.notification_rules +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/codestarnotifications/notification_rules_list_only/index.md b/website/docs/services/codestarnotifications/notification_rules_list_only/index.md new file mode 100644 index 0000000..c683330 --- /dev/null +++ b/website/docs/services/codestarnotifications/notification_rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: notification_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - notification_rules_list_only + - codestarnotifications + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists notification_rules in a region or regions, for all properties use notification_rules + +## Overview + + + + + + + +
Namenotification_rules_list_only
TypeResource
DescriptionResource Type definition for AWS::CodeStarNotifications::NotificationRule
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all notification_rules in a region. +```sql +SELECT +region, +arn +FROM aws.codestarnotifications.notification_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the notification_rules_list_only resource, see notification_rules + diff --git a/website/docs/services/cognito/identity_pool_principal_tags/index.md b/website/docs/services/cognito/identity_pool_principal_tags/index.md new file mode 100644 index 0000000..7a3ccec --- /dev/null +++ b/website/docs/services/cognito/identity_pool_principal_tags/index.md @@ -0,0 +1,224 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for identity_pool_principals in a region + +## Overview + + + + + + + +
Nameidentity_pool_principal_tags
TypeResource
DescriptionResource Type definition for AWS::Cognito::IdentityPoolPrincipalTag
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
boolean
object
stringTag key.
stringTag value.
stringAWS region.
+ +For more information, see AWS::Cognito::IdentityPoolPrincipalTag. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Expands tags for all identity_pool_principals in a region. +```sql +SELECT +region, +identity_pool_id, +identity_provider_name, +use_defaults, +principal_tags, +tag_key, +tag_value +FROM aws.cognito.identity_pool_principal_tags +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual identity_pool_principal_tag. +```sql +SELECT +region, +identity_pool_id, +identity_provider_name, +use_defaults, +principal_tags +FROM aws.cognito.identity_pool_principal_tags +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new identity_pool_principal_tag resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.identity_pool_principal_tags ( + IdentityPoolId, + IdentityProviderName, + region +) +SELECT +'{{ IdentityPoolId }}', + '{{ IdentityProviderName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.identity_pool_principal_tags ( + IdentityPoolId, + IdentityProviderName, + UseDefaults, + PrincipalTags, + region +) +SELECT + '{{ IdentityPoolId }}', + '{{ IdentityProviderName }}', + '{{ UseDefaults }}', + '{{ PrincipalTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: identity_pool_principal_tag + props: + - name: IdentityPoolId + value: '{{ IdentityPoolId }}' + - name: IdentityProviderName + value: '{{ IdentityProviderName }}' + - name: UseDefaults + value: '{{ UseDefaults }}' + - name: PrincipalTags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.identity_pool_principal_tags +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cognito-identity:GetPrincipalTagAttributeMap +``` + +### Update +```json +cognito-identity:GetPrincipalTagAttributeMap, +cognito-identity:SetPrincipalTagAttributeMap +``` + +### Delete +```json +cognito-identity:GetPrincipalTagAttributeMap, +cognito-identity:SetPrincipalTagAttributeMap +``` + +### List +```json +cognito-identity:GetPrincipalTagAttributeMap +``` diff --git a/website/docs/services/cognito/identity_pool_principal_tags_list_only/index.md b/website/docs/services/cognito/identity_pool_principal_tags_list_only/index.md new file mode 100644 index 0000000..0ee30b1 --- /dev/null +++ b/website/docs/services/cognito/identity_pool_principal_tags_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: identity_pool_principal_tags_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pool_principal_tags_list_only + - cognito + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_pool_principal_tags in a region or regions, for all properties use identity_pool_principal_tags + +## Overview + + + + + + + +
Nameidentity_pool_principal_tags_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::IdentityPoolPrincipalTag
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_pool_principal_tags in a region. +```sql +SELECT +region, +identity_pool_id, +identity_provider_name +FROM aws.cognito.identity_pool_principal_tags_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_pool_principal_tags_list_only resource, see identity_pool_principal_tags + diff --git a/website/docs/services/cognito/identity_pool_role_attachments/index.md b/website/docs/services/cognito/identity_pool_role_attachments/index.md new file mode 100644 index 0000000..182d588 --- /dev/null +++ b/website/docs/services/cognito/identity_pool_role_attachments/index.md @@ -0,0 +1,216 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an identity_pool_role_attachment resource or lists identity_pool_role_attachments in a region + +## Overview + + + + + + + +
Nameidentity_pool_role_attachments
TypeResource
DescriptionResource Type definition for AWS::Cognito::IdentityPoolRoleAttachment
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +For more information, see AWS::Cognito::IdentityPoolRoleAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all identity_pool_role_attachments in a region. +```sql +SELECT +region, +identity_pool_id, +roles, +id, +role_mappings +FROM aws.cognito.identity_pool_role_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual identity_pool_role_attachment. +```sql +SELECT +region, +identity_pool_id, +roles, +id, +role_mappings +FROM aws.cognito.identity_pool_role_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new identity_pool_role_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.identity_pool_role_attachments ( + IdentityPoolId, + region +) +SELECT +'{{ IdentityPoolId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.identity_pool_role_attachments ( + IdentityPoolId, + Roles, + RoleMappings, + region +) +SELECT + '{{ IdentityPoolId }}', + '{{ Roles }}', + '{{ RoleMappings }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: identity_pool_role_attachment + props: + - name: IdentityPoolId + value: '{{ IdentityPoolId }}' + - name: Roles + value: null + - name: RoleMappings + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.identity_pool_role_attachments +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cognito-identity:GetIdentityPoolRoles +``` + +### Update +```json +cognito-identity:GetIdentityPoolRoles, +cognito-identity:SetIdentityPoolRoles, +iam:PassRole +``` + +### Delete +```json +cognito-identity:GetIdentityPoolRoles, +cognito-identity:SetIdentityPoolRoles +``` + +### List +```json +cognito-identity:GetIdentityPoolRoles +``` diff --git a/website/docs/services/cognito/identity_pool_role_attachments_list_only/index.md b/website/docs/services/cognito/identity_pool_role_attachments_list_only/index.md new file mode 100644 index 0000000..8bc04fb --- /dev/null +++ b/website/docs/services/cognito/identity_pool_role_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: identity_pool_role_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pool_role_attachments_list_only + - cognito + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_pool_role_attachments in a region or regions, for all properties use identity_pool_role_attachments + +## Overview + + + + + + + +
Nameidentity_pool_role_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::IdentityPoolRoleAttachment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_pool_role_attachments in a region. +```sql +SELECT +region, +id +FROM aws.cognito.identity_pool_role_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_pool_role_attachments_list_only resource, see identity_pool_role_attachments + diff --git a/website/docs/services/cognito/identity_pools/index.md b/website/docs/services/cognito/identity_pools/index.md new file mode 100644 index 0000000..b40f8ea --- /dev/null +++ b/website/docs/services/cognito/identity_pools/index.md @@ -0,0 +1,300 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an identity_pool resource or lists identity_pools in a region + +## Overview + + + + + + + +
Nameidentity_pools
TypeResource
DescriptionResource Type definition for AWS::Cognito::IdentityPool
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
array
string
object
object
string
object
string
string
boolean
array
array
boolean
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Cognito::IdentityPool. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all identity_pools in a region. +```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, +identity_pool_tags +FROM aws.cognito.identity_pools +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual identity_pool. +```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, +identity_pool_tags +FROM aws.cognito.identity_pools +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new identity_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.identity_pools ( + AllowUnauthenticatedIdentities, + region +) +SELECT +'{{ AllowUnauthenticatedIdentities }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.identity_pools ( + PushSync, + CognitoIdentityProviders, + DeveloperProviderName, + CognitoStreams, + SupportedLoginProviders, + CognitoEvents, + IdentityPoolName, + AllowUnauthenticatedIdentities, + SamlProviderARNs, + OpenIdConnectProviderARNs, + AllowClassicFlow, + IdentityPoolTags, + region +) +SELECT + '{{ PushSync }}', + '{{ CognitoIdentityProviders }}', + '{{ DeveloperProviderName }}', + '{{ CognitoStreams }}', + '{{ SupportedLoginProviders }}', + '{{ CognitoEvents }}', + '{{ IdentityPoolName }}', + '{{ AllowUnauthenticatedIdentities }}', + '{{ SamlProviderARNs }}', + '{{ OpenIdConnectProviderARNs }}', + '{{ AllowClassicFlow }}', + '{{ IdentityPoolTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: identity_pool + props: + - name: PushSync + value: + ApplicationArns: + - '{{ ApplicationArns[0] }}' + RoleArn: '{{ RoleArn }}' + - name: CognitoIdentityProviders + value: + - ServerSideTokenCheck: '{{ ServerSideTokenCheck }}' + ProviderName: '{{ ProviderName }}' + ClientId: '{{ ClientId }}' + - name: DeveloperProviderName + value: '{{ DeveloperProviderName }}' + - name: CognitoStreams + value: + StreamingStatus: '{{ StreamingStatus }}' + StreamName: '{{ StreamName }}' + RoleArn: '{{ RoleArn }}' + - name: SupportedLoginProviders + value: {} + - name: CognitoEvents + value: {} + - name: IdentityPoolName + value: '{{ IdentityPoolName }}' + - name: AllowUnauthenticatedIdentities + value: '{{ AllowUnauthenticatedIdentities }}' + - name: SamlProviderARNs + value: + - '{{ SamlProviderARNs[0] }}' + - name: OpenIdConnectProviderARNs + value: + - '{{ OpenIdConnectProviderARNs[0] }}' + - name: AllowClassicFlow + value: '{{ AllowClassicFlow }}' + - name: IdentityPoolTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.identity_pools +WHERE data__Identifier = '' +AND 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, +cognito-identity:TagResource, +iam:PassRole +``` + +### Read +```json +cognito-identity:DescribeIdentityPool +``` + +### Update +```json +cognito-identity:UpdateIdentityPool, +cognito-identity:DescribeIdentityPool, +cognito-sync:SetIdentityPoolConfiguration, +cognito-sync:SetCognitoEvents, +cognito-identity:TagResource, +cognito-identity:UntagResource, +iam:PassRole +``` + +### Delete +```json +cognito-identity:DeleteIdentityPool +``` + +### List +```json +cognito-identity:ListIdentityPools +``` diff --git a/website/docs/services/cognito/identity_pools_list_only/index.md b/website/docs/services/cognito/identity_pools_list_only/index.md new file mode 100644 index 0000000..afe4540 --- /dev/null +++ b/website/docs/services/cognito/identity_pools_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: identity_pools_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pools_list_only + - cognito + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_pools in a region or regions, for all properties use identity_pools + +## Overview + + + + + + + +
Nameidentity_pools_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::IdentityPool
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_pools in a region. +```sql +SELECT +region, +id +FROM aws.cognito.identity_pools_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_pools_list_only resource, see identity_pools + diff --git a/website/docs/services/cognito/index.md b/website/docs/services/cognito/index.md new file mode 100644 index 0000000..d83cc7e --- /dev/null +++ b/website/docs/services/cognito/index.md @@ -0,0 +1,58 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cognito service documentation. + +:::info Service Summary + +
+
+total resources: 23
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cognito/log_delivery_configurations/index.md b/website/docs/services/cognito/log_delivery_configurations/index.md new file mode 100644 index 0000000..81a017c --- /dev/null +++ b/website/docs/services/cognito/log_delivery_configurations/index.md @@ -0,0 +1,241 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a log_delivery_configuration resource or lists log_delivery_configurations in a region + +## Overview + + + + + + + +
Namelog_delivery_configurations
TypeResource
DescriptionResource Type definition for AWS::Cognito::LogDeliveryConfiguration
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
array
stringAWS region.
+ +For more information, see AWS::Cognito::LogDeliveryConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual log_delivery_configuration. +```sql +SELECT +region, +id, +user_pool_id, +log_configurations +FROM aws.cognito.log_delivery_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new log_delivery_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.log_delivery_configurations ( + UserPoolId, + region +) +SELECT +'{{ UserPoolId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.log_delivery_configurations ( + UserPoolId, + LogConfigurations, + region +) +SELECT + '{{ UserPoolId }}', + '{{ LogConfigurations }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: log_delivery_configuration + props: + - name: UserPoolId + value: '{{ UserPoolId }}' + - name: LogConfigurations + value: + - LogLevel: '{{ LogLevel }}' + EventSource: '{{ EventSource }}' + CloudWatchLogsConfiguration: + LogGroupArn: '{{ LogGroupArn }}' + S3Configuration: + BucketArn: '{{ BucketArn }}' + FirehoseConfiguration: + StreamArn: '{{ StreamArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.log_delivery_configurations +WHERE data__Identifier = '' +AND 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, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +s3:ListBucket, +s3:PutObject, +s3:GetBucketAcl, +firehose:TagDeliveryStream, +iam:CreateServiceLinkedRole +``` + +### 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, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +s3:ListBucket, +s3:PutObject, +s3:GetBucketAcl, +firehose:TagDeliveryStream, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +cognito-idp:GetLogDeliveryConfiguration, +cognito-idp:SetLogDeliveryConfiguration, +logs:CreateLogDelivery, +logs:GetLogDelivery, +logs:UpdateLogDelivery, +logs:DeleteLogDelivery, +logs:ListLogDeliveries, +logs:PutResourcePolicy, +logs:DescribeResourcePolicies, +logs:DescribeLogGroups, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +s3:ListBucket, +s3:PutObject, +s3:GetBucketAcl, +firehose:TagDeliveryStream, +iam:CreateServiceLinkedRole +``` diff --git a/website/docs/services/cognito/managed_login_brandings/index.md b/website/docs/services/cognito/managed_login_brandings/index.md new file mode 100644 index 0000000..98799ea --- /dev/null +++ b/website/docs/services/cognito/managed_login_brandings/index.md @@ -0,0 +1,214 @@ +--- +title: managed_login_brandings +hide_title: false +hide_table_of_contents: false +keywords: + - managed_login_brandings + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a managed_login_branding resource or lists managed_login_brandings in a region + +## Overview + + + + + + + +
Namemanaged_login_brandings
TypeResource
DescriptionResource Type definition for AWS::Cognito::ManagedLoginBranding
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
boolean
object
array
string
boolean
stringAWS region.
+ +For more information, see AWS::Cognito::ManagedLoginBranding. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual managed_login_branding. +```sql +SELECT +region, +user_pool_id, +client_id, +use_cognito_provided_values, +settings, +assets, +managed_login_branding_id, +return_merged_resources +FROM aws.cognito.managed_login_brandings +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new managed_login_branding resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.managed_login_brandings ( + UserPoolId, + region +) +SELECT +'{{ UserPoolId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.managed_login_brandings ( + UserPoolId, + ClientId, + UseCognitoProvidedValues, + Settings, + Assets, + ReturnMergedResources, + region +) +SELECT + '{{ UserPoolId }}', + '{{ ClientId }}', + '{{ UseCognitoProvidedValues }}', + '{{ Settings }}', + '{{ Assets }}', + '{{ ReturnMergedResources }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: managed_login_branding + props: + - name: UserPoolId + value: '{{ UserPoolId }}' + - name: ClientId + value: '{{ ClientId }}' + - name: UseCognitoProvidedValues + value: '{{ UseCognitoProvidedValues }}' + - name: Settings + value: {} + - name: Assets + value: + - Category: '{{ Category }}' + ColorMode: '{{ ColorMode }}' + Extension: '{{ Extension }}' + Bytes: '{{ Bytes }}' + ResourceId: '{{ ResourceId }}' + - name: ReturnMergedResources + value: '{{ ReturnMergedResources }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.managed_login_brandings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the managed_login_brandings resource, the following permissions are required: + +### Create +```json +cognito-idp:CreateManagedLoginBranding +``` + +### Read +```json +cognito-idp:DescribeManagedLoginBranding +``` + +### Update +```json +cognito-idp:UpdateManagedLoginBranding +``` + +### Delete +```json +cognito-idp:DeleteManagedLoginBranding +``` diff --git a/website/docs/services/cognito/user_pool_clients/index.md b/website/docs/services/cognito/user_pool_clients/index.md new file mode 100644 index 0000000..4633773 --- /dev/null +++ b/website/docs/services/cognito/user_pool_clients/index.md @@ -0,0 +1,373 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_pool_client resource or lists user_pool_clients in a region + +## Overview + + + + + + + +
Nameuser_pool_clients
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolClient
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
boolean
array
integer
integer
integer
integer
object
string
array
array
boolean
array
array
string
array
array
object
string
boolean
boolean
string
string
string
stringAWS region.
+ +For more information, see AWS::Cognito::UserPoolClient. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_pool_clients in a region. +```sql +SELECT +region, +client_name, +explicit_auth_flows, +generate_secret, +read_attributes, +auth_session_validity, +refresh_token_validity, +access_token_validity, +id_token_validity, +token_validity_units, +user_pool_id, +write_attributes, +allowed_oauth_flows, +allowed_oauth_flows_user_pool_client, +allowed_oauth_scopes, +callback_urls, +default_redirect_uri, +logout_urls, +supported_identity_providers, +analytics_configuration, +prevent_user_existence_errors, +enable_token_revocation, +enable_propagate_additional_user_context_data, +name, +client_secret, +client_id +FROM aws.cognito.user_pool_clients +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_pool_client. +```sql +SELECT +region, +client_name, +explicit_auth_flows, +generate_secret, +read_attributes, +auth_session_validity, +refresh_token_validity, +access_token_validity, +id_token_validity, +token_validity_units, +user_pool_id, +write_attributes, +allowed_oauth_flows, +allowed_oauth_flows_user_pool_client, +allowed_oauth_scopes, +callback_urls, +default_redirect_uri, +logout_urls, +supported_identity_providers, +analytics_configuration, +prevent_user_existence_errors, +enable_token_revocation, +enable_propagate_additional_user_context_data, +name, +client_secret, +client_id +FROM aws.cognito.user_pool_clients +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_pool_client resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_clients ( + UserPoolId, + region +) +SELECT +'{{ UserPoolId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_clients ( + ClientName, + ExplicitAuthFlows, + GenerateSecret, + ReadAttributes, + AuthSessionValidity, + RefreshTokenValidity, + AccessTokenValidity, + IdTokenValidity, + TokenValidityUnits, + UserPoolId, + WriteAttributes, + AllowedOAuthFlows, + AllowedOAuthFlowsUserPoolClient, + AllowedOAuthScopes, + CallbackURLs, + DefaultRedirectURI, + LogoutURLs, + SupportedIdentityProviders, + AnalyticsConfiguration, + PreventUserExistenceErrors, + EnableTokenRevocation, + EnablePropagateAdditionalUserContextData, + region +) +SELECT + '{{ ClientName }}', + '{{ ExplicitAuthFlows }}', + '{{ GenerateSecret }}', + '{{ ReadAttributes }}', + '{{ AuthSessionValidity }}', + '{{ RefreshTokenValidity }}', + '{{ AccessTokenValidity }}', + '{{ IdTokenValidity }}', + '{{ TokenValidityUnits }}', + '{{ UserPoolId }}', + '{{ WriteAttributes }}', + '{{ AllowedOAuthFlows }}', + '{{ AllowedOAuthFlowsUserPoolClient }}', + '{{ AllowedOAuthScopes }}', + '{{ CallbackURLs }}', + '{{ DefaultRedirectURI }}', + '{{ LogoutURLs }}', + '{{ SupportedIdentityProviders }}', + '{{ AnalyticsConfiguration }}', + '{{ PreventUserExistenceErrors }}', + '{{ EnableTokenRevocation }}', + '{{ EnablePropagateAdditionalUserContextData }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_pool_client + props: + - name: ClientName + value: '{{ ClientName }}' + - name: ExplicitAuthFlows + value: + - '{{ ExplicitAuthFlows[0] }}' + - name: GenerateSecret + value: '{{ GenerateSecret }}' + - name: ReadAttributes + value: + - '{{ ReadAttributes[0] }}' + - name: AuthSessionValidity + value: '{{ AuthSessionValidity }}' + - name: RefreshTokenValidity + value: '{{ RefreshTokenValidity }}' + - name: AccessTokenValidity + value: '{{ AccessTokenValidity }}' + - name: IdTokenValidity + value: '{{ IdTokenValidity }}' + - name: TokenValidityUnits + value: + AccessToken: '{{ AccessToken }}' + IdToken: '{{ IdToken }}' + RefreshToken: '{{ RefreshToken }}' + - name: UserPoolId + value: '{{ UserPoolId }}' + - name: WriteAttributes + value: + - '{{ WriteAttributes[0] }}' + - name: AllowedOAuthFlows + value: + - '{{ AllowedOAuthFlows[0] }}' + - name: AllowedOAuthFlowsUserPoolClient + value: '{{ AllowedOAuthFlowsUserPoolClient }}' + - name: AllowedOAuthScopes + value: + - '{{ AllowedOAuthScopes[0] }}' + - name: CallbackURLs + value: + - '{{ CallbackURLs[0] }}' + - name: DefaultRedirectURI + value: '{{ DefaultRedirectURI }}' + - name: LogoutURLs + value: + - '{{ LogoutURLs[0] }}' + - name: SupportedIdentityProviders + value: + - '{{ SupportedIdentityProviders[0] }}' + - name: AnalyticsConfiguration + value: + ApplicationArn: '{{ ApplicationArn }}' + ApplicationId: '{{ ApplicationId }}' + ExternalId: '{{ ExternalId }}' + RoleArn: '{{ RoleArn }}' + UserDataShared: '{{ UserDataShared }}' + - name: PreventUserExistenceErrors + value: '{{ PreventUserExistenceErrors }}' + - name: EnableTokenRevocation + value: '{{ EnableTokenRevocation }}' + - name: EnablePropagateAdditionalUserContextData + value: '{{ EnablePropagateAdditionalUserContextData }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.user_pool_clients +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cognito-idp:DescribeUserPoolClient +``` + +### Update +```json +cognito-idp:UpdateUserPoolClient, +iam:PassRole, +iam:PutRolePolicy +``` + +### Delete +```json +cognito-idp:DeleteUserPoolClient, +iam:PutRolePolicy, +iam:DeleteRolePolicy +``` + +### List +```json +cognito-idp:ListUserPoolClients +``` diff --git a/website/docs/services/cognito/user_pool_clients_list_only/index.md b/website/docs/services/cognito/user_pool_clients_list_only/index.md new file mode 100644 index 0000000..7348320 --- /dev/null +++ b/website/docs/services/cognito/user_pool_clients_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: user_pool_clients_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_clients_list_only + - cognito + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_pool_clients in a region or regions, for all properties use user_pool_clients + +## Overview + + + + + + + +
Nameuser_pool_clients_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolClient
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_pool_clients in a region. +```sql +SELECT +region, +user_pool_id, +client_id +FROM aws.cognito.user_pool_clients_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_pool_clients_list_only resource, see user_pool_clients + diff --git a/website/docs/services/cognito/user_pool_groups/index.md b/website/docs/services/cognito/user_pool_groups/index.md new file mode 100644 index 0000000..d82bcf5 --- /dev/null +++ b/website/docs/services/cognito/user_pool_groups/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_pool_group resource or lists user_pool_groups in a region + +## Overview + + + + + + + +
Nameuser_pool_groups
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
integer
string
string
stringAWS region.
+ +For more information, see AWS::Cognito::UserPoolGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_pool_groups in a region. +```sql +SELECT +region, +description, +group_name, +precedence, +role_arn, +user_pool_id +FROM aws.cognito.user_pool_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_pool_group. +```sql +SELECT +region, +description, +group_name, +precedence, +role_arn, +user_pool_id +FROM aws.cognito.user_pool_groups +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_pool_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_groups ( + UserPoolId, + region +) +SELECT +'{{ UserPoolId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_groups ( + Description, + GroupName, + Precedence, + RoleArn, + UserPoolId, + region +) +SELECT + '{{ Description }}', + '{{ GroupName }}', + '{{ Precedence }}', + '{{ RoleArn }}', + '{{ UserPoolId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_pool_group + props: + - name: Description + value: '{{ Description }}' + - name: GroupName + value: '{{ GroupName }}' + - name: Precedence + value: '{{ Precedence }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: UserPoolId + value: '{{ UserPoolId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.user_pool_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cognito-idp:GetGroup +``` + +### Update +```json +cognito-idp:UpdateGroup, +iam:PassRole, +iam:PutRolePolicy +``` + +### Delete +```json +cognito-idp:DeleteGroup, +cognito-idp:GetGroup, +iam:PutRolePolicy +``` + +### List +```json +cognito-idp:ListGroups +``` diff --git a/website/docs/services/cognito/user_pool_groups_list_only/index.md b/website/docs/services/cognito/user_pool_groups_list_only/index.md new file mode 100644 index 0000000..c758382 --- /dev/null +++ b/website/docs/services/cognito/user_pool_groups_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: user_pool_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_groups_list_only + - cognito + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_pool_groups in a region or regions, for all properties use user_pool_groups + +## Overview + + + + + + + +
Nameuser_pool_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolGroup
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_pool_groups in a region. +```sql +SELECT +region, +user_pool_id, +group_name +FROM aws.cognito.user_pool_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_pool_groups_list_only resource, see user_pool_groups + diff --git a/website/docs/services/cognito/user_pool_identity_providers/index.md b/website/docs/services/cognito/user_pool_identity_providers/index.md new file mode 100644 index 0000000..05ed3d7 --- /dev/null +++ b/website/docs/services/cognito/user_pool_identity_providers/index.md @@ -0,0 +1,239 @@ +--- +title: user_pool_identity_providers +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_identity_providers + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_pool_identity_provider resource or lists user_pool_identity_providers in a region + +## Overview + + + + + + + +
Nameuser_pool_identity_providers
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolIdentityProvider
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
array
object
stringAWS region.
+ +For more information, see AWS::Cognito::UserPoolIdentityProvider. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_pool_identity_providers in a region. +```sql +SELECT +region, +user_pool_id, +provider_name, +provider_type, +provider_details, +idp_identifiers, +attribute_mapping +FROM aws.cognito.user_pool_identity_providers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_pool_identity_provider. +```sql +SELECT +region, +user_pool_id, +provider_name, +provider_type, +provider_details, +idp_identifiers, +attribute_mapping +FROM aws.cognito.user_pool_identity_providers +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_pool_identity_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_identity_providers ( + UserPoolId, + ProviderName, + ProviderType, + ProviderDetails, + region +) +SELECT +'{{ UserPoolId }}', + '{{ ProviderName }}', + '{{ ProviderType }}', + '{{ ProviderDetails }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_identity_providers ( + UserPoolId, + ProviderName, + ProviderType, + ProviderDetails, + IdpIdentifiers, + AttributeMapping, + region +) +SELECT + '{{ UserPoolId }}', + '{{ ProviderName }}', + '{{ ProviderType }}', + '{{ ProviderDetails }}', + '{{ IdpIdentifiers }}', + '{{ AttributeMapping }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_pool_identity_provider + props: + - name: UserPoolId + value: '{{ UserPoolId }}' + - name: ProviderName + value: '{{ ProviderName }}' + - name: ProviderType + value: '{{ ProviderType }}' + - name: ProviderDetails + value: {} + - name: IdpIdentifiers + value: + - '{{ IdpIdentifiers[0] }}' + - name: AttributeMapping + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.user_pool_identity_providers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the user_pool_identity_providers resource, the following permissions are required: + +### Create +```json +cognito-idp:CreateIdentityProvider, +cognito-idp:DescribeIdentityProvider +``` + +### Read +```json +cognito-idp:DescribeIdentityProvider +``` + +### Update +```json +cognito-idp:UpdateIdentityProvider, +cognito-idp:DescribeIdentityProvider +``` + +### Delete +```json +cognito-idp:DeleteIdentityProvider, +cognito-idp:DescribeIdentityProvider +``` + +### List +```json +cognito-idp:ListIdentityProviders +``` diff --git a/website/docs/services/cognito/user_pool_identity_providers_list_only/index.md b/website/docs/services/cognito/user_pool_identity_providers_list_only/index.md new file mode 100644 index 0000000..91b9cfe --- /dev/null +++ b/website/docs/services/cognito/user_pool_identity_providers_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: user_pool_identity_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_identity_providers_list_only + - cognito + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_pool_identity_providers in a region or regions, for all properties use user_pool_identity_providers + +## Overview + + + + + + + +
Nameuser_pool_identity_providers_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolIdentityProvider
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_pool_identity_providers in a region. +```sql +SELECT +region, +user_pool_id, +provider_name +FROM aws.cognito.user_pool_identity_providers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_pool_identity_providers_list_only resource, see user_pool_identity_providers + diff --git a/website/docs/services/cognito/user_pool_resource_servers/index.md b/website/docs/services/cognito/user_pool_resource_servers/index.md new file mode 100644 index 0000000..a41fa58 --- /dev/null +++ b/website/docs/services/cognito/user_pool_resource_servers/index.md @@ -0,0 +1,221 @@ +--- +title: user_pool_resource_servers +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_resource_servers + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_pool_resource_server resource or lists user_pool_resource_servers in a region + +## Overview + + + + + + + +
Nameuser_pool_resource_servers
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolResourceServer
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
array
stringAWS region.
+ +For more information, see AWS::Cognito::UserPoolResourceServer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_pool_resource_servers in a region. +```sql +SELECT +region, +user_pool_id, +identifier, +name, +scopes +FROM aws.cognito.user_pool_resource_servers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_pool_resource_server. +```sql +SELECT +region, +user_pool_id, +identifier, +name, +scopes +FROM aws.cognito.user_pool_resource_servers +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_pool_resource_server resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_resource_servers ( + UserPoolId, + Identifier, + Name, + region +) +SELECT +'{{ UserPoolId }}', + '{{ Identifier }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_resource_servers ( + UserPoolId, + Identifier, + Name, + Scopes, + region +) +SELECT + '{{ UserPoolId }}', + '{{ Identifier }}', + '{{ Name }}', + '{{ Scopes }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_pool_resource_server + props: + - name: UserPoolId + value: '{{ UserPoolId }}' + - name: Identifier + value: '{{ Identifier }}' + - name: Name + value: '{{ Name }}' + - name: Scopes + value: + - ScopeDescription: '{{ ScopeDescription }}' + ScopeName: '{{ ScopeName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.user_pool_resource_servers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the user_pool_resource_servers resource, the following permissions are required: + +### Create +```json +cognito-idp:CreateResourceServer +``` + +### Read +```json +cognito-idp:DescribeResourceServer +``` + +### Update +```json +cognito-idp:UpdateResourceServer +``` + +### Delete +```json +cognito-idp:DeleteResourceServer +``` + +### List +```json +cognito-idp:ListResourceServers +``` diff --git a/website/docs/services/cognito/user_pool_resource_servers_list_only/index.md b/website/docs/services/cognito/user_pool_resource_servers_list_only/index.md new file mode 100644 index 0000000..f647a79 --- /dev/null +++ b/website/docs/services/cognito/user_pool_resource_servers_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: user_pool_resource_servers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_resource_servers_list_only + - cognito + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_pool_resource_servers in a region or regions, for all properties use user_pool_resource_servers + +## Overview + + + + + + + +
Nameuser_pool_resource_servers_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolResourceServer
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_pool_resource_servers in a region. +```sql +SELECT +region, +user_pool_id, +identifier +FROM aws.cognito.user_pool_resource_servers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_pool_resource_servers_list_only resource, see user_pool_resource_servers + diff --git a/website/docs/services/cognito/user_pool_risk_configuration_attachments/index.md b/website/docs/services/cognito/user_pool_risk_configuration_attachments/index.md new file mode 100644 index 0000000..6dc45a2 --- /dev/null +++ b/website/docs/services/cognito/user_pool_risk_configuration_attachments/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_pool_risk_configuration_attachment resource or lists user_pool_risk_configuration_attachments in a region + +## Overview + + + + + + + +
Nameuser_pool_risk_configuration_attachments
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolRiskConfigurationAttachment
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
object
object
object
stringAWS region.
+ +For more information, see AWS::Cognito::UserPoolRiskConfigurationAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual user_pool_risk_configuration_attachment. +```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_attachments +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_pool_risk_configuration_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_risk_configuration_attachments ( + UserPoolId, + ClientId, + region +) +SELECT +'{{ UserPoolId }}', + '{{ ClientId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_risk_configuration_attachments ( + UserPoolId, + ClientId, + RiskExceptionConfiguration, + CompromisedCredentialsRiskConfiguration, + AccountTakeoverRiskConfiguration, + region +) +SELECT + '{{ UserPoolId }}', + '{{ ClientId }}', + '{{ RiskExceptionConfiguration }}', + '{{ CompromisedCredentialsRiskConfiguration }}', + '{{ AccountTakeoverRiskConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_pool_risk_configuration_attachment + props: + - name: UserPoolId + value: '{{ UserPoolId }}' + - name: ClientId + value: '{{ ClientId }}' + - name: RiskExceptionConfiguration + value: + BlockedIPRangeList: + - '{{ BlockedIPRangeList[0] }}' + SkippedIPRangeList: + - '{{ SkippedIPRangeList[0] }}' + - name: CompromisedCredentialsRiskConfiguration + value: + Actions: + EventAction: '{{ EventAction }}' + EventFilter: + - '{{ EventFilter[0] }}' + - name: AccountTakeoverRiskConfiguration + value: + Actions: + HighAction: + EventAction: '{{ EventAction }}' + Notify: '{{ Notify }}' + LowAction: null + MediumAction: null + NotifyConfiguration: + BlockEmail: + HtmlBody: '{{ HtmlBody }}' + Subject: '{{ Subject }}' + TextBody: '{{ TextBody }}' + MfaEmail: null + NoActionEmail: null + From: '{{ From }}' + ReplyTo: '{{ ReplyTo }}' + SourceArn: '{{ SourceArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.user_pool_risk_configuration_attachments +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/cognito/user_pool_user_to_group_attachments/index.md b/website/docs/services/cognito/user_pool_user_to_group_attachments/index.md new file mode 100644 index 0000000..6ccae83 --- /dev/null +++ b/website/docs/services/cognito/user_pool_user_to_group_attachments/index.md @@ -0,0 +1,185 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_pool_user_to_group_attachment resource or lists user_pool_user_to_group_attachments in a region + +## Overview + + + + + + + +
Nameuser_pool_user_to_group_attachments
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +For more information, see AWS::Cognito::UserPoolUserToGroupAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual user_pool_user_to_group_attachment. +```sql +SELECT +region, +user_pool_id, +username, +group_name +FROM aws.cognito.user_pool_user_to_group_attachments +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_pool_user_to_group_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_user_to_group_attachments ( + UserPoolId, + Username, + GroupName, + region +) +SELECT +'{{ UserPoolId }}', + '{{ Username }}', + '{{ GroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_user_to_group_attachments ( + UserPoolId, + Username, + GroupName, + region +) +SELECT + '{{ UserPoolId }}', + '{{ Username }}', + '{{ GroupName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_pool_user_to_group_attachment + props: + - name: UserPoolId + value: '{{ UserPoolId }}' + - name: Username + value: '{{ Username }}' + - name: GroupName + value: '{{ GroupName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.user_pool_user_to_group_attachments +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +cognito-idp:AdminRemoveUserFromGroup, +cognito-idp:AdminListGroupsForUser +``` + +### Read +```json +cognito-idp:AdminListGroupsForUser +``` diff --git a/website/docs/services/cognito/user_pool_users/index.md b/website/docs/services/cognito/user_pool_users/index.md new file mode 100644 index 0000000..b0aeace --- /dev/null +++ b/website/docs/services/cognito/user_pool_users/index.md @@ -0,0 +1,239 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_pool_user resource or lists user_pool_users in a region + +## Overview + + + + + + + +
Nameuser_pool_users
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolUser
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
array
boolean
array
string
string
string
array
object
stringAWS region.
+ +For more information, see AWS::Cognito::UserPoolUser. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_pool_users in a region. +```sql +SELECT +region, +desired_delivery_mediums, +force_alias_creation, +user_attributes, +message_action, +username, +user_pool_id, +validation_data, +client_metadata +FROM aws.cognito.user_pool_users +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_pool_user. +```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_users +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_pool_user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_users ( + UserPoolId, + region +) +SELECT +'{{ UserPoolId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pool_users ( + DesiredDeliveryMediums, + ForceAliasCreation, + UserAttributes, + MessageAction, + Username, + UserPoolId, + ValidationData, + ClientMetadata, + region +) +SELECT + '{{ DesiredDeliveryMediums }}', + '{{ ForceAliasCreation }}', + '{{ UserAttributes }}', + '{{ MessageAction }}', + '{{ Username }}', + '{{ UserPoolId }}', + '{{ ValidationData }}', + '{{ ClientMetadata }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_pool_user + props: + - name: DesiredDeliveryMediums + value: + - '{{ DesiredDeliveryMediums[0] }}' + - name: ForceAliasCreation + value: '{{ ForceAliasCreation }}' + - name: UserAttributes + value: + - Name: '{{ Name }}' + Value: '{{ Value }}' + - name: MessageAction + value: '{{ MessageAction }}' + - name: Username + value: '{{ Username }}' + - name: UserPoolId + value: '{{ UserPoolId }}' + - name: ValidationData + value: + - null + - name: ClientMetadata + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.user_pool_users +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +cognito-idp:AdminGetUser +``` + +### Delete +```json +cognito-idp:AdminDeleteUser +``` + +### List +```json +cognito-idp:ListUsers +``` diff --git a/website/docs/services/cognito/user_pool_users_list_only/index.md b/website/docs/services/cognito/user_pool_users_list_only/index.md new file mode 100644 index 0000000..7c0b8de --- /dev/null +++ b/website/docs/services/cognito/user_pool_users_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: user_pool_users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_users_list_only + - cognito + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_pool_users in a region or regions, for all properties use user_pool_users + +## Overview + + + + + + + +
Nameuser_pool_users_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolUser
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_pool_users in a region. +```sql +SELECT +region, +user_pool_id, +username +FROM aws.cognito.user_pool_users_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_pool_users_list_only resource, see user_pool_users + diff --git a/website/docs/services/cognito/user_pools/index.md b/website/docs/services/cognito/user_pools/index.md new file mode 100644 index 0000000..9734031 --- /dev/null +++ b/website/docs/services/cognito/user_pools/index.md @@ -0,0 +1,550 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_pool resource or lists user_pools in a region + +## Overview + + + + + + + +
Nameuser_pools
TypeResource
DescriptionDefinition of AWS::Cognito::UserPool Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
object
array
array
array
object
object
string
string
string
object
string
array
string
string
string
object
string
string
string
array
object
object
object
object
object
string
string
string
string
string
stringAWS region.
+ +For more information, see AWS::Cognito::UserPool. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_pools in a region. +```sql +SELECT +region, +user_pool_name, +policies, +account_recovery_setting, +admin_create_user_config, +alias_attributes, +username_attributes, +auto_verified_attributes, +device_configuration, +email_configuration, +email_verification_message, +email_verification_subject, +deletion_protection, +lambda_config, +mfa_configuration, +enabled_mfas, +sms_authentication_message, +email_authentication_message, +email_authentication_subject, +sms_configuration, +sms_verification_message, +web_authn_relying_party_id, +web_authn_user_verification, +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, +user_pool_tier +FROM aws.cognito.user_pools +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_pool. +```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, +email_authentication_message, +email_authentication_subject, +sms_configuration, +sms_verification_message, +web_authn_relying_party_id, +web_authn_user_verification, +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, +user_pool_tier +FROM aws.cognito.user_pools +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pools ( + UserPoolName, + Policies, + AccountRecoverySetting, + AdminCreateUserConfig, + AliasAttributes, + UsernameAttributes, + AutoVerifiedAttributes, + DeviceConfiguration, + EmailConfiguration, + EmailVerificationMessage, + EmailVerificationSubject, + DeletionProtection, + LambdaConfig, + MfaConfiguration, + EnabledMfas, + SmsAuthenticationMessage, + EmailAuthenticationMessage, + EmailAuthenticationSubject, + SmsConfiguration, + SmsVerificationMessage, + WebAuthnRelyingPartyID, + WebAuthnUserVerification, + Schema, + UsernameConfiguration, + UserAttributeUpdateSettings, + UserPoolTags, + VerificationMessageTemplate, + UserPoolAddOns, + UserPoolTier, + region +) +SELECT +'{{ UserPoolName }}', + '{{ Policies }}', + '{{ AccountRecoverySetting }}', + '{{ AdminCreateUserConfig }}', + '{{ AliasAttributes }}', + '{{ UsernameAttributes }}', + '{{ AutoVerifiedAttributes }}', + '{{ DeviceConfiguration }}', + '{{ EmailConfiguration }}', + '{{ EmailVerificationMessage }}', + '{{ EmailVerificationSubject }}', + '{{ DeletionProtection }}', + '{{ LambdaConfig }}', + '{{ MfaConfiguration }}', + '{{ EnabledMfas }}', + '{{ SmsAuthenticationMessage }}', + '{{ EmailAuthenticationMessage }}', + '{{ EmailAuthenticationSubject }}', + '{{ SmsConfiguration }}', + '{{ SmsVerificationMessage }}', + '{{ WebAuthnRelyingPartyID }}', + '{{ WebAuthnUserVerification }}', + '{{ Schema }}', + '{{ UsernameConfiguration }}', + '{{ UserAttributeUpdateSettings }}', + '{{ UserPoolTags }}', + '{{ VerificationMessageTemplate }}', + '{{ UserPoolAddOns }}', + '{{ UserPoolTier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_pools ( + UserPoolName, + Policies, + AccountRecoverySetting, + AdminCreateUserConfig, + AliasAttributes, + UsernameAttributes, + AutoVerifiedAttributes, + DeviceConfiguration, + EmailConfiguration, + EmailVerificationMessage, + EmailVerificationSubject, + DeletionProtection, + LambdaConfig, + MfaConfiguration, + EnabledMfas, + SmsAuthenticationMessage, + EmailAuthenticationMessage, + EmailAuthenticationSubject, + SmsConfiguration, + SmsVerificationMessage, + WebAuthnRelyingPartyID, + WebAuthnUserVerification, + Schema, + UsernameConfiguration, + UserAttributeUpdateSettings, + UserPoolTags, + VerificationMessageTemplate, + UserPoolAddOns, + UserPoolTier, + region +) +SELECT + '{{ UserPoolName }}', + '{{ Policies }}', + '{{ AccountRecoverySetting }}', + '{{ AdminCreateUserConfig }}', + '{{ AliasAttributes }}', + '{{ UsernameAttributes }}', + '{{ AutoVerifiedAttributes }}', + '{{ DeviceConfiguration }}', + '{{ EmailConfiguration }}', + '{{ EmailVerificationMessage }}', + '{{ EmailVerificationSubject }}', + '{{ DeletionProtection }}', + '{{ LambdaConfig }}', + '{{ MfaConfiguration }}', + '{{ EnabledMfas }}', + '{{ SmsAuthenticationMessage }}', + '{{ EmailAuthenticationMessage }}', + '{{ EmailAuthenticationSubject }}', + '{{ SmsConfiguration }}', + '{{ SmsVerificationMessage }}', + '{{ WebAuthnRelyingPartyID }}', + '{{ WebAuthnUserVerification }}', + '{{ Schema }}', + '{{ UsernameConfiguration }}', + '{{ UserAttributeUpdateSettings }}', + '{{ UserPoolTags }}', + '{{ VerificationMessageTemplate }}', + '{{ UserPoolAddOns }}', + '{{ UserPoolTier }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_pool + props: + - name: UserPoolName + value: '{{ UserPoolName }}' + - name: Policies + value: + PasswordPolicy: + MinimumLength: '{{ MinimumLength }}' + RequireLowercase: '{{ RequireLowercase }}' + RequireNumbers: '{{ RequireNumbers }}' + RequireSymbols: '{{ RequireSymbols }}' + RequireUppercase: '{{ RequireUppercase }}' + TemporaryPasswordValidityDays: '{{ TemporaryPasswordValidityDays }}' + PasswordHistorySize: '{{ PasswordHistorySize }}' + SignInPolicy: + AllowedFirstAuthFactors: + - '{{ AllowedFirstAuthFactors[0] }}' + - name: AccountRecoverySetting + value: + RecoveryMechanisms: + - Name: '{{ Name }}' + Priority: '{{ Priority }}' + - name: AdminCreateUserConfig + value: + AllowAdminCreateUserOnly: '{{ AllowAdminCreateUserOnly }}' + InviteMessageTemplate: + EmailMessage: '{{ EmailMessage }}' + EmailSubject: '{{ EmailSubject }}' + SMSMessage: '{{ SMSMessage }}' + UnusedAccountValidityDays: '{{ UnusedAccountValidityDays }}' + - name: AliasAttributes + value: + - '{{ AliasAttributes[0] }}' + - name: UsernameAttributes + value: + - '{{ UsernameAttributes[0] }}' + - name: AutoVerifiedAttributes + value: + - '{{ AutoVerifiedAttributes[0] }}' + - name: DeviceConfiguration + value: + ChallengeRequiredOnNewDevice: '{{ ChallengeRequiredOnNewDevice }}' + DeviceOnlyRememberedOnUserPrompt: '{{ DeviceOnlyRememberedOnUserPrompt }}' + - name: EmailConfiguration + value: + ReplyToEmailAddress: '{{ ReplyToEmailAddress }}' + SourceArn: '{{ SourceArn }}' + From: '{{ From }}' + ConfigurationSet: '{{ ConfigurationSet }}' + EmailSendingAccount: '{{ EmailSendingAccount }}' + - name: EmailVerificationMessage + value: '{{ EmailVerificationMessage }}' + - name: EmailVerificationSubject + value: '{{ EmailVerificationSubject }}' + - name: DeletionProtection + value: '{{ DeletionProtection }}' + - name: LambdaConfig + value: + CreateAuthChallenge: '{{ CreateAuthChallenge }}' + CustomMessage: '{{ CustomMessage }}' + DefineAuthChallenge: '{{ DefineAuthChallenge }}' + PostAuthentication: '{{ PostAuthentication }}' + PostConfirmation: '{{ PostConfirmation }}' + PreAuthentication: '{{ PreAuthentication }}' + PreSignUp: '{{ PreSignUp }}' + VerifyAuthChallengeResponse: '{{ VerifyAuthChallengeResponse }}' + UserMigration: '{{ UserMigration }}' + PreTokenGeneration: '{{ PreTokenGeneration }}' + CustomEmailSender: + LambdaVersion: '{{ LambdaVersion }}' + LambdaArn: '{{ LambdaArn }}' + CustomSMSSender: + LambdaVersion: '{{ LambdaVersion }}' + LambdaArn: '{{ LambdaArn }}' + KMSKeyID: '{{ KMSKeyID }}' + PreTokenGenerationConfig: + LambdaVersion: '{{ LambdaVersion }}' + LambdaArn: '{{ LambdaArn }}' + - name: MfaConfiguration + value: '{{ MfaConfiguration }}' + - name: EnabledMfas + value: + - '{{ EnabledMfas[0] }}' + - name: SmsAuthenticationMessage + value: '{{ SmsAuthenticationMessage }}' + - name: EmailAuthenticationMessage + value: '{{ EmailAuthenticationMessage }}' + - name: EmailAuthenticationSubject + value: '{{ EmailAuthenticationSubject }}' + - name: SmsConfiguration + value: + ExternalId: '{{ ExternalId }}' + SnsCallerArn: '{{ SnsCallerArn }}' + SnsRegion: '{{ SnsRegion }}' + - name: SmsVerificationMessage + value: '{{ SmsVerificationMessage }}' + - name: WebAuthnRelyingPartyID + value: '{{ WebAuthnRelyingPartyID }}' + - name: WebAuthnUserVerification + value: '{{ WebAuthnUserVerification }}' + - name: Schema + value: + - AttributeDataType: '{{ AttributeDataType }}' + DeveloperOnlyAttribute: '{{ DeveloperOnlyAttribute }}' + Mutable: '{{ Mutable }}' + Name: '{{ Name }}' + NumberAttributeConstraints: + MaxValue: '{{ MaxValue }}' + MinValue: '{{ MinValue }}' + StringAttributeConstraints: + MaxLength: '{{ MaxLength }}' + MinLength: '{{ MinLength }}' + Required: '{{ Required }}' + - name: UsernameConfiguration + value: + CaseSensitive: '{{ CaseSensitive }}' + - name: UserAttributeUpdateSettings + value: + AttributesRequireVerificationBeforeUpdate: + - '{{ AttributesRequireVerificationBeforeUpdate[0] }}' + - name: UserPoolTags + value: {} + - name: VerificationMessageTemplate + value: + DefaultEmailOption: '{{ DefaultEmailOption }}' + EmailMessage: '{{ EmailMessage }}' + EmailMessageByLink: '{{ EmailMessageByLink }}' + EmailSubject: '{{ EmailSubject }}' + EmailSubjectByLink: '{{ EmailSubjectByLink }}' + SmsMessage: '{{ SmsMessage }}' + - name: UserPoolAddOns + value: + AdvancedSecurityMode: '{{ AdvancedSecurityMode }}' + AdvancedSecurityAdditionalFlows: + CustomAuthMode: '{{ CustomAuthMode }}' + - name: UserPoolTier + value: '{{ UserPoolTier }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.user_pools +WHERE data__Identifier = '' +AND 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, +cognito-idp:TagResource +``` + +### Read +```json +cognito-idp:DescribeUserPool, +cognito-idp:GetUserPoolMfaConfig +``` + +### Update +```json +cognito-idp:UpdateUserPool, +cognito-idp:ListTagsForResource, +cognito-idp:UntagResource, +cognito-idp:TagResource, +cognito-idp:SetUserPoolMfaConfig, +cognito-idp:AddCustomAttributes, +cognito-idp:DescribeUserPool, +cognito-idp:GetUserPoolMfaConfig, +iam:PassRole +``` + +### Delete +```json +cognito-idp:DeleteUserPool +``` + +### List +```json +cognito-idp:ListUserPools +``` diff --git a/website/docs/services/cognito/user_pools_list_only/index.md b/website/docs/services/cognito/user_pools_list_only/index.md new file mode 100644 index 0000000..8e122db --- /dev/null +++ b/website/docs/services/cognito/user_pools_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: user_pools_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_pools_list_only + - cognito + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_pools in a region or regions, for all properties use user_pools + +## Overview + + + + + + + +
Nameuser_pools_list_only
TypeResource
DescriptionDefinition of AWS::Cognito::UserPool Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_pools in a region. +```sql +SELECT +region, +user_pool_id +FROM aws.cognito.user_pools_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_pools_list_only resource, see user_pools + diff --git a/website/docs/services/cognito/user_poolui_customization_attachments/index.md b/website/docs/services/cognito/user_poolui_customization_attachments/index.md new file mode 100644 index 0000000..f3fe14c --- /dev/null +++ b/website/docs/services/cognito/user_poolui_customization_attachments/index.md @@ -0,0 +1,193 @@ +--- +title: user_poolui_customization_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - user_poolui_customization_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_poolui_customization_attachment resource or lists user_poolui_customization_attachments in a region + +## Overview + + + + + + + +
Nameuser_poolui_customization_attachments
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolUICustomizationAttachment
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +For more information, see AWS::Cognito::UserPoolUICustomizationAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual user_poolui_customization_attachment. +```sql +SELECT +region, +user_pool_id, +client_id, +c_ss +FROM aws.cognito.user_poolui_customization_attachments +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_poolui_customization_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_poolui_customization_attachments ( + UserPoolId, + ClientId, + region +) +SELECT +'{{ UserPoolId }}', + '{{ ClientId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cognito.user_poolui_customization_attachments ( + UserPoolId, + ClientId, + CSS, + region +) +SELECT + '{{ UserPoolId }}', + '{{ ClientId }}', + '{{ CSS }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_poolui_customization_attachment + props: + - name: UserPoolId + value: '{{ UserPoolId }}' + - name: ClientId + value: '{{ ClientId }}' + - name: CSS + value: '{{ CSS }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cognito.user_poolui_customization_attachments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the user_poolui_customization_attachments resource, the following permissions are required: + +### Create +```json +cognito-idp:SetUICustomization, +cognito-idp:GetUICustomization +``` + +### Read +```json +cognito-idp:GetUICustomization +``` + +### Update +```json +cognito-idp:SetUICustomization +``` + +### Delete +```json +cognito-idp:SetUICustomization, +cognito-idp:GetUICustomization +``` diff --git a/website/docs/services/comprehend/document_classifier_tags/index.md b/website/docs/services/comprehend/document_classifier_tags/index.md new file mode 100644 index 0000000..ca33884 --- /dev/null +++ b/website/docs/services/comprehend/document_classifier_tags/index.md @@ -0,0 +1,99 @@ +--- +title: document_classifier_tags +hide_title: false +hide_table_of_contents: false +keywords: + - document_classifier_tags + - comprehend + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for document_classifiers in a region + +## Overview + + + + + + + +
Namedocument_classifier_tags
TypeResource
DescriptionDocument Classifier enables training document classifier models.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
string
string
string
string
string
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all document_classifiers in a region. +```sql +SELECT +region, +data_access_role_arn, +input_data_config, +output_data_config, +language_code, +model_kms_key_id, +model_policy, +document_classifier_name, +mode, +version_name, +volume_kms_key_id, +vpc_config, +arn, +tag_key, +tag_value +FROM aws.comprehend.document_classifier_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the document_classifier_tags resource, see document_classifiers + diff --git a/website/docs/services/comprehend/document_classifiers/index.md b/website/docs/services/comprehend/document_classifiers/index.md new file mode 100644 index 0000000..b71f8da --- /dev/null +++ b/website/docs/services/comprehend/document_classifiers/index.md @@ -0,0 +1,321 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a document_classifier resource or lists document_classifiers in a region + +## Overview + + + + + + + +
Namedocument_classifiers
TypeResource
DescriptionDocument Classifier enables training document classifier models.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
string
string
string
string
string
array
string
string
object
string
stringAWS region.
+ +For more information, see AWS::Comprehend::DocumentClassifier. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all document_classifiers in a region. +```sql +SELECT +region, +data_access_role_arn, +input_data_config, +output_data_config, +language_code, +model_kms_key_id, +model_policy, +document_classifier_name, +mode, +tags, +version_name, +volume_kms_key_id, +vpc_config, +arn +FROM aws.comprehend.document_classifiers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual document_classifier. +```sql +SELECT +region, +data_access_role_arn, +input_data_config, +output_data_config, +language_code, +model_kms_key_id, +model_policy, +document_classifier_name, +mode, +tags, +version_name, +volume_kms_key_id, +vpc_config, +arn +FROM aws.comprehend.document_classifiers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new document_classifier resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.comprehend.document_classifiers ( + DataAccessRoleArn, + InputDataConfig, + LanguageCode, + DocumentClassifierName, + region +) +SELECT +'{{ DataAccessRoleArn }}', + '{{ InputDataConfig }}', + '{{ LanguageCode }}', + '{{ DocumentClassifierName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.comprehend.document_classifiers ( + DataAccessRoleArn, + InputDataConfig, + OutputDataConfig, + LanguageCode, + ModelKmsKeyId, + ModelPolicy, + DocumentClassifierName, + Mode, + Tags, + VersionName, + VolumeKmsKeyId, + VpcConfig, + region +) +SELECT + '{{ DataAccessRoleArn }}', + '{{ InputDataConfig }}', + '{{ OutputDataConfig }}', + '{{ LanguageCode }}', + '{{ ModelKmsKeyId }}', + '{{ ModelPolicy }}', + '{{ DocumentClassifierName }}', + '{{ Mode }}', + '{{ Tags }}', + '{{ VersionName }}', + '{{ VolumeKmsKeyId }}', + '{{ VpcConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: document_classifier + props: + - name: DataAccessRoleArn + value: '{{ DataAccessRoleArn }}' + - name: InputDataConfig + value: + AugmentedManifests: + - AttributeNames: + - '{{ AttributeNames[0] }}' + S3Uri: '{{ S3Uri }}' + Split: '{{ Split }}' + DataFormat: '{{ DataFormat }}' + LabelDelimiter: '{{ LabelDelimiter }}' + DocumentType: '{{ DocumentType }}' + Documents: + S3Uri: null + TestS3Uri: null + DocumentReaderConfig: + DocumentReadAction: '{{ DocumentReadAction }}' + DocumentReadMode: '{{ DocumentReadMode }}' + FeatureTypes: + - '{{ FeatureTypes[0] }}' + S3Uri: null + TestS3Uri: null + - name: OutputDataConfig + value: + KmsKeyId: '{{ KmsKeyId }}' + S3Uri: null + - name: LanguageCode + value: '{{ LanguageCode }}' + - name: ModelKmsKeyId + value: null + - name: ModelPolicy + value: '{{ ModelPolicy }}' + - name: DocumentClassifierName + value: '{{ DocumentClassifierName }}' + - name: Mode + value: '{{ Mode }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VersionName + value: '{{ VersionName }}' + - name: VolumeKmsKeyId + value: null + - name: VpcConfig + value: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + Subnets: + - '{{ Subnets[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.comprehend.document_classifiers +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +comprehend:ListDocumentClassifiers +``` diff --git a/website/docs/services/comprehend/document_classifiers_list_only/index.md b/website/docs/services/comprehend/document_classifiers_list_only/index.md new file mode 100644 index 0000000..9cbae95 --- /dev/null +++ b/website/docs/services/comprehend/document_classifiers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: document_classifiers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - document_classifiers_list_only + - comprehend + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists document_classifiers in a region or regions, for all properties use document_classifiers + +## Overview + + + + + + + +
Namedocument_classifiers_list_only
TypeResource
DescriptionDocument Classifier enables training document classifier models.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all document_classifiers in a region. +```sql +SELECT +region, +arn +FROM aws.comprehend.document_classifiers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the document_classifiers_list_only resource, see document_classifiers + diff --git a/website/docs/services/comprehend/flywheel_tags/index.md b/website/docs/services/comprehend/flywheel_tags/index.md new file mode 100644 index 0000000..f5c0d24 --- /dev/null +++ b/website/docs/services/comprehend/flywheel_tags/index.md @@ -0,0 +1,91 @@ +--- +title: flywheel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - flywheel_tags + - comprehend + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for flywheels in a region + +## Overview + + + + + + + +
Nameflywheel_tags
TypeResource
DescriptionThe AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all flywheels in a region. +```sql +SELECT +region, +active_model_arn, +data_access_role_arn, +data_lake_s3_uri, +data_security_config, +flywheel_name, +model_type, +task_config, +arn, +tag_key, +tag_value +FROM aws.comprehend.flywheel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flywheel_tags resource, see flywheels + diff --git a/website/docs/services/comprehend/flywheels/index.md b/website/docs/services/comprehend/flywheels/index.md new file mode 100644 index 0000000..dfb52bf --- /dev/null +++ b/website/docs/services/comprehend/flywheels/index.md @@ -0,0 +1,278 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flywheel resource or lists flywheels in a region + +## Overview + + + + + + + +
Nameflywheels
TypeResource
DescriptionThe AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
string
array
object
string
stringAWS region.
+ +For more information, see AWS::Comprehend::Flywheel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flywheels in a region. +```sql +SELECT +region, +active_model_arn, +data_access_role_arn, +data_lake_s3_uri, +data_security_config, +flywheel_name, +model_type, +tags, +task_config, +arn +FROM aws.comprehend.flywheels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flywheel. +```sql +SELECT +region, +active_model_arn, +data_access_role_arn, +data_lake_s3_uri, +data_security_config, +flywheel_name, +model_type, +tags, +task_config, +arn +FROM aws.comprehend.flywheels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flywheel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.comprehend.flywheels ( + DataAccessRoleArn, + DataLakeS3Uri, + FlywheelName, + region +) +SELECT +'{{ DataAccessRoleArn }}', + '{{ DataLakeS3Uri }}', + '{{ FlywheelName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.comprehend.flywheels ( + ActiveModelArn, + DataAccessRoleArn, + DataLakeS3Uri, + DataSecurityConfig, + FlywheelName, + ModelType, + Tags, + TaskConfig, + region +) +SELECT + '{{ ActiveModelArn }}', + '{{ DataAccessRoleArn }}', + '{{ DataLakeS3Uri }}', + '{{ DataSecurityConfig }}', + '{{ FlywheelName }}', + '{{ ModelType }}', + '{{ Tags }}', + '{{ TaskConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flywheel + props: + - name: ActiveModelArn + value: '{{ ActiveModelArn }}' + - name: DataAccessRoleArn + value: '{{ DataAccessRoleArn }}' + - name: DataLakeS3Uri + value: '{{ DataLakeS3Uri }}' + - name: DataSecurityConfig + value: + ModelKmsKeyId: '{{ ModelKmsKeyId }}' + VolumeKmsKeyId: null + DataLakeKmsKeyId: null + VpcConfig: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + Subnets: + - '{{ Subnets[0] }}' + - name: FlywheelName + value: '{{ FlywheelName }}' + - name: ModelType + value: '{{ ModelType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TaskConfig + value: + LanguageCode: '{{ LanguageCode }}' + DocumentClassificationConfig: + Mode: '{{ Mode }}' + Labels: + - '{{ Labels[0] }}' + EntityRecognitionConfig: + EntityTypes: + - Type: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.comprehend.flywheels +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +comprehend:ListFlywheels +``` diff --git a/website/docs/services/comprehend/flywheels_list_only/index.md b/website/docs/services/comprehend/flywheels_list_only/index.md new file mode 100644 index 0000000..a3d74ab --- /dev/null +++ b/website/docs/services/comprehend/flywheels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: flywheels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flywheels_list_only + - comprehend + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flywheels in a region or regions, for all properties use flywheels + +## Overview + + + + + + + +
Nameflywheels_list_only
TypeResource
DescriptionThe AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flywheels in a region. +```sql +SELECT +region, +arn +FROM aws.comprehend.flywheels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flywheels_list_only resource, see flywheels + diff --git a/website/docs/services/comprehend/index.md b/website/docs/services/comprehend/index.md new file mode 100644 index 0000000..584c688 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The comprehend service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/config/aggregation_authorization_tags/index.md b/website/docs/services/config/aggregation_authorization_tags/index.md new file mode 100644 index 0000000..3c8914e --- /dev/null +++ b/website/docs/services/config/aggregation_authorization_tags/index.md @@ -0,0 +1,81 @@ +--- +title: aggregation_authorization_tags +hide_title: false +hide_table_of_contents: false +keywords: + - aggregation_authorization_tags + - config + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for aggregation_authorizations in a region + +## Overview + + + + + + + +
Nameaggregation_authorization_tags
TypeResource
DescriptionResource Type definition for AWS::Config::AggregationAuthorization
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe 12-digit account ID of the account authorized to aggregate data.
stringThe region authorized to collect aggregated data.
stringThe ARN of the AggregationAuthorization.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all aggregation_authorizations in a region. +```sql +SELECT +region, +authorized_account_id, +authorized_aws_region, +aggregation_authorization_arn, +tag_key, +tag_value +FROM aws.config.aggregation_authorization_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the aggregation_authorization_tags resource, see aggregation_authorizations + diff --git a/website/docs/services/config/aggregation_authorizations/index.md b/website/docs/services/config/aggregation_authorizations/index.md new file mode 100644 index 0000000..ec972a5 --- /dev/null +++ b/website/docs/services/config/aggregation_authorizations/index.md @@ -0,0 +1,223 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an aggregation_authorization resource or lists aggregation_authorizations in a region + +## Overview + + + + + + + +
Nameaggregation_authorizations
TypeResource
DescriptionResource Type definition for AWS::Config::AggregationAuthorization
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe 12-digit account ID of the account authorized to aggregate data.
stringThe region authorized to collect aggregated data.
stringThe ARN of the AggregationAuthorization.
arrayThe tags for the AggregationAuthorization.
stringAWS region.
+ +For more information, see AWS::Config::AggregationAuthorization. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all aggregation_authorizations in a region. +```sql +SELECT +region, +authorized_account_id, +authorized_aws_region, +aggregation_authorization_arn, +tags +FROM aws.config.aggregation_authorizations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual aggregation_authorization. +```sql +SELECT +region, +authorized_account_id, +authorized_aws_region, +aggregation_authorization_arn, +tags +FROM aws.config.aggregation_authorizations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new aggregation_authorization resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.config.aggregation_authorizations ( + AuthorizedAccountId, + AuthorizedAwsRegion, + region +) +SELECT +'{{ AuthorizedAccountId }}', + '{{ AuthorizedAwsRegion }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.config.aggregation_authorizations ( + AuthorizedAccountId, + AuthorizedAwsRegion, + Tags, + region +) +SELECT + '{{ AuthorizedAccountId }}', + '{{ AuthorizedAwsRegion }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: aggregation_authorization + props: + - name: AuthorizedAccountId + value: '{{ AuthorizedAccountId }}' + - name: AuthorizedAwsRegion + value: '{{ AuthorizedAwsRegion }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.config.aggregation_authorizations +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +config:DescribeAggregationAuthorizations, +config:TagResource, +config:UntagResource, +config:ListTagsForResource +``` + +### Read +```json +config:DescribeAggregationAuthorizations, +config:ListTagsForResource +``` + +### Delete +```json +config:DescribeAggregationAuthorizations, +config:DeleteAggregationAuthorization, +config:UntagResource +``` + +### List +```json +config:DescribeAggregationAuthorizations +``` diff --git a/website/docs/services/config/aggregation_authorizations_list_only/index.md b/website/docs/services/config/aggregation_authorizations_list_only/index.md new file mode 100644 index 0000000..02f4723 --- /dev/null +++ b/website/docs/services/config/aggregation_authorizations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: aggregation_authorizations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - aggregation_authorizations_list_only + - config + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists aggregation_authorizations in a region or regions, for all properties use aggregation_authorizations + +## Overview + + + + + + + +
Nameaggregation_authorizations_list_only
TypeResource
DescriptionResource Type definition for AWS::Config::AggregationAuthorization
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe 12-digit account ID of the account authorized to aggregate data.
stringThe region authorized to collect aggregated data.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all aggregation_authorizations in a region. +```sql +SELECT +region, +authorized_account_id, +authorized_aws_region +FROM aws.config.aggregation_authorizations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the aggregation_authorizations_list_only resource, see aggregation_authorizations + diff --git a/website/docs/services/config/config_rules/index.md b/website/docs/services/config/config_rules/index.md new file mode 100644 index 0000000..6036dc1 --- /dev/null +++ b/website/docs/services/config/config_rules/index.md @@ -0,0 +1,270 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a config_rule resource or lists 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).
Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*.
There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ConfigRule resource to create both CC Managed Rules and CC Custom Rules.
CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the SourceIdentifier key.
CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*.
If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ConfigRule resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.
For any new CC rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by CC for new rules.
If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.
For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe description that you provide for the CC rule.
objectDefines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
The scope can be empty.
stringA name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
string
objectIndicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance.
stringThe maximum frequency with which CC runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
+ You are using an AWS managed rule that is triggered at a periodic frequency.
+ Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html).

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
objectProvides the rule owner ( for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.
objectA string, in JSON format, that is passed to the CC rule Lambda function.
arrayThe modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
stringAWS region.
+ +For more information, see AWS::Config::ConfigRule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all config_rules in a region. +```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_rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual config_rule. +```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_rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new config_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.config.config_rules ( + Source, + region +) +SELECT +'{{ Source }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.config.config_rules ( + Description, + Scope, + ConfigRuleName, + Compliance, + MaximumExecutionFrequency, + Source, + InputParameters, + EvaluationModes, + region +) +SELECT + '{{ Description }}', + '{{ Scope }}', + '{{ ConfigRuleName }}', + '{{ Compliance }}', + '{{ MaximumExecutionFrequency }}', + '{{ Source }}', + '{{ InputParameters }}', + '{{ EvaluationModes }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: config_rule + props: + - name: Description + value: '{{ Description }}' + - name: Scope + value: + TagKey: '{{ TagKey }}' + ComplianceResourceTypes: + - '{{ ComplianceResourceTypes[0] }}' + TagValue: '{{ TagValue }}' + ComplianceResourceId: '{{ ComplianceResourceId }}' + - name: ConfigRuleName + value: '{{ ConfigRuleName }}' + - name: Compliance + value: + Type: '{{ Type }}' + - name: MaximumExecutionFrequency + value: '{{ MaximumExecutionFrequency }}' + - name: Source + value: + CustomPolicyDetails: + EnableDebugLogDelivery: '{{ EnableDebugLogDelivery }}' + PolicyText: '{{ PolicyText }}' + PolicyRuntime: '{{ PolicyRuntime }}' + SourceIdentifier: '{{ SourceIdentifier }}' + Owner: '{{ Owner }}' + SourceDetails: + - EventSource: '{{ EventSource }}' + MaximumExecutionFrequency: '{{ MaximumExecutionFrequency }}' + MessageType: '{{ MessageType }}' + - name: InputParameters + value: {} + - name: EvaluationModes + value: + - Mode: '{{ Mode }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.config.config_rules +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the config_rules resource, the following permissions are required: + +### Create +```json +config:PutConfigRule, +config:DescribeConfigRules +``` + +### Read +```json +config:DescribeConfigRules, +config:DescribeComplianceByConfigRule +``` + +### Delete +```json +config:DeleteConfigRule, +config:DescribeConfigRules +``` + +### List +```json +config:DescribeConfigRules +``` + +### Update +```json +config:PutConfigRule, +config:DescribeConfigRules +``` diff --git a/website/docs/services/config/config_rules_list_only/index.md b/website/docs/services/config/config_rules_list_only/index.md new file mode 100644 index 0000000..1002488 --- /dev/null +++ b/website/docs/services/config/config_rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: config_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - config_rules_list_only + - config + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists config_rules in a region or regions, for all properties use config_rules + +## Overview + + + + + + + +
Nameconfig_rules_list_only
TypeResource
DescriptionYou must first create and start the CC configuration recorder in order to create CC managed rules with CFNlong. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html).
Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*.
There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ConfigRule resource to create both CC Managed Rules and CC Custom Rules.
CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the SourceIdentifier key.
CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*.
If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ConfigRule resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.
For any new CC rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by CC for new rules.
If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.
For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all config_rules in a region. +```sql +SELECT +region, +config_rule_name +FROM aws.config.config_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the config_rules_list_only resource, see config_rules + diff --git a/website/docs/services/config/configuration_aggregator_tags/index.md b/website/docs/services/config/configuration_aggregator_tags/index.md new file mode 100644 index 0000000..1e5067c --- /dev/null +++ b/website/docs/services/config/configuration_aggregator_tags/index.md @@ -0,0 +1,83 @@ +--- +title: configuration_aggregator_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_aggregator_tags + - config + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configuration_aggregators in a region + +## Overview + + + + + + + +
Nameconfiguration_aggregator_tags
TypeResource
DescriptionResource Type definition for AWS::Config::ConfigurationAggregator
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
array
stringThe name of the aggregator.
stringThe Amazon Resource Name (ARN) of the aggregator.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configuration_aggregators in a region. +```sql +SELECT +region, +account_aggregation_sources, +configuration_aggregator_name, +configuration_aggregator_arn, +organization_aggregation_source, +tag_key, +tag_value +FROM aws.config.configuration_aggregator_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_aggregator_tags resource, see configuration_aggregators + diff --git a/website/docs/services/config/configuration_aggregators/index.md b/website/docs/services/config/configuration_aggregators/index.md new file mode 100644 index 0000000..6e76fb8 --- /dev/null +++ b/website/docs/services/config/configuration_aggregators/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configuration_aggregator resource or lists configuration_aggregators in a region + +## Overview + + + + + + + +
Nameconfiguration_aggregators
TypeResource
DescriptionResource Type definition for AWS::Config::ConfigurationAggregator
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
array
stringThe name of the aggregator.
stringThe Amazon Resource Name (ARN) of the aggregator.
object
arrayThe tags for the configuration aggregator.
stringAWS region.
+ +For more information, see AWS::Config::ConfigurationAggregator. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configuration_aggregators in a region. +```sql +SELECT +region, +account_aggregation_sources, +configuration_aggregator_name, +configuration_aggregator_arn, +organization_aggregation_source, +tags +FROM aws.config.configuration_aggregators +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual configuration_aggregator. +```sql +SELECT +region, +account_aggregation_sources, +configuration_aggregator_name, +configuration_aggregator_arn, +organization_aggregation_source, +tags +FROM aws.config.configuration_aggregators +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configuration_aggregator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.config.configuration_aggregators ( + AccountAggregationSources, + ConfigurationAggregatorName, + OrganizationAggregationSource, + Tags, + region +) +SELECT +'{{ AccountAggregationSources }}', + '{{ ConfigurationAggregatorName }}', + '{{ OrganizationAggregationSource }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.config.configuration_aggregators ( + AccountAggregationSources, + ConfigurationAggregatorName, + OrganizationAggregationSource, + Tags, + region +) +SELECT + '{{ AccountAggregationSources }}', + '{{ ConfigurationAggregatorName }}', + '{{ OrganizationAggregationSource }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configuration_aggregator + props: + - name: AccountAggregationSources + value: + - AllAwsRegions: '{{ AllAwsRegions }}' + AwsRegions: + - '{{ AwsRegions[0] }}' + AccountIds: + - '{{ AccountIds[0] }}' + - name: ConfigurationAggregatorName + value: '{{ ConfigurationAggregatorName }}' + - name: OrganizationAggregationSource + value: + AllAwsRegions: '{{ AllAwsRegions }}' + AwsRegions: + - '{{ AwsRegions[0] }}' + RoleArn: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.config.configuration_aggregators +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +config:DescribeConfigurationAggregators +``` diff --git a/website/docs/services/config/configuration_aggregators_list_only/index.md b/website/docs/services/config/configuration_aggregators_list_only/index.md new file mode 100644 index 0000000..07e5ed1 --- /dev/null +++ b/website/docs/services/config/configuration_aggregators_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: configuration_aggregators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_aggregators_list_only + - config + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_aggregators in a region or regions, for all properties use configuration_aggregators + +## Overview + + + + + + + +
Nameconfiguration_aggregators_list_only
TypeResource
DescriptionResource Type definition for AWS::Config::ConfigurationAggregator
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the aggregator.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_aggregators in a region. +```sql +SELECT +region, +configuration_aggregator_name +FROM aws.config.configuration_aggregators_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_aggregators_list_only resource, see configuration_aggregators + diff --git a/website/docs/services/config/conformance_packs/index.md b/website/docs/services/config/conformance_packs/index.md new file mode 100644 index 0000000..4c929dc --- /dev/null +++ b/website/docs/services/config/conformance_packs/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a conformance_pack resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of the conformance pack which will be assigned as the unique identifier.
stringAWS Config stores intermediate files while processing conformance pack template.
stringThe prefix for delivery S3 bucket.
stringA string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.
stringLocation of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.
objectThe TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.
arrayA list of ConformancePackInputParameter objects.
stringAWS region.
+ +For more information, see AWS::Config::ConformancePack. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all conformance_packs in a region. +```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_packs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual conformance_pack. +```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_packs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new conformance_pack resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.config.conformance_packs ( + ConformancePackName, + region +) +SELECT +'{{ ConformancePackName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.config.conformance_packs ( + ConformancePackName, + DeliveryS3Bucket, + DeliveryS3KeyPrefix, + TemplateBody, + TemplateS3Uri, + TemplateSSMDocumentDetails, + ConformancePackInputParameters, + region +) +SELECT + '{{ ConformancePackName }}', + '{{ DeliveryS3Bucket }}', + '{{ DeliveryS3KeyPrefix }}', + '{{ TemplateBody }}', + '{{ TemplateS3Uri }}', + '{{ TemplateSSMDocumentDetails }}', + '{{ ConformancePackInputParameters }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: conformance_pack + props: + - name: ConformancePackName + value: '{{ ConformancePackName }}' + - name: DeliveryS3Bucket + value: '{{ DeliveryS3Bucket }}' + - name: DeliveryS3KeyPrefix + value: '{{ DeliveryS3KeyPrefix }}' + - name: TemplateBody + value: '{{ TemplateBody }}' + - name: TemplateS3Uri + value: '{{ TemplateS3Uri }}' + - name: TemplateSSMDocumentDetails + value: + DocumentName: '{{ DocumentName }}' + DocumentVersion: '{{ DocumentVersion }}' + - name: ConformancePackInputParameters + value: + - ParameterName: '{{ ParameterName }}' + ParameterValue: '{{ ParameterValue }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.config.conformance_packs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +config:DescribeConformancePacks +``` + +### Update +```json +config:PutConformancePack, +config:DescribeConformancePackStatus, +s3:GetObject, +s3:GetBucketAcl, +iam:CreateServiceLinkedRole, +iam:PassRole +``` + +### Delete +```json +config:DeleteConformancePack, +config:DescribeConformancePackStatus +``` + +### List +```json +config:DescribeConformancePacks +``` diff --git a/website/docs/services/config/conformance_packs_list_only/index.md b/website/docs/services/config/conformance_packs_list_only/index.md new file mode 100644 index 0000000..b0f6ff2 --- /dev/null +++ b/website/docs/services/config/conformance_packs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: conformance_packs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - conformance_packs_list_only + - config + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists conformance_packs in a region or regions, for all properties use conformance_packs + +## Overview + + + + + + + +
Nameconformance_packs_list_only
TypeResource
DescriptionA conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a region or across an entire AWS Organization.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the conformance pack which will be assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all conformance_packs in a region. +```sql +SELECT +region, +conformance_pack_name +FROM aws.config.conformance_packs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the conformance_packs_list_only resource, see conformance_packs + diff --git a/website/docs/services/config/index.md b/website/docs/services/config/index.md new file mode 100644 index 0000000..663c70c --- /dev/null +++ b/website/docs/services/config/index.md @@ -0,0 +1,50 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The config service documentation. + +:::info Service Summary + +
+
+total resources: 15
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/config/organization_conformance_packs/index.md b/website/docs/services/config/organization_conformance_packs/index.md new file mode 100644 index 0000000..d813105 --- /dev/null +++ b/website/docs/services/config/organization_conformance_packs/index.md @@ -0,0 +1,259 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an organization_conformance_pack resource or lists organization_conformance_packs in a region + +## Overview + + + + + + + +
Nameorganization_conformance_packs
TypeResource
DescriptionResource schema for AWS::Config::OrganizationConformancePack.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the organization conformance pack.
stringLocation of file containing the template body.
stringA string containing full conformance pack template body.
stringAWS Config stores intermediate files while processing conformance pack template.
stringThe prefix for the delivery S3 bucket.
arrayA list of ConformancePackInputParameter objects.
arrayA list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.
stringAWS region.
+ +For more information, see AWS::Config::OrganizationConformancePack. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all organization_conformance_packs in a region. +```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_packs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual organization_conformance_pack. +```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_packs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new organization_conformance_pack resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.config.organization_conformance_packs ( + OrganizationConformancePackName, + region +) +SELECT +'{{ OrganizationConformancePackName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.config.organization_conformance_packs ( + OrganizationConformancePackName, + TemplateS3Uri, + TemplateBody, + DeliveryS3Bucket, + DeliveryS3KeyPrefix, + ConformancePackInputParameters, + ExcludedAccounts, + region +) +SELECT + '{{ OrganizationConformancePackName }}', + '{{ TemplateS3Uri }}', + '{{ TemplateBody }}', + '{{ DeliveryS3Bucket }}', + '{{ DeliveryS3KeyPrefix }}', + '{{ ConformancePackInputParameters }}', + '{{ ExcludedAccounts }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: organization_conformance_pack + props: + - name: OrganizationConformancePackName + value: '{{ OrganizationConformancePackName }}' + - name: TemplateS3Uri + value: '{{ TemplateS3Uri }}' + - name: TemplateBody + value: '{{ TemplateBody }}' + - name: DeliveryS3Bucket + value: '{{ DeliveryS3Bucket }}' + - name: DeliveryS3KeyPrefix + value: '{{ DeliveryS3KeyPrefix }}' + - name: ConformancePackInputParameters + value: + - ParameterName: '{{ ParameterName }}' + ParameterValue: '{{ ParameterValue }}' + - name: ExcludedAccounts + value: + - '{{ ExcludedAccounts[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.config.organization_conformance_packs +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +config:DescribeOrganizationConformancePacks +``` diff --git a/website/docs/services/config/organization_conformance_packs_list_only/index.md b/website/docs/services/config/organization_conformance_packs_list_only/index.md new file mode 100644 index 0000000..18f7964 --- /dev/null +++ b/website/docs/services/config/organization_conformance_packs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: organization_conformance_packs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - organization_conformance_packs_list_only + - config + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists organization_conformance_packs in a region or regions, for all properties use organization_conformance_packs + +## Overview + + + + + + + +
Nameorganization_conformance_packs_list_only
TypeResource
DescriptionResource schema for AWS::Config::OrganizationConformancePack.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the organization conformance pack.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all organization_conformance_packs in a region. +```sql +SELECT +region, +organization_conformance_pack_name +FROM aws.config.organization_conformance_packs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organization_conformance_packs_list_only resource, see organization_conformance_packs + diff --git a/website/docs/services/config/stored_queries/index.md b/website/docs/services/config/stored_queries/index.md new file mode 100644 index 0000000..9705f3b --- /dev/null +++ b/website/docs/services/config/stored_queries/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a stored_query resource or lists stored_queries in a region + +## Overview + + + + + + + +
Namestored_queries
TypeResource
DescriptionResource Type definition for AWS::Config::StoredQuery
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
arrayThe tags for the stored query.
stringAWS region.
+ +For more information, see AWS::Config::StoredQuery. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all stored_queries in a region. +```sql +SELECT +region, +query_arn, +query_id, +query_name, +query_description, +query_expression, +tags +FROM aws.config.stored_queries +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual stored_query. +```sql +SELECT +region, +query_arn, +query_id, +query_name, +query_description, +query_expression, +tags +FROM aws.config.stored_queries +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stored_query resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.config.stored_queries ( + QueryName, + QueryExpression, + region +) +SELECT +'{{ QueryName }}', + '{{ QueryExpression }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.config.stored_queries ( + QueryName, + QueryDescription, + QueryExpression, + Tags, + region +) +SELECT + '{{ QueryName }}', + '{{ QueryDescription }}', + '{{ QueryExpression }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: stored_query + props: + - name: QueryName + value: '{{ QueryName }}' + - name: QueryDescription + value: '{{ QueryDescription }}' + - name: QueryExpression + value: '{{ QueryExpression }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.config.stored_queries +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +config:GetStoredQuery, +config:ListTagsForResource +``` + +### Update +```json +config:PutStoredQuery, +config:GetStoredQuery, +config:TagResource, +config:UntagResource, +config:ListTagsForResource +``` + +### Delete +```json +config:DeleteStoredQuery, +config:UntagResource +``` + +### List +```json +config:ListStoredQueries +``` diff --git a/website/docs/services/config/stored_queries_list_only/index.md b/website/docs/services/config/stored_queries_list_only/index.md new file mode 100644 index 0000000..3007867 --- /dev/null +++ b/website/docs/services/config/stored_queries_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: stored_queries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stored_queries_list_only + - config + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stored_queries in a region or regions, for all properties use stored_queries + +## Overview + + + + + + + +
Namestored_queries_list_only
TypeResource
DescriptionResource Type definition for AWS::Config::StoredQuery
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stored_queries in a region. +```sql +SELECT +region, +query_name +FROM aws.config.stored_queries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stored_queries_list_only resource, see stored_queries + diff --git a/website/docs/services/config/stored_query_tags/index.md b/website/docs/services/config/stored_query_tags/index.md new file mode 100644 index 0000000..fe37431 --- /dev/null +++ b/website/docs/services/config/stored_query_tags/index.md @@ -0,0 +1,85 @@ +--- +title: stored_query_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stored_query_tags + - config + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stored_queries in a region + +## Overview + + + + + + + +
Namestored_query_tags
TypeResource
DescriptionResource Type definition for AWS::Config::StoredQuery
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stored_queries in a region. +```sql +SELECT +region, +query_arn, +query_id, +query_name, +query_description, +query_expression, +tag_key, +tag_value +FROM aws.config.stored_query_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stored_query_tags resource, see stored_queries + diff --git a/website/docs/services/connect/agent_status_tags/index.md b/website/docs/services/connect/agent_status_tags/index.md new file mode 100644 index 0000000..1a2044a --- /dev/null +++ b/website/docs/services/connect/agent_status_tags/index.md @@ -0,0 +1,95 @@ +--- +title: agent_status_tags +hide_title: false +hide_table_of_contents: false +keywords: + - agent_status_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for agent_statuses in a region + +## Overview + + + + + + + +
Nameagent_status_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::AgentStatus
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe Amazon Resource Name (ARN) of the agent status.
stringThe description of the status.
stringThe name of the status.
integerThe display order of the status.
stringThe state of the status.
stringThe type of agent status.
booleanA number indicating the reset order of the agent status.
stringLast modified region.
numberLast modified time.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all agent_statuses in a region. +```sql +SELECT +region, +instance_arn, +agent_status_arn, +description, +name, +display_order, +state, +type, +reset_order_number, +last_modified_region, +last_modified_time, +tag_key, +tag_value +FROM aws.connect.agent_status_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agent_status_tags resource, see agent_statuses + diff --git a/website/docs/services/connect/agent_statuses/index.md b/website/docs/services/connect/agent_statuses/index.md new file mode 100644 index 0000000..66f6f07 --- /dev/null +++ b/website/docs/services/connect/agent_statuses/index.md @@ -0,0 +1,243 @@ +--- +title: agent_statuses +hide_title: false +hide_table_of_contents: false +keywords: + - agent_statuses + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an agent_status resource or lists agent_statuses in a region + +## Overview + + + + + + + +
Nameagent_statuses
TypeResource
DescriptionResource Type definition for AWS::Connect::AgentStatus
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe Amazon Resource Name (ARN) of the agent status.
stringThe description of the status.
stringThe name of the status.
integerThe display order of the status.
stringThe state of the status.
stringThe type of agent status.
booleanA number indicating the reset order of the agent status.
arrayAn array of key-value pairs to apply to this resource.
stringLast modified region.
numberLast modified time.
stringAWS region.
+ +For more information, see AWS::Connect::AgentStatus. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all agent_statuses in a region. +```sql +SELECT +region, +instance_arn, +agent_status_arn, +description, +name, +display_order, +state, +type, +reset_order_number, +tags, +last_modified_region, +last_modified_time +FROM aws.connect.agent_statuses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual agent_status. +```sql +SELECT +region, +instance_arn, +agent_status_arn, +description, +name, +display_order, +state, +type, +reset_order_number, +tags, +last_modified_region, +last_modified_time +FROM aws.connect.agent_statuses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new agent_status resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.agent_statuses ( + InstanceArn, + Name, + State, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', + '{{ State }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.agent_statuses ( + InstanceArn, + Description, + Name, + DisplayOrder, + State, + Type, + ResetOrderNumber, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Description }}', + '{{ Name }}', + '{{ DisplayOrder }}', + '{{ State }}', + '{{ Type }}', + '{{ ResetOrderNumber }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: agent_status + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: DisplayOrder + value: '{{ DisplayOrder }}' + - name: State + value: '{{ State }}' + - name: Type + value: '{{ Type }}' + - name: ResetOrderNumber + value: '{{ ResetOrderNumber }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## Permissions + +To operate on the agent_statuses resource, the following permissions are required: + +### Create +```json +connect:CreateAgentStatus, +connect:TagResource, +connect:ListAgentStatuses +``` + +### Read +```json +connect:DescribeAgentStatus +``` + +### Update +```json +connect:UpdateAgentStatus, +connect:UntagResource, +connect:TagResource +``` + +### List +```json +connect:ListAgentStatuses +``` diff --git a/website/docs/services/connect/agent_statuses_list_only/index.md b/website/docs/services/connect/agent_statuses_list_only/index.md new file mode 100644 index 0000000..1c62be7 --- /dev/null +++ b/website/docs/services/connect/agent_statuses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: agent_statuses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - agent_statuses_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists agent_statuses in a region or regions, for all properties use agent_statuses + +## Overview + + + + + + + +
Nameagent_statuses_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::AgentStatus
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the agent status.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all agent_statuses in a region. +```sql +SELECT +region, +agent_status_arn +FROM aws.connect.agent_statuses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agent_statuses_list_only resource, see agent_statuses + diff --git a/website/docs/services/connect/approved_origins/index.md b/website/docs/services/connect/approved_origins/index.md new file mode 100644 index 0000000..b1aaa28 --- /dev/null +++ b/website/docs/services/connect/approved_origins/index.md @@ -0,0 +1,195 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an approved_origin resource or lists approved_origins in a region + +## Overview + + + + + + + +
Nameapproved_origins
TypeResource
DescriptionResource Type definition for AWS::Connect::ApprovedOrigin
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringDomain name to be added to the allowlist of instance
stringAmazon Connect instance identifier
stringAWS region.
+ +For more information, see AWS::Connect::ApprovedOrigin. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all approved_origins in a region. +```sql +SELECT +region, +origin, +instance_id +FROM aws.connect.approved_origins +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual approved_origin. +```sql +SELECT +region, +origin, +instance_id +FROM aws.connect.approved_origins +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new approved_origin resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.approved_origins ( + Origin, + InstanceId, + region +) +SELECT +'{{ Origin }}', + '{{ InstanceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.approved_origins ( + Origin, + InstanceId, + region +) +SELECT + '{{ Origin }}', + '{{ InstanceId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: approved_origin + props: + - name: Origin + value: '{{ Origin }}' + - name: InstanceId + value: '{{ InstanceId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.approved_origins +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the approved_origins resource, the following permissions are required: + +### Create +```json +connect:AssociateApprovedOrigin, +connect:ListApprovedOrigins +``` + +### Read +```json +connect:ListApprovedOrigins +``` + +### Delete +```json +connect:DisassociateApprovedOrigin, +connect:ListApprovedOrigins +``` + +### List +```json +connect:ListApprovedOrigins +``` diff --git a/website/docs/services/connect/approved_origins_list_only/index.md b/website/docs/services/connect/approved_origins_list_only/index.md new file mode 100644 index 0000000..567c99d --- /dev/null +++ b/website/docs/services/connect/approved_origins_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: approved_origins_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - approved_origins_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists approved_origins in a region or regions, for all properties use approved_origins + +## Overview + + + + + + + +
Nameapproved_origins_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::ApprovedOrigin
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringDomain name to be added to the allowlist of instance
stringAmazon Connect instance identifier
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all approved_origins in a region. +```sql +SELECT +region, +instance_id, +origin +FROM aws.connect.approved_origins_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the approved_origins_list_only resource, see approved_origins + diff --git a/website/docs/services/connect/contact_flow_module_tags/index.md b/website/docs/services/connect/contact_flow_module_tags/index.md new file mode 100644 index 0000000..ab0091c --- /dev/null +++ b/website/docs/services/connect/contact_flow_module_tags/index.md @@ -0,0 +1,89 @@ +--- +title: contact_flow_module_tags +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flow_module_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for contact_flow_modules in a region + +## Overview + + + + + + + +
Namecontact_flow_module_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::ContactFlowModule.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance (ARN).
stringThe identifier of the contact flow module (ARN).
stringThe name of the contact flow module.
stringThe content of the contact flow module in JSON format.
stringThe description of the contact flow module.
stringThe state of the contact flow module.
stringThe status of the contact flow module.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all contact_flow_modules in a region. +```sql +SELECT +region, +instance_arn, +contact_flow_module_arn, +name, +content, +description, +state, +status, +tag_key, +tag_value +FROM aws.connect.contact_flow_module_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_flow_module_tags resource, see contact_flow_modules + diff --git a/website/docs/services/connect/contact_flow_modules/index.md b/website/docs/services/connect/contact_flow_modules/index.md new file mode 100644 index 0000000..e86c129 --- /dev/null +++ b/website/docs/services/connect/contact_flow_modules/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a contact_flow_module resource or lists contact_flow_modules in a region + +## Overview + + + + + + + +
Namecontact_flow_modules
TypeResource
DescriptionResource Type definition for AWS::Connect::ContactFlowModule.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance (ARN).
stringThe identifier of the contact flow module (ARN).
stringThe name of the contact flow module.
stringThe content of the contact flow module in JSON format.
stringThe description of the contact flow module.
stringThe state of the contact flow module.
stringThe status of the contact flow module.
arrayOne or more tags.
stringAWS region.
+ +For more information, see AWS::Connect::ContactFlowModule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all contact_flow_modules in a region. +```sql +SELECT +region, +instance_arn, +contact_flow_module_arn, +name, +content, +description, +state, +status, +tags +FROM aws.connect.contact_flow_modules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual contact_flow_module. +```sql +SELECT +region, +instance_arn, +contact_flow_module_arn, +name, +content, +description, +state, +status, +tags +FROM aws.connect.contact_flow_modules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new contact_flow_module resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.contact_flow_modules ( + InstanceArn, + Name, + Content, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', + '{{ Content }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.contact_flow_modules ( + InstanceArn, + Name, + Content, + Description, + State, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Name }}', + '{{ Content }}', + '{{ Description }}', + '{{ State }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: contact_flow_module + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Name + value: '{{ Name }}' + - name: Content + value: '{{ Content }}' + - name: Description + value: '{{ Description }}' + - name: State + value: '{{ State }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.contact_flow_modules +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the contact_flow_modules resource, the following permissions are required: + +### Create +```json +connect:CreateContactFlowModule, +connect:TagResource +``` + +### Read +```json +connect:DescribeContactFlowModule +``` + +### Delete +```json +connect:DeleteContactFlowModule, +connect:UntagResource +``` + +### Update +```json +connect:UpdateContactFlowModuleMetadata, +connect:UpdateContactFlowModuleContent, +connect:TagResource, +connect:UntagResource +``` + +### List +```json +connect:ListContactFlowModules +``` diff --git a/website/docs/services/connect/contact_flow_modules_list_only/index.md b/website/docs/services/connect/contact_flow_modules_list_only/index.md new file mode 100644 index 0000000..aeb0ad9 --- /dev/null +++ b/website/docs/services/connect/contact_flow_modules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: contact_flow_modules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flow_modules_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists contact_flow_modules in a region or regions, for all properties use contact_flow_modules + +## Overview + + + + + + + +
Namecontact_flow_modules_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::ContactFlowModule.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier of the contact flow module (ARN).
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all contact_flow_modules in a region. +```sql +SELECT +region, +contact_flow_module_arn +FROM aws.connect.contact_flow_modules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_flow_modules_list_only resource, see contact_flow_modules + diff --git a/website/docs/services/connect/contact_flow_tags/index.md b/website/docs/services/connect/contact_flow_tags/index.md new file mode 100644 index 0000000..111931d --- /dev/null +++ b/website/docs/services/connect/contact_flow_tags/index.md @@ -0,0 +1,89 @@ +--- +title: contact_flow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flow_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for contact_flows in a region + +## Overview + + + + + + + +
Namecontact_flow_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::ContactFlow
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance (ARN).
stringThe identifier of the contact flow (ARN).
stringThe name of the contact flow.
stringThe content of the contact flow in JSON format.
stringThe description of the contact flow.
stringThe state of the contact flow.
stringThe type of the contact flow.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all contact_flows in a region. +```sql +SELECT +region, +instance_arn, +contact_flow_arn, +name, +content, +description, +state, +type, +tag_key, +tag_value +FROM aws.connect.contact_flow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_flow_tags resource, see contact_flows + diff --git a/website/docs/services/connect/contact_flows/index.md b/website/docs/services/connect/contact_flows/index.md new file mode 100644 index 0000000..dff5dac --- /dev/null +++ b/website/docs/services/connect/contact_flows/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a contact_flow resource or lists contact_flows in a region + +## Overview + + + + + + + +
Namecontact_flows
TypeResource
DescriptionResource Type definition for AWS::Connect::ContactFlow
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance (ARN).
stringThe identifier of the contact flow (ARN).
stringThe name of the contact flow.
stringThe content of the contact flow in JSON format.
stringThe description of the contact flow.
stringThe state of the contact flow.
stringThe type of the contact flow.
arrayOne or more tags.
stringAWS region.
+ +For more information, see AWS::Connect::ContactFlow. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all contact_flows in a region. +```sql +SELECT +region, +instance_arn, +contact_flow_arn, +name, +content, +description, +state, +type, +tags +FROM aws.connect.contact_flows +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual contact_flow. +```sql +SELECT +region, +instance_arn, +contact_flow_arn, +name, +content, +description, +state, +type, +tags +FROM aws.connect.contact_flows +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new contact_flow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.contact_flows ( + InstanceArn, + Name, + Content, + Type, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', + '{{ Content }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.contact_flows ( + InstanceArn, + Name, + Content, + Description, + State, + Type, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Name }}', + '{{ Content }}', + '{{ Description }}', + '{{ State }}', + '{{ Type }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: contact_flow + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Name + value: '{{ Name }}' + - name: Content + value: '{{ Content }}' + - name: Description + value: '{{ Description }}' + - name: State + value: '{{ State }}' + - name: Type + value: '{{ Type }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.contact_flows +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the contact_flows resource, the following permissions are required: + +### Create +```json +connect:CreateContactFlow, +connect:TagResource +``` + +### Read +```json +connect:DescribeContactFlow +``` + +### Delete +```json +connect:DeleteContactFlow, +connect:UntagResource +``` + +### Update +```json +connect:UpdateContactFlowMetadata, +connect:UpdateContactFlowContent, +connect:TagResource, +connect:UntagResource +``` + +### List +```json +connect:ListContactFlows +``` diff --git a/website/docs/services/connect/contact_flows_list_only/index.md b/website/docs/services/connect/contact_flows_list_only/index.md new file mode 100644 index 0000000..ee20366 --- /dev/null +++ b/website/docs/services/connect/contact_flows_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: contact_flows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flows_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists contact_flows in a region or regions, for all properties use contact_flows + +## Overview + + + + + + + +
Namecontact_flows_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::ContactFlow
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier of the contact flow (ARN).
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all contact_flows in a region. +```sql +SELECT +region, +contact_flow_arn +FROM aws.connect.contact_flows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_flows_list_only resource, see contact_flows + diff --git a/website/docs/services/connect/email_address_tags/index.md b/website/docs/services/connect/email_address_tags/index.md new file mode 100644 index 0000000..8d09703 --- /dev/null +++ b/website/docs/services/connect/email_address_tags/index.md @@ -0,0 +1,85 @@ +--- +title: email_address_tags +hide_title: false +hide_table_of_contents: false +keywords: + - email_address_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for email_addresses in a region + +## Overview + + + + + + + +
Nameemail_address_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::EmailAddress
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe identifier of the email address.
stringA description for the email address.
stringEmail address to be created for this instance
stringThe display name for the email address.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all email_addresses in a region. +```sql +SELECT +region, +instance_arn, +email_address_arn, +description, +email_address, +display_name, +tag_key, +tag_value +FROM aws.connect.email_address_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the email_address_tags resource, see email_addresses + diff --git a/website/docs/services/connect/email_addresses/index.md b/website/docs/services/connect/email_addresses/index.md new file mode 100644 index 0000000..9646b3c --- /dev/null +++ b/website/docs/services/connect/email_addresses/index.md @@ -0,0 +1,242 @@ +--- +title: email_addresses +hide_title: false +hide_table_of_contents: false +keywords: + - email_addresses + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an email_address resource or lists email_addresses in a region + +## Overview + + + + + + + +
Nameemail_addresses
TypeResource
DescriptionResource Type definition for AWS::Connect::EmailAddress
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe identifier of the email address.
stringA description for the email address.
stringEmail address to be created for this instance
stringThe display name for the email address.
arrayOne or more tags.
stringAWS region.
+ +For more information, see AWS::Connect::EmailAddress. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all email_addresses in a region. +```sql +SELECT +region, +instance_arn, +email_address_arn, +description, +email_address, +display_name, +tags +FROM aws.connect.email_addresses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual email_address. +```sql +SELECT +region, +instance_arn, +email_address_arn, +description, +email_address, +display_name, +tags +FROM aws.connect.email_addresses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new email_address resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.email_addresses ( + InstanceArn, + EmailAddress, + region +) +SELECT +'{{ InstanceArn }}', + '{{ EmailAddress }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.email_addresses ( + InstanceArn, + Description, + EmailAddress, + DisplayName, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Description }}', + '{{ EmailAddress }}', + '{{ DisplayName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: email_address + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Description + value: '{{ Description }}' + - name: EmailAddress + value: '{{ EmailAddress }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.email_addresses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the email_addresses resource, the following permissions are required: + +### Create +```json +connect:CreateEmailAddress, +connect:TagResource, +connect:ListIntegrationAssociations, +ses:GetEmailIdentity, +ses:DescribeReceiptRule, +ses:UpdateReceiptRule, +iam:PassRole +``` + +### Read +```json +connect:DescribeEmailAddress +``` + +### Update +```json +connect:UpdateEmailAddressMetadata, +connect:TagResource, +connect:UntagResource +``` + +### Delete +```json +connect:DeleteEmailAddress, +connect:UntagResource, +iam:PassRole, +ses:DescribeReceiptRule, +ses:UpdateReceiptRule +``` + +### List +```json +connect:DescribeEmailAddress, +connect:SearchEmailAddresses +``` diff --git a/website/docs/services/connect/email_addresses_list_only/index.md b/website/docs/services/connect/email_addresses_list_only/index.md new file mode 100644 index 0000000..cc53ac7 --- /dev/null +++ b/website/docs/services/connect/email_addresses_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: email_addresses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - email_addresses_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists email_addresses in a region or regions, for all properties use email_addresses + +## Overview + + + + + + + +
Nameemail_addresses_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::EmailAddress
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe identifier of the email address.
stringEmail address to be created for this instance
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all email_addresses in a region. +```sql +SELECT +region, +email_address_arn +FROM aws.connect.email_addresses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the email_addresses_list_only resource, see email_addresses + diff --git a/website/docs/services/connect/evaluation_form_tags/index.md b/website/docs/services/connect/evaluation_form_tags/index.md new file mode 100644 index 0000000..25108c5 --- /dev/null +++ b/website/docs/services/connect/evaluation_form_tags/index.md @@ -0,0 +1,89 @@ +--- +title: evaluation_form_tags +hide_title: false +hide_table_of_contents: false +keywords: + - evaluation_form_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for evaluation_forms in a region + +## Overview + + + + + + + +
Nameevaluation_form_tags
TypeResource
DescriptionCreates an evaluation form for the specified CON instance.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringA title of the evaluation form.
stringThe description of the evaluation form.
*Length Constraints*: Minimum length of 0. Maximum length of 1024.
string
stringThe identifier of the Amazon Connect instance.
arrayItems that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
*Minimum size*: 1
*Maximum size*: 100
objectA scoring strategy of the evaluation form.
stringThe status of the evaluation form.
*Allowed values*: DRAFT | ACTIVE
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all evaluation_forms in a region. +```sql +SELECT +region, +title, +description, +evaluation_form_arn, +instance_arn, +items, +scoring_strategy, +status, +tag_key, +tag_value +FROM aws.connect.evaluation_form_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the evaluation_form_tags resource, see evaluation_forms + diff --git a/website/docs/services/connect/evaluation_forms/index.md b/website/docs/services/connect/evaluation_forms/index.md new file mode 100644 index 0000000..31b5fd6 --- /dev/null +++ b/website/docs/services/connect/evaluation_forms/index.md @@ -0,0 +1,298 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an evaluation_form resource or lists evaluation_forms in a region + +## Overview + + + + + + + +
Nameevaluation_forms
TypeResource
DescriptionCreates an evaluation form for the specified CON instance.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringA title of the evaluation form.
stringThe description of the evaluation form.
*Length Constraints*: Minimum length of 0. Maximum length of 1024.
string
stringThe identifier of the Amazon Connect instance.
arrayItems that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
*Minimum size*: 1
*Maximum size*: 100
objectA scoring strategy of the evaluation form.
stringThe status of the evaluation form.
*Allowed values*: DRAFT | ACTIVE
arrayThe tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
stringAWS region.
+ +For more information, see AWS::Connect::EvaluationForm. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all evaluation_forms in a region. +```sql +SELECT +region, +title, +description, +evaluation_form_arn, +instance_arn, +items, +scoring_strategy, +status, +tags +FROM aws.connect.evaluation_forms +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual evaluation_form. +```sql +SELECT +region, +title, +description, +evaluation_form_arn, +instance_arn, +items, +scoring_strategy, +status, +tags +FROM aws.connect.evaluation_forms +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new evaluation_form resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.evaluation_forms ( + Title, + InstanceArn, + Items, + Status, + region +) +SELECT +'{{ Title }}', + '{{ InstanceArn }}', + '{{ Items }}', + '{{ Status }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.evaluation_forms ( + Title, + Description, + InstanceArn, + Items, + ScoringStrategy, + Status, + Tags, + region +) +SELECT + '{{ Title }}', + '{{ Description }}', + '{{ InstanceArn }}', + '{{ Items }}', + '{{ ScoringStrategy }}', + '{{ Status }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: evaluation_form + props: + - name: Title + value: '{{ Title }}' + - name: Description + value: '{{ Description }}' + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Items + value: + - Section: + Title: '{{ Title }}' + Instructions: '{{ Instructions }}' + RefId: '{{ RefId }}' + Items: + - Section: null + Question: + Title: '{{ Title }}' + Instructions: '{{ Instructions }}' + RefId: null + NotApplicableEnabled: '{{ NotApplicableEnabled }}' + QuestionType: '{{ QuestionType }}' + QuestionTypeProperties: + Numeric: + MinValue: '{{ MinValue }}' + MaxValue: '{{ MaxValue }}' + Options: + - MinValue: '{{ MinValue }}' + MaxValue: '{{ MaxValue }}' + Score: '{{ Score }}' + AutomaticFail: '{{ AutomaticFail }}' + Automation: + PropertyValue: + Label: '{{ Label }}' + SingleSelect: + Options: + - RefId: null + Text: '{{ Text }}' + Score: null + AutomaticFail: '{{ AutomaticFail }}' + DisplayAs: '{{ DisplayAs }}' + Automation: + Options: + - RuleCategory: + Category: '{{ Category }}' + Condition: '{{ Condition }}' + OptionRefId: null + DefaultOptionRefId: null + Weight: null + Weight: null + - name: ScoringStrategy + value: + Mode: '{{ Mode }}' + Status: '{{ Status }}' + - name: Status + value: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.evaluation_forms +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +connect:DescribeEvaluationForm, +connect:ListEvaluationFormVersions +``` + +### List +```json +connect:ListEvaluationForms +``` + +### Update +```json +connect:UpdateEvaluationForm, +connect:ListEvaluationFormVersions, +connect:ActivateEvaluationForm, +connect:DeactivateEvaluationForm, +connect:TagResource, +connect:UntagResource +``` + +### Delete +```json +connect:DeleteEvaluationForm, +connect:UntagResource +``` diff --git a/website/docs/services/connect/evaluation_forms_list_only/index.md b/website/docs/services/connect/evaluation_forms_list_only/index.md new file mode 100644 index 0000000..f45da04 --- /dev/null +++ b/website/docs/services/connect/evaluation_forms_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: evaluation_forms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - evaluation_forms_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists evaluation_forms in a region or regions, for all properties use evaluation_forms + +## Overview + + + + + + + +
Nameevaluation_forms_list_only
TypeResource
DescriptionCreates an evaluation form for the specified CON instance.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all evaluation_forms in a region. +```sql +SELECT +region, +evaluation_form_arn +FROM aws.connect.evaluation_forms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the evaluation_forms_list_only resource, see evaluation_forms + diff --git a/website/docs/services/connect/hours_of_operation_tags/index.md b/website/docs/services/connect/hours_of_operation_tags/index.md new file mode 100644 index 0000000..a5d0697 --- /dev/null +++ b/website/docs/services/connect/hours_of_operation_tags/index.md @@ -0,0 +1,89 @@ +--- +title: hours_of_operation_tags +hide_title: false +hide_table_of_contents: false +keywords: + - hours_of_operation_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for hours_of_operations in a region + +## Overview + + + + + + + +
Namehours_of_operation_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::HoursOfOperation
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the hours of operation.
stringThe description of the hours of operation.
stringThe time zone of the hours of operation.
arrayConfiguration information for the hours of operation: day, start time, and end time.
stringThe Amazon Resource Name (ARN) for the hours of operation.
arrayOne or more hours of operation overrides assigned to an hour of operation.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all hours_of_operations in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +time_zone, +config, +hours_of_operation_arn, +hours_of_operation_overrides, +tag_key, +tag_value +FROM aws.connect.hours_of_operation_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hours_of_operation_tags resource, see hours_of_operations + diff --git a/website/docs/services/connect/hours_of_operations/index.md b/website/docs/services/connect/hours_of_operations/index.md new file mode 100644 index 0000000..78827b6 --- /dev/null +++ b/website/docs/services/connect/hours_of_operations/index.md @@ -0,0 +1,273 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a hours_of_operation resource or lists hours_of_operations in a region + +## Overview + + + + + + + +
Namehours_of_operations
TypeResource
DescriptionResource Type definition for AWS::Connect::HoursOfOperation
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the hours of operation.
stringThe description of the hours of operation.
stringThe time zone of the hours of operation.
arrayConfiguration information for the hours of operation: day, start time, and end time.
stringThe Amazon Resource Name (ARN) for the hours of operation.
arrayOne or more tags.
arrayOne or more hours of operation overrides assigned to an hour of operation.
stringAWS region.
+ +For more information, see AWS::Connect::HoursOfOperation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all hours_of_operations in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +time_zone, +config, +hours_of_operation_arn, +tags, +hours_of_operation_overrides +FROM aws.connect.hours_of_operations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual hours_of_operation. +```sql +SELECT +region, +instance_arn, +name, +description, +time_zone, +config, +hours_of_operation_arn, +tags, +hours_of_operation_overrides +FROM aws.connect.hours_of_operations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new hours_of_operation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.hours_of_operations ( + InstanceArn, + Name, + TimeZone, + Config, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', + '{{ TimeZone }}', + '{{ Config }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.hours_of_operations ( + InstanceArn, + Name, + Description, + TimeZone, + Config, + Tags, + HoursOfOperationOverrides, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Name }}', + '{{ Description }}', + '{{ TimeZone }}', + '{{ Config }}', + '{{ Tags }}', + '{{ HoursOfOperationOverrides }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: hours_of_operation + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: TimeZone + value: '{{ TimeZone }}' + - name: Config + value: + - Day: '{{ Day }}' + StartTime: + Hours: '{{ Hours }}' + Minutes: '{{ Minutes }}' + EndTime: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: HoursOfOperationOverrides + value: + - OverrideName: '{{ OverrideName }}' + OverrideDescription: '{{ OverrideDescription }}' + EffectiveFrom: '{{ EffectiveFrom }}' + EffectiveTill: '{{ EffectiveTill }}' + OverrideConfig: + - Day: '{{ Day }}' + StartTime: + Hours: '{{ Hours }}' + Minutes: '{{ Minutes }}' + EndTime: null + HoursOfOperationOverrideId: '{{ HoursOfOperationOverrideId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.hours_of_operations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the hours_of_operations resource, the following permissions are required: + +### Create +```json +connect:CreateHoursOfOperation, +connect:TagResource, +connect:CreateHoursOfOperationOverride +``` + +### Read +```json +connect:DescribeHoursOfOperation, +connect:ListHoursOfOperationOverrides +``` + +### Delete +```json +connect:DeleteHoursOfOperation, +connect:UntagResource +``` + +### Update +```json +connect:UpdateHoursOfOperation, +connect:CreateHoursOfOperationOverride, +connect:UpdateHoursOfOperationOverride, +connect:DeleteHoursOfOperationOverride, +connect:ListHoursOfOperationOverrides, +connect:TagResource, +connect:UntagResource +``` + +### List +```json +connect:ListHoursOfOperations +``` diff --git a/website/docs/services/connect/hours_of_operations_list_only/index.md b/website/docs/services/connect/hours_of_operations_list_only/index.md new file mode 100644 index 0000000..1b8c05b --- /dev/null +++ b/website/docs/services/connect/hours_of_operations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: hours_of_operations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hours_of_operations_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hours_of_operations in a region or regions, for all properties use hours_of_operations + +## Overview + + + + + + + +
Namehours_of_operations_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::HoursOfOperation
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the hours of operation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hours_of_operations in a region. +```sql +SELECT +region, +hours_of_operation_arn +FROM aws.connect.hours_of_operations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hours_of_operations_list_only resource, see hours_of_operations + diff --git a/website/docs/services/connect/index.md b/website/docs/services/connect/index.md new file mode 100644 index 0000000..ab2da56 --- /dev/null +++ b/website/docs/services/connect/index.md @@ -0,0 +1,100 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The connect service documentation. + +:::info Service Summary + +
+
+total resources: 65
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/connect/instance_storage_configs/index.md b/website/docs/services/connect/instance_storage_configs/index.md new file mode 100644 index 0000000..504eea4 --- /dev/null +++ b/website/docs/services/connect/instance_storage_configs/index.md @@ -0,0 +1,282 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an instance_storage_config resource or lists instance_storage_configs in a region + +## Overview + + + + + + + +
Nameinstance_storage_configs
TypeResource
DescriptionResource Type definition for AWS::Connect::InstanceStorageConfig
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringConnect Instance ID with which the storage config will be associated
stringSpecifies the type of storage resource available for the instance
stringAn associationID is automatically generated when a storage config is associated with an instance
stringSpecifies the storage type to be associated with the instance
object
object
object
object
stringAWS region.
+ +For more information, see AWS::Connect::InstanceStorageConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all instance_storage_configs in a region. +```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_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual instance_storage_config. +```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_configs +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance_storage_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.instance_storage_configs ( + InstanceArn, + ResourceType, + StorageType, + region +) +SELECT +'{{ InstanceArn }}', + '{{ ResourceType }}', + '{{ StorageType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.instance_storage_configs ( + InstanceArn, + ResourceType, + StorageType, + S3Config, + KinesisVideoStreamConfig, + KinesisStreamConfig, + KinesisFirehoseConfig, + region +) +SELECT + '{{ InstanceArn }}', + '{{ ResourceType }}', + '{{ StorageType }}', + '{{ S3Config }}', + '{{ KinesisVideoStreamConfig }}', + '{{ KinesisStreamConfig }}', + '{{ KinesisFirehoseConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: instance_storage_config + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: ResourceType + value: '{{ ResourceType }}' + - name: StorageType + value: '{{ StorageType }}' + - name: S3Config + value: + BucketName: '{{ BucketName }}' + BucketPrefix: '{{ BucketPrefix }}' + EncryptionConfig: + EncryptionType: '{{ EncryptionType }}' + KeyId: '{{ KeyId }}' + - name: KinesisVideoStreamConfig + value: + Prefix: null + RetentionPeriodHours: null + EncryptionConfig: null + - name: KinesisStreamConfig + value: + StreamArn: '{{ StreamArn }}' + - name: KinesisFirehoseConfig + value: + FirehoseArn: '{{ FirehoseArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.instance_storage_configs +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +connect:DescribeInstance, +connect:ListInstanceStorageConfigs, +ds:DescribeDirectories +``` diff --git a/website/docs/services/connect/instance_storage_configs_list_only/index.md b/website/docs/services/connect/instance_storage_configs_list_only/index.md new file mode 100644 index 0000000..f6ae023 --- /dev/null +++ b/website/docs/services/connect/instance_storage_configs_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: instance_storage_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instance_storage_configs_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instance_storage_configs in a region or regions, for all properties use instance_storage_configs + +## Overview + + + + + + + +
Nameinstance_storage_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::InstanceStorageConfig
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringConnect Instance ID with which the storage config will be associated
stringSpecifies the type of storage resource available for the instance
stringAn associationID is automatically generated when a storage config is associated with an instance
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instance_storage_configs in a region. +```sql +SELECT +region, +instance_arn, +association_id, +resource_type +FROM aws.connect.instance_storage_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_storage_configs_list_only resource, see instance_storage_configs + diff --git a/website/docs/services/connect/instance_tags/index.md b/website/docs/services/connect/instance_tags/index.md new file mode 100644 index 0000000..3801e8a --- /dev/null +++ b/website/docs/services/connect/instance_tags/index.md @@ -0,0 +1,93 @@ +--- +title: instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instances in a region + +## Overview + + + + + + + +
Nameinstance_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::Instance
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAn instanceId is automatically generated on creation and assigned as the unique identifier.
stringAn instanceArn is automatically generated on creation based on instanceId.
stringSpecifies the type of directory integration for new instance.
stringAlias of the new directory created as part of new instance creation.
stringTimestamp of instance creation logged as part of instance creation.
stringService linked role created as part of instance creation.
stringSpecifies the creation status of new instance.
stringExisting directoryId user wants to map to the new Connect instance.
objectThe attributes for the instance.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instances in a region. +```sql +SELECT +region, +id, +arn, +identity_management_type, +instance_alias, +created_time, +service_role, +instance_status, +directory_id, +attributes, +tag_key, +tag_value +FROM aws.connect.instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_tags resource, see instances + diff --git a/website/docs/services/connect/instances/index.md b/website/docs/services/connect/instances/index.md new file mode 100644 index 0000000..307fb7f --- /dev/null +++ b/website/docs/services/connect/instances/index.md @@ -0,0 +1,275 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an instance resource or lists instances in a region + +## Overview + + + + + + + +
Nameinstances
TypeResource
DescriptionResource Type definition for AWS::Connect::Instance
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAn instanceId is automatically generated on creation and assigned as the unique identifier.
stringAn instanceArn is automatically generated on creation based on instanceId.
stringSpecifies the type of directory integration for new instance.
stringAlias of the new directory created as part of new instance creation.
stringTimestamp of instance creation logged as part of instance creation.
stringService linked role created as part of instance creation.
stringSpecifies the creation status of new instance.
stringExisting directoryId user wants to map to the new Connect instance.
objectThe attributes for the instance.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Connect::Instance. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all instances in a region. +```sql +SELECT +region, +id, +arn, +identity_management_type, +instance_alias, +created_time, +service_role, +instance_status, +directory_id, +attributes, +tags +FROM aws.connect.instances +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual instance. +```sql +SELECT +region, +id, +arn, +identity_management_type, +instance_alias, +created_time, +service_role, +instance_status, +directory_id, +attributes, +tags +FROM aws.connect.instances +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.instances ( + IdentityManagementType, + Attributes, + region +) +SELECT +'{{ IdentityManagementType }}', + '{{ Attributes }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.instances ( + IdentityManagementType, + InstanceAlias, + DirectoryId, + Attributes, + Tags, + region +) +SELECT + '{{ IdentityManagementType }}', + '{{ InstanceAlias }}', + '{{ DirectoryId }}', + '{{ Attributes }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: instance + props: + - name: IdentityManagementType + value: '{{ IdentityManagementType }}' + - name: InstanceAlias + value: '{{ InstanceAlias }}' + - name: DirectoryId + value: '{{ DirectoryId }}' + - name: Attributes + value: + InboundCalls: '{{ InboundCalls }}' + OutboundCalls: '{{ OutboundCalls }}' + ContactflowLogs: '{{ ContactflowLogs }}' + ContactLens: '{{ ContactLens }}' + AutoResolveBestVoices: '{{ AutoResolveBestVoices }}' + UseCustomTTSVoices: '{{ UseCustomTTSVoices }}' + EarlyMedia: '{{ EarlyMedia }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.instances +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +connect:ListInstances, +connect:ListInstanceAttributes, +ds:DescribeDirectories +``` diff --git a/website/docs/services/connect/instances_list_only/index.md b/website/docs/services/connect/instances_list_only/index.md new file mode 100644 index 0000000..dfdc221 --- /dev/null +++ b/website/docs/services/connect/instances_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instances_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instances in a region or regions, for all properties use instances + +## Overview + + + + + + + +
Nameinstances_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::Instance
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAn instanceArn is automatically generated on creation based on instanceId.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instances in a region. +```sql +SELECT +region, +arn +FROM aws.connect.instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instances_list_only resource, see instances + diff --git a/website/docs/services/connect/integration_associations/index.md b/website/docs/services/connect/integration_associations/index.md new file mode 100644 index 0000000..96c65df --- /dev/null +++ b/website/docs/services/connect/integration_associations/index.md @@ -0,0 +1,256 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an integration_association resource or lists integration_associations in a region + +## Overview + + + + + + + +
Nameintegration_associations
TypeResource
DescriptionResource Type definition for AWS::Connect::IntegrationAssociation
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringIdentifier of the association with Connect Instance
stringAmazon Connect instance identifier
stringARN of Integration being associated with the instance
stringSpecifies the integration type to be associated with the instance
stringAWS region.
+ +For more information, see AWS::Connect::IntegrationAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all integration_associations in a region. +```sql +SELECT +region, +integration_association_id, +instance_id, +integration_arn, +integration_type +FROM aws.connect.integration_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual integration_association. +```sql +SELECT +region, +integration_association_id, +instance_id, +integration_arn, +integration_type +FROM aws.connect.integration_associations +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new integration_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.integration_associations ( + InstanceId, + IntegrationArn, + IntegrationType, + region +) +SELECT +'{{ InstanceId }}', + '{{ IntegrationArn }}', + '{{ IntegrationType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.integration_associations ( + InstanceId, + IntegrationArn, + IntegrationType, + region +) +SELECT + '{{ InstanceId }}', + '{{ IntegrationArn }}', + '{{ IntegrationType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: integration_association + props: + - name: InstanceId + value: '{{ InstanceId }}' + - name: IntegrationArn + value: '{{ IntegrationArn }}' + - name: IntegrationType + value: '{{ IntegrationType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.integration_associations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +connect:ListBots, +connect:ListLambdaFunctions, +connect:ListIntegrationAssociations +``` diff --git a/website/docs/services/connect/integration_associations_list_only/index.md b/website/docs/services/connect/integration_associations_list_only/index.md new file mode 100644 index 0000000..03e0c2e --- /dev/null +++ b/website/docs/services/connect/integration_associations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: integration_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integration_associations_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integration_associations in a region or regions, for all properties use integration_associations + +## Overview + + + + + + + +
Nameintegration_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::IntegrationAssociation
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringAmazon Connect instance identifier
stringARN of Integration being associated with the instance
stringSpecifies the integration type to be associated with the instance
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integration_associations in a region. +```sql +SELECT +region, +instance_id, +integration_type, +integration_arn +FROM aws.connect.integration_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integration_associations_list_only resource, see integration_associations + diff --git a/website/docs/services/connect/predefined_attributes/index.md b/website/docs/services/connect/predefined_attributes/index.md new file mode 100644 index 0000000..6daa2d1 --- /dev/null +++ b/website/docs/services/connect/predefined_attributes/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a predefined_attribute resource or lists predefined_attributes in a region + +## Overview + + + + + + + +
Namepredefined_attributes
TypeResource
DescriptionResource Type definition for AWS::Connect::PredefinedAttribute
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the predefined attribute.
objectThe values of a predefined attribute.
stringLast modified region.
numberLast modified time.
stringAWS region.
+ +For more information, see AWS::Connect::PredefinedAttribute. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all predefined_attributes in a region. +```sql +SELECT +region, +instance_arn, +name, +values, +last_modified_region, +last_modified_time +FROM aws.connect.predefined_attributes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual predefined_attribute. +```sql +SELECT +region, +instance_arn, +name, +values, +last_modified_region, +last_modified_time +FROM aws.connect.predefined_attributes +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new predefined_attribute resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.predefined_attributes ( + InstanceArn, + Name, + Values, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', + '{{ Values }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.predefined_attributes ( + InstanceArn, + Name, + Values, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Name }}', + '{{ Values }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: predefined_attribute + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Name + value: '{{ Name }}' + - name: Values + value: + StringList: + - '{{ StringList[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.predefined_attributes +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the predefined_attributes resource, the following permissions are required: + +### Create +```json +connect:CreatePredefinedAttribute +``` + +### Read +```json +connect:DescribePredefinedAttribute +``` + +### Delete +```json +connect:DeletePredefinedAttribute +``` + +### Update +```json +connect:UpdatePredefinedAttribute +``` + +### List +```json +connect:ListPredefinedAttributes +``` diff --git a/website/docs/services/connect/predefined_attributes_list_only/index.md b/website/docs/services/connect/predefined_attributes_list_only/index.md new file mode 100644 index 0000000..0dd34b2 --- /dev/null +++ b/website/docs/services/connect/predefined_attributes_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: predefined_attributes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - predefined_attributes_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists predefined_attributes in a region or regions, for all properties use predefined_attributes + +## Overview + + + + + + + +
Namepredefined_attributes_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::PredefinedAttribute
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the predefined attribute.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all predefined_attributes in a region. +```sql +SELECT +region, +instance_arn, +name +FROM aws.connect.predefined_attributes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the predefined_attributes_list_only resource, see predefined_attributes + diff --git a/website/docs/services/connect/prompt_tags/index.md b/website/docs/services/connect/prompt_tags/index.md new file mode 100644 index 0000000..2000ce4 --- /dev/null +++ b/website/docs/services/connect/prompt_tags/index.md @@ -0,0 +1,85 @@ +--- +title: prompt_tags +hide_title: false +hide_table_of_contents: false +keywords: + - prompt_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for prompts in a region + +## Overview + + + + + + + +
Nameprompt_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::Prompt
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the prompt.
stringThe description of the prompt.
stringS3 URI of the customer's audio file for creating prompts resource..
stringThe Amazon Resource Name (ARN) for the prompt.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all prompts in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +s3_uri, +prompt_arn, +tag_key, +tag_value +FROM aws.connect.prompt_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prompt_tags resource, see prompts + diff --git a/website/docs/services/connect/prompts/index.md b/website/docs/services/connect/prompts/index.md new file mode 100644 index 0000000..2571e07 --- /dev/null +++ b/website/docs/services/connect/prompts/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a prompt resource or lists prompts in a region + +## Overview + + + + + + + +
Nameprompts
TypeResource
DescriptionResource Type definition for AWS::Connect::Prompt
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the prompt.
stringThe description of the prompt.
stringS3 URI of the customer's audio file for creating prompts resource..
stringThe Amazon Resource Name (ARN) for the prompt.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Connect::Prompt. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all prompts in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +s3_uri, +prompt_arn, +tags +FROM aws.connect.prompts +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual prompt. +```sql +SELECT +region, +instance_arn, +name, +description, +s3_uri, +prompt_arn, +tags +FROM aws.connect.prompts +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new prompt resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.prompts ( + InstanceArn, + Name, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.prompts ( + InstanceArn, + Name, + Description, + S3Uri, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Name }}', + '{{ Description }}', + '{{ S3Uri }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: prompt + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: S3Uri + value: '{{ S3Uri }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.prompts +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +connect:DescribePrompt +``` + +### Update +```json +connect:UpdatePrompt, +connect:TagResource, +connect:UntagResource +``` + +### Delete +```json +connect:DeletePrompt +``` + +### List +```json +connect:ListPrompts +``` diff --git a/website/docs/services/connect/prompts_list_only/index.md b/website/docs/services/connect/prompts_list_only/index.md new file mode 100644 index 0000000..a898c52 --- /dev/null +++ b/website/docs/services/connect/prompts_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: prompts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - prompts_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists prompts in a region or regions, for all properties use prompts + +## Overview + + + + + + + +
Nameprompts_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::Prompt
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the prompt.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all prompts in a region. +```sql +SELECT +region, +prompt_arn +FROM aws.connect.prompts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prompts_list_only resource, see prompts + diff --git a/website/docs/services/connect/queue_tags/index.md b/website/docs/services/connect/queue_tags/index.md new file mode 100644 index 0000000..18b762e --- /dev/null +++ b/website/docs/services/connect/queue_tags/index.md @@ -0,0 +1,97 @@ +--- +title: queue_tags +hide_title: false +hide_table_of_contents: false +keywords: + - queue_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for queues in a region + +## Overview + + + + + + + +
Namequeue_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::Queue
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe description of the queue.
stringThe identifier for the hours of operation.
integerThe maximum number of contacts that can be in the queue before it is considered full.
stringThe name of the queue.
objectThe outbound caller ID name, number, and outbound whisper flow.
objectThe outbound email address ID.
stringThe Amazon Resource Name (ARN) for the queue.
stringThe status of the queue.
arrayThe quick connects available to agents who are working the queue.
stringThe type of queue.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all queues in a region. +```sql +SELECT +region, +instance_arn, +description, +hours_of_operation_arn, +max_contacts, +name, +outbound_caller_config, +outbound_email_config, +queue_arn, +status, +quick_connect_arns, +type, +tag_key, +tag_value +FROM aws.connect.queue_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queue_tags resource, see queues + diff --git a/website/docs/services/connect/queues/index.md b/website/docs/services/connect/queues/index.md new file mode 100644 index 0000000..e3d5dff --- /dev/null +++ b/website/docs/services/connect/queues/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a queue resource or lists queues in a region + +## Overview + + + + + + + +
Namequeues
TypeResource
DescriptionResource Type definition for AWS::Connect::Queue
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe description of the queue.
stringThe identifier for the hours of operation.
integerThe maximum number of contacts that can be in the queue before it is considered full.
stringThe name of the queue.
objectThe outbound caller ID name, number, and outbound whisper flow.
objectThe outbound email address ID.
stringThe Amazon Resource Name (ARN) for the queue.
stringThe status of the queue.
arrayThe quick connects available to agents who are working the queue.
arrayAn array of key-value pairs to apply to this resource.
stringThe type of queue.
stringAWS region.
+ +For more information, see AWS::Connect::Queue. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all queues in a region. +```sql +SELECT +region, +instance_arn, +description, +hours_of_operation_arn, +max_contacts, +name, +outbound_caller_config, +outbound_email_config, +queue_arn, +status, +quick_connect_arns, +tags, +type +FROM aws.connect.queues +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual queue. +```sql +SELECT +region, +instance_arn, +description, +hours_of_operation_arn, +max_contacts, +name, +outbound_caller_config, +outbound_email_config, +queue_arn, +status, +quick_connect_arns, +tags, +type +FROM aws.connect.queues +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.queues ( + InstanceArn, + HoursOfOperationArn, + Name, + region +) +SELECT +'{{ InstanceArn }}', + '{{ HoursOfOperationArn }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.queues ( + InstanceArn, + Description, + HoursOfOperationArn, + MaxContacts, + Name, + OutboundCallerConfig, + OutboundEmailConfig, + Status, + QuickConnectArns, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Description }}', + '{{ HoursOfOperationArn }}', + '{{ MaxContacts }}', + '{{ Name }}', + '{{ OutboundCallerConfig }}', + '{{ OutboundEmailConfig }}', + '{{ Status }}', + '{{ QuickConnectArns }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: queue + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Description + value: '{{ Description }}' + - name: HoursOfOperationArn + value: '{{ HoursOfOperationArn }}' + - name: MaxContacts + value: '{{ MaxContacts }}' + - name: Name + value: '{{ Name }}' + - name: OutboundCallerConfig + value: + OutboundCallerIdName: '{{ OutboundCallerIdName }}' + OutboundCallerIdNumberArn: '{{ OutboundCallerIdNumberArn }}' + OutboundFlowArn: '{{ OutboundFlowArn }}' + - name: OutboundEmailConfig + value: + OutboundEmailAddressId: '{{ OutboundEmailAddressId }}' + - name: Status + value: '{{ Status }}' + - name: QuickConnectArns + value: + - '{{ QuickConnectArns[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.queues +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the queues resource, the following permissions are required: + +### Create +```json +connect:CreateQueue, +connect:TagResource +``` + +### Read +```json +connect:DescribeQueue, +connect:ListQueueQuickConnects +``` + +### Delete +```json +connect:DeleteQueue, +connect:UntagResource +``` + +### Update +```json +connect:UpdateQueueHoursOfOperation, +connect:UpdateQueueMaxContacts, +connect:UpdateQueueName, +connect:UpdateQueueOutboundCallerConfig, +connect:UpdateQueueOutboundEmailConfig, +connect:UpdateQueueStatus, +connect:AssociateQueueQuickConnects, +connect:DisassociateQueueQuickConnects, +connect:TagResource, +connect:UntagResource +``` + +### List +```json +connect:ListQueues, +connect:ListQueueQuickConnects +``` diff --git a/website/docs/services/connect/queues_list_only/index.md b/website/docs/services/connect/queues_list_only/index.md new file mode 100644 index 0000000..bdd06e2 --- /dev/null +++ b/website/docs/services/connect/queues_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queues_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queues in a region or regions, for all properties use queues + +## Overview + + + + + + + +
Namequeues_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::Queue
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the queue.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queues in a region. +```sql +SELECT +region, +queue_arn +FROM aws.connect.queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queues_list_only resource, see queues + diff --git a/website/docs/services/connect/quick_connect_tags/index.md b/website/docs/services/connect/quick_connect_tags/index.md new file mode 100644 index 0000000..0e4b3cc --- /dev/null +++ b/website/docs/services/connect/quick_connect_tags/index.md @@ -0,0 +1,87 @@ +--- +title: quick_connect_tags +hide_title: false +hide_table_of_contents: false +keywords: + - quick_connect_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for quick_connects in a region + +## Overview + + + + + + + +
Namequick_connect_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::QuickConnect
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the quick connect.
stringThe description of the quick connect.
objectConfiguration settings for the quick connect.
stringThe Amazon Resource Name (ARN) for the quick connect.
stringThe type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all quick_connects in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +quick_connect_config, +quick_connect_arn, +quick_connect_type, +tag_key, +tag_value +FROM aws.connect.quick_connect_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the quick_connect_tags resource, see quick_connects + diff --git a/website/docs/services/connect/quick_connects/index.md b/website/docs/services/connect/quick_connects/index.md new file mode 100644 index 0000000..22fa601 --- /dev/null +++ b/website/docs/services/connect/quick_connects/index.md @@ -0,0 +1,248 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a quick_connect resource or lists quick_connects in a region + +## Overview + + + + + + + +
Namequick_connects
TypeResource
DescriptionResource Type definition for AWS::Connect::QuickConnect
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the quick connect.
stringThe description of the quick connect.
objectConfiguration settings for the quick connect.
stringThe Amazon Resource Name (ARN) for the quick connect.
arrayOne or more tags.
stringThe type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
stringAWS region.
+ +For more information, see AWS::Connect::QuickConnect. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all quick_connects in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +quick_connect_config, +quick_connect_arn, +tags, +quick_connect_type +FROM aws.connect.quick_connects +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual quick_connect. +```sql +SELECT +region, +instance_arn, +name, +description, +quick_connect_config, +quick_connect_arn, +tags, +quick_connect_type +FROM aws.connect.quick_connects +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new quick_connect resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.quick_connects ( + InstanceArn, + Name, + QuickConnectConfig, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', + '{{ QuickConnectConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.quick_connects ( + InstanceArn, + Name, + Description, + QuickConnectConfig, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Name }}', + '{{ Description }}', + '{{ QuickConnectConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: quick_connect + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: QuickConnectConfig + value: + QuickConnectType: '{{ QuickConnectType }}' + PhoneConfig: + PhoneNumber: '{{ PhoneNumber }}' + QueueConfig: + ContactFlowArn: '{{ ContactFlowArn }}' + QueueArn: '{{ QueueArn }}' + UserConfig: + ContactFlowArn: null + UserArn: '{{ UserArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.quick_connects +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the quick_connects resource, the following permissions are required: + +### Create +```json +connect:CreateQuickConnect, +connect:TagResource +``` + +### Read +```json +connect:DescribeQuickConnect +``` + +### Delete +```json +connect:DeleteQuickConnect, +connect:UntagResource +``` + +### Update +```json +connect:UpdateQuickConnectName, +connect:UpdateQuickConnectConfig, +connect:TagResource, +connect:UntagResource +``` + +### List +```json +connect:ListQuickConnects +``` diff --git a/website/docs/services/connect/quick_connects_list_only/index.md b/website/docs/services/connect/quick_connects_list_only/index.md new file mode 100644 index 0000000..d275252 --- /dev/null +++ b/website/docs/services/connect/quick_connects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: quick_connects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - quick_connects_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists quick_connects in a region or regions, for all properties use quick_connects + +## Overview + + + + + + + +
Namequick_connects_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::QuickConnect
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the quick connect.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all quick_connects in a region. +```sql +SELECT +region, +quick_connect_arn +FROM aws.connect.quick_connects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the quick_connects_list_only resource, see quick_connects + diff --git a/website/docs/services/connect/routing_profile_tags/index.md b/website/docs/services/connect/routing_profile_tags/index.md new file mode 100644 index 0000000..ae4ec10 --- /dev/null +++ b/website/docs/services/connect/routing_profile_tags/index.md @@ -0,0 +1,91 @@ +--- +title: routing_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - routing_profile_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for routing_profiles in a region + +## Overview + + + + + + + +
Namerouting_profile_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::RoutingProfile
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the routing profile.
stringThe description of the routing profile.
arrayThe channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
stringThe identifier of the default outbound queue for this routing profile.
stringThe Amazon Resource Name (ARN) of the routing profile.
arrayThe queues to associate with this routing profile.
stringWhether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all routing_profiles in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +media_concurrencies, +default_outbound_queue_arn, +routing_profile_arn, +queue_configs, +agent_availability_timer, +tag_key, +tag_value +FROM aws.connect.routing_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routing_profile_tags resource, see routing_profiles + diff --git a/website/docs/services/connect/routing_profiles/index.md b/website/docs/services/connect/routing_profiles/index.md new file mode 100644 index 0000000..2a73919 --- /dev/null +++ b/website/docs/services/connect/routing_profiles/index.md @@ -0,0 +1,278 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a routing_profile resource or lists routing_profiles in a region + +## Overview + + + + + + + +
Namerouting_profiles
TypeResource
DescriptionResource Type definition for AWS::Connect::RoutingProfile
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the routing profile.
stringThe description of the routing profile.
arrayThe channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
stringThe identifier of the default outbound queue for this routing profile.
stringThe Amazon Resource Name (ARN) of the routing profile.
arrayThe queues to associate with this routing profile.
arrayAn array of key-value pairs to apply to this resource.
stringWhether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
stringAWS region.
+ +For more information, see AWS::Connect::RoutingProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all routing_profiles in a region. +```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_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual routing_profile. +```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_profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new routing_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.routing_profiles ( + InstanceArn, + Name, + Description, + MediaConcurrencies, + DefaultOutboundQueueArn, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', + '{{ Description }}', + '{{ MediaConcurrencies }}', + '{{ DefaultOutboundQueueArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.routing_profiles ( + InstanceArn, + Name, + Description, + MediaConcurrencies, + DefaultOutboundQueueArn, + QueueConfigs, + Tags, + AgentAvailabilityTimer, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Name }}', + '{{ Description }}', + '{{ MediaConcurrencies }}', + '{{ DefaultOutboundQueueArn }}', + '{{ QueueConfigs }}', + '{{ Tags }}', + '{{ AgentAvailabilityTimer }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: routing_profile + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: MediaConcurrencies + value: + - Channel: '{{ Channel }}' + Concurrency: '{{ Concurrency }}' + CrossChannelBehavior: + BehaviorType: '{{ BehaviorType }}' + - name: DefaultOutboundQueueArn + value: '{{ DefaultOutboundQueueArn }}' + - name: QueueConfigs + value: + - Delay: '{{ Delay }}' + Priority: '{{ Priority }}' + QueueReference: + Channel: null + QueueArn: '{{ QueueArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AgentAvailabilityTimer + value: '{{ AgentAvailabilityTimer }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.routing_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the routing_profiles resource, the following permissions are required: + +### Create +```json +connect:CreateRoutingProfile, +connect:TagResource +``` + +### 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 +``` + +### List +```json +connect:ListRoutingProfiles, +connect:ListRoutingProfileQueues +``` diff --git a/website/docs/services/connect/routing_profiles_list_only/index.md b/website/docs/services/connect/routing_profiles_list_only/index.md new file mode 100644 index 0000000..8b9e4d0 --- /dev/null +++ b/website/docs/services/connect/routing_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: routing_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - routing_profiles_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists routing_profiles in a region or regions, for all properties use routing_profiles + +## Overview + + + + + + + +
Namerouting_profiles_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::RoutingProfile
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the routing profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all routing_profiles in a region. +```sql +SELECT +region, +routing_profile_arn +FROM aws.connect.routing_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routing_profiles_list_only resource, see routing_profiles + diff --git a/website/docs/services/connect/rules/index.md b/website/docs/services/connect/rules/index.md new file mode 100644 index 0000000..d20c9eb --- /dev/null +++ b/website/docs/services/connect/rules/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a rule resource or lists rules in a region + +## Overview + + + + + + + +
Namerules
TypeResource
DescriptionCreates a rule for the specified CON instance.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the rule.
string
stringThe Amazon Resource Name (ARN) of the instance.
objectThe event source to trigger the rule.
stringThe conditions of the rule.
objectA list of actions to be run when the rule is triggered.
stringThe publish status of the rule.
*Allowed values*: DRAFT | PUBLISHED
arrayThe tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
stringAWS region.
+ +For more information, see AWS::Connect::Rule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual rule. +```sql +SELECT +region, +name, +rule_arn, +instance_arn, +trigger_event_source, +function, +actions, +publish_status, +tags +FROM aws.connect.rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.rules ( + Name, + InstanceArn, + TriggerEventSource, + Function, + Actions, + PublishStatus, + region +) +SELECT +'{{ Name }}', + '{{ InstanceArn }}', + '{{ TriggerEventSource }}', + '{{ Function }}', + '{{ Actions }}', + '{{ PublishStatus }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.rules ( + Name, + InstanceArn, + TriggerEventSource, + Function, + Actions, + PublishStatus, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ InstanceArn }}', + '{{ TriggerEventSource }}', + '{{ Function }}', + '{{ Actions }}', + '{{ PublishStatus }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: rule + props: + - name: Name + value: '{{ Name }}' + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: TriggerEventSource + value: + EventSourceName: '{{ EventSourceName }}' + IntegrationAssociationArn: '{{ IntegrationAssociationArn }}' + - name: Function + value: '{{ Function }}' + - name: Actions + value: + AssignContactCategoryActions: + - {} + EventBridgeActions: + - Name: '{{ Name }}' + TaskActions: + - Name: '{{ Name }}' + Description: '{{ Description }}' + ContactFlowArn: '{{ ContactFlowArn }}' + References: null + SendNotificationActions: + - DeliveryMethod: '{{ DeliveryMethod }}' + Subject: '{{ Subject }}' + Content: '{{ Content }}' + ContentType: '{{ ContentType }}' + Recipient: + UserTags: null + UserArns: + - '{{ UserArns[0] }}' + CreateCaseActions: + - Fields: + - Id: + Name: '{{ Name }}' + Description: '{{ Description }}' + Type: '{{ Type }}' + SingleSelectOptions: + - '{{ SingleSelectOptions[0] }}' + TemplateId: '{{ TemplateId }}' + UpdateCaseActions: + - Fields: null + EndAssociatedTasksActions: + - {} + SubmitAutoEvaluationActions: + - EvaluationFormArn: '{{ EvaluationFormArn }}' + - name: PublishStatus + value: '{{ PublishStatus }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.rules +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/connect/security_keys/index.md b/website/docs/services/connect/security_keys/index.md new file mode 100644 index 0000000..e8bbc3c --- /dev/null +++ b/website/docs/services/connect/security_keys/index.md @@ -0,0 +1,196 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_key resource or lists security_keys in a region + +## Overview + + + + + + + +
Namesecurity_keys
TypeResource
DescriptionResource Type definition for AWS::Connect::SecurityKey
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA valid security key in PEM format.
stringAmazon Connect instance identifier
stringAn associationID is automatically generated when a storage config is associated with an instance
stringAWS region.
+ +For more information, see AWS::Connect::SecurityKey. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_keys in a region. +```sql +SELECT +region, +key, +instance_id, +association_id +FROM aws.connect.security_keys +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_key. +```sql +SELECT +region, +key, +instance_id, +association_id +FROM aws.connect.security_keys +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.security_keys ( + Key, + InstanceId, + region +) +SELECT +'{{ Key }}', + '{{ InstanceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.security_keys ( + Key, + InstanceId, + region +) +SELECT + '{{ Key }}', + '{{ InstanceId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_key + props: + - name: Key + value: '{{ Key }}' + - name: InstanceId + value: '{{ InstanceId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.security_keys +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the security_keys resource, the following permissions are required: + +### Create +```json +connect:AssociateSecurityKey +``` + +### Read +```json +connect:ListSecurityKeys +``` + +### Delete +```json +connect:DisassociateSecurityKey +``` + +### List +```json +connect:ListSecurityKeys +``` diff --git a/website/docs/services/connect/security_keys_list_only/index.md b/website/docs/services/connect/security_keys_list_only/index.md new file mode 100644 index 0000000..fef196d --- /dev/null +++ b/website/docs/services/connect/security_keys_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: security_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_keys_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_keys in a region or regions, for all properties use security_keys + +## Overview + + + + + + + +
Namesecurity_keys_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::SecurityKey
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringAmazon Connect instance identifier
stringAn associationID is automatically generated when a storage config is associated with an instance
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_keys in a region. +```sql +SELECT +region, +instance_id, +association_id +FROM aws.connect.security_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_keys_list_only resource, see security_keys + diff --git a/website/docs/services/connect/security_profile_tags/index.md b/website/docs/services/connect/security_profile_tags/index.md new file mode 100644 index 0000000..bd77b9e --- /dev/null +++ b/website/docs/services/connect/security_profile_tags/index.md @@ -0,0 +1,99 @@ +--- +title: security_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - security_profile_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for security_profiles in a region + +## Overview + + + + + + + +
Namesecurity_profile_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::SecurityProfile
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe list of tags that a security profile uses to restrict access to resources in Amazon Connect.
stringThe description of the security profile.
stringThe identifier of the Amazon Connect instance.
arrayPermissions assigned to the security profile.
stringThe Amazon Resource Name (ARN) for the security profile.
stringThe name of the security profile.
arrayThe list of resources that a security profile applies tag restrictions to in Amazon Connect.
arrayThe list of resources that a security profile applies hierarchy restrictions to in Amazon Connect.
stringThe identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
arrayA list of third-party applications that the security profile will give access to.
stringThe AWS Region where this resource was last modified.
numberThe timestamp when this resource was last modified.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all security_profiles in a region. +```sql +SELECT +region, +allowed_access_control_tags, +description, +instance_arn, +permissions, +security_profile_arn, +security_profile_name, +tag_restricted_resources, +hierarchy_restricted_resources, +allowed_access_control_hierarchy_group_id, +applications, +last_modified_region, +last_modified_time, +tag_key, +tag_value +FROM aws.connect.security_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_profile_tags resource, see security_profiles + diff --git a/website/docs/services/connect/security_profiles/index.md b/website/docs/services/connect/security_profiles/index.md new file mode 100644 index 0000000..0323132 --- /dev/null +++ b/website/docs/services/connect/security_profiles/index.md @@ -0,0 +1,283 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_profile resource or lists security_profiles in a region + +## Overview + + + + + + + +
Namesecurity_profiles
TypeResource
DescriptionResource Type definition for AWS::Connect::SecurityProfile
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe list of tags that a security profile uses to restrict access to resources in Amazon Connect.
stringThe description of the security profile.
stringThe identifier of the Amazon Connect instance.
arrayPermissions assigned to the security profile.
stringThe Amazon Resource Name (ARN) for the security profile.
stringThe name of the security profile.
arrayThe list of resources that a security profile applies tag restrictions to in Amazon Connect.
arrayThe list of resources that a security profile applies hierarchy restrictions to in Amazon Connect.
stringThe identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
arrayA list of third-party applications that the security profile will give access to.
arrayThe tags used to organize, track, or control access for this resource.
stringThe AWS Region where this resource was last modified.
numberThe timestamp when this resource was last modified.
stringAWS region.
+ +For more information, see AWS::Connect::SecurityProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_profiles in a region. +```sql +SELECT +region, +allowed_access_control_tags, +description, +instance_arn, +permissions, +security_profile_arn, +security_profile_name, +tag_restricted_resources, +hierarchy_restricted_resources, +allowed_access_control_hierarchy_group_id, +applications, +tags, +last_modified_region, +last_modified_time +FROM aws.connect.security_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_profile. +```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_profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.security_profiles ( + InstanceArn, + SecurityProfileName, + region +) +SELECT +'{{ InstanceArn }}', + '{{ SecurityProfileName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.security_profiles ( + AllowedAccessControlTags, + Description, + InstanceArn, + Permissions, + SecurityProfileName, + TagRestrictedResources, + HierarchyRestrictedResources, + AllowedAccessControlHierarchyGroupId, + Applications, + Tags, + region +) +SELECT + '{{ AllowedAccessControlTags }}', + '{{ Description }}', + '{{ InstanceArn }}', + '{{ Permissions }}', + '{{ SecurityProfileName }}', + '{{ TagRestrictedResources }}', + '{{ HierarchyRestrictedResources }}', + '{{ AllowedAccessControlHierarchyGroupId }}', + '{{ Applications }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_profile + props: + - name: AllowedAccessControlTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Description + value: '{{ Description }}' + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Permissions + value: + - '{{ Permissions[0] }}' + - name: SecurityProfileName + value: '{{ SecurityProfileName }}' + - name: TagRestrictedResources + value: + - '{{ TagRestrictedResources[0] }}' + - name: HierarchyRestrictedResources + value: + - null + - name: AllowedAccessControlHierarchyGroupId + value: '{{ AllowedAccessControlHierarchyGroupId }}' + - name: Applications + value: + - ApplicationPermissions: + - '{{ ApplicationPermissions[0] }}' + Namespace: '{{ Namespace }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.security_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the security_profiles resource, the following permissions are required: + +### Create +```json +connect:CreateSecurityProfile, +connect:TagResource +``` + +### Read +```json +connect:DescribeSecurityProfile, +connect:ListSecurityProfileApplications, +connect:ListSecurityProfilePermissions +``` + +### Update +```json +connect:TagResource, +connect:UpdateSecurityProfile, +connect:UntagResource +``` + +### Delete +```json +connect:DeleteSecurityProfile, +connect:UntagResource +``` + +### List +```json +connect:ListSecurityProfiles +``` diff --git a/website/docs/services/connect/security_profiles_list_only/index.md b/website/docs/services/connect/security_profiles_list_only/index.md new file mode 100644 index 0000000..458688e --- /dev/null +++ b/website/docs/services/connect/security_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: security_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_profiles_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_profiles in a region or regions, for all properties use security_profiles + +## Overview + + + + + + + +
Namesecurity_profiles_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::SecurityProfile
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the security profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_profiles in a region. +```sql +SELECT +region, +security_profile_arn +FROM aws.connect.security_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_profiles_list_only resource, see security_profiles + diff --git a/website/docs/services/connect/task_template_tags/index.md b/website/docs/services/connect/task_template_tags/index.md new file mode 100644 index 0000000..d55f528 --- /dev/null +++ b/website/docs/services/connect/task_template_tags/index.md @@ -0,0 +1,97 @@ +--- +title: task_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - task_template_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for task_templates in a region + +## Overview + + + + + + + +
Nametask_template_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::TaskTemplate.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier (arn) of the task template.
stringThe identifier (arn) of the instance.
stringThe name of the task template.
stringThe description of the task template.
stringThe identifier of the contact flow.
stringThe identifier of the contact flow.
objectThe constraints for the task template
array
arrayThe list of task template's fields
stringThe status of the task template
stringthe client token string in uuid format
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all task_templates in a region. +```sql +SELECT +region, +arn, +instance_arn, +name, +description, +contact_flow_arn, +self_assign_contact_flow_arn, +constraints, +defaults, +fields, +status, +client_token, +tag_key, +tag_value +FROM aws.connect.task_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_template_tags resource, see task_templates + diff --git a/website/docs/services/connect/task_templates/index.md b/website/docs/services/connect/task_templates/index.md new file mode 100644 index 0000000..50ea060 --- /dev/null +++ b/website/docs/services/connect/task_templates/index.md @@ -0,0 +1,288 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a task_template resource or lists task_templates in a region + +## Overview + + + + + + + +
Nametask_templates
TypeResource
DescriptionResource Type definition for AWS::Connect::TaskTemplate.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier (arn) of the task template.
stringThe identifier (arn) of the instance.
stringThe name of the task template.
stringThe description of the task template.
stringThe identifier of the contact flow.
stringThe identifier of the contact flow.
objectThe constraints for the task template
array
arrayThe list of task template's fields
stringThe status of the task template
stringthe client token string in uuid format
arrayOne or more tags.
stringAWS region.
+ +For more information, see AWS::Connect::TaskTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all task_templates in a region. +```sql +SELECT +region, +arn, +instance_arn, +name, +description, +contact_flow_arn, +self_assign_contact_flow_arn, +constraints, +defaults, +fields, +status, +client_token, +tags +FROM aws.connect.task_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual task_template. +```sql +SELECT +region, +arn, +instance_arn, +name, +description, +contact_flow_arn, +self_assign_contact_flow_arn, +constraints, +defaults, +fields, +status, +client_token, +tags +FROM aws.connect.task_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new task_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.task_templates ( + InstanceArn, + region +) +SELECT +'{{ InstanceArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.task_templates ( + InstanceArn, + Name, + Description, + ContactFlowArn, + SelfAssignContactFlowArn, + Constraints, + Defaults, + Fields, + Status, + ClientToken, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Name }}', + '{{ Description }}', + '{{ ContactFlowArn }}', + '{{ SelfAssignContactFlowArn }}', + '{{ Constraints }}', + '{{ Defaults }}', + '{{ Fields }}', + '{{ Status }}', + '{{ ClientToken }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: task_template + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: ContactFlowArn + value: '{{ ContactFlowArn }}' + - name: SelfAssignContactFlowArn + value: '{{ SelfAssignContactFlowArn }}' + - name: Constraints + value: + InvisibleFields: + - Id: + Name: '{{ Name }}' + RequiredFields: + - Id: null + ReadOnlyFields: + - Id: null + - name: Defaults + value: + - Id: null + DefaultValue: '{{ DefaultValue }}' + - name: Fields + value: + - Id: null + Description: '{{ Description }}' + Type: '{{ Type }}' + SingleSelectOptions: + - '{{ SingleSelectOptions[0] }}' + - name: Status + value: '{{ Status }}' + - name: ClientToken + value: '{{ ClientToken }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.task_templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the task_templates resource, the following permissions are required: + +### Create +```json +connect:CreateTaskTemplate, +connect:TagResource +``` + +### Read +```json +connect:GetTaskTemplate +``` + +### List +```json +connect:ListTaskTemplates +``` + +### Update +```json +connect:UpdateTaskTemplate, +connect:TagResource, +connect:UntagResource +``` + +### Delete +```json +connect:DeleteTaskTemplate, +connect:UntagResource, +connect:GetTaskTemplate +``` diff --git a/website/docs/services/connect/task_templates_list_only/index.md b/website/docs/services/connect/task_templates_list_only/index.md new file mode 100644 index 0000000..76ef62a --- /dev/null +++ b/website/docs/services/connect/task_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: task_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - task_templates_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists task_templates in a region or regions, for all properties use task_templates + +## Overview + + + + + + + +
Nametask_templates_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::TaskTemplate.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier (arn) of the task template.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all task_templates in a region. +```sql +SELECT +region, +arn +FROM aws.connect.task_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_templates_list_only resource, see task_templates + diff --git a/website/docs/services/connect/traffic_distribution_group_tags/index.md b/website/docs/services/connect/traffic_distribution_group_tags/index.md new file mode 100644 index 0000000..814eb7c --- /dev/null +++ b/website/docs/services/connect/traffic_distribution_group_tags/index.md @@ -0,0 +1,87 @@ +--- +title: traffic_distribution_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_distribution_group_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for traffic_distribution_groups in a region + +## Overview + + + + + + + +
Nametraffic_distribution_group_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::TrafficDistributionGroup
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance that has been replicated.
stringThe identifier of the traffic distribution group.
stringA description for the traffic distribution group.
stringThe name for the traffic distribution group.
stringThe status of the traffic distribution group.
booleanIf this is the default traffic distribution group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all traffic_distribution_groups in a region. +```sql +SELECT +region, +instance_arn, +traffic_distribution_group_arn, +description, +name, +status, +is_default, +tag_key, +tag_value +FROM aws.connect.traffic_distribution_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the traffic_distribution_group_tags resource, see traffic_distribution_groups + diff --git a/website/docs/services/connect/traffic_distribution_groups/index.md b/website/docs/services/connect/traffic_distribution_groups/index.md new file mode 100644 index 0000000..4e48197 --- /dev/null +++ b/website/docs/services/connect/traffic_distribution_groups/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a traffic_distribution_group resource or lists traffic_distribution_groups in a region + +## Overview + + + + + + + +
Nametraffic_distribution_groups
TypeResource
DescriptionResource Type definition for AWS::Connect::TrafficDistributionGroup
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance that has been replicated.
stringThe identifier of the traffic distribution group.
stringA description for the traffic distribution group.
stringThe name for the traffic distribution group.
stringThe status of the traffic distribution group.
arrayOne or more tags.
booleanIf this is the default traffic distribution group.
stringAWS region.
+ +For more information, see AWS::Connect::TrafficDistributionGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all traffic_distribution_groups in a region. +```sql +SELECT +region, +instance_arn, +traffic_distribution_group_arn, +description, +name, +status, +tags, +is_default +FROM aws.connect.traffic_distribution_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual traffic_distribution_group. +```sql +SELECT +region, +instance_arn, +traffic_distribution_group_arn, +description, +name, +status, +tags, +is_default +FROM aws.connect.traffic_distribution_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new traffic_distribution_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.traffic_distribution_groups ( + InstanceArn, + Name, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.traffic_distribution_groups ( + InstanceArn, + Description, + Name, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Description }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: traffic_distribution_group + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.traffic_distribution_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +connect:DescribeTrafficDistributionGroup +``` + +### Update +```json +connect:TagResource, +connect:UntagResource +``` + +### Delete +```json +connect:DeleteTrafficDistributionGroup, +connect:DescribeTrafficDistributionGroup, +connect:UntagResource +``` + +### List +```json +connect:ListTrafficDistributionGroups +``` diff --git a/website/docs/services/connect/traffic_distribution_groups_list_only/index.md b/website/docs/services/connect/traffic_distribution_groups_list_only/index.md new file mode 100644 index 0000000..7cae92e --- /dev/null +++ b/website/docs/services/connect/traffic_distribution_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: traffic_distribution_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_distribution_groups_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists traffic_distribution_groups in a region or regions, for all properties use traffic_distribution_groups + +## Overview + + + + + + + +
Nametraffic_distribution_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::TrafficDistributionGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier of the traffic distribution group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all traffic_distribution_groups in a region. +```sql +SELECT +region, +traffic_distribution_group_arn +FROM aws.connect.traffic_distribution_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the traffic_distribution_groups_list_only resource, see traffic_distribution_groups + diff --git a/website/docs/services/connect/user_hierarchy_group_tags/index.md b/website/docs/services/connect/user_hierarchy_group_tags/index.md new file mode 100644 index 0000000..ad9e8fa --- /dev/null +++ b/website/docs/services/connect/user_hierarchy_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: user_hierarchy_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_hierarchy_group_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for user_hierarchy_groups in a region + +## Overview + + + + + + + +
Nameuser_hierarchy_group_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::UserHierarchyGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe Amazon Resource Name (ARN) for the user hierarchy group.
stringThe Amazon Resource Name (ARN) for the parent user hierarchy group.
stringThe name of the user hierarchy group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all user_hierarchy_groups in a region. +```sql +SELECT +region, +instance_arn, +user_hierarchy_group_arn, +parent_group_arn, +name, +tag_key, +tag_value +FROM aws.connect.user_hierarchy_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_hierarchy_group_tags resource, see user_hierarchy_groups + diff --git a/website/docs/services/connect/user_hierarchy_groups/index.md b/website/docs/services/connect/user_hierarchy_groups/index.md new file mode 100644 index 0000000..37005dc --- /dev/null +++ b/website/docs/services/connect/user_hierarchy_groups/index.md @@ -0,0 +1,226 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_hierarchy_group resource or lists user_hierarchy_groups in a region + +## Overview + + + + + + + +
Nameuser_hierarchy_groups
TypeResource
DescriptionResource Type definition for AWS::Connect::UserHierarchyGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe Amazon Resource Name (ARN) for the user hierarchy group.
stringThe Amazon Resource Name (ARN) for the parent user hierarchy group.
stringThe name of the user hierarchy group.
arrayOne or more tags.
stringAWS region.
+ +For more information, see AWS::Connect::UserHierarchyGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_hierarchy_groups in a region. +```sql +SELECT +region, +instance_arn, +user_hierarchy_group_arn, +parent_group_arn, +name, +tags +FROM aws.connect.user_hierarchy_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_hierarchy_group. +```sql +SELECT +region, +instance_arn, +user_hierarchy_group_arn, +parent_group_arn, +name, +tags +FROM aws.connect.user_hierarchy_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_hierarchy_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.user_hierarchy_groups ( + InstanceArn, + Name, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.user_hierarchy_groups ( + InstanceArn, + ParentGroupArn, + Name, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ ParentGroupArn }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_hierarchy_group + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: ParentGroupArn + value: '{{ ParentGroupArn }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.user_hierarchy_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the user_hierarchy_groups resource, the following permissions are required: + +### Create +```json +connect:CreateUserHierarchyGroup, +connect:TagResource +``` + +### Read +```json +connect:DescribeUserHierarchyGroup +``` + +### Delete +```json +connect:DeleteUserHierarchyGroup, +connect:UntagResource +``` + +### Update +```json +connect:UpdateUserHierarchyGroupName, +connect:TagResource, +connect:UntagResource +``` + +### List +```json +connect:ListUserHierarchyGroups +``` diff --git a/website/docs/services/connect/user_hierarchy_groups_list_only/index.md b/website/docs/services/connect/user_hierarchy_groups_list_only/index.md new file mode 100644 index 0000000..12e0282 --- /dev/null +++ b/website/docs/services/connect/user_hierarchy_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: user_hierarchy_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_hierarchy_groups_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_hierarchy_groups in a region or regions, for all properties use user_hierarchy_groups + +## Overview + + + + + + + +
Nameuser_hierarchy_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::UserHierarchyGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the user hierarchy group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_hierarchy_groups in a region. +```sql +SELECT +region, +user_hierarchy_group_arn +FROM aws.connect.user_hierarchy_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_hierarchy_groups_list_only resource, see user_hierarchy_groups + diff --git a/website/docs/services/connect/user_hierarchy_structures/index.md b/website/docs/services/connect/user_hierarchy_structures/index.md new file mode 100644 index 0000000..3fc61dd --- /dev/null +++ b/website/docs/services/connect/user_hierarchy_structures/index.md @@ -0,0 +1,205 @@ +--- +title: user_hierarchy_structures +hide_title: false +hide_table_of_contents: false +keywords: + - user_hierarchy_structures + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_hierarchy_structure resource or lists user_hierarchy_structures in a region + +## Overview + + + + + + + +
Nameuser_hierarchy_structures
TypeResource
DescriptionResource Type definition for AWS::Connect::UserHierarchyStructure
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe identifier of the User Hierarchy Structure.
objectInformation about the hierarchy structure.
stringAWS region.
+ +For more information, see AWS::Connect::UserHierarchyStructure. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual user_hierarchy_structure. +```sql +SELECT +region, +instance_arn, +user_hierarchy_structure_arn, +user_hierarchy_structure +FROM aws.connect.user_hierarchy_structures +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_hierarchy_structure resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.user_hierarchy_structures ( + InstanceArn, + region +) +SELECT +'{{ InstanceArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.user_hierarchy_structures ( + InstanceArn, + UserHierarchyStructure, + region +) +SELECT + '{{ InstanceArn }}', + '{{ UserHierarchyStructure }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_hierarchy_structure + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: UserHierarchyStructure + value: + LevelOne: + HierarchyLevelArn: '{{ HierarchyLevelArn }}' + HierarchyLevelId: '{{ HierarchyLevelId }}' + Name: '{{ Name }}' + LevelTwo: + HierarchyLevelArn: null + HierarchyLevelId: null + Name: null + LevelThree: + HierarchyLevelArn: null + HierarchyLevelId: null + Name: null + LevelFour: + HierarchyLevelArn: null + HierarchyLevelId: null + Name: null + LevelFive: + HierarchyLevelArn: null + HierarchyLevelId: null + Name: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.user_hierarchy_structures +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the user_hierarchy_structures resource, the following permissions are required: + +### Create +```json +connect:UpdateUserHierarchyStructure +``` + +### Read +```json +connect:DescribeUserHierarchyStructure +``` + +### Delete +```json +connect:UpdateUserHierarchyStructure +``` + +### Update +```json +connect:UpdateUserHierarchyStructure +``` diff --git a/website/docs/services/connect/user_tags/index.md b/website/docs/services/connect/user_tags/index.md new file mode 100644 index 0000000..84a5cc3 --- /dev/null +++ b/website/docs/services/connect/user_tags/index.md @@ -0,0 +1,97 @@ +--- +title: user_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for users in a region + +## Overview + + + + + + + +
Nameuser_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::User
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe identifier of the user account in the directory used for identity management.
stringThe identifier of the hierarchy group for the user.
stringThe user name for the account.
stringThe password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
stringThe identifier of the routing profile for the user.
objectThe information about the identity of the user.
objectThe phone settings for the user.
arrayOne or more security profile arns for the user
stringThe Amazon Resource Name (ARN) for the user.
arrayOne or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all users in a region. +```sql +SELECT +region, +instance_arn, +directory_user_id, +hierarchy_group_arn, +username, +password, +routing_profile_arn, +identity_info, +phone_config, +security_profile_arns, +user_arn, +user_proficiencies, +tag_key, +tag_value +FROM aws.connect.user_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_tags resource, see users + diff --git a/website/docs/services/connect/users/index.md b/website/docs/services/connect/users/index.md new file mode 100644 index 0000000..bdc7a25 --- /dev/null +++ b/website/docs/services/connect/users/index.md @@ -0,0 +1,303 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a user resource or lists users in a region + +## Overview + + + + + + + +
Nameusers
TypeResource
DescriptionResource Type definition for AWS::Connect::User
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe identifier of the user account in the directory used for identity management.
stringThe identifier of the hierarchy group for the user.
stringThe user name for the account.
stringThe password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
stringThe identifier of the routing profile for the user.
objectThe information about the identity of the user.
objectThe phone settings for the user.
arrayOne or more security profile arns for the user
stringThe Amazon Resource Name (ARN) for the user.
arrayOne or more tags.
arrayOne or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
stringAWS region.
+ +For more information, see AWS::Connect::User. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all users in a region. +```sql +SELECT +region, +instance_arn, +directory_user_id, +hierarchy_group_arn, +username, +password, +routing_profile_arn, +identity_info, +phone_config, +security_profile_arns, +user_arn, +tags, +user_proficiencies +FROM aws.connect.users +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user. +```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.users +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.users ( + InstanceArn, + Username, + RoutingProfileArn, + PhoneConfig, + SecurityProfileArns, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Username }}', + '{{ RoutingProfileArn }}', + '{{ PhoneConfig }}', + '{{ SecurityProfileArns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.users ( + InstanceArn, + DirectoryUserId, + HierarchyGroupArn, + Username, + Password, + RoutingProfileArn, + IdentityInfo, + PhoneConfig, + SecurityProfileArns, + Tags, + UserProficiencies, + region +) +SELECT + '{{ InstanceArn }}', + '{{ DirectoryUserId }}', + '{{ HierarchyGroupArn }}', + '{{ Username }}', + '{{ Password }}', + '{{ RoutingProfileArn }}', + '{{ IdentityInfo }}', + '{{ PhoneConfig }}', + '{{ SecurityProfileArns }}', + '{{ Tags }}', + '{{ UserProficiencies }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: DirectoryUserId + value: '{{ DirectoryUserId }}' + - name: HierarchyGroupArn + value: '{{ HierarchyGroupArn }}' + - name: Username + value: '{{ Username }}' + - name: Password + value: '{{ Password }}' + - name: RoutingProfileArn + value: '{{ RoutingProfileArn }}' + - name: IdentityInfo + value: + FirstName: '{{ FirstName }}' + LastName: '{{ LastName }}' + Email: '{{ Email }}' + SecondaryEmail: '{{ SecondaryEmail }}' + Mobile: '{{ Mobile }}' + - name: PhoneConfig + value: + AfterContactWorkTimeLimit: '{{ AfterContactWorkTimeLimit }}' + AutoAccept: '{{ AutoAccept }}' + DeskPhoneNumber: '{{ DeskPhoneNumber }}' + PhoneType: '{{ PhoneType }}' + - name: SecurityProfileArns + value: + - '{{ SecurityProfileArns[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: UserProficiencies + value: + - AttributeName: '{{ AttributeName }}' + AttributeValue: '{{ AttributeValue }}' + Level: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.users +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the users resource, the following permissions are required: + +### Create +```json +connect:CreateUser, +connect:TagResource, +connect:AssociateUserProficiencies +``` + +### 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 +``` + +### List +```json +connect:ListUsers +``` diff --git a/website/docs/services/connect/users_list_only/index.md b/website/docs/services/connect/users_list_only/index.md new file mode 100644 index 0000000..6b9c728 --- /dev/null +++ b/website/docs/services/connect/users_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - users_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists users in a region or regions, for all properties use users + +## Overview + + + + + + + +
Nameusers_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::User
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the user.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all users in a region. +```sql +SELECT +region, +user_arn +FROM aws.connect.users_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the users_list_only resource, see users + diff --git a/website/docs/services/connect/view_tags/index.md b/website/docs/services/connect/view_tags/index.md new file mode 100644 index 0000000..0a5d89a --- /dev/null +++ b/website/docs/services/connect/view_tags/index.md @@ -0,0 +1,91 @@ +--- +title: view_tags +hide_title: false +hide_table_of_contents: false +keywords: + - view_tags + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for views in a region + +## Overview + + + + + + + +
Nameview_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::View
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the instance.
stringThe Amazon Resource Name (ARN) of the view.
stringThe view id of the view.
stringThe name of the view.
stringThe description of the view.
objectThe template of the view as JSON.
arrayThe actions of the view in an array.
stringThe view content hash.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all views in a region. +```sql +SELECT +region, +instance_arn, +view_arn, +view_id, +name, +description, +template, +actions, +view_content_sha256, +tag_key, +tag_value +FROM aws.connect.view_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the view_tags resource, see views + diff --git a/website/docs/services/connect/view_versions/index.md b/website/docs/services/connect/view_versions/index.md new file mode 100644 index 0000000..2632817 --- /dev/null +++ b/website/docs/services/connect/view_versions/index.md @@ -0,0 +1,204 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a view_version resource or lists view_versions in a region + +## Overview + + + + + + + +
Nameview_versions
TypeResource
DescriptionResource Type definition for AWS::Connect::ViewVersion
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the view for which a version is being created.
stringThe Amazon Resource Name (ARN) of the created view version.
stringThe description for the view version.
stringThe view content hash to be checked.
integerThe version of the view.
stringAWS region.
+ +For more information, see AWS::Connect::ViewVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all view_versions in a region. +```sql +SELECT +region, +view_arn, +view_version_arn, +version_description, +view_content_sha256, +version +FROM aws.connect.view_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual view_version. +```sql +SELECT +region, +view_arn, +view_version_arn, +version_description, +view_content_sha256, +version +FROM aws.connect.view_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new view_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.view_versions ( + ViewArn, + region +) +SELECT +'{{ ViewArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.view_versions ( + ViewArn, + VersionDescription, + ViewContentSha256, + region +) +SELECT + '{{ ViewArn }}', + '{{ VersionDescription }}', + '{{ ViewContentSha256 }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: view_version + props: + - name: ViewArn + value: '{{ ViewArn }}' + - name: VersionDescription + value: '{{ VersionDescription }}' + - name: ViewContentSha256 + value: '{{ ViewContentSha256 }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.view_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the view_versions resource, the following permissions are required: + +### Create +```json +connect:CreateViewVersion +``` + +### Read +```json +connect:DescribeView +``` + +### List +```json +connect:ListViewVersions +``` + +### Delete +```json +connect:DeleteViewVersion +``` diff --git a/website/docs/services/connect/view_versions_list_only/index.md b/website/docs/services/connect/view_versions_list_only/index.md new file mode 100644 index 0000000..cb22740 --- /dev/null +++ b/website/docs/services/connect/view_versions_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: view_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - view_versions_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists view_versions in a region or regions, for all properties use view_versions + +## Overview + + + + + + + +
Nameview_versions_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::ViewVersion
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the created view version.
integerThe version of the view.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all view_versions in a region. +```sql +SELECT +region, +view_version_arn +FROM aws.connect.view_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the view_versions_list_only resource, see view_versions + diff --git a/website/docs/services/connect/views/index.md b/website/docs/services/connect/views/index.md new file mode 100644 index 0000000..d4d8c60 --- /dev/null +++ b/website/docs/services/connect/views/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a view resource or lists views in a region + +## Overview + + + + + + + +
Nameviews
TypeResource
DescriptionResource Type definition for AWS::Connect::View
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the instance.
stringThe Amazon Resource Name (ARN) of the view.
stringThe view id of the view.
stringThe name of the view.
stringThe description of the view.
objectThe template of the view as JSON.
arrayThe actions of the view in an array.
stringThe view content hash.
arrayOne or more tags.
stringAWS region.
+ +For more information, see AWS::Connect::View. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all views in a region. +```sql +SELECT +region, +instance_arn, +view_arn, +view_id, +name, +description, +template, +actions, +view_content_sha256, +tags +FROM aws.connect.views +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual view. +```sql +SELECT +region, +instance_arn, +view_arn, +view_id, +name, +description, +template, +actions, +view_content_sha256, +tags +FROM aws.connect.views +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new view resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connect.views ( + InstanceArn, + Name, + Template, + Actions, + region +) +SELECT +'{{ InstanceArn }}', + '{{ Name }}', + '{{ Template }}', + '{{ Actions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connect.views ( + InstanceArn, + Name, + Description, + Template, + Actions, + Tags, + region +) +SELECT + '{{ InstanceArn }}', + '{{ Name }}', + '{{ Description }}', + '{{ Template }}', + '{{ Actions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: view + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Template + value: {} + - name: Actions + value: + - '{{ Actions[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connect.views +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the views resource, the following permissions are required: + +### Create +```json +connect:CreateView, +connect:TagResource +``` + +### Read +```json +connect:DescribeView +``` + +### Delete +```json +connect:DeleteView, +connect:UntagResource +``` + +### List +```json +connect:ListViews +``` + +### Update +```json +connect:UpdateViewMetadata, +connect:UpdateViewContent, +connect:TagResource, +connect:UntagResource +``` diff --git a/website/docs/services/connect/views_list_only/index.md b/website/docs/services/connect/views_list_only/index.md new file mode 100644 index 0000000..ef4ac8f --- /dev/null +++ b/website/docs/services/connect/views_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: views_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - views_list_only + - connect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists views in a region or regions, for all properties use views + +## Overview + + + + + + + +
Nameviews_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::View
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the view.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all views in a region. +```sql +SELECT +region, +view_arn +FROM aws.connect.views_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the views_list_only resource, see views + diff --git a/website/docs/services/connectcampaigns/campaign_tags/index.md b/website/docs/services/connectcampaigns/campaign_tags/index.md new file mode 100644 index 0000000..dfa644e --- /dev/null +++ b/website/docs/services/connectcampaigns/campaign_tags/index.md @@ -0,0 +1,85 @@ +--- +title: campaign_tags +hide_title: false +hide_table_of_contents: false +keywords: + - campaign_tags + - connectcampaigns + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for campaigns in a region + +## Overview + + + + + + + +
Namecampaign_tags
TypeResource
DescriptionDefinition of AWS::ConnectCampaigns::Campaign Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Connect Instance Arn
objectThe possible types of dialer config parameters
stringAmazon Connect Campaign Arn
stringAmazon Connect Campaign Name
objectThe configuration used for outbound calls.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all campaigns in a region. +```sql +SELECT +region, +connect_instance_arn, +dialer_config, +arn, +name, +outbound_call_config, +tag_key, +tag_value +FROM aws.connectcampaigns.campaign_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the campaign_tags resource, see campaigns + diff --git a/website/docs/services/connectcampaigns/campaigns/index.md b/website/docs/services/connectcampaigns/campaigns/index.md new file mode 100644 index 0000000..a7a89ea --- /dev/null +++ b/website/docs/services/connectcampaigns/campaigns/index.md @@ -0,0 +1,257 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a campaign resource or lists campaigns in a region + +## Overview + + + + + + + +
Namecampaigns
TypeResource
DescriptionDefinition of AWS::ConnectCampaigns::Campaign Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Connect Instance Arn
objectThe possible types of dialer config parameters
stringAmazon Connect Campaign Arn
stringAmazon Connect Campaign Name
objectThe configuration used for outbound calls.
arrayOne or more tags.
stringAWS region.
+ +For more information, see AWS::ConnectCampaigns::Campaign. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all campaigns in a region. +```sql +SELECT +region, +connect_instance_arn, +dialer_config, +arn, +name, +outbound_call_config, +tags +FROM aws.connectcampaigns.campaigns +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual campaign. +```sql +SELECT +region, +connect_instance_arn, +dialer_config, +arn, +name, +outbound_call_config, +tags +FROM aws.connectcampaigns.campaigns +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new campaign resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connectcampaigns.campaigns ( + ConnectInstanceArn, + DialerConfig, + Name, + OutboundCallConfig, + region +) +SELECT +'{{ ConnectInstanceArn }}', + '{{ DialerConfig }}', + '{{ Name }}', + '{{ OutboundCallConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connectcampaigns.campaigns ( + ConnectInstanceArn, + DialerConfig, + Name, + OutboundCallConfig, + Tags, + region +) +SELECT + '{{ ConnectInstanceArn }}', + '{{ DialerConfig }}', + '{{ Name }}', + '{{ OutboundCallConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: campaign + props: + - name: ConnectInstanceArn + value: '{{ ConnectInstanceArn }}' + - name: DialerConfig + value: + ProgressiveDialerConfig: + BandwidthAllocation: null + DialingCapacity: null + PredictiveDialerConfig: + BandwidthAllocation: null + DialingCapacity: null + AgentlessDialerConfig: + DialingCapacity: null + - name: Name + value: '{{ Name }}' + - name: OutboundCallConfig + value: + ConnectContactFlowArn: '{{ ConnectContactFlowArn }}' + ConnectSourcePhoneNumber: '{{ ConnectSourcePhoneNumber }}' + ConnectQueueArn: '{{ ConnectQueueArn }}' + AnswerMachineDetectionConfig: + EnableAnswerMachineDetection: '{{ EnableAnswerMachineDetection }}' + AwaitAnswerMachinePrompt: '{{ AwaitAnswerMachinePrompt }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connectcampaigns.campaigns +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +connect-campaigns:DescribeCampaign +``` + +### Delete +```json +connect-campaigns:DeleteCampaign +``` + +### List +```json +connect-campaigns:ListCampaigns +``` + +### Update +```json +connect-campaigns:UpdateCampaignDialerConfig, +connect-campaigns:UpdateCampaignName, +connect-campaigns:UpdateCampaignOutboundCallConfig, +connect-campaigns:TagResource, +connect-campaigns:UntagResource, +connect-campaigns:DescribeCampaign +``` diff --git a/website/docs/services/connectcampaigns/campaigns_list_only/index.md b/website/docs/services/connectcampaigns/campaigns_list_only/index.md new file mode 100644 index 0000000..73a7b15 --- /dev/null +++ b/website/docs/services/connectcampaigns/campaigns_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: campaigns_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - campaigns_list_only + - connectcampaigns + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists campaigns in a region or regions, for all properties use campaigns + +## Overview + + + + + + + +
Namecampaigns_list_only
TypeResource
DescriptionDefinition of AWS::ConnectCampaigns::Campaign Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Connect Campaign Arn
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all campaigns in a region. +```sql +SELECT +region, +arn +FROM aws.connectcampaigns.campaigns_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the campaigns_list_only resource, see campaigns + diff --git a/website/docs/services/connectcampaigns/index.md b/website/docs/services/connectcampaigns/index.md new file mode 100644 index 0000000..dd1cda6 --- /dev/null +++ b/website/docs/services/connectcampaigns/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The connectcampaigns service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/connectcampaignsv2/campaign_tags/index.md b/website/docs/services/connectcampaignsv2/campaign_tags/index.md new file mode 100644 index 0000000..6f9a6d7 --- /dev/null +++ b/website/docs/services/connectcampaignsv2/campaign_tags/index.md @@ -0,0 +1,93 @@ +--- +title: campaign_tags +hide_title: false +hide_table_of_contents: false +keywords: + - campaign_tags + - connectcampaignsv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for campaigns in a region + +## Overview + + + + + + + +
Namecampaign_tags
TypeResource
DescriptionDefinition of AWS::ConnectCampaignsV2::Campaign Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Connect Campaign Arn
stringCampaign name
stringAmazon Connect Instance Id
objectThe possible types of channel subtype config parameters
objectThe possible source of the campaign
stringArn
objectCampaign schedule
objectCampaign communication time config
objectCommunication limits config
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all campaigns in a region. +```sql +SELECT +region, +arn, +name, +connect_instance_id, +channel_subtype_config, +source, +connect_campaign_flow_arn, +schedule, +communication_time_config, +communication_limits_override, +tag_key, +tag_value +FROM aws.connectcampaignsv2.campaign_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the campaign_tags resource, see campaigns + diff --git a/website/docs/services/connectcampaignsv2/campaigns/index.md b/website/docs/services/connectcampaignsv2/campaigns/index.md new file mode 100644 index 0000000..d6c4a65 --- /dev/null +++ b/website/docs/services/connectcampaignsv2/campaigns/index.md @@ -0,0 +1,348 @@ +--- +title: campaigns +hide_title: false +hide_table_of_contents: false +keywords: + - campaigns + - connectcampaignsv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a campaign resource or lists campaigns in a region + +## Overview + + + + + + + +
Namecampaigns
TypeResource
DescriptionDefinition of AWS::ConnectCampaignsV2::Campaign Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Connect Campaign Arn
stringCampaign name
stringAmazon Connect Instance Id
objectThe possible types of channel subtype config parameters
objectThe possible source of the campaign
stringArn
objectCampaign schedule
objectCampaign communication time config
objectCommunication limits config
arrayOne or more tags.
stringAWS region.
+ +For more information, see AWS::ConnectCampaignsV2::Campaign. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all campaigns in a region. +```sql +SELECT +region, +arn, +name, +connect_instance_id, +channel_subtype_config, +source, +connect_campaign_flow_arn, +schedule, +communication_time_config, +communication_limits_override, +tags +FROM aws.connectcampaignsv2.campaigns +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual campaign. +```sql +SELECT +region, +arn, +name, +connect_instance_id, +channel_subtype_config, +source, +connect_campaign_flow_arn, +schedule, +communication_time_config, +communication_limits_override, +tags +FROM aws.connectcampaignsv2.campaigns +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new campaign resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.connectcampaignsv2.campaigns ( + Name, + ConnectInstanceId, + ChannelSubtypeConfig, + region +) +SELECT +'{{ Name }}', + '{{ ConnectInstanceId }}', + '{{ ChannelSubtypeConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.connectcampaignsv2.campaigns ( + Name, + ConnectInstanceId, + ChannelSubtypeConfig, + Source, + ConnectCampaignFlowArn, + Schedule, + CommunicationTimeConfig, + CommunicationLimitsOverride, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ ConnectInstanceId }}', + '{{ ChannelSubtypeConfig }}', + '{{ Source }}', + '{{ ConnectCampaignFlowArn }}', + '{{ Schedule }}', + '{{ CommunicationTimeConfig }}', + '{{ CommunicationLimitsOverride }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: campaign + props: + - name: Name + value: '{{ Name }}' + - name: ConnectInstanceId + value: '{{ ConnectInstanceId }}' + - name: ChannelSubtypeConfig + value: + Telephony: + Capacity: null + ConnectQueueId: '{{ ConnectQueueId }}' + OutboundMode: + ProgressiveConfig: + BandwidthAllocation: null + PredictiveConfig: + BandwidthAllocation: null + AgentlessConfig: {} + DefaultOutboundConfig: + ConnectContactFlowId: '{{ ConnectContactFlowId }}' + ConnectSourcePhoneNumber: '{{ ConnectSourcePhoneNumber }}' + AnswerMachineDetectionConfig: + EnableAnswerMachineDetection: '{{ EnableAnswerMachineDetection }}' + AwaitAnswerMachinePrompt: '{{ AwaitAnswerMachinePrompt }}' + Sms: + Capacity: null + OutboundMode: + AgentlessConfig: null + DefaultOutboundConfig: + ConnectSourcePhoneNumberArn: '{{ ConnectSourcePhoneNumberArn }}' + WisdomTemplateArn: null + Email: + Capacity: null + OutboundMode: + AgentlessConfig: null + DefaultOutboundConfig: + ConnectSourceEmailAddress: '{{ ConnectSourceEmailAddress }}' + SourceEmailAddressDisplayName: '{{ SourceEmailAddressDisplayName }}' + WisdomTemplateArn: null + - name: Source + value: + CustomerProfilesSegmentArn: null + EventTrigger: + CustomerProfilesDomainArn: null + - name: ConnectCampaignFlowArn + value: null + - name: Schedule + value: + StartTime: '{{ StartTime }}' + EndTime: null + RefreshFrequency: '{{ RefreshFrequency }}' + - name: CommunicationTimeConfig + value: + LocalTimeZoneConfig: + DefaultTimeZone: '{{ DefaultTimeZone }}' + LocalTimeZoneDetection: + - '{{ LocalTimeZoneDetection[0] }}' + Telephony: + OpenHours: + DailyHours: + - Key: '{{ Key }}' + Value: + - StartTime: '{{ StartTime }}' + EndTime: null + RestrictedPeriods: + RestrictedPeriodList: + - Name: '{{ Name }}' + StartDate: '{{ StartDate }}' + EndDate: null + Sms: null + Email: null + - name: CommunicationLimitsOverride + value: + AllChannelsSubtypes: + CommunicationLimitList: + - MaxCountPerRecipient: '{{ MaxCountPerRecipient }}' + Frequency: '{{ Frequency }}' + Unit: '{{ Unit }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.connectcampaignsv2.campaigns +WHERE data__Identifier = '' +AND 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:DescribeEmailAddress, +connect:DescribeInstance, +connect:DescribePhoneNumber, +connect:DescribeQueue, +profile:GetSegmentDefinition, +wisdom:GetMessageTemplate +``` + +### Read +```json +connect-campaigns:DescribeCampaign +``` + +### Delete +```json +connect-campaigns:DeleteCampaign, +connect-campaigns:DeleteCampaignChannelSubtypeConfig, +connect-campaigns:DeleteCampaignCommunicationLimits, +connect-campaigns:DeleteCampaignCommunicationTime +``` + +### List +```json +connect-campaigns:ListCampaigns +``` + +### Update +```json +connect-campaigns:DeleteCampaignChannelSubtypeConfig, +connect-campaigns:DeleteCampaignCommunicationLimits, +connect-campaigns:DeleteCampaignCommunicationTime, +connect-campaigns:UpdateCampaignChannelSubtypeConfig, +connect-campaigns:UpdateCampaignCommunicationLimits, +connect-campaigns:UpdateCampaignCommunicationTime, +connect-campaigns:UpdateCampaignName, +connect-campaigns:UpdateCampaignFlowAssociation, +connect-campaigns:UpdateCampaignSchedule, +connect-campaigns:UpdateCampaignSource, +connect-campaigns:TagResource, +connect-campaigns:UntagResource, +connect-campaigns:DescribeCampaign, +connect:DescribeContactFlow, +connect:DescribeEmailAddress, +connect:DescribePhoneNumber, +connect:DescribeQueue, +profile:GetSegmentDefinition, +wisdom:GetMessageTemplate +``` diff --git a/website/docs/services/connectcampaignsv2/campaigns_list_only/index.md b/website/docs/services/connectcampaignsv2/campaigns_list_only/index.md new file mode 100644 index 0000000..f1af598 --- /dev/null +++ b/website/docs/services/connectcampaignsv2/campaigns_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: campaigns_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - campaigns_list_only + - connectcampaignsv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists campaigns in a region or regions, for all properties use campaigns + +## Overview + + + + + + + +
Namecampaigns_list_only
TypeResource
DescriptionDefinition of AWS::ConnectCampaignsV2::Campaign Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Connect Campaign Arn
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all campaigns in a region. +```sql +SELECT +region, +arn +FROM aws.connectcampaignsv2.campaigns_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the campaigns_list_only resource, see campaigns + diff --git a/website/docs/services/connectcampaignsv2/index.md b/website/docs/services/connectcampaignsv2/index.md new file mode 100644 index 0000000..aaa6b3c --- /dev/null +++ b/website/docs/services/connectcampaignsv2/index.md @@ -0,0 +1,38 @@ +--- +title: connectcampaignsv2 +hide_title: false +hide_table_of_contents: false +keywords: + - connectcampaignsv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The connectcampaignsv2 service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/controltower/enabled_baseline_tags/index.md b/website/docs/services/controltower/enabled_baseline_tags/index.md new file mode 100644 index 0000000..78cd1d5 --- /dev/null +++ b/website/docs/services/controltower/enabled_baseline_tags/index.md @@ -0,0 +1,85 @@ +--- +title: enabled_baseline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_baseline_tags + - controltower + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for enabled_baselines in a region + +## Overview + + + + + + + +
Nameenabled_baseline_tags
TypeResource
DescriptionDefinition of AWS::ControlTower::EnabledBaseline Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all enabled_baselines in a region. +```sql +SELECT +region, +baseline_identifier, +baseline_version, +enabled_baseline_identifier, +target_identifier, +parameters, +tag_key, +tag_value +FROM aws.controltower.enabled_baseline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the enabled_baseline_tags resource, see enabled_baselines + diff --git a/website/docs/services/controltower/enabled_baselines/index.md b/website/docs/services/controltower/enabled_baselines/index.md new file mode 100644 index 0000000..2d48dca --- /dev/null +++ b/website/docs/services/controltower/enabled_baselines/index.md @@ -0,0 +1,310 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an enabled_baseline resource or lists enabled_baselines in a region + +## Overview + + + + + + + +
Nameenabled_baselines
TypeResource
DescriptionDefinition of AWS::ControlTower::EnabledBaseline Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
array
stringAWS region.
+ +For more information, see AWS::ControlTower::EnabledBaseline. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all enabled_baselines in a region. +```sql +SELECT +region, +baseline_identifier, +baseline_version, +enabled_baseline_identifier, +target_identifier, +parameters, +tags +FROM aws.controltower.enabled_baselines +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual enabled_baseline. +```sql +SELECT +region, +baseline_identifier, +baseline_version, +enabled_baseline_identifier, +target_identifier, +parameters, +tags +FROM aws.controltower.enabled_baselines +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new enabled_baseline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.controltower.enabled_baselines ( + BaselineIdentifier, + BaselineVersion, + TargetIdentifier, + region +) +SELECT +'{{ BaselineIdentifier }}', + '{{ BaselineVersion }}', + '{{ TargetIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.controltower.enabled_baselines ( + BaselineIdentifier, + BaselineVersion, + TargetIdentifier, + Parameters, + Tags, + region +) +SELECT + '{{ BaselineIdentifier }}', + '{{ BaselineVersion }}', + '{{ TargetIdentifier }}', + '{{ Parameters }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: enabled_baseline + props: + - name: BaselineIdentifier + value: '{{ BaselineIdentifier }}' + - name: BaselineVersion + value: '{{ BaselineVersion }}' + - name: TargetIdentifier + value: '{{ TargetIdentifier }}' + - name: Parameters + value: + - Key: '{{ Key }}' + Value: null + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.controltower.enabled_baselines +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +controltower:ListEnabledBaselines +``` diff --git a/website/docs/services/controltower/enabled_baselines_list_only/index.md b/website/docs/services/controltower/enabled_baselines_list_only/index.md new file mode 100644 index 0000000..20e0f3a --- /dev/null +++ b/website/docs/services/controltower/enabled_baselines_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: enabled_baselines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_baselines_list_only + - controltower + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists enabled_baselines in a region or regions, for all properties use enabled_baselines + +## Overview + + + + + + + +
Nameenabled_baselines_list_only
TypeResource
DescriptionDefinition of AWS::ControlTower::EnabledBaseline Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all enabled_baselines in a region. +```sql +SELECT +region, +enabled_baseline_identifier +FROM aws.controltower.enabled_baselines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the enabled_baselines_list_only resource, see enabled_baselines + diff --git a/website/docs/services/controltower/enabled_control_tags/index.md b/website/docs/services/controltower/enabled_control_tags/index.md new file mode 100644 index 0000000..1d1e123 --- /dev/null +++ b/website/docs/services/controltower/enabled_control_tags/index.md @@ -0,0 +1,81 @@ +--- +title: enabled_control_tags +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_control_tags + - controltower + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for enabled_controls in a region + +## Overview + + + + + + + +
Nameenabled_control_tags
TypeResource
DescriptionEnables a control on a specified target.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringArn of the control.
stringArn for Organizational unit to which the control needs to be applied
arrayParameters to configure the enabled control behavior.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all enabled_controls in a region. +```sql +SELECT +region, +control_identifier, +target_identifier, +parameters, +tag_key, +tag_value +FROM aws.controltower.enabled_control_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the enabled_control_tags resource, see enabled_controls + diff --git a/website/docs/services/controltower/enabled_controls/index.md b/website/docs/services/controltower/enabled_controls/index.md new file mode 100644 index 0000000..fc8a755 --- /dev/null +++ b/website/docs/services/controltower/enabled_controls/index.md @@ -0,0 +1,257 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an enabled_control resource or lists enabled_controls in a region + +## Overview + + + + + + + +
Nameenabled_controls
TypeResource
DescriptionEnables a control on a specified target.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringArn of the control.
stringArn for Organizational unit to which the control needs to be applied
arrayParameters to configure the enabled control behavior.
arrayA set of tags to assign to the enabled control.
stringAWS region.
+ +For more information, see AWS::ControlTower::EnabledControl. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all enabled_controls in a region. +```sql +SELECT +region, +control_identifier, +target_identifier, +parameters, +tags +FROM aws.controltower.enabled_controls +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual enabled_control. +```sql +SELECT +region, +control_identifier, +target_identifier, +parameters, +tags +FROM aws.controltower.enabled_controls +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new enabled_control resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.controltower.enabled_controls ( + ControlIdentifier, + TargetIdentifier, + region +) +SELECT +'{{ ControlIdentifier }}', + '{{ TargetIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.controltower.enabled_controls ( + ControlIdentifier, + TargetIdentifier, + Parameters, + Tags, + region +) +SELECT + '{{ ControlIdentifier }}', + '{{ TargetIdentifier }}', + '{{ Parameters }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: enabled_control + props: + - name: ControlIdentifier + value: '{{ ControlIdentifier }}' + - name: TargetIdentifier + value: '{{ TargetIdentifier }}' + - name: Parameters + value: + - Value: null + Key: '{{ Key }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.controltower.enabled_controls +WHERE data__Identifier = '' +AND 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 +``` + +### 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:ListEnabledControls, +controltower:GetEnabledControl, +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 +``` + +### List +```json +controltower:ListEnabledControls +``` diff --git a/website/docs/services/controltower/enabled_controls_list_only/index.md b/website/docs/services/controltower/enabled_controls_list_only/index.md new file mode 100644 index 0000000..db4846f --- /dev/null +++ b/website/docs/services/controltower/enabled_controls_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: enabled_controls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_controls_list_only + - controltower + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists enabled_controls in a region or regions, for all properties use enabled_controls + +## Overview + + + + + + + +
Nameenabled_controls_list_only
TypeResource
DescriptionEnables a control on a specified target.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringArn of the control.
stringArn for Organizational unit to which the control needs to be applied
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all enabled_controls in a region. +```sql +SELECT +region, +target_identifier, +control_identifier +FROM aws.controltower.enabled_controls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the enabled_controls_list_only resource, see enabled_controls + diff --git a/website/docs/services/controltower/index.md b/website/docs/services/controltower/index.md new file mode 100644 index 0000000..84f3766 --- /dev/null +++ b/website/docs/services/controltower/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The controltower service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/controltower/landing_zone_tags/index.md b/website/docs/services/controltower/landing_zone_tags/index.md new file mode 100644 index 0000000..520897b --- /dev/null +++ b/website/docs/services/controltower/landing_zone_tags/index.md @@ -0,0 +1,89 @@ +--- +title: landing_zone_tags +hide_title: false +hide_table_of_contents: false +keywords: + - landing_zone_tags + - controltower + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for landing_zones in a region + +## Overview + + + + + + + +
Namelanding_zone_tags
TypeResource
DescriptionDefinition of AWS::ControlTower::LandingZone Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all landing_zones in a region. +```sql +SELECT +region, +status, +latest_available_version, +version, +drift_status, +arn, +manifest, +landing_zone_identifier, +tag_key, +tag_value +FROM aws.controltower.landing_zone_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the landing_zone_tags resource, see landing_zones + diff --git a/website/docs/services/controltower/landing_zones/index.md b/website/docs/services/controltower/landing_zones/index.md new file mode 100644 index 0000000..02c600d --- /dev/null +++ b/website/docs/services/controltower/landing_zones/index.md @@ -0,0 +1,310 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a landing_zone resource or lists landing_zones in a region + +## Overview + + + + + + + +
Namelanding_zones
TypeResource
DescriptionDefinition of AWS::ControlTower::LandingZone Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::ControlTower::LandingZone. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all landing_zones in a region. +```sql +SELECT +region, +status, +latest_available_version, +version, +drift_status, +arn, +manifest, +landing_zone_identifier, +tags +FROM aws.controltower.landing_zones +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual landing_zone. +```sql +SELECT +region, +status, +latest_available_version, +version, +drift_status, +arn, +manifest, +landing_zone_identifier, +tags +FROM aws.controltower.landing_zones +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new landing_zone resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.controltower.landing_zones ( + Version, + Manifest, + region +) +SELECT +'{{ Version }}', + '{{ Manifest }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.controltower.landing_zones ( + Version, + Manifest, + Tags, + region +) +SELECT + '{{ Version }}', + '{{ Manifest }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: landing_zone + props: + - name: Version + value: '{{ Version }}' + - name: Manifest + value: null + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.controltower.landing_zones +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the landing_zones resource, the following permissions are required: + +### Read +```json +controltower:GetLandingZone, +controltower:ListTagsForResource +``` + +### 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 +``` + +### 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 +``` + +### List +```json +controltower:ListLandingZones +``` + +### 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/website/docs/services/controltower/landing_zones_list_only/index.md b/website/docs/services/controltower/landing_zones_list_only/index.md new file mode 100644 index 0000000..2739d0d --- /dev/null +++ b/website/docs/services/controltower/landing_zones_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: landing_zones_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - landing_zones_list_only + - controltower + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists landing_zones in a region or regions, for all properties use landing_zones + +## Overview + + + + + + + +
Namelanding_zones_list_only
TypeResource
DescriptionDefinition of AWS::ControlTower::LandingZone Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all landing_zones in a region. +```sql +SELECT +region, +landing_zone_identifier +FROM aws.controltower.landing_zones_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the landing_zones_list_only resource, see landing_zones + diff --git a/website/docs/services/cur/index.md b/website/docs/services/cur/index.md new file mode 100644 index 0000000..c8d160d --- /dev/null +++ b/website/docs/services/cur/index.md @@ -0,0 +1,37 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The cur service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/cur/report_definitions/index.md b/website/docs/services/cur/report_definitions/index.md new file mode 100644 index 0000000..f4d55f5 --- /dev/null +++ b/website/docs/services/cur/report_definitions/index.md @@ -0,0 +1,291 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a report_definition resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.
stringThe granularity of the line items in the report.
stringThe format that AWS saves the report in.
stringThe compression format that AWS uses for the report.
arrayA list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
stringThe S3 bucket where AWS delivers the report.
stringThe prefix that AWS adds to the report name when AWS delivers the report. Your prefix can't include spaces.
stringThe region of the S3 bucket that AWS delivers the report into.
arrayA list of manifests that you want Amazon Web Services to create for this report.
booleanWhether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.
stringWhether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
stringThe Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.
stringAWS region.
+ +For more information, see AWS::CUR::ReportDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all report_definitions in a region. +```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_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual report_definition. +```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_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new report_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.cur.report_definitions ( + ReportName, + TimeUnit, + Format, + Compression, + S3Bucket, + S3Prefix, + S3Region, + RefreshClosedReports, + ReportVersioning, + region +) +SELECT +'{{ ReportName }}', + '{{ TimeUnit }}', + '{{ Format }}', + '{{ Compression }}', + '{{ S3Bucket }}', + '{{ S3Prefix }}', + '{{ S3Region }}', + '{{ RefreshClosedReports }}', + '{{ ReportVersioning }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.cur.report_definitions ( + ReportName, + TimeUnit, + Format, + Compression, + AdditionalSchemaElements, + S3Bucket, + S3Prefix, + S3Region, + AdditionalArtifacts, + RefreshClosedReports, + ReportVersioning, + BillingViewArn, + region +) +SELECT + '{{ ReportName }}', + '{{ TimeUnit }}', + '{{ Format }}', + '{{ Compression }}', + '{{ AdditionalSchemaElements }}', + '{{ S3Bucket }}', + '{{ S3Prefix }}', + '{{ S3Region }}', + '{{ AdditionalArtifacts }}', + '{{ RefreshClosedReports }}', + '{{ ReportVersioning }}', + '{{ BillingViewArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: report_definition + props: + - name: ReportName + value: '{{ ReportName }}' + - name: TimeUnit + value: '{{ TimeUnit }}' + - name: Format + value: '{{ Format }}' + - name: Compression + value: '{{ Compression }}' + - name: AdditionalSchemaElements + value: + - '{{ AdditionalSchemaElements[0] }}' + - name: S3Bucket + value: '{{ S3Bucket }}' + - name: S3Prefix + value: '{{ S3Prefix }}' + - name: S3Region + value: '{{ S3Region }}' + - name: AdditionalArtifacts + value: + - '{{ AdditionalArtifacts[0] }}' + - name: RefreshClosedReports + value: '{{ RefreshClosedReports }}' + - name: ReportVersioning + value: '{{ ReportVersioning }}' + - name: BillingViewArn + value: '{{ BillingViewArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.cur.report_definitions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the report_definitions resource, the following permissions are required: + +### Create +```json +cur:PutReportDefinition, +cur:DescribeReportDefinitions +``` + +### Read +```json +cur:DescribeReportDefinitions +``` + +### Update +```json +cur:DescribeReportDefinitions, +cur:ModifyReportDefinition +``` + +### Delete +```json +cur:DeleteReportDefinition +``` + +### List +```json +cur:DescribeReportDefinitions +``` diff --git a/website/docs/services/cur/report_definitions_list_only/index.md b/website/docs/services/cur/report_definitions_list_only/index.md new file mode 100644 index 0000000..a3cbb2a --- /dev/null +++ b/website/docs/services/cur/report_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: report_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - report_definitions_list_only + - cur + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists report_definitions in a region or regions, for all properties use report_definitions + +## Overview + + + + + + + +
Namereport_definitions_list_only
TypeResource
DescriptionThe AWS::CUR::ReportDefinition resource creates a Cost & Usage Report with user-defined settings. You can use this resource to define settings like time granularity (hourly, daily, monthly), file format (Parquet, CSV), and S3 bucket for delivery of these reports.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all report_definitions in a region. +```sql +SELECT +region, +report_name +FROM aws.cur.report_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the report_definitions_list_only resource, see report_definitions + diff --git a/website/docs/services/customerprofiles/calculated_attribute_definition_tags/index.md b/website/docs/services/customerprofiles/calculated_attribute_definition_tags/index.md new file mode 100644 index 0000000..858ccdb --- /dev/null +++ b/website/docs/services/customerprofiles/calculated_attribute_definition_tags/index.md @@ -0,0 +1,93 @@ +--- +title: calculated_attribute_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - calculated_attribute_definition_tags + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for calculated_attribute_definitions in a region + +## Overview + + + + + + + +
Namecalculated_attribute_definition_tags
TypeResource
DescriptionA calculated attribute definition for Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe unique name of the calculated attribute.
stringThe display name of the calculated attribute.
stringThe description of the event trigger.
objectMathematical expression and a list of attribute items specified in that expression.
objectThe conditions including range, object count, and threshold for the calculated attribute.
stringThe aggregation operation to perform for the calculated attribute.
stringThe timestamp of when the calculated attribute definition was created.
stringThe timestamp of when the calculated attribute definition was most recently edited.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all calculated_attribute_definitions in a region. +```sql +SELECT +region, +domain_name, +calculated_attribute_name, +display_name, +description, +attribute_details, +conditions, +statistic, +created_at, +last_updated_at, +tag_key, +tag_value +FROM aws.customerprofiles.calculated_attribute_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the calculated_attribute_definition_tags resource, see calculated_attribute_definitions + diff --git a/website/docs/services/customerprofiles/calculated_attribute_definitions/index.md b/website/docs/services/customerprofiles/calculated_attribute_definitions/index.md new file mode 100644 index 0000000..bfcfd78 --- /dev/null +++ b/website/docs/services/customerprofiles/calculated_attribute_definitions/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a calculated_attribute_definition resource or lists calculated_attribute_definitions in a region + +## Overview + + + + + + + +
Namecalculated_attribute_definitions
TypeResource
DescriptionA calculated attribute definition for Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe unique name of the calculated attribute.
stringThe display name of the calculated attribute.
stringThe description of the event trigger.
objectMathematical expression and a list of attribute items specified in that expression.
objectThe conditions including range, object count, and threshold for the calculated attribute.
stringThe aggregation operation to perform for the calculated attribute.
stringThe timestamp of when the calculated attribute definition was created.
stringThe timestamp of when the calculated attribute definition was most recently edited.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::CustomerProfiles::CalculatedAttributeDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all calculated_attribute_definitions in a region. +```sql +SELECT +region, +domain_name, +calculated_attribute_name, +display_name, +description, +attribute_details, +conditions, +statistic, +created_at, +last_updated_at, +tags +FROM aws.customerprofiles.calculated_attribute_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual calculated_attribute_definition. +```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_definitions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new calculated_attribute_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.calculated_attribute_definitions ( + DomainName, + CalculatedAttributeName, + AttributeDetails, + Statistic, + region +) +SELECT +'{{ DomainName }}', + '{{ CalculatedAttributeName }}', + '{{ AttributeDetails }}', + '{{ Statistic }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.calculated_attribute_definitions ( + DomainName, + CalculatedAttributeName, + DisplayName, + Description, + AttributeDetails, + Conditions, + Statistic, + Tags, + region +) +SELECT + '{{ DomainName }}', + '{{ CalculatedAttributeName }}', + '{{ DisplayName }}', + '{{ Description }}', + '{{ AttributeDetails }}', + '{{ Conditions }}', + '{{ Statistic }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: calculated_attribute_definition + props: + - name: DomainName + value: '{{ DomainName }}' + - name: CalculatedAttributeName + value: '{{ CalculatedAttributeName }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: Description + value: '{{ Description }}' + - name: AttributeDetails + value: + Attributes: + - Name: '{{ Name }}' + Expression: '{{ Expression }}' + - name: Conditions + value: + Range: + Value: '{{ Value }}' + Unit: '{{ Unit }}' + ObjectCount: '{{ ObjectCount }}' + Threshold: + Value: '{{ Value }}' + Operator: '{{ Operator }}' + - name: Statistic + value: '{{ Statistic }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.customerprofiles.calculated_attribute_definitions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the calculated_attribute_definitions resource, the following permissions are required: + +### Create +```json +profile:CreateCalculatedAttributeDefinition, +profile:TagResource +``` + +### Read +```json +profile:GetCalculatedAttributeDefinition +``` + +### Update +```json +profile:GetCalculatedAttributeDefinition, +profile:UpdateCalculatedAttributeDefinition, +profile:UntagResource, +profile:TagResource +``` + +### Delete +```json +profile:DeleteCalculatedAttributeDefinition +``` + +### List +```json +profile:ListCalculatedAttributeDefinitions +``` diff --git a/website/docs/services/customerprofiles/calculated_attribute_definitions_list_only/index.md b/website/docs/services/customerprofiles/calculated_attribute_definitions_list_only/index.md new file mode 100644 index 0000000..528c77a --- /dev/null +++ b/website/docs/services/customerprofiles/calculated_attribute_definitions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: calculated_attribute_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - calculated_attribute_definitions_list_only + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists calculated_attribute_definitions in a region or regions, for all properties use calculated_attribute_definitions + +## Overview + + + + + + + +
Namecalculated_attribute_definitions_list_only
TypeResource
DescriptionA calculated attribute definition for Customer Profiles
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe unique name of the calculated attribute.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all calculated_attribute_definitions in a region. +```sql +SELECT +region, +domain_name, +calculated_attribute_name +FROM aws.customerprofiles.calculated_attribute_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the calculated_attribute_definitions_list_only resource, see calculated_attribute_definitions + diff --git a/website/docs/services/customerprofiles/domain_tags/index.md b/website/docs/services/customerprofiles/domain_tags/index.md new file mode 100644 index 0000000..0ab6510 --- /dev/null +++ b/website/docs/services/customerprofiles/domain_tags/index.md @@ -0,0 +1,93 @@ +--- +title: domain_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_tags + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domains in a region + +## Overview + + + + + + + +
Namedomain_tags
TypeResource
DescriptionA domain defined for 3rd party data source in Profile Service
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe URL of the SQS dead letter queue
stringThe default encryption key
integerThe default number of days until the data within the domain expires.
objectThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
objectThe process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
objectUsage-specific statistics about the domain.
stringThe time of this integration got created
stringThe time of this integration got last updated at
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domains in a region. +```sql +SELECT +region, +domain_name, +dead_letter_queue_url, +default_encryption_key, +default_expiration_days, +matching, +rule_based_matching, +stats, +created_at, +last_updated_at, +tag_key, +tag_value +FROM aws.customerprofiles.domain_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_tags resource, see domains + diff --git a/website/docs/services/customerprofiles/domains/index.md b/website/docs/services/customerprofiles/domains/index.md new file mode 100644 index 0000000..a67cf6a --- /dev/null +++ b/website/docs/services/customerprofiles/domains/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain resource or lists domains in a region + +## Overview + + + + + + + +
Namedomains
TypeResource
DescriptionA domain defined for 3rd party data source in Profile Service
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe URL of the SQS dead letter queue
stringThe default encryption key
integerThe default number of days until the data within the domain expires.
objectThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
objectThe process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
objectUsage-specific statistics about the domain.
arrayThe tags (keys and values) associated with the domain
stringThe time of this integration got created
stringThe time of this integration got last updated at
stringAWS region.
+ +For more information, see AWS::CustomerProfiles::Domain. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domains in a region. +```sql +SELECT +region, +domain_name, +dead_letter_queue_url, +default_encryption_key, +default_expiration_days, +matching, +rule_based_matching, +stats, +tags, +created_at, +last_updated_at +FROM aws.customerprofiles.domains +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain. +```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.domains +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.domains ( + DomainName, + DefaultExpirationDays, + region +) +SELECT +'{{ DomainName }}', + '{{ DefaultExpirationDays }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.domains ( + DomainName, + DeadLetterQueueUrl, + DefaultEncryptionKey, + DefaultExpirationDays, + Matching, + RuleBasedMatching, + Tags, + region +) +SELECT + '{{ DomainName }}', + '{{ DeadLetterQueueUrl }}', + '{{ DefaultEncryptionKey }}', + '{{ DefaultExpirationDays }}', + '{{ Matching }}', + '{{ RuleBasedMatching }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain + props: + - name: DomainName + value: '{{ DomainName }}' + - name: DeadLetterQueueUrl + value: '{{ DeadLetterQueueUrl }}' + - name: DefaultEncryptionKey + value: '{{ DefaultEncryptionKey }}' + - name: DefaultExpirationDays + value: '{{ DefaultExpirationDays }}' + - name: Matching + value: + Enabled: '{{ Enabled }}' + AutoMerging: + Enabled: '{{ Enabled }}' + ConflictResolution: + ConflictResolvingModel: '{{ ConflictResolvingModel }}' + SourceName: '{{ SourceName }}' + Consolidation: + MatchingAttributesList: + - - '{{ 0[0] }}' + MinAllowedConfidenceScoreForMerging: null + ExportingConfig: + S3Exporting: + S3BucketName: '{{ S3BucketName }}' + S3KeyName: '{{ S3KeyName }}' + JobSchedule: + DayOfTheWeek: '{{ DayOfTheWeek }}' + Time: '{{ Time }}' + - name: RuleBasedMatching + value: + Enabled: '{{ Enabled }}' + AttributeTypesSelector: + AttributeMatchingModel: '{{ AttributeMatchingModel }}' + Address: + - '{{ Address[0] }}' + EmailAddress: + - '{{ EmailAddress[0] }}' + PhoneNumber: + - '{{ PhoneNumber[0] }}' + ConflictResolution: null + ExportingConfig: null + MatchingRules: + - Rule: + - '{{ Rule[0] }}' + MaxAllowedRuleLevelForMatching: '{{ MaxAllowedRuleLevelForMatching }}' + MaxAllowedRuleLevelForMerging: '{{ MaxAllowedRuleLevelForMerging }}' + Status: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.customerprofiles.domains +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +```json +profile:CreateDomain, +profile:TagResource +``` + +### Read +```json +profile:GetDomain +``` + +### Update +```json +profile:GetDomain, +profile:UpdateDomain, +profile:UntagResource, +profile:TagResource +``` + +### Delete +```json +profile:DeleteDomain +``` + +### List +```json +profile:ListDomains +``` diff --git a/website/docs/services/customerprofiles/domains_list_only/index.md b/website/docs/services/customerprofiles/domains_list_only/index.md new file mode 100644 index 0000000..02ee683 --- /dev/null +++ b/website/docs/services/customerprofiles/domains_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domains_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domains in a region or regions, for all properties use domains + +## Overview + + + + + + + +
Namedomains_list_only
TypeResource
DescriptionA domain defined for 3rd party data source in Profile Service
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domains in a region. +```sql +SELECT +region, +domain_name +FROM aws.customerprofiles.domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domains_list_only resource, see domains + diff --git a/website/docs/services/customerprofiles/event_stream_tags/index.md b/website/docs/services/customerprofiles/event_stream_tags/index.md new file mode 100644 index 0000000..9ebf00b --- /dev/null +++ b/website/docs/services/customerprofiles/event_stream_tags/index.md @@ -0,0 +1,89 @@ +--- +title: event_stream_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_stream_tags + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_streams in a region + +## Overview + + + + + + + +
Nameevent_stream_tags
TypeResource
DescriptionAn Event Stream resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe name of the event stream.
stringThe StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name
stringA unique identifier for the event stream.
stringThe timestamp of when the export was created.
stringThe operational state of destination stream for export.
objectDetails regarding the Kinesis stream.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_streams in a region. +```sql +SELECT +region, +domain_name, +event_stream_name, +uri, +event_stream_arn, +created_at, +state, +destination_details, +tag_key, +tag_value +FROM aws.customerprofiles.event_stream_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_stream_tags resource, see event_streams + diff --git a/website/docs/services/customerprofiles/event_streams/index.md b/website/docs/services/customerprofiles/event_streams/index.md new file mode 100644 index 0000000..e2e5a3a --- /dev/null +++ b/website/docs/services/customerprofiles/event_streams/index.md @@ -0,0 +1,241 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_stream resource or lists event_streams in a region + +## Overview + + + + + + + +
Nameevent_streams
TypeResource
DescriptionAn Event Stream resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe name of the event stream.
stringThe StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name
stringA unique identifier for the event stream.
arrayThe tags used to organize, track, or control access for this resource.
stringThe timestamp of when the export was created.
stringThe operational state of destination stream for export.
objectDetails regarding the Kinesis stream.
stringAWS region.
+ +For more information, see AWS::CustomerProfiles::EventStream. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_streams in a region. +```sql +SELECT +region, +domain_name, +event_stream_name, +uri, +event_stream_arn, +tags, +created_at, +state, +destination_details +FROM aws.customerprofiles.event_streams +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_stream. +```sql +SELECT +region, +domain_name, +event_stream_name, +uri, +event_stream_arn, +tags, +created_at, +state, +destination_details +FROM aws.customerprofiles.event_streams +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.event_streams ( + DomainName, + EventStreamName, + Uri, + region +) +SELECT +'{{ DomainName }}', + '{{ EventStreamName }}', + '{{ Uri }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.event_streams ( + DomainName, + EventStreamName, + Uri, + Tags, + region +) +SELECT + '{{ DomainName }}', + '{{ EventStreamName }}', + '{{ Uri }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_stream + props: + - name: DomainName + value: '{{ DomainName }}' + - name: EventStreamName + value: '{{ EventStreamName }}' + - name: Uri + value: '{{ Uri }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.customerprofiles.event_streams +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +profile:GetEventStream, +kinesis:DescribeStreamSummary +``` + +### Update +```json +kinesis:DescribeStreamSummary, +profile:GetEventStream, +profile:UntagResource, +profile:TagResource +``` + +### Delete +```json +profile:DeleteEventStream, +iam:DeleteRolePolicy +``` + +### List +```json +profile:ListEventStreams +``` diff --git a/website/docs/services/customerprofiles/event_streams_list_only/index.md b/website/docs/services/customerprofiles/event_streams_list_only/index.md new file mode 100644 index 0000000..27a37f1 --- /dev/null +++ b/website/docs/services/customerprofiles/event_streams_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: event_streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_streams_list_only + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_streams in a region or regions, for all properties use event_streams + +## Overview + + + + + + + +
Nameevent_streams_list_only
TypeResource
DescriptionAn Event Stream resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe name of the event stream.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_streams in a region. +```sql +SELECT +region, +domain_name, +event_stream_name +FROM aws.customerprofiles.event_streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_streams_list_only resource, see event_streams + diff --git a/website/docs/services/customerprofiles/event_trigger_tags/index.md b/website/docs/services/customerprofiles/event_trigger_tags/index.md new file mode 100644 index 0000000..d768c3a --- /dev/null +++ b/website/docs/services/customerprofiles/event_trigger_tags/index.md @@ -0,0 +1,93 @@ +--- +title: event_trigger_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_trigger_tags + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_triggers in a region + +## Overview + + + + + + + +
Nameevent_trigger_tags
TypeResource
DescriptionAn event trigger resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe unique name of the event trigger.
stringThe unique name of the object type.
stringThe description of the event trigger.
arrayA list of conditions that determine when an event should trigger the destination.
objectDefines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
stringThe destination is triggered only for profiles that meet the criteria of a segment definition.
stringThe timestamp of when the event trigger was created.
stringThe timestamp of when the event trigger was most recently updated.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_triggers in a region. +```sql +SELECT +region, +domain_name, +event_trigger_name, +object_type_name, +description, +event_trigger_conditions, +event_trigger_limits, +segment_filter, +created_at, +last_updated_at, +tag_key, +tag_value +FROM aws.customerprofiles.event_trigger_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_trigger_tags resource, see event_triggers + diff --git a/website/docs/services/customerprofiles/event_triggers/index.md b/website/docs/services/customerprofiles/event_triggers/index.md new file mode 100644 index 0000000..2265220 --- /dev/null +++ b/website/docs/services/customerprofiles/event_triggers/index.md @@ -0,0 +1,275 @@ +--- +title: event_triggers +hide_title: false +hide_table_of_contents: false +keywords: + - event_triggers + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_trigger resource or lists event_triggers in a region + +## Overview + + + + + + + +
Nameevent_triggers
TypeResource
DescriptionAn event trigger resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe unique name of the event trigger.
stringThe unique name of the object type.
stringThe description of the event trigger.
arrayA list of conditions that determine when an event should trigger the destination.
objectDefines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
stringThe destination is triggered only for profiles that meet the criteria of a segment definition.
stringThe timestamp of when the event trigger was created.
stringThe timestamp of when the event trigger was most recently updated.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::CustomerProfiles::EventTrigger. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_triggers in a region. +```sql +SELECT +region, +domain_name, +event_trigger_name, +object_type_name, +description, +event_trigger_conditions, +event_trigger_limits, +segment_filter, +created_at, +last_updated_at, +tags +FROM aws.customerprofiles.event_triggers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_trigger. +```sql +SELECT +region, +domain_name, +event_trigger_name, +object_type_name, +description, +event_trigger_conditions, +event_trigger_limits, +segment_filter, +created_at, +last_updated_at, +tags +FROM aws.customerprofiles.event_triggers +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_trigger resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.event_triggers ( + DomainName, + EventTriggerName, + ObjectTypeName, + EventTriggerConditions, + region +) +SELECT +'{{ DomainName }}', + '{{ EventTriggerName }}', + '{{ ObjectTypeName }}', + '{{ EventTriggerConditions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.event_triggers ( + DomainName, + EventTriggerName, + ObjectTypeName, + Description, + EventTriggerConditions, + EventTriggerLimits, + SegmentFilter, + Tags, + region +) +SELECT + '{{ DomainName }}', + '{{ EventTriggerName }}', + '{{ ObjectTypeName }}', + '{{ Description }}', + '{{ EventTriggerConditions }}', + '{{ EventTriggerLimits }}', + '{{ SegmentFilter }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_trigger + props: + - name: DomainName + value: '{{ DomainName }}' + - name: EventTriggerName + value: '{{ EventTriggerName }}' + - name: ObjectTypeName + value: '{{ ObjectTypeName }}' + - name: Description + value: '{{ Description }}' + - name: EventTriggerConditions + value: + - EventTriggerDimensions: + - ObjectAttributes: + - Source: '{{ Source }}' + FieldName: '{{ FieldName }}' + ComparisonOperator: '{{ ComparisonOperator }}' + Values: + - '{{ Values[0] }}' + LogicalOperator: '{{ LogicalOperator }}' + - name: EventTriggerLimits + value: + EventExpiration: '{{ EventExpiration }}' + Periods: + - Unit: '{{ Unit }}' + Value: '{{ Value }}' + MaxInvocationsPerProfile: '{{ MaxInvocationsPerProfile }}' + Unlimited: '{{ Unlimited }}' + - name: SegmentFilter + value: '{{ SegmentFilter }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.customerprofiles.event_triggers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the event_triggers resource, the following permissions are required: + +### Create +```json +profile:CreateEventTrigger, +profile:TagResource +``` + +### Read +```json +profile:GetEventTrigger +``` + +### Update +```json +profile:GetEventTrigger, +profile:UpdateEventTrigger, +profile:UntagResource, +profile:TagResource +``` + +### Delete +```json +profile:DeleteEventTrigger +``` + +### List +```json +profile:ListEventTriggers +``` diff --git a/website/docs/services/customerprofiles/event_triggers_list_only/index.md b/website/docs/services/customerprofiles/event_triggers_list_only/index.md new file mode 100644 index 0000000..9c21ea0 --- /dev/null +++ b/website/docs/services/customerprofiles/event_triggers_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: event_triggers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_triggers_list_only + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_triggers in a region or regions, for all properties use event_triggers + +## Overview + + + + + + + +
Nameevent_triggers_list_only
TypeResource
DescriptionAn event trigger resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe unique name of the event trigger.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_triggers in a region. +```sql +SELECT +region, +domain_name, +event_trigger_name +FROM aws.customerprofiles.event_triggers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_triggers_list_only resource, see event_triggers + diff --git a/website/docs/services/customerprofiles/index.md b/website/docs/services/customerprofiles/index.md new file mode 100644 index 0000000..56c3bb8 --- /dev/null +++ b/website/docs/services/customerprofiles/index.md @@ -0,0 +1,56 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The customerprofiles service documentation. + +:::info Service Summary + +
+
+total resources: 21
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/customerprofiles/integration_tags/index.md b/website/docs/services/customerprofiles/integration_tags/index.md new file mode 100644 index 0000000..1295ae4 --- /dev/null +++ b/website/docs/services/customerprofiles/integration_tags/index.md @@ -0,0 +1,91 @@ +--- +title: integration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - integration_tags + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for integrations in a region + +## Overview + + + + + + + +
Nameintegration_tags
TypeResource
DescriptionThe resource schema for creating an Amazon Connect Customer Profiles Integration.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe URI of the S3 bucket or any other type of data source.
object
stringThe name of the ObjectType defined for the 3rd party data in Profile Service
stringThe time of this integration got created
stringThe time of this integration got last updated at
arrayThe mapping between 3rd party event types and ObjectType names
arrayA list of unique names for active event triggers associated with the integration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all integrations in a region. +```sql +SELECT +region, +domain_name, +uri, +flow_definition, +object_type_name, +created_at, +last_updated_at, +object_type_names, +event_trigger_names, +tag_key, +tag_value +FROM aws.customerprofiles.integration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integration_tags resource, see integrations + diff --git a/website/docs/services/customerprofiles/integrations/index.md b/website/docs/services/customerprofiles/integrations/index.md new file mode 100644 index 0000000..41dbfee --- /dev/null +++ b/website/docs/services/customerprofiles/integrations/index.md @@ -0,0 +1,323 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an integration resource or lists integrations in a region + +## Overview + + + + + + + +
Nameintegrations
TypeResource
DescriptionThe resource schema for creating an Amazon Connect Customer Profiles Integration.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe URI of the S3 bucket or any other type of data source.
object
stringThe name of the ObjectType defined for the 3rd party data in Profile Service
stringThe time of this integration got created
stringThe time of this integration got last updated at
arrayThe tags (keys and values) associated with the integration
arrayThe mapping between 3rd party event types and ObjectType names
arrayA list of unique names for active event triggers associated with the integration.
stringAWS region.
+ +For more information, see AWS::CustomerProfiles::Integration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all integrations in a region. +```sql +SELECT +region, +domain_name, +uri, +flow_definition, +object_type_name, +created_at, +last_updated_at, +tags, +object_type_names, +event_trigger_names +FROM aws.customerprofiles.integrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual integration. +```sql +SELECT +region, +domain_name, +uri, +flow_definition, +object_type_name, +created_at, +last_updated_at, +tags, +object_type_names, +event_trigger_names +FROM aws.customerprofiles.integrations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.integrations ( + DomainName, + region +) +SELECT +'{{ DomainName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.integrations ( + DomainName, + Uri, + FlowDefinition, + ObjectTypeName, + Tags, + ObjectTypeNames, + EventTriggerNames, + region +) +SELECT + '{{ DomainName }}', + '{{ Uri }}', + '{{ FlowDefinition }}', + '{{ ObjectTypeName }}', + '{{ Tags }}', + '{{ ObjectTypeNames }}', + '{{ EventTriggerNames }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: integration + props: + - name: DomainName + value: '{{ DomainName }}' + - name: Uri + value: '{{ Uri }}' + - name: FlowDefinition + value: + FlowName: '{{ FlowName }}' + Description: '{{ Description }}' + KmsArn: '{{ KmsArn }}' + Tasks: + - ConnectorOperator: + Marketo: '{{ Marketo }}' + S3: '{{ S3 }}' + Salesforce: '{{ Salesforce }}' + ServiceNow: '{{ ServiceNow }}' + Zendesk: '{{ Zendesk }}' + SourceFields: + - '{{ SourceFields[0] }}' + DestinationField: '{{ DestinationField }}' + TaskType: '{{ TaskType }}' + TaskProperties: + - OperatorPropertyKey: '{{ OperatorPropertyKey }}' + Property: '{{ Property }}' + TriggerConfig: + TriggerType: '{{ TriggerType }}' + TriggerProperties: + Scheduled: + ScheduleExpression: '{{ ScheduleExpression }}' + DataPullMode: '{{ DataPullMode }}' + ScheduleStartTime: null + ScheduleEndTime: null + Timezone: '{{ Timezone }}' + ScheduleOffset: '{{ ScheduleOffset }}' + FirstExecutionFrom: null + SourceFlowConfig: + ConnectorType: '{{ ConnectorType }}' + ConnectorProfileName: '{{ ConnectorProfileName }}' + IncrementalPullConfig: + DatetimeTypeFieldName: '{{ DatetimeTypeFieldName }}' + SourceConnectorProperties: + Marketo: + Object: '{{ Object }}' + S3: + BucketName: '{{ BucketName }}' + BucketPrefix: '{{ BucketPrefix }}' + Salesforce: + Object: null + EnableDynamicFieldUpdate: '{{ EnableDynamicFieldUpdate }}' + IncludeDeletedRecords: '{{ IncludeDeletedRecords }}' + ServiceNow: + Object: null + Zendesk: + Object: null + - name: ObjectTypeName + value: '{{ ObjectTypeName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ObjectTypeNames + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: EventTriggerNames + value: + - '{{ EventTriggerNames[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.customerprofiles.integrations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +profile:ListIntegrations +``` diff --git a/website/docs/services/customerprofiles/integrations_list_only/index.md b/website/docs/services/customerprofiles/integrations_list_only/index.md new file mode 100644 index 0000000..a206f65 --- /dev/null +++ b/website/docs/services/customerprofiles/integrations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integrations_list_only + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integrations in a region or regions, for all properties use integrations + +## Overview + + + + + + + +
Nameintegrations_list_only
TypeResource
DescriptionThe resource schema for creating an Amazon Connect Customer Profiles Integration.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe URI of the S3 bucket or any other type of data source.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integrations in a region. +```sql +SELECT +region, +domain_name, +uri +FROM aws.customerprofiles.integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integrations_list_only resource, see integrations + diff --git a/website/docs/services/customerprofiles/object_type_tags/index.md b/website/docs/services/customerprofiles/object_type_tags/index.md new file mode 100644 index 0000000..03f9814 --- /dev/null +++ b/website/docs/services/customerprofiles/object_type_tags/index.md @@ -0,0 +1,99 @@ +--- +title: object_type_tags +hide_title: false +hide_table_of_contents: false +keywords: + - object_type_tags + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for object_types in a region + +## Overview + + + + + + + +
Nameobject_type_tags
TypeResource
DescriptionAn ObjectType resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe name of the profile object type.
booleanIndicates whether a profile should be created when data is received.
stringDescription of the profile object type.
stringThe default encryption key
integerThe default number of days until the data within the domain expires.
arrayA list of the name and ObjectType field.
arrayA list of unique keys that can be used to map data to the profile.
stringThe time of this integration got created.
stringThe time of this integration got last updated at.
stringThe format of your sourceLastUpdatedTimestamp that was previously set up.
stringA unique identifier for the object template.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all object_types in a region. +```sql +SELECT +region, +domain_name, +object_type_name, +allow_profile_creation, +description, +encryption_key, +expiration_days, +fields, +keys, +created_at, +last_updated_at, +source_last_updated_timestamp_format, +template_id, +tag_key, +tag_value +FROM aws.customerprofiles.object_type_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the object_type_tags resource, see object_types + diff --git a/website/docs/services/customerprofiles/object_types/index.md b/website/docs/services/customerprofiles/object_types/index.md new file mode 100644 index 0000000..14c90b9 --- /dev/null +++ b/website/docs/services/customerprofiles/object_types/index.md @@ -0,0 +1,292 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an object_type resource or lists object_types in a region + +## Overview + + + + + + + +
Nameobject_types
TypeResource
DescriptionAn ObjectType resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe name of the profile object type.
booleanIndicates whether a profile should be created when data is received.
stringDescription of the profile object type.
stringThe default encryption key
integerThe default number of days until the data within the domain expires.
arrayA list of the name and ObjectType field.
arrayA list of unique keys that can be used to map data to the profile.
stringThe time of this integration got created.
stringThe time of this integration got last updated at.
stringThe format of your sourceLastUpdatedTimestamp that was previously set up.
arrayThe tags (keys and values) associated with the integration.
stringA unique identifier for the object template.
stringAWS region.
+ +For more information, see AWS::CustomerProfiles::ObjectType. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all object_types in a region. +```sql +SELECT +region, +domain_name, +object_type_name, +allow_profile_creation, +description, +encryption_key, +expiration_days, +fields, +keys, +created_at, +last_updated_at, +source_last_updated_timestamp_format, +tags, +template_id +FROM aws.customerprofiles.object_types +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual object_type. +```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_types +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new object_type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.object_types ( + DomainName, + ObjectTypeName, + Description, + region +) +SELECT +'{{ DomainName }}', + '{{ ObjectTypeName }}', + '{{ Description }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.object_types ( + DomainName, + ObjectTypeName, + AllowProfileCreation, + Description, + EncryptionKey, + ExpirationDays, + Fields, + Keys, + SourceLastUpdatedTimestampFormat, + Tags, + TemplateId, + region +) +SELECT + '{{ DomainName }}', + '{{ ObjectTypeName }}', + '{{ AllowProfileCreation }}', + '{{ Description }}', + '{{ EncryptionKey }}', + '{{ ExpirationDays }}', + '{{ Fields }}', + '{{ Keys }}', + '{{ SourceLastUpdatedTimestampFormat }}', + '{{ Tags }}', + '{{ TemplateId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: object_type + props: + - name: DomainName + value: '{{ DomainName }}' + - name: ObjectTypeName + value: '{{ ObjectTypeName }}' + - name: AllowProfileCreation + value: '{{ AllowProfileCreation }}' + - name: Description + value: '{{ Description }}' + - name: EncryptionKey + value: '{{ EncryptionKey }}' + - name: ExpirationDays + value: '{{ ExpirationDays }}' + - name: Fields + value: + - Name: '{{ Name }}' + ObjectTypeField: + Source: '{{ Source }}' + Target: '{{ Target }}' + ContentType: '{{ ContentType }}' + - name: Keys + value: + - Name: '{{ Name }}' + ObjectTypeKeyList: + - FieldNames: + - '{{ FieldNames[0] }}' + StandardIdentifiers: + - '{{ StandardIdentifiers[0] }}' + - name: SourceLastUpdatedTimestampFormat + value: '{{ SourceLastUpdatedTimestampFormat }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TemplateId + value: '{{ TemplateId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.customerprofiles.object_types +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +profile:GetProfileObjectType +``` + +### Update +```json +profile:GetProfileObjectType, +profile:PutProfileObjectType, +profile:UntagResource, +profile:TagResource +``` + +### Delete +```json +profile:DeleteProfileObjectType +``` + +### List +```json +profile:ListProfileObjectTypes +``` diff --git a/website/docs/services/customerprofiles/object_types_list_only/index.md b/website/docs/services/customerprofiles/object_types_list_only/index.md new file mode 100644 index 0000000..88f952f --- /dev/null +++ b/website/docs/services/customerprofiles/object_types_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: object_types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - object_types_list_only + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists object_types in a region or regions, for all properties use object_types + +## Overview + + + + + + + +
Nameobject_types_list_only
TypeResource
DescriptionAn ObjectType resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe name of the profile object type.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all object_types in a region. +```sql +SELECT +region, +domain_name, +object_type_name +FROM aws.customerprofiles.object_types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the object_types_list_only resource, see object_types + diff --git a/website/docs/services/customerprofiles/segment_definition_tags/index.md b/website/docs/services/customerprofiles/segment_definition_tags/index.md new file mode 100644 index 0000000..bd62e6c --- /dev/null +++ b/website/docs/services/customerprofiles/segment_definition_tags/index.md @@ -0,0 +1,89 @@ +--- +title: segment_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - segment_definition_tags + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for segment_definitions in a region + +## Overview + + + + + + + +
Namesegment_definition_tags
TypeResource
DescriptionA segment definition resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe time of this segment definition got created.
stringThe description of the segment definition.
stringThe display name of the segment definition.
stringThe unique name of the domain.
stringThe unique name of the segment definition.
objectAn array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
stringThe Amazon Resource Name (ARN) of the segment definition.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all segment_definitions in a region. +```sql +SELECT +region, +created_at, +description, +display_name, +domain_name, +segment_definition_name, +segment_groups, +segment_definition_arn, +tag_key, +tag_value +FROM aws.customerprofiles.segment_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the segment_definition_tags resource, see segment_definitions + diff --git a/website/docs/services/customerprofiles/segment_definitions/index.md b/website/docs/services/customerprofiles/segment_definitions/index.md new file mode 100644 index 0000000..64aaef2 --- /dev/null +++ b/website/docs/services/customerprofiles/segment_definitions/index.md @@ -0,0 +1,254 @@ +--- +title: segment_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - segment_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a segment_definition resource or lists segment_definitions in a region + +## Overview + + + + + + + +
Namesegment_definitions
TypeResource
DescriptionA segment definition resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe time of this segment definition got created.
stringThe description of the segment definition.
stringThe display name of the segment definition.
stringThe unique name of the domain.
stringThe unique name of the segment definition.
objectAn array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
stringThe Amazon Resource Name (ARN) of the segment definition.
arrayThe tags used to organize, track, or control access for this resource.
stringAWS region.
+ +For more information, see AWS::CustomerProfiles::SegmentDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all segment_definitions in a region. +```sql +SELECT +region, +created_at, +description, +display_name, +domain_name, +segment_definition_name, +segment_groups, +segment_definition_arn, +tags +FROM aws.customerprofiles.segment_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual segment_definition. +```sql +SELECT +region, +created_at, +description, +display_name, +domain_name, +segment_definition_name, +segment_groups, +segment_definition_arn, +tags +FROM aws.customerprofiles.segment_definitions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new segment_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.segment_definitions ( + DisplayName, + DomainName, + SegmentDefinitionName, + SegmentGroups, + region +) +SELECT +'{{ DisplayName }}', + '{{ DomainName }}', + '{{ SegmentDefinitionName }}', + '{{ SegmentGroups }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.customerprofiles.segment_definitions ( + Description, + DisplayName, + DomainName, + SegmentDefinitionName, + SegmentGroups, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ DisplayName }}', + '{{ DomainName }}', + '{{ SegmentDefinitionName }}', + '{{ SegmentGroups }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: segment_definition + props: + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: DomainName + value: '{{ DomainName }}' + - name: SegmentDefinitionName + value: '{{ SegmentDefinitionName }}' + - name: SegmentGroups + value: + Groups: + - Dimensions: + - null + SourceSegments: + - SegmentDefinitionName: '{{ SegmentDefinitionName }}' + SourceType: '{{ SourceType }}' + Type: null + Include: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.customerprofiles.segment_definitions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the segment_definitions resource, the following permissions are required: + +### Create +```json +profile:CreateSegmentDefinition, +profile:TagResource +``` + +### Read +```json +profile:GetSegmentDefinition +``` + +### Update +```json +profile:GetSegmentDefinition, +profile:UntagResource, +profile:TagResource +``` + +### Delete +```json +profile:DeleteSegmentDefinition +``` + +### List +```json +profile:ListSegmentDefinitions +``` diff --git a/website/docs/services/customerprofiles/segment_definitions_list_only/index.md b/website/docs/services/customerprofiles/segment_definitions_list_only/index.md new file mode 100644 index 0000000..7331c09 --- /dev/null +++ b/website/docs/services/customerprofiles/segment_definitions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: segment_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - segment_definitions_list_only + - customerprofiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists segment_definitions in a region or regions, for all properties use segment_definitions + +## Overview + + + + + + + +
Namesegment_definitions_list_only
TypeResource
DescriptionA segment definition resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe unique name of the segment definition.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all segment_definitions in a region. +```sql +SELECT +region, +domain_name, +segment_definition_name +FROM aws.customerprofiles.segment_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the segment_definitions_list_only resource, see segment_definitions + diff --git a/website/docs/services/databrew/dataset_tags/index.md b/website/docs/services/databrew/dataset_tags/index.md new file mode 100644 index 0000000..466d4dc --- /dev/null +++ b/website/docs/services/databrew/dataset_tags/index.md @@ -0,0 +1,87 @@ +--- +title: dataset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_tags + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for datasets in a region + +## Overview + + + + + + + +
Namedataset_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Dataset.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringDataset name
stringDataset format
objectFormat options for dataset
objectInput
stringSource type of the dataset
objectPathOptions
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all datasets in a region. +```sql +SELECT +region, +name, +format, +format_options, +input, +source, +path_options, +tag_key, +tag_value +FROM aws.databrew.dataset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_tags resource, see datasets + diff --git a/website/docs/services/databrew/datasets/index.md b/website/docs/services/databrew/datasets/index.md new file mode 100644 index 0000000..f2da4c5 --- /dev/null +++ b/website/docs/services/databrew/datasets/index.md @@ -0,0 +1,297 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dataset resource or lists datasets in a region + +## Overview + + + + + + + +
Namedatasets
TypeResource
DescriptionResource schema for AWS::DataBrew::Dataset.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringDataset name
stringDataset format
objectFormat options for dataset
objectInput
stringSource type of the dataset
objectPathOptions
array
stringAWS region.
+ +For more information, see AWS::DataBrew::Dataset. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all datasets in a region. +```sql +SELECT +region, +name, +format, +format_options, +input, +source, +path_options, +tags +FROM aws.databrew.datasets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dataset. +```sql +SELECT +region, +name, +format, +format_options, +input, +source, +path_options, +tags +FROM aws.databrew.datasets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dataset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.datasets ( + Name, + Input, + region +) +SELECT +'{{ Name }}', + '{{ Input }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.datasets ( + Name, + Format, + FormatOptions, + Input, + Source, + PathOptions, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Format }}', + '{{ FormatOptions }}', + '{{ Input }}', + '{{ Source }}', + '{{ PathOptions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dataset + props: + - name: Name + value: '{{ Name }}' + - name: Format + value: '{{ Format }}' + - name: FormatOptions + value: + Json: + MultiLine: '{{ MultiLine }}' + Excel: + SheetNames: + - '{{ SheetNames[0] }}' + SheetIndexes: + - '{{ SheetIndexes[0] }}' + HeaderRow: '{{ HeaderRow }}' + Csv: + Delimiter: '{{ Delimiter }}' + HeaderRow: '{{ HeaderRow }}' + - name: Input + value: + S3InputDefinition: + Bucket: '{{ Bucket }}' + Key: '{{ Key }}' + DataCatalogInputDefinition: + CatalogId: '{{ CatalogId }}' + DatabaseName: '{{ DatabaseName }}' + TableName: '{{ TableName }}' + TempDirectory: null + DatabaseInputDefinition: + GlueConnectionName: '{{ GlueConnectionName }}' + DatabaseTableName: '{{ DatabaseTableName }}' + TempDirectory: null + QueryString: '{{ QueryString }}' + Metadata: + SourceArn: '{{ SourceArn }}' + - name: Source + value: '{{ Source }}' + - name: PathOptions + value: + FilesLimit: + MaxFiles: '{{ MaxFiles }}' + OrderedBy: '{{ OrderedBy }}' + Order: '{{ Order }}' + LastModifiedDateCondition: + Expression: '{{ Expression }}' + ValuesMap: + - ValueReference: '{{ ValueReference }}' + Value: '{{ Value }}' + Parameters: + - PathParameterName: '{{ PathParameterName }}' + DatasetParameter: + Name: null + Type: '{{ Type }}' + DatetimeOptions: + Format: '{{ Format }}' + TimezoneOffset: '{{ TimezoneOffset }}' + LocaleCode: '{{ LocaleCode }}' + CreateColumn: '{{ CreateColumn }}' + Filter: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.databrew.datasets +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +databrew:DescribeDataset, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateDataset, +glue:GetConnection, +glue:GetTable +``` + +### Delete +```json +databrew:DeleteDataset +``` + +### List +```json +databrew:ListDatasets, +databrew:ListTagsForResource, +iam:ListRoles +``` diff --git a/website/docs/services/databrew/datasets_list_only/index.md b/website/docs/services/databrew/datasets_list_only/index.md new file mode 100644 index 0000000..0c5c6bb --- /dev/null +++ b/website/docs/services/databrew/datasets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: datasets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - datasets_list_only + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists datasets in a region or regions, for all properties use datasets + +## Overview + + + + + + + +
Namedatasets_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Dataset.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringDataset name
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all datasets in a region. +```sql +SELECT +region, +name +FROM aws.databrew.datasets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datasets_list_only resource, see datasets + diff --git a/website/docs/services/databrew/index.md b/website/docs/services/databrew/index.md new file mode 100644 index 0000000..5c9c878 --- /dev/null +++ b/website/docs/services/databrew/index.md @@ -0,0 +1,53 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The databrew service documentation. + +:::info Service Summary + +
+
+total resources: 18
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/databrew/job_tags/index.md b/website/docs/services/databrew/job_tags/index.md new file mode 100644 index 0000000..8e02b14 --- /dev/null +++ b/website/docs/services/databrew/job_tags/index.md @@ -0,0 +1,113 @@ +--- +title: job_tags +hide_title: false +hide_table_of_contents: false +keywords: + - job_tags + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for jobs in a region + +## Overview + + + + + + + +
Namejob_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Job.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringDataset name
stringEncryption Key Arn
stringEncryption mode
stringJob name
stringJob type
stringLog subscription
integerMax capacity
integerMax retries
array
array
array
objectOutput location
stringProject name
objectResource schema for AWS::DataBrew::Recipe.
stringRole arn
integerTimeout
objectJob Sample
objectProfile Job configuration
arrayData quality rules configuration
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all jobs in a region. +```sql +SELECT +region, +dataset_name, +encryption_key_arn, +encryption_mode, +name, +type, +log_subscription, +max_capacity, +max_retries, +outputs, +data_catalog_outputs, +database_outputs, +output_location, +project_name, +recipe, +role_arn, +timeout, +job_sample, +profile_configuration, +validation_configurations, +tag_key, +tag_value +FROM aws.databrew.job_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_tags resource, see jobs + diff --git a/website/docs/services/databrew/jobs/index.md b/website/docs/services/databrew/jobs/index.md new file mode 100644 index 0000000..6d012f4 --- /dev/null +++ b/website/docs/services/databrew/jobs/index.md @@ -0,0 +1,405 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a job resource or lists jobs in a region + +## Overview + + + + + + + +
Namejobs
TypeResource
DescriptionResource schema for AWS::DataBrew::Job.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringDataset name
stringEncryption Key Arn
stringEncryption mode
stringJob name
stringJob type
stringLog subscription
integerMax capacity
integerMax retries
array
array
array
objectOutput location
stringProject name
objectResource schema for AWS::DataBrew::Recipe.
stringRole arn
array
integerTimeout
objectJob Sample
objectProfile Job configuration
arrayData quality rules configuration
stringAWS region.
+ +For more information, see AWS::DataBrew::Job. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all jobs in a region. +```sql +SELECT +region, +dataset_name, +encryption_key_arn, +encryption_mode, +name, +type, +log_subscription, +max_capacity, +max_retries, +outputs, +data_catalog_outputs, +database_outputs, +output_location, +project_name, +recipe, +role_arn, +tags, +timeout, +job_sample, +profile_configuration, +validation_configurations +FROM aws.databrew.jobs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual job. +```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.jobs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new job resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.jobs ( + Name, + Type, + RoleArn, + region +) +SELECT +'{{ Name }}', + '{{ Type }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.jobs ( + DatasetName, + EncryptionKeyArn, + EncryptionMode, + Name, + Type, + LogSubscription, + MaxCapacity, + MaxRetries, + Outputs, + DataCatalogOutputs, + DatabaseOutputs, + OutputLocation, + ProjectName, + Recipe, + RoleArn, + Tags, + Timeout, + JobSample, + ProfileConfiguration, + ValidationConfigurations, + region +) +SELECT + '{{ DatasetName }}', + '{{ EncryptionKeyArn }}', + '{{ EncryptionMode }}', + '{{ Name }}', + '{{ Type }}', + '{{ LogSubscription }}', + '{{ MaxCapacity }}', + '{{ MaxRetries }}', + '{{ Outputs }}', + '{{ DataCatalogOutputs }}', + '{{ DatabaseOutputs }}', + '{{ OutputLocation }}', + '{{ ProjectName }}', + '{{ Recipe }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ Timeout }}', + '{{ JobSample }}', + '{{ ProfileConfiguration }}', + '{{ ValidationConfigurations }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: job + props: + - name: DatasetName + value: '{{ DatasetName }}' + - name: EncryptionKeyArn + value: '{{ EncryptionKeyArn }}' + - name: EncryptionMode + value: '{{ EncryptionMode }}' + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: LogSubscription + value: '{{ LogSubscription }}' + - name: MaxCapacity + value: '{{ MaxCapacity }}' + - name: MaxRetries + value: '{{ MaxRetries }}' + - name: Outputs + value: + - CompressionFormat: '{{ CompressionFormat }}' + Format: '{{ Format }}' + FormatOptions: + Csv: + Delimiter: '{{ Delimiter }}' + PartitionColumns: + - '{{ PartitionColumns[0] }}' + Location: + Bucket: '{{ Bucket }}' + Key: '{{ Key }}' + Overwrite: '{{ Overwrite }}' + MaxOutputFiles: '{{ MaxOutputFiles }}' + - name: DataCatalogOutputs + value: + - CatalogId: '{{ CatalogId }}' + DatabaseName: '{{ DatabaseName }}' + TableName: '{{ TableName }}' + S3Options: + Location: null + DatabaseOptions: + TempDirectory: null + TableName: '{{ TableName }}' + Overwrite: '{{ Overwrite }}' + - name: DatabaseOutputs + value: + - GlueConnectionName: '{{ GlueConnectionName }}' + DatabaseOutputMode: '{{ DatabaseOutputMode }}' + DatabaseOptions: null + - name: OutputLocation + value: + Bucket: '{{ Bucket }}' + Key: '{{ Key }}' + BucketOwner: '{{ BucketOwner }}' + - name: ProjectName + value: '{{ ProjectName }}' + - name: Recipe + value: + Description: '{{ Description }}' + Name: '{{ Name }}' + Steps: + - Action: + Operation: '{{ Operation }}' + Parameters: null + ConditionExpressions: + - Condition: '{{ Condition }}' + Value: '{{ Value }}' + TargetColumn: '{{ TargetColumn }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - null + - name: Timeout + value: '{{ Timeout }}' + - name: JobSample + value: + Mode: '{{ Mode }}' + Size: '{{ Size }}' + - name: ProfileConfiguration + value: + DatasetStatisticsConfiguration: + IncludedStatistics: + - '{{ IncludedStatistics[0] }}' + Overrides: + - Statistic: null + Parameters: {} + ProfileColumns: + - Regex: '{{ Regex }}' + Name: '{{ Name }}' + ColumnStatisticsConfigurations: + - Selectors: + - null + Statistics: null + EntityDetectorConfiguration: + EntityTypes: + - '{{ EntityTypes[0] }}' + AllowedStatistics: + Statistics: + - null + - name: ValidationConfigurations + value: + - RulesetArn: '{{ RulesetArn }}' + ValidationMode: '{{ ValidationMode }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.databrew.jobs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +databrew:DescribeJob, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateProfileJob, +databrew:UpdateRecipeJob, +iam:PassRole +``` + +### Delete +```json +databrew:DeleteJob +``` + +### List +```json +databrew:ListJobs, +databrew:ListTagsForResource, +iam:ListRoles +``` diff --git a/website/docs/services/databrew/jobs_list_only/index.md b/website/docs/services/databrew/jobs_list_only/index.md new file mode 100644 index 0000000..1f0eeaf --- /dev/null +++ b/website/docs/services/databrew/jobs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: jobs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - jobs_list_only + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists jobs in a region or regions, for all properties use jobs + +## Overview + + + + + + + +
Namejobs_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Job.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringJob name
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all jobs in a region. +```sql +SELECT +region, +name +FROM aws.databrew.jobs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the jobs_list_only resource, see jobs + diff --git a/website/docs/services/databrew/project_tags/index.md b/website/docs/services/databrew/project_tags/index.md new file mode 100644 index 0000000..9e20d40 --- /dev/null +++ b/website/docs/services/databrew/project_tags/index.md @@ -0,0 +1,85 @@ +--- +title: project_tags +hide_title: false +hide_table_of_contents: false +keywords: + - project_tags + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for projects in a region + +## Overview + + + + + + + +
Nameproject_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Project.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringDataset name
stringProject name
stringRecipe name
stringRole arn
objectSample
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all projects in a region. +```sql +SELECT +region, +dataset_name, +name, +recipe_name, +role_arn, +sample, +tag_key, +tag_value +FROM aws.databrew.project_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the project_tags resource, see projects + diff --git a/website/docs/services/databrew/projects/index.md b/website/docs/services/databrew/projects/index.md new file mode 100644 index 0000000..44e7111 --- /dev/null +++ b/website/docs/services/databrew/projects/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a project resource or lists projects in a region + +## Overview + + + + + + + +
Nameprojects
TypeResource
DescriptionResource schema for AWS::DataBrew::Project.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringDataset name
stringProject name
stringRecipe name
stringRole arn
objectSample
array
stringAWS region.
+ +For more information, see AWS::DataBrew::Project. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all projects in a region. +```sql +SELECT +region, +dataset_name, +name, +recipe_name, +role_arn, +sample, +tags +FROM aws.databrew.projects +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual project. +```sql +SELECT +region, +dataset_name, +name, +recipe_name, +role_arn, +sample, +tags +FROM aws.databrew.projects +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.projects ( + DatasetName, + Name, + RecipeName, + RoleArn, + region +) +SELECT +'{{ DatasetName }}', + '{{ Name }}', + '{{ RecipeName }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.projects ( + DatasetName, + Name, + RecipeName, + RoleArn, + Sample, + Tags, + region +) +SELECT + '{{ DatasetName }}', + '{{ Name }}', + '{{ RecipeName }}', + '{{ RoleArn }}', + '{{ Sample }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: project + props: + - name: DatasetName + value: '{{ DatasetName }}' + - name: Name + value: '{{ Name }}' + - name: RecipeName + value: '{{ RecipeName }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Sample + value: + Size: '{{ Size }}' + Type: '{{ Type }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.databrew.projects +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +databrew:DescribeProject, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateProject, +iam:PassRole +``` + +### Delete +```json +databrew:DeleteProject +``` + +### List +```json +databrew:ListProjects, +databrew:ListTagsForResource, +iam:ListRoles +``` diff --git a/website/docs/services/databrew/projects_list_only/index.md b/website/docs/services/databrew/projects_list_only/index.md new file mode 100644 index 0000000..7f5adf6 --- /dev/null +++ b/website/docs/services/databrew/projects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + + + +
Nameprojects_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Project.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringProject name
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +name +FROM aws.databrew.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + diff --git a/website/docs/services/databrew/recipe_tags/index.md b/website/docs/services/databrew/recipe_tags/index.md new file mode 100644 index 0000000..b2fd61a --- /dev/null +++ b/website/docs/services/databrew/recipe_tags/index.md @@ -0,0 +1,81 @@ +--- +title: recipe_tags +hide_title: false +hide_table_of_contents: false +keywords: + - recipe_tags + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for recipes in a region + +## Overview + + + + + + + +
Namerecipe_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Recipe.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringDescription of the recipe
stringRecipe name
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all recipes in a region. +```sql +SELECT +region, +description, +name, +steps, +tag_key, +tag_value +FROM aws.databrew.recipe_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recipe_tags resource, see recipes + diff --git a/website/docs/services/databrew/recipes/index.md b/website/docs/services/databrew/recipes/index.md new file mode 100644 index 0000000..585f10a --- /dev/null +++ b/website/docs/services/databrew/recipes/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a recipe resource or lists recipes in a region + +## Overview + + + + + + + +
Namerecipes
TypeResource
DescriptionResource schema for AWS::DataBrew::Recipe.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringDescription of the recipe
stringRecipe name
array
array
stringAWS region.
+ +For more information, see AWS::DataBrew::Recipe. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all recipes in a region. +```sql +SELECT +region, +description, +name, +steps, +tags +FROM aws.databrew.recipes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual recipe. +```sql +SELECT +region, +description, +name, +steps, +tags +FROM aws.databrew.recipes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new recipe resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.recipes ( + Name, + Steps, + region +) +SELECT +'{{ Name }}', + '{{ Steps }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.recipes ( + Description, + Name, + Steps, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ Steps }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: recipe + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Steps + value: + - Action: + Operation: '{{ Operation }}' + Parameters: null + ConditionExpressions: + - Condition: '{{ Condition }}' + Value: '{{ Value }}' + TargetColumn: '{{ TargetColumn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.databrew.recipes +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +databrew:DescribeRecipe, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Delete +```json +databrew:DeleteRecipeVersion +``` + +### List +```json +databrew:ListRecipes, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateRecipe +``` diff --git a/website/docs/services/databrew/recipes_list_only/index.md b/website/docs/services/databrew/recipes_list_only/index.md new file mode 100644 index 0000000..66f8a4d --- /dev/null +++ b/website/docs/services/databrew/recipes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: recipes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - recipes_list_only + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists recipes in a region or regions, for all properties use recipes + +## Overview + + + + + + + +
Namerecipes_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Recipe.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringRecipe name
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all recipes in a region. +```sql +SELECT +region, +name +FROM aws.databrew.recipes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recipes_list_only resource, see recipes + diff --git a/website/docs/services/databrew/ruleset_tags/index.md b/website/docs/services/databrew/ruleset_tags/index.md new file mode 100644 index 0000000..03f9576 --- /dev/null +++ b/website/docs/services/databrew/ruleset_tags/index.md @@ -0,0 +1,83 @@ +--- +title: ruleset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ruleset_tags + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rulesets in a region + +## Overview + + + + + + + +
Nameruleset_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Ruleset.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of the Ruleset
stringDescription of the Ruleset
stringArn of the target resource (dataset) to apply the ruleset to
arrayList of the data quality rules in the ruleset
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rulesets in a region. +```sql +SELECT +region, +name, +description, +target_arn, +rules, +tag_key, +tag_value +FROM aws.databrew.ruleset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ruleset_tags resource, see rulesets + diff --git a/website/docs/services/databrew/rulesets/index.md b/website/docs/services/databrew/rulesets/index.md new file mode 100644 index 0000000..ccc3c08 --- /dev/null +++ b/website/docs/services/databrew/rulesets/index.md @@ -0,0 +1,248 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a ruleset resource or lists rulesets in a region + +## Overview + + + + + + + +
Namerulesets
TypeResource
DescriptionResource schema for AWS::DataBrew::Ruleset.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of the Ruleset
stringDescription of the Ruleset
stringArn of the target resource (dataset) to apply the ruleset to
arrayList of the data quality rules in the ruleset
array
stringAWS region.
+ +For more information, see AWS::DataBrew::Ruleset. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rulesets in a region. +```sql +SELECT +region, +name, +description, +target_arn, +rules, +tags +FROM aws.databrew.rulesets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ruleset. +```sql +SELECT +region, +name, +description, +target_arn, +rules, +tags +FROM aws.databrew.rulesets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ruleset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.rulesets ( + Name, + TargetArn, + Rules, + region +) +SELECT +'{{ Name }}', + '{{ TargetArn }}', + '{{ Rules }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.rulesets ( + Name, + Description, + TargetArn, + Rules, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ TargetArn }}', + '{{ Rules }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ruleset + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: TargetArn + value: '{{ TargetArn }}' + - name: Rules + value: + - Name: '{{ Name }}' + Disabled: '{{ Disabled }}' + CheckExpression: '{{ CheckExpression }}' + SubstitutionMap: + - ValueReference: '{{ ValueReference }}' + Value: '{{ Value }}' + Threshold: + Value: null + Type: '{{ Type }}' + Unit: '{{ Unit }}' + ColumnSelectors: + - Regex: '{{ Regex }}' + Name: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.databrew.rulesets +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +databrew:DescribeRuleset, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateRuleset +``` + +### Delete +```json +databrew:DeleteRuleset +``` + +### List +```json +databrew:ListRulesets, +databrew:ListTagsForResource, +iam:ListRoles +``` diff --git a/website/docs/services/databrew/rulesets_list_only/index.md b/website/docs/services/databrew/rulesets_list_only/index.md new file mode 100644 index 0000000..707a607 --- /dev/null +++ b/website/docs/services/databrew/rulesets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: rulesets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rulesets_list_only + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rulesets in a region or regions, for all properties use rulesets + +## Overview + + + + + + + +
Namerulesets_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Ruleset.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the Ruleset
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rulesets in a region. +```sql +SELECT +region, +name +FROM aws.databrew.rulesets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rulesets_list_only resource, see rulesets + diff --git a/website/docs/services/databrew/schedule_tags/index.md b/website/docs/services/databrew/schedule_tags/index.md new file mode 100644 index 0000000..2a80263 --- /dev/null +++ b/website/docs/services/databrew/schedule_tags/index.md @@ -0,0 +1,81 @@ +--- +title: schedule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - schedule_tags + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for schedules in a region + +## Overview + + + + + + + +
Nameschedule_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Schedule.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
array
stringSchedule cron
stringSchedule Name
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all schedules in a region. +```sql +SELECT +region, +job_names, +cron_expression, +name, +tag_key, +tag_value +FROM aws.databrew.schedule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schedule_tags resource, see schedules + diff --git a/website/docs/services/databrew/schedules/index.md b/website/docs/services/databrew/schedules/index.md new file mode 100644 index 0000000..974e974 --- /dev/null +++ b/website/docs/services/databrew/schedules/index.md @@ -0,0 +1,227 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a schedule resource or lists schedules in a region + +## Overview + + + + + + + +
Nameschedules
TypeResource
DescriptionResource schema for AWS::DataBrew::Schedule.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
array
stringSchedule cron
stringSchedule Name
array
stringAWS region.
+ +For more information, see AWS::DataBrew::Schedule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all schedules in a region. +```sql +SELECT +region, +job_names, +cron_expression, +name, +tags +FROM aws.databrew.schedules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual schedule. +```sql +SELECT +region, +job_names, +cron_expression, +name, +tags +FROM aws.databrew.schedules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new schedule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.schedules ( + CronExpression, + Name, + region +) +SELECT +'{{ CronExpression }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.databrew.schedules ( + JobNames, + CronExpression, + Name, + Tags, + region +) +SELECT + '{{ JobNames }}', + '{{ CronExpression }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: schedule + props: + - name: JobNames + value: + - '{{ JobNames[0] }}' + - name: CronExpression + value: '{{ CronExpression }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.databrew.schedules +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +databrew:DescribeSchedule, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateSchedule +``` + +### Delete +```json +databrew:DeleteSchedule +``` + +### List +```json +databrew:ListSchedules, +databrew:ListTagsForResource, +iam:ListRoles +``` diff --git a/website/docs/services/databrew/schedules_list_only/index.md b/website/docs/services/databrew/schedules_list_only/index.md new file mode 100644 index 0000000..7bdf297 --- /dev/null +++ b/website/docs/services/databrew/schedules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: schedules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schedules_list_only + - databrew + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schedules in a region or regions, for all properties use schedules + +## Overview + + + + + + + +
Nameschedules_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Schedule.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringSchedule Name
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schedules in a region. +```sql +SELECT +region, +name +FROM aws.databrew.schedules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schedules_list_only resource, see schedules + diff --git a/website/docs/services/datapipeline/index.md b/website/docs/services/datapipeline/index.md new file mode 100644 index 0000000..081d367 --- /dev/null +++ b/website/docs/services/datapipeline/index.md @@ -0,0 +1,37 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The datapipeline service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/datapipeline/pipelines/index.md b/website/docs/services/datapipeline/pipelines/index.md new file mode 100644 index 0000000..dcd3b31 --- /dev/null +++ b/website/docs/services/datapipeline/pipelines/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a pipeline resource or lists pipelines in a region + +## Overview + + + + + + + +
Namepipelines
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
stringA description of the pipeline.
stringThe name of the pipeline.
arrayThe parameter objects used with the pipeline.
arrayThe parameter values used with the pipeline.
arrayThe objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
arrayA list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.
string
stringAWS region.
+ +For more information, see AWS::DataPipeline::Pipeline. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all pipelines in a region. +```sql +SELECT +region, +activate, +description, +name, +parameter_objects, +parameter_values, +pipeline_objects, +pipeline_tags, +pipeline_id +FROM aws.datapipeline.pipelines +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual pipeline. +```sql +SELECT +region, +activate, +description, +name, +parameter_objects, +parameter_values, +pipeline_objects, +pipeline_tags, +pipeline_id +FROM aws.datapipeline.pipelines +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datapipeline.pipelines ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datapipeline.pipelines ( + Activate, + Description, + Name, + ParameterObjects, + ParameterValues, + PipelineObjects, + PipelineTags, + region +) +SELECT + '{{ Activate }}', + '{{ Description }}', + '{{ Name }}', + '{{ ParameterObjects }}', + '{{ ParameterValues }}', + '{{ PipelineObjects }}', + '{{ PipelineTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: pipeline + props: + - name: Activate + value: '{{ Activate }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: ParameterObjects + value: + - Attributes: + - Key: '{{ Key }}' + StringValue: '{{ StringValue }}' + Id: '{{ Id }}' + - name: ParameterValues + value: + - Id: '{{ Id }}' + StringValue: '{{ StringValue }}' + - name: PipelineObjects + value: + - Fields: + - Key: '{{ Key }}' + RefValue: '{{ RefValue }}' + StringValue: '{{ StringValue }}' + Id: '{{ Id }}' + Name: '{{ Name }}' + - name: PipelineTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datapipeline.pipelines +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +datapipeline:ListPipelines +``` diff --git a/website/docs/services/datapipeline/pipelines_list_only/index.md b/website/docs/services/datapipeline/pipelines_list_only/index.md new file mode 100644 index 0000000..2edd3b3 --- /dev/null +++ b/website/docs/services/datapipeline/pipelines_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipelines in a region or regions, for all properties use pipelines + +## Overview + + + + + + + +
Namepipelines_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipelines in a region. +```sql +SELECT +region, +pipeline_id +FROM aws.datapipeline.pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipelines_list_only resource, see pipelines + diff --git a/website/docs/services/datasync/agent_tags/index.md b/website/docs/services/datasync/agent_tags/index.md new file mode 100644 index 0000000..4700480 --- /dev/null +++ b/website/docs/services/datasync/agent_tags/index.md @@ -0,0 +1,89 @@ +--- +title: agent_tags +hide_title: false +hide_table_of_contents: false +keywords: + - agent_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for agents in a region + +## Overview + + + + + + + +
Nameagent_tags
TypeResource
DescriptionResource schema for AWS::DataSync::Agent.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name configured for the agent. Text reference used to identify the agent in the console.
stringActivation key of the Agent.
arrayThe ARNs of the security group used to protect your data transfer task subnets.
arrayThe ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
stringThe ID of the VPC endpoint that the agent has access to.
stringThe service endpoints that the agent will connect to.
stringThe DataSync Agent ARN.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all agents in a region. +```sql +SELECT +region, +agent_name, +activation_key, +security_group_arns, +subnet_arns, +vpc_endpoint_id, +endpoint_type, +agent_arn, +tag_key, +tag_value +FROM aws.datasync.agent_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agent_tags resource, see agents + diff --git a/website/docs/services/datasync/agents/index.md b/website/docs/services/datasync/agents/index.md new file mode 100644 index 0000000..9ea31ee --- /dev/null +++ b/website/docs/services/datasync/agents/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an agent resource or lists agents in a region + +## Overview + + + + + + + +
Nameagents
TypeResource
DescriptionResource schema for AWS::DataSync::Agent.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name configured for the agent. Text reference used to identify the agent in the console.
stringActivation key of the Agent.
arrayThe ARNs of the security group used to protect your data transfer task subnets.
arrayThe ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
stringThe ID of the VPC endpoint that the agent has access to.
stringThe service endpoints that the agent will connect to.
arrayAn array of key-value pairs to apply to this resource.
stringThe DataSync Agent ARN.
stringAWS region.
+ +For more information, see AWS::DataSync::Agent. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all agents in a region. +```sql +SELECT +region, +agent_name, +activation_key, +security_group_arns, +subnet_arns, +vpc_endpoint_id, +endpoint_type, +tags, +agent_arn +FROM aws.datasync.agents +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual agent. +```sql +SELECT +region, +agent_name, +activation_key, +security_group_arns, +subnet_arns, +vpc_endpoint_id, +endpoint_type, +tags, +agent_arn +FROM aws.datasync.agents +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new agent resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.agents ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.agents ( + AgentName, + ActivationKey, + SecurityGroupArns, + SubnetArns, + VpcEndpointId, + Tags, + region +) +SELECT + '{{ AgentName }}', + '{{ ActivationKey }}', + '{{ SecurityGroupArns }}', + '{{ SubnetArns }}', + '{{ VpcEndpointId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: agent + props: + - name: AgentName + value: '{{ AgentName }}' + - name: ActivationKey + value: '{{ ActivationKey }}' + - name: SecurityGroupArns + value: + - '{{ SecurityGroupArns[0] }}' + - name: SubnetArns + value: + - '{{ SubnetArns[0] }}' + - name: VpcEndpointId + value: '{{ VpcEndpointId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.agents +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +datasync:DescribeAgent, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:UpdateAgent, +datasync:DescribeAgent, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteAgent +``` + +### List +```json +datasync:ListAgents +``` diff --git a/website/docs/services/datasync/agents_list_only/index.md b/website/docs/services/datasync/agents_list_only/index.md new file mode 100644 index 0000000..b3a63f6 --- /dev/null +++ b/website/docs/services/datasync/agents_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: agents_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - agents_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists agents in a region or regions, for all properties use agents + +## Overview + + + + + + + +
Nameagents_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::Agent.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe DataSync Agent ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all agents in a region. +```sql +SELECT +region, +agent_arn +FROM aws.datasync.agents_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agents_list_only resource, see agents + diff --git a/website/docs/services/datasync/index.md b/website/docs/services/datasync/index.md new file mode 100644 index 0000000..2e67e3c --- /dev/null +++ b/website/docs/services/datasync/index.md @@ -0,0 +1,77 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The datasync service documentation. + +:::info Service Summary + +
+
+total resources: 42
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/datasync/location_azure_blob_tags/index.md b/website/docs/services/datasync/location_azure_blob_tags/index.md new file mode 100644 index 0000000..9d5782f --- /dev/null +++ b/website/docs/services/datasync/location_azure_blob_tags/index.md @@ -0,0 +1,93 @@ +--- +title: location_azure_blob_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_azure_blob_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_azure_blobs in a region + +## Overview + + + + + + + +
Namelocation_azure_blob_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationAzureBlob.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location.
stringThe specific authentication type that you want DataSync to use to access your Azure Blob Container.
objectSpecifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.
stringThe URL of the Azure Blob container that was described.
stringSpecifies a blob type for the objects you're transferring into your Azure Blob Storage container.
stringSpecifies an access tier for the objects you're transferring into your Azure Blob Storage container.
stringThe subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
stringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
stringThe URL of the Azure Blob Location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_azure_blobs in a region. +```sql +SELECT +region, +agent_arns, +azure_blob_authentication_type, +azure_blob_sas_configuration, +azure_blob_container_url, +azure_blob_type, +azure_access_tier, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_azure_blob_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_azure_blob_tags resource, see location_azure_blobs + diff --git a/website/docs/services/datasync/location_azure_blobs/index.md b/website/docs/services/datasync/location_azure_blobs/index.md new file mode 100644 index 0000000..7e25db2 --- /dev/null +++ b/website/docs/services/datasync/location_azure_blobs/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a location_azure_blob resource or lists location_azure_blobs in a region + +## Overview + + + + + + + +
Namelocation_azure_blobs
TypeResource
DescriptionResource schema for AWS::DataSync::LocationAzureBlob.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location.
stringThe specific authentication type that you want DataSync to use to access your Azure Blob Container.
objectSpecifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.
stringThe URL of the Azure Blob container that was described.
stringSpecifies a blob type for the objects you're transferring into your Azure Blob Storage container.
stringSpecifies an access tier for the objects you're transferring into your Azure Blob Storage container.
stringThe subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
stringThe URL of the Azure Blob Location that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationAzureBlob. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all location_azure_blobs in a region. +```sql +SELECT +region, +agent_arns, +azure_blob_authentication_type, +azure_blob_sas_configuration, +azure_blob_container_url, +azure_blob_type, +azure_access_tier, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.location_azure_blobs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual location_azure_blob. +```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_blobs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new location_azure_blob resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_azure_blobs ( + AgentArns, + AzureBlobAuthenticationType, + region +) +SELECT +'{{ AgentArns }}', + '{{ AzureBlobAuthenticationType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_azure_blobs ( + AgentArns, + AzureBlobAuthenticationType, + AzureBlobSasConfiguration, + AzureBlobContainerUrl, + AzureBlobType, + AzureAccessTier, + Subdirectory, + Tags, + region +) +SELECT + '{{ AgentArns }}', + '{{ AzureBlobAuthenticationType }}', + '{{ AzureBlobSasConfiguration }}', + '{{ AzureBlobContainerUrl }}', + '{{ AzureBlobType }}', + '{{ AzureAccessTier }}', + '{{ Subdirectory }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: location_azure_blob + props: + - name: AgentArns + value: + - '{{ AgentArns[0] }}' + - name: AzureBlobAuthenticationType + value: '{{ AzureBlobAuthenticationType }}' + - name: AzureBlobSasConfiguration + value: + AzureBlobSasToken: '{{ AzureBlobSasToken }}' + - name: AzureBlobContainerUrl + value: '{{ AzureBlobContainerUrl }}' + - name: AzureBlobType + value: '{{ AzureBlobType }}' + - name: AzureAccessTier + value: '{{ AzureAccessTier }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.location_azure_blobs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +datasync:DescribeLocationAzureBlob, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationAzureBlob, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource, +datasync:UpdateLocationAzureBlob +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/location_azure_blobs_list_only/index.md b/website/docs/services/datasync/location_azure_blobs_list_only/index.md new file mode 100644 index 0000000..bf532f7 --- /dev/null +++ b/website/docs/services/datasync/location_azure_blobs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: location_azure_blobs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_azure_blobs_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_azure_blobs in a region or regions, for all properties use location_azure_blobs + +## Overview + + + + + + + +
Namelocation_azure_blobs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationAzureBlob.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_azure_blobs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_azure_blobs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_azure_blobs_list_only resource, see location_azure_blobs + diff --git a/website/docs/services/datasync/location_efs/index.md b/website/docs/services/datasync/location_efs/index.md new file mode 100644 index 0000000..050f5cf --- /dev/null +++ b/website/docs/services/datasync/location_efs/index.md @@ -0,0 +1,260 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a location_ef resource or lists location_efs in a region + +## Overview + + + + + + + +
Namelocation_efs
TypeResource
DescriptionResource schema for AWS::DataSync::LocationEFS.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe subnet and security group that DataSync uses to access target EFS file system.
stringThe Amazon Resource Name (ARN) for the Amazon EFS file system.
stringThe Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.
stringThe Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.
stringProtocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.
stringA subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
stringThe URL of the EFS location that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationEFS. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all location_efs in a region. +```sql +SELECT +region, +ec2_config, +efs_filesystem_arn, +access_point_arn, +file_system_access_role_arn, +in_transit_encryption, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.location_efs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual location_ef. +```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 region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new location_ef resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_efs ( + Ec2Config, + region +) +SELECT +'{{ Ec2Config }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_efs ( + Ec2Config, + EfsFilesystemArn, + AccessPointArn, + FileSystemAccessRoleArn, + InTransitEncryption, + Subdirectory, + Tags, + region +) +SELECT + '{{ Ec2Config }}', + '{{ EfsFilesystemArn }}', + '{{ AccessPointArn }}', + '{{ FileSystemAccessRoleArn }}', + '{{ InTransitEncryption }}', + '{{ Subdirectory }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: location_ef + props: + - name: Ec2Config + value: + SecurityGroupArns: + - '{{ SecurityGroupArns[0] }}' + SubnetArn: '{{ SubnetArn }}' + - name: EfsFilesystemArn + value: '{{ EfsFilesystemArn }}' + - name: AccessPointArn + value: '{{ AccessPointArn }}' + - name: FileSystemAccessRoleArn + value: '{{ FileSystemAccessRoleArn }}' + - name: InTransitEncryption + value: '{{ InTransitEncryption }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.location_efs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the location_efs resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationEfs, +datasync:DescribeLocationEfs, +datasync:ListTagsForResource, +datasync:TagResource, +elasticfilesystem:DescribeFileSystems, +elasticfilesystem:DescribeMountTargets, +elasticfilesystem:DescribeAccessPoints, +iam:PassRole, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups +``` + +### Read +```json +datasync:DescribeLocationEfs, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationEfs, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/location_efs_list_only/index.md b/website/docs/services/datasync/location_efs_list_only/index.md new file mode 100644 index 0000000..3e9603b --- /dev/null +++ b/website/docs/services/datasync/location_efs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: location_efs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_efs_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_efs in a region or regions, for all properties use location_efs + +## Overview + + + + + + + +
Namelocation_efs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationEFS.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_efs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_efs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_efs_list_only resource, see location_efs + diff --git a/website/docs/services/datasync/location_efs_tags/index.md b/website/docs/services/datasync/location_efs_tags/index.md new file mode 100644 index 0000000..bc30c22 --- /dev/null +++ b/website/docs/services/datasync/location_efs_tags/index.md @@ -0,0 +1,91 @@ +--- +title: location_efs_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_efs_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_efs in a region + +## Overview + + + + + + + +
Namelocation_efs_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationEFS.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe subnet and security group that DataSync uses to access target EFS file system.
stringThe Amazon Resource Name (ARN) for the Amazon EFS file system.
stringThe Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.
stringThe Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.
stringProtocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.
stringA subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination.
stringThe Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
stringThe URL of the EFS location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_efs in a region. +```sql +SELECT +region, +ec2_config, +efs_filesystem_arn, +access_point_arn, +file_system_access_role_arn, +in_transit_encryption, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_efs_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_efs_tags resource, see location_efs + diff --git a/website/docs/services/datasync/location_hdfs/index.md b/website/docs/services/datasync/location_hdfs/index.md new file mode 100644 index 0000000..fb1a361 --- /dev/null +++ b/website/docs/services/datasync/location_hdfs/index.md @@ -0,0 +1,303 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a location_hdf resource or lists location_hdfs in a region + +## Overview + + + + + + + +
Namelocation_hdfs
TypeResource
DescriptionResource schema for AWS::DataSync::LocationHDFS.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of Name Node(s) of the HDFS location.
integerSize of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.
integerNumber of copies of each block that exists inside the HDFS cluster.
stringThe identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.
objectConfiguration information for RPC Protection and Data Transfer Protection. These parameters can be set to AUTHENTICATION, INTEGRITY, or PRIVACY. The default value is PRIVACY.
stringThe authentication mode used to determine identity of user.
stringThe user name that has read and write permissions on the specified HDFS cluster.
stringThe unique identity, or principal, to which Kerberos can assign tickets.
stringThe Base64 string representation of the Keytab file.
stringThe string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
arrayAn array of key-value pairs to apply to this resource.
arrayARN(s) of the agent(s) to use for an HDFS location.
stringThe subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.
stringThe Amazon Resource Name (ARN) of the HDFS location.
stringThe URL of the HDFS location that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationHDFS. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all location_hdfs in a region. +```sql +SELECT +region, +name_nodes, +block_size, +replication_factor, +kms_key_provider_uri, +qop_configuration, +authentication_type, +simple_user, +kerberos_principal, +kerberos_keytab, +kerberos_krb5_conf, +tags, +agent_arns, +subdirectory, +location_arn, +location_uri +FROM aws.datasync.location_hdfs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual location_hdf. +```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 region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new location_hdf resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_hdfs ( + NameNodes, + AuthenticationType, + AgentArns, + region +) +SELECT +'{{ NameNodes }}', + '{{ AuthenticationType }}', + '{{ AgentArns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_hdfs ( + NameNodes, + BlockSize, + ReplicationFactor, + KmsKeyProviderUri, + QopConfiguration, + AuthenticationType, + SimpleUser, + KerberosPrincipal, + KerberosKeytab, + KerberosKrb5Conf, + Tags, + AgentArns, + Subdirectory, + region +) +SELECT + '{{ NameNodes }}', + '{{ BlockSize }}', + '{{ ReplicationFactor }}', + '{{ KmsKeyProviderUri }}', + '{{ QopConfiguration }}', + '{{ AuthenticationType }}', + '{{ SimpleUser }}', + '{{ KerberosPrincipal }}', + '{{ KerberosKeytab }}', + '{{ KerberosKrb5Conf }}', + '{{ Tags }}', + '{{ AgentArns }}', + '{{ Subdirectory }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: location_hdf + props: + - name: NameNodes + value: + - Hostname: '{{ Hostname }}' + Port: '{{ Port }}' + - name: BlockSize + value: '{{ BlockSize }}' + - name: ReplicationFactor + value: '{{ ReplicationFactor }}' + - name: KmsKeyProviderUri + value: '{{ KmsKeyProviderUri }}' + - name: QopConfiguration + value: + RpcProtection: '{{ RpcProtection }}' + DataTransferProtection: '{{ DataTransferProtection }}' + - name: AuthenticationType + value: '{{ AuthenticationType }}' + - name: SimpleUser + value: '{{ SimpleUser }}' + - name: KerberosPrincipal + value: '{{ KerberosPrincipal }}' + - name: KerberosKeytab + value: '{{ KerberosKeytab }}' + - name: KerberosKrb5Conf + value: '{{ KerberosKrb5Conf }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AgentArns + value: + - '{{ AgentArns[0] }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.location_hdfs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the location_hdfs resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationHdfs, +datasync:DescribeLocationHdfs, +datasync:TagResource, +datasync:ListTagsForResource +``` + +### Read +```json +datasync:DescribeLocationHdfs, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:UpdateLocationHdfs, +datasync:DescribeLocationHdfs, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/location_hdfs_list_only/index.md b/website/docs/services/datasync/location_hdfs_list_only/index.md new file mode 100644 index 0000000..6883a7d --- /dev/null +++ b/website/docs/services/datasync/location_hdfs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: location_hdfs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_hdfs_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_hdfs in a region or regions, for all properties use location_hdfs + +## Overview + + + + + + + +
Namelocation_hdfs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationHDFS.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the HDFS location.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_hdfs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_hdfs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_hdfs_list_only resource, see location_hdfs + diff --git a/website/docs/services/datasync/location_hdfs_tags/index.md b/website/docs/services/datasync/location_hdfs_tags/index.md new file mode 100644 index 0000000..4199f65 --- /dev/null +++ b/website/docs/services/datasync/location_hdfs_tags/index.md @@ -0,0 +1,103 @@ +--- +title: location_hdfs_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_hdfs_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_hdfs in a region + +## Overview + + + + + + + +
Namelocation_hdfs_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationHDFS.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of Name Node(s) of the HDFS location.
integerSize of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.
integerNumber of copies of each block that exists inside the HDFS cluster.
stringThe identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.
objectConfiguration information for RPC Protection and Data Transfer Protection. These parameters can be set to AUTHENTICATION, INTEGRITY, or PRIVACY. The default value is PRIVACY.
stringThe authentication mode used to determine identity of user.
stringThe user name that has read and write permissions on the specified HDFS cluster.
stringThe unique identity, or principal, to which Kerberos can assign tickets.
stringThe Base64 string representation of the Keytab file.
stringThe string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
arrayARN(s) of the agent(s) to use for an HDFS location.
stringThe subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.
stringThe Amazon Resource Name (ARN) of the HDFS location.
stringThe URL of the HDFS location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_hdfs in a region. +```sql +SELECT +region, +name_nodes, +block_size, +replication_factor, +kms_key_provider_uri, +qop_configuration, +authentication_type, +simple_user, +kerberos_principal, +kerberos_keytab, +kerberos_krb5_conf, +agent_arns, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_hdfs_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_hdfs_tags resource, see location_hdfs + diff --git a/website/docs/services/datasync/location_nfs/index.md b/website/docs/services/datasync/location_nfs/index.md new file mode 100644 index 0000000..9f73d11 --- /dev/null +++ b/website/docs/services/datasync/location_nfs/index.md @@ -0,0 +1,241 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a location_nf resource or lists location_nfs in a region + +## Overview + + + + + + + +
Namelocation_nfs
TypeResource
DescriptionResource schema for AWS::DataSync::LocationNFS
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThe mount options used by DataSync to access the SMB server.
objectContains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.
stringThe name of the NFS server. This value is the IP address or DNS name of the NFS server.
stringThe subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the NFS location.
stringThe URL of the NFS location that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationNFS. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all location_nfs in a region. +```sql +SELECT +region, +mount_options, +on_prem_config, +server_hostname, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.location_nfs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual location_nf. +```sql +SELECT +region, +mount_options, +on_prem_config, +server_hostname, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.location_nfs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new location_nf resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_nfs ( + OnPremConfig, + region +) +SELECT +'{{ OnPremConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_nfs ( + MountOptions, + OnPremConfig, + ServerHostname, + Subdirectory, + Tags, + region +) +SELECT + '{{ MountOptions }}', + '{{ OnPremConfig }}', + '{{ ServerHostname }}', + '{{ Subdirectory }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: location_nf + props: + - name: MountOptions + value: + Version: '{{ Version }}' + - name: OnPremConfig + value: + AgentArns: + - '{{ AgentArns[0] }}' + - name: ServerHostname + value: '{{ ServerHostname }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.location_nfs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the location_nfs resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationNfs, +datasync:DescribeLocationNfs, +datasync:ListTagsForResource, +datasync:TagResource +``` + +### Read +```json +datasync:DescribeLocationNfs, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationNfs, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource, +datasync:UpdateLocationNfs +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/location_nfs_list_only/index.md b/website/docs/services/datasync/location_nfs_list_only/index.md new file mode 100644 index 0000000..9f05b80 --- /dev/null +++ b/website/docs/services/datasync/location_nfs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: location_nfs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_nfs_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_nfs in a region or regions, for all properties use location_nfs + +## Overview + + + + + + + +
Namelocation_nfs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationNFS
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the NFS location.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_nfs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_nfs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_nfs_list_only resource, see location_nfs + diff --git a/website/docs/services/datasync/location_nfs_tags/index.md b/website/docs/services/datasync/location_nfs_tags/index.md new file mode 100644 index 0000000..e9052fb --- /dev/null +++ b/website/docs/services/datasync/location_nfs_tags/index.md @@ -0,0 +1,87 @@ +--- +title: location_nfs_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_nfs_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_nfs in a region + +## Overview + + + + + + + +
Namelocation_nfs_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationNFS
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectThe mount options used by DataSync to access the SMB server.
objectContains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.
stringThe name of the NFS server. This value is the IP address or DNS name of the NFS server.
stringThe subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
stringThe Amazon Resource Name (ARN) of the NFS location.
stringThe URL of the NFS location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_nfs in a region. +```sql +SELECT +region, +mount_options, +on_prem_config, +server_hostname, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_nfs_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_nfs_tags resource, see location_nfs + diff --git a/website/docs/services/datasync/location_object_storage_tags/index.md b/website/docs/services/datasync/location_object_storage_tags/index.md new file mode 100644 index 0000000..6fe11fb --- /dev/null +++ b/website/docs/services/datasync/location_object_storage_tags/index.md @@ -0,0 +1,97 @@ +--- +title: location_object_storage_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_object_storage_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_object_storages in a region + +## Overview + + + + + + + +
Namelocation_object_storage_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationObjectStorage.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringOptional. The access key is used if credentials are required to access the self-managed object storage server.
arrayThe Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
stringThe name of the bucket on the self-managed object storage server.
stringOptional. The secret key is used if credentials are required to access the self-managed object storage server.
stringX.509 PEM content containing a certificate authority or chain to trust.
stringThe name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
integerThe port that your self-managed server accepts inbound network traffic on.
stringThe protocol that the object storage server uses to communicate.
stringThe subdirectory in the self-managed object storage server that is used to read data from.
stringThe Amazon Resource Name (ARN) of the location that is created.
stringThe URL of the object storage location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_object_storages in a region. +```sql +SELECT +region, +access_key, +agent_arns, +bucket_name, +secret_key, +server_certificate, +server_hostname, +server_port, +server_protocol, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_object_storage_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_object_storage_tags resource, see location_object_storages + diff --git a/website/docs/services/datasync/location_object_storages/index.md b/website/docs/services/datasync/location_object_storages/index.md new file mode 100644 index 0000000..3921e84 --- /dev/null +++ b/website/docs/services/datasync/location_object_storages/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a location_object_storage resource or lists location_object_storages in a region + +## Overview + + + + + + + +
Namelocation_object_storages
TypeResource
DescriptionResource schema for AWS::DataSync::LocationObjectStorage.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringOptional. The access key is used if credentials are required to access the self-managed object storage server.
arrayThe Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
stringThe name of the bucket on the self-managed object storage server.
stringOptional. The secret key is used if credentials are required to access the self-managed object storage server.
stringX.509 PEM content containing a certificate authority or chain to trust.
stringThe name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
integerThe port that your self-managed server accepts inbound network traffic on.
stringThe protocol that the object storage server uses to communicate.
stringThe subdirectory in the self-managed object storage server that is used to read data from.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the location that is created.
stringThe URL of the object storage location that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationObjectStorage. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all location_object_storages in a region. +```sql +SELECT +region, +access_key, +agent_arns, +bucket_name, +secret_key, +server_certificate, +server_hostname, +server_port, +server_protocol, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.location_object_storages +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual location_object_storage. +```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_storages +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new location_object_storage resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_object_storages ( + AgentArns, + region +) +SELECT +'{{ AgentArns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_object_storages ( + AccessKey, + AgentArns, + BucketName, + SecretKey, + ServerCertificate, + ServerHostname, + ServerPort, + ServerProtocol, + Subdirectory, + Tags, + region +) +SELECT + '{{ AccessKey }}', + '{{ AgentArns }}', + '{{ BucketName }}', + '{{ SecretKey }}', + '{{ ServerCertificate }}', + '{{ ServerHostname }}', + '{{ ServerPort }}', + '{{ ServerProtocol }}', + '{{ Subdirectory }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: location_object_storage + props: + - name: AccessKey + value: '{{ AccessKey }}' + - name: AgentArns + value: + - '{{ AgentArns[0] }}' + - name: BucketName + value: '{{ BucketName }}' + - name: SecretKey + value: '{{ SecretKey }}' + - name: ServerCertificate + value: '{{ ServerCertificate }}' + - name: ServerHostname + value: '{{ ServerHostname }}' + - name: ServerPort + value: '{{ ServerPort }}' + - name: ServerProtocol + value: '{{ ServerProtocol }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.location_object_storages +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +datasync:DescribeLocationObjectStorage, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationObjectStorage, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource, +datasync:UpdateLocationObjectStorage +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/location_object_storages_list_only/index.md b/website/docs/services/datasync/location_object_storages_list_only/index.md new file mode 100644 index 0000000..1e8870f --- /dev/null +++ b/website/docs/services/datasync/location_object_storages_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: location_object_storages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_object_storages_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_object_storages in a region or regions, for all properties use location_object_storages + +## Overview + + + + + + + +
Namelocation_object_storages_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationObjectStorage.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the location that is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_object_storages in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_object_storages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_object_storages_list_only resource, see location_object_storages + diff --git a/website/docs/services/datasync/location_s3_tags/index.md b/website/docs/services/datasync/location_s3_tags/index.md new file mode 100644 index 0000000..0b43461 --- /dev/null +++ b/website/docs/services/datasync/location_s3_tags/index.md @@ -0,0 +1,87 @@ +--- +title: location_s3_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_s3_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_s3s in a region + +## Overview + + + + + + + +
Namelocation_s3_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationS3
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectThe Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.
stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket.
stringA subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
stringThe Amazon S3 storage class you want to store your files in when this location is used as a task destination.
stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
stringThe URL of the S3 location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_s3s in a region. +```sql +SELECT +region, +s3_config, +s3_bucket_arn, +subdirectory, +s3_storage_class, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_s3_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_s3_tags resource, see location_s3s + diff --git a/website/docs/services/datasync/location_s3s/index.md b/website/docs/services/datasync/location_s3s/index.md new file mode 100644 index 0000000..0d52e68 --- /dev/null +++ b/website/docs/services/datasync/location_s3s/index.md @@ -0,0 +1,242 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a location_s3 resource or lists location_s3s in a region + +## Overview + + + + + + + +
Namelocation_s3s
TypeResource
DescriptionResource schema for AWS::DataSync::LocationS3
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThe Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.
stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket.
stringA subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
stringThe Amazon S3 storage class you want to store your files in when this location is used as a task destination.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
stringThe URL of the S3 location that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationS3. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all location_s3s in a region. +```sql +SELECT +region, +s3_config, +s3_bucket_arn, +subdirectory, +s3_storage_class, +tags, +location_arn, +location_uri +FROM aws.datasync.location_s3s +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual location_s3. +```sql +SELECT +region, +s3_config, +s3_bucket_arn, +subdirectory, +s3_storage_class, +tags, +location_arn, +location_uri +FROM aws.datasync.location_s3s +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new location_s3 resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_s3s ( + S3Config, + region +) +SELECT +'{{ S3Config }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_s3s ( + S3Config, + S3BucketArn, + Subdirectory, + S3StorageClass, + Tags, + region +) +SELECT + '{{ S3Config }}', + '{{ S3BucketArn }}', + '{{ Subdirectory }}', + '{{ S3StorageClass }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: location_s3 + props: + - name: S3Config + value: + BucketAccessRoleArn: '{{ BucketAccessRoleArn }}' + - name: S3BucketArn + value: '{{ S3BucketArn }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + - name: S3StorageClass + value: '{{ S3StorageClass }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.location_s3s +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +datasync:DescribeLocationS3, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationS3, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/location_s3s_list_only/index.md b/website/docs/services/datasync/location_s3s_list_only/index.md new file mode 100644 index 0000000..120b62c --- /dev/null +++ b/website/docs/services/datasync/location_s3s_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: location_s3s_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_s3s_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_s3s in a region or regions, for all properties use location_s3s + +## Overview + + + + + + + +
Namelocation_s3s_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationS3
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_s3s in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_s3s_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_s3s_list_only resource, see location_s3s + diff --git a/website/docs/services/datasync/location_smb_tags/index.md b/website/docs/services/datasync/location_smb_tags/index.md new file mode 100644 index 0000000..0c0ee6f --- /dev/null +++ b/website/docs/services/datasync/location_smb_tags/index.md @@ -0,0 +1,93 @@ +--- +title: location_smb_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_smb_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_smbs in a region + +## Overview + + + + + + + +
Namelocation_smb_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationSMB.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
stringThe name of the Windows domain that the SMB server belongs to.
objectThe mount options used by DataSync to access the SMB server.
stringThe password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
stringThe name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
stringThe subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
stringThe user who can mount the share, has the permissions to access files and folders in the SMB share.
stringThe Amazon Resource Name (ARN) of the SMB location that is created.
stringThe URL of the SMB location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_smbs in a region. +```sql +SELECT +region, +agent_arns, +domain, +mount_options, +password, +server_hostname, +subdirectory, +user, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_smb_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_smb_tags resource, see location_smbs + diff --git a/website/docs/services/datasync/location_smbs/index.md b/website/docs/services/datasync/location_smbs/index.md new file mode 100644 index 0000000..91f5407 --- /dev/null +++ b/website/docs/services/datasync/location_smbs/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a location_smb resource or lists location_smbs in a region + +## Overview + + + + + + + +
Namelocation_smbs
TypeResource
DescriptionResource schema for AWS::DataSync::LocationSMB.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
stringThe name of the Windows domain that the SMB server belongs to.
objectThe mount options used by DataSync to access the SMB server.
stringThe password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
stringThe name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
stringThe subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
stringThe user who can mount the share, has the permissions to access files and folders in the SMB share.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the SMB location that is created.
stringThe URL of the SMB location that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationSMB. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all location_smbs in a region. +```sql +SELECT +region, +agent_arns, +domain, +mount_options, +password, +server_hostname, +subdirectory, +user, +tags, +location_arn, +location_uri +FROM aws.datasync.location_smbs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual location_smb. +```sql +SELECT +region, +agent_arns, +domain, +mount_options, +password, +server_hostname, +subdirectory, +user, +tags, +location_arn, +location_uri +FROM aws.datasync.location_smbs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new location_smb resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_smbs ( + AgentArns, + User, + region +) +SELECT +'{{ AgentArns }}', + '{{ User }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.location_smbs ( + AgentArns, + Domain, + MountOptions, + Password, + ServerHostname, + Subdirectory, + User, + Tags, + region +) +SELECT + '{{ AgentArns }}', + '{{ Domain }}', + '{{ MountOptions }}', + '{{ Password }}', + '{{ ServerHostname }}', + '{{ Subdirectory }}', + '{{ User }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: location_smb + props: + - name: AgentArns + value: + - '{{ AgentArns[0] }}' + - name: Domain + value: '{{ Domain }}' + - name: MountOptions + value: + Version: '{{ Version }}' + - name: Password + value: '{{ Password }}' + - name: ServerHostname + value: '{{ ServerHostname }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + - name: User + value: '{{ User }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.location_smbs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +datasync:DescribeLocationSmb, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationSmb, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource, +datasync:UpdateLocationSmb +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/location_smbs_list_only/index.md b/website/docs/services/datasync/location_smbs_list_only/index.md new file mode 100644 index 0000000..9922f36 --- /dev/null +++ b/website/docs/services/datasync/location_smbs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: location_smbs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_smbs_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_smbs in a region or regions, for all properties use location_smbs + +## Overview + + + + + + + +
Namelocation_smbs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationSMB.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the SMB location that is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_smbs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_smbs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_smbs_list_only resource, see location_smbs + diff --git a/website/docs/services/datasync/locationf_sx_lustre_tags/index.md b/website/docs/services/datasync/locationf_sx_lustre_tags/index.md new file mode 100644 index 0000000..b92b7b6 --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_lustre_tags/index.md @@ -0,0 +1,85 @@ +--- +title: locationf_sx_lustre_tags +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_lustre_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for locationf_sx_lustres in a region + +## Overview + + + + + + + +
Namelocationf_sx_lustre_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxLustre.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx for Lustre file system.
arrayThe ARNs of the security groups that are to use to configure the FSx for Lustre file system.
stringA subdirectory in the location's path.
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
stringThe URL of the FSx for Lustre location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all locationf_sx_lustres in a region. +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.locationf_sx_lustre_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_lustre_tags resource, see locationf_sx_lustres + diff --git a/website/docs/services/datasync/locationf_sx_lustres/index.md b/website/docs/services/datasync/locationf_sx_lustres/index.md new file mode 100644 index 0000000..36b44f2 --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_lustres/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a locationf_sx_lustre resource or lists locationf_sx_lustres in a region + +## Overview + + + + + + + +
Namelocationf_sx_lustres
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxLustre.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx for Lustre file system.
arrayThe ARNs of the security groups that are to use to configure the FSx for Lustre file system.
stringA subdirectory in the location's path.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
stringThe URL of the FSx for Lustre location that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationFSxLustre. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all locationf_sx_lustres in a region. +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.locationf_sx_lustres +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual locationf_sx_lustre. +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.locationf_sx_lustres +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new locationf_sx_lustre resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.locationf_sx_lustres ( + SecurityGroupArns, + region +) +SELECT +'{{ SecurityGroupArns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.locationf_sx_lustres ( + FsxFilesystemArn, + SecurityGroupArns, + Subdirectory, + Tags, + region +) +SELECT + '{{ FsxFilesystemArn }}', + '{{ SecurityGroupArns }}', + '{{ Subdirectory }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: locationf_sx_lustre + props: + - name: FsxFilesystemArn + value: '{{ FsxFilesystemArn }}' + - name: SecurityGroupArns + value: + - '{{ SecurityGroupArns[0] }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.locationf_sx_lustres +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +datasync:DescribeLocationFsxLustre, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationFsxLustre, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/locationf_sx_lustres_list_only/index.md b/website/docs/services/datasync/locationf_sx_lustres_list_only/index.md new file mode 100644 index 0000000..b8a0afd --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_lustres_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: locationf_sx_lustres_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_lustres_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists locationf_sx_lustres in a region or regions, for all properties use locationf_sx_lustres + +## Overview + + + + + + + +
Namelocationf_sx_lustres_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxLustre.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all locationf_sx_lustres in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.locationf_sx_lustres_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_lustres_list_only resource, see locationf_sx_lustres + diff --git a/website/docs/services/datasync/locationf_sx_ontap_tags/index.md b/website/docs/services/datasync/locationf_sx_ontap_tags/index.md new file mode 100644 index 0000000..bc866f3 --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_ontap_tags/index.md @@ -0,0 +1,89 @@ +--- +title: locationf_sx_ontap_tags +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_ontap_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for locationf_sx_ontaps in a region + +## Overview + + + + + + + +
Namelocationf_sx_ontap_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxONTAP.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx ONTAP SVM.
stringThe Amazon Resource Name (ARN) for the FSx ONAP file system.
arrayThe ARNs of the security groups that are to use to configure the FSx ONTAP file system.
objectConfiguration settings for an NFS or SMB protocol, currently only support NFS
stringA subdirectory in the location's path.
stringThe Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
stringThe URL of the FSx ONTAP file system that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all locationf_sx_ontaps in a region. +```sql +SELECT +region, +storage_virtual_machine_arn, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.locationf_sx_ontap_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_ontap_tags resource, see locationf_sx_ontaps + diff --git a/website/docs/services/datasync/locationf_sx_ontaps/index.md b/website/docs/services/datasync/locationf_sx_ontaps/index.md new file mode 100644 index 0000000..98d9b35 --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_ontaps/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a locationf_sx_ontap resource or lists locationf_sx_ontaps in a region + +## Overview + + + + + + + +
Namelocationf_sx_ontaps
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxONTAP.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx ONTAP SVM.
stringThe Amazon Resource Name (ARN) for the FSx ONAP file system.
arrayThe ARNs of the security groups that are to use to configure the FSx ONTAP file system.
objectConfiguration settings for an NFS or SMB protocol, currently only support NFS
stringA subdirectory in the location's path.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
stringThe URL of the FSx ONTAP file system that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationFSxONTAP. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all locationf_sx_ontaps in a region. +```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_ontaps +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual locationf_sx_ontap. +```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_ontaps +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new locationf_sx_ontap resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.locationf_sx_ontaps ( + StorageVirtualMachineArn, + SecurityGroupArns, + region +) +SELECT +'{{ StorageVirtualMachineArn }}', + '{{ SecurityGroupArns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.locationf_sx_ontaps ( + StorageVirtualMachineArn, + SecurityGroupArns, + Protocol, + Subdirectory, + Tags, + region +) +SELECT + '{{ StorageVirtualMachineArn }}', + '{{ SecurityGroupArns }}', + '{{ Protocol }}', + '{{ Subdirectory }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: locationf_sx_ontap + props: + - name: StorageVirtualMachineArn + value: '{{ StorageVirtualMachineArn }}' + - name: SecurityGroupArns + value: + - '{{ SecurityGroupArns[0] }}' + - name: Protocol + value: + NFS: + MountOptions: + Version: '{{ Version }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.locationf_sx_ontaps +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +datasync:DescribeLocationFsxOntap, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationFsxOntap, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/locationf_sx_ontaps_list_only/index.md b/website/docs/services/datasync/locationf_sx_ontaps_list_only/index.md new file mode 100644 index 0000000..23a2b13 --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_ontaps_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: locationf_sx_ontaps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_ontaps_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists locationf_sx_ontaps in a region or regions, for all properties use locationf_sx_ontaps + +## Overview + + + + + + + +
Namelocationf_sx_ontaps_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxONTAP.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all locationf_sx_ontaps in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.locationf_sx_ontaps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_ontaps_list_only resource, see locationf_sx_ontaps + diff --git a/website/docs/services/datasync/locationf_sx_open_zfs/index.md b/website/docs/services/datasync/locationf_sx_open_zfs/index.md new file mode 100644 index 0000000..b45a7c8 --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_open_zfs/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a locationf_sx_open_zf resource or lists locationf_sx_open_zfs in a region + +## Overview + + + + + + + +
Namelocationf_sx_open_zfs
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxOpenZFS.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx OpenZFS file system.
arrayThe ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
objectConfiguration settings for an NFS or SMB protocol, currently only support NFS
stringA subdirectory in the location's path.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
stringThe URL of the FSx OpenZFS that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationFSxOpenZFS. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all locationf_sx_open_zfs in a region. +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.locationf_sx_open_zfs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual locationf_sx_open_zf. +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.locationf_sx_open_zfs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new locationf_sx_open_zf resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.locationf_sx_open_zfs ( + SecurityGroupArns, + Protocol, + region +) +SELECT +'{{ SecurityGroupArns }}', + '{{ Protocol }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.locationf_sx_open_zfs ( + FsxFilesystemArn, + SecurityGroupArns, + Protocol, + Subdirectory, + Tags, + region +) +SELECT + '{{ FsxFilesystemArn }}', + '{{ SecurityGroupArns }}', + '{{ Protocol }}', + '{{ Subdirectory }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: locationf_sx_open_zf + props: + - name: FsxFilesystemArn + value: '{{ FsxFilesystemArn }}' + - name: SecurityGroupArns + value: + - '{{ SecurityGroupArns[0] }}' + - name: Protocol + value: + NFS: + MountOptions: + Version: '{{ Version }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.locationf_sx_open_zfs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the locationf_sx_open_zfs resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationFsxOpenZfs, +datasync:DescribeLocationFsxOpenZfs, +datasync:ListTagsForResource, +datasync:TagResource, +fsx:DescribeFileSystems, +ec2:DescribeNetworkInterfaces, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups +``` + +### Read +```json +datasync:DescribeLocationFsxOpenZfs, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationFsxOpenZfs, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/locationf_sx_open_zfs_list_only/index.md b/website/docs/services/datasync/locationf_sx_open_zfs_list_only/index.md new file mode 100644 index 0000000..c96ad6f --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_open_zfs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: locationf_sx_open_zfs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_open_zfs_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists locationf_sx_open_zfs in a region or regions, for all properties use locationf_sx_open_zfs + +## Overview + + + + + + + +
Namelocationf_sx_open_zfs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxOpenZFS.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all locationf_sx_open_zfs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.locationf_sx_open_zfs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_open_zfs_list_only resource, see locationf_sx_open_zfs + diff --git a/website/docs/services/datasync/locationf_sx_open_zfs_tags/index.md b/website/docs/services/datasync/locationf_sx_open_zfs_tags/index.md new file mode 100644 index 0000000..a717e53 --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_open_zfs_tags/index.md @@ -0,0 +1,87 @@ +--- +title: locationf_sx_open_zfs_tags +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_open_zfs_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for locationf_sx_open_zfs in a region + +## Overview + + + + + + + +
Namelocationf_sx_open_zfs_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxOpenZFS.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx OpenZFS file system.
arrayThe ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
objectConfiguration settings for an NFS or SMB protocol, currently only support NFS
stringA subdirectory in the location's path.
stringThe Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
stringThe URL of the FSx OpenZFS that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all locationf_sx_open_zfs in a region. +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.locationf_sx_open_zfs_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_open_zfs_tags resource, see locationf_sx_open_zfs + diff --git a/website/docs/services/datasync/locationf_sx_windows/index.md b/website/docs/services/datasync/locationf_sx_windows/index.md new file mode 100644 index 0000000..9511e06 --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_windows/index.md @@ -0,0 +1,258 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a locationf_sx_window resource or lists locationf_sx_windows in a region + +## Overview + + + + + + + +
Namelocationf_sx_windows
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxWindows.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Windows domain that the FSx for Windows server belongs to.
stringThe Amazon Resource Name (ARN) for the FSx for Windows file system.
stringThe password of the user who has the permissions to access files and folders in the FSx for Windows file system.
arrayThe ARNs of the security groups that are to use to configure the FSx for Windows file system.
stringA subdirectory in the location's path.
stringThe user who has the permissions to access files and folders in the FSx for Windows file system.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
stringThe URL of the FSx for Windows location that was described.
stringAWS region.
+ +For more information, see AWS::DataSync::LocationFSxWindows. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all locationf_sx_windows in a region. +```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 region = 'us-east-1'; +``` +Gets all properties from an individual locationf_sx_window. +```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 region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new locationf_sx_window resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.locationf_sx_windows ( + SecurityGroupArns, + User, + region +) +SELECT +'{{ SecurityGroupArns }}', + '{{ User }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.locationf_sx_windows ( + Domain, + FsxFilesystemArn, + Password, + SecurityGroupArns, + Subdirectory, + User, + Tags, + region +) +SELECT + '{{ Domain }}', + '{{ FsxFilesystemArn }}', + '{{ Password }}', + '{{ SecurityGroupArns }}', + '{{ Subdirectory }}', + '{{ User }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: locationf_sx_window + props: + - name: Domain + value: '{{ Domain }}' + - name: FsxFilesystemArn + value: '{{ FsxFilesystemArn }}' + - name: Password + value: '{{ Password }}' + - name: SecurityGroupArns + value: + - '{{ SecurityGroupArns[0] }}' + - name: Subdirectory + value: '{{ Subdirectory }}' + - name: User + value: '{{ User }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.locationf_sx_windows +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the locationf_sx_windows resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationFsxWindows, +datasync:DescribeLocationFsxWindows, +datasync:ListTagsForResource, +datasync:TagResource, +fsx:DescribeFileSystems, +ec2:DescribeNetworkInterfaces, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups +``` + +### Read +```json +datasync:DescribeLocationFsxWindows, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationFsxWindows, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + +### List +```json +datasync:ListLocations +``` diff --git a/website/docs/services/datasync/locationf_sx_windows_list_only/index.md b/website/docs/services/datasync/locationf_sx_windows_list_only/index.md new file mode 100644 index 0000000..0ed2b34 --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_windows_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: locationf_sx_windows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_windows_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists locationf_sx_windows in a region or regions, for all properties use locationf_sx_windows + +## Overview + + + + + + + +
Namelocationf_sx_windows_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxWindows.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all locationf_sx_windows in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.locationf_sx_windows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_windows_list_only resource, see locationf_sx_windows + diff --git a/website/docs/services/datasync/locationf_sx_windows_tags/index.md b/website/docs/services/datasync/locationf_sx_windows_tags/index.md new file mode 100644 index 0000000..1cf40cc --- /dev/null +++ b/website/docs/services/datasync/locationf_sx_windows_tags/index.md @@ -0,0 +1,91 @@ +--- +title: locationf_sx_windows_tags +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_windows_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for locationf_sx_windows in a region + +## Overview + + + + + + + +
Namelocationf_sx_windows_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxWindows.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Windows domain that the FSx for Windows server belongs to.
stringThe Amazon Resource Name (ARN) for the FSx for Windows file system.
stringThe password of the user who has the permissions to access files and folders in the FSx for Windows file system.
arrayThe ARNs of the security groups that are to use to configure the FSx for Windows file system.
stringA subdirectory in the location's path.
stringThe user who has the permissions to access files and folders in the FSx for Windows file system.
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
stringThe URL of the FSx for Windows location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all locationf_sx_windows in a region. +```sql +SELECT +region, +domain, +fsx_filesystem_arn, +password, +security_group_arns, +subdirectory, +user, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.locationf_sx_windows_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_windows_tags resource, see locationf_sx_windows + diff --git a/website/docs/services/datasync/storage_system_tags/index.md b/website/docs/services/datasync/storage_system_tags/index.md new file mode 100644 index 0000000..611c68c --- /dev/null +++ b/website/docs/services/datasync/storage_system_tags/index.md @@ -0,0 +1,93 @@ +--- +title: storage_system_tags +hide_title: false +hide_table_of_contents: false +keywords: + - storage_system_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for storage_systems in a region + +## Overview + + + + + + + +
Namestorage_system_tags
TypeResource
DescriptionResource schema for AWS::DataSync::StorageSystem.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe server name and network port required to connect with the management interface of the on-premises storage system.
objectThe username and password for accessing your on-premises storage system's management interface.
stringThe ARN of a secret stored by AWS Secrets Manager.
stringThe type of on-premises storage system that DataSync Discovery will analyze.
arrayThe ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface.
stringThe ARN of the Amazon CloudWatch log group used to monitor and log discovery job events.
stringA familiar name for the on-premises storage system.
stringThe ARN of the on-premises storage system added to DataSync Discovery.
stringIndicates whether the DataSync agent can access the on-premises storage system.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all storage_systems in a region. +```sql +SELECT +region, +server_configuration, +server_credentials, +secrets_manager_arn, +system_type, +agent_arns, +cloud_watch_log_group_arn, +name, +storage_system_arn, +connectivity_status, +tag_key, +tag_value +FROM aws.datasync.storage_system_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_system_tags resource, see storage_systems + diff --git a/website/docs/services/datasync/storage_systems/index.md b/website/docs/services/datasync/storage_systems/index.md new file mode 100644 index 0000000..dd6b1bc --- /dev/null +++ b/website/docs/services/datasync/storage_systems/index.md @@ -0,0 +1,273 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a storage_system resource or lists storage_systems in a region + +## Overview + + + + + + + +
Namestorage_systems
TypeResource
DescriptionResource schema for AWS::DataSync::StorageSystem.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe server name and network port required to connect with the management interface of the on-premises storage system.
objectThe username and password for accessing your on-premises storage system's management interface.
stringThe ARN of a secret stored by AWS Secrets Manager.
stringThe type of on-premises storage system that DataSync Discovery will analyze.
arrayThe ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface.
stringThe ARN of the Amazon CloudWatch log group used to monitor and log discovery job events.
stringA familiar name for the on-premises storage system.
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the on-premises storage system added to DataSync Discovery.
stringIndicates whether the DataSync agent can access the on-premises storage system.
stringAWS region.
+ +For more information, see AWS::DataSync::StorageSystem. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all storage_systems in a region. +```sql +SELECT +region, +server_configuration, +server_credentials, +secrets_manager_arn, +system_type, +agent_arns, +cloud_watch_log_group_arn, +name, +tags, +storage_system_arn, +connectivity_status +FROM aws.datasync.storage_systems +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual storage_system. +```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_systems +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new storage_system resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.storage_systems ( + ServerConfiguration, + SystemType, + AgentArns, + region +) +SELECT +'{{ ServerConfiguration }}', + '{{ SystemType }}', + '{{ AgentArns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.storage_systems ( + ServerConfiguration, + ServerCredentials, + SystemType, + AgentArns, + CloudWatchLogGroupArn, + Name, + Tags, + region +) +SELECT + '{{ ServerConfiguration }}', + '{{ ServerCredentials }}', + '{{ SystemType }}', + '{{ AgentArns }}', + '{{ CloudWatchLogGroupArn }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: storage_system + props: + - name: ServerConfiguration + value: + ServerHostname: '{{ ServerHostname }}' + ServerPort: '{{ ServerPort }}' + - name: ServerCredentials + value: + Username: '{{ Username }}' + Password: '{{ Password }}' + - name: SystemType + value: '{{ SystemType }}' + - name: AgentArns + value: + - '{{ AgentArns[0] }}' + - name: CloudWatchLogGroupArn + value: '{{ CloudWatchLogGroupArn }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.storage_systems +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +datasync:ListStorageSystems +``` diff --git a/website/docs/services/datasync/storage_systems_list_only/index.md b/website/docs/services/datasync/storage_systems_list_only/index.md new file mode 100644 index 0000000..4385b12 --- /dev/null +++ b/website/docs/services/datasync/storage_systems_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: storage_systems_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - storage_systems_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists storage_systems in a region or regions, for all properties use storage_systems + +## Overview + + + + + + + +
Namestorage_systems_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::StorageSystem.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the on-premises storage system added to DataSync Discovery.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all storage_systems in a region. +```sql +SELECT +region, +storage_system_arn +FROM aws.datasync.storage_systems_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_systems_list_only resource, see storage_systems + diff --git a/website/docs/services/datasync/task_tags/index.md b/website/docs/services/datasync/task_tags/index.md new file mode 100644 index 0000000..e4139a0 --- /dev/null +++ b/website/docs/services/datasync/task_tags/index.md @@ -0,0 +1,105 @@ +--- +title: task_tags +hide_title: false +hide_table_of_contents: false +keywords: + - task_tags + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for tasks in a region + +## Overview + + + + + + + +
Nametask_tags
TypeResource
DescriptionResource schema for AWS::DataSync::Task.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
stringThe ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
stringThe ARN of an AWS storage resource's location.
stringThe name of a task. This value is a text reference that is used to identify the task in the console.
objectRepresents the options that are available to control the behavior of a StartTaskExecution operation.
objectSpecifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.
objectConfigures a manifest, which is a list of files or objects that you want DataSync to transfer.
objectSpecifies the schedule you want your task to use for repeated executions.
stringThe ARN of the source location for the task.
stringThe ARN of the task.
stringSpecifies the task mode for the task.
stringThe status of the task that was described.
arrayThe Amazon Resource Names (ARNs) of the source ENIs (Elastic Network Interfaces) that were created for your subnet.
arrayThe Amazon Resource Names (ARNs) of the destination ENIs (Elastic Network Interfaces) that were created for your subnet.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all tasks in a region. +```sql +SELECT +region, +excludes, +includes, +cloud_watch_log_group_arn, +destination_location_arn, +name, +options, +task_report_config, +manifest_config, +schedule, +source_location_arn, +task_arn, +task_mode, +status, +source_network_interface_arns, +destination_network_interface_arns, +tag_key, +tag_value +FROM aws.datasync.task_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_tags resource, see tasks + diff --git a/website/docs/services/datasync/tasks/index.md b/website/docs/services/datasync/tasks/index.md new file mode 100644 index 0000000..cfc9c13 --- /dev/null +++ b/website/docs/services/datasync/tasks/index.md @@ -0,0 +1,367 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a task resource or lists tasks in a region + +## Overview + + + + + + + +
Nametasks
TypeResource
DescriptionResource schema for AWS::DataSync::Task.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
stringThe ARN of an AWS storage resource's location.
stringThe name of a task. This value is a text reference that is used to identify the task in the console.
objectRepresents the options that are available to control the behavior of a StartTaskExecution operation.
objectSpecifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.
objectConfigures a manifest, which is a list of files or objects that you want DataSync to transfer.
objectSpecifies the schedule you want your task to use for repeated executions.
stringThe ARN of the source location for the task.
stringThe ARN of the task.
stringSpecifies the task mode for the task.
stringThe status of the task that was described.
arrayThe Amazon Resource Names (ARNs) of the source ENIs (Elastic Network Interfaces) that were created for your subnet.
arrayThe Amazon Resource Names (ARNs) of the destination ENIs (Elastic Network Interfaces) that were created for your subnet.
stringAWS region.
+ +For more information, see AWS::DataSync::Task. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all tasks in a region. +```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, +task_mode, +status, +source_network_interface_arns, +destination_network_interface_arns +FROM aws.datasync.tasks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual task. +```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, +task_mode, +status, +source_network_interface_arns, +destination_network_interface_arns +FROM aws.datasync.tasks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new task resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.tasks ( + DestinationLocationArn, + SourceLocationArn, + region +) +SELECT +'{{ DestinationLocationArn }}', + '{{ SourceLocationArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datasync.tasks ( + Excludes, + Includes, + Tags, + CloudWatchLogGroupArn, + DestinationLocationArn, + Name, + Options, + TaskReportConfig, + ManifestConfig, + Schedule, + SourceLocationArn, + TaskMode, + region +) +SELECT + '{{ Excludes }}', + '{{ Includes }}', + '{{ Tags }}', + '{{ CloudWatchLogGroupArn }}', + '{{ DestinationLocationArn }}', + '{{ Name }}', + '{{ Options }}', + '{{ TaskReportConfig }}', + '{{ ManifestConfig }}', + '{{ Schedule }}', + '{{ SourceLocationArn }}', + '{{ TaskMode }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: task + props: + - name: Excludes + value: + - FilterType: '{{ FilterType }}' + Value: '{{ Value }}' + - name: Includes + value: + - null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CloudWatchLogGroupArn + value: '{{ CloudWatchLogGroupArn }}' + - name: DestinationLocationArn + value: '{{ DestinationLocationArn }}' + - name: Name + value: '{{ Name }}' + - name: Options + value: + Atime: '{{ Atime }}' + BytesPerSecond: '{{ BytesPerSecond }}' + Gid: '{{ Gid }}' + LogLevel: '{{ LogLevel }}' + Mtime: '{{ Mtime }}' + OverwriteMode: '{{ OverwriteMode }}' + PosixPermissions: '{{ PosixPermissions }}' + PreserveDeletedFiles: '{{ PreserveDeletedFiles }}' + PreserveDevices: '{{ PreserveDevices }}' + SecurityDescriptorCopyFlags: '{{ SecurityDescriptorCopyFlags }}' + TaskQueueing: '{{ TaskQueueing }}' + TransferMode: '{{ TransferMode }}' + Uid: '{{ Uid }}' + VerifyMode: '{{ VerifyMode }}' + ObjectTags: '{{ ObjectTags }}' + - name: TaskReportConfig + value: + Destination: + S3: + Subdirectory: '{{ Subdirectory }}' + BucketAccessRoleArn: '{{ BucketAccessRoleArn }}' + S3BucketArn: '{{ S3BucketArn }}' + OutputType: '{{ OutputType }}' + ReportLevel: '{{ ReportLevel }}' + ObjectVersionIds: '{{ ObjectVersionIds }}' + Overrides: + Transferred: + ReportLevel: '{{ ReportLevel }}' + Verified: + ReportLevel: '{{ ReportLevel }}' + Deleted: + ReportLevel: '{{ ReportLevel }}' + Skipped: + ReportLevel: '{{ ReportLevel }}' + - name: ManifestConfig + value: + Action: '{{ Action }}' + Format: '{{ Format }}' + Source: + S3: + ManifestObjectPath: '{{ ManifestObjectPath }}' + BucketAccessRoleArn: '{{ BucketAccessRoleArn }}' + S3BucketArn: '{{ S3BucketArn }}' + ManifestObjectVersionId: '{{ ManifestObjectVersionId }}' + - name: Schedule + value: + ScheduleExpression: '{{ ScheduleExpression }}' + Status: '{{ Status }}' + - name: SourceLocationArn + value: '{{ SourceLocationArn }}' + - name: TaskMode + value: '{{ TaskMode }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datasync.tasks +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +datasync:ListTasks +``` diff --git a/website/docs/services/datasync/tasks_list_only/index.md b/website/docs/services/datasync/tasks_list_only/index.md new file mode 100644 index 0000000..9b2a382 --- /dev/null +++ b/website/docs/services/datasync/tasks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: tasks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tasks_list_only + - datasync + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tasks in a region or regions, for all properties use tasks + +## Overview + + + + + + + +
Nametasks_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::Task.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the task.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tasks in a region. +```sql +SELECT +region, +task_arn +FROM aws.datasync.tasks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tasks_list_only resource, see tasks + diff --git a/website/docs/services/datazone/data_sources/index.md b/website/docs/services/datazone/data_sources/index.md new file mode 100644 index 0000000..72f5925 --- /dev/null +++ b/website/docs/services/datazone/data_sources/index.md @@ -0,0 +1,322 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_source resource or lists data_sources in a region + +## Overview + + + + + + + +
Namedata_sources
TypeResource
DescriptionA data source is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe metadata forms that are to be attached to the assets that this data source works with.
stringThe timestamp of when the data source was created.
stringThe description of the data source.
stringThe ID of the Amazon DataZone domain where the data source is created.
stringThe ID of the Amazon DataZone domain where the data source is created.
stringSpecifies whether the data source is enabled.
stringThe unique identifier of the Amazon DataZone environment to which the data source publishes assets.
stringThe unique identifier of the Amazon DataZone environment to which the data source publishes assets.
stringThe unique identifier of the data source.
undefinedConfiguration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.
numberThe number of assets created by the data source during its last run.
stringThe timestamp that specifies when the data source was last run.
stringThe status of the last run of this data source.
stringThe name of the data source.
stringThe ID of the Amazon DataZone project to which the data source is added.
stringThe identifier of the Amazon DataZone project in which you want to add the data source.
booleanSpecifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
objectSpecifies whether the business name generation is to be enabled for this data source.
objectThe schedule of the data source runs.
stringThe status of the data source.
stringThe type of the data source.
stringThe timestamp of when this data source was updated.
stringAWS region.
+ +For more information, see AWS::DataZone::DataSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_sources in a region. +```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_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_source. +```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_sources +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.data_sources ( + DomainIdentifier, + EnvironmentIdentifier, + Name, + ProjectIdentifier, + Type, + region +) +SELECT +'{{ DomainIdentifier }}', + '{{ EnvironmentIdentifier }}', + '{{ Name }}', + '{{ ProjectIdentifier }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.data_sources ( + AssetFormsInput, + Description, + DomainIdentifier, + EnableSetting, + EnvironmentIdentifier, + Configuration, + Name, + ProjectIdentifier, + PublishOnImport, + Recommendation, + Schedule, + Type, + region +) +SELECT + '{{ AssetFormsInput }}', + '{{ Description }}', + '{{ DomainIdentifier }}', + '{{ EnableSetting }}', + '{{ EnvironmentIdentifier }}', + '{{ Configuration }}', + '{{ Name }}', + '{{ ProjectIdentifier }}', + '{{ PublishOnImport }}', + '{{ Recommendation }}', + '{{ Schedule }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_source + props: + - name: AssetFormsInput + value: + - FormName: '{{ FormName }}' + TypeIdentifier: '{{ TypeIdentifier }}' + TypeRevision: '{{ TypeRevision }}' + Content: '{{ Content }}' + - name: Description + value: '{{ Description }}' + - name: DomainIdentifier + value: '{{ DomainIdentifier }}' + - name: EnableSetting + value: '{{ EnableSetting }}' + - name: EnvironmentIdentifier + value: '{{ EnvironmentIdentifier }}' + - name: Configuration + value: null + - name: Name + value: '{{ Name }}' + - name: ProjectIdentifier + value: '{{ ProjectIdentifier }}' + - name: PublishOnImport + value: '{{ PublishOnImport }}' + - name: Recommendation + value: + EnableBusinessNameGeneration: '{{ EnableBusinessNameGeneration }}' + - name: Schedule + value: + Timezone: '{{ Timezone }}' + Schedule: '{{ Schedule }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.data_sources +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +datazone:GetDataSource +``` + +### Update +```json +datazone:UpdateDataSource, +datazone:GetDataSource, +datazone:DeleteDataSource +``` + +### Delete +```json +datazone:DeleteDataSource, +datazone:GetDataSource +``` + +### List +```json +datazone:ListDataSources +``` diff --git a/website/docs/services/datazone/data_sources_list_only/index.md b/website/docs/services/datazone/data_sources_list_only/index.md new file mode 100644 index 0000000..10a2b8c --- /dev/null +++ b/website/docs/services/datazone/data_sources_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - datazone + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionA data source is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the Amazon DataZone domain where the data source is created.
stringThe unique identifier of the data source.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + diff --git a/website/docs/services/datazone/domain_tags/index.md b/website/docs/services/datazone/domain_tags/index.md new file mode 100644 index 0000000..815d786 --- /dev/null +++ b/website/docs/services/datazone/domain_tags/index.md @@ -0,0 +1,99 @@ +--- +title: domain_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_tags + - datazone + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domains in a region + +## Overview + + + + + + + +
Namedomain_tags
TypeResource
DescriptionA domain is an organizing entity for connecting together assets, users, and their projects
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Amazon DataZone domain.
stringThe timestamp of when the Amazon DataZone domain was last updated.
stringThe description of the Amazon DataZone domain.
stringThe domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
stringThe id of the Amazon DataZone domain.
stringThe identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
stringThe timestamp of when the Amazon DataZone domain was last updated.
stringThe identifier of the AWS account that manages the domain.
stringThe name of the Amazon DataZone domain.
stringThe URL of the data portal for this Amazon DataZone domain.
objectThe single-sign on configuration of the Amazon DataZone domain.
stringThe status of the Amazon DataZone domain.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domains in a region. +```sql +SELECT +region, +arn, +created_at, +description, +domain_execution_role, +id, +kms_key_identifier, +last_updated_at, +managed_account_id, +name, +portal_url, +single_sign_on, +status, +tag_key, +tag_value +FROM aws.datazone.domain_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_tags resource, see domains + diff --git a/website/docs/services/datazone/domains/index.md b/website/docs/services/datazone/domains/index.md new file mode 100644 index 0000000..d13a9af --- /dev/null +++ b/website/docs/services/datazone/domains/index.md @@ -0,0 +1,276 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain resource or lists domains in a region + +## Overview + + + + + + + +
Namedomains
TypeResource
DescriptionA domain is an organizing entity for connecting together assets, users, and their projects
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Amazon DataZone domain.
stringThe timestamp of when the Amazon DataZone domain was last updated.
stringThe description of the Amazon DataZone domain.
stringThe domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
stringThe id of the Amazon DataZone domain.
stringThe identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
stringThe timestamp of when the Amazon DataZone domain was last updated.
stringThe identifier of the AWS account that manages the domain.
stringThe name of the Amazon DataZone domain.
stringThe URL of the data portal for this Amazon DataZone domain.
objectThe single-sign on configuration of the Amazon DataZone domain.
stringThe status of the Amazon DataZone domain.
arrayThe tags specified for the Amazon DataZone domain.
stringAWS region.
+ +For more information, see AWS::DataZone::Domain. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domains in a region. +```sql +SELECT +region, +arn, +created_at, +description, +domain_execution_role, +id, +kms_key_identifier, +last_updated_at, +managed_account_id, +name, +portal_url, +single_sign_on, +status, +tags +FROM aws.datazone.domains +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain. +```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.domains +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.domains ( + DomainExecutionRole, + Name, + region +) +SELECT +'{{ DomainExecutionRole }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.domains ( + Description, + DomainExecutionRole, + KmsKeyIdentifier, + Name, + SingleSignOn, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ DomainExecutionRole }}', + '{{ KmsKeyIdentifier }}', + '{{ Name }}', + '{{ SingleSignOn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain + props: + - name: Description + value: '{{ Description }}' + - name: DomainExecutionRole + value: '{{ DomainExecutionRole }}' + - name: KmsKeyIdentifier + value: '{{ KmsKeyIdentifier }}' + - name: Name + value: '{{ Name }}' + - name: SingleSignOn + value: + Type: '{{ Type }}' + UserAssignment: '{{ UserAssignment }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.domains +WHERE data__Identifier = '' +AND 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, +sso:ListInstances, +iam:PassRole +``` + +### Read +```json +datazone:GetDomain +``` + +### Update +```json +datazone:UpdateDomain, +datazone:GetDomain, +datazone:TagResource, +datazone:UntagResource, +sso:CreateManagedApplicationInstance, +sso:DeleteManagedApplicationInstance, +sso:PutApplicationAssignmentConfiguration, +sso:ListInstances, +iam:PassRole +``` + +### Delete +```json +datazone:DeleteDomain, +datazone:GetDomain, +sso:DeleteManagedApplicationInstance, +sso:PutApplicationAssignmentConfiguration, +sso:ListInstances +``` + +### List +```json +datazone:ListDomains +``` diff --git a/website/docs/services/datazone/domains_list_only/index.md b/website/docs/services/datazone/domains_list_only/index.md new file mode 100644 index 0000000..338f771 --- /dev/null +++ b/website/docs/services/datazone/domains_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domains_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domains in a region or regions, for all properties use domains + +## Overview + + + + + + + +
Namedomains_list_only
TypeResource
DescriptionA domain is an organizing entity for connecting together assets, users, and their projects
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe id of the Amazon DataZone domain.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domains in a region. +```sql +SELECT +region, +id +FROM aws.datazone.domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domains_list_only resource, see domains + diff --git a/website/docs/services/datazone/environment_actions/index.md b/website/docs/services/datazone/environment_actions/index.md new file mode 100644 index 0000000..3519932 --- /dev/null +++ b/website/docs/services/datazone/environment_actions/index.md @@ -0,0 +1,244 @@ +--- +title: environment_actions +hide_title: false +hide_table_of_contents: false +keywords: + - environment_actions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment_action resource or lists environment_actions in a region + +## Overview + + + + + + + +
Nameenvironment_actions
TypeResource
DescriptionDefinition of AWS::DataZone::EnvironmentActions Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the Amazon DataZone environment action.
stringThe identifier of the Amazon DataZone domain in which the environment is created.
stringThe identifier of the Amazon DataZone domain in which the environment would be created.
stringThe identifier of the Amazon DataZone environment in which the action is taking place
stringThe identifier of the Amazon DataZone environment in which the action is taking place
stringThe ID of the Amazon DataZone environment action.
stringThe ID of the Amazon DataZone environment action.
stringThe name of the environment action.
objectThe parameters of the environment action.
stringAWS region.
+ +For more information, see AWS::DataZone::EnvironmentActions. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environment_actions in a region. +```sql +SELECT +region, +description, +domain_id, +domain_identifier, +environment_id, +environment_identifier, +id, +identifier, +name, +parameters +FROM aws.datazone.environment_actions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment_action. +```sql +SELECT +region, +description, +domain_id, +domain_identifier, +environment_id, +environment_identifier, +id, +identifier, +name, +parameters +FROM aws.datazone.environment_actions +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.environment_actions ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.environment_actions ( + Description, + DomainIdentifier, + EnvironmentIdentifier, + Identifier, + Name, + Parameters, + region +) +SELECT + '{{ Description }}', + '{{ DomainIdentifier }}', + '{{ EnvironmentIdentifier }}', + '{{ Identifier }}', + '{{ Name }}', + '{{ Parameters }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment_action + props: + - name: Description + value: '{{ Description }}' + - name: DomainIdentifier + value: '{{ DomainIdentifier }}' + - name: EnvironmentIdentifier + value: '{{ EnvironmentIdentifier }}' + - name: Identifier + value: '{{ Identifier }}' + - name: Name + value: '{{ Name }}' + - name: Parameters + value: + Uri: '{{ Uri }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.environment_actions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the environment_actions resource, the following permissions are required: + +### Create +```json +datazone:CreateEnvironmentAction, +datazone:GetEnvironmentAction, +datazone:DeleteEnvironmentAction +``` + +### Read +```json +datazone:GetEnvironmentAction +``` + +### Update +```json +datazone:UpdateEnvironmentAction, +datazone:GetEnvironmentAction, +datazone:DeleteEnvironmentAction +``` + +### Delete +```json +datazone:DeleteEnvironmentAction, +datazone:GetEnvironmentAction +``` + +### List +```json +datazone:ListEnvironmentActions +``` diff --git a/website/docs/services/datazone/environment_actions_list_only/index.md b/website/docs/services/datazone/environment_actions_list_only/index.md new file mode 100644 index 0000000..f86c604 --- /dev/null +++ b/website/docs/services/datazone/environment_actions_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: environment_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environment_actions_list_only + - datazone + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environment_actions in a region or regions, for all properties use environment_actions + +## Overview + + + + + + + +
Nameenvironment_actions_list_only
TypeResource
DescriptionDefinition of AWS::DataZone::EnvironmentActions Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon DataZone domain in which the environment is created.
stringThe identifier of the Amazon DataZone environment in which the action is taking place
stringThe ID of the Amazon DataZone environment action.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environment_actions in a region. +```sql +SELECT +region, +domain_id, +environment_id, +id +FROM aws.datazone.environment_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_actions_list_only resource, see environment_actions + diff --git a/website/docs/services/datazone/environment_blueprint_configurations/index.md b/website/docs/services/datazone/environment_blueprint_configurations/index.md new file mode 100644 index 0000000..455893c --- /dev/null +++ b/website/docs/services/datazone/environment_blueprint_configurations/index.md @@ -0,0 +1,255 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment_blueprint_configuration resource or lists environment_blueprint_configurations in a region + +## Overview + + + + + + + +
Nameenvironment_blueprint_configurations
TypeResource
DescriptionDefinition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
array
string
string
string
string
string
stringAWS region.
+ +For more information, see AWS::DataZone::EnvironmentBlueprintConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environment_blueprint_configurations in a region. +```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_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment_blueprint_configuration. +```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_configurations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment_blueprint_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.environment_blueprint_configurations ( + EnabledRegions, + EnvironmentBlueprintIdentifier, + DomainIdentifier, + region +) +SELECT +'{{ EnabledRegions }}', + '{{ EnvironmentBlueprintIdentifier }}', + '{{ DomainIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.environment_blueprint_configurations ( + RegionalParameters, + ProvisioningRoleArn, + EnabledRegions, + EnvironmentBlueprintIdentifier, + DomainIdentifier, + ManageAccessRoleArn, + region +) +SELECT + '{{ RegionalParameters }}', + '{{ ProvisioningRoleArn }}', + '{{ EnabledRegions }}', + '{{ EnvironmentBlueprintIdentifier }}', + '{{ DomainIdentifier }}', + '{{ ManageAccessRoleArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment_blueprint_configuration + props: + - name: RegionalParameters + value: + - Parameters: {} + Region: '{{ Region }}' + - name: ProvisioningRoleArn + value: '{{ ProvisioningRoleArn }}' + - name: EnabledRegions + value: + - '{{ EnabledRegions[0] }}' + - name: EnvironmentBlueprintIdentifier + value: '{{ EnvironmentBlueprintIdentifier }}' + - name: DomainIdentifier + value: '{{ DomainIdentifier }}' + - name: ManageAccessRoleArn + value: '{{ ManageAccessRoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.environment_blueprint_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the environment_blueprint_configurations resource, the following permissions are required: + +### Read +```json +datazone:GetEnvironmentBlueprintConfiguration +``` + +### Create +```json +datazone:ListEnvironmentBlueprints, +iam:PassRole, +datazone:GetEnvironmentBlueprintConfiguration, +datazone:PutEnvironmentBlueprintConfiguration +``` + +### Update +```json +datazone:DeleteEnvironmentBlueprintConfiguration, +iam:PassRole, +datazone:GetEnvironmentBlueprintConfiguration, +datazone:PutEnvironmentBlueprintConfiguration +``` + +### List +```json +datazone:ListEnvironmentBlueprintConfigurations +``` + +### Delete +```json +datazone:GetEnvironmentBlueprintConfiguration, +datazone:DeleteEnvironmentBlueprintConfiguration +``` diff --git a/website/docs/services/datazone/environment_blueprint_configurations_list_only/index.md b/website/docs/services/datazone/environment_blueprint_configurations_list_only/index.md new file mode 100644 index 0000000..ff934b0 --- /dev/null +++ b/website/docs/services/datazone/environment_blueprint_configurations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: environment_blueprint_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environment_blueprint_configurations_list_only + - datazone + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environment_blueprint_configurations in a region or regions, for all properties use environment_blueprint_configurations + +## Overview + + + + + + + +
Nameenvironment_blueprint_configurations_list_only
TypeResource
DescriptionDefinition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environment_blueprint_configurations in a region. +```sql +SELECT +region, +domain_id, +environment_blueprint_id +FROM aws.datazone.environment_blueprint_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_blueprint_configurations_list_only resource, see environment_blueprint_configurations + diff --git a/website/docs/services/datazone/environment_profiles/index.md b/website/docs/services/datazone/environment_profiles/index.md new file mode 100644 index 0000000..e415852 --- /dev/null +++ b/website/docs/services/datazone/environment_profiles/index.md @@ -0,0 +1,279 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment_profile resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AWS account in which the Amazon DataZone environment is created.
stringThe AWS region in which this environment profile is created.
stringThe timestamp of when this environment profile was created.
stringThe Amazon DataZone user who created this environment profile.
stringThe description of this Amazon DataZone environment profile.
stringThe ID of the Amazon DataZone domain in which this environment profile is created.
stringThe ID of the Amazon DataZone domain in which this environment profile is created.
stringThe ID of the blueprint with which this environment profile is created.
stringThe ID of the blueprint with which this environment profile is created.
stringThe ID of this Amazon DataZone environment profile.
stringThe name of this Amazon DataZone environment profile.
stringThe identifier of the project in which to create the environment profile.
stringThe identifier of the project in which to create the environment profile.
stringThe timestamp of when this environment profile was updated.
arrayThe user parameters of this Amazon DataZone environment profile.
stringAWS region.
+ +For more information, see AWS::DataZone::EnvironmentProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environment_profiles in a region. +```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_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment_profile. +```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_profiles +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.environment_profiles ( + AwsAccountId, + AwsAccountRegion, + DomainIdentifier, + EnvironmentBlueprintIdentifier, + Name, + ProjectIdentifier, + region +) +SELECT +'{{ AwsAccountId }}', + '{{ AwsAccountRegion }}', + '{{ DomainIdentifier }}', + '{{ EnvironmentBlueprintIdentifier }}', + '{{ Name }}', + '{{ ProjectIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.environment_profiles ( + AwsAccountId, + AwsAccountRegion, + Description, + DomainIdentifier, + EnvironmentBlueprintIdentifier, + Name, + ProjectIdentifier, + UserParameters, + region +) +SELECT + '{{ AwsAccountId }}', + '{{ AwsAccountRegion }}', + '{{ Description }}', + '{{ DomainIdentifier }}', + '{{ EnvironmentBlueprintIdentifier }}', + '{{ Name }}', + '{{ ProjectIdentifier }}', + '{{ UserParameters }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment_profile + props: + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: AwsAccountRegion + value: '{{ AwsAccountRegion }}' + - name: Description + value: '{{ Description }}' + - name: DomainIdentifier + value: '{{ DomainIdentifier }}' + - name: EnvironmentBlueprintIdentifier + value: '{{ EnvironmentBlueprintIdentifier }}' + - name: Name + value: '{{ Name }}' + - name: ProjectIdentifier + value: '{{ ProjectIdentifier }}' + - name: UserParameters + value: + - Name: '{{ Name }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.environment_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the environment_profiles resource, the following permissions are required: + +### Create +```json +datazone:CreateEnvironmentProfile, +datazone:GetEnvironmentProfile +``` + +### Read +```json +datazone:GetEnvironmentProfile +``` + +### Update +```json +datazone:UpdateEnvironmentProfile, +datazone:GetEnvironmentProfile +``` + +### Delete +```json +datazone:DeleteEnvironmentProfile, +datazone:GetEnvironmentProfile +``` + +### List +```json +datazone:ListEnvironmentProfiles +``` diff --git a/website/docs/services/datazone/environment_profiles_list_only/index.md b/website/docs/services/datazone/environment_profiles_list_only/index.md new file mode 100644 index 0000000..284efaa --- /dev/null +++ b/website/docs/services/datazone/environment_profiles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: environment_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environment_profiles_list_only + - datazone + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environment_profiles in a region or regions, for all properties use environment_profiles + +## Overview + + + + + + + +
Nameenvironment_profiles_list_only
TypeResource
DescriptionAWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the Amazon DataZone domain in which this environment profile is created.
stringThe ID of this Amazon DataZone environment profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environment_profiles in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.environment_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_profiles_list_only resource, see environment_profiles + diff --git a/website/docs/services/datazone/environments/index.md b/website/docs/services/datazone/environments/index.md new file mode 100644 index 0000000..843e4ad --- /dev/null +++ b/website/docs/services/datazone/environments/index.md @@ -0,0 +1,310 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment resource or lists environments in a region + +## Overview + + + + + + + +
Nameenvironments
TypeResource
DescriptionDefinition of AWS::DataZone::Environment Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AWS account in which the Amazon DataZone environment is created.
stringThe AWS region in which the Amazon DataZone environment is created.
stringThe AWS account in which the Amazon DataZone environment is created.
stringThe AWS region in which the Amazon DataZone environment is created.
stringThe timestamp of when the environment was created.
stringThe Amazon DataZone user who created the environment.
stringThe description of the Amazon DataZone environment.
stringThe identifier of the Amazon DataZone domain in which the environment is created.
stringThe identifier of the Amazon DataZone domain in which the environment would be created.
stringThe ID of the blueprint with which the Amazon DataZone environment was created.
stringThe ID of the environment profile with which the Amazon DataZone environment was created.
stringThe ID of the environment profile with which the Amazon DataZone environment would be created.
arrayThe glossary terms that can be used in the Amazon DataZone environment.
stringEnvironment role arn for custom aws environment permissions
stringThe ID of the Amazon DataZone environment.
stringThe name of the environment.
stringThe ID of the Amazon DataZone project in which the environment is created.
stringThe ID of the Amazon DataZone project in which the environment would be created.
stringThe provider of the Amazon DataZone environment.
stringThe status of the Amazon DataZone environment.
stringThe timestamp of when the environment was updated.
arrayThe user parameters of the Amazon DataZone environment.
stringAWS region.
+ +For more information, see AWS::DataZone::Environment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environments in a region. +```sql +SELECT +region, +aws_account_id, +aws_account_region, +environment_account_identifier, +environment_account_region, +created_at, +created_by, +description, +domain_id, +domain_identifier, +environment_blueprint_id, +environment_profile_id, +environment_profile_identifier, +glossary_terms, +environment_role_arn, +id, +name, +project_id, +project_identifier, +provider, +status, +updated_at, +user_parameters +FROM aws.datazone.environments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment. +```sql +SELECT +region, +aws_account_id, +aws_account_region, +environment_account_identifier, +environment_account_region, +created_at, +created_by, +description, +domain_id, +domain_identifier, +environment_blueprint_id, +environment_profile_id, +environment_profile_identifier, +glossary_terms, +environment_role_arn, +id, +name, +project_id, +project_identifier, +provider, +status, +updated_at, +user_parameters +FROM aws.datazone.environments +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.environments ( + DomainIdentifier, + Name, + ProjectIdentifier, + region +) +SELECT +'{{ DomainIdentifier }}', + '{{ Name }}', + '{{ ProjectIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.environments ( + EnvironmentAccountIdentifier, + EnvironmentAccountRegion, + Description, + DomainIdentifier, + EnvironmentProfileIdentifier, + GlossaryTerms, + EnvironmentRoleArn, + Name, + ProjectIdentifier, + UserParameters, + region +) +SELECT + '{{ EnvironmentAccountIdentifier }}', + '{{ EnvironmentAccountRegion }}', + '{{ Description }}', + '{{ DomainIdentifier }}', + '{{ EnvironmentProfileIdentifier }}', + '{{ GlossaryTerms }}', + '{{ EnvironmentRoleArn }}', + '{{ Name }}', + '{{ ProjectIdentifier }}', + '{{ UserParameters }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment + props: + - name: EnvironmentAccountIdentifier + value: '{{ EnvironmentAccountIdentifier }}' + - name: EnvironmentAccountRegion + value: '{{ EnvironmentAccountRegion }}' + - name: Description + value: '{{ Description }}' + - name: DomainIdentifier + value: '{{ DomainIdentifier }}' + - name: EnvironmentProfileIdentifier + value: '{{ EnvironmentProfileIdentifier }}' + - name: GlossaryTerms + value: + - '{{ GlossaryTerms[0] }}' + - name: EnvironmentRoleArn + value: '{{ EnvironmentRoleArn }}' + - name: Name + value: '{{ Name }}' + - name: ProjectIdentifier + value: '{{ ProjectIdentifier }}' + - name: UserParameters + value: + - Name: '{{ Name }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.environments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +```json +datazone:CreateEnvironment, +datazone:GetEnvironment, +datazone:DeleteEnvironment, +datazone:AssociateEnvironmentRole, +iam:PassRole +``` + +### Read +```json +datazone:GetEnvironment +``` + +### Update +```json +datazone:UpdateEnvironment, +datazone:GetEnvironment, +datazone:DeleteEnvironment, +datazone:AssociateEnvironmentRole, +datazone:DisassociateEnvironmentRole, +iam:PassRole +``` + +### Delete +```json +datazone:DeleteEnvironment, +datazone:GetEnvironment +``` + +### List +```json +datazone:ListEnvironments +``` diff --git a/website/docs/services/datazone/environments_list_only/index.md b/website/docs/services/datazone/environments_list_only/index.md new file mode 100644 index 0000000..bbfac71 --- /dev/null +++ b/website/docs/services/datazone/environments_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - datazone + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionDefinition of AWS::DataZone::Environment Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon DataZone domain in which the environment is created.
stringThe ID of the Amazon DataZone environment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + diff --git a/website/docs/services/datazone/group_profiles/index.md b/website/docs/services/datazone/group_profiles/index.md new file mode 100644 index 0000000..410dd7c --- /dev/null +++ b/website/docs/services/datazone/group_profiles/index.md @@ -0,0 +1,236 @@ +--- +title: group_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - group_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a group_profile resource or lists group_profiles in a region + +## Overview + + + + + + + +
Namegroup_profiles
TypeResource
DescriptionGroup profiles represent groups of Amazon DataZone users. Groups can be manually created, or mapped to Active Directory groups of enterprise customers. In Amazon DataZone, groups serve two purposes. First, a group can map to a team of users in the organizational chart, and thus reduce the administrative work of a Amazon DataZone project owner when there are new employees joining or leaving a team. Second, corporate administrators use Active Directory groups to manage and update user statuses and so Amazon DataZone domain administrators can use these group memberships to implement Amazon DataZone domain policies.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon DataZone domain in which the group profile is created.
stringThe identifier of the Amazon DataZone domain in which the group profile would be created.
stringThe ID of the group.
stringThe group-name of the Group Profile.
stringThe ID of the Amazon DataZone group profile.
stringThe status of the group profile.
stringAWS region.
+ +For more information, see AWS::DataZone::GroupProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all group_profiles in a region. +```sql +SELECT +region, +domain_id, +domain_identifier, +group_identifier, +group_name, +id, +status +FROM aws.datazone.group_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual group_profile. +```sql +SELECT +region, +domain_id, +domain_identifier, +group_identifier, +group_name, +id, +status +FROM aws.datazone.group_profiles +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new group_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.group_profiles ( + DomainIdentifier, + GroupIdentifier, + region +) +SELECT +'{{ DomainIdentifier }}', + '{{ GroupIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.group_profiles ( + DomainIdentifier, + GroupIdentifier, + Status, + region +) +SELECT + '{{ DomainIdentifier }}', + '{{ GroupIdentifier }}', + '{{ Status }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: group_profile + props: + - name: DomainIdentifier + value: '{{ DomainIdentifier }}' + - name: GroupIdentifier + value: '{{ GroupIdentifier }}' + - name: Status + value: '{{ Status }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.group_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the group_profiles resource, the following permissions are required: + +### Create +```json +datazone:CreateGroupProfile, +datazone:GetGroupProfile, +datazone:UpdateGroupProfile, +sso:ListProfiles, +sso:GetProfile, +sso:AssociateProfile, +sso:DisassociateProfile +``` + +### Read +```json +datazone:GetGroupProfile +``` + +### Update +```json +datazone:UpdateGroupProfile, +datazone:GetGroupProfile, +sso:ListProfiles, +sso:GetProfile, +sso:AssociateProfile, +sso:DisassociateProfile +``` + +### Delete +```json +datazone:DeleteGroupProfile, +datazone:GetGroupProfile, +datazone:UpdateGroupProfile, +sso:ListProfiles, +sso:GetProfile, +sso:AssociateProfile, +sso:DisassociateProfile +``` + +### List +```json +datazone:SearchGroupProfiles +``` diff --git a/website/docs/services/datazone/group_profiles_list_only/index.md b/website/docs/services/datazone/group_profiles_list_only/index.md new file mode 100644 index 0000000..1bb2329 --- /dev/null +++ b/website/docs/services/datazone/group_profiles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: group_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - group_profiles_list_only + - datazone + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists group_profiles in a region or regions, for all properties use group_profiles + +## Overview + + + + + + + +
Namegroup_profiles_list_only
TypeResource
DescriptionGroup profiles represent groups of Amazon DataZone users. Groups can be manually created, or mapped to Active Directory groups of enterprise customers. In Amazon DataZone, groups serve two purposes. First, a group can map to a team of users in the organizational chart, and thus reduce the administrative work of a Amazon DataZone project owner when there are new employees joining or leaving a team. Second, corporate administrators use Active Directory groups to manage and update user statuses and so Amazon DataZone domain administrators can use these group memberships to implement Amazon DataZone domain policies.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon DataZone domain in which the group profile is created.
stringThe ID of the Amazon DataZone group profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all group_profiles in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.group_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the group_profiles_list_only resource, see group_profiles + diff --git a/website/docs/services/datazone/index.md b/website/docs/services/datazone/index.md new file mode 100644 index 0000000..86a5d48 --- /dev/null +++ b/website/docs/services/datazone/index.md @@ -0,0 +1,58 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The datazone service documentation. + +:::info Service Summary + +
+
+total resources: 23
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/datazone/project_memberships/index.md b/website/docs/services/datazone/project_memberships/index.md new file mode 100644 index 0000000..e27d1e9 --- /dev/null +++ b/website/docs/services/datazone/project_memberships/index.md @@ -0,0 +1,226 @@ +--- +title: project_memberships +hide_title: false +hide_table_of_contents: false +keywords: + - project_memberships + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a project_membership resource or lists project_memberships in a region + +## Overview + + + + + + + +
Nameproject_memberships
TypeResource
DescriptionDefinition of AWS::DataZone::ProjectMembership Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
stringAWS region.
+ +For more information, see AWS::DataZone::ProjectMembership. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all project_memberships in a region. +```sql +SELECT +region, +project_identifier, +designation, +member, +domain_identifier +FROM aws.datazone.project_memberships +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual project_membership. +```sql +SELECT +region, +project_identifier, +designation, +member, +domain_identifier +FROM aws.datazone.project_memberships +WHERE region = 'us-east-1' AND data__Identifier = '|||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new project_membership resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.project_memberships ( + ProjectIdentifier, + Designation, + Member, + DomainIdentifier, + region +) +SELECT +'{{ ProjectIdentifier }}', + '{{ Designation }}', + '{{ Member }}', + '{{ DomainIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.project_memberships ( + ProjectIdentifier, + Designation, + Member, + DomainIdentifier, + region +) +SELECT + '{{ ProjectIdentifier }}', + '{{ Designation }}', + '{{ Member }}', + '{{ DomainIdentifier }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: project_membership + props: + - name: ProjectIdentifier + value: '{{ ProjectIdentifier }}' + - name: Designation + value: '{{ Designation }}' + - name: Member + value: null + - name: DomainIdentifier + value: '{{ DomainIdentifier }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.project_memberships +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the project_memberships resource, the following permissions are required: + +### Read +```json +datazone:ListProjectMemberships +``` + +### Create +```json +datazone:CreateProjectMembership, +datazone:ListProjectMemberships, +iam:GetRole, +datazone:GetGroupProfile, +datazone:GetUserProfile +``` + +### Update +```json +datazone:CreateProjectMembership, +datazone:DeleteProjectMembership +``` + +### List +```json +datazone:ListProjectMemberships +``` + +### Delete +```json +datazone:DeleteProjectMembership +``` diff --git a/website/docs/services/datazone/project_memberships_list_only/index.md b/website/docs/services/datazone/project_memberships_list_only/index.md new file mode 100644 index 0000000..22cb5bb --- /dev/null +++ b/website/docs/services/datazone/project_memberships_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: project_memberships_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - project_memberships_list_only + - datazone + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists project_memberships in a region or regions, for all properties use project_memberships + +## Overview + + + + + + + +
Nameproject_memberships_list_only
TypeResource
DescriptionDefinition of AWS::DataZone::ProjectMembership Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
undefined
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all project_memberships in a region. +```sql +SELECT +region, +domain_identifier, +member_identifier, +member_identifier_type, +project_identifier +FROM aws.datazone.project_memberships_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the project_memberships_list_only resource, see project_memberships + diff --git a/website/docs/services/datazone/projects/index.md b/website/docs/services/datazone/projects/index.md new file mode 100644 index 0000000..dd1eadc --- /dev/null +++ b/website/docs/services/datazone/projects/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a project resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe timestamp of when the project was created.
stringThe Amazon DataZone user who created the project.
stringThe description of the Amazon DataZone project.
stringThe identifier of the Amazon DataZone domain in which the project was created.
stringThe ID of the Amazon DataZone domain in which this project is created.
arrayThe glossary terms that can be used in this Amazon DataZone project.
stringThe ID of the Amazon DataZone project.
stringThe timestamp of when the project was last updated.
stringThe name of the Amazon DataZone project.
stringAWS region.
+ +For more information, see AWS::DataZone::Project. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all projects in a region. +```sql +SELECT +region, +created_at, +created_by, +description, +domain_id, +domain_identifier, +glossary_terms, +id, +last_updated_at, +name +FROM aws.datazone.projects +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual project. +```sql +SELECT +region, +created_at, +created_by, +description, +domain_id, +domain_identifier, +glossary_terms, +id, +last_updated_at, +name +FROM aws.datazone.projects +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.projects ( + DomainIdentifier, + Name, + region +) +SELECT +'{{ DomainIdentifier }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.projects ( + Description, + DomainIdentifier, + GlossaryTerms, + Name, + region +) +SELECT + '{{ Description }}', + '{{ DomainIdentifier }}', + '{{ GlossaryTerms }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: project + props: + - name: Description + value: '{{ Description }}' + - name: DomainIdentifier + value: '{{ DomainIdentifier }}' + - name: GlossaryTerms + value: + - '{{ GlossaryTerms[0] }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.projects +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +```json +datazone:CreateProject, +datazone:GetProject +``` + +### Read +```json +datazone:GetProject +``` + +### Update +```json +datazone:UpdateProject, +datazone:GetProject +``` + +### Delete +```json +datazone:DeleteProject, +datazone:GetProject +``` + +### List +```json +datazone:ListProjects +``` diff --git a/website/docs/services/datazone/projects_list_only/index.md b/website/docs/services/datazone/projects_list_only/index.md new file mode 100644 index 0000000..eb462e2 --- /dev/null +++ b/website/docs/services/datazone/projects_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + + + +
Nameprojects_list_only
TypeResource
DescriptionAmazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon DataZone domain in which the project was created.
stringThe ID of the Amazon DataZone project.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + diff --git a/website/docs/services/datazone/subscription_targets/index.md b/website/docs/services/datazone/subscription_targets/index.md new file mode 100644 index 0000000..c72b638 --- /dev/null +++ b/website/docs/services/datazone/subscription_targets/index.md @@ -0,0 +1,294 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a subscription_target resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe asset types that can be included in the subscription target.
arrayThe authorized principals of the subscription target.
stringThe timestamp of when the subscription target was created.
stringThe Amazon DataZone user who created the subscription target.
stringThe ID of the Amazon DataZone domain in which subscription target is created.
stringThe ID of the Amazon DataZone domain in which subscription target would be created.
stringThe ID of the environment in which subscription target is created.
stringThe ID of the environment in which subscription target would be created.
stringThe ID of the subscription target.
stringThe manage access role that is used to create the subscription target.
stringThe name of the subscription target.
stringThe identifier of the project specified in the subscription target.
stringThe provider of the subscription target.
arrayThe configuration of the subscription target.
stringThe type of the subscription target.
stringThe timestamp of when the subscription target was updated.
stringThe Amazon DataZone user who updated the subscription target.
stringAWS region.
+ +For more information, see AWS::DataZone::SubscriptionTarget. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all subscription_targets in a region. +```sql +SELECT +region, +applicable_asset_types, +authorized_principals, +created_at, +created_by, +domain_id, +domain_identifier, +environment_id, +environment_identifier, +id, +manage_access_role, +name, +project_id, +provider, +subscription_target_config, +type, +updated_at, +updated_by +FROM aws.datazone.subscription_targets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual subscription_target. +```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_targets +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new subscription_target resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.subscription_targets ( + ApplicableAssetTypes, + AuthorizedPrincipals, + DomainIdentifier, + EnvironmentIdentifier, + Name, + SubscriptionTargetConfig, + Type, + region +) +SELECT +'{{ ApplicableAssetTypes }}', + '{{ AuthorizedPrincipals }}', + '{{ DomainIdentifier }}', + '{{ EnvironmentIdentifier }}', + '{{ Name }}', + '{{ SubscriptionTargetConfig }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.subscription_targets ( + ApplicableAssetTypes, + AuthorizedPrincipals, + DomainIdentifier, + EnvironmentIdentifier, + ManageAccessRole, + Name, + Provider, + SubscriptionTargetConfig, + Type, + region +) +SELECT + '{{ ApplicableAssetTypes }}', + '{{ AuthorizedPrincipals }}', + '{{ DomainIdentifier }}', + '{{ EnvironmentIdentifier }}', + '{{ ManageAccessRole }}', + '{{ Name }}', + '{{ Provider }}', + '{{ SubscriptionTargetConfig }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: subscription_target + props: + - name: ApplicableAssetTypes + value: + - '{{ ApplicableAssetTypes[0] }}' + - name: AuthorizedPrincipals + value: + - '{{ AuthorizedPrincipals[0] }}' + - name: DomainIdentifier + value: '{{ DomainIdentifier }}' + - name: EnvironmentIdentifier + value: '{{ EnvironmentIdentifier }}' + - name: ManageAccessRole + value: '{{ ManageAccessRole }}' + - name: Name + value: '{{ Name }}' + - name: Provider + value: '{{ Provider }}' + - name: SubscriptionTargetConfig + value: + - FormName: '{{ FormName }}' + Content: '{{ Content }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.subscription_targets +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +datazone:GetSubscriptionTarget +``` + +### Update +```json +datazone:UpdateSubscriptionTarget, +datazone:GetSubscriptionTarget, +iam:PassRole +``` + +### Delete +```json +datazone:DeleteSubscriptionTarget +``` + +### List +```json +datazone:ListSubscriptionTargets +``` diff --git a/website/docs/services/datazone/subscription_targets_list_only/index.md b/website/docs/services/datazone/subscription_targets_list_only/index.md new file mode 100644 index 0000000..2405292 --- /dev/null +++ b/website/docs/services/datazone/subscription_targets_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: subscription_targets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subscription_targets_list_only + - datazone + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subscription_targets in a region or regions, for all properties use subscription_targets + +## Overview + + + + + + + +
Namesubscription_targets_list_only
TypeResource
DescriptionSubscription targets enables one to access the data to which you have subscribed in your projects.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the Amazon DataZone domain in which subscription target is created.
stringThe ID of the environment in which subscription target is created.
stringThe ID of the subscription target.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subscription_targets in a region. +```sql +SELECT +region, +domain_id, +environment_id, +id +FROM aws.datazone.subscription_targets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subscription_targets_list_only resource, see subscription_targets + diff --git a/website/docs/services/datazone/user_profiles/index.md b/website/docs/services/datazone/user_profiles/index.md new file mode 100644 index 0000000..caec055 --- /dev/null +++ b/website/docs/services/datazone/user_profiles/index.md @@ -0,0 +1,254 @@ +--- +title: user_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - user_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_profile resource or lists user_profiles in a region + +## Overview + + + + + + + +
Nameuser_profiles
TypeResource
DescriptionA user profile represents Amazon DataZone users. Amazon DataZone supports both IAM roles and SSO identities to interact with the Amazon DataZone Management Console and the data portal for different purposes. Domain administrators use IAM roles to perform the initial administrative domain-related work in the Amazon DataZone Management Console, including creating new Amazon DataZone domains, configuring metadata form types, and implementing policies. Data workers use their SSO corporate identities via Identity Center to log into the Amazon DataZone Data Portal and access projects where they have memberships.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
undefined
stringThe identifier of the Amazon DataZone domain in which the user profile is created.
stringThe identifier of the Amazon DataZone domain in which the user profile would be created.
stringThe ID of the Amazon DataZone user profile.
stringThe status of the user profile.
stringThe type of the user profile.
stringThe ID of the user.
stringThe type of the user.
stringAWS region.
+ +For more information, see AWS::DataZone::UserProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_profiles in a region. +```sql +SELECT +region, +details, +domain_id, +domain_identifier, +id, +status, +type, +user_identifier, +user_type +FROM aws.datazone.user_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_profile. +```sql +SELECT +region, +details, +domain_id, +domain_identifier, +id, +status, +type, +user_identifier, +user_type +FROM aws.datazone.user_profiles +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.user_profiles ( + DomainIdentifier, + UserIdentifier, + region +) +SELECT +'{{ DomainIdentifier }}', + '{{ UserIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.datazone.user_profiles ( + DomainIdentifier, + Status, + UserIdentifier, + UserType, + region +) +SELECT + '{{ DomainIdentifier }}', + '{{ Status }}', + '{{ UserIdentifier }}', + '{{ UserType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_profile + props: + - name: DomainIdentifier + value: '{{ DomainIdentifier }}' + - name: Status + value: '{{ Status }}' + - name: UserIdentifier + value: '{{ UserIdentifier }}' + - name: UserType + value: '{{ UserType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.datazone.user_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the user_profiles resource, the following permissions are required: + +### Create +```json +datazone:CreateUserProfile, +datazone:GetUserProfile, +datazone:UpdateUserProfile, +datazone:GetDomain, +sso:ListProfiles, +sso:GetProfile, +sso:AssociateProfile, +sso:DisassociateProfile, +iam:GetRole, +iam:GetUser +``` + +### Read +```json +datazone:GetUserProfile +``` + +### Update +```json +datazone:UpdateUserProfile, +datazone:GetUserProfile, +datazone:UpdateUserProfile, +sso:ListProfiles, +sso:GetProfile, +sso:AssociateProfile, +sso:DisassociateProfile, +iam:GetRole, +iam:GetUser +``` + +### Delete +```json +datazone:DeleteUserProfile, +datazone:GetUserProfile, +datazone:UpdateUserProfile, +sso:ListProfiles, +sso:GetProfile, +sso:AssociateProfile, +sso:DisassociateProfile, +iam:GetRole, +iam:GetUser +``` + +### List +```json +datazone:SearchUserProfiles +``` diff --git a/website/docs/services/datazone/user_profiles_list_only/index.md b/website/docs/services/datazone/user_profiles_list_only/index.md new file mode 100644 index 0000000..dd38bd0 --- /dev/null +++ b/website/docs/services/datazone/user_profiles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: user_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_profiles_list_only + - datazone + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_profiles in a region or regions, for all properties use user_profiles + +## Overview + + + + + + + +
Nameuser_profiles_list_only
TypeResource
DescriptionA user profile represents Amazon DataZone users. Amazon DataZone supports both IAM roles and SSO identities to interact with the Amazon DataZone Management Console and the data portal for different purposes. Domain administrators use IAM roles to perform the initial administrative domain-related work in the Amazon DataZone Management Console, including creating new Amazon DataZone domains, configuring metadata form types, and implementing policies. Data workers use their SSO corporate identities via Identity Center to log into the Amazon DataZone Data Portal and access projects where they have memberships.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon DataZone domain in which the user profile is created.
stringThe ID of the Amazon DataZone user profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_profiles in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.user_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_profiles_list_only resource, see user_profiles + diff --git a/website/docs/services/deadline/farm_tags/index.md b/website/docs/services/deadline/farm_tags/index.md new file mode 100644 index 0000000..6c8f43e --- /dev/null +++ b/website/docs/services/deadline/farm_tags/index.md @@ -0,0 +1,85 @@ +--- +title: farm_tags +hide_title: false +hide_table_of_contents: false +keywords: + - farm_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for farms in a region + +## Overview + + + + + + + +
Namefarm_tags
TypeResource
DescriptionDefinition of AWS::Deadline::Farm Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all farms in a region. +```sql +SELECT +region, +description, +display_name, +farm_id, +kms_key_arn, +arn, +tag_key, +tag_value +FROM aws.deadline.farm_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the farm_tags resource, see farms + diff --git a/website/docs/services/deadline/farms/index.md b/website/docs/services/deadline/farms/index.md new file mode 100644 index 0000000..df11156 --- /dev/null +++ b/website/docs/services/deadline/farms/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a farm resource or lists farms in a region + +## Overview + + + + + + + +
Namefarms
TypeResource
DescriptionDefinition of AWS::Deadline::Farm Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Deadline::Farm. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all farms in a region. +```sql +SELECT +region, +description, +display_name, +farm_id, +kms_key_arn, +arn, +tags +FROM aws.deadline.farms +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual farm. +```sql +SELECT +region, +description, +display_name, +farm_id, +kms_key_arn, +arn, +tags +FROM aws.deadline.farms +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new farm resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.farms ( + DisplayName, + region +) +SELECT +'{{ DisplayName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.farms ( + Description, + DisplayName, + KmsKeyArn, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ DisplayName }}', + '{{ KmsKeyArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: farm + props: + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.deadline.farms +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the farms resource, the following permissions are required: + +### Create +```json +deadline:CreateFarm, +deadline:GetFarm, +deadline:TagResource, +deadline:ListTagsForResource, +identitystore:ListGroupMembershipsForMember, +kms:Encrypt, +kms:Decrypt, +kms:CreateGrant, +kms:GenerateDataKey +``` + +### Read +```json +deadline:GetFarm, +deadline:ListTagsForResource, +identitystore:ListGroupMembershipsForMember, +kms:Encrypt, +kms:Decrypt, +kms:CreateGrant, +kms:GenerateDataKey +``` + +### Update +```json +deadline:UpdateFarm, +deadline:GetFarm, +deadline:TagResource, +deadline:UntagResource, +deadline:ListTagsForResource, +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 +``` + +### List +```json +deadline:ListFarms, +identitystore:ListGroupMembershipsForMember +``` diff --git a/website/docs/services/deadline/farms_list_only/index.md b/website/docs/services/deadline/farms_list_only/index.md new file mode 100644 index 0000000..b2df752 --- /dev/null +++ b/website/docs/services/deadline/farms_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: farms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - farms_list_only + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists farms in a region or regions, for all properties use farms + +## Overview + + + + + + + +
Namefarms_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::Farm Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all farms in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.farms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the farms_list_only resource, see farms + diff --git a/website/docs/services/deadline/fleet_tags/index.md b/website/docs/services/deadline/fleet_tags/index.md new file mode 100644 index 0000000..0dea4e4 --- /dev/null +++ b/website/docs/services/deadline/fleet_tags/index.md @@ -0,0 +1,99 @@ +--- +title: fleet_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fleets in a region + +## Overview + + + + + + + +
Namefleet_tags
TypeResource
DescriptionDefinition of AWS::Deadline::Fleet Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
undefined
string
string
string
string
integer
integer
string
string
integer
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fleets in a region. +```sql +SELECT +region, +capabilities, +configuration, +description, +display_name, +farm_id, +fleet_id, +max_worker_count, +min_worker_count, +role_arn, +status, +worker_count, +arn, +tag_key, +tag_value +FROM aws.deadline.fleet_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_tags resource, see fleets + diff --git a/website/docs/services/deadline/fleets/index.md b/website/docs/services/deadline/fleets/index.md new file mode 100644 index 0000000..77ab21a --- /dev/null +++ b/website/docs/services/deadline/fleets/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a fleet resource or lists fleets in a region + +## Overview + + + + + + + +
Namefleets
TypeResource
DescriptionDefinition of AWS::Deadline::Fleet Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
undefined
string
string
string
string
integer
integer
string
string
integer
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Deadline::Fleet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all fleets in a region. +```sql +SELECT +region, +capabilities, +configuration, +description, +display_name, +farm_id, +fleet_id, +max_worker_count, +min_worker_count, +role_arn, +status, +worker_count, +arn, +tags +FROM aws.deadline.fleets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual fleet. +```sql +SELECT +region, +capabilities, +configuration, +description, +display_name, +farm_id, +fleet_id, +max_worker_count, +min_worker_count, +role_arn, +status, +worker_count, +arn, +tags +FROM aws.deadline.fleets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.fleets ( + Configuration, + DisplayName, + FarmId, + MaxWorkerCount, + RoleArn, + region +) +SELECT +'{{ Configuration }}', + '{{ DisplayName }}', + '{{ FarmId }}', + '{{ MaxWorkerCount }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.fleets ( + Configuration, + Description, + DisplayName, + FarmId, + MaxWorkerCount, + MinWorkerCount, + RoleArn, + Tags, + region +) +SELECT + '{{ Configuration }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ FarmId }}', + '{{ MaxWorkerCount }}', + '{{ MinWorkerCount }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: fleet + props: + - name: Configuration + value: null + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: FarmId + value: '{{ FarmId }}' + - name: MaxWorkerCount + value: '{{ MaxWorkerCount }}' + - name: MinWorkerCount + value: '{{ MinWorkerCount }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.deadline.fleets +WHERE data__Identifier = '' +AND 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, +deadline:TagResource, +deadline:ListTagsForResource +``` + +### Read +```json +deadline:GetFleet, +identitystore:ListGroupMembershipsForMember, +deadline:ListTagsForResource +``` + +### Update +```json +deadline:UpdateFleet, +deadline:GetFleet, +iam:PassRole, +identitystore:ListGroupMembershipsForMember, +deadline:TagResource, +deadline:UntagResource, +deadline:ListTagsForResource +``` + +### Delete +```json +deadline:DeleteFleet, +deadline:GetFleet, +identitystore:ListGroupMembershipsForMember +``` + +### List +```json +deadline:ListFleets, +identitystore:DescribeGroup, +identitystore:DescribeUser, +identitystore:ListGroupMembershipsForMember +``` diff --git a/website/docs/services/deadline/fleets_list_only/index.md b/website/docs/services/deadline/fleets_list_only/index.md new file mode 100644 index 0000000..5a618b8 --- /dev/null +++ b/website/docs/services/deadline/fleets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleets_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleets in a region or regions, for all properties use fleets + +## Overview + + + + + + + +
Namefleets_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::Fleet Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleets in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleets_list_only resource, see fleets + diff --git a/website/docs/services/deadline/index.md b/website/docs/services/deadline/index.md new file mode 100644 index 0000000..4e5e6d3 --- /dev/null +++ b/website/docs/services/deadline/index.md @@ -0,0 +1,57 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The deadline service documentation. + +:::info Service Summary + +
+
+total resources: 22
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/deadline/license_endpoint_tags/index.md b/website/docs/services/deadline/license_endpoint_tags/index.md new file mode 100644 index 0000000..c3a059b --- /dev/null +++ b/website/docs/services/deadline/license_endpoint_tags/index.md @@ -0,0 +1,91 @@ +--- +title: license_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - license_endpoint_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for license_endpoints in a region + +## Overview + + + + + + + +
Namelicense_endpoint_tags
TypeResource
DescriptionDefinition of AWS::Deadline::LicenseEndpoint Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all license_endpoints in a region. +```sql +SELECT +region, +dns_name, +license_endpoint_id, +security_group_ids, +status, +status_message, +subnet_ids, +vpc_id, +arn, +tag_key, +tag_value +FROM aws.deadline.license_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the license_endpoint_tags resource, see license_endpoints + diff --git a/website/docs/services/deadline/license_endpoints/index.md b/website/docs/services/deadline/license_endpoints/index.md new file mode 100644 index 0000000..2cee327 --- /dev/null +++ b/website/docs/services/deadline/license_endpoints/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a license_endpoint resource or lists license_endpoints in a region + +## Overview + + + + + + + +
Namelicense_endpoints
TypeResource
DescriptionDefinition of AWS::Deadline::LicenseEndpoint Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
array
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Deadline::LicenseEndpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all license_endpoints in a region. +```sql +SELECT +region, +dns_name, +license_endpoint_id, +security_group_ids, +status, +status_message, +subnet_ids, +vpc_id, +arn, +tags +FROM aws.deadline.license_endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual license_endpoint. +```sql +SELECT +region, +dns_name, +license_endpoint_id, +security_group_ids, +status, +status_message, +subnet_ids, +vpc_id, +arn, +tags +FROM aws.deadline.license_endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new license_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.license_endpoints ( + SecurityGroupIds, + SubnetIds, + VpcId, + region +) +SELECT +'{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.license_endpoints ( + SecurityGroupIds, + SubnetIds, + VpcId, + Tags, + region +) +SELECT + '{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ VpcId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: license_endpoint + props: + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: VpcId + value: '{{ VpcId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.deadline.license_endpoints +WHERE data__Identifier = '' +AND 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, +deadline:TagResource, +deadline:ListTagsForResource +``` + +### Read +```json +deadline:GetLicenseEndpoint, +deadline:ListTagsForResource +``` + +### Update +```json +deadline:TagResource, +deadline:UntagResource, +deadline:ListTagsForResource, +deadline:GetLicenseEndpoint +``` + +### Delete +```json +deadline:GetLicenseEndpoint, +deadline:DeleteLicenseEndpoint, +ec2:DeleteVpcEndpoints, +ec2:DescribeVpcEndpoints +``` + +### List +```json +deadline:ListLicenseEndpoints +``` diff --git a/website/docs/services/deadline/license_endpoints_list_only/index.md b/website/docs/services/deadline/license_endpoints_list_only/index.md new file mode 100644 index 0000000..7cba48c --- /dev/null +++ b/website/docs/services/deadline/license_endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: license_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - license_endpoints_list_only + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists license_endpoints in a region or regions, for all properties use license_endpoints + +## Overview + + + + + + + +
Namelicense_endpoints_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::LicenseEndpoint Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all license_endpoints in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.license_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the license_endpoints_list_only resource, see license_endpoints + diff --git a/website/docs/services/deadline/metered_products/index.md b/website/docs/services/deadline/metered_products/index.md new file mode 100644 index 0000000..070b85b --- /dev/null +++ b/website/docs/services/deadline/metered_products/index.md @@ -0,0 +1,208 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a metered_product resource or lists metered_products in a region + +## Overview + + + + + + + +
Namemetered_products
TypeResource
DescriptionDefinition of AWS::Deadline::MeteredProduct Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
string
string
string
stringAWS region.
+ +For more information, see AWS::Deadline::MeteredProduct. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all metered_products in a region. +```sql +SELECT +region, +license_endpoint_id, +product_id, +port, +family, +vendor, +arn +FROM aws.deadline.metered_products +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual metered_product. +```sql +SELECT +region, +license_endpoint_id, +product_id, +port, +family, +vendor, +arn +FROM aws.deadline.metered_products +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new metered_product resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.metered_products ( + LicenseEndpointId, + ProductId, + region +) +SELECT +'{{ LicenseEndpointId }}', + '{{ ProductId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.metered_products ( + LicenseEndpointId, + ProductId, + region +) +SELECT + '{{ LicenseEndpointId }}', + '{{ ProductId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: metered_product + props: + - name: LicenseEndpointId + value: '{{ LicenseEndpointId }}' + - name: ProductId + value: '{{ ProductId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.deadline.metered_products +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the metered_products resource, the following permissions are required: + +### Create +```json +deadline:PutMeteredProduct, +deadline:ListMeteredProducts +``` + +### Read +```json +deadline:GetMeteredProduct, +deadline:ListMeteredProducts +``` + +### Delete +```json +deadline:DeleteMeteredProduct, +deadline:ListMeteredProducts +``` + +### List +```json +deadline:ListMeteredProducts +``` diff --git a/website/docs/services/deadline/metered_products_list_only/index.md b/website/docs/services/deadline/metered_products_list_only/index.md new file mode 100644 index 0000000..d51f7df --- /dev/null +++ b/website/docs/services/deadline/metered_products_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: metered_products_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - metered_products_list_only + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists metered_products in a region or regions, for all properties use metered_products + +## Overview + + + + + + + +
Namemetered_products_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::MeteredProduct Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all metered_products in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.metered_products_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the metered_products_list_only resource, see metered_products + diff --git a/website/docs/services/deadline/monitors/index.md b/website/docs/services/deadline/monitors/index.md new file mode 100644 index 0000000..b937380 --- /dev/null +++ b/website/docs/services/deadline/monitors/index.md @@ -0,0 +1,248 @@ +--- +title: monitors +hide_title: false +hide_table_of_contents: false +keywords: + - monitors + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a monitor resource or lists monitors in a region + +## Overview + + + + + + + +
Namemonitors
TypeResource
DescriptionDefinition of AWS::Deadline::Monitor Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
stringAWS region.
+ +For more information, see AWS::Deadline::Monitor. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all monitors in a region. +```sql +SELECT +region, +display_name, +identity_center_application_arn, +identity_center_instance_arn, +monitor_id, +role_arn, +subdomain, +url, +arn +FROM aws.deadline.monitors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual monitor. +```sql +SELECT +region, +display_name, +identity_center_application_arn, +identity_center_instance_arn, +monitor_id, +role_arn, +subdomain, +url, +arn +FROM aws.deadline.monitors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new monitor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.monitors ( + DisplayName, + IdentityCenterInstanceArn, + RoleArn, + Subdomain, + region +) +SELECT +'{{ DisplayName }}', + '{{ IdentityCenterInstanceArn }}', + '{{ RoleArn }}', + '{{ Subdomain }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.monitors ( + DisplayName, + IdentityCenterInstanceArn, + RoleArn, + Subdomain, + region +) +SELECT + '{{ DisplayName }}', + '{{ IdentityCenterInstanceArn }}', + '{{ RoleArn }}', + '{{ Subdomain }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: monitor + props: + - name: DisplayName + value: '{{ DisplayName }}' + - name: IdentityCenterInstanceArn + value: '{{ IdentityCenterInstanceArn }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Subdomain + value: '{{ Subdomain }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.deadline.monitors +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the monitors resource, the following permissions are required: + +### Create +```json +deadline:CreateMonitor, +deadline:GetMonitor, +iam:PassRole, +kms:CreateGrant, +sso:CreateApplication, +sso:DeleteApplication, +sso:PutApplicationAssignmentConfiguration, +sso:PutApplicationAuthenticationMethod, +sso:PutApplicationGrant +``` + +### Read +```json +deadline:GetMonitor +``` + +### Update +```json +deadline:GetMonitor, +deadline:UpdateMonitor, +iam:PassRole, +kms:CreateGrant, +sso:PutApplicationGrant, +sso:UpdateApplication +``` + +### Delete +```json +deadline:DeleteMonitor, +deadline:GetMonitor, +sso:DeleteApplication +``` + +### List +```json +deadline:ListMonitors +``` diff --git a/website/docs/services/deadline/monitors_list_only/index.md b/website/docs/services/deadline/monitors_list_only/index.md new file mode 100644 index 0000000..9a49cfe --- /dev/null +++ b/website/docs/services/deadline/monitors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: monitors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - monitors_list_only + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists monitors in a region or regions, for all properties use monitors + +## Overview + + + + + + + +
Namemonitors_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::Monitor Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all monitors in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.monitors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the monitors_list_only resource, see monitors + diff --git a/website/docs/services/deadline/queue_environments/index.md b/website/docs/services/deadline/queue_environments/index.md new file mode 100644 index 0000000..5b41628 --- /dev/null +++ b/website/docs/services/deadline/queue_environments/index.md @@ -0,0 +1,242 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a queue_environment resource or lists queue_environments in a region + +## Overview + + + + + + + +
Namequeue_environments
TypeResource
DescriptionDefinition of AWS::Deadline::QueueEnvironment Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
string
string
string
string
stringAWS region.
+ +For more information, see AWS::Deadline::QueueEnvironment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all queue_environments in a region. +```sql +SELECT +region, +farm_id, +name, +priority, +queue_environment_id, +queue_id, +template, +template_type +FROM aws.deadline.queue_environments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual queue_environment. +```sql +SELECT +region, +farm_id, +name, +priority, +queue_environment_id, +queue_id, +template, +template_type +FROM aws.deadline.queue_environments +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new queue_environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.queue_environments ( + FarmId, + Priority, + QueueId, + Template, + TemplateType, + region +) +SELECT +'{{ FarmId }}', + '{{ Priority }}', + '{{ QueueId }}', + '{{ Template }}', + '{{ TemplateType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.queue_environments ( + FarmId, + Priority, + QueueId, + Template, + TemplateType, + region +) +SELECT + '{{ FarmId }}', + '{{ Priority }}', + '{{ QueueId }}', + '{{ Template }}', + '{{ TemplateType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: queue_environment + props: + - name: FarmId + value: '{{ FarmId }}' + - name: Priority + value: '{{ Priority }}' + - name: QueueId + value: '{{ QueueId }}' + - name: Template + value: '{{ Template }}' + - name: TemplateType + value: '{{ TemplateType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.deadline.queue_environments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the queue_environments resource, the following permissions are required: + +### Create +```json +deadline:CreateQueueEnvironment, +identitystore:ListGroupMembershipsForMember +``` + +### Read +```json +deadline:GetQueueEnvironment, +identitystore:ListGroupMembershipsForMember +``` + +### Update +```json +deadline:UpdateQueueEnvironment, +identitystore:ListGroupMembershipsForMember +``` + +### Delete +```json +deadline:DeleteQueueEnvironment, +deadline:GetQueueEnvironment, +identitystore:ListGroupMembershipsForMember +``` + +### List +```json +deadline:ListQueueEnvironments, +identitystore:ListGroupMembershipsForMember +``` diff --git a/website/docs/services/deadline/queue_environments_list_only/index.md b/website/docs/services/deadline/queue_environments_list_only/index.md new file mode 100644 index 0000000..cb9966f --- /dev/null +++ b/website/docs/services/deadline/queue_environments_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: queue_environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queue_environments_list_only + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queue_environments in a region or regions, for all properties use queue_environments + +## Overview + + + + + + + +
Namequeue_environments_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::QueueEnvironment Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queue_environments in a region. +```sql +SELECT +region, +farm_id, +queue_id, +queue_environment_id +FROM aws.deadline.queue_environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queue_environments_list_only resource, see queue_environments + diff --git a/website/docs/services/deadline/queue_fleet_associations/index.md b/website/docs/services/deadline/queue_fleet_associations/index.md new file mode 100644 index 0000000..39e9d07 --- /dev/null +++ b/website/docs/services/deadline/queue_fleet_associations/index.md @@ -0,0 +1,209 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a queue_fleet_association resource or lists queue_fleet_associations in a region + +## Overview + + + + + + + +
Namequeue_fleet_associations
TypeResource
DescriptionDefinition of AWS::Deadline::QueueFleetAssociation Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +For more information, see AWS::Deadline::QueueFleetAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all queue_fleet_associations in a region. +```sql +SELECT +region, +farm_id, +fleet_id, +queue_id +FROM aws.deadline.queue_fleet_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual queue_fleet_association. +```sql +SELECT +region, +farm_id, +fleet_id, +queue_id +FROM aws.deadline.queue_fleet_associations +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new queue_fleet_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.queue_fleet_associations ( + FarmId, + FleetId, + QueueId, + region +) +SELECT +'{{ FarmId }}', + '{{ FleetId }}', + '{{ QueueId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.queue_fleet_associations ( + FarmId, + FleetId, + QueueId, + region +) +SELECT + '{{ FarmId }}', + '{{ FleetId }}', + '{{ QueueId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: queue_fleet_association + props: + - name: FarmId + value: '{{ FarmId }}' + - name: FleetId + value: '{{ FleetId }}' + - name: QueueId + value: '{{ QueueId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.deadline.queue_fleet_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +deadline:GetQueueFleetAssociation, +identitystore:ListGroupMembershipsForMember +``` + +### Delete +```json +deadline:DeleteQueueFleetAssociation, +deadline:GetQueueFleetAssociation, +deadline:UpdateQueueFleetAssociation, +identitystore:ListGroupMembershipsForMember +``` + +### List +```json +deadline:ListQueueFleetAssociations, +identitystore:ListGroupMembershipsForMember +``` diff --git a/website/docs/services/deadline/queue_fleet_associations_list_only/index.md b/website/docs/services/deadline/queue_fleet_associations_list_only/index.md new file mode 100644 index 0000000..4cfc997 --- /dev/null +++ b/website/docs/services/deadline/queue_fleet_associations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: queue_fleet_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queue_fleet_associations_list_only + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queue_fleet_associations in a region or regions, for all properties use queue_fleet_associations + +## Overview + + + + + + + +
Namequeue_fleet_associations_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::QueueFleetAssociation Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queue_fleet_associations in a region. +```sql +SELECT +region, +farm_id, +fleet_id, +queue_id +FROM aws.deadline.queue_fleet_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queue_fleet_associations_list_only resource, see queue_fleet_associations + diff --git a/website/docs/services/deadline/queue_tags/index.md b/website/docs/services/deadline/queue_tags/index.md new file mode 100644 index 0000000..dca0a29 --- /dev/null +++ b/website/docs/services/deadline/queue_tags/index.md @@ -0,0 +1,97 @@ +--- +title: queue_tags +hide_title: false +hide_table_of_contents: false +keywords: + - queue_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for queues in a region + +## Overview + + + + + + + +
Namequeue_tags
TypeResource
DescriptionDefinition of AWS::Deadline::Queue Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
string
object
object
string
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all queues in a region. +```sql +SELECT +region, +allowed_storage_profile_ids, +default_budget_action, +description, +display_name, +farm_id, +job_attachment_settings, +job_run_as_user, +queue_id, +required_file_system_location_names, +role_arn, +arn, +tag_key, +tag_value +FROM aws.deadline.queue_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queue_tags resource, see queues + diff --git a/website/docs/services/deadline/queues/index.md b/website/docs/services/deadline/queues/index.md new file mode 100644 index 0000000..394004c --- /dev/null +++ b/website/docs/services/deadline/queues/index.md @@ -0,0 +1,300 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a queue resource or lists queues in a region + +## Overview + + + + + + + +
Namequeues
TypeResource
DescriptionDefinition of AWS::Deadline::Queue Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
string
object
object
string
array
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Deadline::Queue. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all queues in a region. +```sql +SELECT +region, +allowed_storage_profile_ids, +default_budget_action, +description, +display_name, +farm_id, +job_attachment_settings, +job_run_as_user, +queue_id, +required_file_system_location_names, +role_arn, +arn, +tags +FROM aws.deadline.queues +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual queue. +```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, +tags +FROM aws.deadline.queues +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.queues ( + DisplayName, + FarmId, + region +) +SELECT +'{{ DisplayName }}', + '{{ FarmId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.queues ( + AllowedStorageProfileIds, + DefaultBudgetAction, + Description, + DisplayName, + FarmId, + JobAttachmentSettings, + JobRunAsUser, + RequiredFileSystemLocationNames, + RoleArn, + Tags, + region +) +SELECT + '{{ AllowedStorageProfileIds }}', + '{{ DefaultBudgetAction }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ FarmId }}', + '{{ JobAttachmentSettings }}', + '{{ JobRunAsUser }}', + '{{ RequiredFileSystemLocationNames }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: queue + props: + - name: AllowedStorageProfileIds + value: + - '{{ AllowedStorageProfileIds[0] }}' + - name: DefaultBudgetAction + value: '{{ DefaultBudgetAction }}' + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: FarmId + value: '{{ FarmId }}' + - name: JobAttachmentSettings + value: + S3BucketName: '{{ S3BucketName }}' + RootPrefix: '{{ RootPrefix }}' + - name: JobRunAsUser + value: + Posix: + User: '{{ User }}' + Group: '{{ Group }}' + Windows: + User: '{{ User }}' + PasswordArn: '{{ PasswordArn }}' + RunAs: '{{ RunAs }}' + - name: RequiredFileSystemLocationNames + value: + - '{{ RequiredFileSystemLocationNames[0] }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.deadline.queues +WHERE data__Identifier = '' +AND 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, +deadline:TagResource, +deadline:ListTagsForResource +``` + +### Read +```json +deadline:GetQueue, +identitystore:ListGroupMembershipsForMember, +deadline:ListTagsForResource +``` + +### Update +```json +deadline:UpdateQueue, +deadline:GetQueue, +iam:PassRole, +identitystore:ListGroupMembershipsForMember, +logs:CreateLogGroup, +s3:ListBucket, +deadline:TagResource, +deadline:UntagResource, +deadline:ListTagsForResource +``` + +### Delete +```json +deadline:DeleteQueue, +deadline:GetQueue, +identitystore:ListGroupMembershipsForMember +``` + +### List +```json +deadline:ListQueues, +identitystore:DescribeGroup, +identitystore:DescribeUser, +identitystore:ListGroupMembershipsForMember +``` diff --git a/website/docs/services/deadline/queues_list_only/index.md b/website/docs/services/deadline/queues_list_only/index.md new file mode 100644 index 0000000..24bee27 --- /dev/null +++ b/website/docs/services/deadline/queues_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queues_list_only + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queues in a region or regions, for all properties use queues + +## Overview + + + + + + + +
Namequeues_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::Queue Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queues in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queues_list_only resource, see queues + diff --git a/website/docs/services/deadline/storage_profiles/index.md b/website/docs/services/deadline/storage_profiles/index.md new file mode 100644 index 0000000..2192662 --- /dev/null +++ b/website/docs/services/deadline/storage_profiles/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a storage_profile resource or lists storage_profiles in a region + +## Overview + + + + + + + +
Namestorage_profiles
TypeResource
DescriptionDefinition of AWS::Deadline::StorageProfile Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
stringAWS region.
+ +For more information, see AWS::Deadline::StorageProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all storage_profiles in a region. +```sql +SELECT +region, +display_name, +farm_id, +file_system_locations, +os_family, +storage_profile_id +FROM aws.deadline.storage_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual storage_profile. +```sql +SELECT +region, +display_name, +farm_id, +file_system_locations, +os_family, +storage_profile_id +FROM aws.deadline.storage_profiles +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new storage_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.storage_profiles ( + DisplayName, + FarmId, + OsFamily, + region +) +SELECT +'{{ DisplayName }}', + '{{ FarmId }}', + '{{ OsFamily }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.deadline.storage_profiles ( + DisplayName, + FarmId, + FileSystemLocations, + OsFamily, + region +) +SELECT + '{{ DisplayName }}', + '{{ FarmId }}', + '{{ FileSystemLocations }}', + '{{ OsFamily }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: storage_profile + props: + - name: DisplayName + value: '{{ DisplayName }}' + - name: FarmId + value: '{{ FarmId }}' + - name: FileSystemLocations + value: + - Name: '{{ Name }}' + Path: '{{ Path }}' + Type: '{{ Type }}' + - name: OsFamily + value: '{{ OsFamily }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.deadline.storage_profiles +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +deadline:GetStorageProfile, +identitystore:ListGroupMembershipsForMember +``` + +### Update +```json +deadline:UpdateStorageProfile, +deadline:GetStorageProfile, +identitystore:ListGroupMembershipsForMember +``` + +### Delete +```json +deadline:DeleteStorageProfile, +deadline:GetStorageProfile, +identitystore:ListGroupMembershipsForMember +``` + +### List +```json +deadline:ListStorageProfiles, +identitystore:ListGroupMembershipsForMember +``` diff --git a/website/docs/services/deadline/storage_profiles_list_only/index.md b/website/docs/services/deadline/storage_profiles_list_only/index.md new file mode 100644 index 0000000..de0725c --- /dev/null +++ b/website/docs/services/deadline/storage_profiles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: storage_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - storage_profiles_list_only + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists storage_profiles in a region or regions, for all properties use storage_profiles + +## Overview + + + + + + + +
Namestorage_profiles_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::StorageProfile Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all storage_profiles in a region. +```sql +SELECT +region, +farm_id, +storage_profile_id +FROM aws.deadline.storage_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_profiles_list_only resource, see storage_profiles + diff --git a/website/docs/services/detective/graph_tags/index.md b/website/docs/services/detective/graph_tags/index.md new file mode 100644 index 0000000..b7532ee --- /dev/null +++ b/website/docs/services/detective/graph_tags/index.md @@ -0,0 +1,79 @@ +--- +title: graph_tags +hide_title: false +hide_table_of_contents: false +keywords: + - graph_tags + - detective + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for graphs in a region + +## Overview + + + + + + + +
Namegraph_tags
TypeResource
DescriptionResource schema for AWS::Detective::Graph
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Detective graph ARN
booleanIndicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all graphs in a region. +```sql +SELECT +region, +arn, +auto_enable_members, +tag_key, +tag_value +FROM aws.detective.graph_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the graph_tags resource, see graphs + diff --git a/website/docs/services/detective/graphs/index.md b/website/docs/services/detective/graphs/index.md new file mode 100644 index 0000000..f277da6 --- /dev/null +++ b/website/docs/services/detective/graphs/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a graph resource or lists graphs in a region + +## Overview + + + + + + + +
Namegraphs
TypeResource
DescriptionResource schema for AWS::Detective::Graph
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Detective graph ARN
array
booleanIndicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
stringAWS region.
+ +For more information, see AWS::Detective::Graph. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all graphs in a region. +```sql +SELECT +region, +arn, +tags, +auto_enable_members +FROM aws.detective.graphs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual graph. +```sql +SELECT +region, +arn, +tags, +auto_enable_members +FROM aws.detective.graphs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new graph resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.detective.graphs ( + Tags, + AutoEnableMembers, + region +) +SELECT +'{{ Tags }}', + '{{ AutoEnableMembers }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.detective.graphs ( + Tags, + AutoEnableMembers, + region +) +SELECT + '{{ Tags }}', + '{{ AutoEnableMembers }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: graph + props: + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AutoEnableMembers + value: '{{ AutoEnableMembers }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.detective.graphs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the graphs resource, the following permissions are required: + +### Create +```json +detective:CreateGraph, +detective:UpdateOrganizationConfiguration, +organizations:DescribeOrganization +``` + +### 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 +``` + +### List +```json +detective:ListGraphs, +detective:ListTagsForResource, +detective:DescribeOrganizationConfiguration, +organizations:DescribeOrganization +``` diff --git a/website/docs/services/detective/graphs_list_only/index.md b/website/docs/services/detective/graphs_list_only/index.md new file mode 100644 index 0000000..67a8050 --- /dev/null +++ b/website/docs/services/detective/graphs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: graphs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - graphs_list_only + - detective + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists graphs in a region or regions, for all properties use graphs + +## Overview + + + + + + + +
Namegraphs_list_only
TypeResource
DescriptionResource schema for AWS::Detective::Graph
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Detective graph ARN
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all graphs in a region. +```sql +SELECT +region, +arn +FROM aws.detective.graphs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the graphs_list_only resource, see graphs + diff --git a/website/docs/services/detective/index.md b/website/docs/services/detective/index.md new file mode 100644 index 0000000..bfbee89 --- /dev/null +++ b/website/docs/services/detective/index.md @@ -0,0 +1,42 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The detective service documentation. + +:::info Service Summary + +
+
+total resources: 7
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/detective/member_invitations/index.md b/website/docs/services/detective/member_invitations/index.md new file mode 100644 index 0000000..5c46b3a --- /dev/null +++ b/website/docs/services/detective/member_invitations/index.md @@ -0,0 +1,218 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a member_invitation resource or lists member_invitations in a region + +## Overview + + + + + + + +
Namemember_invitations
TypeResource
DescriptionResource schema for AWS::Detective::MemberInvitation
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the graph to which the member account will be invited
stringThe AWS account ID to be invited to join the graph as a member
stringThe root email address for the account to be invited, for validation. Updating this field has no effect.
booleanWhen set to true, invitation emails are not sent to the member accounts. Member accounts must still accept the invitation before they are added to the behavior graph. Updating this field has no effect.
stringA message to be included in the email invitation sent to the invited account. Updating this field has no effect.
stringAWS region.
+ +For more information, see AWS::Detective::MemberInvitation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all member_invitations in a region. +```sql +SELECT +region, +graph_arn, +member_id, +member_email_address, +disable_email_notification, +message +FROM aws.detective.member_invitations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual member_invitation. +```sql +SELECT +region, +graph_arn, +member_id, +member_email_address, +disable_email_notification, +message +FROM aws.detective.member_invitations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new member_invitation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.detective.member_invitations ( + GraphArn, + MemberId, + MemberEmailAddress, + region +) +SELECT +'{{ GraphArn }}', + '{{ MemberId }}', + '{{ MemberEmailAddress }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.detective.member_invitations ( + GraphArn, + MemberId, + MemberEmailAddress, + DisableEmailNotification, + Message, + region +) +SELECT + '{{ GraphArn }}', + '{{ MemberId }}', + '{{ MemberEmailAddress }}', + '{{ DisableEmailNotification }}', + '{{ Message }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: member_invitation + props: + - name: GraphArn + value: '{{ GraphArn }}' + - name: MemberId + value: '{{ MemberId }}' + - name: MemberEmailAddress + value: '{{ MemberEmailAddress }}' + - name: DisableEmailNotification + value: '{{ DisableEmailNotification }}' + - name: Message + value: '{{ Message }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.detective.member_invitations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the member_invitations resource, the following permissions are required: + +### Create +```json +detective:CreateMembers, +detective:GetMembers +``` + +### Read +```json +detective:GetMembers +``` + +### Delete +```json +detective:DeleteMembers +``` + +### List +```json +detective:ListGraphs, +detective:ListMembers +``` diff --git a/website/docs/services/detective/member_invitations_list_only/index.md b/website/docs/services/detective/member_invitations_list_only/index.md new file mode 100644 index 0000000..fff3015 --- /dev/null +++ b/website/docs/services/detective/member_invitations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: member_invitations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - member_invitations_list_only + - detective + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists member_invitations in a region or regions, for all properties use member_invitations + +## Overview + + + + + + + +
Namemember_invitations_list_only
TypeResource
DescriptionResource schema for AWS::Detective::MemberInvitation
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ARN of the graph to which the member account will be invited
stringThe AWS account ID to be invited to join the graph as a member
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all member_invitations in a region. +```sql +SELECT +region, +graph_arn, +member_id +FROM aws.detective.member_invitations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the member_invitations_list_only resource, see member_invitations + diff --git a/website/docs/services/detective/organization_admins/index.md b/website/docs/services/detective/organization_admins/index.md new file mode 100644 index 0000000..73cf90b --- /dev/null +++ b/website/docs/services/detective/organization_admins/index.md @@ -0,0 +1,197 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an organization_admin resource or lists organization_admins in a region + +## Overview + + + + + + + +
Nameorganization_admins
TypeResource
DescriptionResource schema for AWS::Detective::OrganizationAdmin
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe account ID of the account that should be registered as your Organization's delegated administrator for Detective
stringThe Detective graph ARN
stringAWS region.
+ +For more information, see AWS::Detective::OrganizationAdmin. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all organization_admins in a region. +```sql +SELECT +region, +account_id, +graph_arn +FROM aws.detective.organization_admins +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual organization_admin. +```sql +SELECT +region, +account_id, +graph_arn +FROM aws.detective.organization_admins +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new organization_admin resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.detective.organization_admins ( + AccountId, + region +) +SELECT +'{{ AccountId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.detective.organization_admins ( + AccountId, + region +) +SELECT + '{{ AccountId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: organization_admin + props: + - name: AccountId + value: '{{ AccountId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.detective.organization_admins +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +detective:ListOrganizationAdminAccount, +organizations:DescribeOrganization +``` + +### Delete +```json +detective:DisableOrganizationAdminAccount, +detective:ListOrganizationAdminAccount, +organizations:DescribeOrganization +``` + +### List +```json +detective:ListOrganizationAdminAccount, +organizations:DescribeOrganization +``` diff --git a/website/docs/services/detective/organization_admins_list_only/index.md b/website/docs/services/detective/organization_admins_list_only/index.md new file mode 100644 index 0000000..f309834 --- /dev/null +++ b/website/docs/services/detective/organization_admins_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: organization_admins_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - organization_admins_list_only + - detective + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists organization_admins in a region or regions, for all properties use organization_admins + +## Overview + + + + + + + +
Nameorganization_admins_list_only
TypeResource
DescriptionResource schema for AWS::Detective::OrganizationAdmin
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe account ID of the account that should be registered as your Organization's delegated administrator for Detective
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all organization_admins in a region. +```sql +SELECT +region, +account_id +FROM aws.detective.organization_admins_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organization_admins_list_only resource, see organization_admins + diff --git a/website/docs/services/devopsguru/index.md b/website/docs/services/devopsguru/index.md new file mode 100644 index 0000000..8ada6ca --- /dev/null +++ b/website/docs/services/devopsguru/index.md @@ -0,0 +1,41 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The devopsguru service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/devopsguru/log_anomaly_detection_integrations/index.md b/website/docs/services/devopsguru/log_anomaly_detection_integrations/index.md new file mode 100644 index 0000000..609c117 --- /dev/null +++ b/website/docs/services/devopsguru/log_anomaly_detection_integrations/index.md @@ -0,0 +1,200 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a log_anomaly_detection_integration resource or lists 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.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUser account id, used as the primary identifier for the resource
stringAWS region.
+ +For more information, see AWS::DevOpsGuru::LogAnomalyDetectionIntegration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all log_anomaly_detection_integrations in a region. +```sql +SELECT +region, +account_id +FROM aws.devopsguru.log_anomaly_detection_integrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual log_anomaly_detection_integration. +```sql +SELECT +region, +account_id +FROM aws.devopsguru.log_anomaly_detection_integrations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new log_anomaly_detection_integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.devopsguru.log_anomaly_detection_integrations ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.devopsguru.log_anomaly_detection_integrations ( + , + region +) +SELECT + '{{ }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: log_anomaly_detection_integration + props: [] + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.devopsguru.log_anomaly_detection_integrations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +devops-guru:DescribeServiceIntegration +``` diff --git a/website/docs/services/devopsguru/log_anomaly_detection_integrations_list_only/index.md b/website/docs/services/devopsguru/log_anomaly_detection_integrations_list_only/index.md new file mode 100644 index 0000000..244dff7 --- /dev/null +++ b/website/docs/services/devopsguru/log_anomaly_detection_integrations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: log_anomaly_detection_integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - log_anomaly_detection_integrations_list_only + - devopsguru + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists log_anomaly_detection_integrations in a region or regions, for all properties use log_anomaly_detection_integrations + +## Overview + + + + + + + +
Namelog_anomaly_detection_integrations_list_only
TypeResource
DescriptionThis resource schema represents the LogAnomalyDetectionIntegration resource in the Amazon DevOps Guru.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUser account id, used as the primary identifier for the resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all log_anomaly_detection_integrations in a region. +```sql +SELECT +region, +account_id +FROM aws.devopsguru.log_anomaly_detection_integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the log_anomaly_detection_integrations_list_only resource, see log_anomaly_detection_integrations + diff --git a/website/docs/services/devopsguru/notification_channels/index.md b/website/docs/services/devopsguru/notification_channels/index.md new file mode 100644 index 0000000..e3fc2f8 --- /dev/null +++ b/website/docs/services/devopsguru/notification_channels/index.md @@ -0,0 +1,199 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a notification_channel resource or lists notification_channels in a region + +## Overview + + + + + + + +
Namenotification_channels
TypeResource
DescriptionThis resource schema represents the NotificationChannel resource in the Amazon DevOps Guru.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectInformation about notification channels you have configured with DevOps Guru.
stringThe ID of a notification channel.
stringAWS region.
+ +For more information, see AWS::DevOpsGuru::NotificationChannel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all notification_channels in a region. +```sql +SELECT +region, +config, +id +FROM aws.devopsguru.notification_channels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual notification_channel. +```sql +SELECT +region, +config, +id +FROM aws.devopsguru.notification_channels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new notification_channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.devopsguru.notification_channels ( + Config, + region +) +SELECT +'{{ Config }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.devopsguru.notification_channels ( + Config, + region +) +SELECT + '{{ Config }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: notification_channel + props: + - name: Config + value: + Sns: + TopicArn: '{{ TopicArn }}' + Filters: + Severities: + - '{{ Severities[0] }}' + MessageTypes: + - '{{ MessageTypes[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.devopsguru.notification_channels +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +devops-guru:RemoveNotificationChannel, +devops-guru:ListNotificationChannels +``` + +### Read +```json +devops-guru:ListNotificationChannels +``` diff --git a/website/docs/services/devopsguru/notification_channels_list_only/index.md b/website/docs/services/devopsguru/notification_channels_list_only/index.md new file mode 100644 index 0000000..a773225 --- /dev/null +++ b/website/docs/services/devopsguru/notification_channels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: notification_channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - notification_channels_list_only + - devopsguru + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists notification_channels in a region or regions, for all properties use notification_channels + +## Overview + + + + + + + +
Namenotification_channels_list_only
TypeResource
DescriptionThis resource schema represents the NotificationChannel resource in the Amazon DevOps Guru.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of a notification channel.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all notification_channels in a region. +```sql +SELECT +region, +id +FROM aws.devopsguru.notification_channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the notification_channels_list_only resource, see notification_channels + diff --git a/website/docs/services/devopsguru/resource_collections/index.md b/website/docs/services/devopsguru/resource_collections/index.md new file mode 100644 index 0000000..14d01b2 --- /dev/null +++ b/website/docs/services/devopsguru/resource_collections/index.md @@ -0,0 +1,207 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_collection resource or lists resource_collections in a region + +## Overview + + + + + + + +
Nameresource_collections
TypeResource
DescriptionThis resource schema represents the ResourceCollection resource in the Amazon DevOps Guru.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectInformation about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.
stringThe type of ResourceCollection
stringAWS region.
+ +For more information, see AWS::DevOpsGuru::ResourceCollection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_collections in a region. +```sql +SELECT +region, +resource_collection_filter, +resource_collection_type +FROM aws.devopsguru.resource_collections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_collection. +```sql +SELECT +region, +resource_collection_filter, +resource_collection_type +FROM aws.devopsguru.resource_collections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_collection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.devopsguru.resource_collections ( + ResourceCollectionFilter, + region +) +SELECT +'{{ ResourceCollectionFilter }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.devopsguru.resource_collections ( + ResourceCollectionFilter, + region +) +SELECT + '{{ ResourceCollectionFilter }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_collection + props: + - name: ResourceCollectionFilter + value: + CloudFormation: + StackNames: + - '{{ StackNames[0] }}' + Tags: + - AppBoundaryKey: '{{ AppBoundaryKey }}' + TagValues: + - '{{ TagValues[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.devopsguru.resource_collections +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +devops-guru:GetResourceCollection +``` + +### Delete +```json +devops-guru:UpdateResourceCollection, +devops-guru:GetResourceCollection +``` + +### List +```json +devops-guru:GetResourceCollection +``` + +### Update +```json +devops-guru:UpdateResourceCollection, +devops-guru:GetResourceCollection +``` diff --git a/website/docs/services/devopsguru/resource_collections_list_only/index.md b/website/docs/services/devopsguru/resource_collections_list_only/index.md new file mode 100644 index 0000000..3c16ed7 --- /dev/null +++ b/website/docs/services/devopsguru/resource_collections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_collections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_collections_list_only + - devopsguru + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_collections in a region or regions, for all properties use resource_collections + +## Overview + + + + + + + +
Nameresource_collections_list_only
TypeResource
DescriptionThis resource schema represents the ResourceCollection resource in the Amazon DevOps Guru.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe type of ResourceCollection
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_collections in a region. +```sql +SELECT +region, +resource_collection_type +FROM aws.devopsguru.resource_collections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_collections_list_only resource, see resource_collections + diff --git a/website/docs/services/directoryservice/index.md b/website/docs/services/directoryservice/index.md new file mode 100644 index 0000000..1417124 --- /dev/null +++ b/website/docs/services/directoryservice/index.md @@ -0,0 +1,37 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The directoryservice service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/directoryservice/simple_ads/index.md b/website/docs/services/directoryservice/simple_ads/index.md new file mode 100644 index 0000000..502c4c2 --- /dev/null +++ b/website/docs/services/directoryservice/simple_ads/index.md @@ -0,0 +1,281 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a simple_ad resource or lists simple_ads in a region + +## Overview + + + + + + + +
Namesimple_ads
TypeResource
DescriptionResource Type definition for AWS::DirectoryService::SimpleAD
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for a directory.
stringThe alias for a directory.
arrayThe IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
booleanThe name of the configuration set.
stringDescription for the directory.
booleanWhether to enable single sign-on for a Simple Active Directory in AWS.
stringThe fully qualified domain name for the AWS Managed Simple AD directory.
stringThe password for the default administrative user named Admin.
stringThe NetBIOS name for your domain.
stringThe size of the directory.
objectVPC settings of the Simple AD directory server in AWS.
stringAWS region.
+ +For more information, see AWS::DirectoryService::SimpleAD. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all simple_ads in a region. +```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_ads +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual simple_ad. +```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_ads +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new simple_ad resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.directoryservice.simple_ads ( + Name, + Size, + VpcSettings, + region +) +SELECT +'{{ Name }}', + '{{ Size }}', + '{{ VpcSettings }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.directoryservice.simple_ads ( + CreateAlias, + Description, + EnableSso, + Name, + Password, + ShortName, + Size, + VpcSettings, + region +) +SELECT + '{{ CreateAlias }}', + '{{ Description }}', + '{{ EnableSso }}', + '{{ Name }}', + '{{ Password }}', + '{{ ShortName }}', + '{{ Size }}', + '{{ VpcSettings }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: simple_ad + props: + - name: CreateAlias + value: '{{ CreateAlias }}' + - name: Description + value: '{{ Description }}' + - name: EnableSso + value: '{{ EnableSso }}' + - name: Name + value: '{{ Name }}' + - name: Password + value: '{{ Password }}' + - name: ShortName + value: '{{ ShortName }}' + - name: Size + value: '{{ Size }}' + - name: VpcSettings + value: + SubnetIds: + - '{{ SubnetIds[0] }}' + VpcId: '{{ VpcId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.directoryservice.simple_ads +WHERE data__Identifier = '' +AND 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, +ec2:RevokeSecurityGroupIngress, +ec2:RevokeSecurityGroupEgress +``` + +### 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 +``` + +### List +```json +ds:DescribeDirectories +``` diff --git a/website/docs/services/directoryservice/simple_ads_list_only/index.md b/website/docs/services/directoryservice/simple_ads_list_only/index.md new file mode 100644 index 0000000..ae45903 --- /dev/null +++ b/website/docs/services/directoryservice/simple_ads_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: simple_ads_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - simple_ads_list_only + - directoryservice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists simple_ads in a region or regions, for all properties use simple_ads + +## Overview + + + + + + + +
Namesimple_ads_list_only
TypeResource
DescriptionResource Type definition for AWS::DirectoryService::SimpleAD
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier for a directory.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all simple_ads in a region. +```sql +SELECT +region, +directory_id +FROM aws.directoryservice.simple_ads_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the simple_ads_list_only resource, see simple_ads + diff --git a/website/docs/services/dms/data_migration_tags/index.md b/website/docs/services/dms/data_migration_tags/index.md new file mode 100644 index 0000000..8595197 --- /dev/null +++ b/website/docs/services/dms/data_migration_tags/index.md @@ -0,0 +1,93 @@ +--- +title: data_migration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_migration_tags + - dms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_migrations in a region + +## Overview + + + + + + + +
Namedata_migration_tags
TypeResource
DescriptionResource schema for AWS::DMS::DataMigration.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes a name to identify the data migration.
stringThe property describes an ARN of the data migration.
stringThe property describes an ARN of the data migration.
stringThe property describes the create time of the data migration.
stringThe property describes Amazon Resource Name (ARN) of the service access role.
stringThe property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
stringThe property describes the type of migration.
objectThe property describes the settings for the data migration.
arrayThe property describes the settings for the data migration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_migrations in a region. +```sql +SELECT +region, +data_migration_name, +data_migration_arn, +data_migration_identifier, +data_migration_create_time, +service_access_role_arn, +migration_project_identifier, +data_migration_type, +data_migration_settings, +source_data_settings, +tag_key, +tag_value +FROM aws.dms.data_migration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_migration_tags resource, see data_migrations + diff --git a/website/docs/services/dms/data_migrations/index.md b/website/docs/services/dms/data_migrations/index.md new file mode 100644 index 0000000..2d485b0 --- /dev/null +++ b/website/docs/services/dms/data_migrations/index.md @@ -0,0 +1,273 @@ +--- +title: data_migrations +hide_title: false +hide_table_of_contents: false +keywords: + - data_migrations + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_migration resource or lists data_migrations in a region + +## Overview + + + + + + + +
Namedata_migrations
TypeResource
DescriptionResource schema for AWS::DMS::DataMigration.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes a name to identify the data migration.
stringThe property describes an ARN of the data migration.
stringThe property describes an ARN of the data migration.
stringThe property describes the create time of the data migration.
stringThe property describes Amazon Resource Name (ARN) of the service access role.
stringThe property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
stringThe property describes the type of migration.
objectThe property describes the settings for the data migration.
arrayThe property describes the settings for the data migration.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::DMS::DataMigration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_migrations in a region. +```sql +SELECT +region, +data_migration_name, +data_migration_arn, +data_migration_identifier, +data_migration_create_time, +service_access_role_arn, +migration_project_identifier, +data_migration_type, +data_migration_settings, +source_data_settings, +tags +FROM aws.dms.data_migrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_migration. +```sql +SELECT +region, +data_migration_name, +data_migration_arn, +data_migration_identifier, +data_migration_create_time, +service_access_role_arn, +migration_project_identifier, +data_migration_type, +data_migration_settings, +source_data_settings, +tags +FROM aws.dms.data_migrations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_migration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.dms.data_migrations ( + ServiceAccessRoleArn, + MigrationProjectIdentifier, + DataMigrationType, + region +) +SELECT +'{{ ServiceAccessRoleArn }}', + '{{ MigrationProjectIdentifier }}', + '{{ DataMigrationType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.dms.data_migrations ( + DataMigrationName, + DataMigrationIdentifier, + ServiceAccessRoleArn, + MigrationProjectIdentifier, + DataMigrationType, + DataMigrationSettings, + SourceDataSettings, + Tags, + region +) +SELECT + '{{ DataMigrationName }}', + '{{ DataMigrationIdentifier }}', + '{{ ServiceAccessRoleArn }}', + '{{ MigrationProjectIdentifier }}', + '{{ DataMigrationType }}', + '{{ DataMigrationSettings }}', + '{{ SourceDataSettings }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_migration + props: + - name: DataMigrationName + value: '{{ DataMigrationName }}' + - name: DataMigrationIdentifier + value: '{{ DataMigrationIdentifier }}' + - name: ServiceAccessRoleArn + value: '{{ ServiceAccessRoleArn }}' + - name: MigrationProjectIdentifier + value: '{{ MigrationProjectIdentifier }}' + - name: DataMigrationType + value: '{{ DataMigrationType }}' + - name: DataMigrationSettings + value: + CloudwatchLogsEnabled: '{{ CloudwatchLogsEnabled }}' + NumberOfJobs: '{{ NumberOfJobs }}' + SelectionRules: '{{ SelectionRules }}' + - name: SourceDataSettings + value: + - CDCStartPosition: '{{ CDCStartPosition }}' + CDCStartTime: '{{ CDCStartTime }}' + CDCStopTime: '{{ CDCStopTime }}' + SlotName: '{{ SlotName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.dms.data_migrations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the data_migrations resource, the following permissions are required: + +### Create +```json +dms:CreateDataMigration, +dms:DescribeDataMigrations, +dms:AddTagsToResource, +dms:ListTagsForResource, +iam:PassRole +``` + +### Read +```json +dms:DescribeDataMigrations, +dms:ListTagsForResource +``` + +### Update +```json +dms:ModifyDataMigration, +dms:AddTagsToResource, +dms:RemoveTagsFromResource, +dms:ListTagsForResource, +iam:PassRole +``` + +### Delete +```json +dms:DeleteDataMigration, +dms:RemoveTagsFromResource +``` + +### List +```json +dms:DescribeDataMigrations, +dms:ListTagsForResource +``` diff --git a/website/docs/services/dms/data_migrations_list_only/index.md b/website/docs/services/dms/data_migrations_list_only/index.md new file mode 100644 index 0000000..7f25aef --- /dev/null +++ b/website/docs/services/dms/data_migrations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: data_migrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_migrations_list_only + - dms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_migrations in a region or regions, for all properties use data_migrations + +## Overview + + + + + + + +
Namedata_migrations_list_only
TypeResource
DescriptionResource schema for AWS::DMS::DataMigration.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe property describes an ARN of the data migration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_migrations in a region. +```sql +SELECT +region, +data_migration_arn +FROM aws.dms.data_migrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_migrations_list_only resource, see data_migrations + diff --git a/website/docs/services/dms/data_provider_tags/index.md b/website/docs/services/dms/data_provider_tags/index.md new file mode 100644 index 0000000..4f46484 --- /dev/null +++ b/website/docs/services/dms/data_provider_tags/index.md @@ -0,0 +1,91 @@ +--- +title: data_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_provider_tags + - dms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_providers in a region + +## Overview + + + + + + + +
Namedata_provider_tags
TypeResource
DescriptionResource schema for AWS::DMS::DataProvider
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes a name to identify the data provider.
stringThe property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn
stringThe data provider ARN.
stringThe data provider creation time.
stringThe optional description of the data provider.
stringThe property describes a data engine for the data provider.
booleanThe property describes the exact settings which can be modified
objectThe property identifies the exact type of settings for the data provider.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_providers in a region. +```sql +SELECT +region, +data_provider_name, +data_provider_identifier, +data_provider_arn, +data_provider_creation_time, +description, +engine, +exact_settings, +settings, +tag_key, +tag_value +FROM aws.dms.data_provider_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_provider_tags resource, see data_providers + diff --git a/website/docs/services/dms/data_providers/index.md b/website/docs/services/dms/data_providers/index.md new file mode 100644 index 0000000..61a6bd4 --- /dev/null +++ b/website/docs/services/dms/data_providers/index.md @@ -0,0 +1,310 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_provider resource or lists data_providers in a region + +## Overview + + + + + + + +
Namedata_providers
TypeResource
DescriptionResource schema for AWS::DMS::DataProvider
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes a name to identify the data provider.
stringThe property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn
stringThe data provider ARN.
stringThe data provider creation time.
stringThe optional description of the data provider.
stringThe property describes a data engine for the data provider.
booleanThe property describes the exact settings which can be modified
objectThe property identifies the exact type of settings for the data provider.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::DMS::DataProvider. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_providers in a region. +```sql +SELECT +region, +data_provider_name, +data_provider_identifier, +data_provider_arn, +data_provider_creation_time, +description, +engine, +exact_settings, +settings, +tags +FROM aws.dms.data_providers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_provider. +```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_providers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.dms.data_providers ( + Engine, + region +) +SELECT +'{{ Engine }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.dms.data_providers ( + DataProviderName, + DataProviderIdentifier, + Description, + Engine, + ExactSettings, + Settings, + Tags, + region +) +SELECT + '{{ DataProviderName }}', + '{{ DataProviderIdentifier }}', + '{{ Description }}', + '{{ Engine }}', + '{{ ExactSettings }}', + '{{ Settings }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_provider + props: + - name: DataProviderName + value: '{{ DataProviderName }}' + - name: DataProviderIdentifier + value: '{{ DataProviderIdentifier }}' + - name: Description + value: '{{ Description }}' + - name: Engine + value: '{{ Engine }}' + - name: ExactSettings + value: '{{ ExactSettings }}' + - name: Settings + value: + PostgreSqlSettings: + ServerName: '{{ ServerName }}' + Port: '{{ Port }}' + DatabaseName: '{{ DatabaseName }}' + SslMode: '{{ SslMode }}' + CertificateArn: '{{ CertificateArn }}' + MySqlSettings: + ServerName: '{{ ServerName }}' + Port: '{{ Port }}' + SslMode: null + CertificateArn: '{{ CertificateArn }}' + OracleSettings: + ServerName: '{{ ServerName }}' + Port: '{{ Port }}' + DatabaseName: '{{ DatabaseName }}' + SslMode: null + CertificateArn: '{{ CertificateArn }}' + AsmServer: '{{ AsmServer }}' + SecretsManagerOracleAsmSecretId: '{{ SecretsManagerOracleAsmSecretId }}' + SecretsManagerOracleAsmAccessRoleArn: '{{ SecretsManagerOracleAsmAccessRoleArn }}' + SecretsManagerSecurityDbEncryptionSecretId: '{{ SecretsManagerSecurityDbEncryptionSecretId }}' + SecretsManagerSecurityDbEncryptionAccessRoleArn: '{{ SecretsManagerSecurityDbEncryptionAccessRoleArn }}' + MicrosoftSqlServerSettings: + ServerName: '{{ ServerName }}' + Port: '{{ Port }}' + DatabaseName: '{{ DatabaseName }}' + SslMode: null + CertificateArn: '{{ CertificateArn }}' + RedshiftSettings: + ServerName: '{{ ServerName }}' + Port: '{{ Port }}' + DatabaseName: '{{ DatabaseName }}' + MariaDbSettings: + ServerName: '{{ ServerName }}' + Port: '{{ Port }}' + SslMode: null + CertificateArn: '{{ CertificateArn }}' + DocDbSettings: + ServerName: '{{ ServerName }}' + Port: '{{ Port }}' + DatabaseName: '{{ DatabaseName }}' + SslMode: '{{ SslMode }}' + CertificateArn: '{{ CertificateArn }}' + MongoDbSettings: + ServerName: '{{ ServerName }}' + Port: '{{ Port }}' + DatabaseName: '{{ DatabaseName }}' + SslMode: null + CertificateArn: '{{ CertificateArn }}' + AuthType: '{{ AuthType }}' + AuthSource: '{{ AuthSource }}' + AuthMechanism: '{{ AuthMechanism }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.dms.data_providers +WHERE data__Identifier = '' +AND 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, +iam:GetRole, +iam:PassRole +``` + +### Read +```json +dms:ListDataProviders, +dms:DescribeDataProviders, +dms:ListTagsForResource +``` + +### Update +```json +dms:UpdateDataProvider, +dms:ModifyDataProvider, +dms:AddTagsToResource, +dms:RemoveTagsFromResource, +dms:ListTagsForResource +``` + +### Delete +```json +dms:DeleteDataProvider +``` + +### List +```json +dms:ListDataProviders, +dms:DescribeDataProviders, +dms:ListTagsForResource +``` diff --git a/website/docs/services/dms/data_providers_list_only/index.md b/website/docs/services/dms/data_providers_list_only/index.md new file mode 100644 index 0000000..1e8a4c9 --- /dev/null +++ b/website/docs/services/dms/data_providers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: data_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_providers_list_only + - dms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_providers in a region or regions, for all properties use data_providers + +## Overview + + + + + + + +
Namedata_providers_list_only
TypeResource
DescriptionResource schema for AWS::DMS::DataProvider
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe data provider ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_providers in a region. +```sql +SELECT +region, +data_provider_arn +FROM aws.dms.data_providers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_providers_list_only resource, see data_providers + diff --git a/website/docs/services/dms/index.md b/website/docs/services/dms/index.md new file mode 100644 index 0000000..53a390a --- /dev/null +++ b/website/docs/services/dms/index.md @@ -0,0 +1,50 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The dms service documentation. + +:::info Service Summary + +
+
+total resources: 15
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/dms/instance_profile_tags/index.md b/website/docs/services/dms/instance_profile_tags/index.md new file mode 100644 index 0000000..888fa6d --- /dev/null +++ b/website/docs/services/dms/instance_profile_tags/index.md @@ -0,0 +1,97 @@ +--- +title: instance_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profile_tags + - dms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instance_profiles in a region + +## Overview + + + + + + + +
Nameinstance_profile_tags
TypeResource
DescriptionResource schema for AWS::DMS::InstanceProfile.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes an ARN of the instance profile.
stringThe property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn
stringThe property describes an availability zone of the instance profile.
stringThe optional description of the instance profile.
stringThe property describes kms key arn for the instance profile.
booleanThe property describes the publicly accessible of the instance profile
stringThe property describes a network type for the instance profile.
stringThe property describes a name for the instance profile.
stringThe property describes a creating time of the instance profile.
stringThe property describes a subnet group identifier for the instance profile.
arrayThe property describes vps security groups for the instance profile.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instance_profiles in a region. +```sql +SELECT +region, +instance_profile_arn, +instance_profile_identifier, +availability_zone, +description, +kms_key_arn, +publicly_accessible, +network_type, +instance_profile_name, +instance_profile_creation_time, +subnet_group_identifier, +vpc_security_groups, +tag_key, +tag_value +FROM aws.dms.instance_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_profile_tags resource, see instance_profiles + diff --git a/website/docs/services/dms/instance_profiles/index.md b/website/docs/services/dms/instance_profiles/index.md new file mode 100644 index 0000000..967f89d --- /dev/null +++ b/website/docs/services/dms/instance_profiles/index.md @@ -0,0 +1,296 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an instance_profile resource or lists instance_profiles in a region + +## Overview + + + + + + + +
Nameinstance_profiles
TypeResource
DescriptionResource schema for AWS::DMS::InstanceProfile.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes an ARN of the instance profile.
stringThe property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn
stringThe property describes an availability zone of the instance profile.
stringThe optional description of the instance profile.
stringThe property describes kms key arn for the instance profile.
booleanThe property describes the publicly accessible of the instance profile
stringThe property describes a network type for the instance profile.
stringThe property describes a name for the instance profile.
stringThe property describes a creating time of the instance profile.
stringThe property describes a subnet group identifier for the instance profile.
arrayThe property describes vps security groups for the instance profile.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::DMS::InstanceProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all instance_profiles in a region. +```sql +SELECT +region, +instance_profile_arn, +instance_profile_identifier, +availability_zone, +description, +kms_key_arn, +publicly_accessible, +network_type, +instance_profile_name, +instance_profile_creation_time, +subnet_group_identifier, +vpc_security_groups, +tags +FROM aws.dms.instance_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual instance_profile. +```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_profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.dms.instance_profiles ( + InstanceProfileIdentifier, + AvailabilityZone, + Description, + KmsKeyArn, + PubliclyAccessible, + NetworkType, + InstanceProfileName, + SubnetGroupIdentifier, + VpcSecurityGroups, + Tags, + region +) +SELECT +'{{ InstanceProfileIdentifier }}', + '{{ AvailabilityZone }}', + '{{ Description }}', + '{{ KmsKeyArn }}', + '{{ PubliclyAccessible }}', + '{{ NetworkType }}', + '{{ InstanceProfileName }}', + '{{ SubnetGroupIdentifier }}', + '{{ VpcSecurityGroups }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.dms.instance_profiles ( + InstanceProfileIdentifier, + AvailabilityZone, + Description, + KmsKeyArn, + PubliclyAccessible, + NetworkType, + InstanceProfileName, + SubnetGroupIdentifier, + VpcSecurityGroups, + Tags, + region +) +SELECT + '{{ InstanceProfileIdentifier }}', + '{{ AvailabilityZone }}', + '{{ Description }}', + '{{ KmsKeyArn }}', + '{{ PubliclyAccessible }}', + '{{ NetworkType }}', + '{{ InstanceProfileName }}', + '{{ SubnetGroupIdentifier }}', + '{{ VpcSecurityGroups }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: instance_profile + props: + - name: InstanceProfileIdentifier + value: '{{ InstanceProfileIdentifier }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: Description + value: '{{ Description }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: PubliclyAccessible + value: '{{ PubliclyAccessible }}' + - name: NetworkType + value: '{{ NetworkType }}' + - name: InstanceProfileName + value: '{{ InstanceProfileName }}' + - name: SubnetGroupIdentifier + value: '{{ SubnetGroupIdentifier }}' + - name: VpcSecurityGroups + value: + - '{{ VpcSecurityGroups[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.dms.instance_profiles +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +dms:ListInstanceProfiles, +dms:DescribeInstanceProfiles, +dms:ListTagsForResource +``` + +### Update +```json +dms:UpdateInstanceProfile, +dms:ModifyInstanceProfile, +dms:AddTagsToResource, +dms:RemoveTagsFromResource, +dms:ListTagsForResource +``` + +### Delete +```json +dms:DeleteInstanceProfile +``` + +### List +```json +dms:ListInstanceProfiles, +dms:DescribeInstanceProfiles, +dms:ListTagsForResource +``` diff --git a/website/docs/services/dms/instance_profiles_list_only/index.md b/website/docs/services/dms/instance_profiles_list_only/index.md new file mode 100644 index 0000000..72dadbd --- /dev/null +++ b/website/docs/services/dms/instance_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: instance_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profiles_list_only + - dms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instance_profiles in a region or regions, for all properties use instance_profiles + +## Overview + + + + + + + +
Nameinstance_profiles_list_only
TypeResource
DescriptionResource schema for AWS::DMS::InstanceProfile.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe property describes an ARN of the instance profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instance_profiles in a region. +```sql +SELECT +region, +instance_profile_arn +FROM aws.dms.instance_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_profiles_list_only resource, see instance_profiles + diff --git a/website/docs/services/dms/migration_project_tags/index.md b/website/docs/services/dms/migration_project_tags/index.md new file mode 100644 index 0000000..8dc108a --- /dev/null +++ b/website/docs/services/dms/migration_project_tags/index.md @@ -0,0 +1,99 @@ +--- +title: migration_project_tags +hide_title: false +hide_table_of_contents: false +keywords: + - migration_project_tags + - dms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for migration_projects in a region + +## Overview + + + + + + + +
Namemigration_project_tags
TypeResource
DescriptionResource schema for AWS::DMS::MigrationProject
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes a name to identify the migration project.
stringThe property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
stringThe property describes an ARN of the migration project.
stringThe property describes a creating time of the migration project.
stringThe property describes an instance profile identifier for the migration project. For create
stringThe property describes an instance profile name for the migration project. For read
stringThe property describes an instance profile arn for the migration project. For read
stringThe property describes transformation rules for the migration project.
stringThe optional description of the migration project.
objectThe property describes schema conversion application attributes for the migration project.
arrayThe property describes source data provider descriptors for the migration project.
arrayThe property describes target data provider descriptors for the migration project.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all migration_projects in a region. +```sql +SELECT +region, +migration_project_name, +migration_project_identifier, +migration_project_arn, +migration_project_creation_time, +instance_profile_identifier, +instance_profile_name, +instance_profile_arn, +transformation_rules, +description, +schema_conversion_application_attributes, +source_data_provider_descriptors, +target_data_provider_descriptors, +tag_key, +tag_value +FROM aws.dms.migration_project_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the migration_project_tags resource, see migration_projects + diff --git a/website/docs/services/dms/migration_projects/index.md b/website/docs/services/dms/migration_projects/index.md new file mode 100644 index 0000000..4f6edad --- /dev/null +++ b/website/docs/services/dms/migration_projects/index.md @@ -0,0 +1,320 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a migration_project resource or lists migration_projects in a region + +## Overview + + + + + + + +
Namemigration_projects
TypeResource
DescriptionResource schema for AWS::DMS::MigrationProject
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes a name to identify the migration project.
stringThe property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
stringThe property describes an ARN of the migration project.
stringThe property describes a creating time of the migration project.
stringThe property describes an instance profile identifier for the migration project. For create
stringThe property describes an instance profile name for the migration project. For read
stringThe property describes an instance profile arn for the migration project. For read
stringThe property describes transformation rules for the migration project.
stringThe optional description of the migration project.
objectThe property describes schema conversion application attributes for the migration project.
arrayThe property describes source data provider descriptors for the migration project.
arrayThe property describes target data provider descriptors for the migration project.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::DMS::MigrationProject. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all migration_projects in a region. +```sql +SELECT +region, +migration_project_name, +migration_project_identifier, +migration_project_arn, +migration_project_creation_time, +instance_profile_identifier, +instance_profile_name, +instance_profile_arn, +transformation_rules, +description, +schema_conversion_application_attributes, +source_data_provider_descriptors, +target_data_provider_descriptors, +tags +FROM aws.dms.migration_projects +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual migration_project. +```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_projects +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new migration_project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.dms.migration_projects ( + MigrationProjectName, + MigrationProjectIdentifier, + MigrationProjectCreationTime, + InstanceProfileIdentifier, + InstanceProfileName, + InstanceProfileArn, + TransformationRules, + Description, + SchemaConversionApplicationAttributes, + SourceDataProviderDescriptors, + TargetDataProviderDescriptors, + Tags, + region +) +SELECT +'{{ MigrationProjectName }}', + '{{ MigrationProjectIdentifier }}', + '{{ MigrationProjectCreationTime }}', + '{{ InstanceProfileIdentifier }}', + '{{ InstanceProfileName }}', + '{{ InstanceProfileArn }}', + '{{ TransformationRules }}', + '{{ Description }}', + '{{ SchemaConversionApplicationAttributes }}', + '{{ SourceDataProviderDescriptors }}', + '{{ TargetDataProviderDescriptors }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.dms.migration_projects ( + MigrationProjectName, + MigrationProjectIdentifier, + MigrationProjectCreationTime, + InstanceProfileIdentifier, + InstanceProfileName, + InstanceProfileArn, + TransformationRules, + Description, + SchemaConversionApplicationAttributes, + SourceDataProviderDescriptors, + TargetDataProviderDescriptors, + Tags, + region +) +SELECT + '{{ MigrationProjectName }}', + '{{ MigrationProjectIdentifier }}', + '{{ MigrationProjectCreationTime }}', + '{{ InstanceProfileIdentifier }}', + '{{ InstanceProfileName }}', + '{{ InstanceProfileArn }}', + '{{ TransformationRules }}', + '{{ Description }}', + '{{ SchemaConversionApplicationAttributes }}', + '{{ SourceDataProviderDescriptors }}', + '{{ TargetDataProviderDescriptors }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: migration_project + props: + - name: MigrationProjectName + value: '{{ MigrationProjectName }}' + - name: MigrationProjectIdentifier + value: '{{ MigrationProjectIdentifier }}' + - name: MigrationProjectCreationTime + value: '{{ MigrationProjectCreationTime }}' + - name: InstanceProfileIdentifier + value: '{{ InstanceProfileIdentifier }}' + - name: InstanceProfileName + value: '{{ InstanceProfileName }}' + - name: InstanceProfileArn + value: '{{ InstanceProfileArn }}' + - name: TransformationRules + value: '{{ TransformationRules }}' + - name: Description + value: '{{ Description }}' + - name: SchemaConversionApplicationAttributes + value: + S3BucketPath: '{{ S3BucketPath }}' + S3BucketRoleArn: '{{ S3BucketRoleArn }}' + - name: SourceDataProviderDescriptors + value: + - DataProviderIdentifier: '{{ DataProviderIdentifier }}' + DataProviderName: '{{ DataProviderName }}' + DataProviderArn: '{{ DataProviderArn }}' + SecretsManagerSecretId: '{{ SecretsManagerSecretId }}' + SecretsManagerAccessRoleArn: '{{ SecretsManagerAccessRoleArn }}' + - name: TargetDataProviderDescriptors + value: + - null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.dms.migration_projects +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +dms:DescribeMigrationProjects, +dms:ListMigrationProjects, +dms:ListTagsForResource +``` + +### Update +```json +dms:UpdateMigrationProject, +dms:ModifyMigrationProject, +dms:AddTagsToResource, +dms:RemoveTagsFromResource, +dms:ListTagsForResource, +iam:PassRole +``` + +### Delete +```json +dms:DeleteMigrationProject +``` + +### List +```json +dms:ListMigrationProjects, +dms:DescribeMigrationProjects, +dms:ListTagsForResource +``` diff --git a/website/docs/services/dms/migration_projects_list_only/index.md b/website/docs/services/dms/migration_projects_list_only/index.md new file mode 100644 index 0000000..6939d4b --- /dev/null +++ b/website/docs/services/dms/migration_projects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: migration_projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - migration_projects_list_only + - dms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists migration_projects in a region or regions, for all properties use migration_projects + +## Overview + + + + + + + +
Namemigration_projects_list_only
TypeResource
DescriptionResource schema for AWS::DMS::MigrationProject
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe property describes an ARN of the migration project.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all migration_projects in a region. +```sql +SELECT +region, +migration_project_arn +FROM aws.dms.migration_projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the migration_projects_list_only resource, see migration_projects + diff --git a/website/docs/services/dms/replication_config_tags/index.md b/website/docs/services/dms/replication_config_tags/index.md new file mode 100644 index 0000000..4f1264e --- /dev/null +++ b/website/docs/services/dms/replication_config_tags/index.md @@ -0,0 +1,95 @@ +--- +title: replication_config_tags +hide_title: false +hide_table_of_contents: false +keywords: + - replication_config_tags + - dms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for replication_configs in a region + +## Overview + + + + + + + +
Namereplication_config_tags
TypeResource
DescriptionA replication configuration that you later provide to configure and start a AWS DMS Serverless replication
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier of replication configuration
stringThe Amazon Resource Name (ARN) of the Replication Config
stringThe Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration
stringThe Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration
stringThe type of AWS DMS Serverless replication to provision using this replication configuration
objectConfiguration parameters for provisioning a AWS DMS Serverless replication
objectJSON settings for Servereless replications that are provisioned using this replication configuration
objectJSON settings for specifying supplemental data
stringA unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource
objectJSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all replication_configs in a region. +```sql +SELECT +region, +replication_config_identifier, +replication_config_arn, +source_endpoint_arn, +target_endpoint_arn, +replication_type, +compute_config, +replication_settings, +supplemental_settings, +resource_identifier, +table_mappings, +tag_key, +tag_value +FROM aws.dms.replication_config_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replication_config_tags resource, see replication_configs + diff --git a/website/docs/services/dms/replication_configs/index.md b/website/docs/services/dms/replication_configs/index.md new file mode 100644 index 0000000..7ca7546 --- /dev/null +++ b/website/docs/services/dms/replication_configs/index.md @@ -0,0 +1,301 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a replication_config resource or lists 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
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier of replication configuration
stringThe Amazon Resource Name (ARN) of the Replication Config
stringThe Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration
stringThe Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration
stringThe type of AWS DMS Serverless replication to provision using this replication configuration
objectConfiguration parameters for provisioning a AWS DMS Serverless replication
objectJSON settings for Servereless replications that are provisioned using this replication configuration
objectJSON settings for specifying supplemental data
stringA unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource
objectJSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration
array

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

stringAWS region.
+ +For more information, see AWS::DMS::ReplicationConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all replication_configs in a region. +```sql +SELECT +region, +replication_config_identifier, +replication_config_arn, +source_endpoint_arn, +target_endpoint_arn, +replication_type, +compute_config, +replication_settings, +supplemental_settings, +resource_identifier, +table_mappings, +tags +FROM aws.dms.replication_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual replication_config. +```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_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new replication_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.dms.replication_configs ( + ReplicationConfigIdentifier, + SourceEndpointArn, + TargetEndpointArn, + ReplicationType, + ComputeConfig, + TableMappings, + region +) +SELECT +'{{ ReplicationConfigIdentifier }}', + '{{ SourceEndpointArn }}', + '{{ TargetEndpointArn }}', + '{{ ReplicationType }}', + '{{ ComputeConfig }}', + '{{ TableMappings }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.dms.replication_configs ( + ReplicationConfigIdentifier, + SourceEndpointArn, + TargetEndpointArn, + ReplicationType, + ComputeConfig, + ReplicationSettings, + SupplementalSettings, + ResourceIdentifier, + TableMappings, + Tags, + region +) +SELECT + '{{ ReplicationConfigIdentifier }}', + '{{ SourceEndpointArn }}', + '{{ TargetEndpointArn }}', + '{{ ReplicationType }}', + '{{ ComputeConfig }}', + '{{ ReplicationSettings }}', + '{{ SupplementalSettings }}', + '{{ ResourceIdentifier }}', + '{{ TableMappings }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: replication_config + props: + - name: ReplicationConfigIdentifier + value: '{{ ReplicationConfigIdentifier }}' + - name: SourceEndpointArn + value: '{{ SourceEndpointArn }}' + - name: TargetEndpointArn + value: '{{ TargetEndpointArn }}' + - name: ReplicationType + value: '{{ ReplicationType }}' + - name: ComputeConfig + value: + AvailabilityZone: '{{ AvailabilityZone }}' + DnsNameServers: '{{ DnsNameServers }}' + KmsKeyId: '{{ KmsKeyId }}' + MaxCapacityUnits: '{{ MaxCapacityUnits }}' + MinCapacityUnits: '{{ MinCapacityUnits }}' + MultiAZ: '{{ MultiAZ }}' + PreferredMaintenanceWindow: '{{ PreferredMaintenanceWindow }}' + ReplicationSubnetGroupId: '{{ ReplicationSubnetGroupId }}' + VpcSecurityGroupIds: + - '{{ VpcSecurityGroupIds[0] }}' + - name: ReplicationSettings + value: {} + - name: SupplementalSettings + value: {} + - name: ResourceIdentifier + value: '{{ ResourceIdentifier }}' + - name: TableMappings + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.dms.replication_configs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +dms:DescribeReplicationConfigs, +dms:ListTagsForResource +``` + +### Update +```json +dms:ModifyReplicationConfig, +dms:AddTagsToResource, +dms:RemoveTagsFromResource, +dms:ListTagsForResource, +iam:CreateServiceLinkedRole, +iam:AttachRolePolicy, +iam:PutRolePolicy, +iam:UpdateRoleDescription +``` + +### List +```json +dms:DescribeReplicationConfigs, +dms:ListTagsForResource +``` + +### Delete +```json +dms:DescribeReplicationConfigs, +dms:DeleteReplicationConfig, +dms:ListTagsForResource, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` diff --git a/website/docs/services/dms/replication_configs_list_only/index.md b/website/docs/services/dms/replication_configs_list_only/index.md new file mode 100644 index 0000000..e3b40a3 --- /dev/null +++ b/website/docs/services/dms/replication_configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: replication_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - replication_configs_list_only + - dms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists replication_configs in a region or regions, for all properties use replication_configs + +## Overview + + + + + + + +
Namereplication_configs_list_only
TypeResource
DescriptionA replication configuration that you later provide to configure and start a AWS DMS Serverless replication
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Replication Config
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all replication_configs in a region. +```sql +SELECT +region, +replication_config_arn +FROM aws.dms.replication_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replication_configs_list_only resource, see replication_configs + diff --git a/website/docs/services/docdbelastic/cluster_tags/index.md b/website/docs/services/docdbelastic/cluster_tags/index.md new file mode 100644 index 0000000..e01f1be --- /dev/null +++ b/website/docs/services/docdbelastic/cluster_tags/index.md @@ -0,0 +1,105 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - docdbelastic + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + + + +
Namecluster_tags
TypeResource
DescriptionThe AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
integer
array
array
string
string
integer
integer
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +cluster_name, +cluster_arn, +cluster_endpoint, +admin_user_name, +admin_user_password, +shard_capacity, +shard_count, +vpc_security_group_ids, +subnet_ids, +preferred_maintenance_window, +preferred_backup_window, +backup_retention_period, +shard_instance_count, +kms_key_id, +auth_type, +tag_key, +tag_value +FROM aws.docdbelastic.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + diff --git a/website/docs/services/docdbelastic/clusters/index.md b/website/docs/services/docdbelastic/clusters/index.md new file mode 100644 index 0000000..f1a60e6 --- /dev/null +++ b/website/docs/services/docdbelastic/clusters/index.md @@ -0,0 +1,357 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster resource or lists clusters in a region + +## Overview + + + + + + + +
Nameclusters
TypeResource
DescriptionThe AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
integer
array
array
string
string
integer
integer
string
array
string
stringAWS region.
+ +For more information, see AWS::DocDBElastic::Cluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all clusters in a region. +```sql +SELECT +region, +cluster_name, +cluster_arn, +cluster_endpoint, +admin_user_name, +admin_user_password, +shard_capacity, +shard_count, +vpc_security_group_ids, +subnet_ids, +preferred_maintenance_window, +preferred_backup_window, +backup_retention_period, +shard_instance_count, +kms_key_id, +tags, +auth_type +FROM aws.docdbelastic.clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster. +```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.clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.docdbelastic.clusters ( + ClusterName, + AdminUserName, + ShardCapacity, + ShardCount, + AuthType, + region +) +SELECT +'{{ ClusterName }}', + '{{ AdminUserName }}', + '{{ ShardCapacity }}', + '{{ ShardCount }}', + '{{ AuthType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.docdbelastic.clusters ( + ClusterName, + AdminUserName, + AdminUserPassword, + ShardCapacity, + ShardCount, + VpcSecurityGroupIds, + SubnetIds, + PreferredMaintenanceWindow, + PreferredBackupWindow, + BackupRetentionPeriod, + ShardInstanceCount, + KmsKeyId, + Tags, + AuthType, + region +) +SELECT + '{{ ClusterName }}', + '{{ AdminUserName }}', + '{{ AdminUserPassword }}', + '{{ ShardCapacity }}', + '{{ ShardCount }}', + '{{ VpcSecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ PreferredMaintenanceWindow }}', + '{{ PreferredBackupWindow }}', + '{{ BackupRetentionPeriod }}', + '{{ ShardInstanceCount }}', + '{{ KmsKeyId }}', + '{{ Tags }}', + '{{ AuthType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster + props: + - name: ClusterName + value: '{{ ClusterName }}' + - name: AdminUserName + value: '{{ AdminUserName }}' + - name: AdminUserPassword + value: '{{ AdminUserPassword }}' + - name: ShardCapacity + value: '{{ ShardCapacity }}' + - name: ShardCount + value: '{{ ShardCount }}' + - name: VpcSecurityGroupIds + value: + - '{{ VpcSecurityGroupIds[0] }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: PreferredMaintenanceWindow + value: '{{ PreferredMaintenanceWindow }}' + - name: PreferredBackupWindow + value: '{{ PreferredBackupWindow }}' + - name: BackupRetentionPeriod + value: '{{ BackupRetentionPeriod }}' + - name: ShardInstanceCount + value: '{{ ShardInstanceCount }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AuthType + value: '{{ AuthType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.docdbelastic.clusters +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +docdb-elastic:ListClusters +``` diff --git a/website/docs/services/docdbelastic/clusters_list_only/index.md b/website/docs/services/docdbelastic/clusters_list_only/index.md new file mode 100644 index 0000000..6aa9491 --- /dev/null +++ b/website/docs/services/docdbelastic/clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - docdbelastic + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + + + +
Nameclusters_list_only
TypeResource
DescriptionThe AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +cluster_arn +FROM aws.docdbelastic.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + diff --git a/website/docs/services/docdbelastic/index.md b/website/docs/services/docdbelastic/index.md new file mode 100644 index 0000000..d5b03ad --- /dev/null +++ b/website/docs/services/docdbelastic/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The docdbelastic service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/dynamodb/global_tables/index.md b/website/docs/services/dynamodb/global_tables/index.md new file mode 100644 index 0000000..5fb4183 --- /dev/null +++ b/website/docs/services/dynamodb/global_tables/index.md @@ -0,0 +1,461 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a global_table resource or lists global_tables in a region + +## Overview + + + + + + + +
Nameglobal_tables
TypeResource
DescriptionVersion: None. Resource Type definition for AWS::DynamoDB::GlobalTable
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
array
array
array
objectThe settings used to enable point in time recovery.
object
object
objectProvides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the UpdateTable operation to meet the throughput requirements of an upcoming peak event.
array
objectRepresents the settings used to enable server-side encryption.
objectRepresents the DynamoDB Streams configuration for a table in DynamoDB.
string
string
objectRepresents the settings used to enable or disable Time to Live (TTL) for the specified table.
stringAWS region.
+ +For more information, see AWS::DynamoDB::GlobalTable. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all global_tables in a region. +```sql +SELECT +region, +arn, +stream_arn, +attribute_definitions, +billing_mode, +global_secondary_indexes, +key_schema, +local_secondary_indexes, +point_in_time_recovery_specification, +write_provisioned_throughput_settings, +write_on_demand_throughput_settings, +warm_throughput, +replicas, +sse_specification, +stream_specification, +table_name, +table_id, +time_to_live_specification +FROM aws.dynamodb.global_tables +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual global_table. +```sql +SELECT +region, +arn, +stream_arn, +attribute_definitions, +billing_mode, +global_secondary_indexes, +key_schema, +local_secondary_indexes, +point_in_time_recovery_specification, +write_provisioned_throughput_settings, +write_on_demand_throughput_settings, +warm_throughput, +replicas, +sse_specification, +stream_specification, +table_name, +table_id, +time_to_live_specification +FROM aws.dynamodb.global_tables +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new global_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.dynamodb.global_tables ( + AttributeDefinitions, + KeySchema, + Replicas, + region +) +SELECT +'{{ AttributeDefinitions }}', + '{{ KeySchema }}', + '{{ Replicas }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.dynamodb.global_tables ( + AttributeDefinitions, + BillingMode, + GlobalSecondaryIndexes, + KeySchema, + LocalSecondaryIndexes, + PointInTimeRecoverySpecification, + WriteProvisionedThroughputSettings, + WriteOnDemandThroughputSettings, + WarmThroughput, + Replicas, + SSESpecification, + StreamSpecification, + TableName, + TimeToLiveSpecification, + region +) +SELECT + '{{ AttributeDefinitions }}', + '{{ BillingMode }}', + '{{ GlobalSecondaryIndexes }}', + '{{ KeySchema }}', + '{{ LocalSecondaryIndexes }}', + '{{ PointInTimeRecoverySpecification }}', + '{{ WriteProvisionedThroughputSettings }}', + '{{ WriteOnDemandThroughputSettings }}', + '{{ WarmThroughput }}', + '{{ Replicas }}', + '{{ SSESpecification }}', + '{{ StreamSpecification }}', + '{{ TableName }}', + '{{ TimeToLiveSpecification }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: global_table + props: + - name: AttributeDefinitions + value: + - AttributeType: '{{ AttributeType }}' + AttributeName: '{{ AttributeName }}' + - name: BillingMode + value: '{{ BillingMode }}' + - name: GlobalSecondaryIndexes + value: + - IndexName: '{{ IndexName }}' + OnDemandThroughput: + MaxReadRequestUnits: '{{ MaxReadRequestUnits }}' + MaxWriteRequestUnits: '{{ MaxWriteRequestUnits }}' + ContributorInsightsSpecification: + Enabled: '{{ Enabled }}' + Projection: + NonKeyAttributes: + - '{{ NonKeyAttributes[0] }}' + ProjectionType: '{{ ProjectionType }}' + ProvisionedThroughput: + WriteCapacityUnits: '{{ WriteCapacityUnits }}' + ReadCapacityUnits: '{{ ReadCapacityUnits }}' + KeySchema: + - KeyType: '{{ KeyType }}' + AttributeName: '{{ AttributeName }}' + WarmThroughput: + ReadUnitsPerSecond: '{{ ReadUnitsPerSecond }}' + WriteUnitsPerSecond: '{{ WriteUnitsPerSecond }}' + - name: KeySchema + value: + - null + - name: LocalSecondaryIndexes + value: + - IndexName: '{{ IndexName }}' + Projection: null + KeySchema: + - null + - name: PointInTimeRecoverySpecification + value: + PointInTimeRecoveryEnabled: '{{ PointInTimeRecoveryEnabled }}' + RecoveryPeriodInDays: '{{ RecoveryPeriodInDays }}' + - name: WriteProvisionedThroughputSettings + value: + WriteCapacityAutoScalingSettings: + MinCapacity: '{{ MinCapacity }}' + MaxCapacity: '{{ MaxCapacity }}' + SeedCapacity: '{{ SeedCapacity }}' + TargetTrackingScalingPolicyConfiguration: + DisableScaleIn: '{{ DisableScaleIn }}' + ScaleInCooldown: '{{ ScaleInCooldown }}' + ScaleOutCooldown: '{{ ScaleOutCooldown }}' + TargetValue: null + - name: WriteOnDemandThroughputSettings + value: + MaxWriteRequestUnits: '{{ MaxWriteRequestUnits }}' + - name: WarmThroughput + value: null + - name: Replicas + value: + - Region: '{{ Region }}' + GlobalSecondaryIndexes: + - IndexName: '{{ IndexName }}' + ContributorInsightsSpecification: null + ReadProvisionedThroughputSettings: + ReadCapacityUnits: '{{ ReadCapacityUnits }}' + ReadCapacityAutoScalingSettings: null + ReadOnDemandThroughputSettings: + MaxReadRequestUnits: '{{ MaxReadRequestUnits }}' + ContributorInsightsSpecification: null + PointInTimeRecoverySpecification: null + TableClass: '{{ TableClass }}' + DeletionProtectionEnabled: '{{ DeletionProtectionEnabled }}' + SSESpecification: + KMSMasterKeyId: '{{ KMSMasterKeyId }}' + Tags: + - Value: '{{ Value }}' + Key: '{{ Key }}' + ReadProvisionedThroughputSettings: null + ReadOnDemandThroughputSettings: null + KinesisStreamSpecification: + ApproximateCreationDateTimePrecision: '{{ ApproximateCreationDateTimePrecision }}' + StreamArn: '{{ StreamArn }}' + ResourcePolicy: + PolicyDocument: {} + ReplicaStreamSpecification: + ResourcePolicy: null + - name: SSESpecification + value: + SSEEnabled: '{{ SSEEnabled }}' + SSEType: '{{ SSEType }}' + KMSMasterKeyId: '{{ KMSMasterKeyId }}' + - name: StreamSpecification + value: + StreamViewType: '{{ StreamViewType }}' + ResourcePolicy: null + - name: TableName + value: '{{ TableName }}' + - name: TimeToLiveSpecification + value: + Enabled: '{{ Enabled }}' + AttributeName: '{{ AttributeName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.dynamodb.global_tables +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +dynamodb:ListTables, +cloudwatch:PutMetricData +``` diff --git a/website/docs/services/dynamodb/global_tables_list_only/index.md b/website/docs/services/dynamodb/global_tables_list_only/index.md new file mode 100644 index 0000000..9d889a1 --- /dev/null +++ b/website/docs/services/dynamodb/global_tables_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: global_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - global_tables_list_only + - dynamodb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists global_tables in a region or regions, for all properties use global_tables + +## Overview + + + + + + + +
Nameglobal_tables_list_only
TypeResource
DescriptionVersion: None. Resource Type definition for AWS::DynamoDB::GlobalTable
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all global_tables in a region. +```sql +SELECT +region, +table_name +FROM aws.dynamodb.global_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_tables_list_only resource, see global_tables + diff --git a/website/docs/services/dynamodb/index.md b/website/docs/services/dynamodb/index.md new file mode 100644 index 0000000..61ad100 --- /dev/null +++ b/website/docs/services/dynamodb/index.md @@ -0,0 +1,40 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The dynamodb service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/dynamodb/table_tags/index.md b/website/docs/services/dynamodb/table_tags/index.md new file mode 100644 index 0000000..f40cda5 --- /dev/null +++ b/website/docs/services/dynamodb/table_tags/index.md @@ -0,0 +1,117 @@ +--- +title: table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - table_tags + - dynamodb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for tables in a region + +## Overview + + + + + + + +
Nametable_tags
TypeResource
DescriptionThe AWS::DynamoDB::Table resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
You should be aware of the following behaviors when working with DDB tables:
+ CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).

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

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

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

If not specified, the default is PROVISIONED.
arrayGlobal secondary indexes to be created on the table. You can create up to 20 global secondary indexes.
If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command.
If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index.
Updates are not supported. The following are exceptions:
+ If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
+ You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.
objectA resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).
When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).
Specifies the attributes that make up the primary key for the table. The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.
arrayLocal secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
string
string
booleanDetermines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*.
stringThe table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
objectSpecifies the Time to Live (TTL) settings for the table.
For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.
stringAWS region.
+ +For more information, see AWS::DynamoDB::Table. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all tables in a region. +```sql +SELECT +region, +on_demand_throughput, +sse_specification, +kinesis_stream_specification, +stream_specification, +contributor_insights_specification, +import_source_specification, +point_in_time_recovery_specification, +provisioned_throughput, +warm_throughput, +table_name, +attribute_definitions, +billing_mode, +global_secondary_indexes, +resource_policy, +key_schema, +local_secondary_indexes, +arn, +stream_arn, +deletion_protection_enabled, +table_class, +tags, +time_to_live_specification +FROM aws.dynamodb.tables +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual table. +```sql +SELECT +region, +on_demand_throughput, +sse_specification, +kinesis_stream_specification, +stream_specification, +contributor_insights_specification, +import_source_specification, +point_in_time_recovery_specification, +provisioned_throughput, +warm_throughput, +table_name, +attribute_definitions, +billing_mode, +global_secondary_indexes, +resource_policy, +key_schema, +local_secondary_indexes, +arn, +stream_arn, +deletion_protection_enabled, +table_class, +tags, +time_to_live_specification +FROM aws.dynamodb.tables +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.dynamodb.tables ( + KeySchema, + region +) +SELECT +'{{ KeySchema }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.dynamodb.tables ( + OnDemandThroughput, + SSESpecification, + KinesisStreamSpecification, + StreamSpecification, + ContributorInsightsSpecification, + ImportSourceSpecification, + PointInTimeRecoverySpecification, + ProvisionedThroughput, + WarmThroughput, + TableName, + AttributeDefinitions, + BillingMode, + GlobalSecondaryIndexes, + ResourcePolicy, + KeySchema, + LocalSecondaryIndexes, + DeletionProtectionEnabled, + TableClass, + Tags, + TimeToLiveSpecification, + region +) +SELECT + '{{ OnDemandThroughput }}', + '{{ SSESpecification }}', + '{{ KinesisStreamSpecification }}', + '{{ StreamSpecification }}', + '{{ ContributorInsightsSpecification }}', + '{{ ImportSourceSpecification }}', + '{{ PointInTimeRecoverySpecification }}', + '{{ ProvisionedThroughput }}', + '{{ WarmThroughput }}', + '{{ TableName }}', + '{{ AttributeDefinitions }}', + '{{ BillingMode }}', + '{{ GlobalSecondaryIndexes }}', + '{{ ResourcePolicy }}', + '{{ KeySchema }}', + '{{ LocalSecondaryIndexes }}', + '{{ DeletionProtectionEnabled }}', + '{{ TableClass }}', + '{{ Tags }}', + '{{ TimeToLiveSpecification }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: table + props: + - name: OnDemandThroughput + value: + MaxReadRequestUnits: '{{ MaxReadRequestUnits }}' + MaxWriteRequestUnits: '{{ MaxWriteRequestUnits }}' + - name: SSESpecification + value: + SSEEnabled: '{{ SSEEnabled }}' + SSEType: '{{ SSEType }}' + KMSMasterKeyId: '{{ KMSMasterKeyId }}' + - name: KinesisStreamSpecification + value: + ApproximateCreationDateTimePrecision: '{{ ApproximateCreationDateTimePrecision }}' + StreamArn: '{{ StreamArn }}' + - name: StreamSpecification + value: + StreamViewType: '{{ StreamViewType }}' + ResourcePolicy: + PolicyDocument: {} + - name: ContributorInsightsSpecification + value: + Enabled: '{{ Enabled }}' + - name: ImportSourceSpecification + value: + S3BucketSource: + S3Bucket: '{{ S3Bucket }}' + S3KeyPrefix: '{{ S3KeyPrefix }}' + S3BucketOwner: '{{ S3BucketOwner }}' + InputFormat: '{{ InputFormat }}' + InputFormatOptions: + Csv: + Delimiter: '{{ Delimiter }}' + HeaderList: + - '{{ HeaderList[0] }}' + InputCompressionType: '{{ InputCompressionType }}' + - name: PointInTimeRecoverySpecification + value: + PointInTimeRecoveryEnabled: '{{ PointInTimeRecoveryEnabled }}' + RecoveryPeriodInDays: '{{ RecoveryPeriodInDays }}' + - name: ProvisionedThroughput + value: + WriteCapacityUnits: '{{ WriteCapacityUnits }}' + ReadCapacityUnits: '{{ ReadCapacityUnits }}' + - name: WarmThroughput + value: + ReadUnitsPerSecond: '{{ ReadUnitsPerSecond }}' + WriteUnitsPerSecond: '{{ WriteUnitsPerSecond }}' + - name: TableName + value: '{{ TableName }}' + - name: AttributeDefinitions + value: + - AttributeType: '{{ AttributeType }}' + AttributeName: '{{ AttributeName }}' + - name: BillingMode + value: '{{ BillingMode }}' + - name: GlobalSecondaryIndexes + value: + - IndexName: '{{ IndexName }}' + OnDemandThroughput: null + ContributorInsightsSpecification: null + Projection: + NonKeyAttributes: + - '{{ NonKeyAttributes[0] }}' + ProjectionType: '{{ ProjectionType }}' + ProvisionedThroughput: null + KeySchema: + - KeyType: '{{ KeyType }}' + AttributeName: '{{ AttributeName }}' + WarmThroughput: null + - name: ResourcePolicy + value: null + - name: KeySchema + value: null + - name: LocalSecondaryIndexes + value: + - IndexName: '{{ IndexName }}' + Projection: null + KeySchema: + - null + - name: DeletionProtectionEnabled + value: '{{ DeletionProtectionEnabled }}' + - name: TableClass + value: '{{ TableClass }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: TimeToLiveSpecification + value: + Enabled: '{{ Enabled }}' + AttributeName: '{{ AttributeName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.dynamodb.tables +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the tables resource, the following permissions are required: + +### Read +```json +dynamodb:DescribeTable, +dynamodb:DescribeContinuousBackups, +dynamodb:DescribeContributorInsights, +dynamodb:DescribeKinesisStreamingDestination, +dynamodb:ListTagsOfResource, +dynamodb:GetResourcePolicy +``` + +### 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 +``` + +### 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 +``` + +### List +```json +dynamodb:ListTables +``` + +### Delete +```json +dynamodb:DeleteTable, +dynamodb:DescribeTable +``` diff --git a/website/docs/services/dynamodb/tables_list_only/index.md b/website/docs/services/dynamodb/tables_list_only/index.md new file mode 100644 index 0000000..14e2b79 --- /dev/null +++ b/website/docs/services/dynamodb/tables_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tables_list_only + - dynamodb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tables in a region or regions, for all properties use tables + +## Overview + + + + + + + +
Nametables_list_only
TypeResource
DescriptionThe AWS::DynamoDB::Table resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
You should be aware of the following behaviors when working with DDB tables:
+ CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).

Our guidance is to use the latest schema documented for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tables in a region. +```sql +SELECT +region, +table_name +FROM aws.dynamodb.tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tables_list_only resource, see tables + diff --git a/website/docs/services/ec2/capacity_reservation_fleets/index.md b/website/docs/services/ec2/capacity_reservation_fleets/index.md new file mode 100644 index 0000000..804d725 --- /dev/null +++ b/website/docs/services/ec2/capacity_reservation_fleets/index.md @@ -0,0 +1,309 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a capacity_reservation_fleet resource or lists capacity_reservation_fleets in a region + +## Overview + + + + + + + +
Namecapacity_reservation_fleets
TypeResource
DescriptionResource Type definition for AWS::EC2::CapacityReservationFleet
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
array
integer
string
string
string
string
boolean
boolean
stringAWS region.
+ +For more information, see AWS::EC2::CapacityReservationFleet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all capacity_reservation_fleets in a region. +```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_fleets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual capacity_reservation_fleet. +```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_fleets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new capacity_reservation_fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.capacity_reservation_fleets ( + AllocationStrategy, + TagSpecifications, + InstanceTypeSpecifications, + TotalTargetCapacity, + EndDate, + InstanceMatchCriteria, + Tenancy, + RemoveEndDate, + NoRemoveEndDate, + region +) +SELECT +'{{ AllocationStrategy }}', + '{{ TagSpecifications }}', + '{{ InstanceTypeSpecifications }}', + '{{ TotalTargetCapacity }}', + '{{ EndDate }}', + '{{ InstanceMatchCriteria }}', + '{{ Tenancy }}', + '{{ RemoveEndDate }}', + '{{ NoRemoveEndDate }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.capacity_reservation_fleets ( + AllocationStrategy, + TagSpecifications, + InstanceTypeSpecifications, + TotalTargetCapacity, + EndDate, + InstanceMatchCriteria, + Tenancy, + RemoveEndDate, + NoRemoveEndDate, + region +) +SELECT + '{{ AllocationStrategy }}', + '{{ TagSpecifications }}', + '{{ InstanceTypeSpecifications }}', + '{{ TotalTargetCapacity }}', + '{{ EndDate }}', + '{{ InstanceMatchCriteria }}', + '{{ Tenancy }}', + '{{ RemoveEndDate }}', + '{{ NoRemoveEndDate }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: capacity_reservation_fleet + props: + - name: AllocationStrategy + value: '{{ AllocationStrategy }}' + - name: TagSpecifications + value: + - ResourceType: '{{ ResourceType }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: InstanceTypeSpecifications + value: + - InstanceType: '{{ InstanceType }}' + InstancePlatform: '{{ InstancePlatform }}' + Weight: null + AvailabilityZone: '{{ AvailabilityZone }}' + AvailabilityZoneId: '{{ AvailabilityZoneId }}' + EbsOptimized: '{{ EbsOptimized }}' + Priority: '{{ Priority }}' + - name: TotalTargetCapacity + value: '{{ TotalTargetCapacity }}' + - name: EndDate + value: '{{ EndDate }}' + - name: InstanceMatchCriteria + value: '{{ InstanceMatchCriteria }}' + - name: Tenancy + value: '{{ Tenancy }}' + - name: RemoveEndDate + value: '{{ RemoveEndDate }}' + - name: NoRemoveEndDate + value: '{{ NoRemoveEndDate }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.capacity_reservation_fleets +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +ec2:CreateCapacityReservationFleet, +ec2:ModifyCapacityReservationFleet, +ec2:DescribeCapacityReservationFleets, +ec2:CancelCapacityReservationFleets, +ec2:CreateCapacityReservation, +ec2:DescribeCapacityReservations, +ec2:CancelCapacityReservation, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeCapacityReservationFleets, +ec2:DescribeCapacityReservations, +ec2:DescribeInstances +``` + +### 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/website/docs/services/ec2/capacity_reservation_fleets_list_only/index.md b/website/docs/services/ec2/capacity_reservation_fleets_list_only/index.md new file mode 100644 index 0000000..4d4f79e --- /dev/null +++ b/website/docs/services/ec2/capacity_reservation_fleets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: capacity_reservation_fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservation_fleets_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists capacity_reservation_fleets in a region or regions, for all properties use capacity_reservation_fleets + +## Overview + + + + + + + +
Namecapacity_reservation_fleets_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::CapacityReservationFleet
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all capacity_reservation_fleets in a region. +```sql +SELECT +region, +capacity_reservation_fleet_id +FROM aws.ec2.capacity_reservation_fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capacity_reservation_fleets_list_only resource, see capacity_reservation_fleets + diff --git a/website/docs/services/ec2/capacity_reservations/index.md b/website/docs/services/ec2/capacity_reservations/index.md new file mode 100644 index 0000000..3fc21f2 --- /dev/null +++ b/website/docs/services/ec2/capacity_reservations/index.md @@ -0,0 +1,316 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a capacity_reservation resource or lists capacity_reservations in a region + +## Overview + + + + + + + +
Namecapacity_reservations
TypeResource
DescriptionResource Type definition for AWS::EC2::CapacityReservation
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
integer
string
boolean
string
integer
string
integer
string
string
string
boolean
string
string
stringAWS region.
+ +For more information, see AWS::EC2::CapacityReservation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all capacity_reservations in a region. +```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, +unused_reservation_billing_owner_id +FROM aws.ec2.capacity_reservations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual capacity_reservation. +```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, +unused_reservation_billing_owner_id +FROM aws.ec2.capacity_reservations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new capacity_reservation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.capacity_reservations ( + AvailabilityZone, + InstanceCount, + InstancePlatform, + InstanceType, + region +) +SELECT +'{{ AvailabilityZone }}', + '{{ InstanceCount }}', + '{{ InstancePlatform }}', + '{{ InstanceType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.capacity_reservations ( + Tenancy, + EndDateType, + TagSpecifications, + AvailabilityZone, + EndDate, + EbsOptimized, + OutPostArn, + InstanceCount, + PlacementGroupArn, + InstancePlatform, + InstanceType, + EphemeralStorage, + InstanceMatchCriteria, + UnusedReservationBillingOwnerId, + region +) +SELECT + '{{ Tenancy }}', + '{{ EndDateType }}', + '{{ TagSpecifications }}', + '{{ AvailabilityZone }}', + '{{ EndDate }}', + '{{ EbsOptimized }}', + '{{ OutPostArn }}', + '{{ InstanceCount }}', + '{{ PlacementGroupArn }}', + '{{ InstancePlatform }}', + '{{ InstanceType }}', + '{{ EphemeralStorage }}', + '{{ InstanceMatchCriteria }}', + '{{ UnusedReservationBillingOwnerId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: capacity_reservation + props: + - name: Tenancy + value: '{{ Tenancy }}' + - name: EndDateType + value: '{{ EndDateType }}' + - name: TagSpecifications + value: + - ResourceType: '{{ ResourceType }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: EndDate + value: '{{ EndDate }}' + - name: EbsOptimized + value: '{{ EbsOptimized }}' + - name: OutPostArn + value: '{{ OutPostArn }}' + - name: InstanceCount + value: '{{ InstanceCount }}' + - name: PlacementGroupArn + value: '{{ PlacementGroupArn }}' + - name: InstancePlatform + value: '{{ InstancePlatform }}' + - name: InstanceType + value: '{{ InstanceType }}' + - name: EphemeralStorage + value: '{{ EphemeralStorage }}' + - name: InstanceMatchCriteria + value: '{{ InstanceMatchCriteria }}' + - name: UnusedReservationBillingOwnerId + value: '{{ UnusedReservationBillingOwnerId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.capacity_reservations +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +ec2:CreateCapacityReservation, +ec2:DescribeCapacityReservations, +ec2:CancelCapacityReservation, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeCapacityReservations +``` + +### Read +```json +ec2:DescribeCapacityReservations +``` + +### Update +```json +ec2:ModifyCapacityReservation, +ec2:CreateCapacityReservation, +ec2:DescribeCapacityReservations, +ec2:CancelCapacityReservation, +ec2:AssociateCapacityReservationBillingOwner, +ec2:CreateTags, +ec2:DeleteTags +``` diff --git a/website/docs/services/ec2/capacity_reservations_list_only/index.md b/website/docs/services/ec2/capacity_reservations_list_only/index.md new file mode 100644 index 0000000..13cc685 --- /dev/null +++ b/website/docs/services/ec2/capacity_reservations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: capacity_reservations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists capacity_reservations in a region or regions, for all properties use capacity_reservations + +## Overview + + + + + + + +
Namecapacity_reservations_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::CapacityReservation
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all capacity_reservations in a region. +```sql +SELECT +region, +id +FROM aws.ec2.capacity_reservations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capacity_reservations_list_only resource, see capacity_reservations + diff --git a/website/docs/services/ec2/carrier_gateway_tags/index.md b/website/docs/services/ec2/carrier_gateway_tags/index.md new file mode 100644 index 0000000..97328aa --- /dev/null +++ b/website/docs/services/ec2/carrier_gateway_tags/index.md @@ -0,0 +1,83 @@ +--- +title: carrier_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - carrier_gateway_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for carrier_gateways in a region + +## Overview + + + + + + + +
Namecarrier_gateway_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the carrier gateway.
stringThe state of the carrier gateway.
stringThe ID of the VPC.
stringThe ID of the owner.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all carrier_gateways in a region. +```sql +SELECT +region, +carrier_gateway_id, +state, +vpc_id, +owner_id, +tag_key, +tag_value +FROM aws.ec2.carrier_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the carrier_gateway_tags resource, see carrier_gateways + diff --git a/website/docs/services/ec2/carrier_gateways/index.md b/website/docs/services/ec2/carrier_gateways/index.md new file mode 100644 index 0000000..81fb002 --- /dev/null +++ b/website/docs/services/ec2/carrier_gateways/index.md @@ -0,0 +1,219 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a carrier_gateway resource or lists carrier_gateways in a region + +## Overview + + + + + + + +
Namecarrier_gateways
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the carrier gateway.
stringThe state of the carrier gateway.
stringThe ID of the VPC.
stringThe ID of the owner.
arrayThe tags for the carrier gateway.
stringAWS region.
+ +For more information, see AWS::EC2::CarrierGateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all carrier_gateways in a region. +```sql +SELECT +region, +carrier_gateway_id, +state, +vpc_id, +owner_id, +tags +FROM aws.ec2.carrier_gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual carrier_gateway. +```sql +SELECT +region, +carrier_gateway_id, +state, +vpc_id, +owner_id, +tags +FROM aws.ec2.carrier_gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new carrier_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.carrier_gateways ( + VpcId, + region +) +SELECT +'{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.carrier_gateways ( + VpcId, + Tags, + region +) +SELECT + '{{ VpcId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: carrier_gateway + props: + - name: VpcId + value: '{{ VpcId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.carrier_gateways +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeCarrierGateways, +ec2:DescribeTags +``` + +### Update +```json +ec2:DescribeCarrierGateways, +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeTags +``` + +### Delete +```json +ec2:DeleteCarrierGateway, +ec2:DescribeCarrierGateways +``` + +### List +```json +ec2:DescribeCarrierGateways +``` diff --git a/website/docs/services/ec2/carrier_gateways_list_only/index.md b/website/docs/services/ec2/carrier_gateways_list_only/index.md new file mode 100644 index 0000000..a4fbd06 --- /dev/null +++ b/website/docs/services/ec2/carrier_gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: carrier_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - carrier_gateways_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists carrier_gateways in a region or regions, for all properties use carrier_gateways + +## Overview + + + + + + + +
Namecarrier_gateways_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the carrier gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all carrier_gateways in a region. +```sql +SELECT +region, +carrier_gateway_id +FROM aws.ec2.carrier_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the carrier_gateways_list_only resource, see carrier_gateways + diff --git a/website/docs/services/ec2/customer_gateway_tags/index.md b/website/docs/services/ec2/customer_gateway_tags/index.md new file mode 100644 index 0000000..02d32e0 --- /dev/null +++ b/website/docs/services/ec2/customer_gateway_tags/index.md @@ -0,0 +1,89 @@ +--- +title: customer_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - customer_gateway_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for customer_gateways in a region + +## Overview + + + + + + + +
Namecustomer_gateway_tags
TypeResource
DescriptionSpecifies a customer gateway.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of VPN connection that this customer gateway supports (ipsec.1).
string
stringIPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
numberFor customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.
Valid values: 2,147,483,648 to 4,294,967,295
integerFor customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.
Default: 65000
Valid values: 1 to 2,147,483,647
stringThe Amazon Resource Name (ARN) for the customer gateway certificate.
stringThe name of customer gateway device.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all customer_gateways in a region. +```sql +SELECT +region, +type, +customer_gateway_id, +ip_address, +bgp_asn_extended, +bgp_asn, +certificate_arn, +device_name, +tag_key, +tag_value +FROM aws.ec2.customer_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the customer_gateway_tags resource, see customer_gateways + diff --git a/website/docs/services/ec2/customer_gateways/index.md b/website/docs/services/ec2/customer_gateways/index.md new file mode 100644 index 0000000..9602e28 --- /dev/null +++ b/website/docs/services/ec2/customer_gateways/index.md @@ -0,0 +1,248 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a customer_gateway resource or lists customer_gateways in a region + +## Overview + + + + + + + +
Namecustomer_gateways
TypeResource
DescriptionSpecifies a customer gateway.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of VPN connection that this customer gateway supports (ipsec.1).
string
stringIPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
numberFor customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.
Valid values: 2,147,483,648 to 4,294,967,295
integerFor customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.
Default: 65000
Valid values: 1 to 2,147,483,647
arrayOne or more tags for the customer gateway.
stringThe Amazon Resource Name (ARN) for the customer gateway certificate.
stringThe name of customer gateway device.
stringAWS region.
+ +For more information, see AWS::EC2::CustomerGateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all customer_gateways in a region. +```sql +SELECT +region, +type, +customer_gateway_id, +ip_address, +bgp_asn_extended, +bgp_asn, +tags, +certificate_arn, +device_name +FROM aws.ec2.customer_gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual customer_gateway. +```sql +SELECT +region, +type, +customer_gateway_id, +ip_address, +bgp_asn_extended, +bgp_asn, +tags, +certificate_arn, +device_name +FROM aws.ec2.customer_gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new customer_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.customer_gateways ( + Type, + IpAddress, + region +) +SELECT +'{{ Type }}', + '{{ IpAddress }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.customer_gateways ( + Type, + IpAddress, + BgpAsnExtended, + BgpAsn, + Tags, + CertificateArn, + DeviceName, + region +) +SELECT + '{{ Type }}', + '{{ IpAddress }}', + '{{ BgpAsnExtended }}', + '{{ BgpAsn }}', + '{{ Tags }}', + '{{ CertificateArn }}', + '{{ DeviceName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: customer_gateway + props: + - name: Type + value: '{{ Type }}' + - name: IpAddress + value: '{{ IpAddress }}' + - name: BgpAsnExtended + value: null + - name: BgpAsn + value: '{{ BgpAsn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CertificateArn + value: '{{ CertificateArn }}' + - name: DeviceName + value: '{{ DeviceName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.customer_gateways +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the customer_gateways resource, the following permissions are required: + +### Read +```json +ec2:DescribeCustomerGateways +``` + +### Create +```json +ec2:CreateCustomerGateway, +ec2:DescribeCustomerGateways, +ec2:CreateTags +``` + +### Update +```json +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeCustomerGateways +``` + +### List +```json +ec2:DescribeCustomerGateways +``` + +### Delete +```json +ec2:DeleteCustomerGateway, +ec2:DescribeCustomerGateways +``` diff --git a/website/docs/services/ec2/customer_gateways_list_only/index.md b/website/docs/services/ec2/customer_gateways_list_only/index.md new file mode 100644 index 0000000..60b4aa7 --- /dev/null +++ b/website/docs/services/ec2/customer_gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: customer_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - customer_gateways_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists customer_gateways in a region or regions, for all properties use customer_gateways + +## Overview + + + + + + + +
Namecustomer_gateways_list_only
TypeResource
DescriptionSpecifies a customer gateway.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all customer_gateways in a region. +```sql +SELECT +region, +customer_gateway_id +FROM aws.ec2.customer_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the customer_gateways_list_only resource, see customer_gateways + diff --git a/website/docs/services/ec2/dhcp_options/index.md b/website/docs/services/ec2/dhcp_options/index.md new file mode 100644 index 0000000..fa4e734 --- /dev/null +++ b/website/docs/services/ec2/dhcp_options/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dhcp_option resource or lists dhcp_options in a region + +## Overview + + + + + + + +
Namedhcp_options
TypeResource
DescriptionResource Type definition for AWS::EC2::DHCPOptions
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThis value is used to complete unqualified DNS hostnames.
arrayThe IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS.
arrayThe IPv4 addresses of up to four NetBIOS name servers.
integerThe NetBIOS node type (1, 2, 4, or 8).
arrayThe IPv4 addresses of up to four Network Time Protocol (NTP) servers.
integerThe preferred Lease Time for ipV6 address in seconds.
arrayAny tags assigned to the DHCP options set.
stringAWS region.
+ +For more information, see AWS::EC2::DHCPOptions. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dhcp_options in a region. +```sql +SELECT +region, +dhcp_options_id, +domain_name, +domain_name_servers, +netbios_name_servers, +netbios_node_type, +ntp_servers, +ipv6_address_preferred_lease_time, +tags +FROM aws.ec2.dhcp_options +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dhcp_option. +```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 region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dhcp_option resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.dhcp_options ( + DomainName, + DomainNameServers, + NetbiosNameServers, + NetbiosNodeType, + NtpServers, + Ipv6AddressPreferredLeaseTime, + Tags, + region +) +SELECT +'{{ DomainName }}', + '{{ DomainNameServers }}', + '{{ NetbiosNameServers }}', + '{{ NetbiosNodeType }}', + '{{ NtpServers }}', + '{{ Ipv6AddressPreferredLeaseTime }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.dhcp_options ( + DomainName, + DomainNameServers, + NetbiosNameServers, + NetbiosNodeType, + NtpServers, + Ipv6AddressPreferredLeaseTime, + Tags, + region +) +SELECT + '{{ DomainName }}', + '{{ DomainNameServers }}', + '{{ NetbiosNameServers }}', + '{{ NetbiosNodeType }}', + '{{ NtpServers }}', + '{{ Ipv6AddressPreferredLeaseTime }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dhcp_option + props: + - name: DomainName + value: '{{ DomainName }}' + - name: DomainNameServers + value: + - '{{ DomainNameServers[0] }}' + - name: NetbiosNameServers + value: + - '{{ NetbiosNameServers[0] }}' + - name: NetbiosNodeType + value: '{{ NetbiosNodeType }}' + - name: NtpServers + value: + - '{{ NtpServers[0] }}' + - name: Ipv6AddressPreferredLeaseTime + value: '{{ Ipv6AddressPreferredLeaseTime }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.dhcp_options +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the dhcp_options resource, the following permissions are required: + +### Create +```json +ec2:CreateDhcpOptions, +ec2:DescribeDhcpOptions, +ec2:CreateTags +``` + +### Read +```json +ec2:DescribeDhcpOptions, +ec2:DescribeTags +``` + +### Update +```json +ec2:CreateTags, +ec2:DescribeDhcpOptions, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteDhcpOptions, +ec2:DeleteTags, +ec2:DescribeDhcpOptions +``` + +### List +```json +ec2:DescribeDhcpOptions +``` diff --git a/website/docs/services/ec2/dhcp_options_list_only/index.md b/website/docs/services/ec2/dhcp_options_list_only/index.md new file mode 100644 index 0000000..3b40ea2 --- /dev/null +++ b/website/docs/services/ec2/dhcp_options_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dhcp_options_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dhcp_options_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dhcp_options in a region or regions, for all properties use dhcp_options + +## Overview + + + + + + + +
Namedhcp_options_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::DHCPOptions
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dhcp_options in a region. +```sql +SELECT +region, +dhcp_options_id +FROM aws.ec2.dhcp_options_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dhcp_options_list_only resource, see dhcp_options + diff --git a/website/docs/services/ec2/dhcp_options_tags/index.md b/website/docs/services/ec2/dhcp_options_tags/index.md new file mode 100644 index 0000000..cfe35e0 --- /dev/null +++ b/website/docs/services/ec2/dhcp_options_tags/index.md @@ -0,0 +1,89 @@ +--- +title: dhcp_options_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dhcp_options_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dhcp_options in a region + +## Overview + + + + + + + +
Namedhcp_options_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::DHCPOptions
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThis value is used to complete unqualified DNS hostnames.
arrayThe IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS.
arrayThe IPv4 addresses of up to four NetBIOS name servers.
integerThe NetBIOS node type (1, 2, 4, or 8).
arrayThe IPv4 addresses of up to four Network Time Protocol (NTP) servers.
integerThe preferred Lease Time for ipV6 address in seconds.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dhcp_options in a region. +```sql +SELECT +region, +dhcp_options_id, +domain_name, +domain_name_servers, +netbios_name_servers, +netbios_node_type, +ntp_servers, +ipv6_address_preferred_lease_time, +tag_key, +tag_value +FROM aws.ec2.dhcp_options_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dhcp_options_tags resource, see dhcp_options + diff --git a/website/docs/services/ec2/ec2fleets/index.md b/website/docs/services/ec2/ec2fleets/index.md new file mode 100644 index 0000000..8602bce --- /dev/null +++ b/website/docs/services/ec2/ec2fleets/index.md @@ -0,0 +1,382 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ec2fleet resource or lists ec2fleets in a region + +## Overview + + + + + + + +
Nameec2fleets
TypeResource
DescriptionResource Type definition for AWS::EC2::EC2Fleet
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
string
array
object
array
boolean
string
string
string
string
boolean
stringAWS region.
+ +For more information, see AWS::EC2::EC2Fleet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ec2fleets in a region. +```sql +SELECT +region, +context, +target_capacity_specification, +on_demand_options, +excess_capacity_termination_policy, +tag_specifications, +spot_options, +launch_template_configs, +terminate_instances_with_expiration, +valid_until, +type, +fleet_id, +valid_from, +replace_unhealthy_instances +FROM aws.ec2.ec2fleets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ec2fleet. +```sql +SELECT +region, +context, +target_capacity_specification, +on_demand_options, +excess_capacity_termination_policy, +tag_specifications, +spot_options, +launch_template_configs, +terminate_instances_with_expiration, +valid_until, +type, +fleet_id, +valid_from, +replace_unhealthy_instances +FROM aws.ec2.ec2fleets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ec2fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ec2fleets ( + TargetCapacitySpecification, + LaunchTemplateConfigs, + region +) +SELECT +'{{ TargetCapacitySpecification }}', + '{{ LaunchTemplateConfigs }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ec2fleets ( + Context, + TargetCapacitySpecification, + OnDemandOptions, + ExcessCapacityTerminationPolicy, + TagSpecifications, + SpotOptions, + LaunchTemplateConfigs, + TerminateInstancesWithExpiration, + ValidUntil, + Type, + ValidFrom, + ReplaceUnhealthyInstances, + region +) +SELECT + '{{ Context }}', + '{{ TargetCapacitySpecification }}', + '{{ OnDemandOptions }}', + '{{ ExcessCapacityTerminationPolicy }}', + '{{ TagSpecifications }}', + '{{ SpotOptions }}', + '{{ LaunchTemplateConfigs }}', + '{{ TerminateInstancesWithExpiration }}', + '{{ ValidUntil }}', + '{{ Type }}', + '{{ ValidFrom }}', + '{{ ReplaceUnhealthyInstances }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ec2fleet + props: + - name: Context + value: '{{ Context }}' + - name: TargetCapacitySpecification + value: + DefaultTargetCapacityType: '{{ DefaultTargetCapacityType }}' + TotalTargetCapacity: '{{ TotalTargetCapacity }}' + OnDemandTargetCapacity: '{{ OnDemandTargetCapacity }}' + SpotTargetCapacity: '{{ SpotTargetCapacity }}' + TargetCapacityUnitType: '{{ TargetCapacityUnitType }}' + - name: OnDemandOptions + value: + SingleAvailabilityZone: '{{ SingleAvailabilityZone }}' + AllocationStrategy: '{{ AllocationStrategy }}' + SingleInstanceType: '{{ SingleInstanceType }}' + MinTargetCapacity: '{{ MinTargetCapacity }}' + MaxTotalPrice: '{{ MaxTotalPrice }}' + CapacityReservationOptions: + UsageStrategy: '{{ UsageStrategy }}' + - name: ExcessCapacityTerminationPolicy + value: '{{ ExcessCapacityTerminationPolicy }}' + - name: TagSpecifications + value: + - ResourceType: '{{ ResourceType }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: SpotOptions + value: + SingleAvailabilityZone: '{{ SingleAvailabilityZone }}' + AllocationStrategy: '{{ AllocationStrategy }}' + SingleInstanceType: '{{ SingleInstanceType }}' + MinTargetCapacity: '{{ MinTargetCapacity }}' + MaxTotalPrice: '{{ MaxTotalPrice }}' + MaintenanceStrategies: + CapacityRebalance: + TerminationDelay: '{{ TerminationDelay }}' + ReplacementStrategy: '{{ ReplacementStrategy }}' + InstanceInterruptionBehavior: '{{ InstanceInterruptionBehavior }}' + InstancePoolsToUseCount: '{{ InstancePoolsToUseCount }}' + - name: LaunchTemplateConfigs + value: + - LaunchTemplateSpecification: + LaunchTemplateName: '{{ LaunchTemplateName }}' + Version: '{{ Version }}' + LaunchTemplateId: '{{ LaunchTemplateId }}' + Overrides: + - WeightedCapacity: null + Placement: + GroupName: '{{ GroupName }}' + Tenancy: '{{ Tenancy }}' + SpreadDomain: '{{ SpreadDomain }}' + PartitionNumber: '{{ PartitionNumber }}' + AvailabilityZone: '{{ AvailabilityZone }}' + Affinity: '{{ Affinity }}' + HostId: '{{ HostId }}' + HostResourceGroupArn: '{{ HostResourceGroupArn }}' + GroupId: '{{ GroupId }}' + Priority: null + AvailabilityZone: '{{ AvailabilityZone }}' + SubnetId: '{{ SubnetId }}' + InstanceRequirements: + VCpuCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + MemoryMiB: + Min: '{{ Min }}' + Max: '{{ Max }}' + CpuManufacturers: + - '{{ CpuManufacturers[0] }}' + MemoryGiBPerVCpu: + Min: null + Max: null + AllowedInstanceTypes: + - '{{ AllowedInstanceTypes[0] }}' + ExcludedInstanceTypes: + - '{{ ExcludedInstanceTypes[0] }}' + InstanceGenerations: + - '{{ InstanceGenerations[0] }}' + SpotMaxPricePercentageOverLowestPrice: '{{ SpotMaxPricePercentageOverLowestPrice }}' + OnDemandMaxPricePercentageOverLowestPrice: '{{ OnDemandMaxPricePercentageOverLowestPrice }}' + MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: '{{ MaxSpotPriceAsPercentageOfOptimalOnDemandPrice }}' + BareMetal: '{{ BareMetal }}' + BurstablePerformance: '{{ BurstablePerformance }}' + RequireHibernateSupport: '{{ RequireHibernateSupport }}' + NetworkBandwidthGbps: + Min: null + Max: null + NetworkInterfaceCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + LocalStorage: '{{ LocalStorage }}' + LocalStorageTypes: + - '{{ LocalStorageTypes[0] }}' + TotalLocalStorageGB: + Min: null + Max: null + BaselineEbsBandwidthMbps: + Min: '{{ Min }}' + Max: '{{ Max }}' + AcceleratorTypes: + - '{{ AcceleratorTypes[0] }}' + AcceleratorCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + AcceleratorManufacturers: + - '{{ AcceleratorManufacturers[0] }}' + AcceleratorNames: + - '{{ AcceleratorNames[0] }}' + AcceleratorTotalMemoryMiB: + Min: '{{ Min }}' + Max: '{{ Max }}' + BaselinePerformanceFactors: + Cpu: + References: + - InstanceFamily: '{{ InstanceFamily }}' + InstanceType: '{{ InstanceType }}' + MaxPrice: '{{ MaxPrice }}' + - name: TerminateInstancesWithExpiration + value: '{{ TerminateInstancesWithExpiration }}' + - name: ValidUntil + value: '{{ ValidUntil }}' + - name: Type + value: '{{ Type }}' + - name: ValidFrom + value: '{{ ValidFrom }}' + - name: ReplaceUnhealthyInstances + value: '{{ ReplaceUnhealthyInstances }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.ec2fleets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ec2fleets resource, the following permissions are required: + +### Read +```json +ec2:DescribeFleets +``` + +### Create +```json +ec2:CreateFleet, +ec2:DescribeFleets +``` + +### Update +```json +ec2:ModifyFleet, +ec2:DescribeFleets +``` + +### List +```json +ec2:DescribeFleets +``` + +### Delete +```json +ec2:DescribeFleets, +ec2:DeleteFleets +``` diff --git a/website/docs/services/ec2/ec2fleets_list_only/index.md b/website/docs/services/ec2/ec2fleets_list_only/index.md new file mode 100644 index 0000000..d5b4198 --- /dev/null +++ b/website/docs/services/ec2/ec2fleets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: ec2fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ec2fleets_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ec2fleets in a region or regions, for all properties use ec2fleets + +## Overview + + + + + + + +
Nameec2fleets_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::EC2Fleet
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ec2fleets in a region. +```sql +SELECT +region, +fleet_id +FROM aws.ec2.ec2fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ec2fleets_list_only resource, see ec2fleets + diff --git a/website/docs/services/ec2/egress_only_internet_gateways/index.md b/website/docs/services/ec2/egress_only_internet_gateways/index.md new file mode 100644 index 0000000..1be1ee9 --- /dev/null +++ b/website/docs/services/ec2/egress_only_internet_gateways/index.md @@ -0,0 +1,190 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an egress_only_internet_gateway resource or lists egress_only_internet_gateways in a region + +## Overview + + + + + + + +
Nameegress_only_internet_gateways
TypeResource
DescriptionResource Type definition for AWS::EC2::EgressOnlyInternetGateway
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringService Generated ID of the EgressOnlyInternetGateway
stringThe ID of the VPC for which to create the egress-only internet gateway.
stringAWS region.
+ +For more information, see AWS::EC2::EgressOnlyInternetGateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all egress_only_internet_gateways in a region. +```sql +SELECT +region, +id, +vpc_id +FROM aws.ec2.egress_only_internet_gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual egress_only_internet_gateway. +```sql +SELECT +region, +id, +vpc_id +FROM aws.ec2.egress_only_internet_gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new egress_only_internet_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.egress_only_internet_gateways ( + VpcId, + region +) +SELECT +'{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.egress_only_internet_gateways ( + VpcId, + region +) +SELECT + '{{ VpcId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: egress_only_internet_gateway + props: + - name: VpcId + value: '{{ VpcId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.egress_only_internet_gateways +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeEgressOnlyInternetGateways +``` + +### Delete +```json +ec2:DeleteEgressOnlyInternetGateway, +ec2:DescribeEgressOnlyInternetGateways, +ec2:DescribeVpcs +``` + +### List +```json +ec2:DescribeEgressOnlyInternetGateways +``` diff --git a/website/docs/services/ec2/egress_only_internet_gateways_list_only/index.md b/website/docs/services/ec2/egress_only_internet_gateways_list_only/index.md new file mode 100644 index 0000000..4c6cc22 --- /dev/null +++ b/website/docs/services/ec2/egress_only_internet_gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: egress_only_internet_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - egress_only_internet_gateways_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists egress_only_internet_gateways in a region or regions, for all properties use egress_only_internet_gateways + +## Overview + + + + + + + +
Nameegress_only_internet_gateways_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::EgressOnlyInternetGateway
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringService Generated ID of the EgressOnlyInternetGateway
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all egress_only_internet_gateways in a region. +```sql +SELECT +region, +id +FROM aws.ec2.egress_only_internet_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the egress_only_internet_gateways_list_only resource, see egress_only_internet_gateways + diff --git a/website/docs/services/ec2/eip_associations/index.md b/website/docs/services/ec2/eip_associations/index.md new file mode 100644 index 0000000..22b267b --- /dev/null +++ b/website/docs/services/ec2/eip_associations/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an eip_association resource or lists eip_associations in a region + +## Overview + + + + + + + +
Nameeip_associations
TypeResource
DescriptionAssociates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. For more information about working with Elastic IP addresses, see [Elastic IP address concepts and rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#vpc-eip-overview).
You must specify AllocationId and either InstanceId, NetworkInterfaceId, or PrivateIpAddress.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringThe allocation ID. This is required.
stringThe ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
You can specify either the instance ID or the network interface ID, but not both.
stringThe ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both.
stringThe primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
string
stringAWS region.
+ +For more information, see AWS::EC2::EIPAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all eip_associations in a region. +```sql +SELECT +region, +id, +allocation_id, +network_interface_id, +instance_id, +private_ip_address, +e_ip +FROM aws.ec2.eip_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual eip_association. +```sql +SELECT +region, +id, +allocation_id, +network_interface_id, +instance_id, +private_ip_address, +e_ip +FROM aws.ec2.eip_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new eip_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.eip_associations ( + AllocationId, + NetworkInterfaceId, + InstanceId, + PrivateIpAddress, + EIP, + region +) +SELECT +'{{ AllocationId }}', + '{{ NetworkInterfaceId }}', + '{{ InstanceId }}', + '{{ PrivateIpAddress }}', + '{{ EIP }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.eip_associations ( + AllocationId, + NetworkInterfaceId, + InstanceId, + PrivateIpAddress, + EIP, + region +) +SELECT + '{{ AllocationId }}', + '{{ NetworkInterfaceId }}', + '{{ InstanceId }}', + '{{ PrivateIpAddress }}', + '{{ EIP }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: eip_association + props: + - name: AllocationId + value: '{{ AllocationId }}' + - name: NetworkInterfaceId + value: '{{ NetworkInterfaceId }}' + - name: InstanceId + value: '{{ InstanceId }}' + - name: PrivateIpAddress + value: '{{ PrivateIpAddress }}' + - name: EIP + value: '{{ EIP }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.eip_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the eip_associations resource, the following permissions are required: + +### Create +```json +ec2:DescribeAddresses, +ec2:AssociateAddress +``` + +### Read +```json +ec2:DescribeAddresses +``` + +### Delete +```json +ec2:DisassociateAddress, +ec2:DescribeAddresses +``` + +### List +```json +ec2:DescribeAddresses +``` diff --git a/website/docs/services/ec2/eip_associations_list_only/index.md b/website/docs/services/ec2/eip_associations_list_only/index.md new file mode 100644 index 0000000..01d69bb --- /dev/null +++ b/website/docs/services/ec2/eip_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: eip_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - eip_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists eip_associations in a region or regions, for all properties use eip_associations + +## Overview + + + + + + + +
Nameeip_associations_list_only
TypeResource
DescriptionAssociates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. For more information about working with Elastic IP addresses, see [Elastic IP address concepts and rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#vpc-eip-overview).
You must specify AllocationId and either InstanceId, NetworkInterfaceId, or PrivateIpAddress.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all eip_associations in a region. +```sql +SELECT +region, +id +FROM aws.ec2.eip_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the eip_associations_list_only resource, see eip_associations + diff --git a/website/docs/services/ec2/eip_tags/index.md b/website/docs/services/ec2/eip_tags/index.md new file mode 100644 index 0000000..08706b0 --- /dev/null +++ b/website/docs/services/ec2/eip_tags/index.md @@ -0,0 +1,93 @@ +--- +title: eip_tags +hide_title: false +hide_table_of_contents: false +keywords: + - eip_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for eips in a region + +## Overview + + + + + + + +
Nameeip_tags
TypeResource
DescriptionSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.
For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe network (vpc).
If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
stringA unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
stringThe Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.
stringThe ID of the instance.
Updates to the InstanceId property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
stringThe ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.
Updates to the PublicIpv4Pool property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all eips in a region. +```sql +SELECT +region, +public_ip, +allocation_id, +domain, +network_border_group, +transfer_address, +instance_id, +public_ipv4_pool, +ipam_pool_id, +address, +tag_key, +tag_value +FROM aws.ec2.eip_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the eip_tags resource, see eips + diff --git a/website/docs/services/ec2/eips/index.md b/website/docs/services/ec2/eips/index.md new file mode 100644 index 0000000..1655ae6 --- /dev/null +++ b/website/docs/services/ec2/eips/index.md @@ -0,0 +1,275 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an eip resource or lists eips in a region + +## Overview + + + + + + + +
Nameeips
TypeResource
DescriptionSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.
For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe network (vpc).
If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
stringA unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
stringThe Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.
stringThe ID of the instance.
Updates to the InstanceId property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
stringThe ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.
Updates to the PublicIpv4Pool property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
string
string
arrayAny tags assigned to the Elastic IP address.
Updates to the Tags property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
stringAWS region.
+ +For more information, see AWS::EC2::EIP. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all eips in a region. +```sql +SELECT +region, +public_ip, +allocation_id, +domain, +network_border_group, +transfer_address, +instance_id, +public_ipv4_pool, +ipam_pool_id, +address, +tags +FROM aws.ec2.eips +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual eip. +```sql +SELECT +region, +public_ip, +allocation_id, +domain, +network_border_group, +transfer_address, +instance_id, +public_ipv4_pool, +ipam_pool_id, +address, +tags +FROM aws.ec2.eips +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new eip resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.eips ( + Domain, + NetworkBorderGroup, + TransferAddress, + InstanceId, + PublicIpv4Pool, + IpamPoolId, + Address, + Tags, + region +) +SELECT +'{{ Domain }}', + '{{ NetworkBorderGroup }}', + '{{ TransferAddress }}', + '{{ InstanceId }}', + '{{ PublicIpv4Pool }}', + '{{ IpamPoolId }}', + '{{ Address }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.eips ( + Domain, + NetworkBorderGroup, + TransferAddress, + InstanceId, + PublicIpv4Pool, + IpamPoolId, + Address, + Tags, + region +) +SELECT + '{{ Domain }}', + '{{ NetworkBorderGroup }}', + '{{ TransferAddress }}', + '{{ InstanceId }}', + '{{ PublicIpv4Pool }}', + '{{ IpamPoolId }}', + '{{ Address }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: eip + props: + - name: Domain + value: '{{ Domain }}' + - name: NetworkBorderGroup + value: '{{ NetworkBorderGroup }}' + - name: TransferAddress + value: '{{ TransferAddress }}' + - name: InstanceId + value: '{{ InstanceId }}' + - name: PublicIpv4Pool + value: '{{ PublicIpv4Pool }}' + - name: IpamPoolId + value: '{{ IpamPoolId }}' + - name: Address + value: '{{ Address }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.eips +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeAddresses +``` + +### Delete +```json +ec2:ReleaseAddress, +ec2:DescribeAddresses, +ec2:DisassociateAddress +``` + +### Update +```json +ec2:DescribeAddresses, +ec2:DisassociateAddress, +ec2:DeleteTags, +ec2:CreateTags, +ec2:AssociateAddress +``` + +### List +```json +ec2:DescribeAddresses +``` diff --git a/website/docs/services/ec2/eips_list_only/index.md b/website/docs/services/ec2/eips_list_only/index.md new file mode 100644 index 0000000..ea77e91 --- /dev/null +++ b/website/docs/services/ec2/eips_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: eips_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - eips_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists eips in a region or regions, for all properties use eips + +## Overview + + + + + + + +
Nameeips_list_only
TypeResource
DescriptionSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.
For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all eips in a region. +```sql +SELECT +region, +public_ip, +allocation_id +FROM aws.ec2.eips_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the eips_list_only resource, see eips + diff --git a/website/docs/services/ec2/enclave_certificate_iam_role_associations/index.md b/website/docs/services/ec2/enclave_certificate_iam_role_associations/index.md new file mode 100644 index 0000000..da95fc0 --- /dev/null +++ b/website/docs/services/ec2/enclave_certificate_iam_role_associations/index.md @@ -0,0 +1,204 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an enclave_certificate_iam_role_association resource or lists 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.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.
stringThe Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
stringThe name of the Amazon S3 bucket to which the certificate was uploaded.
stringThe Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored.
stringThe ID of the AWS KMS CMK used to encrypt the private key of the certificate.
stringAWS region.
+ +For more information, see AWS::EC2::EnclaveCertificateIamRoleAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all enclave_certificate_iam_role_associations in a region. +```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_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual enclave_certificate_iam_role_association. +```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_associations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new enclave_certificate_iam_role_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.enclave_certificate_iam_role_associations ( + CertificateArn, + RoleArn, + region +) +SELECT +'{{ CertificateArn }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.enclave_certificate_iam_role_associations ( + CertificateArn, + RoleArn, + region +) +SELECT + '{{ CertificateArn }}', + '{{ RoleArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: enclave_certificate_iam_role_association + props: + - name: CertificateArn + value: '{{ CertificateArn }}' + - name: RoleArn + value: '{{ RoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.enclave_certificate_iam_role_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the enclave_certificate_iam_role_associations resource, the following permissions are required: + +### Create +```json +ec2:AssociateEnclaveCertificateIamRole, +ec2:GetAssociatedEnclaveCertificateIamRoles +``` + +### Read +```json +ec2:GetAssociatedEnclaveCertificateIamRoles +``` + +### Delete +```json +ec2:DisassociateEnclaveCertificateIamRole, +ec2:GetAssociatedEnclaveCertificateIamRoles +``` + +### List +```json +ec2:GetAssociatedEnclaveCertificateIamRoles +``` diff --git a/website/docs/services/ec2/enclave_certificate_iam_role_associations_list_only/index.md b/website/docs/services/ec2/enclave_certificate_iam_role_associations_list_only/index.md new file mode 100644 index 0000000..617c27f --- /dev/null +++ b/website/docs/services/ec2/enclave_certificate_iam_role_associations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: enclave_certificate_iam_role_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - enclave_certificate_iam_role_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists enclave_certificate_iam_role_associations in a region or regions, for all properties use enclave_certificate_iam_role_associations + +## Overview + + + + + + + +
Nameenclave_certificate_iam_role_associations_list_only
TypeResource
DescriptionAssociates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This association is based on Amazon Resource Names and it enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.
stringThe Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all enclave_certificate_iam_role_associations in a region. +```sql +SELECT +region, +certificate_arn, +role_arn +FROM aws.ec2.enclave_certificate_iam_role_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the enclave_certificate_iam_role_associations_list_only resource, see enclave_certificate_iam_role_associations + diff --git a/website/docs/services/ec2/flow_log_tags/index.md b/website/docs/services/ec2/flow_log_tags/index.md new file mode 100644 index 0000000..fa40306 --- /dev/null +++ b/website/docs/services/ec2/flow_log_tags/index.md @@ -0,0 +1,99 @@ +--- +title: flow_log_tags +hide_title: false +hide_table_of_contents: false +keywords: + - flow_log_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for flow_logs in a region + +## Overview + + + + + + + +
Nameflow_log_tags
TypeResource
DescriptionSpecifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Flow Log ID
stringThe ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
stringThe ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
stringSpecifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType.
stringSpecifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.
stringThe fields to include in the flow log record, in the order in which they should appear.
stringThe name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
integerThe maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
stringThe ID of the subnet, network interface, or VPC for which you want to create a flow log.
stringThe type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
stringThe type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all flow_logs in a region. +```sql +SELECT +region, +id, +deliver_cross_account_role, +deliver_logs_permission_arn, +log_destination, +log_destination_type, +log_format, +log_group_name, +max_aggregation_interval, +resource_id, +resource_type, +traffic_type, +destination_options, +tag_key, +tag_value +FROM aws.ec2.flow_log_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_log_tags resource, see flow_logs + diff --git a/website/docs/services/ec2/flow_logs/index.md b/website/docs/services/ec2/flow_logs/index.md new file mode 100644 index 0000000..bc843c0 --- /dev/null +++ b/website/docs/services/ec2/flow_logs/index.md @@ -0,0 +1,291 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flow_log resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Flow Log ID
stringThe ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
stringThe ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
stringSpecifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType.
stringSpecifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.
stringThe fields to include in the flow log record, in the order in which they should appear.
stringThe name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
integerThe maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
stringThe ID of the subnet, network interface, or VPC for which you want to create a flow log.
stringThe type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
arrayThe tags to apply to the flow logs.
stringThe type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
object
stringAWS region.
+ +For more information, see AWS::EC2::FlowLog. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flow_logs in a region. +```sql +SELECT +region, +id, +deliver_cross_account_role, +deliver_logs_permission_arn, +log_destination, +log_destination_type, +log_format, +log_group_name, +max_aggregation_interval, +resource_id, +resource_type, +tags, +traffic_type, +destination_options +FROM aws.ec2.flow_logs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flow_log. +```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_logs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flow_log resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.flow_logs ( + ResourceId, + ResourceType, + region +) +SELECT +'{{ ResourceId }}', + '{{ ResourceType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.flow_logs ( + DeliverCrossAccountRole, + DeliverLogsPermissionArn, + LogDestination, + LogDestinationType, + LogFormat, + LogGroupName, + MaxAggregationInterval, + ResourceId, + ResourceType, + Tags, + TrafficType, + DestinationOptions, + region +) +SELECT + '{{ DeliverCrossAccountRole }}', + '{{ DeliverLogsPermissionArn }}', + '{{ LogDestination }}', + '{{ LogDestinationType }}', + '{{ LogFormat }}', + '{{ LogGroupName }}', + '{{ MaxAggregationInterval }}', + '{{ ResourceId }}', + '{{ ResourceType }}', + '{{ Tags }}', + '{{ TrafficType }}', + '{{ DestinationOptions }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flow_log + props: + - name: DeliverCrossAccountRole + value: '{{ DeliverCrossAccountRole }}' + - name: DeliverLogsPermissionArn + value: '{{ DeliverLogsPermissionArn }}' + - name: LogDestination + value: '{{ LogDestination }}' + - name: LogDestinationType + value: '{{ LogDestinationType }}' + - name: LogFormat + value: '{{ LogFormat }}' + - name: LogGroupName + value: '{{ LogGroupName }}' + - name: MaxAggregationInterval + value: '{{ MaxAggregationInterval }}' + - name: ResourceId + value: '{{ ResourceId }}' + - name: ResourceType + value: '{{ ResourceType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TrafficType + value: '{{ TrafficType }}' + - name: DestinationOptions + value: + FileFormat: '{{ FileFormat }}' + HiveCompatiblePartitions: '{{ HiveCompatiblePartitions }}' + PerHourPartition: '{{ PerHourPartition }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.flow_logs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeFlowLogs +``` + +### Update +```json +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeFlowLogs +``` + +### Delete +```json +ec2:DeleteFlowLogs, +ec2:DescribeFlowLogs, +logs:DeleteLogDelivery +``` + +### List +```json +ec2:DescribeFlowLogs +``` diff --git a/website/docs/services/ec2/flow_logs_list_only/index.md b/website/docs/services/ec2/flow_logs_list_only/index.md new file mode 100644 index 0000000..cd48a29 --- /dev/null +++ b/website/docs/services/ec2/flow_logs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: flow_logs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_logs_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_logs in a region or regions, for all properties use flow_logs + +## Overview + + + + + + + +
Nameflow_logs_list_only
TypeResource
DescriptionSpecifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Flow Log ID
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_logs in a region. +```sql +SELECT +region, +id +FROM aws.ec2.flow_logs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_logs_list_only resource, see flow_logs + diff --git a/website/docs/services/ec2/gateway_route_table_associations/index.md b/website/docs/services/ec2/gateway_route_table_associations/index.md new file mode 100644 index 0000000..b08b218 --- /dev/null +++ b/website/docs/services/ec2/gateway_route_table_associations/index.md @@ -0,0 +1,190 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a gateway_route_table_association resource or lists 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.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the route table.
stringThe ID of the gateway.
stringThe route table association ID.
stringAWS region.
+ +For more information, see AWS::EC2::GatewayRouteTableAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual gateway_route_table_association. +```sql +SELECT +region, +route_table_id, +gateway_id, +association_id +FROM aws.ec2.gateway_route_table_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new gateway_route_table_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.gateway_route_table_associations ( + RouteTableId, + GatewayId, + region +) +SELECT +'{{ RouteTableId }}', + '{{ GatewayId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.gateway_route_table_associations ( + RouteTableId, + GatewayId, + region +) +SELECT + '{{ RouteTableId }}', + '{{ GatewayId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: gateway_route_table_association + props: + - name: RouteTableId + value: '{{ RouteTableId }}' + - name: GatewayId + value: '{{ GatewayId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.gateway_route_table_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeRouteTables +``` + +### Update +```json +ec2:DescribeRouteTables, +ec2:ReplaceRouteTableAssociation +``` + +### Delete +```json +ec2:DescribeRouteTables, +ec2:DisassociateRouteTable +``` diff --git a/website/docs/services/ec2/hosts/index.md b/website/docs/services/ec2/hosts/index.md new file mode 100644 index 0000000..4fcd663 --- /dev/null +++ b/website/docs/services/ec2/hosts/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a host resource or lists hosts in a region + +## Overview + + + + + + + +
Namehosts
TypeResource
DescriptionResource Type definition for AWS::EC2::Host
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the host created.
stringIndicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.
stringThe Availability Zone in which to allocate the Dedicated Host.
stringIndicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
stringSpecifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
stringSpecifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
stringThe Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
stringAutomatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
stringThe ID of the Outpost hardware asset.
stringAWS region.
+ +For more information, see AWS::EC2::Host. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all hosts in a region. +```sql +SELECT +region, +host_id, +auto_placement, +availability_zone, +host_recovery, +instance_type, +instance_family, +outpost_arn, +host_maintenance, +asset_id +FROM aws.ec2.hosts +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual host. +```sql +SELECT +region, +host_id, +auto_placement, +availability_zone, +host_recovery, +instance_type, +instance_family, +outpost_arn, +host_maintenance, +asset_id +FROM aws.ec2.hosts +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new host resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.hosts ( + AvailabilityZone, + region +) +SELECT +'{{ AvailabilityZone }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.hosts ( + AutoPlacement, + AvailabilityZone, + HostRecovery, + InstanceType, + InstanceFamily, + OutpostArn, + HostMaintenance, + AssetId, + region +) +SELECT + '{{ AutoPlacement }}', + '{{ AvailabilityZone }}', + '{{ HostRecovery }}', + '{{ InstanceType }}', + '{{ InstanceFamily }}', + '{{ OutpostArn }}', + '{{ HostMaintenance }}', + '{{ AssetId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: host + props: + - name: AutoPlacement + value: '{{ AutoPlacement }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: HostRecovery + value: '{{ HostRecovery }}' + - name: InstanceType + value: '{{ InstanceType }}' + - name: InstanceFamily + value: '{{ InstanceFamily }}' + - name: OutpostArn + value: '{{ OutpostArn }}' + - name: HostMaintenance + value: '{{ HostMaintenance }}' + - name: AssetId + value: '{{ AssetId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.hosts +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the hosts resource, the following permissions are required: + +### Create +```json +ec2:AllocateHosts, +ec2:DescribeHosts +``` + +### Read +```json +ec2:DescribeHosts +``` + +### Update +```json +ec2:ModifyHosts, +ec2:DescribeHosts +``` + +### Delete +```json +ec2:ReleaseHosts, +ec2:DescribeHosts +``` + +### List +```json +ec2:DescribeHosts +``` diff --git a/website/docs/services/ec2/hosts_list_only/index.md b/website/docs/services/ec2/hosts_list_only/index.md new file mode 100644 index 0000000..f343bd7 --- /dev/null +++ b/website/docs/services/ec2/hosts_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: hosts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hosts_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hosts in a region or regions, for all properties use hosts + +## Overview + + + + + + + +
Namehosts_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::Host
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringID of the host created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hosts in a region. +```sql +SELECT +region, +host_id +FROM aws.ec2.hosts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hosts_list_only resource, see hosts + diff --git a/website/docs/services/ec2/index.md b/website/docs/services/ec2/index.md new file mode 100644 index 0000000..55642d7 --- /dev/null +++ b/website/docs/services/ec2/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The ec2 service documentation. + +:::info Service Summary + +
+
+total resources: 216
+
+
+ +::: + +## Resources +
+
+capacity_reservation_fleets
+capacity_reservation_fleets_list_only
+capacity_reservations
+capacity_reservations_list_only
+carrier_gateway_tags
+carrier_gateways
+carrier_gateways_list_only
+customer_gateway_tags
+customer_gateways
+customer_gateways_list_only
+dhcp_options
+dhcp_options_list_only
+dhcp_options_tags
+ec2fleets
+ec2fleets_list_only
+egress_only_internet_gateways
+egress_only_internet_gateways_list_only
+eip_associations
+eip_associations_list_only
+eip_tags
+eips
+eips_list_only
+enclave_certificate_iam_role_associations
+enclave_certificate_iam_role_associations_list_only
+flow_log_tags
+flow_logs
+flow_logs_list_only
+gateway_route_table_associations
+hosts
+hosts_list_only
+instance_connect_endpoint_tags
+instance_connect_endpoints
+instance_connect_endpoints_list_only
+instance_tags
+instances
+instances_list_only
+internet_gateway_tags
+internet_gateways
+internet_gateways_list_only
+ipam_allocations
+ipam_allocations_list_only
+ipam_pool_cidrs
+ipam_pool_cidrs_list_only
+ipam_pool_tags
+ipam_pools
+ipam_pools_list_only
+ipam_resource_discoveries
+ipam_resource_discoveries_list_only
+ipam_resource_discovery_association_tags
+ipam_resource_discovery_associations
+ipam_resource_discovery_associations_list_only
+ipam_resource_discovery_tags
+ipam_scope_tags
+ipam_scopes
+ipam_scopes_list_only
+ipam_tags
+ipams
+ipams_list_only
+key_pair_tags
+key_pairs
+key_pairs_list_only
+launch_templates
+launch_templates_list_only
+local_gateway_route_table_tags
+local_gateway_route_table_virtual_interface_group_association_tags
+local_gateway_route_table_virtual_interface_group_associations
+local_gateway_route_table_virtual_interface_group_associations_list_only
+local_gateway_route_tables
+local_gateway_route_tables_list_only
+local_gateway_route_tablevpc_association_tags
+local_gateway_route_tablevpc_associations
+local_gateway_route_tablevpc_associations_list_only
+local_gateway_routes
+local_gateway_routes_list_only
+nat_gateway_tags
+nat_gateways
+nat_gateways_list_only
+network_acl_tags
+network_acls
+network_acls_list_only
+network_insights_access_scope_analyses
+network_insights_access_scope_analyses_list_only
+network_insights_access_scope_analysis_tags
+network_insights_access_scope_tags
+network_insights_access_scopes
+network_insights_access_scopes_list_only
+network_insights_analyses
+network_insights_analyses_list_only
+network_insights_analysis_tags
+network_insights_path_tags
+network_insights_paths
+network_insights_paths_list_only
+network_interface_attachments
+network_interface_attachments_list_only
+network_interface_tags
+network_interfaces
+network_interfaces_list_only
+network_performance_metric_subscriptions
+network_performance_metric_subscriptions_list_only
+placement_group_tags
+placement_groups
+placement_groups_list_only
+prefix_list_tags
+prefix_lists
+prefix_lists_list_only
+route_table_tags
+route_tables
+route_tables_list_only +
+
+routes
+routes_list_only
+security_group_egresses
+security_group_egresses_list_only
+security_group_ingresses
+security_group_ingresses_list_only
+security_group_tags
+security_group_vpc_associations
+security_group_vpc_associations_list_only
+security_groups
+security_groups_list_only
+snapshot_block_public_accesses
+snapshot_block_public_accesses_list_only
+spot_fleets
+spot_fleets_list_only
+subnet_cidr_blocks
+subnet_cidr_blocks_list_only
+subnet_network_acl_associations
+subnet_network_acl_associations_list_only
+subnet_route_table_associations
+subnet_route_table_associations_list_only
+subnet_tags
+subnets
+subnets_list_only
+transit_gateway_attachment_tags
+transit_gateway_attachments
+transit_gateway_attachments_list_only
+transit_gateway_connect_tags
+transit_gateway_connects
+transit_gateway_connects_list_only
+transit_gateway_multicast_domain_associations
+transit_gateway_multicast_domain_associations_list_only
+transit_gateway_multicast_domain_tags
+transit_gateway_multicast_domains
+transit_gateway_multicast_domains_list_only
+transit_gateway_multicast_group_members
+transit_gateway_multicast_group_members_list_only
+transit_gateway_multicast_group_sources
+transit_gateway_multicast_group_sources_list_only
+transit_gateway_peering_attachment_tags
+transit_gateway_peering_attachments
+transit_gateway_peering_attachments_list_only
+transit_gateway_route_table_associations
+transit_gateway_route_table_associations_list_only
+transit_gateway_route_table_propagations
+transit_gateway_route_table_propagations_list_only
+transit_gateway_route_table_tags
+transit_gateway_route_tables
+transit_gateway_route_tables_list_only
+transit_gateway_routes
+transit_gateway_routes_list_only
+transit_gateway_tags
+transit_gateway_vpc_attachment_tags
+transit_gateway_vpc_attachments
+transit_gateway_vpc_attachments_list_only
+transit_gateways
+transit_gateways_list_only
+verified_access_endpoint_tags
+verified_access_endpoints
+verified_access_endpoints_list_only
+verified_access_group_tags
+verified_access_groups
+verified_access_groups_list_only
+verified_access_instance_tags
+verified_access_instances
+verified_access_instances_list_only
+verified_access_trust_provider_tags
+verified_access_trust_providers
+verified_access_trust_providers_list_only
+volume_attachments
+volume_attachments_list_only
+volume_tags
+volumes
+volumes_list_only
+vpc_block_public_access_exclusion_tags
+vpc_block_public_access_exclusions
+vpc_block_public_access_exclusions_list_only
+vpc_block_public_access_options
+vpc_cidr_blocks
+vpc_cidr_blocks_list_only
+vpc_endpoint_connection_notifications
+vpc_endpoint_connection_notifications_list_only
+vpc_endpoint_service_permissions
+vpc_endpoint_service_permissions_list_only
+vpc_endpoint_service_tags
+vpc_endpoint_services
+vpc_endpoint_services_list_only
+vpc_endpoint_tags
+vpc_endpoints
+vpc_endpoints_list_only
+vpc_gateway_attachments
+vpc_gateway_attachments_list_only
+vpc_peering_connection_tags
+vpc_peering_connections
+vpc_peering_connections_list_only
+vpc_tags
+vpcdhcp_options_associations
+vpcdhcp_options_associations_list_only
+vpcs
+vpcs_list_only
+vpn_connection_routes
+vpn_connection_routes_list_only
+vpn_connection_tags
+vpn_connections
+vpn_connections_list_only
+vpn_gateway_tags
+vpn_gateways
+vpn_gateways_list_only +
+
\ No newline at end of file diff --git a/website/docs/services/ec2/instance_connect_endpoint_tags/index.md b/website/docs/services/ec2/instance_connect_endpoint_tags/index.md new file mode 100644 index 0000000..cd0b27a --- /dev/null +++ b/website/docs/services/ec2/instance_connect_endpoint_tags/index.md @@ -0,0 +1,85 @@ +--- +title: instance_connect_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_connect_endpoint_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instance_connect_endpoints in a region + +## Overview + + + + + + + +
Nameinstance_connect_endpoint_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::InstanceConnectEndpoint
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe id of the instance connect endpoint
stringThe subnet id of the instance connect endpoint
stringThe client token of the instance connect endpoint.
booleanIf true, the address of the instance connect endpoint client is preserved when connecting to the end resource
arrayThe security group IDs of the instance connect endpoint.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instance_connect_endpoints in a region. +```sql +SELECT +region, +id, +subnet_id, +client_token, +preserve_client_ip, +security_group_ids, +tag_key, +tag_value +FROM aws.ec2.instance_connect_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_connect_endpoint_tags resource, see instance_connect_endpoints + diff --git a/website/docs/services/ec2/instance_connect_endpoints/index.md b/website/docs/services/ec2/instance_connect_endpoints/index.md new file mode 100644 index 0000000..924dcdb --- /dev/null +++ b/website/docs/services/ec2/instance_connect_endpoints/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an instance_connect_endpoint resource or lists instance_connect_endpoints in a region + +## Overview + + + + + + + +
Nameinstance_connect_endpoints
TypeResource
DescriptionResource Type definition for AWS::EC2::InstanceConnectEndpoint
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe id of the instance connect endpoint
stringThe subnet id of the instance connect endpoint
stringThe client token of the instance connect endpoint.
booleanIf true, the address of the instance connect endpoint client is preserved when connecting to the end resource
arrayThe tags of the instance connect endpoint.
arrayThe security group IDs of the instance connect endpoint.
stringAWS region.
+ +For more information, see AWS::EC2::InstanceConnectEndpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all instance_connect_endpoints in a region. +```sql +SELECT +region, +id, +subnet_id, +client_token, +preserve_client_ip, +tags, +security_group_ids +FROM aws.ec2.instance_connect_endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual instance_connect_endpoint. +```sql +SELECT +region, +id, +subnet_id, +client_token, +preserve_client_ip, +tags, +security_group_ids +FROM aws.ec2.instance_connect_endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance_connect_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.instance_connect_endpoints ( + SubnetId, + region +) +SELECT +'{{ SubnetId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.instance_connect_endpoints ( + SubnetId, + ClientToken, + PreserveClientIp, + Tags, + SecurityGroupIds, + region +) +SELECT + '{{ SubnetId }}', + '{{ ClientToken }}', + '{{ PreserveClientIp }}', + '{{ Tags }}', + '{{ SecurityGroupIds }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: instance_connect_endpoint + props: + - name: SubnetId + value: '{{ SubnetId }}' + - name: ClientToken + value: '{{ ClientToken }}' + - name: PreserveClientIp + value: '{{ PreserveClientIp }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.instance_connect_endpoints +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeInstanceConnectEndpoints +``` + +### Update +```json +ec2:DescribeInstanceConnectEndpoints, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteInstanceConnectEndpoint, +ec2:DescribeInstanceConnectEndpoints +``` + +### List +```json +ec2:DescribeInstanceConnectEndpoints +``` diff --git a/website/docs/services/ec2/instance_connect_endpoints_list_only/index.md b/website/docs/services/ec2/instance_connect_endpoints_list_only/index.md new file mode 100644 index 0000000..1b9c39a --- /dev/null +++ b/website/docs/services/ec2/instance_connect_endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: instance_connect_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instance_connect_endpoints_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instance_connect_endpoints in a region or regions, for all properties use instance_connect_endpoints + +## Overview + + + + + + + +
Nameinstance_connect_endpoints_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::InstanceConnectEndpoint
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe id of the instance connect endpoint
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instance_connect_endpoints in a region. +```sql +SELECT +region, +id +FROM aws.ec2.instance_connect_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_connect_endpoints_list_only resource, see instance_connect_endpoints + diff --git a/website/docs/services/ec2/instance_tags/index.md b/website/docs/services/ec2/instance_tags/index.md new file mode 100644 index 0000000..9a0078b --- /dev/null +++ b/website/docs/services/ec2/instance_tags/index.md @@ -0,0 +1,167 @@ +--- +title: instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instances in a region + +## Overview + + + + + + + +
Nameinstance_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::Instance
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
arraythe names of the security groups. For a nondefault VPC, you must use security group IDs instead.
stringThe private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
string[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
stringThe user data to make available to the instance.
arrayThe block device mapping entries that defines the block devices to attach to the instance at launch.
stringThe IAM instance profile.
array[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.
stringThe ID of the kernel.
string[EC2-VPC] The ID of the subnet to launch the instance into.
booleanIndicates whether the instance is optimized for Amazon EBS I/O.
booleanIndicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes.
arrayAn elastic GPU to associate with the instance.
arrayAn elastic inference accelerator to associate with the instance.
arrayThe volumes to attach to the instance.
stringThe private IP address of the specified instance. For example: 10.24.34.0.
integer[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.
objectThe launch template to use to launch the instances.
objectIndicates whether the instance is enabled for AWS Nitro Enclaves.
arrayThe network interfaces to associate with the instance.
stringThe ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
stringThe instance type.
booleanSpecifies whether detailed monitoring is enabled for the instance.
stringThis property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).
objectIndicates whether an instance is enabled for hibernation.
arrayThe license configurations.
stringThe EC2 Instance ID.
stringThe public IP address of the specified instance. For example: 192.0.2.0.
stringIndicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
objectThe CPU options for the instance.
stringThe Availability Zone of the instance.
objectThe options for the instance hostname.
stringIf you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
stringThe ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
stringThe public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
arrayThe IDs of the security groups.
booleanIf you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
stringThe name of the key pair.
stringThe ID of the RAM disk to select.
booleanSpecifies whether to enable an instance launched in a VPC to perform NAT.
stringThe name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
arrayThe SSM document and parameter values in AWS Systems Manager to associate with this instance.
stringThe ID of the VPC that the instance is running in.
objectThe current state of the instance.
stringIndicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
objectThe credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instances in a region. +```sql +SELECT +region, +tenancy, +security_groups, +private_dns_name, +private_ip_address, +user_data, +block_device_mappings, +iam_instance_profile, +ipv6_addresses, +kernel_id, +subnet_id, +ebs_optimized, +propagate_tags_to_volume_on_creation, +elastic_gpu_specifications, +elastic_inference_accelerators, +volumes, +private_ip, +ipv6_address_count, +launch_template, +enclave_options, +network_interfaces, +image_id, +instance_type, +monitoring, +additional_info, +hibernation_options, +license_specifications, +instance_id, +public_ip, +instance_initiated_shutdown_behavior, +cpu_options, +availability_zone, +private_dns_name_options, +host_id, +host_resource_group_arn, +public_dns_name, +security_group_ids, +disable_api_termination, +key_name, +ramdisk_id, +source_dest_check, +placement_group_name, +ssm_associations, +vpc_id, +state, +affinity, +credit_specification, +tag_key, +tag_value +FROM aws.ec2.instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_tags resource, see instances + diff --git a/website/docs/services/ec2/instances/index.md b/website/docs/services/ec2/instances/index.md new file mode 100644 index 0000000..f584872 --- /dev/null +++ b/website/docs/services/ec2/instances/index.md @@ -0,0 +1,722 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an instance resource or lists instances in a region + +## Overview + + + + + + + +
Nameinstances
TypeResource
DescriptionResource Type definition for AWS::EC2::Instance
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
arraythe names of the security groups. For a nondefault VPC, you must use security group IDs instead.
stringThe private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
string[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
stringThe user data to make available to the instance.
arrayThe block device mapping entries that defines the block devices to attach to the instance at launch.
stringThe IAM instance profile.
array[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.
stringThe ID of the kernel.
string[EC2-VPC] The ID of the subnet to launch the instance into.
booleanIndicates whether the instance is optimized for Amazon EBS I/O.
booleanIndicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes.
arrayAn elastic GPU to associate with the instance.
arrayAn elastic inference accelerator to associate with the instance.
arrayThe volumes to attach to the instance.
stringThe private IP address of the specified instance. For example: 10.24.34.0.
integer[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.
objectThe launch template to use to launch the instances.
objectIndicates whether the instance is enabled for AWS Nitro Enclaves.
arrayThe network interfaces to associate with the instance.
stringThe ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
stringThe instance type.
booleanSpecifies whether detailed monitoring is enabled for the instance.
arrayThe tags to add to the instance.
stringThis property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).
objectIndicates whether an instance is enabled for hibernation.
arrayThe license configurations.
stringThe EC2 Instance ID.
stringThe public IP address of the specified instance. For example: 192.0.2.0.
stringIndicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
objectThe CPU options for the instance.
stringThe Availability Zone of the instance.
objectThe options for the instance hostname.
stringIf you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
stringThe ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
stringThe public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
arrayThe IDs of the security groups.
booleanIf you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
stringThe name of the key pair.
stringThe ID of the RAM disk to select.
booleanSpecifies whether to enable an instance launched in a VPC to perform NAT.
stringThe name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
arrayThe SSM document and parameter values in AWS Systems Manager to associate with this instance.
stringThe ID of the VPC that the instance is running in.
objectThe current state of the instance.
stringIndicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
objectThe credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
stringAWS region.
+ +For more information, see AWS::EC2::Instance. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all instances in a region. +```sql +SELECT +region, +tenancy, +security_groups, +private_dns_name, +private_ip_address, +user_data, +block_device_mappings, +iam_instance_profile, +ipv6_addresses, +kernel_id, +subnet_id, +ebs_optimized, +propagate_tags_to_volume_on_creation, +elastic_gpu_specifications, +elastic_inference_accelerators, +volumes, +private_ip, +ipv6_address_count, +launch_template, +enclave_options, +network_interfaces, +image_id, +instance_type, +monitoring, +tags, +additional_info, +hibernation_options, +license_specifications, +instance_id, +public_ip, +instance_initiated_shutdown_behavior, +cpu_options, +availability_zone, +private_dns_name_options, +host_id, +host_resource_group_arn, +public_dns_name, +security_group_ids, +disable_api_termination, +key_name, +ramdisk_id, +source_dest_check, +placement_group_name, +ssm_associations, +vpc_id, +state, +affinity, +credit_specification +FROM aws.ec2.instances +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual instance. +```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, +state, +affinity, +credit_specification +FROM aws.ec2.instances +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.instances ( + Tenancy, + SecurityGroups, + PrivateIpAddress, + UserData, + BlockDeviceMappings, + IamInstanceProfile, + Ipv6Addresses, + KernelId, + SubnetId, + EbsOptimized, + PropagateTagsToVolumeOnCreation, + ElasticGpuSpecifications, + ElasticInferenceAccelerators, + Volumes, + Ipv6AddressCount, + LaunchTemplate, + EnclaveOptions, + NetworkInterfaces, + ImageId, + InstanceType, + Monitoring, + Tags, + AdditionalInfo, + HibernationOptions, + LicenseSpecifications, + InstanceInitiatedShutdownBehavior, + CpuOptions, + AvailabilityZone, + PrivateDnsNameOptions, + HostId, + HostResourceGroupArn, + SecurityGroupIds, + DisableApiTermination, + KeyName, + RamdiskId, + SourceDestCheck, + PlacementGroupName, + SsmAssociations, + Affinity, + CreditSpecification, + region +) +SELECT +'{{ Tenancy }}', + '{{ SecurityGroups }}', + '{{ PrivateIpAddress }}', + '{{ UserData }}', + '{{ BlockDeviceMappings }}', + '{{ IamInstanceProfile }}', + '{{ Ipv6Addresses }}', + '{{ KernelId }}', + '{{ SubnetId }}', + '{{ EbsOptimized }}', + '{{ PropagateTagsToVolumeOnCreation }}', + '{{ ElasticGpuSpecifications }}', + '{{ ElasticInferenceAccelerators }}', + '{{ Volumes }}', + '{{ Ipv6AddressCount }}', + '{{ LaunchTemplate }}', + '{{ EnclaveOptions }}', + '{{ NetworkInterfaces }}', + '{{ ImageId }}', + '{{ InstanceType }}', + '{{ Monitoring }}', + '{{ Tags }}', + '{{ AdditionalInfo }}', + '{{ HibernationOptions }}', + '{{ LicenseSpecifications }}', + '{{ InstanceInitiatedShutdownBehavior }}', + '{{ CpuOptions }}', + '{{ AvailabilityZone }}', + '{{ PrivateDnsNameOptions }}', + '{{ HostId }}', + '{{ HostResourceGroupArn }}', + '{{ SecurityGroupIds }}', + '{{ DisableApiTermination }}', + '{{ KeyName }}', + '{{ RamdiskId }}', + '{{ SourceDestCheck }}', + '{{ PlacementGroupName }}', + '{{ SsmAssociations }}', + '{{ Affinity }}', + '{{ CreditSpecification }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.instances ( + Tenancy, + SecurityGroups, + PrivateIpAddress, + UserData, + BlockDeviceMappings, + IamInstanceProfile, + Ipv6Addresses, + KernelId, + SubnetId, + EbsOptimized, + PropagateTagsToVolumeOnCreation, + ElasticGpuSpecifications, + ElasticInferenceAccelerators, + Volumes, + Ipv6AddressCount, + LaunchTemplate, + EnclaveOptions, + NetworkInterfaces, + ImageId, + InstanceType, + Monitoring, + Tags, + AdditionalInfo, + HibernationOptions, + LicenseSpecifications, + InstanceInitiatedShutdownBehavior, + CpuOptions, + AvailabilityZone, + PrivateDnsNameOptions, + HostId, + HostResourceGroupArn, + SecurityGroupIds, + DisableApiTermination, + KeyName, + RamdiskId, + SourceDestCheck, + PlacementGroupName, + SsmAssociations, + Affinity, + CreditSpecification, + region +) +SELECT + '{{ Tenancy }}', + '{{ SecurityGroups }}', + '{{ PrivateIpAddress }}', + '{{ UserData }}', + '{{ BlockDeviceMappings }}', + '{{ IamInstanceProfile }}', + '{{ Ipv6Addresses }}', + '{{ KernelId }}', + '{{ SubnetId }}', + '{{ EbsOptimized }}', + '{{ PropagateTagsToVolumeOnCreation }}', + '{{ ElasticGpuSpecifications }}', + '{{ ElasticInferenceAccelerators }}', + '{{ Volumes }}', + '{{ Ipv6AddressCount }}', + '{{ LaunchTemplate }}', + '{{ EnclaveOptions }}', + '{{ NetworkInterfaces }}', + '{{ ImageId }}', + '{{ InstanceType }}', + '{{ Monitoring }}', + '{{ Tags }}', + '{{ AdditionalInfo }}', + '{{ HibernationOptions }}', + '{{ LicenseSpecifications }}', + '{{ InstanceInitiatedShutdownBehavior }}', + '{{ CpuOptions }}', + '{{ AvailabilityZone }}', + '{{ PrivateDnsNameOptions }}', + '{{ HostId }}', + '{{ HostResourceGroupArn }}', + '{{ SecurityGroupIds }}', + '{{ DisableApiTermination }}', + '{{ KeyName }}', + '{{ RamdiskId }}', + '{{ SourceDestCheck }}', + '{{ PlacementGroupName }}', + '{{ SsmAssociations }}', + '{{ Affinity }}', + '{{ CreditSpecification }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: instance + props: + - name: Tenancy + value: '{{ Tenancy }}' + - name: SecurityGroups + value: + - '{{ SecurityGroups[0] }}' + - name: PrivateIpAddress + value: '{{ PrivateIpAddress }}' + - name: UserData + value: '{{ UserData }}' + - name: BlockDeviceMappings + value: + - DeviceName: '{{ DeviceName }}' + Ebs: + DeleteOnTermination: '{{ DeleteOnTermination }}' + Encrypted: '{{ Encrypted }}' + Iops: '{{ Iops }}' + SnapshotId: '{{ SnapshotId }}' + VolumeSize: '{{ VolumeSize }}' + VolumeType: '{{ VolumeType }}' + NoDevice: '{{ NoDevice }}' + VirtualName: '{{ VirtualName }}' + - name: IamInstanceProfile + value: '{{ IamInstanceProfile }}' + - name: Ipv6Addresses + value: + - Ipv6Address: '{{ Ipv6Address }}' + - name: KernelId + value: '{{ KernelId }}' + - name: SubnetId + value: '{{ SubnetId }}' + - name: EbsOptimized + value: '{{ EbsOptimized }}' + - name: PropagateTagsToVolumeOnCreation + value: '{{ PropagateTagsToVolumeOnCreation }}' + - name: ElasticGpuSpecifications + value: + - Type: '{{ Type }}' + - name: ElasticInferenceAccelerators + value: + - Type: '{{ Type }}' + Count: '{{ Count }}' + - name: Volumes + value: + - MultiAttachEnabled: '{{ MultiAttachEnabled }}' + KmsKeyId: '{{ KmsKeyId }}' + Encrypted: '{{ Encrypted }}' + Size: '{{ Size }}' + AutoEnableIO: '{{ AutoEnableIO }}' + OutpostArn: '{{ OutpostArn }}' + AvailabilityZone: '{{ AvailabilityZone }}' + Throughput: '{{ Throughput }}' + Iops: '{{ Iops }}' + SnapshotId: '{{ SnapshotId }}' + VolumeType: '{{ VolumeType }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Ipv6AddressCount + value: '{{ Ipv6AddressCount }}' + - name: LaunchTemplate + value: + LaunchTemplateName: '{{ LaunchTemplateName }}' + Version: '{{ Version }}' + LaunchTemplateId: '{{ LaunchTemplateId }}' + - name: EnclaveOptions + value: + Enabled: '{{ Enabled }}' + - name: NetworkInterfaces + value: + - Description: '{{ Description }}' + PrivateIpAddress: '{{ PrivateIpAddress }}' + PrivateIpAddresses: + - Primary: '{{ Primary }}' + PrivateIpAddress: '{{ PrivateIpAddress }}' + SecondaryPrivateIpAddressCount: '{{ SecondaryPrivateIpAddressCount }}' + Ipv6PrefixCount: '{{ Ipv6PrefixCount }}' + Ipv4Prefixes: + - Ipv4Prefix: '{{ Ipv4Prefix }}' + Ipv4PrefixCount: '{{ Ipv4PrefixCount }}' + EnablePrimaryIpv6: '{{ EnablePrimaryIpv6 }}' + GroupSet: + - '{{ GroupSet[0] }}' + Ipv6Addresses: + - null + Ipv6Prefixes: + - Ipv6Prefix: '{{ Ipv6Prefix }}' + SubnetId: '{{ SubnetId }}' + SourceDestCheck: '{{ SourceDestCheck }}' + InterfaceType: '{{ InterfaceType }}' + Ipv6AddressCount: '{{ Ipv6AddressCount }}' + Tags: + - null + ConnectionTrackingSpecification: + UdpTimeout: '{{ UdpTimeout }}' + TcpEstablishedTimeout: '{{ TcpEstablishedTimeout }}' + UdpStreamTimeout: '{{ UdpStreamTimeout }}' + - name: ImageId + value: '{{ ImageId }}' + - name: InstanceType + value: '{{ InstanceType }}' + - name: Monitoring + value: '{{ Monitoring }}' + - name: Tags + value: + - null + - name: AdditionalInfo + value: '{{ AdditionalInfo }}' + - name: HibernationOptions + value: + Configured: '{{ Configured }}' + - name: LicenseSpecifications + value: + - LicenseConfigurationArn: '{{ LicenseConfigurationArn }}' + - name: InstanceInitiatedShutdownBehavior + value: '{{ InstanceInitiatedShutdownBehavior }}' + - name: CpuOptions + value: + ThreadsPerCore: '{{ ThreadsPerCore }}' + CoreCount: '{{ CoreCount }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: PrivateDnsNameOptions + value: + EnableResourceNameDnsARecord: '{{ EnableResourceNameDnsARecord }}' + HostnameType: '{{ HostnameType }}' + EnableResourceNameDnsAAAARecord: '{{ EnableResourceNameDnsAAAARecord }}' + - name: HostId + value: '{{ HostId }}' + - name: HostResourceGroupArn + value: '{{ HostResourceGroupArn }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: DisableApiTermination + value: '{{ DisableApiTermination }}' + - name: KeyName + value: '{{ KeyName }}' + - name: RamdiskId + value: '{{ RamdiskId }}' + - name: SourceDestCheck + value: '{{ SourceDestCheck }}' + - name: PlacementGroupName + value: '{{ PlacementGroupName }}' + - name: SsmAssociations + value: + - AssociationParameters: + - Value: + - '{{ Value[0] }}' + Key: '{{ Key }}' + DocumentName: '{{ DocumentName }}' + - name: Affinity + value: '{{ Affinity }}' + - name: CreditSpecification + value: + CPUCredits: '{{ CPUCredits }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.instances +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the instances 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 +``` + +### 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 +``` + +### 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 +``` + +### List +```json +ec2:DescribeInstances +``` + +### 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/website/docs/services/ec2/instances_list_only/index.md b/website/docs/services/ec2/instances_list_only/index.md new file mode 100644 index 0000000..033b209 --- /dev/null +++ b/website/docs/services/ec2/instances_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instances_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instances in a region or regions, for all properties use instances + +## Overview + + + + + + + +
Nameinstances_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::Instance
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe EC2 Instance ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instances in a region. +```sql +SELECT +region, +instance_id +FROM aws.ec2.instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instances_list_only resource, see instances + diff --git a/website/docs/services/ec2/internet_gateway_tags/index.md b/website/docs/services/ec2/internet_gateway_tags/index.md new file mode 100644 index 0000000..790fa97 --- /dev/null +++ b/website/docs/services/ec2/internet_gateway_tags/index.md @@ -0,0 +1,77 @@ +--- +title: internet_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - internet_gateway_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for internet_gateways in a region + +## Overview + + + + + + + +
Nameinternet_gateway_tags
TypeResource
DescriptionAllocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all internet_gateways in a region. +```sql +SELECT +region, +internet_gateway_id, +tag_key, +tag_value +FROM aws.ec2.internet_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the internet_gateway_tags resource, see internet_gateways + diff --git a/website/docs/services/ec2/internet_gateways/index.md b/website/docs/services/ec2/internet_gateways/index.md new file mode 100644 index 0000000..3ae8781 --- /dev/null +++ b/website/docs/services/ec2/internet_gateways/index.md @@ -0,0 +1,204 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an internet_gateway resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
arrayAny tags to assign to the internet gateway.
stringAWS region.
+ +For more information, see AWS::EC2::InternetGateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all internet_gateways in a region. +```sql +SELECT +region, +internet_gateway_id, +tags +FROM aws.ec2.internet_gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual internet_gateway. +```sql +SELECT +region, +internet_gateway_id, +tags +FROM aws.ec2.internet_gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new internet_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.internet_gateways ( + Tags, + region +) +SELECT +'{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.internet_gateways ( + Tags, + region +) +SELECT + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: internet_gateway + props: + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.internet_gateways +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeInternetGateways +``` + +### Delete +```json +ec2:DeleteInternetGateway, +ec2:DescribeInternetGateways +``` + +### Update +```json +ec2:DeleteTags, +ec2:CreateTags, +ec2:DescribeInternetGateways +``` + +### List +```json +ec2:DescribeInternetGateways +``` diff --git a/website/docs/services/ec2/internet_gateways_list_only/index.md b/website/docs/services/ec2/internet_gateways_list_only/index.md new file mode 100644 index 0000000..811ef6b --- /dev/null +++ b/website/docs/services/ec2/internet_gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: internet_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - internet_gateways_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists internet_gateways in a region or regions, for all properties use internet_gateways + +## Overview + + + + + + + +
Nameinternet_gateways_list_only
TypeResource
DescriptionAllocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all internet_gateways in a region. +```sql +SELECT +region, +internet_gateway_id +FROM aws.ec2.internet_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the internet_gateways_list_only resource, see internet_gateways + diff --git a/website/docs/services/ec2/ipam_allocations/index.md b/website/docs/services/ec2/ipam_allocations/index.md new file mode 100644 index 0000000..5b4ead3 --- /dev/null +++ b/website/docs/services/ec2/ipam_allocations/index.md @@ -0,0 +1,209 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ipam_allocation resource or lists ipam_allocations in a region + +## Overview + + + + + + + +
Nameipam_allocations
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMAllocation Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringId of the allocation.
stringId of the IPAM Pool.
stringRepresents a single IPv4 or IPv6 CIDR
integerThe desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
string
stringAWS region.
+ +For more information, see AWS::EC2::IPAMAllocation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ipam_allocations in a region. +```sql +SELECT +region, +ipam_pool_allocation_id, +ipam_pool_id, +cidr, +netmask_length, +description +FROM aws.ec2.ipam_allocations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ipam_allocation. +```sql +SELECT +region, +ipam_pool_allocation_id, +ipam_pool_id, +cidr, +netmask_length, +description +FROM aws.ec2.ipam_allocations +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ipam_allocation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_allocations ( + IpamPoolId, + region +) +SELECT +'{{ IpamPoolId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_allocations ( + IpamPoolId, + Cidr, + NetmaskLength, + Description, + region +) +SELECT + '{{ IpamPoolId }}', + '{{ Cidr }}', + '{{ NetmaskLength }}', + '{{ Description }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ipam_allocation + props: + - name: IpamPoolId + value: '{{ IpamPoolId }}' + - name: Cidr + value: '{{ Cidr }}' + - name: NetmaskLength + value: '{{ NetmaskLength }}' + - name: Description + value: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.ipam_allocations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ipam_allocations resource, the following permissions are required: + +### Create +```json +ec2:AllocateIpamPoolCidr, +ec2:GetIpamPoolAllocations +``` + +### Read +```json +ec2:GetIpamPoolAllocations +``` + +### Delete +```json +ec2:ReleaseIpamPoolAllocation +``` + +### List +```json +ec2:GetIpamPoolAllocations +``` diff --git a/website/docs/services/ec2/ipam_allocations_list_only/index.md b/website/docs/services/ec2/ipam_allocations_list_only/index.md new file mode 100644 index 0000000..5426d2f --- /dev/null +++ b/website/docs/services/ec2/ipam_allocations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: ipam_allocations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_allocations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_allocations in a region or regions, for all properties use ipam_allocations + +## Overview + + + + + + + +
Nameipam_allocations_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMAllocation Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringId of the allocation.
stringId of the IPAM Pool.
stringRepresents a single IPv4 or IPv6 CIDR
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_allocations in a region. +```sql +SELECT +region, +ipam_pool_id, +ipam_pool_allocation_id, +cidr +FROM aws.ec2.ipam_allocations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_allocations_list_only resource, see ipam_allocations + diff --git a/website/docs/services/ec2/ipam_pool_cidrs/index.md b/website/docs/services/ec2/ipam_pool_cidrs/index.md new file mode 100644 index 0000000..bd6d9bb --- /dev/null +++ b/website/docs/services/ec2/ipam_pool_cidrs/index.md @@ -0,0 +1,206 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ipam_pool_cidr resource or lists ipam_pool_cidrs in a region + +## Overview + + + + + + + +
Nameipam_pool_cidrs
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPoolCidr Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool Cidr.
stringId of the IPAM Pool.
stringRepresents a single IPv4 or IPv6 CIDR
integerThe desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
stringProvisioned state of the cidr.
stringAWS region.
+ +For more information, see AWS::EC2::IPAMPoolCidr. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ipam_pool_cidrs in a region. +```sql +SELECT +region, +ipam_pool_cidr_id, +ipam_pool_id, +cidr, +netmask_length, +state +FROM aws.ec2.ipam_pool_cidrs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ipam_pool_cidr. +```sql +SELECT +region, +ipam_pool_cidr_id, +ipam_pool_id, +cidr, +netmask_length, +state +FROM aws.ec2.ipam_pool_cidrs +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ipam_pool_cidr resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_pool_cidrs ( + IpamPoolId, + region +) +SELECT +'{{ IpamPoolId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_pool_cidrs ( + IpamPoolId, + Cidr, + NetmaskLength, + region +) +SELECT + '{{ IpamPoolId }}', + '{{ Cidr }}', + '{{ NetmaskLength }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ipam_pool_cidr + props: + - name: IpamPoolId + value: '{{ IpamPoolId }}' + - name: Cidr + value: '{{ Cidr }}' + - name: NetmaskLength + value: '{{ NetmaskLength }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.ipam_pool_cidrs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ipam_pool_cidrs resource, the following permissions are required: + +### Create +```json +ec2:ProvisionIpamPoolCidr, +ec2:GetIpamPoolCidrs +``` + +### Read +```json +ec2:GetIpamPoolCidrs +``` + +### Delete +```json +ec2:DeprovisionIpamPoolCidr, +ec2:GetIpamPoolCidrs +``` + +### List +```json +ec2:GetIpamPoolCidrs +``` diff --git a/website/docs/services/ec2/ipam_pool_cidrs_list_only/index.md b/website/docs/services/ec2/ipam_pool_cidrs_list_only/index.md new file mode 100644 index 0000000..ff8ca12 --- /dev/null +++ b/website/docs/services/ec2/ipam_pool_cidrs_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: ipam_pool_cidrs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pool_cidrs_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_pool_cidrs in a region or regions, for all properties use ipam_pool_cidrs + +## Overview + + + + + + + +
Nameipam_pool_cidrs_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPoolCidr Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool Cidr.
stringId of the IPAM Pool.
stringRepresents a single IPv4 or IPv6 CIDR
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_pool_cidrs in a region. +```sql +SELECT +region, +ipam_pool_id, +ipam_pool_cidr_id +FROM aws.ec2.ipam_pool_cidrs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_pool_cidrs_list_only resource, see ipam_pool_cidrs + diff --git a/website/docs/services/ec2/ipam_pool_tags/index.md b/website/docs/services/ec2/ipam_pool_tags/index.md new file mode 100644 index 0000000..be51829 --- /dev/null +++ b/website/docs/services/ec2/ipam_pool_tags/index.md @@ -0,0 +1,121 @@ +--- +title: ipam_pool_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pool_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ipam_pools in a region + +## Overview + + + + + + + +
Nameipam_pool_tags
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPool Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool.
stringThe address family of the address space in this pool. Either IPv4 or IPv6.
integerThe minimum allowed netmask length for allocations made from this pool.
integerThe default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.
integerThe maximum allowed netmask length for allocations made from this pool.
arrayWhen specified, an allocation will not be allowed unless a resource has a matching set of tags.
stringThe Amazon Resource Name (ARN) of the IPAM Pool.
booleanDetermines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.
stringLimits which service in Amazon Web Services that the pool can be used in.
string
stringThe Id of the scope this pool is a part of.
stringThe Amazon Resource Name (ARN) of the scope this pool is a part of.
stringDetermines whether this scope contains publicly routable space or space for a private network
stringThe Amazon Resource Name (ARN) of the IPAM this pool is a part of.
stringThe region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.
integerThe depth of this pool in the source pool hierarchy.
arrayA list of cidrs representing the address space available for allocation in this pool.
stringThe IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.
booleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
stringThe Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.
objectThe resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations
stringThe state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"
stringAn explanation of how the pool arrived at it current state.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ipam_pools in a region. +```sql +SELECT +region, +ipam_pool_id, +address_family, +allocation_min_netmask_length, +allocation_default_netmask_length, +allocation_max_netmask_length, +allocation_resource_tags, +arn, +auto_import, +aws_service, +description, +ipam_scope_id, +ipam_scope_arn, +ipam_scope_type, +ipam_arn, +locale, +pool_depth, +provisioned_cidrs, +public_ip_source, +publicly_advertisable, +source_ipam_pool_id, +source_resource, +state, +state_message, +tag_key, +tag_value +FROM aws.ec2.ipam_pool_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_pool_tags resource, see ipam_pools + diff --git a/website/docs/services/ec2/ipam_pools/index.md b/website/docs/services/ec2/ipam_pools/index.md new file mode 100644 index 0000000..a88c952 --- /dev/null +++ b/website/docs/services/ec2/ipam_pools/index.md @@ -0,0 +1,348 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ipam_pool resource or lists ipam_pools in a region + +## Overview + + + + + + + +
Nameipam_pools
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPool Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool.
stringThe address family of the address space in this pool. Either IPv4 or IPv6.
integerThe minimum allowed netmask length for allocations made from this pool.
integerThe default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.
integerThe maximum allowed netmask length for allocations made from this pool.
arrayWhen specified, an allocation will not be allowed unless a resource has a matching set of tags.
stringThe Amazon Resource Name (ARN) of the IPAM Pool.
booleanDetermines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.
stringLimits which service in Amazon Web Services that the pool can be used in.
string
stringThe Id of the scope this pool is a part of.
stringThe Amazon Resource Name (ARN) of the scope this pool is a part of.
stringDetermines whether this scope contains publicly routable space or space for a private network
stringThe Amazon Resource Name (ARN) of the IPAM this pool is a part of.
stringThe region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.
integerThe depth of this pool in the source pool hierarchy.
arrayA list of cidrs representing the address space available for allocation in this pool.
stringThe IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.
booleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
stringThe Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.
objectThe resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations
stringThe state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"
stringAn explanation of how the pool arrived at it current state.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EC2::IPAMPool. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ipam_pools in a region. +```sql +SELECT +region, +ipam_pool_id, +address_family, +allocation_min_netmask_length, +allocation_default_netmask_length, +allocation_max_netmask_length, +allocation_resource_tags, +arn, +auto_import, +aws_service, +description, +ipam_scope_id, +ipam_scope_arn, +ipam_scope_type, +ipam_arn, +locale, +pool_depth, +provisioned_cidrs, +public_ip_source, +publicly_advertisable, +source_ipam_pool_id, +source_resource, +state, +state_message, +tags +FROM aws.ec2.ipam_pools +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ipam_pool. +```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_pools +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ipam_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_pools ( + AddressFamily, + IpamScopeId, + region +) +SELECT +'{{ AddressFamily }}', + '{{ IpamScopeId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_pools ( + AddressFamily, + AllocationMinNetmaskLength, + AllocationDefaultNetmaskLength, + AllocationMaxNetmaskLength, + AllocationResourceTags, + AutoImport, + AwsService, + Description, + IpamScopeId, + Locale, + ProvisionedCidrs, + PublicIpSource, + PubliclyAdvertisable, + SourceIpamPoolId, + SourceResource, + Tags, + region +) +SELECT + '{{ AddressFamily }}', + '{{ AllocationMinNetmaskLength }}', + '{{ AllocationDefaultNetmaskLength }}', + '{{ AllocationMaxNetmaskLength }}', + '{{ AllocationResourceTags }}', + '{{ AutoImport }}', + '{{ AwsService }}', + '{{ Description }}', + '{{ IpamScopeId }}', + '{{ Locale }}', + '{{ ProvisionedCidrs }}', + '{{ PublicIpSource }}', + '{{ PubliclyAdvertisable }}', + '{{ SourceIpamPoolId }}', + '{{ SourceResource }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ipam_pool + props: + - name: AddressFamily + value: '{{ AddressFamily }}' + - name: AllocationMinNetmaskLength + value: '{{ AllocationMinNetmaskLength }}' + - name: AllocationDefaultNetmaskLength + value: '{{ AllocationDefaultNetmaskLength }}' + - name: AllocationMaxNetmaskLength + value: '{{ AllocationMaxNetmaskLength }}' + - name: AllocationResourceTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AutoImport + value: '{{ AutoImport }}' + - name: AwsService + value: '{{ AwsService }}' + - name: Description + value: '{{ Description }}' + - name: IpamScopeId + value: '{{ IpamScopeId }}' + - name: Locale + value: '{{ Locale }}' + - name: ProvisionedCidrs + value: + - Cidr: '{{ Cidr }}' + - name: PublicIpSource + value: '{{ PublicIpSource }}' + - name: PubliclyAdvertisable + value: '{{ PubliclyAdvertisable }}' + - name: SourceIpamPoolId + value: '{{ SourceIpamPoolId }}' + - name: SourceResource + value: + ResourceId: '{{ ResourceId }}' + ResourceType: '{{ ResourceType }}' + ResourceRegion: '{{ ResourceRegion }}' + ResourceOwner: '{{ ResourceOwner }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.ipam_pools +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ec2:DescribeIpamPools +``` diff --git a/website/docs/services/ec2/ipam_pools_list_only/index.md b/website/docs/services/ec2/ipam_pools_list_only/index.md new file mode 100644 index 0000000..818cb5e --- /dev/null +++ b/website/docs/services/ec2/ipam_pools_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: ipam_pools_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pools_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_pools in a region or regions, for all properties use ipam_pools + +## Overview + + + + + + + +
Nameipam_pools_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPool Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_pools in a region. +```sql +SELECT +region, +ipam_pool_id +FROM aws.ec2.ipam_pools_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_pools_list_only resource, see ipam_pools + diff --git a/website/docs/services/ec2/ipam_resource_discoveries/index.md b/website/docs/services/ec2/ipam_resource_discoveries/index.md new file mode 100644 index 0000000..39d4ab6 --- /dev/null +++ b/website/docs/services/ec2/ipam_resource_discoveries/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ipam_resource_discovery resource or lists ipam_resource_discoveries in a region + +## Overview + + + + + + + +
Nameipam_resource_discoveries
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscovery Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool.
stringOwner Account ID of the Resource Discovery
arrayThe regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
stringThe region the resource discovery is setup in.
string
booleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
stringAmazon Resource Name (Arn) for the Resource Discovery.
stringThe state of this Resource Discovery.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EC2::IPAMResourceDiscovery. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ipam_resource_discoveries in a region. +```sql +SELECT +region, +ipam_resource_discovery_id, +owner_id, +operating_regions, +ipam_resource_discovery_region, +description, +is_default, +ipam_resource_discovery_arn, +state, +tags +FROM aws.ec2.ipam_resource_discoveries +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ipam_resource_discovery. +```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_discoveries +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ipam_resource_discovery resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_resource_discoveries ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_resource_discoveries ( + OperatingRegions, + Description, + Tags, + region +) +SELECT + '{{ OperatingRegions }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ipam_resource_discovery + props: + - name: OperatingRegions + value: + - RegionName: '{{ RegionName }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.ipam_resource_discoveries +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeIpamResourceDiscoveries +``` + +### Update +```json +ec2:ModifyIpamResourceDiscovery, +ec2:DescribeIpamResourceDiscoveries, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteIpamResourceDiscovery, +ec2:DescribeIpamResourceDiscoveries, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeIpamResourceDiscoveries +``` diff --git a/website/docs/services/ec2/ipam_resource_discoveries_list_only/index.md b/website/docs/services/ec2/ipam_resource_discoveries_list_only/index.md new file mode 100644 index 0000000..0210780 --- /dev/null +++ b/website/docs/services/ec2/ipam_resource_discoveries_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: ipam_resource_discoveries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discoveries_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_resource_discoveries in a region or regions, for all properties use ipam_resource_discoveries + +## Overview + + + + + + + +
Nameipam_resource_discoveries_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscovery Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_resource_discoveries in a region. +```sql +SELECT +region, +ipam_resource_discovery_id +FROM aws.ec2.ipam_resource_discoveries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_resource_discoveries_list_only resource, see ipam_resource_discoveries + diff --git a/website/docs/services/ec2/ipam_resource_discovery_association_tags/index.md b/website/docs/services/ec2/ipam_resource_discovery_association_tags/index.md new file mode 100644 index 0000000..baa6e60 --- /dev/null +++ b/website/docs/services/ec2/ipam_resource_discovery_association_tags/index.md @@ -0,0 +1,95 @@ +--- +title: ipam_resource_discovery_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discovery_association_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ipam_resource_discovery_associations in a region + +## Overview + + + + + + + +
Nameipam_resource_discovery_association_tags
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn of the IPAM.
stringThe home region of the IPAM.
stringId of the IPAM Resource Discovery Association.
stringThe Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.
stringThe Id of the IPAM this Resource Discovery is associated to.
stringThe Amazon Resource Name (ARN) of the resource discovery association is a part of.
booleanIf the Resource Discovery Association exists due as part of CreateIpam.
stringThe AWS Account ID for the account where the shared IPAM exists.
stringThe operational state of the Resource Discovery Association. Related to Create/Delete activities.
stringThe status of the resource discovery.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ipam_resource_discovery_associations in a region. +```sql +SELECT +region, +ipam_arn, +ipam_region, +ipam_resource_discovery_association_id, +ipam_resource_discovery_id, +ipam_id, +ipam_resource_discovery_association_arn, +is_default, +owner_id, +state, +resource_discovery_status, +tag_key, +tag_value +FROM aws.ec2.ipam_resource_discovery_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_resource_discovery_association_tags resource, see ipam_resource_discovery_associations + diff --git a/website/docs/services/ec2/ipam_resource_discovery_associations/index.md b/website/docs/services/ec2/ipam_resource_discovery_associations/index.md new file mode 100644 index 0000000..6ca7840 --- /dev/null +++ b/website/docs/services/ec2/ipam_resource_discovery_associations/index.md @@ -0,0 +1,242 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ipam_resource_discovery_association resource or lists ipam_resource_discovery_associations in a region + +## Overview + + + + + + + +
Nameipam_resource_discovery_associations
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn of the IPAM.
stringThe home region of the IPAM.
stringId of the IPAM Resource Discovery Association.
stringThe Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.
stringThe Id of the IPAM this Resource Discovery is associated to.
stringThe Amazon Resource Name (ARN) of the resource discovery association is a part of.
booleanIf the Resource Discovery Association exists due as part of CreateIpam.
stringThe AWS Account ID for the account where the shared IPAM exists.
stringThe operational state of the Resource Discovery Association. Related to Create/Delete activities.
stringThe status of the resource discovery.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EC2::IPAMResourceDiscoveryAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ipam_resource_discovery_associations in a region. +```sql +SELECT +region, +ipam_arn, +ipam_region, +ipam_resource_discovery_association_id, +ipam_resource_discovery_id, +ipam_id, +ipam_resource_discovery_association_arn, +is_default, +owner_id, +state, +resource_discovery_status, +tags +FROM aws.ec2.ipam_resource_discovery_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ipam_resource_discovery_association. +```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_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ipam_resource_discovery_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_resource_discovery_associations ( + IpamResourceDiscoveryId, + IpamId, + region +) +SELECT +'{{ IpamResourceDiscoveryId }}', + '{{ IpamId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_resource_discovery_associations ( + IpamResourceDiscoveryId, + IpamId, + Tags, + region +) +SELECT + '{{ IpamResourceDiscoveryId }}', + '{{ IpamId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ipam_resource_discovery_association + props: + - name: IpamResourceDiscoveryId + value: '{{ IpamResourceDiscoveryId }}' + - name: IpamId + value: '{{ IpamId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.ipam_resource_discovery_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeIpamResourceDiscoveryAssociations +``` + +### Update +```json +ec2:DescribeIpamResourceDiscoveryAssociations, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DisassociateIpamResourceDiscovery, +ec2:DescribeIpamResourceDiscoveryAssociations, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeIpamResourceDiscoveryAssociations +``` diff --git a/website/docs/services/ec2/ipam_resource_discovery_associations_list_only/index.md b/website/docs/services/ec2/ipam_resource_discovery_associations_list_only/index.md new file mode 100644 index 0000000..053c578 --- /dev/null +++ b/website/docs/services/ec2/ipam_resource_discovery_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: ipam_resource_discovery_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discovery_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_resource_discovery_associations in a region or regions, for all properties use ipam_resource_discovery_associations + +## Overview + + + + + + + +
Nameipam_resource_discovery_associations_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId of the IPAM Resource Discovery Association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_resource_discovery_associations in a region. +```sql +SELECT +region, +ipam_resource_discovery_association_id +FROM aws.ec2.ipam_resource_discovery_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_resource_discovery_associations_list_only resource, see ipam_resource_discovery_associations + diff --git a/website/docs/services/ec2/ipam_resource_discovery_tags/index.md b/website/docs/services/ec2/ipam_resource_discovery_tags/index.md new file mode 100644 index 0000000..dfe2a11 --- /dev/null +++ b/website/docs/services/ec2/ipam_resource_discovery_tags/index.md @@ -0,0 +1,91 @@ +--- +title: ipam_resource_discovery_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discovery_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ipam_resource_discoveries in a region + +## Overview + + + + + + + +
Nameipam_resource_discovery_tags
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscovery Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool.
stringOwner Account ID of the Resource Discovery
arrayThe regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
stringThe region the resource discovery is setup in.
string
booleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
stringAmazon Resource Name (Arn) for the Resource Discovery.
stringThe state of this Resource Discovery.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ipam_resource_discoveries in a region. +```sql +SELECT +region, +ipam_resource_discovery_id, +owner_id, +operating_regions, +ipam_resource_discovery_region, +description, +is_default, +ipam_resource_discovery_arn, +state, +tag_key, +tag_value +FROM aws.ec2.ipam_resource_discovery_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_resource_discovery_tags resource, see ipam_resource_discoveries + diff --git a/website/docs/services/ec2/ipam_scope_tags/index.md b/website/docs/services/ec2/ipam_scope_tags/index.md new file mode 100644 index 0000000..45d1a51 --- /dev/null +++ b/website/docs/services/ec2/ipam_scope_tags/index.md @@ -0,0 +1,91 @@ +--- +title: ipam_scope_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_scope_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ipam_scopes in a region + +## Overview + + + + + + + +
Nameipam_scope_tags
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMScope Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM scope.
stringThe Amazon Resource Name (ARN) of the IPAM scope.
stringThe Id of the IPAM this scope is a part of.
stringThe Amazon Resource Name (ARN) of the IPAM this scope is a part of.
stringDetermines whether this scope contains publicly routable space or space for a private network
booleanIs this one of the default scopes created with the IPAM.
string
integerThe number of pools that currently exist in this scope.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ipam_scopes in a region. +```sql +SELECT +region, +ipam_scope_id, +arn, +ipam_id, +ipam_arn, +ipam_scope_type, +is_default, +description, +pool_count, +tag_key, +tag_value +FROM aws.ec2.ipam_scope_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_scope_tags resource, see ipam_scopes + diff --git a/website/docs/services/ec2/ipam_scopes/index.md b/website/docs/services/ec2/ipam_scopes/index.md new file mode 100644 index 0000000..9f20ed0 --- /dev/null +++ b/website/docs/services/ec2/ipam_scopes/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ipam_scope resource or lists ipam_scopes in a region + +## Overview + + + + + + + +
Nameipam_scopes
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMScope Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM scope.
stringThe Amazon Resource Name (ARN) of the IPAM scope.
stringThe Id of the IPAM this scope is a part of.
stringThe Amazon Resource Name (ARN) of the IPAM this scope is a part of.
stringDetermines whether this scope contains publicly routable space or space for a private network
booleanIs this one of the default scopes created with the IPAM.
string
integerThe number of pools that currently exist in this scope.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EC2::IPAMScope. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ipam_scopes in a region. +```sql +SELECT +region, +ipam_scope_id, +arn, +ipam_id, +ipam_arn, +ipam_scope_type, +is_default, +description, +pool_count, +tags +FROM aws.ec2.ipam_scopes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ipam_scope. +```sql +SELECT +region, +ipam_scope_id, +arn, +ipam_id, +ipam_arn, +ipam_scope_type, +is_default, +description, +pool_count, +tags +FROM aws.ec2.ipam_scopes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ipam_scope resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_scopes ( + IpamId, + region +) +SELECT +'{{ IpamId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipam_scopes ( + IpamId, + Description, + Tags, + region +) +SELECT + '{{ IpamId }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ipam_scope + props: + - name: IpamId + value: '{{ IpamId }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.ipam_scopes +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeIpamScopes +``` + +### Update +```json +ec2:ModifyIpamScope, +ec2:DescribeIpamScopes, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteIpamScope, +ec2:DescribeIpamScopes, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeIpamScopes +``` diff --git a/website/docs/services/ec2/ipam_scopes_list_only/index.md b/website/docs/services/ec2/ipam_scopes_list_only/index.md new file mode 100644 index 0000000..22c6fc3 --- /dev/null +++ b/website/docs/services/ec2/ipam_scopes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: ipam_scopes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_scopes_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_scopes in a region or regions, for all properties use ipam_scopes + +## Overview + + + + + + + +
Nameipam_scopes_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMScope Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId of the IPAM scope.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_scopes in a region. +```sql +SELECT +region, +ipam_scope_id +FROM aws.ec2.ipam_scopes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_scopes_list_only resource, see ipam_scopes + diff --git a/website/docs/services/ec2/ipam_tags/index.md b/website/docs/services/ec2/ipam_tags/index.md new file mode 100644 index 0000000..82bf1c8 --- /dev/null +++ b/website/docs/services/ec2/ipam_tags/index.md @@ -0,0 +1,99 @@ +--- +title: ipam_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ipams in a region + +## Overview + + + + + + + +
Nameipam_tags
TypeResource
DescriptionResource Schema of AWS::EC2::IPAM Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM.
stringThe Amazon Resource Name (ARN) of the IPAM.
stringThe Id of the default resource discovery, created with this IPAM.
stringThe Id of the default association to the default resource discovery, created with this IPAM.
integerThe count of resource discoveries associated with this IPAM.
string
stringThe Id of the default scope for publicly routable IP space, created with this IPAM.
stringThe Id of the default scope for publicly routable IP space, created with this IPAM.
integerThe number of scopes that currently exist in this IPAM.
arrayThe regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
stringThe tier of the IPAM.
booleanEnable provisioning of GUA space in private pools.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ipams in a region. +```sql +SELECT +region, +ipam_id, +arn, +default_resource_discovery_id, +default_resource_discovery_association_id, +resource_discovery_association_count, +description, +public_default_scope_id, +private_default_scope_id, +scope_count, +operating_regions, +tier, +enable_private_gua, +tag_key, +tag_value +FROM aws.ec2.ipam_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_tags resource, see ipams + diff --git a/website/docs/services/ec2/ipams/index.md b/website/docs/services/ec2/ipams/index.md new file mode 100644 index 0000000..7e18afd --- /dev/null +++ b/website/docs/services/ec2/ipams/index.md @@ -0,0 +1,257 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ipam resource or lists ipams in a region + +## Overview + + + + + + + +
Nameipams
TypeResource
DescriptionResource Schema of AWS::EC2::IPAM Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM.
stringThe Amazon Resource Name (ARN) of the IPAM.
stringThe Id of the default resource discovery, created with this IPAM.
stringThe Id of the default association to the default resource discovery, created with this IPAM.
integerThe count of resource discoveries associated with this IPAM.
string
stringThe Id of the default scope for publicly routable IP space, created with this IPAM.
stringThe Id of the default scope for publicly routable IP space, created with this IPAM.
integerThe number of scopes that currently exist in this IPAM.
arrayThe regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
stringThe tier of the IPAM.
booleanEnable provisioning of GUA space in private pools.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EC2::IPAM. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ipams in a region. +```sql +SELECT +region, +ipam_id, +arn, +default_resource_discovery_id, +default_resource_discovery_association_id, +resource_discovery_association_count, +description, +public_default_scope_id, +private_default_scope_id, +scope_count, +operating_regions, +tier, +enable_private_gua, +tags +FROM aws.ec2.ipams +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ipam. +```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, +enable_private_gua, +tags +FROM aws.ec2.ipams +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ipam resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipams ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.ipams ( + Description, + OperatingRegions, + Tier, + EnablePrivateGua, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ OperatingRegions }}', + '{{ Tier }}', + '{{ EnablePrivateGua }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ipam + props: + - name: Description + value: '{{ Description }}' + - name: OperatingRegions + value: + - RegionName: '{{ RegionName }}' + - name: Tier + value: '{{ Tier }}' + - name: EnablePrivateGua + value: '{{ EnablePrivateGua }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.ipams +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeIpams +``` + +### Update +```json +ec2:ModifyIpam, +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeIpams +``` + +### Delete +```json +ec2:DeleteIpam, +ec2:DeleteTags, +ec2:DescribeIpams +``` + +### List +```json +ec2:DescribeIpams +``` diff --git a/website/docs/services/ec2/ipams_list_only/index.md b/website/docs/services/ec2/ipams_list_only/index.md new file mode 100644 index 0000000..4ad9ffe --- /dev/null +++ b/website/docs/services/ec2/ipams_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: ipams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipams_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipams in a region or regions, for all properties use ipams + +## Overview + + + + + + + +
Nameipams_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAM Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId of the IPAM.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipams in a region. +```sql +SELECT +region, +ipam_id +FROM aws.ec2.ipams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipams_list_only resource, see ipams + diff --git a/website/docs/services/ec2/key_pair_tags/index.md b/website/docs/services/ec2/key_pair_tags/index.md new file mode 100644 index 0000000..a514552 --- /dev/null +++ b/website/docs/services/ec2/key_pair_tags/index.md @@ -0,0 +1,87 @@ +--- +title: key_pair_tags +hide_title: false +hide_table_of_contents: false +keywords: + - key_pair_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for key_pairs in a region + +## Overview + + + + + + + +
Namekey_pair_tags
TypeResource
DescriptionSpecifies a key pair for use with an EC2long instance as follows:
+ To import an existing key pair, include the PublicKeyMaterial property.
+ To create a new key pair, omit the PublicKeyMaterial property.

When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. CFNlong does not create or return the private key material when you import a key pair.
When you create a new key pair, the private key is saved to SYSlong Parameter Store, using a parameter with the following name: /ec2/keypair/{key_pair_id}. For more information about retrieving private key, and the required permissions, see [Create a key pair using](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *User Guide*.
When CFN deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringA unique name for the key pair.
Constraints: Up to 255 ASCII characters
stringThe type of key pair. Note that ED25519 keys are not supported for Windows instances.
If the PublicKeyMaterial property is specified, the KeyType property is ignored, and the key type is inferred from the PublicKeyMaterial value.
Default: rsa
stringThe format of the key pair.
Default: pem
stringThe public key material. The PublicKeyMaterial property is used to import a key pair. If this property is not specified, then a new key pair will be created.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all key_pairs in a region. +```sql +SELECT +region, +key_name, +key_type, +key_format, +public_key_material, +key_fingerprint, +key_pair_id, +tag_key, +tag_value +FROM aws.ec2.key_pair_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the key_pair_tags resource, see key_pairs + diff --git a/website/docs/services/ec2/key_pairs/index.md b/website/docs/services/ec2/key_pairs/index.md new file mode 100644 index 0000000..c52f59b --- /dev/null +++ b/website/docs/services/ec2/key_pairs/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a key_pair resource or lists key_pairs in a region + +## Overview + + + + + + + +
Namekey_pairs
TypeResource
DescriptionSpecifies a key pair for use with an EC2long instance as follows:
+ To import an existing key pair, include the PublicKeyMaterial property.
+ To create a new key pair, omit the PublicKeyMaterial property.

When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. CFNlong does not create or return the private key material when you import a key pair.
When you create a new key pair, the private key is saved to SYSlong Parameter Store, using a parameter with the following name: /ec2/keypair/{key_pair_id}. For more information about retrieving private key, and the required permissions, see [Create a key pair using](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *User Guide*.
When CFN deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA unique name for the key pair.
Constraints: Up to 255 ASCII characters
stringThe type of key pair. Note that ED25519 keys are not supported for Windows instances.
If the PublicKeyMaterial property is specified, the KeyType property is ignored, and the key type is inferred from the PublicKeyMaterial value.
Default: rsa
stringThe format of the key pair.
Default: pem
stringThe public key material. The PublicKeyMaterial property is used to import a key pair. If this property is not specified, then a new key pair will be created.
string
string
arrayThe tags to apply to the key pair.
stringAWS region.
+ +For more information, see AWS::EC2::KeyPair. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all key_pairs in a region. +```sql +SELECT +region, +key_name, +key_type, +key_format, +public_key_material, +key_fingerprint, +key_pair_id, +tags +FROM aws.ec2.key_pairs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual key_pair. +```sql +SELECT +region, +key_name, +key_type, +key_format, +public_key_material, +key_fingerprint, +key_pair_id, +tags +FROM aws.ec2.key_pairs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new key_pair resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.key_pairs ( + KeyName, + region +) +SELECT +'{{ KeyName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.key_pairs ( + KeyName, + KeyType, + KeyFormat, + PublicKeyMaterial, + Tags, + region +) +SELECT + '{{ KeyName }}', + '{{ KeyType }}', + '{{ KeyFormat }}', + '{{ PublicKeyMaterial }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: key_pair + props: + - name: KeyName + value: '{{ KeyName }}' + - name: KeyType + value: '{{ KeyType }}' + - name: KeyFormat + value: '{{ KeyFormat }}' + - name: PublicKeyMaterial + value: '{{ PublicKeyMaterial }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.key_pairs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeKeyPairs +``` + +### List +```json +ec2:DescribeKeyPairs +``` + +### Delete +```json +ec2:DeleteKeyPair, +ssm:DeleteParameter, +ec2:DescribeKeyPairs +``` diff --git a/website/docs/services/ec2/key_pairs_list_only/index.md b/website/docs/services/ec2/key_pairs_list_only/index.md new file mode 100644 index 0000000..6ef5b63 --- /dev/null +++ b/website/docs/services/ec2/key_pairs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: key_pairs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - key_pairs_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists key_pairs in a region or regions, for all properties use key_pairs + +## Overview + + + + + + + +
Namekey_pairs_list_only
TypeResource
DescriptionSpecifies a key pair for use with an EC2long instance as follows:
+ To import an existing key pair, include the PublicKeyMaterial property.
+ To create a new key pair, omit the PublicKeyMaterial property.

When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. CFNlong does not create or return the private key material when you import a key pair.
When you create a new key pair, the private key is saved to SYSlong Parameter Store, using a parameter with the following name: /ec2/keypair/{key_pair_id}. For more information about retrieving private key, and the required permissions, see [Create a key pair using](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *User Guide*.
When CFN deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique name for the key pair.
Constraints: Up to 255 ASCII characters
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all key_pairs in a region. +```sql +SELECT +region, +key_name +FROM aws.ec2.key_pairs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the key_pairs_list_only resource, see key_pairs + diff --git a/website/docs/services/ec2/launch_templates/index.md b/website/docs/services/ec2/launch_templates/index.md new file mode 100644 index 0000000..c50bc3c --- /dev/null +++ b/website/docs/services/ec2/launch_templates/index.md @@ -0,0 +1,401 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a launch_template resource or lists launch_templates in a region + +## Overview + + + + + + + +
Namelaunch_templates
TypeResource
DescriptionSpecifies the properties for creating a launch template.
The minimum required properties for specifying a launch template are as follows:
+ You must specify at least one property for the launch template data.
+ You can optionally specify a name for the launch template. If you do not specify a name, CFN creates a name for you.

A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ImageId property, which has no default value. If you do not specify an AMI ID for the launch template ImageId property, you must specify an AMI ID for the instance ImageId property.
For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA name for the launch template.
objectThe information for the launch template.
stringA description for the first version of the launch template.
arrayThe tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template.
To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications).
string
string
string
stringAWS region.
+ +For more information, see AWS::EC2::LaunchTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all launch_templates in a region. +```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_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual launch_template. +```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_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new launch_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.launch_templates ( + LaunchTemplateData, + region +) +SELECT +'{{ LaunchTemplateData }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.launch_templates ( + LaunchTemplateName, + LaunchTemplateData, + VersionDescription, + TagSpecifications, + region +) +SELECT + '{{ LaunchTemplateName }}', + '{{ LaunchTemplateData }}', + '{{ VersionDescription }}', + '{{ TagSpecifications }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: launch_template + props: + - name: LaunchTemplateName + value: '{{ LaunchTemplateName }}' + - name: LaunchTemplateData + value: + SecurityGroups: + - '{{ SecurityGroups[0] }}' + TagSpecifications: + - ResourceType: '{{ ResourceType }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + NetworkPerformanceOptions: null + UserData: '{{ UserData }}' + BlockDeviceMappings: + - DeviceName: '{{ DeviceName }}' + Ebs: + DeleteOnTermination: '{{ DeleteOnTermination }}' + Encrypted: '{{ Encrypted }}' + Iops: '{{ Iops }}' + SnapshotId: '{{ SnapshotId }}' + VolumeSize: '{{ VolumeSize }}' + VolumeType: '{{ VolumeType }}' + NoDevice: '{{ NoDevice }}' + VirtualName: '{{ VirtualName }}' + MaintenanceOptions: + AutoRecovery: '{{ AutoRecovery }}' + IamInstanceProfile: + Arn: '{{ Arn }}' + Name: '{{ Name }}' + KernelId: '{{ KernelId }}' + EbsOptimized: '{{ EbsOptimized }}' + ElasticGpuSpecifications: + - Type: '{{ Type }}' + ElasticInferenceAccelerators: + - Type: '{{ Type }}' + Count: '{{ Count }}' + Placement: + GroupName: '{{ GroupName }}' + Tenancy: '{{ Tenancy }}' + SpreadDomain: '{{ SpreadDomain }}' + PartitionNumber: '{{ PartitionNumber }}' + AvailabilityZone: '{{ AvailabilityZone }}' + Affinity: '{{ Affinity }}' + HostId: '{{ HostId }}' + HostResourceGroupArn: '{{ HostResourceGroupArn }}' + GroupId: '{{ GroupId }}' + NetworkInterfaces: + - Description: '{{ Description }}' + PrivateIpAddress: '{{ PrivateIpAddress }}' + PrivateIpAddresses: + - Primary: '{{ Primary }}' + PrivateIpAddress: '{{ PrivateIpAddress }}' + SecondaryPrivateIpAddressCount: '{{ SecondaryPrivateIpAddressCount }}' + Ipv6PrefixCount: '{{ Ipv6PrefixCount }}' + Ipv4Prefixes: + - Ipv4Prefix: '{{ Ipv4Prefix }}' + Ipv4PrefixCount: '{{ Ipv4PrefixCount }}' + EnablePrimaryIpv6: '{{ EnablePrimaryIpv6 }}' + GroupSet: + - '{{ GroupSet[0] }}' + Ipv6Addresses: + - Ipv6Address: '{{ Ipv6Address }}' + Ipv6Prefixes: + - Ipv6Prefix: '{{ Ipv6Prefix }}' + SubnetId: '{{ SubnetId }}' + SourceDestCheck: '{{ SourceDestCheck }}' + InterfaceType: '{{ InterfaceType }}' + Ipv6AddressCount: '{{ Ipv6AddressCount }}' + Tags: + - null + ConnectionTrackingSpecification: + UdpTimeout: '{{ UdpTimeout }}' + TcpEstablishedTimeout: '{{ TcpEstablishedTimeout }}' + UdpStreamTimeout: '{{ UdpStreamTimeout }}' + EnclaveOptions: + Enabled: '{{ Enabled }}' + ImageId: '{{ ImageId }}' + InstanceType: '{{ InstanceType }}' + Monitoring: + Enabled: '{{ Enabled }}' + HibernationOptions: + Configured: '{{ Configured }}' + MetadataOptions: + HttpPutResponseHopLimit: '{{ HttpPutResponseHopLimit }}' + HttpTokens: '{{ HttpTokens }}' + HttpProtocolIpv6: '{{ HttpProtocolIpv6 }}' + InstanceMetadataTags: '{{ InstanceMetadataTags }}' + HttpEndpoint: '{{ HttpEndpoint }}' + LicenseSpecifications: + - LicenseConfigurationArn: '{{ LicenseConfigurationArn }}' + InstanceInitiatedShutdownBehavior: '{{ InstanceInitiatedShutdownBehavior }}' + DisableApiStop: '{{ DisableApiStop }}' + CpuOptions: + ThreadsPerCore: '{{ ThreadsPerCore }}' + AmdSevSnp: '{{ AmdSevSnp }}' + CoreCount: '{{ CoreCount }}' + PrivateDnsNameOptions: + EnableResourceNameDnsARecord: '{{ EnableResourceNameDnsARecord }}' + HostnameType: '{{ HostnameType }}' + EnableResourceNameDnsAAAARecord: '{{ EnableResourceNameDnsAAAARecord }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + KeyName: '{{ KeyName }}' + DisableApiTermination: '{{ DisableApiTermination }}' + InstanceMarketOptions: + SpotOptions: + SpotInstanceType: '{{ SpotInstanceType }}' + InstanceInterruptionBehavior: '{{ InstanceInterruptionBehavior }}' + MaxPrice: '{{ MaxPrice }}' + BlockDurationMinutes: '{{ BlockDurationMinutes }}' + ValidUntil: '{{ ValidUntil }}' + MarketType: '{{ MarketType }}' + InstanceRequirements: + InstanceGenerations: + - '{{ InstanceGenerations[0] }}' + MemoryGiBPerVCpu: + Min: null + Max: null + AcceleratorTypes: + - '{{ AcceleratorTypes[0] }}' + VCpuCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + AcceleratorManufacturers: + - '{{ AcceleratorManufacturers[0] }}' + LocalStorage: '{{ LocalStorage }}' + CpuManufacturers: + - '{{ CpuManufacturers[0] }}' + BareMetal: '{{ BareMetal }}' + RequireHibernateSupport: '{{ RequireHibernateSupport }}' + MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: '{{ MaxSpotPriceAsPercentageOfOptimalOnDemandPrice }}' + OnDemandMaxPricePercentageOverLowestPrice: '{{ OnDemandMaxPricePercentageOverLowestPrice }}' + MemoryMiB: + Min: '{{ Min }}' + Max: '{{ Max }}' + LocalStorageTypes: + - '{{ LocalStorageTypes[0] }}' + NetworkInterfaceCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + ExcludedInstanceTypes: + - '{{ ExcludedInstanceTypes[0] }}' + AllowedInstanceTypes: + - '{{ AllowedInstanceTypes[0] }}' + AcceleratorCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + NetworkBandwidthGbps: + Min: null + Max: null + BaselinePerformanceFactors: + Cpu: + References: + - InstanceFamily: '{{ InstanceFamily }}' + SpotMaxPricePercentageOverLowestPrice: '{{ SpotMaxPricePercentageOverLowestPrice }}' + BaselineEbsBandwidthMbps: + Min: '{{ Min }}' + Max: '{{ Max }}' + AcceleratorNames: + - '{{ AcceleratorNames[0] }}' + AcceleratorTotalMemoryMiB: + Min: '{{ Min }}' + Max: '{{ Max }}' + BurstablePerformance: '{{ BurstablePerformance }}' + TotalLocalStorageGB: + Min: null + Max: null + RamDiskId: '{{ RamDiskId }}' + CapacityReservationSpecification: + CapacityReservationPreference: '{{ CapacityReservationPreference }}' + CapacityReservationTarget: + CapacityReservationResourceGroupArn: '{{ CapacityReservationResourceGroupArn }}' + CapacityReservationId: '{{ CapacityReservationId }}' + CreditSpecification: + CpuCredits: '{{ CpuCredits }}' + - name: VersionDescription + value: '{{ VersionDescription }}' + - name: TagSpecifications + value: + - ResourceType: '{{ ResourceType }}' + Tags: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.launch_templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the launch_templates resource, the following permissions are required: + +### Read +```json +ec2:DescribeLaunchTemplates +``` + +### Create +```json +ec2:CreateLaunchTemplate, +ec2:CreateTags +``` + +### Update +```json +ec2:CreateLaunchTemplateVersion +``` + +### List +```json +ec2:DescribeLaunchTemplates +``` + +### Delete +```json +ec2:DeleteLaunchTemplate, +ec2:DeleteTags, +ec2:DescribeLaunchTemplates +``` diff --git a/website/docs/services/ec2/launch_templates_list_only/index.md b/website/docs/services/ec2/launch_templates_list_only/index.md new file mode 100644 index 0000000..98fb4d5 --- /dev/null +++ b/website/docs/services/ec2/launch_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: launch_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - launch_templates_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists launch_templates in a region or regions, for all properties use launch_templates + +## Overview + + + + + + + +
Namelaunch_templates_list_only
TypeResource
DescriptionSpecifies the properties for creating a launch template.
The minimum required properties for specifying a launch template are as follows:
+ You must specify at least one property for the launch template data.
+ You can optionally specify a name for the launch template. If you do not specify a name, CFN creates a name for you.

A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ImageId property, which has no default value. If you do not specify an AMI ID for the launch template ImageId property, you must specify an AMI ID for the instance ImageId property.
For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all launch_templates in a region. +```sql +SELECT +region, +launch_template_id +FROM aws.ec2.launch_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the launch_templates_list_only resource, see launch_templates + diff --git a/website/docs/services/ec2/local_gateway_route_table_tags/index.md b/website/docs/services/ec2/local_gateway_route_table_tags/index.md new file mode 100644 index 0000000..d9b8d43 --- /dev/null +++ b/website/docs/services/ec2/local_gateway_route_table_tags/index.md @@ -0,0 +1,89 @@ +--- +title: local_gateway_route_table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_table_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for local_gateway_route_tables in a region + +## Overview + + + + + + + +
Namelocal_gateway_route_table_tags
TypeResource
DescriptionDescribes a route table for a local gateway.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway route table.
stringThe ARN of the local gateway route table.
stringThe ID of the local gateway.
stringThe ARN of the outpost.
stringThe owner of the local gateway route table.
stringThe state of the local gateway route table.
stringThe mode of the local gateway route table.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all local_gateway_route_tables in a region. +```sql +SELECT +region, +local_gateway_route_table_id, +local_gateway_route_table_arn, +local_gateway_id, +outpost_arn, +owner_id, +state, +mode, +tag_key, +tag_value +FROM aws.ec2.local_gateway_route_table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_table_tags resource, see local_gateway_route_tables + diff --git a/website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_association_tags/index.md b/website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_association_tags/index.md new file mode 100644 index 0000000..b09bfec --- /dev/null +++ b/website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_association_tags/index.md @@ -0,0 +1,89 @@ +--- +title: local_gateway_route_table_virtual_interface_group_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_table_virtual_interface_group_association_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for local_gateway_route_table_virtual_interface_group_associations in a region + +## Overview + + + + + + + +
Namelocal_gateway_route_table_virtual_interface_group_association_tags
TypeResource
DescriptionDescribes a local gateway route table virtual interface group association for a local gateway.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway route table virtual interface group association.
stringThe ID of the local gateway.
stringThe ID of the local gateway route table.
stringThe ARN of the local gateway route table.
stringThe ID of the local gateway route table virtual interface group.
stringThe owner of the local gateway route table virtual interface group association.
stringThe state of the local gateway route table virtual interface group association.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all local_gateway_route_table_virtual_interface_group_associations in a region. +```sql +SELECT +region, +local_gateway_route_table_virtual_interface_group_association_id, +local_gateway_id, +local_gateway_route_table_id, +local_gateway_route_table_arn, +local_gateway_virtual_interface_group_id, +owner_id, +state, +tag_key, +tag_value +FROM aws.ec2.local_gateway_route_table_virtual_interface_group_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_table_virtual_interface_group_association_tags resource, see local_gateway_route_table_virtual_interface_group_associations + diff --git a/website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md b/website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md new file mode 100644 index 0000000..4c20d27 --- /dev/null +++ b/website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a local_gateway_route_table_virtual_interface_group_association resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway route table virtual interface group association.
stringThe ID of the local gateway.
stringThe ID of the local gateway route table.
stringThe ARN of the local gateway route table.
stringThe ID of the local gateway route table virtual interface group.
stringThe owner of the local gateway route table virtual interface group association.
stringThe state of the local gateway route table virtual interface group association.
arrayThe tags for the local gateway route table virtual interface group association.
stringAWS region.
+ +For more information, see AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all local_gateway_route_table_virtual_interface_group_associations in a region. +```sql +SELECT +region, +local_gateway_route_table_virtual_interface_group_association_id, +local_gateway_id, +local_gateway_route_table_id, +local_gateway_route_table_arn, +local_gateway_virtual_interface_group_id, +owner_id, +state, +tags +FROM aws.ec2.local_gateway_route_table_virtual_interface_group_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual local_gateway_route_table_virtual_interface_group_association. +```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_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new local_gateway_route_table_virtual_interface_group_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.local_gateway_route_table_virtual_interface_group_associations ( + LocalGatewayRouteTableId, + LocalGatewayVirtualInterfaceGroupId, + region +) +SELECT +'{{ LocalGatewayRouteTableId }}', + '{{ LocalGatewayVirtualInterfaceGroupId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.local_gateway_route_table_virtual_interface_group_associations ( + LocalGatewayRouteTableId, + LocalGatewayVirtualInterfaceGroupId, + Tags, + region +) +SELECT + '{{ LocalGatewayRouteTableId }}', + '{{ LocalGatewayVirtualInterfaceGroupId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: local_gateway_route_table_virtual_interface_group_association + props: + - name: LocalGatewayRouteTableId + value: '{{ LocalGatewayRouteTableId }}' + - name: LocalGatewayVirtualInterfaceGroupId + value: '{{ LocalGatewayVirtualInterfaceGroupId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.local_gateway_route_table_virtual_interface_group_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations +``` + +### Update +```json +ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation, +ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations +``` diff --git a/website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_associations_list_only/index.md b/website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_associations_list_only/index.md new file mode 100644 index 0000000..84ce906 --- /dev/null +++ b/website/docs/services/ec2/local_gateway_route_table_virtual_interface_group_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: local_gateway_route_table_virtual_interface_group_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_table_virtual_interface_group_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists local_gateway_route_table_virtual_interface_group_associations in a region or regions, for all properties use local_gateway_route_table_virtual_interface_group_associations + +## Overview + + + + + + + +
Namelocal_gateway_route_table_virtual_interface_group_associations_list_only
TypeResource
DescriptionDescribes a local gateway route table virtual interface group association for a local gateway.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway route table virtual interface group association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all local_gateway_route_table_virtual_interface_group_associations in a region. +```sql +SELECT +region, +local_gateway_route_table_virtual_interface_group_association_id +FROM aws.ec2.local_gateway_route_table_virtual_interface_group_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_table_virtual_interface_group_associations_list_only resource, see local_gateway_route_table_virtual_interface_group_associations + diff --git a/website/docs/services/ec2/local_gateway_route_tables/index.md b/website/docs/services/ec2/local_gateway_route_tables/index.md new file mode 100644 index 0000000..76e376b --- /dev/null +++ b/website/docs/services/ec2/local_gateway_route_tables/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a local_gateway_route_table resource or lists local_gateway_route_tables in a region + +## Overview + + + + + + + +
Namelocal_gateway_route_tables
TypeResource
DescriptionDescribes a route table for a local gateway.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway route table.
stringThe ARN of the local gateway route table.
stringThe ID of the local gateway.
stringThe ARN of the outpost.
stringThe owner of the local gateway route table.
stringThe state of the local gateway route table.
stringThe mode of the local gateway route table.
arrayThe tags for the local gateway route table.
stringAWS region.
+ +For more information, see AWS::EC2::LocalGatewayRouteTable. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all local_gateway_route_tables in a region. +```sql +SELECT +region, +local_gateway_route_table_id, +local_gateway_route_table_arn, +local_gateway_id, +outpost_arn, +owner_id, +state, +mode, +tags +FROM aws.ec2.local_gateway_route_tables +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual local_gateway_route_table. +```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_tables +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new local_gateway_route_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.local_gateway_route_tables ( + LocalGatewayId, + region +) +SELECT +'{{ LocalGatewayId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.local_gateway_route_tables ( + LocalGatewayId, + Mode, + Tags, + region +) +SELECT + '{{ LocalGatewayId }}', + '{{ Mode }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: local_gateway_route_table + props: + - name: LocalGatewayId + value: '{{ LocalGatewayId }}' + - name: Mode + value: '{{ Mode }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.local_gateway_route_tables +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeLocalGatewayRouteTables +``` + +### Update +```json +ec2:DescribeLocalGatewayRouteTables, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteLocalGatewayRouteTable, +ec2:DescribeLocalGatewayRouteTables, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeLocalGatewayRouteTables +``` diff --git a/website/docs/services/ec2/local_gateway_route_tables_list_only/index.md b/website/docs/services/ec2/local_gateway_route_tables_list_only/index.md new file mode 100644 index 0000000..4845e71 --- /dev/null +++ b/website/docs/services/ec2/local_gateway_route_tables_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: local_gateway_route_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_tables_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists local_gateway_route_tables in a region or regions, for all properties use local_gateway_route_tables + +## Overview + + + + + + + +
Namelocal_gateway_route_tables_list_only
TypeResource
DescriptionDescribes a route table for a local gateway.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway route table.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all local_gateway_route_tables in a region. +```sql +SELECT +region, +local_gateway_route_table_id +FROM aws.ec2.local_gateway_route_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_tables_list_only resource, see local_gateway_route_tables + diff --git a/website/docs/services/ec2/local_gateway_route_tablevpc_association_tags/index.md b/website/docs/services/ec2/local_gateway_route_tablevpc_association_tags/index.md new file mode 100644 index 0000000..cde6a26 --- /dev/null +++ b/website/docs/services/ec2/local_gateway_route_tablevpc_association_tags/index.md @@ -0,0 +1,85 @@ +--- +title: local_gateway_route_tablevpc_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_tablevpc_association_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for local_gateway_route_tablevpc_associations in a region + +## Overview + + + + + + + +
Namelocal_gateway_route_tablevpc_association_tags
TypeResource
DescriptionDescribes an association between a local gateway route table and a VPC.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway.
stringThe ID of the local gateway route table.
stringThe ID of the association.
stringThe state of the association.
stringThe ID of the VPC.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all local_gateway_route_tablevpc_associations in a region. +```sql +SELECT +region, +local_gateway_id, +local_gateway_route_table_id, +local_gateway_route_table_vpc_association_id, +state, +vpc_id, +tag_key, +tag_value +FROM aws.ec2.local_gateway_route_tablevpc_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_tablevpc_association_tags resource, see local_gateway_route_tablevpc_associations + diff --git a/website/docs/services/ec2/local_gateway_route_tablevpc_associations/index.md b/website/docs/services/ec2/local_gateway_route_tablevpc_associations/index.md new file mode 100644 index 0000000..633b371 --- /dev/null +++ b/website/docs/services/ec2/local_gateway_route_tablevpc_associations/index.md @@ -0,0 +1,227 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a local_gateway_route_tablevpc_association resource or lists 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.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway.
stringThe ID of the local gateway route table.
stringThe ID of the association.
stringThe state of the association.
stringThe ID of the VPC.
arrayThe tags for the association.
stringAWS region.
+ +For more information, see AWS::EC2::LocalGatewayRouteTableVPCAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all local_gateway_route_tablevpc_associations in a region. +```sql +SELECT +region, +local_gateway_id, +local_gateway_route_table_id, +local_gateway_route_table_vpc_association_id, +state, +vpc_id, +tags +FROM aws.ec2.local_gateway_route_tablevpc_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual local_gateway_route_tablevpc_association. +```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_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new local_gateway_route_tablevpc_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.local_gateway_route_tablevpc_associations ( + LocalGatewayRouteTableId, + VpcId, + region +) +SELECT +'{{ LocalGatewayRouteTableId }}', + '{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.local_gateway_route_tablevpc_associations ( + LocalGatewayRouteTableId, + VpcId, + Tags, + region +) +SELECT + '{{ LocalGatewayRouteTableId }}', + '{{ VpcId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: local_gateway_route_tablevpc_association + props: + - name: LocalGatewayRouteTableId + value: '{{ LocalGatewayRouteTableId }}' + - name: VpcId + value: '{{ VpcId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.local_gateway_route_tablevpc_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeLocalGatewayRouteTableVpcAssociations +``` + +### Update +```json +ec2:DescribeLocalGatewayRouteTableVpcAssociations, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteLocalGatewayRouteTableVpcAssociation, +ec2:DescribeLocalGatewayRouteTableVpcAssociations, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeLocalGatewayRouteTableVpcAssociations +``` diff --git a/website/docs/services/ec2/local_gateway_route_tablevpc_associations_list_only/index.md b/website/docs/services/ec2/local_gateway_route_tablevpc_associations_list_only/index.md new file mode 100644 index 0000000..adf7454 --- /dev/null +++ b/website/docs/services/ec2/local_gateway_route_tablevpc_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: local_gateway_route_tablevpc_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_tablevpc_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists local_gateway_route_tablevpc_associations in a region or regions, for all properties use local_gateway_route_tablevpc_associations + +## Overview + + + + + + + +
Namelocal_gateway_route_tablevpc_associations_list_only
TypeResource
DescriptionDescribes an association between a local gateway route table and a VPC.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all local_gateway_route_tablevpc_associations in a region. +```sql +SELECT +region, +local_gateway_route_table_vpc_association_id +FROM aws.ec2.local_gateway_route_tablevpc_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_tablevpc_associations_list_only resource, see local_gateway_route_tablevpc_associations + diff --git a/website/docs/services/ec2/local_gateway_routes/index.md b/website/docs/services/ec2/local_gateway_routes/index.md new file mode 100644 index 0000000..8e58ef6 --- /dev/null +++ b/website/docs/services/ec2/local_gateway_routes/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a local_gateway_route resource or lists local_gateway_routes in a region + +## Overview + + + + + + + +
Namelocal_gateway_routes
TypeResource
DescriptionDescribes a route for a local gateway route table.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe CIDR block used for destination matches.
stringThe ID of the local gateway route table.
stringThe ID of the virtual interface group.
stringThe ID of the network interface.
stringThe state of the route.
stringThe route type.
stringAWS region.
+ +For more information, see AWS::EC2::LocalGatewayRoute. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all local_gateway_routes in a region. +```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_routes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual local_gateway_route. +```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_routes +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new local_gateway_route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.local_gateway_routes ( + DestinationCidrBlock, + LocalGatewayRouteTableId, + LocalGatewayVirtualInterfaceGroupId, + NetworkInterfaceId, + region +) +SELECT +'{{ DestinationCidrBlock }}', + '{{ LocalGatewayRouteTableId }}', + '{{ LocalGatewayVirtualInterfaceGroupId }}', + '{{ NetworkInterfaceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.local_gateway_routes ( + DestinationCidrBlock, + LocalGatewayRouteTableId, + LocalGatewayVirtualInterfaceGroupId, + NetworkInterfaceId, + region +) +SELECT + '{{ DestinationCidrBlock }}', + '{{ LocalGatewayRouteTableId }}', + '{{ LocalGatewayVirtualInterfaceGroupId }}', + '{{ NetworkInterfaceId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: local_gateway_route + props: + - name: DestinationCidrBlock + value: '{{ DestinationCidrBlock }}' + - name: LocalGatewayRouteTableId + value: '{{ LocalGatewayRouteTableId }}' + - name: LocalGatewayVirtualInterfaceGroupId + value: '{{ LocalGatewayVirtualInterfaceGroupId }}' + - name: NetworkInterfaceId + value: '{{ NetworkInterfaceId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.local_gateway_routes +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the local_gateway_routes resource, the following permissions are required: + +### Create +```json +ec2:CreateLocalGatewayRoute, +ec2:SearchLocalGatewayRoutes +``` + +### Read +```json +ec2:SearchLocalGatewayRoutes +``` + +### Delete +```json +ec2:DeleteLocalGatewayRoute, +ec2:SearchLocalGatewayRoutes +``` + +### List +```json +ec2:DescribeLocalGatewayRouteTables, +ec2:SearchLocalGatewayRoutes +``` + +### Update +```json +ec2:ModifyLocalGatewayRoute, +ec2:SearchLocalGatewayRoutes +``` diff --git a/website/docs/services/ec2/local_gateway_routes_list_only/index.md b/website/docs/services/ec2/local_gateway_routes_list_only/index.md new file mode 100644 index 0000000..94d8aca --- /dev/null +++ b/website/docs/services/ec2/local_gateway_routes_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: local_gateway_routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_routes_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists local_gateway_routes in a region or regions, for all properties use local_gateway_routes + +## Overview + + + + + + + +
Namelocal_gateway_routes_list_only
TypeResource
DescriptionDescribes a route for a local gateway route table.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe CIDR block used for destination matches.
stringThe ID of the local gateway route table.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all local_gateway_routes in a region. +```sql +SELECT +region, +destination_cidr_block, +local_gateway_route_table_id +FROM aws.ec2.local_gateway_routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_routes_list_only resource, see local_gateway_routes + diff --git a/website/docs/services/ec2/nat_gateway_tags/index.md b/website/docs/services/ec2/nat_gateway_tags/index.md new file mode 100644 index 0000000..cbd946d --- /dev/null +++ b/website/docs/services/ec2/nat_gateway_tags/index.md @@ -0,0 +1,93 @@ +--- +title: nat_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - nat_gateway_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for nat_gateways in a region + +## Overview + + + + + + + +
Namenat_gateway_tags
TypeResource
DescriptionSpecifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.
With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.
If you add a default route (AWS::EC2::Route resource) that points to a NAT gateway, specify the NAT gateway ID for the route's NatGatewayId property.
When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arraySecondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html) in the *Amazon VPC User Guide*.
stringThe private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
stringIndicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
arraySecondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
integer[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
string[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.
stringThe ID of the subnet in which the NAT gateway is located.
string
integerThe maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all nat_gateways in a region. +```sql +SELECT +region, +secondary_allocation_ids, +private_ip_address, +connectivity_type, +secondary_private_ip_addresses, +secondary_private_ip_address_count, +allocation_id, +subnet_id, +nat_gateway_id, +max_drain_duration_seconds, +tag_key, +tag_value +FROM aws.ec2.nat_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the nat_gateway_tags resource, see nat_gateways + diff --git a/website/docs/services/ec2/nat_gateways/index.md b/website/docs/services/ec2/nat_gateways/index.md new file mode 100644 index 0000000..9264dd8 --- /dev/null +++ b/website/docs/services/ec2/nat_gateways/index.md @@ -0,0 +1,266 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a nat_gateway resource or lists 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.
With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.
If you add a default route (AWS::EC2::Route resource) that points to a NAT gateway, specify the NAT gateway ID for the route's NatGatewayId property.
When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arraySecondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html) in the *Amazon VPC User Guide*.
stringThe private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
stringIndicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
arraySecondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
integer[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
string[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.
stringThe ID of the subnet in which the NAT gateway is located.
string
arrayThe tags for the NAT gateway.
integerThe maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
stringAWS region.
+ +For more information, see AWS::EC2::NatGateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all nat_gateways in a region. +```sql +SELECT +region, +secondary_allocation_ids, +private_ip_address, +connectivity_type, +secondary_private_ip_addresses, +secondary_private_ip_address_count, +allocation_id, +subnet_id, +nat_gateway_id, +tags, +max_drain_duration_seconds +FROM aws.ec2.nat_gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual nat_gateway. +```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_gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new nat_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.nat_gateways ( + SubnetId, + region +) +SELECT +'{{ SubnetId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.nat_gateways ( + SecondaryAllocationIds, + PrivateIpAddress, + ConnectivityType, + SecondaryPrivateIpAddresses, + SecondaryPrivateIpAddressCount, + AllocationId, + SubnetId, + Tags, + MaxDrainDurationSeconds, + region +) +SELECT + '{{ SecondaryAllocationIds }}', + '{{ PrivateIpAddress }}', + '{{ ConnectivityType }}', + '{{ SecondaryPrivateIpAddresses }}', + '{{ SecondaryPrivateIpAddressCount }}', + '{{ AllocationId }}', + '{{ SubnetId }}', + '{{ Tags }}', + '{{ MaxDrainDurationSeconds }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: nat_gateway + props: + - name: SecondaryAllocationIds + value: + - '{{ SecondaryAllocationIds[0] }}' + - name: PrivateIpAddress + value: '{{ PrivateIpAddress }}' + - name: ConnectivityType + value: '{{ ConnectivityType }}' + - name: SecondaryPrivateIpAddresses + value: + - '{{ SecondaryPrivateIpAddresses[0] }}' + - name: SecondaryPrivateIpAddressCount + value: '{{ SecondaryPrivateIpAddressCount }}' + - name: AllocationId + value: '{{ AllocationId }}' + - name: SubnetId + value: '{{ SubnetId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: MaxDrainDurationSeconds + value: '{{ MaxDrainDurationSeconds }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.nat_gateways +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the nat_gateways resource, the following permissions are required: + +### Read +```json +ec2:DescribeNatGateways +``` + +### Create +```json +ec2:CreateNatGateway, +ec2:DescribeNatGateways, +ec2:CreateTags +``` + +### Update +```json +ec2:DescribeNatGateways, +ec2:CreateTags, +ec2:DeleteTags, +ec2:AssociateNatGatewayAddress, +ec2:DisassociateNatGatewayAddress, +ec2:AssignPrivateNatGatewayAddress, +ec2:UnassignPrivateNatGatewayAddress +``` + +### List +```json +ec2:DescribeNatGateways +``` + +### Delete +```json +ec2:DeleteNatGateway, +ec2:DescribeNatGateways +``` diff --git a/website/docs/services/ec2/nat_gateways_list_only/index.md b/website/docs/services/ec2/nat_gateways_list_only/index.md new file mode 100644 index 0000000..8b7e6b6 --- /dev/null +++ b/website/docs/services/ec2/nat_gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: nat_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - nat_gateways_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists nat_gateways in a region or regions, for all properties use nat_gateways + +## Overview + + + + + + + +
Namenat_gateways_list_only
TypeResource
DescriptionSpecifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.
With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.
If you add a default route (AWS::EC2::Route resource) that points to a NAT gateway, specify the NAT gateway ID for the route's NatGatewayId property.
When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all nat_gateways in a region. +```sql +SELECT +region, +nat_gateway_id +FROM aws.ec2.nat_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the nat_gateways_list_only resource, see nat_gateways + diff --git a/website/docs/services/ec2/network_acl_tags/index.md b/website/docs/services/ec2/network_acl_tags/index.md new file mode 100644 index 0000000..ef20136 --- /dev/null +++ b/website/docs/services/ec2/network_acl_tags/index.md @@ -0,0 +1,79 @@ +--- +title: network_acl_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_acl_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_acls in a region + +## Overview + + + + + + + +
Namenetwork_acl_tags
TypeResource
DescriptionSpecifies a network ACL for your VPC.
To add a network ACL entry, see [AWS::EC2::NetworkAclEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html).
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of the VPC for the network ACL.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_acls in a region. +```sql +SELECT +region, +vpc_id, +id, +tag_key, +tag_value +FROM aws.ec2.network_acl_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_acl_tags resource, see network_acls + diff --git a/website/docs/services/ec2/network_acls/index.md b/website/docs/services/ec2/network_acls/index.md new file mode 100644 index 0000000..86900fe --- /dev/null +++ b/website/docs/services/ec2/network_acls/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network_acl resource or lists network_acls in a region + +## Overview + + + + + + + +
Namenetwork_acls
TypeResource
DescriptionSpecifies a network ACL for your VPC.
To add a network ACL entry, see [AWS::EC2::NetworkAclEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html).
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the VPC for the network ACL.
string
arrayThe tags for the network ACL.
stringAWS region.
+ +For more information, see AWS::EC2::NetworkAcl. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all network_acls in a region. +```sql +SELECT +region, +vpc_id, +id, +tags +FROM aws.ec2.network_acls +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network_acl. +```sql +SELECT +region, +vpc_id, +id, +tags +FROM aws.ec2.network_acls +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_acl resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_acls ( + VpcId, + region +) +SELECT +'{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_acls ( + VpcId, + Tags, + region +) +SELECT + '{{ VpcId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network_acl + props: + - name: VpcId + value: '{{ VpcId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.network_acls +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the network_acls resource, the following permissions are required: + +### Read +```json +ec2:DescribeNetworkAcls, +ec2:DescribeTags +``` + +### Create +```json +ec2:CreateNetworkAcl, +ec2:DescribeNetworkAcls, +ec2:CreateTags +``` + +### Update +```json +ec2:DescribeNetworkAcls, +ec2:DeleteTags, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeNetworkAcls +``` + +### Delete +```json +ec2:DeleteTags, +ec2:DeleteNetworkAcl, +ec2:DescribeNetworkAcls +``` diff --git a/website/docs/services/ec2/network_acls_list_only/index.md b/website/docs/services/ec2/network_acls_list_only/index.md new file mode 100644 index 0000000..babd158 --- /dev/null +++ b/website/docs/services/ec2/network_acls_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_acls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_acls_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_acls in a region or regions, for all properties use network_acls + +## Overview + + + + + + + +
Namenetwork_acls_list_only
TypeResource
DescriptionSpecifies a network ACL for your VPC.
To add a network ACL entry, see [AWS::EC2::NetworkAclEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_acls in a region. +```sql +SELECT +region, +id +FROM aws.ec2.network_acls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_acls_list_only resource, see network_acls + diff --git a/website/docs/services/ec2/network_insights_access_scope_analyses/index.md b/website/docs/services/ec2/network_insights_access_scope_analyses/index.md new file mode 100644 index 0000000..fbed673 --- /dev/null +++ b/website/docs/services/ec2/network_insights_access_scope_analyses/index.md @@ -0,0 +1,238 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network_insights_access_scope_analysis resource or lists network_insights_access_scope_analyses in a region + +## Overview + + + + + + + +
Namenetwork_insights_access_scope_analyses
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
integer
array
stringAWS region.
+ +For more information, see AWS::EC2::NetworkInsightsAccessScopeAnalysis. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all network_insights_access_scope_analyses in a region. +```sql +SELECT +region, +network_insights_access_scope_analysis_id, +network_insights_access_scope_analysis_arn, +network_insights_access_scope_id, +status, +status_message, +start_date, +end_date, +findings_found, +analyzed_eni_count, +tags +FROM aws.ec2.network_insights_access_scope_analyses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network_insights_access_scope_analysis. +```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_analyses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_insights_access_scope_analysis resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_insights_access_scope_analyses ( + NetworkInsightsAccessScopeId, + region +) +SELECT +'{{ NetworkInsightsAccessScopeId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_insights_access_scope_analyses ( + NetworkInsightsAccessScopeId, + Tags, + region +) +SELECT + '{{ NetworkInsightsAccessScopeId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network_insights_access_scope_analysis + props: + - name: NetworkInsightsAccessScopeId + value: '{{ NetworkInsightsAccessScopeId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.network_insights_access_scope_analyses +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeNetworkInsightsAccessScopeAnalyses +``` + +### Update +```json +ec2:DescribeNetworkInsightsAccessScopeAnalyses, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteNetworkInsightsAccessScopeAnalysis, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeNetworkInsightsAccessScopeAnalyses +``` diff --git a/website/docs/services/ec2/network_insights_access_scope_analyses_list_only/index.md b/website/docs/services/ec2/network_insights_access_scope_analyses_list_only/index.md new file mode 100644 index 0000000..37106f1 --- /dev/null +++ b/website/docs/services/ec2/network_insights_access_scope_analyses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_insights_access_scope_analyses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope_analyses_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_insights_access_scope_analyses in a region or regions, for all properties use network_insights_access_scope_analyses + +## Overview + + + + + + + +
Namenetwork_insights_access_scope_analyses_list_only
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_insights_access_scope_analyses in a region. +```sql +SELECT +region, +network_insights_access_scope_analysis_id +FROM aws.ec2.network_insights_access_scope_analyses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_access_scope_analyses_list_only resource, see network_insights_access_scope_analyses + diff --git a/website/docs/services/ec2/network_insights_access_scope_analysis_tags/index.md b/website/docs/services/ec2/network_insights_access_scope_analysis_tags/index.md new file mode 100644 index 0000000..e0e50d4 --- /dev/null +++ b/website/docs/services/ec2/network_insights_access_scope_analysis_tags/index.md @@ -0,0 +1,93 @@ +--- +title: network_insights_access_scope_analysis_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope_analysis_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_insights_access_scope_analyses in a region + +## Overview + + + + + + + +
Namenetwork_insights_access_scope_analysis_tags
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_insights_access_scope_analyses in a region. +```sql +SELECT +region, +network_insights_access_scope_analysis_id, +network_insights_access_scope_analysis_arn, +network_insights_access_scope_id, +status, +status_message, +start_date, +end_date, +findings_found, +analyzed_eni_count, +tag_key, +tag_value +FROM aws.ec2.network_insights_access_scope_analysis_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_access_scope_analysis_tags resource, see network_insights_access_scope_analyses + diff --git a/website/docs/services/ec2/network_insights_access_scope_tags/index.md b/website/docs/services/ec2/network_insights_access_scope_tags/index.md new file mode 100644 index 0000000..331908b --- /dev/null +++ b/website/docs/services/ec2/network_insights_access_scope_tags/index.md @@ -0,0 +1,87 @@ +--- +title: network_insights_access_scope_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_insights_access_scopes in a region + +## Overview + + + + + + + +
Namenetwork_insights_access_scope_tags
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScope
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_insights_access_scopes in a region. +```sql +SELECT +region, +network_insights_access_scope_id, +network_insights_access_scope_arn, +created_date, +updated_date, +match_paths, +exclude_paths, +tag_key, +tag_value +FROM aws.ec2.network_insights_access_scope_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_access_scope_tags resource, see network_insights_access_scopes + diff --git a/website/docs/services/ec2/network_insights_access_scopes/index.md b/website/docs/services/ec2/network_insights_access_scopes/index.md new file mode 100644 index 0000000..af70e45 --- /dev/null +++ b/website/docs/services/ec2/network_insights_access_scopes/index.md @@ -0,0 +1,258 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network_insights_access_scope resource or lists network_insights_access_scopes in a region + +## Overview + + + + + + + +
Namenetwork_insights_access_scopes
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScope
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
array
array
stringAWS region.
+ +For more information, see AWS::EC2::NetworkInsightsAccessScope. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all network_insights_access_scopes in a region. +```sql +SELECT +region, +network_insights_access_scope_id, +network_insights_access_scope_arn, +created_date, +updated_date, +tags, +match_paths, +exclude_paths +FROM aws.ec2.network_insights_access_scopes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network_insights_access_scope. +```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_scopes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_insights_access_scope resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_insights_access_scopes ( + Tags, + MatchPaths, + ExcludePaths, + region +) +SELECT +'{{ Tags }}', + '{{ MatchPaths }}', + '{{ ExcludePaths }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_insights_access_scopes ( + Tags, + MatchPaths, + ExcludePaths, + region +) +SELECT + '{{ Tags }}', + '{{ MatchPaths }}', + '{{ ExcludePaths }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network_insights_access_scope + props: + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: MatchPaths + value: + - Source: + PacketHeaderStatement: + SourceAddresses: + - '{{ SourceAddresses[0] }}' + DestinationAddresses: + - '{{ DestinationAddresses[0] }}' + SourcePorts: + - '{{ SourcePorts[0] }}' + DestinationPorts: + - '{{ DestinationPorts[0] }}' + SourcePrefixLists: + - '{{ SourcePrefixLists[0] }}' + DestinationPrefixLists: + - '{{ DestinationPrefixLists[0] }}' + Protocols: + - '{{ Protocols[0] }}' + ResourceStatement: + Resources: + - '{{ Resources[0] }}' + ResourceTypes: + - '{{ ResourceTypes[0] }}' + Destination: null + ThroughResources: + - ResourceStatement: null + - name: ExcludePaths + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.network_insights_access_scopes +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeNetworkInsightsAccessScopes, +ec2:GetNetworkInsightsAccessScopeContent +``` + +### Update +```json +ec2:DescribeNetworkInsightsAccessScopes, +ec2:GetNetworkInsightsAccessScopeContent, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteNetworkInsightsAccessScope, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeNetworkInsightsAccessScopes +``` diff --git a/website/docs/services/ec2/network_insights_access_scopes_list_only/index.md b/website/docs/services/ec2/network_insights_access_scopes_list_only/index.md new file mode 100644 index 0000000..0c8c9e4 --- /dev/null +++ b/website/docs/services/ec2/network_insights_access_scopes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_insights_access_scopes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scopes_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_insights_access_scopes in a region or regions, for all properties use network_insights_access_scopes + +## Overview + + + + + + + +
Namenetwork_insights_access_scopes_list_only
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScope
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_insights_access_scopes in a region. +```sql +SELECT +region, +network_insights_access_scope_id +FROM aws.ec2.network_insights_access_scopes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_access_scopes_list_only resource, see network_insights_access_scopes + diff --git a/website/docs/services/ec2/network_insights_analyses/index.md b/website/docs/services/ec2/network_insights_analyses/index.md new file mode 100644 index 0000000..e538fcc --- /dev/null +++ b/website/docs/services/ec2/network_insights_analyses/index.md @@ -0,0 +1,265 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network_insights_analysis resource or lists network_insights_analyses in a region + +## Overview + + + + + + + +
Namenetwork_insights_analyses
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAnalysis
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
string
string
boolean
array
array
string
string
string
array
array
array
array
array
stringAWS region.
+ +For more information, see AWS::EC2::NetworkInsightsAnalysis. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all network_insights_analyses in a region. +```sql +SELECT +region, +status, +return_path_components, +network_insights_analysis_id, +network_insights_path_id, +network_path_found, +suggested_accounts, +filter_in_arns, +network_insights_analysis_arn, +status_message, +start_date, +alternate_path_hints, +explanations, +forward_path_components, +additional_accounts, +tags +FROM aws.ec2.network_insights_analyses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network_insights_analysis. +```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_analyses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_insights_analysis resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_insights_analyses ( + NetworkInsightsPathId, + region +) +SELECT +'{{ NetworkInsightsPathId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_insights_analyses ( + NetworkInsightsPathId, + FilterInArns, + AdditionalAccounts, + Tags, + region +) +SELECT + '{{ NetworkInsightsPathId }}', + '{{ FilterInArns }}', + '{{ AdditionalAccounts }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network_insights_analysis + props: + - name: NetworkInsightsPathId + value: '{{ NetworkInsightsPathId }}' + - name: FilterInArns + value: + - '{{ FilterInArns[0] }}' + - name: AdditionalAccounts + value: + - '{{ AdditionalAccounts[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.network_insights_analyses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the network_insights_analyses resource, the following permissions are required: + +### Read +```json +ec2:Describe* +``` + +### Create +```json +ec2:CreateTags, +ec2:StartNetworkInsightsAnalysis, +ec2:GetTransitGatewayRouteTablePropagations, +ec2:SearchTransitGatewayRoutes, +ec2:Describe*, +ec2:GetManagedPrefixListEntries, +elasticloadbalancing:Describe*, +directconnect:Describe*, +tiros:CreateQuery, +tiros:GetQueryAnswer, +tiros:GetQueryExplanation +``` + +### Update +```json +ec2:CreateTags, +ec2:Describe*, +ec2:DeleteTags +``` + +### List +```json +ec2:Describe* +``` + +### Delete +```json +ec2:DeleteNetworkInsightsAnalysis, +ec2:DeleteTags +``` diff --git a/website/docs/services/ec2/network_insights_analyses_list_only/index.md b/website/docs/services/ec2/network_insights_analyses_list_only/index.md new file mode 100644 index 0000000..e53b4b3 --- /dev/null +++ b/website/docs/services/ec2/network_insights_analyses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_insights_analyses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_analyses_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_insights_analyses in a region or regions, for all properties use network_insights_analyses + +## Overview + + + + + + + +
Namenetwork_insights_analyses_list_only
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAnalysis
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_insights_analyses in a region. +```sql +SELECT +region, +network_insights_analysis_id +FROM aws.ec2.network_insights_analyses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_analyses_list_only resource, see network_insights_analyses + diff --git a/website/docs/services/ec2/network_insights_analysis_tags/index.md b/website/docs/services/ec2/network_insights_analysis_tags/index.md new file mode 100644 index 0000000..9e7fa8c --- /dev/null +++ b/website/docs/services/ec2/network_insights_analysis_tags/index.md @@ -0,0 +1,103 @@ +--- +title: network_insights_analysis_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_analysis_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_insights_analyses in a region + +## Overview + + + + + + + +
Namenetwork_insights_analysis_tags
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAnalysis
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
string
string
boolean
array
array
string
string
string
array
array
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_insights_analyses in a region. +```sql +SELECT +region, +status, +return_path_components, +network_insights_analysis_id, +network_insights_path_id, +network_path_found, +suggested_accounts, +filter_in_arns, +network_insights_analysis_arn, +status_message, +start_date, +alternate_path_hints, +explanations, +forward_path_components, +additional_accounts, +tag_key, +tag_value +FROM aws.ec2.network_insights_analysis_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_analysis_tags resource, see network_insights_analyses + diff --git a/website/docs/services/ec2/network_insights_path_tags/index.md b/website/docs/services/ec2/network_insights_path_tags/index.md new file mode 100644 index 0000000..1131e41 --- /dev/null +++ b/website/docs/services/ec2/network_insights_path_tags/index.md @@ -0,0 +1,101 @@ +--- +title: network_insights_path_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_path_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_insights_paths in a region + +## Overview + + + + + + + +
Namenetwork_insights_path_tags
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsPath
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
string
string
string
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_insights_paths in a region. +```sql +SELECT +region, +network_insights_path_id, +network_insights_path_arn, +created_date, +source_ip, +filter_at_source, +filter_at_destination, +destination_ip, +source, +destination, +source_arn, +destination_arn, +protocol, +destination_port, +tag_key, +tag_value +FROM aws.ec2.network_insights_path_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_path_tags resource, see network_insights_paths + diff --git a/website/docs/services/ec2/network_insights_paths/index.md b/website/docs/services/ec2/network_insights_paths/index.md new file mode 100644 index 0000000..34a2acd --- /dev/null +++ b/website/docs/services/ec2/network_insights_paths/index.md @@ -0,0 +1,279 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network_insights_path resource or lists network_insights_paths in a region + +## Overview + + + + + + + +
Namenetwork_insights_paths
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsPath
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
string
string
string
integer
array
stringAWS region.
+ +For more information, see AWS::EC2::NetworkInsightsPath. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all network_insights_paths in a region. +```sql +SELECT +region, +network_insights_path_id, +network_insights_path_arn, +created_date, +source_ip, +filter_at_source, +filter_at_destination, +destination_ip, +source, +destination, +source_arn, +destination_arn, +protocol, +destination_port, +tags +FROM aws.ec2.network_insights_paths +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network_insights_path. +```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_paths +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_insights_path resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_insights_paths ( + Source, + Protocol, + region +) +SELECT +'{{ Source }}', + '{{ Protocol }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_insights_paths ( + SourceIp, + FilterAtSource, + FilterAtDestination, + DestinationIp, + Source, + Destination, + Protocol, + DestinationPort, + Tags, + region +) +SELECT + '{{ SourceIp }}', + '{{ FilterAtSource }}', + '{{ FilterAtDestination }}', + '{{ DestinationIp }}', + '{{ Source }}', + '{{ Destination }}', + '{{ Protocol }}', + '{{ DestinationPort }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network_insights_path + props: + - name: SourceIp + value: '{{ SourceIp }}' + - name: FilterAtSource + value: + SourceAddress: null + SourcePortRange: + FromPort: '{{ FromPort }}' + ToPort: '{{ ToPort }}' + DestinationAddress: null + DestinationPortRange: null + - name: FilterAtDestination + value: null + - name: DestinationIp + value: null + - name: Source + value: '{{ Source }}' + - name: Destination + value: '{{ Destination }}' + - name: Protocol + value: '{{ Protocol }}' + - name: DestinationPort + value: '{{ DestinationPort }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.network_insights_paths +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the network_insights_paths resource, the following permissions are required: + +### Create +```json +ec2:CreateNetworkInsightsPath, +ec2:CreateTags +``` + +### Delete +```json +ec2:DeleteNetworkInsightsPath, +ec2:DeleteTags +``` + +### Read +```json +ec2:DescribeNetworkInsightsPaths +``` + +### List +```json +ec2:DescribeNetworkInsightsPaths +``` + +### Update +```json +ec2:DescribeNetworkInsightsPaths, +ec2:CreateTags, +ec2:DeleteTags +``` diff --git a/website/docs/services/ec2/network_insights_paths_list_only/index.md b/website/docs/services/ec2/network_insights_paths_list_only/index.md new file mode 100644 index 0000000..80a70c0 --- /dev/null +++ b/website/docs/services/ec2/network_insights_paths_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_insights_paths_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_paths_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_insights_paths in a region or regions, for all properties use network_insights_paths + +## Overview + + + + + + + +
Namenetwork_insights_paths_list_only
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsPath
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_insights_paths in a region. +```sql +SELECT +region, +network_insights_path_id +FROM aws.ec2.network_insights_paths_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_paths_list_only resource, see network_insights_paths + diff --git a/website/docs/services/ec2/network_interface_attachments/index.md b/website/docs/services/ec2/network_interface_attachments/index.md new file mode 100644 index 0000000..15fdc4f --- /dev/null +++ b/website/docs/services/ec2/network_interface_attachments/index.md @@ -0,0 +1,238 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network_interface_attachment resource or lists network_interface_attachments in a region + +## Overview + + + + + + + +
Namenetwork_interface_attachments
TypeResource
DescriptionAttaches an elastic network interface (ENI) to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instance without interruption.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
booleanWhether to delete the network interface when the instance terminates. By default, this value is set to true.
stringThe network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.
stringThe ID of the instance to which you will attach the ENI.
stringThe ID of the ENI that you want to attach.
objectConfigures ENA Express for the network interface that this action attaches to the instance.
stringAWS region.
+ +For more information, see AWS::EC2::NetworkInterfaceAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all network_interface_attachments in a region. +```sql +SELECT +region, +attachment_id, +delete_on_termination, +device_index, +instance_id, +network_interface_id, +ena_srd_specification +FROM aws.ec2.network_interface_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network_interface_attachment. +```sql +SELECT +region, +attachment_id, +delete_on_termination, +device_index, +instance_id, +network_interface_id, +ena_srd_specification +FROM aws.ec2.network_interface_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_interface_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_interface_attachments ( + DeviceIndex, + InstanceId, + NetworkInterfaceId, + region +) +SELECT +'{{ DeviceIndex }}', + '{{ InstanceId }}', + '{{ NetworkInterfaceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_interface_attachments ( + DeleteOnTermination, + DeviceIndex, + InstanceId, + NetworkInterfaceId, + EnaSrdSpecification, + region +) +SELECT + '{{ DeleteOnTermination }}', + '{{ DeviceIndex }}', + '{{ InstanceId }}', + '{{ NetworkInterfaceId }}', + '{{ EnaSrdSpecification }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network_interface_attachment + props: + - name: DeleteOnTermination + value: '{{ DeleteOnTermination }}' + - name: DeviceIndex + value: '{{ DeviceIndex }}' + - name: InstanceId + value: '{{ InstanceId }}' + - name: NetworkInterfaceId + value: '{{ NetworkInterfaceId }}' + - name: EnaSrdSpecification + value: + EnaSrdEnabled: '{{ EnaSrdEnabled }}' + EnaSrdUdpSpecification: + EnaSrdUdpEnabled: '{{ EnaSrdUdpEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.network_interface_attachments +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeNetworkInterfaces +``` + +### List +```json +ec2:DescribeNetworkInterfaces +``` + +### Update +```json +ec2:ModifyNetworkInterfaceAttribute, +ec2:DescribeNetworkInterfaces, +ec2:AttachNetworkInterface, +ec2:DetachNetworkInterface +``` + +### Delete +```json +ec2:DetachNetworkInterface, +ec2:DescribeNetworkInterfaces +``` diff --git a/website/docs/services/ec2/network_interface_attachments_list_only/index.md b/website/docs/services/ec2/network_interface_attachments_list_only/index.md new file mode 100644 index 0000000..631d8a9 --- /dev/null +++ b/website/docs/services/ec2/network_interface_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_interface_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_interface_attachments_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_interface_attachments in a region or regions, for all properties use network_interface_attachments + +## Overview + + + + + + + +
Namenetwork_interface_attachments_list_only
TypeResource
DescriptionAttaches an elastic network interface (ENI) to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instance without interruption.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_interface_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.ec2.network_interface_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_interface_attachments_list_only resource, see network_interface_attachments + diff --git a/website/docs/services/ec2/network_interface_tags/index.md b/website/docs/services/ec2/network_interface_tags/index.md new file mode 100644 index 0000000..95af43f --- /dev/null +++ b/website/docs/services/ec2/network_interface_tags/index.md @@ -0,0 +1,117 @@ +--- +title: network_interface_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_interface_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_interfaces in a region + +## Overview + + + + + + + +
Namenetwork_interface_tags
TypeResource
DescriptionThe AWS::EC2::NetworkInterface resource creates network interface
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description for the network interface.
stringAssigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.
stringThe primary IPv6 address
arrayAssigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
integerThe number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses
integerThe number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
stringReturns the primary private IP address of the network interface.
arrayAssigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
integerThe number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
booleanIf you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.
arrayA list of security group IDs associated with this network interface.
arrayOne or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
arrayAssigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
stringThe ID of the subnet to associate with the network interface.
booleanIndicates whether traffic to or from the instance is validated.
stringIndicates the type of network interface.
arrayReturns the secondary private IP addresses of the network interface.
stringThe ID of the VPC
integerThe number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
stringNetwork interface id.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_interfaces in a region. +```sql +SELECT +region, +description, +private_ip_address, +primary_ipv6_address, +private_ip_addresses, +secondary_private_ip_address_count, +ipv6_prefix_count, +primary_private_ip_address, +ipv4_prefixes, +ipv4_prefix_count, +enable_primary_ipv6, +group_set, +ipv6_addresses, +ipv6_prefixes, +subnet_id, +source_dest_check, +interface_type, +secondary_private_ip_addresses, +vpc_id, +ipv6_address_count, +id, +connection_tracking_specification, +tag_key, +tag_value +FROM aws.ec2.network_interface_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_interface_tags resource, see network_interfaces + diff --git a/website/docs/services/ec2/network_interfaces/index.md b/website/docs/services/ec2/network_interfaces/index.md new file mode 100644 index 0000000..cb7cd75 --- /dev/null +++ b/website/docs/services/ec2/network_interfaces/index.md @@ -0,0 +1,345 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network_interface resource or lists network_interfaces in a region + +## Overview + + + + + + + +
Namenetwork_interfaces
TypeResource
DescriptionThe AWS::EC2::NetworkInterface resource creates network interface
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description for the network interface.
stringAssigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.
stringThe primary IPv6 address
arrayAssigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
integerThe number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses
integerThe number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
stringReturns the primary private IP address of the network interface.
arrayAssigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
integerThe number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
booleanIf you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.
arrayA list of security group IDs associated with this network interface.
arrayOne or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
arrayAssigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
stringThe ID of the subnet to associate with the network interface.
booleanIndicates whether traffic to or from the instance is validated.
stringIndicates the type of network interface.
arrayReturns the secondary private IP addresses of the network interface.
stringThe ID of the VPC
integerThe number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
stringNetwork interface id.
arrayAn arbitrary set of tags (key-value pairs) for this network interface.
object
stringAWS region.
+ +For more information, see AWS::EC2::NetworkInterface. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all network_interfaces in a region. +```sql +SELECT +region, +description, +private_ip_address, +primary_ipv6_address, +private_ip_addresses, +secondary_private_ip_address_count, +ipv6_prefix_count, +primary_private_ip_address, +ipv4_prefixes, +ipv4_prefix_count, +enable_primary_ipv6, +group_set, +ipv6_addresses, +ipv6_prefixes, +subnet_id, +source_dest_check, +interface_type, +secondary_private_ip_addresses, +vpc_id, +ipv6_address_count, +id, +tags, +connection_tracking_specification +FROM aws.ec2.network_interfaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network_interface. +```sql +SELECT +region, +description, +private_ip_address, +primary_ipv6_address, +private_ip_addresses, +secondary_private_ip_address_count, +ipv6_prefix_count, +primary_private_ip_address, +ipv4_prefixes, +ipv4_prefix_count, +enable_primary_ipv6, +group_set, +ipv6_addresses, +ipv6_prefixes, +subnet_id, +source_dest_check, +interface_type, +secondary_private_ip_addresses, +vpc_id, +ipv6_address_count, +id, +tags, +connection_tracking_specification +FROM aws.ec2.network_interfaces +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_interface resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_interfaces ( + SubnetId, + region +) +SELECT +'{{ SubnetId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_interfaces ( + Description, + PrivateIpAddress, + PrivateIpAddresses, + SecondaryPrivateIpAddressCount, + Ipv6PrefixCount, + Ipv4Prefixes, + Ipv4PrefixCount, + EnablePrimaryIpv6, + GroupSet, + Ipv6Addresses, + Ipv6Prefixes, + SubnetId, + SourceDestCheck, + InterfaceType, + Ipv6AddressCount, + Tags, + ConnectionTrackingSpecification, + region +) +SELECT + '{{ Description }}', + '{{ PrivateIpAddress }}', + '{{ PrivateIpAddresses }}', + '{{ SecondaryPrivateIpAddressCount }}', + '{{ Ipv6PrefixCount }}', + '{{ Ipv4Prefixes }}', + '{{ Ipv4PrefixCount }}', + '{{ EnablePrimaryIpv6 }}', + '{{ GroupSet }}', + '{{ Ipv6Addresses }}', + '{{ Ipv6Prefixes }}', + '{{ SubnetId }}', + '{{ SourceDestCheck }}', + '{{ InterfaceType }}', + '{{ Ipv6AddressCount }}', + '{{ Tags }}', + '{{ ConnectionTrackingSpecification }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network_interface + props: + - name: Description + value: '{{ Description }}' + - name: PrivateIpAddress + value: '{{ PrivateIpAddress }}' + - name: PrivateIpAddresses + value: + - Primary: '{{ Primary }}' + PrivateIpAddress: '{{ PrivateIpAddress }}' + - name: SecondaryPrivateIpAddressCount + value: '{{ SecondaryPrivateIpAddressCount }}' + - name: Ipv6PrefixCount + value: '{{ Ipv6PrefixCount }}' + - name: Ipv4Prefixes + value: + - Ipv4Prefix: '{{ Ipv4Prefix }}' + - name: Ipv4PrefixCount + value: '{{ Ipv4PrefixCount }}' + - name: EnablePrimaryIpv6 + value: '{{ EnablePrimaryIpv6 }}' + - name: GroupSet + value: + - '{{ GroupSet[0] }}' + - name: Ipv6Addresses + value: + - Ipv6Address: '{{ Ipv6Address }}' + - name: Ipv6Prefixes + value: + - Ipv6Prefix: '{{ Ipv6Prefix }}' + - name: SubnetId + value: '{{ SubnetId }}' + - name: SourceDestCheck + value: '{{ SourceDestCheck }}' + - name: InterfaceType + value: '{{ InterfaceType }}' + - name: Ipv6AddressCount + value: '{{ Ipv6AddressCount }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ConnectionTrackingSpecification + value: + UdpTimeout: '{{ UdpTimeout }}' + TcpEstablishedTimeout: '{{ TcpEstablishedTimeout }}' + UdpStreamTimeout: '{{ UdpStreamTimeout }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.network_interfaces +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the network_interfaces resource, the following permissions are required: + +### Read +```json +ec2:DescribeNetworkInterfaces +``` + +### Create +```json +ec2:CreateNetworkInterface, +ec2:DescribeNetworkInterfaces, +ec2:CreateTags, +ec2:ModifyNetworkInterfaceAttribute, +ec2:ModifyPublicIpDnsNameOptions +``` + +### Update +```json +ec2:DescribeNetworkInterfaces, +ec2:ModifyNetworkInterfaceAttribute, +ec2:UnassignIpv6Addresses, +ec2:AssignIpv6Addresses, +ec2:DeleteTags, +ec2:CreateTags, +ec2:UnassignPrivateIpAddresses, +ec2:AssignPrivateIpAddresses, +ec2:ModifyPublicIpDnsNameOptions +``` + +### List +```json +ec2:DescribeNetworkInterfaces +``` + +### Delete +```json +ec2:DescribeNetworkInterfaces, +ec2:DeleteNetworkInterface +``` diff --git a/website/docs/services/ec2/network_interfaces_list_only/index.md b/website/docs/services/ec2/network_interfaces_list_only/index.md new file mode 100644 index 0000000..76d17e8 --- /dev/null +++ b/website/docs/services/ec2/network_interfaces_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_interfaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_interfaces_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_interfaces in a region or regions, for all properties use network_interfaces + +## Overview + + + + + + + +
Namenetwork_interfaces_list_only
TypeResource
DescriptionThe AWS::EC2::NetworkInterface resource creates network interface
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringNetwork interface id.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_interfaces in a region. +```sql +SELECT +region, +id +FROM aws.ec2.network_interfaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_interfaces_list_only resource, see network_interfaces + diff --git a/website/docs/services/ec2/network_performance_metric_subscriptions/index.md b/website/docs/services/ec2/network_performance_metric_subscriptions/index.md new file mode 100644 index 0000000..075ddac --- /dev/null +++ b/website/docs/services/ec2/network_performance_metric_subscriptions/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network_performance_metric_subscription resource or lists network_performance_metric_subscriptions in a region + +## Overview + + + + + + + +
Namenetwork_performance_metric_subscriptions
TypeResource
DescriptionResource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe starting Region or Availability Zone for metric to subscribe to.
stringThe target Region or Availability Zone for the metric to subscribe to.
stringThe metric type to subscribe to.
stringThe statistic to subscribe to.
stringAWS region.
+ +For more information, see AWS::EC2::NetworkPerformanceMetricSubscription. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all network_performance_metric_subscriptions in a region. +```sql +SELECT +region, +source, +destination, +metric, +statistic +FROM aws.ec2.network_performance_metric_subscriptions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network_performance_metric_subscription. +```sql +SELECT +region, +source, +destination, +metric, +statistic +FROM aws.ec2.network_performance_metric_subscriptions +WHERE region = 'us-east-1' AND data__Identifier = '|||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_performance_metric_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_performance_metric_subscriptions ( + Source, + Destination, + Metric, + Statistic, + region +) +SELECT +'{{ Source }}', + '{{ Destination }}', + '{{ Metric }}', + '{{ Statistic }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.network_performance_metric_subscriptions ( + Source, + Destination, + Metric, + Statistic, + region +) +SELECT + '{{ Source }}', + '{{ Destination }}', + '{{ Metric }}', + '{{ Statistic }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network_performance_metric_subscription + props: + - name: Source + value: '{{ Source }}' + - name: Destination + value: '{{ Destination }}' + - name: Metric + value: '{{ Metric }}' + - name: Statistic + value: '{{ Statistic }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.network_performance_metric_subscriptions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeAwsNetworkPerformanceMetricSubscriptions +``` + +### Delete +```json +ec2:DescribeAwsNetworkPerformanceMetricSubscriptions, +ec2:DisableAwsNetworkPerformanceMetricSubscription +``` + +### List +```json +ec2:DescribeAwsNetworkPerformanceMetricSubscriptions +``` diff --git a/website/docs/services/ec2/network_performance_metric_subscriptions_list_only/index.md b/website/docs/services/ec2/network_performance_metric_subscriptions_list_only/index.md new file mode 100644 index 0000000..eb14e94 --- /dev/null +++ b/website/docs/services/ec2/network_performance_metric_subscriptions_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: network_performance_metric_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_performance_metric_subscriptions_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_performance_metric_subscriptions in a region or regions, for all properties use network_performance_metric_subscriptions + +## Overview + + + + + + + +
Namenetwork_performance_metric_subscriptions_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe starting Region or Availability Zone for metric to subscribe to.
stringThe target Region or Availability Zone for the metric to subscribe to.
stringThe metric type to subscribe to.
stringThe statistic to subscribe to.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_performance_metric_subscriptions in a region. +```sql +SELECT +region, +source, +destination, +metric, +statistic +FROM aws.ec2.network_performance_metric_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_performance_metric_subscriptions_list_only resource, see network_performance_metric_subscriptions + diff --git a/website/docs/services/ec2/placement_group_tags/index.md b/website/docs/services/ec2/placement_group_tags/index.md new file mode 100644 index 0000000..92a5284 --- /dev/null +++ b/website/docs/services/ec2/placement_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: placement_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - placement_group_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for placement_groups in a region + +## Overview + + + + + + + +
Nameplacement_group_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::PlacementGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe placement strategy.
stringThe Group Name of Placement Group.
stringThe Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread
integerThe number of partitions. Valid only when **Strategy** is set to `partition`
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all placement_groups in a region. +```sql +SELECT +region, +strategy, +group_name, +spread_level, +partition_count, +tag_key, +tag_value +FROM aws.ec2.placement_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the placement_group_tags resource, see placement_groups + diff --git a/website/docs/services/ec2/placement_groups/index.md b/website/docs/services/ec2/placement_groups/index.md new file mode 100644 index 0000000..a87083b --- /dev/null +++ b/website/docs/services/ec2/placement_groups/index.md @@ -0,0 +1,219 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a placement_group resource or lists placement_groups in a region + +## Overview + + + + + + + +
Nameplacement_groups
TypeResource
DescriptionResource Type definition for AWS::EC2::PlacementGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe placement strategy.
stringThe Group Name of Placement Group.
stringThe Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread
integerThe number of partitions. Valid only when **Strategy** is set to `partition`
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EC2::PlacementGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all placement_groups in a region. +```sql +SELECT +region, +strategy, +group_name, +spread_level, +partition_count, +tags +FROM aws.ec2.placement_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual placement_group. +```sql +SELECT +region, +strategy, +group_name, +spread_level, +partition_count, +tags +FROM aws.ec2.placement_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new placement_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.placement_groups ( + Strategy, + SpreadLevel, + PartitionCount, + Tags, + region +) +SELECT +'{{ Strategy }}', + '{{ SpreadLevel }}', + '{{ PartitionCount }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.placement_groups ( + Strategy, + SpreadLevel, + PartitionCount, + Tags, + region +) +SELECT + '{{ Strategy }}', + '{{ SpreadLevel }}', + '{{ PartitionCount }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: placement_group + props: + - name: Strategy + value: '{{ Strategy }}' + - name: SpreadLevel + value: '{{ SpreadLevel }}' + - name: PartitionCount + value: '{{ PartitionCount }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.placement_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribePlacementGroups +``` + +### Delete +```json +ec2:DeletePlacementGroup, +ec2:DescribePlacementGroups +``` + +### List +```json +ec2:DescribePlacementGroups +``` diff --git a/website/docs/services/ec2/placement_groups_list_only/index.md b/website/docs/services/ec2/placement_groups_list_only/index.md new file mode 100644 index 0000000..91250aa --- /dev/null +++ b/website/docs/services/ec2/placement_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: placement_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - placement_groups_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists placement_groups in a region or regions, for all properties use placement_groups + +## Overview + + + + + + + +
Nameplacement_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::PlacementGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Group Name of Placement Group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all placement_groups in a region. +```sql +SELECT +region, +group_name +FROM aws.ec2.placement_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the placement_groups_list_only resource, see placement_groups + diff --git a/website/docs/services/ec2/prefix_list_tags/index.md b/website/docs/services/ec2/prefix_list_tags/index.md new file mode 100644 index 0000000..3100238 --- /dev/null +++ b/website/docs/services/ec2/prefix_list_tags/index.md @@ -0,0 +1,91 @@ +--- +title: prefix_list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - prefix_list_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for prefix_lists in a region + +## Overview + + + + + + + +
Nameprefix_list_tags
TypeResource
DescriptionResource schema of AWS::EC2::PrefixList Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of Prefix List.
stringId of Prefix List.
stringOwner Id of Prefix List.
stringIp Version of Prefix List.
integerMax Entries of Prefix List.
integerVersion of Prefix List.
arrayEntries of Prefix List.
stringThe Amazon Resource Name (ARN) of the Prefix List.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all prefix_lists in a region. +```sql +SELECT +region, +prefix_list_name, +prefix_list_id, +owner_id, +address_family, +max_entries, +version, +entries, +arn, +tag_key, +tag_value +FROM aws.ec2.prefix_list_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prefix_list_tags resource, see prefix_lists + diff --git a/website/docs/services/ec2/prefix_lists/index.md b/website/docs/services/ec2/prefix_lists/index.md new file mode 100644 index 0000000..182e945 --- /dev/null +++ b/website/docs/services/ec2/prefix_lists/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a prefix_list resource or lists prefix_lists in a region + +## Overview + + + + + + + +
Nameprefix_lists
TypeResource
DescriptionResource schema of AWS::EC2::PrefixList Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of Prefix List.
stringId of Prefix List.
stringOwner Id of Prefix List.
stringIp Version of Prefix List.
integerMax Entries of Prefix List.
integerVersion of Prefix List.
arrayTags for Prefix List
arrayEntries of Prefix List.
stringThe Amazon Resource Name (ARN) of the Prefix List.
stringAWS region.
+ +For more information, see AWS::EC2::PrefixList. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all prefix_lists in a region. +```sql +SELECT +region, +prefix_list_name, +prefix_list_id, +owner_id, +address_family, +max_entries, +version, +tags, +entries, +arn +FROM aws.ec2.prefix_lists +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual prefix_list. +```sql +SELECT +region, +prefix_list_name, +prefix_list_id, +owner_id, +address_family, +max_entries, +version, +tags, +entries, +arn +FROM aws.ec2.prefix_lists +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new prefix_list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.prefix_lists ( + PrefixListName, + AddressFamily, + region +) +SELECT +'{{ PrefixListName }}', + '{{ AddressFamily }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.prefix_lists ( + PrefixListName, + AddressFamily, + MaxEntries, + Tags, + Entries, + region +) +SELECT + '{{ PrefixListName }}', + '{{ AddressFamily }}', + '{{ MaxEntries }}', + '{{ Tags }}', + '{{ Entries }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: prefix_list + props: + - name: PrefixListName + value: '{{ PrefixListName }}' + - name: AddressFamily + value: '{{ AddressFamily }}' + - name: MaxEntries + value: '{{ MaxEntries }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Entries + value: + - Cidr: '{{ Cidr }}' + Description: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.prefix_lists +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +EC2:GetManagedPrefixListEntries, +EC2:DescribeManagedPrefixLists +``` + +### Update +```json +EC2:DescribeManagedPrefixLists, +EC2:GetManagedPrefixListEntries, +EC2:ModifyManagedPrefixList, +EC2:CreateTags, +EC2:DeleteTags +``` + +### Delete +```json +EC2:DeleteManagedPrefixList, +EC2:DescribeManagedPrefixLists +``` + +### List +```json +EC2:DescribeManagedPrefixLists, +EC2:GetManagedPrefixListEntries +``` diff --git a/website/docs/services/ec2/prefix_lists_list_only/index.md b/website/docs/services/ec2/prefix_lists_list_only/index.md new file mode 100644 index 0000000..95371f1 --- /dev/null +++ b/website/docs/services/ec2/prefix_lists_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: prefix_lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - prefix_lists_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists prefix_lists in a region or regions, for all properties use prefix_lists + +## Overview + + + + + + + +
Nameprefix_lists_list_only
TypeResource
DescriptionResource schema of AWS::EC2::PrefixList Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId of Prefix List.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all prefix_lists in a region. +```sql +SELECT +region, +prefix_list_id +FROM aws.ec2.prefix_lists_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prefix_lists_list_only resource, see prefix_lists + diff --git a/website/docs/services/ec2/route_table_tags/index.md b/website/docs/services/ec2/route_table_tags/index.md new file mode 100644 index 0000000..c5caee1 --- /dev/null +++ b/website/docs/services/ec2/route_table_tags/index.md @@ -0,0 +1,79 @@ +--- +title: route_table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - route_table_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for route_tables in a region + +## Overview + + + + + + + +
Nameroute_table_tags
TypeResource
DescriptionSpecifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringThe ID of the VPC.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all route_tables in a region. +```sql +SELECT +region, +route_table_id, +vpc_id, +tag_key, +tag_value +FROM aws.ec2.route_table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_table_tags resource, see route_tables + diff --git a/website/docs/services/ec2/route_tables/index.md b/website/docs/services/ec2/route_tables/index.md new file mode 100644 index 0000000..c29b472 --- /dev/null +++ b/website/docs/services/ec2/route_tables/index.md @@ -0,0 +1,211 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a route_table resource or lists 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.
For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringThe ID of the VPC.
arrayAny tags assigned to the route table.
stringAWS region.
+ +For more information, see AWS::EC2::RouteTable. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all route_tables in a region. +```sql +SELECT +region, +route_table_id, +vpc_id, +tags +FROM aws.ec2.route_tables +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual route_table. +```sql +SELECT +region, +route_table_id, +vpc_id, +tags +FROM aws.ec2.route_tables +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new route_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.route_tables ( + VpcId, + region +) +SELECT +'{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.route_tables ( + VpcId, + Tags, + region +) +SELECT + '{{ VpcId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: route_table + props: + - name: VpcId + value: '{{ VpcId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.route_tables +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the route_tables resource, the following permissions are required: + +### Read +```json +ec2:DescribeRouteTables +``` + +### Create +```json +ec2:CreateRouteTable, +ec2:CreateTags, +ec2:DescribeRouteTables +``` + +### Update +```json +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeRouteTables +``` + +### List +```json +ec2:DescribeRouteTables +``` + +### Delete +```json +ec2:DescribeRouteTables, +ec2:DeleteRouteTable +``` diff --git a/website/docs/services/ec2/route_tables_list_only/index.md b/website/docs/services/ec2/route_tables_list_only/index.md new file mode 100644 index 0000000..eb5065a --- /dev/null +++ b/website/docs/services/ec2/route_tables_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: route_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - route_tables_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists route_tables in a region or regions, for all properties use route_tables + +## Overview + + + + + + + +
Nameroute_tables_list_only
TypeResource
DescriptionSpecifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all route_tables in a region. +```sql +SELECT +region, +route_table_id +FROM aws.ec2.route_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_tables_list_only resource, see route_tables + diff --git a/website/docs/services/ec2/routes/index.md b/website/docs/services/ec2/routes/index.md new file mode 100644 index 0000000..6fd9a47 --- /dev/null +++ b/website/docs/services/ec2/routes/index.md @@ -0,0 +1,300 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a route resource or lists 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*.
You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.
If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the AWS::EC2::Route resource to explicitly declare a dependency on the AWS::EC2::TransitGatewayAttachment resource.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
string
stringThe Amazon Resource Name (ARN) of the core network.
stringThe IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
stringThe IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
stringThe ID of a prefix list used for the destination match.
string[IPv6 traffic only] The ID of an egress-only internet gateway.
stringThe ID of an internet gateway or virtual private gateway attached to your VPC.
stringThe ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
stringThe ID of the local gateway.
string[IPv4 traffic only] The ID of a NAT gateway.
stringThe ID of a network interface.
stringThe ID of the route table for the route.
stringThe ID of a transit gateway.
stringThe ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
stringThe ID of a VPC peering connection.
stringAWS region.
+ +For more information, see AWS::EC2::Route. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all routes in a region. +```sql +SELECT +region, +carrier_gateway_id, +cidr_block, +core_network_arn, +destination_cidr_block, +destination_ipv6_cidr_block, +destination_prefix_list_id, +egress_only_internet_gateway_id, +gateway_id, +instance_id, +local_gateway_id, +nat_gateway_id, +network_interface_id, +route_table_id, +transit_gateway_id, +vpc_endpoint_id, +vpc_peering_connection_id +FROM aws.ec2.routes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual route. +```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.routes +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.routes ( + RouteTableId, + region +) +SELECT +'{{ RouteTableId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.routes ( + CarrierGatewayId, + CoreNetworkArn, + DestinationCidrBlock, + DestinationIpv6CidrBlock, + DestinationPrefixListId, + EgressOnlyInternetGatewayId, + GatewayId, + InstanceId, + LocalGatewayId, + NatGatewayId, + NetworkInterfaceId, + RouteTableId, + TransitGatewayId, + VpcEndpointId, + VpcPeeringConnectionId, + region +) +SELECT + '{{ CarrierGatewayId }}', + '{{ CoreNetworkArn }}', + '{{ DestinationCidrBlock }}', + '{{ DestinationIpv6CidrBlock }}', + '{{ DestinationPrefixListId }}', + '{{ EgressOnlyInternetGatewayId }}', + '{{ GatewayId }}', + '{{ InstanceId }}', + '{{ LocalGatewayId }}', + '{{ NatGatewayId }}', + '{{ NetworkInterfaceId }}', + '{{ RouteTableId }}', + '{{ TransitGatewayId }}', + '{{ VpcEndpointId }}', + '{{ VpcPeeringConnectionId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: route + props: + - name: CarrierGatewayId + value: '{{ CarrierGatewayId }}' + - name: CoreNetworkArn + value: '{{ CoreNetworkArn }}' + - name: DestinationCidrBlock + value: '{{ DestinationCidrBlock }}' + - name: DestinationIpv6CidrBlock + value: '{{ DestinationIpv6CidrBlock }}' + - name: DestinationPrefixListId + value: '{{ DestinationPrefixListId }}' + - name: EgressOnlyInternetGatewayId + value: '{{ EgressOnlyInternetGatewayId }}' + - name: GatewayId + value: '{{ GatewayId }}' + - name: InstanceId + value: '{{ InstanceId }}' + - name: LocalGatewayId + value: '{{ LocalGatewayId }}' + - name: NatGatewayId + value: '{{ NatGatewayId }}' + - name: NetworkInterfaceId + value: '{{ NetworkInterfaceId }}' + - name: RouteTableId + value: '{{ RouteTableId }}' + - name: TransitGatewayId + value: '{{ TransitGatewayId }}' + - name: VpcEndpointId + value: '{{ VpcEndpointId }}' + - name: VpcPeeringConnectionId + value: '{{ VpcPeeringConnectionId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.routes +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the routes resource, the following permissions are required: + +### Create +```json +ec2:CreateRoute, +ec2:DescribeRouteTables, +ec2:DescribeNetworkInterfaces +``` + +### Read +```json +ec2:DescribeRouteTables +``` + +### Update +```json +ec2:ReplaceRoute, +ec2:DescribeRouteTables, +ec2:DescribeNetworkInterfaces +``` + +### Delete +```json +ec2:DeleteRoute, +ec2:DescribeRouteTables +``` + +### List +```json +ec2:DescribeRouteTables +``` diff --git a/website/docs/services/ec2/routes_list_only/index.md b/website/docs/services/ec2/routes_list_only/index.md new file mode 100644 index 0000000..400db35 --- /dev/null +++ b/website/docs/services/ec2/routes_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - routes_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists routes in a region or regions, for all properties use routes + +## Overview + + + + + + + +
Nameroutes_list_only
TypeResource
DescriptionSpecifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide*.
You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.
If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the AWS::EC2::Route resource to explicitly declare a dependency on the AWS::EC2::TransitGatewayAttachment resource.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe ID of the route table for the route.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all routes in a region. +```sql +SELECT +region, +route_table_id, +cidr_block +FROM aws.ec2.routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routes_list_only resource, see routes + diff --git a/website/docs/services/ec2/security_group_egresses/index.md b/website/docs/services/ec2/security_group_egresses/index.md new file mode 100644 index 0000000..5caa9d0 --- /dev/null +++ b/website/docs/services/ec2/security_group_egresses/index.md @@ -0,0 +1,258 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_group_egress resource or lists security_group_egresses in a region + +## Overview + + + + + + + +
Namesecurity_group_egresses
TypeResource
DescriptionAdds the specified outbound (egress) rule to a security group.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).
You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.
You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IPv4 address range, in CIDR format.
You must specify exactly one of the following: CidrIp, CidrIpv6, DestinationPrefixListId, or DestinationSecurityGroupId.
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
stringThe IPv6 address range, in CIDR format.
You must specify exactly one of the following: CidrIp, CidrIpv6, DestinationPrefixListId, or DestinationSecurityGroupId.
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
stringThe description of an egress (outbound) security group rule.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
integerIf the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
integerIf the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
stringThe IP protocol name (tcp, udp, icmp, icmpv6) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
stringThe ID of the security group.
You must specify exactly one of the following: CidrIp, CidrIpv6, DestinationPrefixListId, or DestinationSecurityGroupId.
string
stringThe prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group.
You must specify exactly one of the following: CidrIp, CidrIpv6, DestinationPrefixListId, or DestinationSecurityGroupId.
stringThe ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
stringAWS region.
+ +For more information, see AWS::EC2::SecurityGroupEgress. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_group_egresses in a region. +```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_egresses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_group_egress. +```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_egresses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_group_egress resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.security_group_egresses ( + IpProtocol, + GroupId, + region +) +SELECT +'{{ IpProtocol }}', + '{{ GroupId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.security_group_egresses ( + CidrIp, + CidrIpv6, + Description, + FromPort, + ToPort, + IpProtocol, + DestinationSecurityGroupId, + DestinationPrefixListId, + GroupId, + region +) +SELECT + '{{ CidrIp }}', + '{{ CidrIpv6 }}', + '{{ Description }}', + '{{ FromPort }}', + '{{ ToPort }}', + '{{ IpProtocol }}', + '{{ DestinationSecurityGroupId }}', + '{{ DestinationPrefixListId }}', + '{{ GroupId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_group_egress + props: + - name: CidrIp + value: '{{ CidrIp }}' + - name: CidrIpv6 + value: '{{ CidrIpv6 }}' + - name: Description + value: '{{ Description }}' + - name: FromPort + value: '{{ FromPort }}' + - name: ToPort + value: '{{ ToPort }}' + - name: IpProtocol + value: '{{ IpProtocol }}' + - name: DestinationSecurityGroupId + value: '{{ DestinationSecurityGroupId }}' + - name: DestinationPrefixListId + value: '{{ DestinationPrefixListId }}' + - name: GroupId + value: '{{ GroupId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.security_group_egresses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the security_group_egresses resource, the following permissions are required: + +### Read +```json +ec2:DescribeSecurityGroupRules +``` + +### Create +```json +ec2:AuthorizeSecurityGroupEgress, +ec2:RevokeSecurityGroupEgress, +ec2:DescribeSecurityGroupRules +``` + +### Update +```json +ec2:UpdateSecurityGroupRuleDescriptionsEgress +``` + +### List +```json +ec2:DescribeSecurityGroupRules +``` + +### Delete +```json +ec2:RevokeSecurityGroupEgress, +ec2:DescribeSecurityGroupRules +``` diff --git a/website/docs/services/ec2/security_group_egresses_list_only/index.md b/website/docs/services/ec2/security_group_egresses_list_only/index.md new file mode 100644 index 0000000..b42be94 --- /dev/null +++ b/website/docs/services/ec2/security_group_egresses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: security_group_egresses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_egresses_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_group_egresses in a region or regions, for all properties use security_group_egresses + +## Overview + + + + + + + +
Namesecurity_group_egresses_list_only
TypeResource
DescriptionAdds the specified outbound (egress) rule to a security group.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).
You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.
You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_group_egresses in a region. +```sql +SELECT +region, +id +FROM aws.ec2.security_group_egresses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_group_egresses_list_only resource, see security_group_egresses + diff --git a/website/docs/services/ec2/security_group_ingresses/index.md b/website/docs/services/ec2/security_group_ingresses/index.md new file mode 100644 index 0000000..fb619f4 --- /dev/null +++ b/website/docs/services/ec2/security_group_ingresses/index.md @@ -0,0 +1,277 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_group_ingress resource or lists security_group_ingresses in a region + +## Overview + + + + + + + +
Namesecurity_group_ingresses
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroupIngress
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Security Group Rule Id
stringThe IPv4 ranges
string[VPC only] The IPv6 ranges
stringUpdates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
integerThe start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Use this for ICMP and any protocol that uses ports.
stringThe ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
stringThe name of the security group.
stringThe IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
string[EC2-VPC only] The ID of a prefix list.
stringThe ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
string[EC2-Classic, default VPC] The name of the source security group.
You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
string[nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.
If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.
integerThe end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Use this for ICMP and any protocol that uses ports.
stringAWS region.
+ +For more information, see AWS::EC2::SecurityGroupIngress. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_group_ingresses in a region. +```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_ingresses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_group_ingress. +```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_ingresses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_group_ingress resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.security_group_ingresses ( + IpProtocol, + region +) +SELECT +'{{ IpProtocol }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.security_group_ingresses ( + CidrIp, + CidrIpv6, + Description, + FromPort, + GroupId, + GroupName, + IpProtocol, + SourcePrefixListId, + SourceSecurityGroupId, + SourceSecurityGroupName, + SourceSecurityGroupOwnerId, + ToPort, + region +) +SELECT + '{{ CidrIp }}', + '{{ CidrIpv6 }}', + '{{ Description }}', + '{{ FromPort }}', + '{{ GroupId }}', + '{{ GroupName }}', + '{{ IpProtocol }}', + '{{ SourcePrefixListId }}', + '{{ SourceSecurityGroupId }}', + '{{ SourceSecurityGroupName }}', + '{{ SourceSecurityGroupOwnerId }}', + '{{ ToPort }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_group_ingress + props: + - name: CidrIp + value: '{{ CidrIp }}' + - name: CidrIpv6 + value: '{{ CidrIpv6 }}' + - name: Description + value: '{{ Description }}' + - name: FromPort + value: '{{ FromPort }}' + - name: GroupId + value: '{{ GroupId }}' + - name: GroupName + value: '{{ GroupName }}' + - name: IpProtocol + value: '{{ IpProtocol }}' + - name: SourcePrefixListId + value: '{{ SourcePrefixListId }}' + - name: SourceSecurityGroupId + value: '{{ SourceSecurityGroupId }}' + - name: SourceSecurityGroupName + value: '{{ SourceSecurityGroupName }}' + - name: SourceSecurityGroupOwnerId + value: '{{ SourceSecurityGroupOwnerId }}' + - name: ToPort + value: '{{ ToPort }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.security_group_ingresses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the security_group_ingresses resource, the following permissions are required: + +### Create +```json +ec2:DescribeSecurityGroupRules, +ec2:AuthorizeSecurityGroupIngress +``` + +### Update +```json +ec2:UpdateSecurityGroupRuleDescriptionsIngress +``` + +### Delete +```json +ec2:DescribeSecurityGroupRules, +ec2:RevokeSecurityGroupIngress +``` + +### Read +```json +ec2:DescribeSecurityGroups, +ec2:DescribeSecurityGroupRules +``` + +### List +```json +ec2:DescribeSecurityGroupRules +``` diff --git a/website/docs/services/ec2/security_group_ingresses_list_only/index.md b/website/docs/services/ec2/security_group_ingresses_list_only/index.md new file mode 100644 index 0000000..01eabdf --- /dev/null +++ b/website/docs/services/ec2/security_group_ingresses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: security_group_ingresses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_ingresses_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_group_ingresses in a region or regions, for all properties use security_group_ingresses + +## Overview + + + + + + + +
Namesecurity_group_ingresses_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroupIngress
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Security Group Rule Id
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_group_ingresses in a region. +```sql +SELECT +region, +id +FROM aws.ec2.security_group_ingresses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_group_ingresses_list_only resource, see security_group_ingresses + diff --git a/website/docs/services/ec2/security_group_tags/index.md b/website/docs/services/ec2/security_group_tags/index.md new file mode 100644 index 0000000..fc5ffb6 --- /dev/null +++ b/website/docs/services/ec2/security_group_tags/index.md @@ -0,0 +1,89 @@ +--- +title: security_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for security_groups in a region + +## Overview + + + + + + + +
Namesecurity_group_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroup
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description for the security group.
stringThe name of the security group.
stringThe ID of the VPC for the security group.
stringThe group name or group ID depending on whether the SG is created in default or specific VPC
arrayThe inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
array[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
stringThe group ID of the specified security group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all security_groups in a region. +```sql +SELECT +region, +group_description, +group_name, +vpc_id, +id, +security_group_ingress, +security_group_egress, +group_id, +tag_key, +tag_value +FROM aws.ec2.security_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_group_tags resource, see security_groups + diff --git a/website/docs/services/ec2/security_group_vpc_associations/index.md b/website/docs/services/ec2/security_group_vpc_associations/index.md new file mode 100644 index 0000000..5925479 --- /dev/null +++ b/website/docs/services/ec2/security_group_vpc_associations/index.md @@ -0,0 +1,204 @@ +--- +title: security_group_vpc_associations +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_group_vpc_association resource or lists security_group_vpc_associations in a region + +## Overview + + + + + + + +
Namesecurity_group_vpc_associations
TypeResource
DescriptionResource type definition for the AWS::EC2::SecurityGroupVpcAssociation resource
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe group ID of the specified security group.
stringThe ID of the VPC in the security group vpc association.
stringThe owner of the VPC in the security group vpc association.
stringThe state of the security group vpc association.
stringThe reason for the state of the security group vpc association.
stringAWS region.
+ +For more information, see AWS::EC2::SecurityGroupVpcAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_group_vpc_associations in a region. +```sql +SELECT +region, +group_id, +vpc_id, +vpc_owner_id, +state, +state_reason +FROM aws.ec2.security_group_vpc_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_group_vpc_association. +```sql +SELECT +region, +group_id, +vpc_id, +vpc_owner_id, +state, +state_reason +FROM aws.ec2.security_group_vpc_associations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_group_vpc_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.security_group_vpc_associations ( + GroupId, + VpcId, + region +) +SELECT +'{{ GroupId }}', + '{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.security_group_vpc_associations ( + GroupId, + VpcId, + region +) +SELECT + '{{ GroupId }}', + '{{ VpcId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_group_vpc_association + props: + - name: GroupId + value: '{{ GroupId }}' + - name: VpcId + value: '{{ VpcId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.security_group_vpc_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the security_group_vpc_associations resource, the following permissions are required: + +### Create +```json +ec2:AssociateSecurityGroupVpc, +ec2:DescribeSecurityGroupVpcAssociations +``` + +### Read +```json +ec2:DescribeSecurityGroupVpcAssociations +``` + +### Delete +```json +ec2:DisassociateSecurityGroupVpc, +ec2:DescribeSecurityGroupVpcAssociations +``` + +### List +```json +ec2:DescribeSecurityGroupVpcAssociations +``` diff --git a/website/docs/services/ec2/security_group_vpc_associations_list_only/index.md b/website/docs/services/ec2/security_group_vpc_associations_list_only/index.md new file mode 100644 index 0000000..b85f9ec --- /dev/null +++ b/website/docs/services/ec2/security_group_vpc_associations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: security_group_vpc_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_vpc_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_group_vpc_associations in a region or regions, for all properties use security_group_vpc_associations + +## Overview + + + + + + + +
Namesecurity_group_vpc_associations_list_only
TypeResource
DescriptionResource type definition for the AWS::EC2::SecurityGroupVpcAssociation resource
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe group ID of the specified security group.
stringThe ID of the VPC in the security group vpc association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_group_vpc_associations in a region. +```sql +SELECT +region, +group_id, +vpc_id +FROM aws.ec2.security_group_vpc_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_group_vpc_associations_list_only resource, see security_group_vpc_associations + diff --git a/website/docs/services/ec2/security_groups/index.md b/website/docs/services/ec2/security_groups/index.md new file mode 100644 index 0000000..5c954a4 --- /dev/null +++ b/website/docs/services/ec2/security_groups/index.md @@ -0,0 +1,268 @@ +--- +title: security_groups +hide_title: false +hide_table_of_contents: false +keywords: + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_group resource or lists security_groups in a region + +## Overview + + + + + + + +
Namesecurity_groups
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroup
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringA description for the security group.
stringThe name of the security group.
stringThe ID of the VPC for the security group.
stringThe group name or group ID depending on whether the SG is created in default or specific VPC
arrayThe inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
array[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
arrayAny tags assigned to the security group.
stringThe group ID of the specified security group.
stringAWS region.
+ +For more information, see AWS::EC2::SecurityGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_groups in a region. +```sql +SELECT +region, +group_description, +group_name, +vpc_id, +id, +security_group_ingress, +security_group_egress, +tags, +group_id +FROM aws.ec2.security_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_group. +```sql +SELECT +region, +group_description, +group_name, +vpc_id, +id, +security_group_ingress, +security_group_egress, +tags, +group_id +FROM aws.ec2.security_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.security_groups ( + GroupDescription, + region +) +SELECT +'{{ GroupDescription }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.security_groups ( + GroupDescription, + GroupName, + VpcId, + SecurityGroupIngress, + SecurityGroupEgress, + Tags, + region +) +SELECT + '{{ GroupDescription }}', + '{{ GroupName }}', + '{{ VpcId }}', + '{{ SecurityGroupIngress }}', + '{{ SecurityGroupEgress }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_group + props: + - name: GroupDescription + value: '{{ GroupDescription }}' + - name: GroupName + value: '{{ GroupName }}' + - name: VpcId + value: '{{ VpcId }}' + - name: SecurityGroupIngress + value: + - CidrIp: '{{ CidrIp }}' + CidrIpv6: '{{ CidrIpv6 }}' + Description: '{{ Description }}' + FromPort: '{{ FromPort }}' + SourceSecurityGroupName: '{{ SourceSecurityGroupName }}' + ToPort: '{{ ToPort }}' + SourceSecurityGroupOwnerId: '{{ SourceSecurityGroupOwnerId }}' + IpProtocol: '{{ IpProtocol }}' + SourceSecurityGroupId: '{{ SourceSecurityGroupId }}' + SourcePrefixListId: '{{ SourcePrefixListId }}' + - name: SecurityGroupEgress + value: + - CidrIp: '{{ CidrIp }}' + CidrIpv6: '{{ CidrIpv6 }}' + Description: '{{ Description }}' + FromPort: '{{ FromPort }}' + ToPort: '{{ ToPort }}' + IpProtocol: '{{ IpProtocol }}' + DestinationSecurityGroupId: '{{ DestinationSecurityGroupId }}' + DestinationPrefixListId: '{{ DestinationPrefixListId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.security_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the security_groups resource, the following permissions are required: + +### Read +```json +ec2:DescribeSecurityGroups +``` + +### Create +```json +ec2:CreateSecurityGroup, +ec2:DescribeSecurityGroups, +ec2:RevokeSecurityGroupEgress, +ec2:AuthorizeSecurityGroupEgress, +ec2:AuthorizeSecurityGroupIngress, +ec2:CreateTags +``` + +### Update +```json +ec2:RevokeSecurityGroupEgress, +ec2:RevokeSecurityGroupIngress, +ec2:DescribeSecurityGroups, +ec2:AuthorizeSecurityGroupEgress, +ec2:AuthorizeSecurityGroupIngress, +ec2:CreateTags, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeSecurityGroups +``` + +### Delete +```json +ec2:DescribeSecurityGroups, +ec2:DeleteSecurityGroup, +ec2:DescribeInstances +``` diff --git a/website/docs/services/ec2/security_groups_list_only/index.md b/website/docs/services/ec2/security_groups_list_only/index.md new file mode 100644 index 0000000..3b93d71 --- /dev/null +++ b/website/docs/services/ec2/security_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: security_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_groups_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_groups in a region or regions, for all properties use security_groups + +## Overview + + + + + + + +
Namesecurity_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe group name or group ID depending on whether the SG is created in default or specific VPC
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_groups in a region. +```sql +SELECT +region, +id +FROM aws.ec2.security_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_groups_list_only resource, see security_groups + diff --git a/website/docs/services/ec2/snapshot_block_public_accesses/index.md b/website/docs/services/ec2/snapshot_block_public_accesses/index.md new file mode 100644 index 0000000..7ace986 --- /dev/null +++ b/website/docs/services/ec2/snapshot_block_public_accesses/index.md @@ -0,0 +1,200 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a snapshot_block_public_access resource or lists snapshot_block_public_accesses in a region + +## Overview + + + + + + + +
Namesnapshot_block_public_accesses
TypeResource
DescriptionResource Type definition for AWS::EC2::SnapshotBlockPublicAccess
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe state of EBS Snapshot Block Public Access.
stringThe identifier for the specified AWS account.
stringAWS region.
+ +For more information, see AWS::EC2::SnapshotBlockPublicAccess. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all snapshot_block_public_accesses in a region. +```sql +SELECT +region, +state, +account_id +FROM aws.ec2.snapshot_block_public_accesses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual snapshot_block_public_access. +```sql +SELECT +region, +state, +account_id +FROM aws.ec2.snapshot_block_public_accesses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new snapshot_block_public_access resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.snapshot_block_public_accesses ( + State, + region +) +SELECT +'{{ State }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.snapshot_block_public_accesses ( + State, + region +) +SELECT + '{{ State }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: snapshot_block_public_access + props: + - name: State + value: '{{ State }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.snapshot_block_public_accesses +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:GetSnapshotBlockPublicAccessState +``` + +### Update +```json +ec2:EnableSnapshotBlockPublicAccess, +ec2:GetSnapshotBlockPublicAccessState +``` + +### Delete +```json +ec2:DisableSnapshotBlockPublicAccess, +ec2:GetSnapshotBlockPublicAccessState +``` + +### List +```json +ec2:GetSnapshotBlockPublicAccessState +``` diff --git a/website/docs/services/ec2/snapshot_block_public_accesses_list_only/index.md b/website/docs/services/ec2/snapshot_block_public_accesses_list_only/index.md new file mode 100644 index 0000000..da44fc6 --- /dev/null +++ b/website/docs/services/ec2/snapshot_block_public_accesses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: snapshot_block_public_accesses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - snapshot_block_public_accesses_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists snapshot_block_public_accesses in a region or regions, for all properties use snapshot_block_public_accesses + +## Overview + + + + + + + +
Namesnapshot_block_public_accesses_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::SnapshotBlockPublicAccess
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier for the specified AWS account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all snapshot_block_public_accesses in a region. +```sql +SELECT +region, +account_id +FROM aws.ec2.snapshot_block_public_accesses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the snapshot_block_public_accesses_list_only resource, see snapshot_block_public_accesses + diff --git a/website/docs/services/ec2/spot_fleets/index.md b/website/docs/services/ec2/spot_fleets/index.md new file mode 100644 index 0000000..84c564c --- /dev/null +++ b/website/docs/services/ec2/spot_fleets/index.md @@ -0,0 +1,355 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a spot_fleet resource or lists spot_fleets in a region + +## Overview + + + + + + + +
Namespot_fleets
TypeResource
DescriptionResource Type definition for AWS::EC2::SpotFleet
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
object
stringAWS region.
+ +For more information, see AWS::EC2::SpotFleet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all spot_fleets in a region. +```sql +SELECT +region, +id, +spot_fleet_request_config_data +FROM aws.ec2.spot_fleets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual spot_fleet. +```sql +SELECT +region, +id, +spot_fleet_request_config_data +FROM aws.ec2.spot_fleets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new spot_fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.spot_fleets ( + SpotFleetRequestConfigData, + region +) +SELECT +'{{ SpotFleetRequestConfigData }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.spot_fleets ( + SpotFleetRequestConfigData, + region +) +SELECT + '{{ SpotFleetRequestConfigData }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: spot_fleet + props: + - name: SpotFleetRequestConfigData + value: + AllocationStrategy: '{{ AllocationStrategy }}' + Context: '{{ Context }}' + ExcessCapacityTerminationPolicy: '{{ ExcessCapacityTerminationPolicy }}' + IamFleetRole: '{{ IamFleetRole }}' + InstanceInterruptionBehavior: '{{ InstanceInterruptionBehavior }}' + InstancePoolsToUseCount: '{{ InstancePoolsToUseCount }}' + LaunchSpecifications: + - BlockDeviceMappings: + - DeviceName: '{{ DeviceName }}' + Ebs: + DeleteOnTermination: '{{ DeleteOnTermination }}' + Encrypted: '{{ Encrypted }}' + Iops: '{{ Iops }}' + SnapshotId: '{{ SnapshotId }}' + VolumeSize: '{{ VolumeSize }}' + VolumeType: '{{ VolumeType }}' + NoDevice: '{{ NoDevice }}' + VirtualName: '{{ VirtualName }}' + EbsOptimized: '{{ EbsOptimized }}' + IamInstanceProfile: + Arn: '{{ Arn }}' + ImageId: '{{ ImageId }}' + InstanceType: '{{ InstanceType }}' + KernelId: '{{ KernelId }}' + KeyName: '{{ KeyName }}' + Monitoring: + Enabled: '{{ Enabled }}' + NetworkInterfaces: + - AssociatePublicIpAddress: '{{ AssociatePublicIpAddress }}' + DeleteOnTermination: '{{ DeleteOnTermination }}' + Description: '{{ Description }}' + DeviceIndex: '{{ DeviceIndex }}' + Groups: + - '{{ Groups[0] }}' + Ipv6AddressCount: '{{ Ipv6AddressCount }}' + Ipv6Addresses: + - Ipv6Address: '{{ Ipv6Address }}' + NetworkInterfaceId: '{{ NetworkInterfaceId }}' + PrivateIpAddresses: + - Primary: '{{ Primary }}' + PrivateIpAddress: '{{ PrivateIpAddress }}' + SecondaryPrivateIpAddressCount: '{{ SecondaryPrivateIpAddressCount }}' + SubnetId: '{{ SubnetId }}' + Placement: + AvailabilityZone: '{{ AvailabilityZone }}' + GroupName: '{{ GroupName }}' + Tenancy: '{{ Tenancy }}' + RamdiskId: '{{ RamdiskId }}' + SecurityGroups: + - GroupId: '{{ GroupId }}' + SpotPrice: '{{ SpotPrice }}' + SubnetId: '{{ SubnetId }}' + TagSpecifications: + - ResourceType: '{{ ResourceType }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + UserData: '{{ UserData }}' + WeightedCapacity: null + InstanceRequirements: + VCpuCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + MemoryMiB: + Min: '{{ Min }}' + Max: '{{ Max }}' + CpuManufacturers: + - '{{ CpuManufacturers[0] }}' + MemoryGiBPerVCpu: + Min: null + Max: null + AllowedInstanceTypes: + - '{{ AllowedInstanceTypes[0] }}' + ExcludedInstanceTypes: + - '{{ ExcludedInstanceTypes[0] }}' + InstanceGenerations: + - '{{ InstanceGenerations[0] }}' + SpotMaxPricePercentageOverLowestPrice: '{{ SpotMaxPricePercentageOverLowestPrice }}' + OnDemandMaxPricePercentageOverLowestPrice: '{{ OnDemandMaxPricePercentageOverLowestPrice }}' + MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: '{{ MaxSpotPriceAsPercentageOfOptimalOnDemandPrice }}' + BareMetal: '{{ BareMetal }}' + BurstablePerformance: '{{ BurstablePerformance }}' + RequireHibernateSupport: '{{ RequireHibernateSupport }}' + NetworkBandwidthGbps: + Min: null + Max: null + NetworkInterfaceCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + LocalStorage: '{{ LocalStorage }}' + LocalStorageTypes: + - '{{ LocalStorageTypes[0] }}' + TotalLocalStorageGB: + Min: null + Max: null + BaselineEbsBandwidthMbps: + Min: '{{ Min }}' + Max: '{{ Max }}' + AcceleratorTypes: + - '{{ AcceleratorTypes[0] }}' + AcceleratorCount: + Min: '{{ Min }}' + Max: '{{ Max }}' + AcceleratorManufacturers: + - '{{ AcceleratorManufacturers[0] }}' + AcceleratorNames: + - '{{ AcceleratorNames[0] }}' + AcceleratorTotalMemoryMiB: + Min: '{{ Min }}' + Max: '{{ Max }}' + BaselinePerformanceFactors: + Cpu: + References: + - InstanceFamily: '{{ InstanceFamily }}' + LaunchTemplateConfigs: + - LaunchTemplateSpecification: + LaunchTemplateId: '{{ LaunchTemplateId }}' + LaunchTemplateName: '{{ LaunchTemplateName }}' + Version: '{{ Version }}' + Overrides: + - AvailabilityZone: '{{ AvailabilityZone }}' + InstanceType: '{{ InstanceType }}' + SpotPrice: '{{ SpotPrice }}' + SubnetId: '{{ SubnetId }}' + WeightedCapacity: null + InstanceRequirements: null + Priority: null + LoadBalancersConfig: + ClassicLoadBalancersConfig: + ClassicLoadBalancers: + - Name: '{{ Name }}' + TargetGroupsConfig: + TargetGroups: + - Arn: '{{ Arn }}' + OnDemandAllocationStrategy: '{{ OnDemandAllocationStrategy }}' + OnDemandMaxTotalPrice: '{{ OnDemandMaxTotalPrice }}' + OnDemandTargetCapacity: '{{ OnDemandTargetCapacity }}' + ReplaceUnhealthyInstances: '{{ ReplaceUnhealthyInstances }}' + SpotMaintenanceStrategies: + CapacityRebalance: + ReplacementStrategy: '{{ ReplacementStrategy }}' + TerminationDelay: '{{ TerminationDelay }}' + SpotMaxTotalPrice: '{{ SpotMaxTotalPrice }}' + SpotPrice: '{{ SpotPrice }}' + TargetCapacity: '{{ TargetCapacity }}' + TerminateInstancesWithExpiration: '{{ TerminateInstancesWithExpiration }}' + Type: '{{ Type }}' + ValidFrom: '{{ ValidFrom }}' + ValidUntil: '{{ ValidUntil }}' + TagSpecifications: + - null + TargetCapacityUnitType: '{{ TargetCapacityUnitType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.spot_fleets +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +ec2:DescribeSpotFleetRequests, +ec2:CancelSpotFleetRequests +``` + +### List +```json +ec2:DescribeSpotFleetRequests +``` + +### Read +```json +ec2:DescribeSpotFleetRequests +``` + +### Update +```json +ec2:ModifySpotFleetRequest, +ec2:DescribeSpotFleetRequests +``` diff --git a/website/docs/services/ec2/spot_fleets_list_only/index.md b/website/docs/services/ec2/spot_fleets_list_only/index.md new file mode 100644 index 0000000..7e6451d --- /dev/null +++ b/website/docs/services/ec2/spot_fleets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: spot_fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - spot_fleets_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists spot_fleets in a region or regions, for all properties use spot_fleets + +## Overview + + + + + + + +
Namespot_fleets_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::SpotFleet
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all spot_fleets in a region. +```sql +SELECT +region, +id +FROM aws.ec2.spot_fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the spot_fleets_list_only resource, see spot_fleets + diff --git a/website/docs/services/ec2/subnet_cidr_blocks/index.md b/website/docs/services/ec2/subnet_cidr_blocks/index.md new file mode 100644 index 0000000..c87cb2c --- /dev/null +++ b/website/docs/services/ec2/subnet_cidr_blocks/index.md @@ -0,0 +1,216 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a subnet_cidr_block resource or lists subnet_cidr_blocks in a region + +## Overview + + + + + + + +
Namesubnet_cidr_blocks
TypeResource
DescriptionThe AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringInformation about the IPv6 association.
stringThe IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length
stringThe ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR
integerThe netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool
stringThe ID of the subnet
stringThe value denoting whether an IPv6 Subnet CIDR Block is public or private.
stringThe IP Source of an IPv6 Subnet CIDR Block.
stringAWS region.
+ +For more information, see AWS::EC2::SubnetCidrBlock. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all subnet_cidr_blocks in a region. +```sql +SELECT +region, +id, +ipv6_cidr_block, +ipv6_ipam_pool_id, +ipv6_netmask_length, +subnet_id, +ipv6_address_attribute, +ip_source +FROM aws.ec2.subnet_cidr_blocks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual subnet_cidr_block. +```sql +SELECT +region, +id, +ipv6_cidr_block, +ipv6_ipam_pool_id, +ipv6_netmask_length, +subnet_id, +ipv6_address_attribute, +ip_source +FROM aws.ec2.subnet_cidr_blocks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new subnet_cidr_block resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.subnet_cidr_blocks ( + SubnetId, + region +) +SELECT +'{{ SubnetId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.subnet_cidr_blocks ( + Ipv6CidrBlock, + Ipv6IpamPoolId, + Ipv6NetmaskLength, + SubnetId, + region +) +SELECT + '{{ Ipv6CidrBlock }}', + '{{ Ipv6IpamPoolId }}', + '{{ Ipv6NetmaskLength }}', + '{{ SubnetId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: subnet_cidr_block + props: + - name: Ipv6CidrBlock + value: '{{ Ipv6CidrBlock }}' + - name: Ipv6IpamPoolId + value: '{{ Ipv6IpamPoolId }}' + - name: Ipv6NetmaskLength + value: '{{ Ipv6NetmaskLength }}' + - name: SubnetId + value: '{{ SubnetId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.subnet_cidr_blocks +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the subnet_cidr_blocks resource, the following permissions are required: + +### Create +```json +ec2:AssociateSubnetCidrBlock, +ec2:DescribeSubnets +``` + +### Delete +```json +ec2:DisassociateSubnetCidrBlock, +ec2:DescribeSubnets +``` + +### List +```json +ec2:DescribeSubnets +``` + +### Read +```json +ec2:DescribeSubnets +``` diff --git a/website/docs/services/ec2/subnet_cidr_blocks_list_only/index.md b/website/docs/services/ec2/subnet_cidr_blocks_list_only/index.md new file mode 100644 index 0000000..6faf427 --- /dev/null +++ b/website/docs/services/ec2/subnet_cidr_blocks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: subnet_cidr_blocks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_cidr_blocks_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnet_cidr_blocks in a region or regions, for all properties use subnet_cidr_blocks + +## Overview + + + + + + + +
Namesubnet_cidr_blocks_list_only
TypeResource
DescriptionThe AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringInformation about the IPv6 association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnet_cidr_blocks in a region. +```sql +SELECT +region, +id +FROM aws.ec2.subnet_cidr_blocks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_cidr_blocks_list_only resource, see subnet_cidr_blocks + diff --git a/website/docs/services/ec2/subnet_network_acl_associations/index.md b/website/docs/services/ec2/subnet_network_acl_associations/index.md new file mode 100644 index 0000000..815060e --- /dev/null +++ b/website/docs/services/ec2/subnet_network_acl_associations/index.md @@ -0,0 +1,198 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a subnet_network_acl_association resource or lists subnet_network_acl_associations in a region + +## Overview + + + + + + + +
Namesubnet_network_acl_associations
TypeResource
DescriptionResource Type definition for AWS::EC2::SubnetNetworkAclAssociation
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the subnet
stringThe ID of the network ACL
string
stringAWS region.
+ +For more information, see AWS::EC2::SubnetNetworkAclAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all subnet_network_acl_associations in a region. +```sql +SELECT +region, +subnet_id, +network_acl_id, +association_id +FROM aws.ec2.subnet_network_acl_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual subnet_network_acl_association. +```sql +SELECT +region, +subnet_id, +network_acl_id, +association_id +FROM aws.ec2.subnet_network_acl_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new subnet_network_acl_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.subnet_network_acl_associations ( + SubnetId, + NetworkAclId, + region +) +SELECT +'{{ SubnetId }}', + '{{ NetworkAclId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.subnet_network_acl_associations ( + SubnetId, + NetworkAclId, + region +) +SELECT + '{{ SubnetId }}', + '{{ NetworkAclId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: subnet_network_acl_association + props: + - name: SubnetId + value: '{{ SubnetId }}' + - name: NetworkAclId + value: '{{ NetworkAclId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.subnet_network_acl_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeNetworkAcls +``` + +### Delete +```json +ec2:DescribeNetworkAcls, +ec2:ReplaceNetworkAclAssociation +``` + +### List +```json +ec2:DescribeNetworkAcls +``` diff --git a/website/docs/services/ec2/subnet_network_acl_associations_list_only/index.md b/website/docs/services/ec2/subnet_network_acl_associations_list_only/index.md new file mode 100644 index 0000000..f790fc4 --- /dev/null +++ b/website/docs/services/ec2/subnet_network_acl_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: subnet_network_acl_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_network_acl_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnet_network_acl_associations in a region or regions, for all properties use subnet_network_acl_associations + +## Overview + + + + + + + +
Namesubnet_network_acl_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::SubnetNetworkAclAssociation
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnet_network_acl_associations in a region. +```sql +SELECT +region, +association_id +FROM aws.ec2.subnet_network_acl_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_network_acl_associations_list_only resource, see subnet_network_acl_associations + diff --git a/website/docs/services/ec2/subnet_route_table_associations/index.md b/website/docs/services/ec2/subnet_route_table_associations/index.md new file mode 100644 index 0000000..b935bc2 --- /dev/null +++ b/website/docs/services/ec2/subnet_route_table_associations/index.md @@ -0,0 +1,201 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a subnet_route_table_association resource or lists 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).
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the route table.
The physical ID changes when the route table ID is changed.
string
stringThe ID of the subnet.
stringAWS region.
+ +For more information, see AWS::EC2::SubnetRouteTableAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all subnet_route_table_associations in a region. +```sql +SELECT +region, +route_table_id, +id, +subnet_id +FROM aws.ec2.subnet_route_table_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual subnet_route_table_association. +```sql +SELECT +region, +route_table_id, +id, +subnet_id +FROM aws.ec2.subnet_route_table_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new subnet_route_table_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.subnet_route_table_associations ( + RouteTableId, + SubnetId, + region +) +SELECT +'{{ RouteTableId }}', + '{{ SubnetId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.subnet_route_table_associations ( + RouteTableId, + SubnetId, + region +) +SELECT + '{{ RouteTableId }}', + '{{ SubnetId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: subnet_route_table_association + props: + - name: RouteTableId + value: '{{ RouteTableId }}' + - name: SubnetId + value: '{{ SubnetId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.subnet_route_table_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the subnet_route_table_associations resource, the following permissions are required: + +### Read +```json +ec2:DescribeRouteTables +``` + +### Create +```json +ec2:AssociateRouteTable, +ec2:ReplaceRouteTableAssociation, +ec2:DescribeSubnets, +ec2:DescribeRouteTables +``` + +### List +```json +ec2:DescribeRouteTables +``` + +### Delete +```json +ec2:DisassociateRouteTable, +ec2:DescribeSubnets, +ec2:DescribeRouteTables +``` diff --git a/website/docs/services/ec2/subnet_route_table_associations_list_only/index.md b/website/docs/services/ec2/subnet_route_table_associations_list_only/index.md new file mode 100644 index 0000000..bdcff6f --- /dev/null +++ b/website/docs/services/ec2/subnet_route_table_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: subnet_route_table_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_route_table_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnet_route_table_associations in a region or regions, for all properties use subnet_route_table_associations + +## Overview + + + + + + + +
Namesubnet_route_table_associations_list_only
TypeResource
DescriptionAssociates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnet_route_table_associations in a region. +```sql +SELECT +region, +id +FROM aws.ec2.subnet_route_table_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_route_table_associations_list_only resource, see subnet_route_table_associations + diff --git a/website/docs/services/ec2/subnet_tags/index.md b/website/docs/services/ec2/subnet_tags/index.md new file mode 100644 index 0000000..3d7a2ce --- /dev/null +++ b/website/docs/services/ec2/subnet_tags/index.md @@ -0,0 +1,113 @@ +--- +title: subnet_tags +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for subnets in a region + +## Overview + + + + + + + +
Namesubnet_tags
TypeResource
DescriptionSpecifies a subnet for the specified VPC.
For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicates whether a network interface created in this subnet receives an IPv6 address. The default value is false.
If you specify AssignIpv6AddressOnCreation, you must also specify an IPv6 CIDR block.
stringThe ID of the VPC the subnet is in.
If you update this property, you must also update the CidrBlock property.
booleanIndicates whether instances launched in this subnet receive a public IPv4 address. The default value is false.
AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).
integerIndicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
string
stringThe Availability Zone of the subnet.
If you update this property, you must also update the CidrBlock property.
stringThe AZ ID of the subnet.
stringThe IPv4 CIDR block assigned to the subnet.
If you update this property, we create a new subnet, and then delete the existing one.
string
array
stringThe IPv6 CIDR block.
If you specify AssignIpv6AddressOnCreation, you must also specify an IPv6 CIDR block.
stringThe Amazon Resource Name (ARN) of the Outpost.
booleanIndicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.
booleanIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a 0.0.0.0/0 route pointing to the internet gateway. For more information, see [Configure DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough) in the *User Guide*.
objectThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.
Available options:
+ EnableResourceNameDnsAAAARecord (true | false)
+ EnableResourceNameDnsARecord (true | false)
+ HostnameType (ip-name | resource-name)
stringAn IPv4 IPAM pool ID for the subnet.
integerAn IPv4 netmask length for the subnet.
stringAn IPv6 IPAM pool ID for the subnet.
integerAn IPv6 netmask length for the subnet.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all subnets in a region. +```sql +SELECT +region, +assign_ipv6_address_on_creation, +vpc_id, +map_public_ip_on_launch, +enable_lni_at_device_index, +network_acl_association_id, +availability_zone, +availability_zone_id, +cidr_block, +subnet_id, +ipv6_cidr_blocks, +ipv6_cidr_block, +outpost_arn, +ipv6_native, +enable_dns64, +private_dns_name_options_on_launch, +ipv4_ipam_pool_id, +ipv4_netmask_length, +ipv6_ipam_pool_id, +ipv6_netmask_length, +tag_key, +tag_value +FROM aws.ec2.subnet_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_tags resource, see subnets + diff --git a/website/docs/services/ec2/subnets/index.md b/website/docs/services/ec2/subnets/index.md new file mode 100644 index 0000000..9478667 --- /dev/null +++ b/website/docs/services/ec2/subnets/index.md @@ -0,0 +1,331 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a subnet resource or lists subnets in a region + +## Overview + + + + + + + +
Namesubnets
TypeResource
DescriptionSpecifies a subnet for the specified VPC.
For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicates whether a network interface created in this subnet receives an IPv6 address. The default value is false.
If you specify AssignIpv6AddressOnCreation, you must also specify an IPv6 CIDR block.
stringThe ID of the VPC the subnet is in.
If you update this property, you must also update the CidrBlock property.
booleanIndicates whether instances launched in this subnet receive a public IPv4 address. The default value is false.
AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).
integerIndicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
string
stringThe Availability Zone of the subnet.
If you update this property, you must also update the CidrBlock property.
stringThe AZ ID of the subnet.
stringThe IPv4 CIDR block assigned to the subnet.
If you update this property, we create a new subnet, and then delete the existing one.
string
array
stringThe IPv6 CIDR block.
If you specify AssignIpv6AddressOnCreation, you must also specify an IPv6 CIDR block.
stringThe Amazon Resource Name (ARN) of the Outpost.
booleanIndicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.
booleanIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a 0.0.0.0/0 route pointing to the internet gateway. For more information, see [Configure DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough) in the *User Guide*.
objectThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.
Available options:
+ EnableResourceNameDnsAAAARecord (true | false)
+ EnableResourceNameDnsARecord (true | false)
+ HostnameType (ip-name | resource-name)
arrayAny tags assigned to the subnet.
stringAn IPv4 IPAM pool ID for the subnet.
integerAn IPv4 netmask length for the subnet.
stringAn IPv6 IPAM pool ID for the subnet.
integerAn IPv6 netmask length for the subnet.
stringAWS region.
+ +For more information, see AWS::EC2::Subnet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all subnets in a region. +```sql +SELECT +region, +assign_ipv6_address_on_creation, +vpc_id, +map_public_ip_on_launch, +enable_lni_at_device_index, +network_acl_association_id, +availability_zone, +availability_zone_id, +cidr_block, +subnet_id, +ipv6_cidr_blocks, +ipv6_cidr_block, +outpost_arn, +ipv6_native, +enable_dns64, +private_dns_name_options_on_launch, +tags, +ipv4_ipam_pool_id, +ipv4_netmask_length, +ipv6_ipam_pool_id, +ipv6_netmask_length +FROM aws.ec2.subnets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual subnet. +```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.subnets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new subnet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.subnets ( + VpcId, + region +) +SELECT +'{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.subnets ( + AssignIpv6AddressOnCreation, + VpcId, + MapPublicIpOnLaunch, + EnableLniAtDeviceIndex, + AvailabilityZone, + AvailabilityZoneId, + CidrBlock, + Ipv6CidrBlock, + OutpostArn, + Ipv6Native, + EnableDns64, + PrivateDnsNameOptionsOnLaunch, + Tags, + Ipv4IpamPoolId, + Ipv4NetmaskLength, + Ipv6IpamPoolId, + Ipv6NetmaskLength, + region +) +SELECT + '{{ AssignIpv6AddressOnCreation }}', + '{{ VpcId }}', + '{{ MapPublicIpOnLaunch }}', + '{{ EnableLniAtDeviceIndex }}', + '{{ AvailabilityZone }}', + '{{ AvailabilityZoneId }}', + '{{ CidrBlock }}', + '{{ Ipv6CidrBlock }}', + '{{ OutpostArn }}', + '{{ Ipv6Native }}', + '{{ EnableDns64 }}', + '{{ PrivateDnsNameOptionsOnLaunch }}', + '{{ Tags }}', + '{{ Ipv4IpamPoolId }}', + '{{ Ipv4NetmaskLength }}', + '{{ Ipv6IpamPoolId }}', + '{{ Ipv6NetmaskLength }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: subnet + props: + - name: AssignIpv6AddressOnCreation + value: '{{ AssignIpv6AddressOnCreation }}' + - name: VpcId + value: '{{ VpcId }}' + - name: MapPublicIpOnLaunch + value: '{{ MapPublicIpOnLaunch }}' + - name: EnableLniAtDeviceIndex + value: '{{ EnableLniAtDeviceIndex }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: AvailabilityZoneId + value: '{{ AvailabilityZoneId }}' + - name: CidrBlock + value: '{{ CidrBlock }}' + - name: Ipv6CidrBlock + value: '{{ Ipv6CidrBlock }}' + - name: OutpostArn + value: '{{ OutpostArn }}' + - name: Ipv6Native + value: '{{ Ipv6Native }}' + - name: EnableDns64 + value: '{{ EnableDns64 }}' + - name: PrivateDnsNameOptionsOnLaunch + value: + HostnameType: '{{ HostnameType }}' + EnableResourceNameDnsARecord: '{{ EnableResourceNameDnsARecord }}' + EnableResourceNameDnsAAAARecord: '{{ EnableResourceNameDnsAAAARecord }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Ipv4IpamPoolId + value: '{{ Ipv4IpamPoolId }}' + - name: Ipv4NetmaskLength + value: '{{ Ipv4NetmaskLength }}' + - name: Ipv6IpamPoolId + value: '{{ Ipv6IpamPoolId }}' + - name: Ipv6NetmaskLength + value: '{{ Ipv6NetmaskLength }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.subnets +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ec2:DescribeSubnets, +ec2:DescribeNetworkAcls +``` diff --git a/website/docs/services/ec2/subnets_list_only/index.md b/website/docs/services/ec2/subnets_list_only/index.md new file mode 100644 index 0000000..00385da --- /dev/null +++ b/website/docs/services/ec2/subnets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: subnets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnets_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnets in a region or regions, for all properties use subnets + +## Overview + + + + + + + +
Namesubnets_list_only
TypeResource
DescriptionSpecifies a subnet for the specified VPC.
For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnets in a region. +```sql +SELECT +region, +subnet_id +FROM aws.ec2.subnets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnets_list_only resource, see subnets + diff --git a/website/docs/services/ec2/transit_gateway_attachment_tags/index.md b/website/docs/services/ec2/transit_gateway_attachment_tags/index.md new file mode 100644 index 0000000..dcf6dfe --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_attachment_tags/index.md @@ -0,0 +1,85 @@ +--- +title: transit_gateway_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_attachment_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_attachments in a region + +## Overview + + + + + + + +
Nametransit_gateway_attachment_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayAttachment
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThe options for the transit gateway vpc attachment.
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_attachments in a region. +```sql +SELECT +region, +options, +transit_gateway_id, +vpc_id, +id, +subnet_ids, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_attachment_tags resource, see transit_gateway_attachments + diff --git a/website/docs/services/ec2/transit_gateway_attachments/index.md b/website/docs/services/ec2/transit_gateway_attachments/index.md new file mode 100644 index 0000000..a8ff6ae --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_attachments/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_attachment resource or lists transit_gateway_attachments in a region + +## Overview + + + + + + + +
Nametransit_gateway_attachments
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayAttachment
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectThe options for the transit gateway vpc attachment.
string
string
string
array
array
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_attachments in a region. +```sql +SELECT +region, +options, +transit_gateway_id, +vpc_id, +id, +subnet_ids, +tags +FROM aws.ec2.transit_gateway_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_attachment. +```sql +SELECT +region, +options, +transit_gateway_id, +vpc_id, +id, +subnet_ids, +tags +FROM aws.ec2.transit_gateway_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_attachments ( + TransitGatewayId, + VpcId, + SubnetIds, + region +) +SELECT +'{{ TransitGatewayId }}', + '{{ VpcId }}', + '{{ SubnetIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_attachments ( + Options, + TransitGatewayId, + VpcId, + SubnetIds, + Tags, + region +) +SELECT + '{{ Options }}', + '{{ TransitGatewayId }}', + '{{ VpcId }}', + '{{ SubnetIds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_attachment + props: + - name: Options + value: + Ipv6Support: '{{ Ipv6Support }}' + ApplianceModeSupport: '{{ ApplianceModeSupport }}' + SecurityGroupReferencingSupport: '{{ SecurityGroupReferencingSupport }}' + DnsSupport: '{{ DnsSupport }}' + - name: TransitGatewayId + value: '{{ TransitGatewayId }}' + - name: VpcId + value: '{{ VpcId }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_attachments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the transit_gateway_attachments 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 +``` + +### Create +```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 +``` + +### List +```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/website/docs/services/ec2/transit_gateway_attachments_list_only/index.md b/website/docs/services/ec2/transit_gateway_attachments_list_only/index.md new file mode 100644 index 0000000..c274dd5 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_attachments_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_attachments in a region or regions, for all properties use transit_gateway_attachments + +## Overview + + + + + + + +
Nametransit_gateway_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayAttachment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_attachments in a region. +```sql +SELECT +region, +id +FROM aws.ec2.transit_gateway_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_attachments_list_only resource, see transit_gateway_attachments + diff --git a/website/docs/services/ec2/transit_gateway_connect_tags/index.md b/website/docs/services/ec2/transit_gateway_connect_tags/index.md new file mode 100644 index 0000000..2a648a7 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_connect_tags/index.md @@ -0,0 +1,87 @@ +--- +title: transit_gateway_connect_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_connect_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_connects in a region + +## Overview + + + + + + + +
Nametransit_gateway_connect_tags
TypeResource
DescriptionThe AWS::EC2::TransitGatewayConnect type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the Connect attachment.
stringThe ID of the attachment from which the Connect attachment was created.
stringThe ID of the transit gateway.
stringThe state of the attachment.
stringThe creation time.
objectThe Connect attachment options.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_connects in a region. +```sql +SELECT +region, +transit_gateway_attachment_id, +transport_transit_gateway_attachment_id, +transit_gateway_id, +state, +creation_time, +options, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_connect_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_connect_tags resource, see transit_gateway_connects + diff --git a/website/docs/services/ec2/transit_gateway_connects/index.md b/website/docs/services/ec2/transit_gateway_connects/index.md new file mode 100644 index 0000000..81439cc --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_connects/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_connect resource or lists transit_gateway_connects in a region + +## Overview + + + + + + + +
Nametransit_gateway_connects
TypeResource
DescriptionThe AWS::EC2::TransitGatewayConnect type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the Connect attachment.
stringThe ID of the attachment from which the Connect attachment was created.
stringThe ID of the transit gateway.
stringThe state of the attachment.
stringThe creation time.
arrayThe tags for the attachment.
objectThe Connect attachment options.
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayConnect. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_connects in a region. +```sql +SELECT +region, +transit_gateway_attachment_id, +transport_transit_gateway_attachment_id, +transit_gateway_id, +state, +creation_time, +tags, +options +FROM aws.ec2.transit_gateway_connects +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_connect. +```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_connects +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_connect resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_connects ( + TransportTransitGatewayAttachmentId, + Options, + region +) +SELECT +'{{ TransportTransitGatewayAttachmentId }}', + '{{ Options }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_connects ( + TransportTransitGatewayAttachmentId, + Tags, + Options, + region +) +SELECT + '{{ TransportTransitGatewayAttachmentId }}', + '{{ Tags }}', + '{{ Options }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_connect + props: + - name: TransportTransitGatewayAttachmentId + value: '{{ TransportTransitGatewayAttachmentId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Options + value: + Protocol: '{{ Protocol }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_connects +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeTransitGatewayConnects +``` + +### Update +```json +ec2:DescribeTransitGatewayConnects, +ec2:DeleteTags, +ec2:CreateTags +``` + +### Delete +```json +ec2:DeleteTransitGatewayConnect, +ec2:DescribeTransitGatewayConnects, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeTransitGatewayConnects +``` diff --git a/website/docs/services/ec2/transit_gateway_connects_list_only/index.md b/website/docs/services/ec2/transit_gateway_connects_list_only/index.md new file mode 100644 index 0000000..2983dce --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_connects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_connects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_connects_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_connects in a region or regions, for all properties use transit_gateway_connects + +## Overview + + + + + + + +
Nametransit_gateway_connects_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayConnect type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the Connect attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_connects in a region. +```sql +SELECT +region, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_connects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_connects_list_only resource, see transit_gateway_connects + diff --git a/website/docs/services/ec2/transit_gateway_multicast_domain_associations/index.md b/website/docs/services/ec2/transit_gateway_multicast_domain_associations/index.md new file mode 100644 index 0000000..2298a85 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_multicast_domain_associations/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_multicast_domain_association resource or lists transit_gateway_multicast_domain_associations in a region + +## Overview + + + + + + + +
Nametransit_gateway_multicast_domain_associations
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomainAssociation type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the transit gateway multicast domain.
stringThe ID of the transit gateway attachment.
stringThe ID of the resource.
stringThe type of resource, for example a VPC attachment.
stringThe state of the subnet association.
stringThe IDs of the subnets to associate with the transit gateway multicast domain.
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayMulticastDomainAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_multicast_domain_associations in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +transit_gateway_attachment_id, +resource_id, +resource_type, +state, +subnet_id +FROM aws.ec2.transit_gateway_multicast_domain_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_multicast_domain_association. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +transit_gateway_attachment_id, +resource_id, +resource_type, +state, +subnet_id +FROM aws.ec2.transit_gateway_multicast_domain_associations +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_multicast_domain_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_multicast_domain_associations ( + TransitGatewayMulticastDomainId, + TransitGatewayAttachmentId, + SubnetId, + region +) +SELECT +'{{ TransitGatewayMulticastDomainId }}', + '{{ TransitGatewayAttachmentId }}', + '{{ SubnetId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_multicast_domain_associations ( + TransitGatewayMulticastDomainId, + TransitGatewayAttachmentId, + SubnetId, + region +) +SELECT + '{{ TransitGatewayMulticastDomainId }}', + '{{ TransitGatewayAttachmentId }}', + '{{ SubnetId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_multicast_domain_association + props: + - name: TransitGatewayMulticastDomainId + value: '{{ TransitGatewayMulticastDomainId }}' + - name: TransitGatewayAttachmentId + value: '{{ TransitGatewayAttachmentId }}' + - name: SubnetId + value: '{{ SubnetId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_multicast_domain_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:GetTransitGatewayMulticastDomainAssociations +``` + +### Delete +```json +ec2:DisassociateTransitGatewayMulticastDomain, +ec2:GetTransitGatewayMulticastDomainAssociations +``` + +### List +```json +ec2:GetTransitGatewayMulticastDomainAssociations +``` diff --git a/website/docs/services/ec2/transit_gateway_multicast_domain_associations_list_only/index.md b/website/docs/services/ec2/transit_gateway_multicast_domain_associations_list_only/index.md new file mode 100644 index 0000000..6b645b6 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_multicast_domain_associations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: transit_gateway_multicast_domain_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_domain_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_multicast_domain_associations in a region or regions, for all properties use transit_gateway_multicast_domain_associations + +## Overview + + + + + + + +
Nametransit_gateway_multicast_domain_associations_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomainAssociation type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the transit gateway multicast domain.
stringThe ID of the transit gateway attachment.
stringThe IDs of the subnets to associate with the transit gateway multicast domain.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_multicast_domain_associations in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +transit_gateway_attachment_id, +subnet_id +FROM aws.ec2.transit_gateway_multicast_domain_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_multicast_domain_associations_list_only resource, see transit_gateway_multicast_domain_associations + diff --git a/website/docs/services/ec2/transit_gateway_multicast_domain_tags/index.md b/website/docs/services/ec2/transit_gateway_multicast_domain_tags/index.md new file mode 100644 index 0000000..135f3d7 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_multicast_domain_tags/index.md @@ -0,0 +1,87 @@ +--- +title: transit_gateway_multicast_domain_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_domain_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_multicast_domains in a region + +## Overview + + + + + + + +
Nametransit_gateway_multicast_domain_tags
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomain type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the transit gateway multicast domain.
stringThe Amazon Resource Name (ARN) of the transit gateway multicast domain.
stringThe ID of the transit gateway.
stringThe state of the transit gateway multicast domain.
stringThe time the transit gateway multicast domain was created.
objectThe options for the transit gateway multicast domain.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_multicast_domains in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +transit_gateway_multicast_domain_arn, +transit_gateway_id, +state, +creation_time, +options, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_multicast_domain_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_multicast_domain_tags resource, see transit_gateway_multicast_domains + diff --git a/website/docs/services/ec2/transit_gateway_multicast_domains/index.md b/website/docs/services/ec2/transit_gateway_multicast_domains/index.md new file mode 100644 index 0000000..59121e9 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_multicast_domains/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_multicast_domain resource or lists transit_gateway_multicast_domains in a region + +## Overview + + + + + + + +
Nametransit_gateway_multicast_domains
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomain type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the transit gateway multicast domain.
stringThe Amazon Resource Name (ARN) of the transit gateway multicast domain.
stringThe ID of the transit gateway.
stringThe state of the transit gateway multicast domain.
stringThe time the transit gateway multicast domain was created.
arrayThe tags for the transit gateway multicast domain.
objectThe options for the transit gateway multicast domain.
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayMulticastDomain. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_multicast_domains in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +transit_gateway_multicast_domain_arn, +transit_gateway_id, +state, +creation_time, +tags, +options +FROM aws.ec2.transit_gateway_multicast_domains +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_multicast_domain. +```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_domains +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_multicast_domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_multicast_domains ( + TransitGatewayId, + region +) +SELECT +'{{ TransitGatewayId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_multicast_domains ( + TransitGatewayId, + Tags, + Options, + region +) +SELECT + '{{ TransitGatewayId }}', + '{{ Tags }}', + '{{ Options }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_multicast_domain + props: + - name: TransitGatewayId + value: '{{ TransitGatewayId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Options + value: + AutoAcceptSharedAssociations: '{{ AutoAcceptSharedAssociations }}' + Igmpv2Support: '{{ Igmpv2Support }}' + StaticSourcesSupport: '{{ StaticSourcesSupport }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_multicast_domains +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeTransitGatewayMulticastDomains +``` + +### Update +```json +ec2:DescribeTransitGatewayMulticastDomains, +ec2:DeleteTags, +ec2:CreateTags +``` + +### Delete +```json +ec2:DescribeTransitGatewayMulticastDomains, +ec2:DeleteTransitGatewayMulticastDomain, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeTransitGatewayMulticastDomains +``` diff --git a/website/docs/services/ec2/transit_gateway_multicast_domains_list_only/index.md b/website/docs/services/ec2/transit_gateway_multicast_domains_list_only/index.md new file mode 100644 index 0000000..5a085f8 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_multicast_domains_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_multicast_domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_domains_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_multicast_domains in a region or regions, for all properties use transit_gateway_multicast_domains + +## Overview + + + + + + + +
Nametransit_gateway_multicast_domains_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomain type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the transit gateway multicast domain.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_multicast_domains in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id +FROM aws.ec2.transit_gateway_multicast_domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_multicast_domains_list_only resource, see transit_gateway_multicast_domains + diff --git a/website/docs/services/ec2/transit_gateway_multicast_group_members/index.md b/website/docs/services/ec2/transit_gateway_multicast_group_members/index.md new file mode 100644 index 0000000..1f3ddc5 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_multicast_group_members/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_multicast_group_member resource or lists 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
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address assigned to the transit gateway multicast group.
stringThe ID of the transit gateway attachment.
stringThe ID of the transit gateway multicast domain.
stringThe ID of the subnet.
stringThe ID of the resource.
stringThe type of resource, for example a VPC attachment.
stringThe ID of the transit gateway attachment.
booleanIndicates that the resource is a transit gateway multicast group member.
booleanIndicates that the resource is a transit gateway multicast group member.
stringThe member type (for example, static).
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayMulticastGroupMember. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_multicast_group_members in a region. +```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 +FROM aws.ec2.transit_gateway_multicast_group_members +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_multicast_group_member. +```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 +FROM aws.ec2.transit_gateway_multicast_group_members +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_multicast_group_member resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_multicast_group_members ( + GroupIpAddress, + TransitGatewayMulticastDomainId, + NetworkInterfaceId, + region +) +SELECT +'{{ GroupIpAddress }}', + '{{ TransitGatewayMulticastDomainId }}', + '{{ NetworkInterfaceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_multicast_group_members ( + GroupIpAddress, + TransitGatewayMulticastDomainId, + NetworkInterfaceId, + region +) +SELECT + '{{ GroupIpAddress }}', + '{{ TransitGatewayMulticastDomainId }}', + '{{ NetworkInterfaceId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_multicast_group_member + props: + - name: GroupIpAddress + value: '{{ GroupIpAddress }}' + - name: TransitGatewayMulticastDomainId + value: '{{ TransitGatewayMulticastDomainId }}' + - name: NetworkInterfaceId + value: '{{ NetworkInterfaceId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_multicast_group_members +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:SearchTransitGatewayMulticastGroups +``` + +### Delete +```json +ec2:DeregisterTransitGatewayMulticastGroupMembers, +ec2:SearchTransitGatewayMulticastGroups +``` + +### List +```json +ec2:SearchTransitGatewayMulticastGroups +``` diff --git a/website/docs/services/ec2/transit_gateway_multicast_group_members_list_only/index.md b/website/docs/services/ec2/transit_gateway_multicast_group_members_list_only/index.md new file mode 100644 index 0000000..21e46ba --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_multicast_group_members_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: transit_gateway_multicast_group_members_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_group_members_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_multicast_group_members in a region or regions, for all properties use transit_gateway_multicast_group_members + +## Overview + + + + + + + +
Nametransit_gateway_multicast_group_members_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe IP address assigned to the transit gateway multicast group.
stringThe ID of the transit gateway multicast domain.
stringThe ID of the transit gateway attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_multicast_group_members in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +group_ip_address, +network_interface_id +FROM aws.ec2.transit_gateway_multicast_group_members_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_multicast_group_members_list_only resource, see transit_gateway_multicast_group_members + diff --git a/website/docs/services/ec2/transit_gateway_multicast_group_sources/index.md b/website/docs/services/ec2/transit_gateway_multicast_group_sources/index.md new file mode 100644 index 0000000..71dd94d --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_multicast_group_sources/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_multicast_group_source resource or lists 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
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address assigned to the transit gateway multicast group.
stringThe ID of the transit gateway attachment.
stringThe ID of the transit gateway multicast domain.
stringThe ID of the subnet.
stringThe ID of the resource.
stringThe type of resource, for example a VPC attachment.
stringThe ID of the transit gateway attachment.
booleanIndicates that the resource is a transit gateway multicast group member.
booleanIndicates that the resource is a transit gateway multicast group member.
stringThe source type.
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayMulticastGroupSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_multicast_group_sources in a region. +```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, +source_type +FROM aws.ec2.transit_gateway_multicast_group_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_multicast_group_source. +```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, +source_type +FROM aws.ec2.transit_gateway_multicast_group_sources +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_multicast_group_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_multicast_group_sources ( + GroupIpAddress, + TransitGatewayMulticastDomainId, + NetworkInterfaceId, + region +) +SELECT +'{{ GroupIpAddress }}', + '{{ TransitGatewayMulticastDomainId }}', + '{{ NetworkInterfaceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_multicast_group_sources ( + GroupIpAddress, + TransitGatewayMulticastDomainId, + NetworkInterfaceId, + region +) +SELECT + '{{ GroupIpAddress }}', + '{{ TransitGatewayMulticastDomainId }}', + '{{ NetworkInterfaceId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_multicast_group_source + props: + - name: GroupIpAddress + value: '{{ GroupIpAddress }}' + - name: TransitGatewayMulticastDomainId + value: '{{ TransitGatewayMulticastDomainId }}' + - name: NetworkInterfaceId + value: '{{ NetworkInterfaceId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_multicast_group_sources +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:SearchTransitGatewayMulticastGroups +``` + +### Delete +```json +ec2:DeregisterTransitGatewayMulticastGroupSources, +ec2:SearchTransitGatewayMulticastGroups +``` + +### List +```json +ec2:SearchTransitGatewayMulticastGroups +``` diff --git a/website/docs/services/ec2/transit_gateway_multicast_group_sources_list_only/index.md b/website/docs/services/ec2/transit_gateway_multicast_group_sources_list_only/index.md new file mode 100644 index 0000000..fb04dcb --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_multicast_group_sources_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: transit_gateway_multicast_group_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_group_sources_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_multicast_group_sources in a region or regions, for all properties use transit_gateway_multicast_group_sources + +## Overview + + + + + + + +
Nametransit_gateway_multicast_group_sources_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastGroupSource registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe IP address assigned to the transit gateway multicast group.
stringThe ID of the transit gateway multicast domain.
stringThe ID of the transit gateway attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_multicast_group_sources in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +group_ip_address, +network_interface_id +FROM aws.ec2.transit_gateway_multicast_group_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_multicast_group_sources_list_only resource, see transit_gateway_multicast_group_sources + diff --git a/website/docs/services/ec2/transit_gateway_peering_attachment_tags/index.md b/website/docs/services/ec2/transit_gateway_peering_attachment_tags/index.md new file mode 100644 index 0000000..f8670c0 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_peering_attachment_tags/index.md @@ -0,0 +1,91 @@ +--- +title: transit_gateway_peering_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peering_attachment_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_peering_attachments in a region + +## Overview + + + + + + + +
Nametransit_gateway_peering_attachment_tags
TypeResource
DescriptionThe AWS::EC2::TransitGatewayPeeringAttachment type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe status of the transit gateway peering attachment.
stringThe ID of the transit gateway.
stringThe ID of the peer transit gateway.
stringThe ID of the peer account
stringThe state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
stringThe time the transit gateway peering attachment was created.
stringPeer Region
stringThe ID of the transit gateway peering attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_peering_attachments in a region. +```sql +SELECT +region, +status, +transit_gateway_id, +peer_transit_gateway_id, +peer_account_id, +state, +creation_time, +peer_region, +transit_gateway_attachment_id, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_peering_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_peering_attachment_tags resource, see transit_gateway_peering_attachments + diff --git a/website/docs/services/ec2/transit_gateway_peering_attachments/index.md b/website/docs/services/ec2/transit_gateway_peering_attachments/index.md new file mode 100644 index 0000000..27ab633 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_peering_attachments/index.md @@ -0,0 +1,248 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_peering_attachment resource or lists transit_gateway_peering_attachments in a region + +## Overview + + + + + + + +
Nametransit_gateway_peering_attachments
TypeResource
DescriptionThe AWS::EC2::TransitGatewayPeeringAttachment type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe status of the transit gateway peering attachment.
stringThe ID of the transit gateway.
stringThe ID of the peer transit gateway.
stringThe ID of the peer account
stringThe state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
stringThe time the transit gateway peering attachment was created.
stringPeer Region
arrayThe tags for the transit gateway peering attachment.
stringThe ID of the transit gateway peering attachment.
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayPeeringAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_peering_attachments in a region. +```sql +SELECT +region, +status, +transit_gateway_id, +peer_transit_gateway_id, +peer_account_id, +state, +creation_time, +peer_region, +tags, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_peering_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_peering_attachment. +```sql +SELECT +region, +status, +transit_gateway_id, +peer_transit_gateway_id, +peer_account_id, +state, +creation_time, +peer_region, +tags, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_peering_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_peering_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_peering_attachments ( + TransitGatewayId, + PeerTransitGatewayId, + PeerAccountId, + PeerRegion, + region +) +SELECT +'{{ TransitGatewayId }}', + '{{ PeerTransitGatewayId }}', + '{{ PeerAccountId }}', + '{{ PeerRegion }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_peering_attachments ( + TransitGatewayId, + PeerTransitGatewayId, + PeerAccountId, + PeerRegion, + Tags, + region +) +SELECT + '{{ TransitGatewayId }}', + '{{ PeerTransitGatewayId }}', + '{{ PeerAccountId }}', + '{{ PeerRegion }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_peering_attachment + props: + - name: TransitGatewayId + value: '{{ TransitGatewayId }}' + - name: PeerTransitGatewayId + value: '{{ PeerTransitGatewayId }}' + - name: PeerAccountId + value: '{{ PeerAccountId }}' + - name: PeerRegion + value: '{{ PeerRegion }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_peering_attachments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the transit_gateway_peering_attachments resource, the following permissions are required: + +### Read +```json +ec2:DescribeTransitGatewayPeeringAttachments +``` + +### Create +```json +ec2:CreateTransitGatewayPeeringAttachment, +ec2:DescribeTransitGatewayPeeringAttachments, +ec2:CreateTags +``` + +### Update +```json +ec2:DescribeTransitGatewayPeeringAttachments, +ec2:CreateTags, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeTransitGatewayPeeringAttachments +``` + +### Delete +```json +ec2:DeleteTransitGatewayPeeringAttachment, +ec2:DescribeTransitGatewayPeeringAttachments, +ec2:DeleteTags +``` diff --git a/website/docs/services/ec2/transit_gateway_peering_attachments_list_only/index.md b/website/docs/services/ec2/transit_gateway_peering_attachments_list_only/index.md new file mode 100644 index 0000000..b2b6665 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_peering_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_peering_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peering_attachments_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_peering_attachments in a region or regions, for all properties use transit_gateway_peering_attachments + +## Overview + + + + + + + +
Nametransit_gateway_peering_attachments_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayPeeringAttachment type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the transit gateway peering attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_peering_attachments in a region. +```sql +SELECT +region, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_peering_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_peering_attachments_list_only resource, see transit_gateway_peering_attachments + diff --git a/website/docs/services/ec2/transit_gateway_route_table_associations/index.md b/website/docs/services/ec2/transit_gateway_route_table_associations/index.md new file mode 100644 index 0000000..ee896a8 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_route_table_associations/index.md @@ -0,0 +1,195 @@ +--- +title: transit_gateway_route_table_associations +hide_title: false +hide_table_of_contents: false +keywords: + - transit_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_route_table_association resource or lists transit_gateway_route_table_associations in a region + +## Overview + + + + + + + +
Nametransit_gateway_route_table_associations
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of transit gateway route table.
stringThe ID of transit gateway attachment.
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayRouteTableAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_route_table_associations in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_route_table_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_route_table_association. +```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' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_route_table_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_route_table_associations ( + TransitGatewayRouteTableId, + TransitGatewayAttachmentId, + region +) +SELECT +'{{ TransitGatewayRouteTableId }}', + '{{ TransitGatewayAttachmentId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_route_table_associations ( + TransitGatewayRouteTableId, + TransitGatewayAttachmentId, + region +) +SELECT + '{{ TransitGatewayRouteTableId }}', + '{{ TransitGatewayAttachmentId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_route_table_association + props: + - name: TransitGatewayRouteTableId + value: '{{ TransitGatewayRouteTableId }}' + - name: TransitGatewayAttachmentId + value: '{{ TransitGatewayAttachmentId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_route_table_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the transit_gateway_route_table_associations resource, the following permissions are required: + +### Read +```json +ec2:GetTransitGatewayRouteTableAssociations +``` + +### Create +```json +ec2:AssociateTransitGatewayRouteTable, +ec2:GetTransitGatewayRouteTableAssociations +``` + +### List +```json +ec2:GetTransitGatewayRouteTableAssociations +``` + +### Delete +```json +ec2:GetTransitGatewayRouteTableAssociations, +ec2:DisassociateTransitGatewayRouteTable +``` diff --git a/website/docs/services/ec2/transit_gateway_route_table_associations_list_only/index.md b/website/docs/services/ec2/transit_gateway_route_table_associations_list_only/index.md new file mode 100644 index 0000000..b4c4720 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_route_table_associations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: transit_gateway_route_table_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_route_table_associations in a region or regions, for all properties use transit_gateway_route_table_associations + +## Overview + + + + + + + +
Nametransit_gateway_route_table_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of transit gateway route table.
stringThe ID of transit gateway attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_route_table_associations in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_route_table_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_table_associations_list_only resource, see transit_gateway_route_table_associations + diff --git a/website/docs/services/ec2/transit_gateway_route_table_propagations/index.md b/website/docs/services/ec2/transit_gateway_route_table_propagations/index.md new file mode 100644 index 0000000..5662e45 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_route_table_propagations/index.md @@ -0,0 +1,195 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_route_table_propagation resource or lists transit_gateway_route_table_propagations in a region + +## Overview + + + + + + + +
Nametransit_gateway_route_table_propagations
TypeResource
DescriptionAWS::EC2::TransitGatewayRouteTablePropagation Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of transit gateway route table.
stringThe ID of transit gateway attachment.
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayRouteTablePropagation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_route_table_propagations in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_route_table_propagations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_route_table_propagation. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_route_table_propagations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_route_table_propagation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_route_table_propagations ( + TransitGatewayRouteTableId, + TransitGatewayAttachmentId, + region +) +SELECT +'{{ TransitGatewayRouteTableId }}', + '{{ TransitGatewayAttachmentId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_route_table_propagations ( + TransitGatewayRouteTableId, + TransitGatewayAttachmentId, + region +) +SELECT + '{{ TransitGatewayRouteTableId }}', + '{{ TransitGatewayAttachmentId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_route_table_propagation + props: + - name: TransitGatewayRouteTableId + value: '{{ TransitGatewayRouteTableId }}' + - name: TransitGatewayAttachmentId + value: '{{ TransitGatewayAttachmentId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_route_table_propagations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the transit_gateway_route_table_propagations resource, the following permissions are required: + +### Read +```json +ec2:GetTransitGatewayRouteTablePropagations +``` + +### Create +```json +ec2:GetTransitGatewayRouteTablePropagations, +ec2:EnableTransitGatewayRouteTablePropagation +``` + +### List +```json +ec2:GetTransitGatewayRouteTablePropagations +``` + +### Delete +```json +ec2:GetTransitGatewayRouteTablePropagations, +ec2:DisableTransitGatewayRouteTablePropagation +``` diff --git a/website/docs/services/ec2/transit_gateway_route_table_propagations_list_only/index.md b/website/docs/services/ec2/transit_gateway_route_table_propagations_list_only/index.md new file mode 100644 index 0000000..69dd13c --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_route_table_propagations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: transit_gateway_route_table_propagations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_propagations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_route_table_propagations in a region or regions, for all properties use transit_gateway_route_table_propagations + +## Overview + + + + + + + +
Nametransit_gateway_route_table_propagations_list_only
TypeResource
DescriptionAWS::EC2::TransitGatewayRouteTablePropagation Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of transit gateway route table.
stringThe ID of transit gateway attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_route_table_propagations in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_route_table_propagations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_table_propagations_list_only resource, see transit_gateway_route_table_propagations + diff --git a/website/docs/services/ec2/transit_gateway_route_table_tags/index.md b/website/docs/services/ec2/transit_gateway_route_table_tags/index.md new file mode 100644 index 0000000..ee16adf --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_route_table_tags/index.md @@ -0,0 +1,79 @@ +--- +title: transit_gateway_route_table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_route_tables in a region + +## Overview + + + + + + + +
Nametransit_gateway_route_table_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTable
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringTransit Gateway Route Table primary identifier
stringThe ID of the transit gateway.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_route_tables in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_id, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_route_table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_table_tags resource, see transit_gateway_route_tables + diff --git a/website/docs/services/ec2/transit_gateway_route_tables/index.md b/website/docs/services/ec2/transit_gateway_route_tables/index.md new file mode 100644 index 0000000..77fee3e --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_route_tables/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_route_table resource or lists transit_gateway_route_tables in a region + +## Overview + + + + + + + +
Nametransit_gateway_route_tables
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTable
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringTransit Gateway Route Table primary identifier
stringThe ID of the transit gateway.
arrayTags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayRouteTable. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_route_tables in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_id, +tags +FROM aws.ec2.transit_gateway_route_tables +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_route_table. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_id, +tags +FROM aws.ec2.transit_gateway_route_tables +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_route_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_route_tables ( + TransitGatewayId, + region +) +SELECT +'{{ TransitGatewayId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_route_tables ( + TransitGatewayId, + Tags, + region +) +SELECT + '{{ TransitGatewayId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_route_table + props: + - name: TransitGatewayId + value: '{{ TransitGatewayId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_route_tables +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the transit_gateway_route_tables resource, the following permissions are required: + +### Read +```json +ec2:DescribeTransitGatewayRouteTables +``` + +### Create +```json +ec2:CreateTransitGatewayRouteTable, +ec2:CreateTags, +ec2:DescribeTransitGatewayRouteTables +``` + +### Update +```json +ec2:DescribeTransitGatewayRouteTables, +ec2:CreateTags, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeTransitGatewayRouteTables +``` + +### Delete +```json +ec2:DeleteTransitGatewayRouteTable, +ec2:DescribeTransitGatewayRouteTables, +ec2:GetTransitGatewayRouteTableAssociations, +ec2:DisassociateTransitGatewayRouteTable +``` diff --git a/website/docs/services/ec2/transit_gateway_route_tables_list_only/index.md b/website/docs/services/ec2/transit_gateway_route_tables_list_only/index.md new file mode 100644 index 0000000..e6660ed --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_route_tables_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_route_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_tables_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_route_tables in a region or regions, for all properties use transit_gateway_route_tables + +## Overview + + + + + + + +
Nametransit_gateway_route_tables_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTable
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringTransit Gateway Route Table primary identifier
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_route_tables in a region. +```sql +SELECT +region, +transit_gateway_route_table_id +FROM aws.ec2.transit_gateway_route_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_tables_list_only resource, see transit_gateway_route_tables + diff --git a/website/docs/services/ec2/transit_gateway_routes/index.md b/website/docs/services/ec2/transit_gateway_routes/index.md new file mode 100644 index 0000000..c891e9a --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_routes/index.md @@ -0,0 +1,209 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_route resource or lists transit_gateway_routes in a region + +## Overview + + + + + + + +
Nametransit_gateway_routes
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRoute
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of transit gateway route table.
stringThe CIDR range used for destination matches. Routing decisions are based on the most specific match.
booleanIndicates whether to drop traffic that matches this route.
stringThe ID of transit gateway attachment.
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayRoute. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_routes in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +destination_cidr_block, +blackhole, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_routes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_route. +```sql +SELECT +region, +transit_gateway_route_table_id, +destination_cidr_block, +blackhole, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_routes +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_routes ( + TransitGatewayRouteTableId, + DestinationCidrBlock, + region +) +SELECT +'{{ TransitGatewayRouteTableId }}', + '{{ DestinationCidrBlock }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_routes ( + TransitGatewayRouteTableId, + DestinationCidrBlock, + Blackhole, + TransitGatewayAttachmentId, + region +) +SELECT + '{{ TransitGatewayRouteTableId }}', + '{{ DestinationCidrBlock }}', + '{{ Blackhole }}', + '{{ TransitGatewayAttachmentId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_route + props: + - name: TransitGatewayRouteTableId + value: '{{ TransitGatewayRouteTableId }}' + - name: DestinationCidrBlock + value: '{{ DestinationCidrBlock }}' + - name: Blackhole + value: '{{ Blackhole }}' + - name: TransitGatewayAttachmentId + value: '{{ TransitGatewayAttachmentId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_routes +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the transit_gateway_routes resource, the following permissions are required: + +### Read +```json +ec2:SearchTransitGatewayRoutes +``` + +### Create +```json +ec2:CreateTransitGatewayRoute, +ec2:SearchTransitGatewayRoutes +``` + +### List +```json +ec2:SearchTransitGatewayRoutes +``` + +### Delete +```json +ec2:DeleteTransitGatewayRoute, +ec2:SearchTransitGatewayRoutes +``` diff --git a/website/docs/services/ec2/transit_gateway_routes_list_only/index.md b/website/docs/services/ec2/transit_gateway_routes_list_only/index.md new file mode 100644 index 0000000..1b450c9 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_routes_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: transit_gateway_routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_routes_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_routes in a region or regions, for all properties use transit_gateway_routes + +## Overview + + + + + + + +
Nametransit_gateway_routes_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRoute
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of transit gateway route table.
stringThe CIDR range used for destination matches. Routing decisions are based on the most specific match.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_routes in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +destination_cidr_block +FROM aws.ec2.transit_gateway_routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_routes_list_only resource, see transit_gateway_routes + diff --git a/website/docs/services/ec2/transit_gateway_tags/index.md b/website/docs/services/ec2/transit_gateway_tags/index.md new file mode 100644 index 0000000..d4263ee --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_tags/index.md @@ -0,0 +1,103 @@ +--- +title: transit_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateways in a region + +## Overview + + + + + + + +
Nametransit_gateway_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGateway
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
string
string
integer
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateways in a region. +```sql +SELECT +region, +default_route_table_propagation, +transit_gateway_arn, +description, +auto_accept_shared_attachments, +default_route_table_association, +id, +vpn_ecmp_support, +dns_support, +security_group_referencing_support, +multicast_support, +amazon_side_asn, +transit_gateway_cidr_blocks, +association_default_route_table_id, +propagation_default_route_table_id, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_tags resource, see transit_gateways + diff --git a/website/docs/services/ec2/transit_gateway_vpc_attachment_tags/index.md b/website/docs/services/ec2/transit_gateway_vpc_attachment_tags/index.md new file mode 100644 index 0000000..4f33fde --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_vpc_attachment_tags/index.md @@ -0,0 +1,89 @@ +--- +title: transit_gateway_vpc_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_vpc_attachment_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_vpc_attachments in a region + +## Overview + + + + + + + +
Nametransit_gateway_vpc_attachment_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayVpcAttachment
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
array
array
objectThe options for the transit gateway vpc attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_vpc_attachments in a region. +```sql +SELECT +region, +id, +transit_gateway_id, +vpc_id, +subnet_ids, +add_subnet_ids, +remove_subnet_ids, +options, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_vpc_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_vpc_attachment_tags resource, see transit_gateway_vpc_attachments + diff --git a/website/docs/services/ec2/transit_gateway_vpc_attachments/index.md b/website/docs/services/ec2/transit_gateway_vpc_attachments/index.md new file mode 100644 index 0000000..dfc6b23 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_vpc_attachments/index.md @@ -0,0 +1,290 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_vpc_attachment resource or lists transit_gateway_vpc_attachments in a region + +## Overview + + + + + + + +
Nametransit_gateway_vpc_attachments
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayVpcAttachment
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
array
array
array
objectThe options for the transit gateway vpc attachment.
stringAWS region.
+ +For more information, see AWS::EC2::TransitGatewayVpcAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_vpc_attachments in a region. +```sql +SELECT +region, +id, +transit_gateway_id, +vpc_id, +subnet_ids, +add_subnet_ids, +remove_subnet_ids, +tags, +options +FROM aws.ec2.transit_gateway_vpc_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_vpc_attachment. +```sql +SELECT +region, +id, +transit_gateway_id, +vpc_id, +subnet_ids, +add_subnet_ids, +remove_subnet_ids, +tags, +options +FROM aws.ec2.transit_gateway_vpc_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_vpc_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_vpc_attachments ( + TransitGatewayId, + VpcId, + SubnetIds, + region +) +SELECT +'{{ TransitGatewayId }}', + '{{ VpcId }}', + '{{ SubnetIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateway_vpc_attachments ( + TransitGatewayId, + VpcId, + SubnetIds, + AddSubnetIds, + RemoveSubnetIds, + Tags, + Options, + region +) +SELECT + '{{ TransitGatewayId }}', + '{{ VpcId }}', + '{{ SubnetIds }}', + '{{ AddSubnetIds }}', + '{{ RemoveSubnetIds }}', + '{{ Tags }}', + '{{ Options }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_vpc_attachment + props: + - name: TransitGatewayId + value: '{{ TransitGatewayId }}' + - name: VpcId + value: '{{ VpcId }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: AddSubnetIds + value: + - '{{ AddSubnetIds[0] }}' + - name: RemoveSubnetIds + value: + - '{{ RemoveSubnetIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Options + value: + DnsSupport: '{{ DnsSupport }}' + Ipv6Support: '{{ Ipv6Support }}' + ApplianceModeSupport: '{{ ApplianceModeSupport }}' + SecurityGroupReferencingSupport: '{{ SecurityGroupReferencingSupport }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateway_vpc_attachments +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:DescribeTags, +ec2:CreateTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:DeleteTags, +ec2:ModifyTransitGatewayVpcAttachment +``` + +### Update +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:DescribeTags, +ec2:CreateTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:DeleteTags, +ec2:ModifyTransitGatewayVpcAttachment +``` diff --git a/website/docs/services/ec2/transit_gateway_vpc_attachments_list_only/index.md b/website/docs/services/ec2/transit_gateway_vpc_attachments_list_only/index.md new file mode 100644 index 0000000..10ae5d6 --- /dev/null +++ b/website/docs/services/ec2/transit_gateway_vpc_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_vpc_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_vpc_attachments_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_vpc_attachments in a region or regions, for all properties use transit_gateway_vpc_attachments + +## Overview + + + + + + + +
Nametransit_gateway_vpc_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayVpcAttachment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_vpc_attachments in a region. +```sql +SELECT +region, +id +FROM aws.ec2.transit_gateway_vpc_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_vpc_attachments_list_only resource, see transit_gateway_vpc_attachments + diff --git a/website/docs/services/ec2/transit_gateways/index.md b/website/docs/services/ec2/transit_gateways/index.md new file mode 100644 index 0000000..90d90a5 --- /dev/null +++ b/website/docs/services/ec2/transit_gateways/index.md @@ -0,0 +1,346 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway resource or lists transit_gateways in a region + +## Overview + + + + + + + +
Nametransit_gateways
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGateway
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
string
string
integer
array
array
string
string
stringAWS region.
+ +For more information, see AWS::EC2::TransitGateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateways in a region. +```sql +SELECT +region, +default_route_table_propagation, +transit_gateway_arn, +description, +auto_accept_shared_attachments, +default_route_table_association, +id, +vpn_ecmp_support, +dns_support, +security_group_referencing_support, +multicast_support, +amazon_side_asn, +transit_gateway_cidr_blocks, +tags, +association_default_route_table_id, +propagation_default_route_table_id +FROM aws.ec2.transit_gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway. +```sql +SELECT +region, +default_route_table_propagation, +transit_gateway_arn, +description, +auto_accept_shared_attachments, +default_route_table_association, +id, +vpn_ecmp_support, +dns_support, +security_group_referencing_support, +multicast_support, +amazon_side_asn, +transit_gateway_cidr_blocks, +tags, +association_default_route_table_id, +propagation_default_route_table_id +FROM aws.ec2.transit_gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateways ( + DefaultRouteTablePropagation, + Description, + AutoAcceptSharedAttachments, + DefaultRouteTableAssociation, + VpnEcmpSupport, + DnsSupport, + SecurityGroupReferencingSupport, + MulticastSupport, + AmazonSideAsn, + TransitGatewayCidrBlocks, + Tags, + AssociationDefaultRouteTableId, + PropagationDefaultRouteTableId, + region +) +SELECT +'{{ DefaultRouteTablePropagation }}', + '{{ Description }}', + '{{ AutoAcceptSharedAttachments }}', + '{{ DefaultRouteTableAssociation }}', + '{{ VpnEcmpSupport }}', + '{{ DnsSupport }}', + '{{ SecurityGroupReferencingSupport }}', + '{{ MulticastSupport }}', + '{{ AmazonSideAsn }}', + '{{ TransitGatewayCidrBlocks }}', + '{{ Tags }}', + '{{ AssociationDefaultRouteTableId }}', + '{{ PropagationDefaultRouteTableId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.transit_gateways ( + DefaultRouteTablePropagation, + Description, + AutoAcceptSharedAttachments, + DefaultRouteTableAssociation, + VpnEcmpSupport, + DnsSupport, + SecurityGroupReferencingSupport, + MulticastSupport, + AmazonSideAsn, + TransitGatewayCidrBlocks, + Tags, + AssociationDefaultRouteTableId, + PropagationDefaultRouteTableId, + region +) +SELECT + '{{ DefaultRouteTablePropagation }}', + '{{ Description }}', + '{{ AutoAcceptSharedAttachments }}', + '{{ DefaultRouteTableAssociation }}', + '{{ VpnEcmpSupport }}', + '{{ DnsSupport }}', + '{{ SecurityGroupReferencingSupport }}', + '{{ MulticastSupport }}', + '{{ AmazonSideAsn }}', + '{{ TransitGatewayCidrBlocks }}', + '{{ Tags }}', + '{{ AssociationDefaultRouteTableId }}', + '{{ PropagationDefaultRouteTableId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway + props: + - name: DefaultRouteTablePropagation + value: '{{ DefaultRouteTablePropagation }}' + - name: Description + value: '{{ Description }}' + - name: AutoAcceptSharedAttachments + value: '{{ AutoAcceptSharedAttachments }}' + - name: DefaultRouteTableAssociation + value: '{{ DefaultRouteTableAssociation }}' + - name: VpnEcmpSupport + value: '{{ VpnEcmpSupport }}' + - name: DnsSupport + value: '{{ DnsSupport }}' + - name: SecurityGroupReferencingSupport + value: '{{ SecurityGroupReferencingSupport }}' + - name: MulticastSupport + value: '{{ MulticastSupport }}' + - name: AmazonSideAsn + value: '{{ AmazonSideAsn }}' + - name: TransitGatewayCidrBlocks + value: + - '{{ TransitGatewayCidrBlocks[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AssociationDefaultRouteTableId + value: '{{ AssociationDefaultRouteTableId }}' + - name: PropagationDefaultRouteTableId + value: '{{ PropagationDefaultRouteTableId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.transit_gateways +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```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 +``` + +### Update +```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/website/docs/services/ec2/transit_gateways_list_only/index.md b/website/docs/services/ec2/transit_gateways_list_only/index.md new file mode 100644 index 0000000..853247b --- /dev/null +++ b/website/docs/services/ec2/transit_gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateways_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateways in a region or regions, for all properties use transit_gateways + +## Overview + + + + + + + +
Nametransit_gateways_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGateway
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateways in a region. +```sql +SELECT +region, +id +FROM aws.ec2.transit_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateways_list_only resource, see transit_gateways + diff --git a/website/docs/services/ec2/verified_access_endpoint_tags/index.md b/website/docs/services/ec2/verified_access_endpoint_tags/index.md new file mode 100644 index 0000000..d0d0322 --- /dev/null +++ b/website/docs/services/ec2/verified_access_endpoint_tags/index.md @@ -0,0 +1,115 @@ +--- +title: verified_access_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_endpoint_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for verified_access_endpoints in a region + +## Overview + + + + + + + +
Nameverified_access_endpoint_tags
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access endpoint.
stringThe ID of the AWS Verified Access group.
stringThe ID of the AWS Verified Access instance.
stringThe endpoint status.
arrayThe IDs of the security groups for the endpoint.
objectThe options for network-interface type endpoint.
objectThe load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
stringThe type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
stringA DNS name that is generated for the endpoint.
stringA custom identifier that gets prepended to a DNS name that is generated for the endpoint.
stringReturned if endpoint has a device trust provider attached.
stringThe ARN of a public TLS/SSL certificate imported into or created with ACM.
stringThe type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
stringThe DNS name for users to reach your application.
stringThe creation time.
stringThe last updated time.
stringA description for the AWS Verified Access endpoint.
stringThe AWS Verified Access policy document.
booleanThe status of the Verified Access policy.
objectThe configuration options for customer provided KMS encryption.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all verified_access_endpoints in a region. +```sql +SELECT +region, +verified_access_endpoint_id, +verified_access_group_id, +verified_access_instance_id, +status, +security_group_ids, +network_interface_options, +load_balancer_options, +endpoint_type, +endpoint_domain, +endpoint_domain_prefix, +device_validation_domain, +domain_certificate_arn, +attachment_type, +application_domain, +creation_time, +last_updated_time, +description, +policy_document, +policy_enabled, +sse_specification, +tag_key, +tag_value +FROM aws.ec2.verified_access_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_endpoint_tags resource, see verified_access_endpoints + diff --git a/website/docs/services/ec2/verified_access_endpoints/index.md b/website/docs/services/ec2/verified_access_endpoints/index.md new file mode 100644 index 0000000..ce5296c --- /dev/null +++ b/website/docs/services/ec2/verified_access_endpoints/index.md @@ -0,0 +1,478 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a verified_access_endpoint resource or lists verified_access_endpoints in a region + +## Overview + + + + + + + +
Nameverified_access_endpoints
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access endpoint.
stringThe ID of the AWS Verified Access group.
stringThe ID of the AWS Verified Access instance.
stringThe endpoint status.
arrayThe IDs of the security groups for the endpoint.
objectThe options for network-interface type endpoint.
objectThe load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
stringThe type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
stringA DNS name that is generated for the endpoint.
stringA custom identifier that gets prepended to a DNS name that is generated for the endpoint.
stringReturned if endpoint has a device trust provider attached.
stringThe ARN of a public TLS/SSL certificate imported into or created with ACM.
stringThe type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
stringThe DNS name for users to reach your application.
stringThe creation time.
stringThe last updated time.
stringA description for the AWS Verified Access endpoint.
stringThe AWS Verified Access policy document.
booleanThe status of the Verified Access policy.
arrayAn array of key-value pairs to apply to this resource.
objectThe configuration options for customer provided KMS encryption.
stringAWS region.
+ +For more information, see AWS::EC2::VerifiedAccessEndpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all verified_access_endpoints in a region. +```sql +SELECT +region, +verified_access_endpoint_id, +verified_access_group_id, +verified_access_instance_id, +status, +security_group_ids, +network_interface_options, +load_balancer_options, +endpoint_type, +endpoint_domain, +endpoint_domain_prefix, +device_validation_domain, +domain_certificate_arn, +attachment_type, +application_domain, +creation_time, +last_updated_time, +description, +policy_document, +policy_enabled, +tags, +sse_specification +FROM aws.ec2.verified_access_endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual verified_access_endpoint. +```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_endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new verified_access_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.verified_access_endpoints ( + VerifiedAccessGroupId, + EndpointType, + EndpointDomainPrefix, + DomainCertificateArn, + AttachmentType, + ApplicationDomain, + region +) +SELECT +'{{ VerifiedAccessGroupId }}', + '{{ EndpointType }}', + '{{ EndpointDomainPrefix }}', + '{{ DomainCertificateArn }}', + '{{ AttachmentType }}', + '{{ ApplicationDomain }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.verified_access_endpoints ( + VerifiedAccessGroupId, + SecurityGroupIds, + NetworkInterfaceOptions, + LoadBalancerOptions, + EndpointType, + EndpointDomainPrefix, + DomainCertificateArn, + AttachmentType, + ApplicationDomain, + Description, + PolicyDocument, + PolicyEnabled, + Tags, + SseSpecification, + region +) +SELECT + '{{ VerifiedAccessGroupId }}', + '{{ SecurityGroupIds }}', + '{{ NetworkInterfaceOptions }}', + '{{ LoadBalancerOptions }}', + '{{ EndpointType }}', + '{{ EndpointDomainPrefix }}', + '{{ DomainCertificateArn }}', + '{{ AttachmentType }}', + '{{ ApplicationDomain }}', + '{{ Description }}', + '{{ PolicyDocument }}', + '{{ PolicyEnabled }}', + '{{ Tags }}', + '{{ SseSpecification }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: verified_access_endpoint + props: + - name: VerifiedAccessGroupId + value: '{{ VerifiedAccessGroupId }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: NetworkInterfaceOptions + value: + NetworkInterfaceId: '{{ NetworkInterfaceId }}' + Port: '{{ Port }}' + Protocol: '{{ Protocol }}' + - name: LoadBalancerOptions + value: + LoadBalancerArn: '{{ LoadBalancerArn }}' + Port: '{{ Port }}' + Protocol: '{{ Protocol }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: EndpointType + value: '{{ EndpointType }}' + - name: EndpointDomainPrefix + value: '{{ EndpointDomainPrefix }}' + - name: DomainCertificateArn + value: '{{ DomainCertificateArn }}' + - name: AttachmentType + value: '{{ AttachmentType }}' + - name: ApplicationDomain + value: '{{ ApplicationDomain }}' + - name: Description + value: '{{ Description }}' + - name: PolicyDocument + value: '{{ PolicyDocument }}' + - name: PolicyEnabled + value: '{{ PolicyEnabled }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: SseSpecification + value: + KmsKeyArn: '{{ KmsKeyArn }}' + CustomerManagedKeyEnabled: '{{ CustomerManagedKeyEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.verified_access_endpoints +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the verified_access_endpoints resource, the following permissions are required: + +### Create +```json +ec2:CreateVerifiedAccessEndpoint, +ec2:DescribeVerifiedAccessEndpoints, +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, +ec2:CreateTags, +ec2:DescribeTags, +acm:DeleteCertificateRelation, +ec2:DeleteVerifiedAccessEndpoint, +ec2:GetVerifiedAccessEndpointPolicy, +ec2:ModifyVerifiedAccessEndpoint, +ec2:ModifyVerifiedAccessEndpointPolicy, +sso:DeleteManagedApplicationInstance, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Read +```json +ec2:DescribeVerifiedAccessEndpoints, +ec2:GetVerifiedAccessEndpointPolicy, +ec2:DescribeTags, +acm:CreateCertificateRelation, +acm:DeleteCertificateRelation, +acm:DescribeCertificate, +acm:GetCertificateWithPK, +ec2:CreateVerifiedAccessEndpoint, +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, +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:DescribeTags, +ec2:DeleteTags, +ec2:CreateTags, +ec2:CreateVerifiedAccessEndpoint, +ec2:DeleteVerifiedAccessEndpoint, +iam:CreateServiceLinkedRole, +iam:ListRoles, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +ec2:DescribeVerifiedAccessEndpoints, +ec2:DeleteVerifiedAccessEndpoint, +ec2:DescribeTags, +ec2:DeleteTags, +sso:DeleteManagedApplicationInstance, +acm:DeleteCertificateRelation, +acm:DescribeCertificate, +acm:CreateCertificateRelation, +acm:GetCertificateWithPK, +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 +``` + +### List +```json +ec2:DescribeVerifiedAccessEndpoints, +ec2:DescribeTags, +acm:CreateCertificateRelation, +acm:DeleteCertificateRelation, +acm:DescribeCertificate, +acm:GetCertificateWithPK, +ec2:CreateVerifiedAccessEndpoint, +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/website/docs/services/ec2/verified_access_endpoints_list_only/index.md b/website/docs/services/ec2/verified_access_endpoints_list_only/index.md new file mode 100644 index 0000000..c6289b5 --- /dev/null +++ b/website/docs/services/ec2/verified_access_endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: verified_access_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_endpoints_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists verified_access_endpoints in a region or regions, for all properties use verified_access_endpoints + +## Overview + + + + + + + +
Nameverified_access_endpoints_list_only
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access endpoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all verified_access_endpoints in a region. +```sql +SELECT +region, +verified_access_endpoint_id +FROM aws.ec2.verified_access_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_endpoints_list_only resource, see verified_access_endpoints + diff --git a/website/docs/services/ec2/verified_access_group_tags/index.md b/website/docs/services/ec2/verified_access_group_tags/index.md new file mode 100644 index 0000000..4272767 --- /dev/null +++ b/website/docs/services/ec2/verified_access_group_tags/index.md @@ -0,0 +1,95 @@ +--- +title: verified_access_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_group_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for verified_access_groups in a region + +## Overview + + + + + + + +
Nameverified_access_group_tags
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access group.
stringThe ID of the AWS Verified Access instance.
stringThe ARN of the Verified Access group.
stringThe AWS account number that owns the group.
stringTime this Verified Access Group was created.
stringTime this Verified Access Group was last updated.
stringA description for the AWS Verified Access group.
stringThe AWS Verified Access policy document.
booleanThe status of the Verified Access policy.
objectThe configuration options for customer provided KMS encryption.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all verified_access_groups in a region. +```sql +SELECT +region, +verified_access_group_id, +verified_access_instance_id, +verified_access_group_arn, +owner, +creation_time, +last_updated_time, +description, +policy_document, +policy_enabled, +sse_specification, +tag_key, +tag_value +FROM aws.ec2.verified_access_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_group_tags resource, see verified_access_groups + diff --git a/website/docs/services/ec2/verified_access_groups/index.md b/website/docs/services/ec2/verified_access_groups/index.md new file mode 100644 index 0000000..3350cdf --- /dev/null +++ b/website/docs/services/ec2/verified_access_groups/index.md @@ -0,0 +1,289 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a verified_access_group resource or lists verified_access_groups in a region + +## Overview + + + + + + + +
Nameverified_access_groups
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access group.
stringThe ID of the AWS Verified Access instance.
stringThe ARN of the Verified Access group.
stringThe AWS account number that owns the group.
stringTime this Verified Access Group was created.
stringTime this Verified Access Group was last updated.
stringA description for the AWS Verified Access group.
stringThe AWS Verified Access policy document.
booleanThe status of the Verified Access policy.
arrayAn array of key-value pairs to apply to this resource.
objectThe configuration options for customer provided KMS encryption.
stringAWS region.
+ +For more information, see AWS::EC2::VerifiedAccessGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all verified_access_groups in a region. +```sql +SELECT +region, +verified_access_group_id, +verified_access_instance_id, +verified_access_group_arn, +owner, +creation_time, +last_updated_time, +description, +policy_document, +policy_enabled, +tags, +sse_specification +FROM aws.ec2.verified_access_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual verified_access_group. +```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_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new verified_access_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.verified_access_groups ( + VerifiedAccessInstanceId, + region +) +SELECT +'{{ VerifiedAccessInstanceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.verified_access_groups ( + VerifiedAccessInstanceId, + Description, + PolicyDocument, + PolicyEnabled, + Tags, + SseSpecification, + region +) +SELECT + '{{ VerifiedAccessInstanceId }}', + '{{ Description }}', + '{{ PolicyDocument }}', + '{{ PolicyEnabled }}', + '{{ Tags }}', + '{{ SseSpecification }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: verified_access_group + props: + - name: VerifiedAccessInstanceId + value: '{{ VerifiedAccessInstanceId }}' + - name: Description + value: '{{ Description }}' + - name: PolicyDocument + value: '{{ PolicyDocument }}' + - name: PolicyEnabled + value: '{{ PolicyEnabled }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: SseSpecification + value: + KmsKeyArn: '{{ KmsKeyArn }}' + CustomerManagedKeyEnabled: '{{ CustomerManagedKeyEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.verified_access_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ec2:DescribeVerifiedAccessGroups, +ec2:DescribeTags, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` diff --git a/website/docs/services/ec2/verified_access_groups_list_only/index.md b/website/docs/services/ec2/verified_access_groups_list_only/index.md new file mode 100644 index 0000000..b1a0c4f --- /dev/null +++ b/website/docs/services/ec2/verified_access_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: verified_access_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_groups_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists verified_access_groups in a region or regions, for all properties use verified_access_groups + +## Overview + + + + + + + +
Nameverified_access_groups_list_only
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all verified_access_groups in a region. +```sql +SELECT +region, +verified_access_group_id +FROM aws.ec2.verified_access_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_groups_list_only resource, see verified_access_groups + diff --git a/website/docs/services/ec2/verified_access_instance_tags/index.md b/website/docs/services/ec2/verified_access_instance_tags/index.md new file mode 100644 index 0000000..e40b3cc --- /dev/null +++ b/website/docs/services/ec2/verified_access_instance_tags/index.md @@ -0,0 +1,91 @@ +--- +title: verified_access_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_instance_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for verified_access_instances in a region + +## Overview + + + + + + + +
Nameverified_access_instance_tags
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access instance.
arrayAWS Verified Access trust providers.
arrayThe IDs of the AWS Verified Access trust providers.
stringTime this Verified Access Instance was created.
stringTime this Verified Access Instance was last updated.
stringA description for the AWS Verified Access instance.
objectThe configuration options for AWS Verified Access instances.
booleanIndicates whether FIPS is enabled
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all verified_access_instances in a region. +```sql +SELECT +region, +verified_access_instance_id, +verified_access_trust_providers, +verified_access_trust_provider_ids, +creation_time, +last_updated_time, +description, +logging_configurations, +fips_enabled, +tag_key, +tag_value +FROM aws.ec2.verified_access_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_instance_tags resource, see verified_access_instances + diff --git a/website/docs/services/ec2/verified_access_instances/index.md b/website/docs/services/ec2/verified_access_instances/index.md new file mode 100644 index 0000000..cab2564 --- /dev/null +++ b/website/docs/services/ec2/verified_access_instances/index.md @@ -0,0 +1,353 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a verified_access_instance resource or lists verified_access_instances in a region + +## Overview + + + + + + + +
Nameverified_access_instances
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access instance.
arrayAWS Verified Access trust providers.
arrayThe IDs of the AWS Verified Access trust providers.
stringTime this Verified Access Instance was created.
stringTime this Verified Access Instance was last updated.
stringA description for the AWS Verified Access instance.
objectThe configuration options for AWS Verified Access instances.
arrayAn array of key-value pairs to apply to this resource.
booleanIndicates whether FIPS is enabled
stringAWS region.
+ +For more information, see AWS::EC2::VerifiedAccessInstance. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all verified_access_instances in a region. +```sql +SELECT +region, +verified_access_instance_id, +verified_access_trust_providers, +verified_access_trust_provider_ids, +creation_time, +last_updated_time, +description, +logging_configurations, +tags, +fips_enabled +FROM aws.ec2.verified_access_instances +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual verified_access_instance. +```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_instances +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new verified_access_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.verified_access_instances ( + VerifiedAccessTrustProviders, + VerifiedAccessTrustProviderIds, + Description, + LoggingConfigurations, + Tags, + FipsEnabled, + region +) +SELECT +'{{ VerifiedAccessTrustProviders }}', + '{{ VerifiedAccessTrustProviderIds }}', + '{{ Description }}', + '{{ LoggingConfigurations }}', + '{{ Tags }}', + '{{ FipsEnabled }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.verified_access_instances ( + VerifiedAccessTrustProviders, + VerifiedAccessTrustProviderIds, + Description, + LoggingConfigurations, + Tags, + FipsEnabled, + region +) +SELECT + '{{ VerifiedAccessTrustProviders }}', + '{{ VerifiedAccessTrustProviderIds }}', + '{{ Description }}', + '{{ LoggingConfigurations }}', + '{{ Tags }}', + '{{ FipsEnabled }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: verified_access_instance + props: + - name: VerifiedAccessTrustProviders + value: + - TrustProviderType: '{{ TrustProviderType }}' + DeviceTrustProviderType: '{{ DeviceTrustProviderType }}' + UserTrustProviderType: '{{ UserTrustProviderType }}' + OidcOptions: + Issuer: '{{ Issuer }}' + AuthorizationEndpoint: '{{ AuthorizationEndpoint }}' + TokenEndpoint: '{{ TokenEndpoint }}' + UserInfoEndpoint: '{{ UserInfoEndpoint }}' + ClientId: '{{ ClientId }}' + ClientSecret: '{{ ClientSecret }}' + Scope: '{{ Scope }}' + DeviceOptions: + TenantId: '{{ TenantId }}' + PublicSigningKeyUrl: '{{ PublicSigningKeyUrl }}' + PolicyReferenceName: '{{ PolicyReferenceName }}' + Description: '{{ Description }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + SseSpecification: + KmsKeyArn: '{{ KmsKeyArn }}' + CustomerManagedKeyEnabled: '{{ CustomerManagedKeyEnabled }}' + - name: VerifiedAccessTrustProviderIds + value: + - '{{ VerifiedAccessTrustProviderIds[0] }}' + - name: Description + value: '{{ Description }}' + - name: LoggingConfigurations + value: + LogVersion: '{{ LogVersion }}' + IncludeTrustContext: '{{ IncludeTrustContext }}' + CloudWatchLogs: + Enabled: '{{ Enabled }}' + LogGroup: '{{ LogGroup }}' + KinesisDataFirehose: + Enabled: '{{ Enabled }}' + DeliveryStream: '{{ DeliveryStream }}' + S3: + Enabled: '{{ Enabled }}' + BucketName: '{{ BucketName }}' + BucketOwner: '{{ BucketOwner }}' + Prefix: '{{ Prefix }}' + - name: Tags + value: + - null + - name: FipsEnabled + value: '{{ FipsEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.verified_access_instances +WHERE data__Identifier = '' +AND 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:DetachVerifiedAccessTrustProvider, +ec2:DeleteVerifiedAccessInstance, +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 +``` + +### 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 +``` + +### List +```json +ec2:DescribeVerifiedAccessInstances, +ec2:DescribeTags, +logs:ListLogDeliveries, +logs:GetLogDelivery +``` diff --git a/website/docs/services/ec2/verified_access_instances_list_only/index.md b/website/docs/services/ec2/verified_access_instances_list_only/index.md new file mode 100644 index 0000000..d197a79 --- /dev/null +++ b/website/docs/services/ec2/verified_access_instances_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: verified_access_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_instances_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists verified_access_instances in a region or regions, for all properties use verified_access_instances + +## Overview + + + + + + + +
Nameverified_access_instances_list_only
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access instance.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all verified_access_instances in a region. +```sql +SELECT +region, +verified_access_instance_id +FROM aws.ec2.verified_access_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_instances_list_only resource, see verified_access_instances + diff --git a/website/docs/services/ec2/verified_access_trust_provider_tags/index.md b/website/docs/services/ec2/verified_access_trust_provider_tags/index.md new file mode 100644 index 0000000..29b35b9 --- /dev/null +++ b/website/docs/services/ec2/verified_access_trust_provider_tags/index.md @@ -0,0 +1,97 @@ +--- +title: verified_access_trust_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_trust_provider_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for verified_access_trust_providers in a region + +## Overview + + + + + + + +
Nameverified_access_trust_provider_tags
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringType of trust provider. Possible values: user|device
stringThe type of device-based trust provider. Possible values: jamf|crowdstrike
stringThe type of device-based trust provider. Possible values: oidc|iam-identity-center
objectThe OpenID Connect details for an oidc -type, user-identity based trust provider.
objectThe options for device identity based trust providers.
stringThe identifier to be used when working with policy rules.
stringThe creation time.
stringThe last updated time.
stringThe ID of the Amazon Web Services Verified Access trust provider.
stringA description for the Amazon Web Services Verified Access trust provider.
objectThe configuration options for customer provided KMS encryption.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all verified_access_trust_providers in a region. +```sql +SELECT +region, +trust_provider_type, +device_trust_provider_type, +user_trust_provider_type, +oidc_options, +device_options, +policy_reference_name, +creation_time, +last_updated_time, +verified_access_trust_provider_id, +description, +sse_specification, +tag_key, +tag_value +FROM aws.ec2.verified_access_trust_provider_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_trust_provider_tags resource, see verified_access_trust_providers + diff --git a/website/docs/services/ec2/verified_access_trust_providers/index.md b/website/docs/services/ec2/verified_access_trust_providers/index.md new file mode 100644 index 0000000..522ccfc --- /dev/null +++ b/website/docs/services/ec2/verified_access_trust_providers/index.md @@ -0,0 +1,308 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a verified_access_trust_provider resource or lists verified_access_trust_providers in a region + +## Overview + + + + + + + +
Nameverified_access_trust_providers
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringType of trust provider. Possible values: user|device
stringThe type of device-based trust provider. Possible values: jamf|crowdstrike
stringThe type of device-based trust provider. Possible values: oidc|iam-identity-center
objectThe OpenID Connect details for an oidc -type, user-identity based trust provider.
objectThe options for device identity based trust providers.
stringThe identifier to be used when working with policy rules.
stringThe creation time.
stringThe last updated time.
stringThe ID of the Amazon Web Services Verified Access trust provider.
stringA description for the Amazon Web Services Verified Access trust provider.
arrayAn array of key-value pairs to apply to this resource.
objectThe configuration options for customer provided KMS encryption.
stringAWS region.
+ +For more information, see AWS::EC2::VerifiedAccessTrustProvider. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all verified_access_trust_providers in a region. +```sql +SELECT +region, +trust_provider_type, +device_trust_provider_type, +user_trust_provider_type, +oidc_options, +device_options, +policy_reference_name, +creation_time, +last_updated_time, +verified_access_trust_provider_id, +description, +tags, +sse_specification +FROM aws.ec2.verified_access_trust_providers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual verified_access_trust_provider. +```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_providers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new verified_access_trust_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.verified_access_trust_providers ( + TrustProviderType, + PolicyReferenceName, + region +) +SELECT +'{{ TrustProviderType }}', + '{{ PolicyReferenceName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.verified_access_trust_providers ( + TrustProviderType, + DeviceTrustProviderType, + UserTrustProviderType, + OidcOptions, + DeviceOptions, + PolicyReferenceName, + Description, + Tags, + SseSpecification, + region +) +SELECT + '{{ TrustProviderType }}', + '{{ DeviceTrustProviderType }}', + '{{ UserTrustProviderType }}', + '{{ OidcOptions }}', + '{{ DeviceOptions }}', + '{{ PolicyReferenceName }}', + '{{ Description }}', + '{{ Tags }}', + '{{ SseSpecification }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: verified_access_trust_provider + props: + - name: TrustProviderType + value: '{{ TrustProviderType }}' + - name: DeviceTrustProviderType + value: '{{ DeviceTrustProviderType }}' + - name: UserTrustProviderType + value: '{{ UserTrustProviderType }}' + - name: OidcOptions + value: + Issuer: '{{ Issuer }}' + AuthorizationEndpoint: '{{ AuthorizationEndpoint }}' + TokenEndpoint: '{{ TokenEndpoint }}' + UserInfoEndpoint: '{{ UserInfoEndpoint }}' + ClientId: '{{ ClientId }}' + ClientSecret: '{{ ClientSecret }}' + Scope: '{{ Scope }}' + - name: DeviceOptions + value: + TenantId: '{{ TenantId }}' + PublicSigningKeyUrl: '{{ PublicSigningKeyUrl }}' + - name: PolicyReferenceName + value: '{{ PolicyReferenceName }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: SseSpecification + value: + KmsKeyArn: '{{ KmsKeyArn }}' + CustomerManagedKeyEnabled: '{{ CustomerManagedKeyEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.verified_access_trust_providers +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ec2:DescribeVerifiedAccessTrustProviders, +ec2:DescribeTags, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` diff --git a/website/docs/services/ec2/verified_access_trust_providers_list_only/index.md b/website/docs/services/ec2/verified_access_trust_providers_list_only/index.md new file mode 100644 index 0000000..40bc75d --- /dev/null +++ b/website/docs/services/ec2/verified_access_trust_providers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: verified_access_trust_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_trust_providers_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists verified_access_trust_providers in a region or regions, for all properties use verified_access_trust_providers + +## Overview + + + + + + + +
Nameverified_access_trust_providers_list_only
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the Amazon Web Services Verified Access trust provider.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all verified_access_trust_providers in a region. +```sql +SELECT +region, +verified_access_trust_provider_id +FROM aws.ec2.verified_access_trust_providers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_trust_providers_list_only resource, see verified_access_trust_providers + diff --git a/website/docs/services/ec2/volume_attachments/index.md b/website/docs/services/ec2/volume_attachments/index.md new file mode 100644 index 0000000..b71ecaa --- /dev/null +++ b/website/docs/services/ec2/volume_attachments/index.md @@ -0,0 +1,202 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a volume_attachment resource or lists 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.
Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.
If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.
If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
stringThe ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
stringThe device name (for example, /dev/sdh or xvdh).
stringAWS region.
+ +For more information, see AWS::EC2::VolumeAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all volume_attachments in a region. +```sql +SELECT +region, +volume_id, +instance_id, +device +FROM aws.ec2.volume_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual volume_attachment. +```sql +SELECT +region, +volume_id, +instance_id, +device +FROM aws.ec2.volume_attachments +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new volume_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.volume_attachments ( + VolumeId, + InstanceId, + region +) +SELECT +'{{ VolumeId }}', + '{{ InstanceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.volume_attachments ( + VolumeId, + InstanceId, + Device, + region +) +SELECT + '{{ VolumeId }}', + '{{ InstanceId }}', + '{{ Device }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: volume_attachment + props: + - name: VolumeId + value: '{{ VolumeId }}' + - name: InstanceId + value: '{{ InstanceId }}' + - name: Device + value: '{{ Device }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.volume_attachments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the volume_attachments resource, the following permissions are required: + +### Create +```json +ec2:AttachVolume, +ec2:DescribeVolumes +``` + +### Read +```json +ec2:DescribeVolumes +``` + +### Delete +```json +ec2:DetachVolume, +ec2:DescribeVolumes +``` + +### List +```json +ec2:DescribeVolumes +``` diff --git a/website/docs/services/ec2/volume_attachments_list_only/index.md b/website/docs/services/ec2/volume_attachments_list_only/index.md new file mode 100644 index 0000000..400f9fd --- /dev/null +++ b/website/docs/services/ec2/volume_attachments_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: volume_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - volume_attachments_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists volume_attachments in a region or regions, for all properties use volume_attachments + +## Overview + + + + + + + +
Namevolume_attachments_list_only
TypeResource
DescriptionAttaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.
Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.
If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.
If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
stringThe ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all volume_attachments in a region. +```sql +SELECT +region, +volume_id, +instance_id +FROM aws.ec2.volume_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the volume_attachments_list_only resource, see volume_attachments + diff --git a/website/docs/services/ec2/volume_tags/index.md b/website/docs/services/ec2/volume_tags/index.md new file mode 100644 index 0000000..bd4d851 --- /dev/null +++ b/website/docs/services/ec2/volume_tags/index.md @@ -0,0 +1,99 @@ +--- +title: volume_tags +hide_title: false +hide_table_of_contents: false +keywords: + - volume_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for volumes in a region + +## Overview + + + + + + + +
Namevolume_tags
TypeResource
DescriptionSpecifies an Amazon Elastic Block Store (Amazon EBS) volume.
When you use CFNlong to update an Amazon EBS volume that modifies Iops, Size, or VolumeType, there is a cooldown period before another operation can occur. This can cause your stack to report being in UPDATE_IN_PROGRESS or UPDATE_ROLLBACK_IN_PROGRESS for long periods of time.
Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.
Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
+ You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.
+ You successfully update an Amazon EBS volume and the update succeeds but another change in your update-stack call fails. The rollback will be subject to a cooldown period.

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

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

For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html).
Default: gp2
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all volumes in a region. +```sql +SELECT +region, +multi_attach_enabled, +kms_key_id, +encrypted, +size, +auto_enable_io, +outpost_arn, +availability_zone, +throughput, +iops, +snapshot_id, +volume_id, +volume_type, +tag_key, +tag_value +FROM aws.ec2.volume_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the volume_tags resource, see volumes + diff --git a/website/docs/services/ec2/volumes/index.md b/website/docs/services/ec2/volumes/index.md new file mode 100644 index 0000000..f38071b --- /dev/null +++ b/website/docs/services/ec2/volumes/index.md @@ -0,0 +1,296 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a volume resource or lists volumes in a region + +## Overview + + + + + + + +
Namevolumes
TypeResource
DescriptionSpecifies an Amazon Elastic Block Store (Amazon EBS) volume.
When you use CFNlong to update an Amazon EBS volume that modifies Iops, Size, or VolumeType, there is a cooldown period before another operation can occur. This can cause your stack to report being in UPDATE_IN_PROGRESS or UPDATE_ROLLBACK_IN_PROGRESS for long periods of time.
Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.
Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
+ You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.
+ You successfully update an Amazon EBS volume and the update succeeds but another change in your update-stack call fails. The rollback will be subject to a cooldown period.

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

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

For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html).
Default: gp2
arrayThe tags to apply to the volume during creation.
stringAWS region.
+ +For more information, see AWS::EC2::Volume. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all volumes in a region. +```sql +SELECT +region, +multi_attach_enabled, +kms_key_id, +encrypted, +size, +auto_enable_io, +outpost_arn, +availability_zone, +throughput, +iops, +snapshot_id, +volume_id, +volume_type, +tags +FROM aws.ec2.volumes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual volume. +```sql +SELECT +region, +multi_attach_enabled, +kms_key_id, +encrypted, +size, +auto_enable_io, +outpost_arn, +availability_zone, +throughput, +iops, +snapshot_id, +volume_id, +volume_type, +tags +FROM aws.ec2.volumes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new volume resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.volumes ( + AvailabilityZone, + region +) +SELECT +'{{ AvailabilityZone }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.volumes ( + MultiAttachEnabled, + KmsKeyId, + Encrypted, + Size, + AutoEnableIO, + OutpostArn, + AvailabilityZone, + Throughput, + Iops, + SnapshotId, + VolumeType, + Tags, + region +) +SELECT + '{{ MultiAttachEnabled }}', + '{{ KmsKeyId }}', + '{{ Encrypted }}', + '{{ Size }}', + '{{ AutoEnableIO }}', + '{{ OutpostArn }}', + '{{ AvailabilityZone }}', + '{{ Throughput }}', + '{{ Iops }}', + '{{ SnapshotId }}', + '{{ VolumeType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: volume + props: + - name: MultiAttachEnabled + value: '{{ MultiAttachEnabled }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: Encrypted + value: '{{ Encrypted }}' + - name: Size + value: '{{ Size }}' + - name: AutoEnableIO + value: '{{ AutoEnableIO }}' + - name: OutpostArn + value: '{{ OutpostArn }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: Throughput + value: '{{ Throughput }}' + - name: Iops + value: '{{ Iops }}' + - name: SnapshotId + value: '{{ SnapshotId }}' + - name: VolumeType + value: '{{ VolumeType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.volumes +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the volumes resource, the following permissions are required: + +### Read +```json +ec2:DescribeVolumes, +ec2:DescribeVolumeAttribute, +ec2:DescribeTags +``` + +### Create +```json +ec2:CreateVolume, +ec2:DescribeVolumes, +ec2:DescribeVolumeAttribute, +ec2:ModifyVolumeAttribute, +ec2:CreateTags, +kms:GenerateDataKeyWithoutPlaintext, +kms:CreateGrant +``` + +### Update +```json +ec2:ModifyVolume, +ec2:ModifyVolumeAttribute, +ec2:DescribeVolumeAttribute, +ec2:DescribeVolumesModifications, +ec2:DescribeVolumes, +ec2:CreateTags, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeVolumes, +ec2:DescribeTags, +ec2:DescribeVolumeAttribute +``` + +### Delete +```json +ec2:DeleteVolume, +ec2:CreateSnapshot, +ec2:DescribeSnapshots, +ec2:DeleteTags, +ec2:DescribeVolumes +``` diff --git a/website/docs/services/ec2/volumes_list_only/index.md b/website/docs/services/ec2/volumes_list_only/index.md new file mode 100644 index 0000000..f165dcf --- /dev/null +++ b/website/docs/services/ec2/volumes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: volumes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - volumes_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists volumes in a region or regions, for all properties use volumes + +## Overview + + + + + + + +
Namevolumes_list_only
TypeResource
DescriptionSpecifies an Amazon Elastic Block Store (Amazon EBS) volume.
When you use CFNlong to update an Amazon EBS volume that modifies Iops, Size, or VolumeType, there is a cooldown period before another operation can occur. This can cause your stack to report being in UPDATE_IN_PROGRESS or UPDATE_ROLLBACK_IN_PROGRESS for long periods of time.
Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.
Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
+ You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.
+ You successfully update an Amazon EBS volume and the update succeeds but another change in your update-stack call fails. The rollback will be subject to a cooldown period.

For more information, see [Requirements for EBS volume modifications](https://docs.aws.amazon.com/ebs/latest/userguide/modify-volume-requirements.html).
*DeletionPolicy attribute*
To control how CFNlong handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all volumes in a region. +```sql +SELECT +region, +volume_id +FROM aws.ec2.volumes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the volumes_list_only resource, see volumes + diff --git a/website/docs/services/ec2/vpc_block_public_access_exclusion_tags/index.md b/website/docs/services/ec2/vpc_block_public_access_exclusion_tags/index.md new file mode 100644 index 0000000..709ce6e --- /dev/null +++ b/website/docs/services/ec2/vpc_block_public_access_exclusion_tags/index.md @@ -0,0 +1,83 @@ +--- +title: vpc_block_public_access_exclusion_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_block_public_access_exclusion_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_block_public_access_exclusions in a region + +## Overview + + + + + + + +
Namevpc_block_public_access_exclusion_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCBlockPublicAccessExclusion.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the exclusion
stringThe desired Block Public Access Exclusion Mode for a specific VPC/Subnet.
stringThe ID of the vpc. Required only if you don't specify SubnetId.
stringThe ID of the subnet. Required only if you don't specify VpcId
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_block_public_access_exclusions in a region. +```sql +SELECT +region, +exclusion_id, +internet_gateway_exclusion_mode, +vpc_id, +subnet_id, +tag_key, +tag_value +FROM aws.ec2.vpc_block_public_access_exclusion_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_block_public_access_exclusion_tags resource, see vpc_block_public_access_exclusions + diff --git a/website/docs/services/ec2/vpc_block_public_access_exclusions/index.md b/website/docs/services/ec2/vpc_block_public_access_exclusions/index.md new file mode 100644 index 0000000..2361918 --- /dev/null +++ b/website/docs/services/ec2/vpc_block_public_access_exclusions/index.md @@ -0,0 +1,226 @@ +--- +title: vpc_block_public_access_exclusions +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_block_public_access_exclusions + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_block_public_access_exclusion resource or lists vpc_block_public_access_exclusions in a region + +## Overview + + + + + + + +
Namevpc_block_public_access_exclusions
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCBlockPublicAccessExclusion.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the exclusion
stringThe desired Block Public Access Exclusion Mode for a specific VPC/Subnet.
stringThe ID of the vpc. Required only if you don't specify SubnetId.
stringThe ID of the subnet. Required only if you don't specify VpcId
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EC2::VPCBlockPublicAccessExclusion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_block_public_access_exclusions in a region. +```sql +SELECT +region, +exclusion_id, +internet_gateway_exclusion_mode, +vpc_id, +subnet_id, +tags +FROM aws.ec2.vpc_block_public_access_exclusions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_block_public_access_exclusion. +```sql +SELECT +region, +exclusion_id, +internet_gateway_exclusion_mode, +vpc_id, +subnet_id, +tags +FROM aws.ec2.vpc_block_public_access_exclusions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_block_public_access_exclusion resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_block_public_access_exclusions ( + InternetGatewayExclusionMode, + region +) +SELECT +'{{ InternetGatewayExclusionMode }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_block_public_access_exclusions ( + InternetGatewayExclusionMode, + VpcId, + SubnetId, + Tags, + region +) +SELECT + '{{ InternetGatewayExclusionMode }}', + '{{ VpcId }}', + '{{ SubnetId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_block_public_access_exclusion + props: + - name: InternetGatewayExclusionMode + value: '{{ InternetGatewayExclusionMode }}' + - name: VpcId + value: '{{ VpcId }}' + - name: SubnetId + value: '{{ SubnetId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpc_block_public_access_exclusions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpc_block_public_access_exclusions resource, the following permissions are required: + +### Create +```json +ec2:DescribeVpcBlockPublicAccessExclusions, +ec2:CreateVpcBlockPublicAccessExclusion, +ec2:CreateTags +``` + +### Read +```json +ec2:DescribeVpcBlockPublicAccessExclusions +``` + +### Update +```json +ec2:DescribeVpcBlockPublicAccessExclusions, +ec2:ModifyVpcBlockPublicAccessExclusion, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DescribeVpcBlockPublicAccessExclusions, +ec2:DeleteVpcBlockPublicAccessExclusion +``` + +### List +```json +ec2:DescribeVpcBlockPublicAccessExclusions +``` diff --git a/website/docs/services/ec2/vpc_block_public_access_exclusions_list_only/index.md b/website/docs/services/ec2/vpc_block_public_access_exclusions_list_only/index.md new file mode 100644 index 0000000..b42a576 --- /dev/null +++ b/website/docs/services/ec2/vpc_block_public_access_exclusions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_block_public_access_exclusions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_block_public_access_exclusions_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_block_public_access_exclusions in a region or regions, for all properties use vpc_block_public_access_exclusions + +## Overview + + + + + + + +
Namevpc_block_public_access_exclusions_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCBlockPublicAccessExclusion.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the exclusion
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_block_public_access_exclusions in a region. +```sql +SELECT +region, +exclusion_id +FROM aws.ec2.vpc_block_public_access_exclusions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_block_public_access_exclusions_list_only resource, see vpc_block_public_access_exclusions + diff --git a/website/docs/services/ec2/vpc_block_public_access_options/index.md b/website/docs/services/ec2/vpc_block_public_access_options/index.md new file mode 100644 index 0000000..b9d38d9 --- /dev/null +++ b/website/docs/services/ec2/vpc_block_public_access_options/index.md @@ -0,0 +1,182 @@ +--- +title: vpc_block_public_access_options +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_block_public_access_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_block_public_access_option resource or lists vpc_block_public_access_options in a region + +## Overview + + + + + + + +
Namevpc_block_public_access_options
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCBlockPublicAccessOptions
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe desired Block Public Access mode for Internet Gateways in your account. We do not allow to create in a off mode as this is the default value
stringThe identifier for the specified AWS account.
stringAWS region.
+ +For more information, see AWS::EC2::VPCBlockPublicAccessOptions. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual vpc_block_public_access_option. +```sql +SELECT +region, +internet_gateway_block_mode, +account_id +FROM aws.ec2.vpc_block_public_access_options +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_block_public_access_option resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_block_public_access_options ( + InternetGatewayBlockMode, + region +) +SELECT +'{{ InternetGatewayBlockMode }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_block_public_access_options ( + InternetGatewayBlockMode, + region +) +SELECT + '{{ InternetGatewayBlockMode }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_block_public_access_option + props: + - name: InternetGatewayBlockMode + value: '{{ InternetGatewayBlockMode }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpc_block_public_access_options +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpc_block_public_access_options resource, the following permissions are required: + +### Create +```json +ec2:DescribeVpcBlockPublicAccessOptions, +ec2:ModifyVpcBlockPublicAccessOptions +``` + +### Read +```json +ec2:DescribeVpcBlockPublicAccessOptions +``` + +### Update +```json +ec2:DescribeVpcBlockPublicAccessOptions, +ec2:ModifyVpcBlockPublicAccessOptions +``` + +### Delete +```json +ec2:DescribeVpcBlockPublicAccessOptions, +ec2:ModifyVpcBlockPublicAccessOptions +``` diff --git a/website/docs/services/ec2/vpc_cidr_blocks/index.md b/website/docs/services/ec2/vpc_cidr_blocks/index.md new file mode 100644 index 0000000..cb888fe --- /dev/null +++ b/website/docs/services/ec2/vpc_cidr_blocks/index.md @@ -0,0 +1,259 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_cidr_block resource or lists vpc_cidr_blocks in a region + +## Overview + + + + + + + +
Namevpc_cidr_blocks
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCCidrBlock
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAn IPv4 CIDR block to associate with the VPC.
stringThe ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
stringThe Id of the VPC associated CIDR Block.
stringThe ID of the VPC.
stringAn IPv6 CIDR block from the IPv6 address pool.
stringThe ID of the IPv4 IPAM pool to Associate a CIDR from to a VPC.
integerThe netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
stringThe ID of the IPv6 IPAM pool to Associate a CIDR from to a VPC.
integerThe netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
booleanRequests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
stringThe value denoting whether an IPv6 VPC CIDR Block is public or private.
stringThe IP Source of an IPv6 VPC CIDR Block.
stringThe name of the location from which we advertise the IPV6 CIDR block.
stringAWS region.
+ +For more information, see AWS::EC2::VPCCidrBlock. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_cidr_blocks in a region. +```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, +ipv6_address_attribute, +ip_source, +ipv6_cidr_block_network_border_group +FROM aws.ec2.vpc_cidr_blocks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_cidr_block. +```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, +ipv6_address_attribute, +ip_source, +ipv6_cidr_block_network_border_group +FROM aws.ec2.vpc_cidr_blocks +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_cidr_block resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_cidr_blocks ( + VpcId, + region +) +SELECT +'{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_cidr_blocks ( + CidrBlock, + Ipv6Pool, + VpcId, + Ipv6CidrBlock, + Ipv4IpamPoolId, + Ipv4NetmaskLength, + Ipv6IpamPoolId, + Ipv6NetmaskLength, + AmazonProvidedIpv6CidrBlock, + Ipv6CidrBlockNetworkBorderGroup, + region +) +SELECT + '{{ CidrBlock }}', + '{{ Ipv6Pool }}', + '{{ VpcId }}', + '{{ Ipv6CidrBlock }}', + '{{ Ipv4IpamPoolId }}', + '{{ Ipv4NetmaskLength }}', + '{{ Ipv6IpamPoolId }}', + '{{ Ipv6NetmaskLength }}', + '{{ AmazonProvidedIpv6CidrBlock }}', + '{{ Ipv6CidrBlockNetworkBorderGroup }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_cidr_block + props: + - name: CidrBlock + value: '{{ CidrBlock }}' + - name: Ipv6Pool + value: '{{ Ipv6Pool }}' + - name: VpcId + value: '{{ VpcId }}' + - name: Ipv6CidrBlock + value: '{{ Ipv6CidrBlock }}' + - name: Ipv4IpamPoolId + value: '{{ Ipv4IpamPoolId }}' + - name: Ipv4NetmaskLength + value: '{{ Ipv4NetmaskLength }}' + - name: Ipv6IpamPoolId + value: '{{ Ipv6IpamPoolId }}' + - name: Ipv6NetmaskLength + value: '{{ Ipv6NetmaskLength }}' + - name: AmazonProvidedIpv6CidrBlock + value: '{{ AmazonProvidedIpv6CidrBlock }}' + - name: Ipv6CidrBlockNetworkBorderGroup + value: '{{ Ipv6CidrBlockNetworkBorderGroup }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpc_cidr_blocks +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ec2:DescribeVpcs +``` + +### Delete +```json +ec2:DescribeVpcs, +ec2:DisassociateVpcCidrBlock +``` + +### List +```json +ec2:DescribeVpcs +``` diff --git a/website/docs/services/ec2/vpc_cidr_blocks_list_only/index.md b/website/docs/services/ec2/vpc_cidr_blocks_list_only/index.md new file mode 100644 index 0000000..6078062 --- /dev/null +++ b/website/docs/services/ec2/vpc_cidr_blocks_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: vpc_cidr_blocks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_cidr_blocks_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_cidr_blocks in a region or regions, for all properties use vpc_cidr_blocks + +## Overview + + + + + + + +
Namevpc_cidr_blocks_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCCidrBlock
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Id of the VPC associated CIDR Block.
stringThe ID of the VPC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_cidr_blocks in a region. +```sql +SELECT +region, +id, +vpc_id +FROM aws.ec2.vpc_cidr_blocks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_cidr_blocks_list_only resource, see vpc_cidr_blocks + diff --git a/website/docs/services/ec2/vpc_endpoint_connection_notifications/index.md b/website/docs/services/ec2/vpc_endpoint_connection_notifications/index.md new file mode 100644 index 0000000..d880e7d --- /dev/null +++ b/website/docs/services/ec2/vpc_endpoint_connection_notifications/index.md @@ -0,0 +1,222 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_endpoint_connection_notification resource or lists vpc_endpoint_connection_notifications in a region + +## Overview + + + + + + + +
Namevpc_endpoint_connection_notifications
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointConnectionNotification
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arrayThe endpoint events for which to receive notifications.
stringThe ID of the endpoint.
stringVPC Endpoint Connection ID generated by service
stringThe ARN of the SNS topic for the notifications.
stringThe ID of the endpoint service.
stringAWS region.
+ +For more information, see AWS::EC2::VPCEndpointConnectionNotification. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_endpoint_connection_notifications in a region. +```sql +SELECT +region, +connection_events, +vpc_endpoint_id, +vpc_endpoint_connection_notification_id, +connection_notification_arn, +service_id +FROM aws.ec2.vpc_endpoint_connection_notifications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_endpoint_connection_notification. +```sql +SELECT +region, +connection_events, +vpc_endpoint_id, +vpc_endpoint_connection_notification_id, +connection_notification_arn, +service_id +FROM aws.ec2.vpc_endpoint_connection_notifications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_endpoint_connection_notification resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_endpoint_connection_notifications ( + ConnectionEvents, + ConnectionNotificationArn, + region +) +SELECT +'{{ ConnectionEvents }}', + '{{ ConnectionNotificationArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_endpoint_connection_notifications ( + ConnectionEvents, + VPCEndpointId, + ConnectionNotificationArn, + ServiceId, + region +) +SELECT + '{{ ConnectionEvents }}', + '{{ VPCEndpointId }}', + '{{ ConnectionNotificationArn }}', + '{{ ServiceId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_endpoint_connection_notification + props: + - name: ConnectionEvents + value: + - '{{ ConnectionEvents[0] }}' + - name: VPCEndpointId + value: '{{ VPCEndpointId }}' + - name: ConnectionNotificationArn + value: '{{ ConnectionNotificationArn }}' + - name: ServiceId + value: '{{ ServiceId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpc_endpoint_connection_notifications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpc_endpoint_connection_notifications resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpcEndpointConnectionNotifications +``` + +### Create +```json +ec2:CreateVpcEndpointConnectionNotification +``` + +### Update +```json +ec2:ModifyVpcEndpointConnectionNotification, +ec2:DescribeVpcEndpointConnectionNotifications +``` + +### List +```json +ec2:DescribeVpcEndpointConnectionNotifications +``` + +### Delete +```json +ec2:DeleteVpcEndpointConnectionNotifications +``` diff --git a/website/docs/services/ec2/vpc_endpoint_connection_notifications_list_only/index.md b/website/docs/services/ec2/vpc_endpoint_connection_notifications_list_only/index.md new file mode 100644 index 0000000..5009400 --- /dev/null +++ b/website/docs/services/ec2/vpc_endpoint_connection_notifications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_endpoint_connection_notifications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_connection_notifications_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_endpoint_connection_notifications in a region or regions, for all properties use vpc_endpoint_connection_notifications + +## Overview + + + + + + + +
Namevpc_endpoint_connection_notifications_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointConnectionNotification
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringVPC Endpoint Connection ID generated by service
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_endpoint_connection_notifications in a region. +```sql +SELECT +region, +vpc_endpoint_connection_notification_id +FROM aws.ec2.vpc_endpoint_connection_notifications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoint_connection_notifications_list_only resource, see vpc_endpoint_connection_notifications + diff --git a/website/docs/services/ec2/vpc_endpoint_service_permissions/index.md b/website/docs/services/ec2/vpc_endpoint_service_permissions/index.md new file mode 100644 index 0000000..5f3715c --- /dev/null +++ b/website/docs/services/ec2/vpc_endpoint_service_permissions/index.md @@ -0,0 +1,217 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_endpoint_service_permission resource or lists vpc_endpoint_service_permissions in a region + +## Overview + + + + + + + +
Namevpc_endpoint_service_permissions
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointServicePermissions
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
array
string
stringAWS region.
+ +For more information, see AWS::EC2::VPCEndpointServicePermissions. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_endpoint_service_permissions in a region. +```sql +SELECT +region, +allowed_principals, +service_id +FROM aws.ec2.vpc_endpoint_service_permissions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_endpoint_service_permission. +```sql +SELECT +region, +allowed_principals, +service_id +FROM aws.ec2.vpc_endpoint_service_permissions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_endpoint_service_permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_endpoint_service_permissions ( + ServiceId, + region +) +SELECT +'{{ ServiceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_endpoint_service_permissions ( + AllowedPrincipals, + ServiceId, + region +) +SELECT + '{{ AllowedPrincipals }}', + '{{ ServiceId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_endpoint_service_permission + props: + - name: AllowedPrincipals + value: + - '{{ AllowedPrincipals[0] }}' + - name: ServiceId + value: '{{ ServiceId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpc_endpoint_service_permissions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpc_endpoint_service_permissions resource, the following permissions are required: + +### Read +```json +ec2:CreateVpcEndpointServicePermissions, +ec2:ModifyVpcEndpointServicePermissions, +ec2:DeleteVpcEndpointServicePermissions, +ec2:DescribeVpcEndpointServicePermissions +``` + +### Create +```json +ec2:CreateVpcEndpointServicePermissions, +ec2:ModifyVpcEndpointServicePermissions, +ec2:DeleteVpcEndpointServicePermissions, +ec2:DescribeVpcEndpointServicePermissions +``` + +### Update +```json +ec2:CreateVpcEndpointServicePermissions, +ec2:ModifyVpcEndpointServicePermissions, +ec2:DeleteVpcEndpointServicePermissions, +ec2:DescribeVpcEndpointServicePermissions +``` + +### List +```json +ec2:CreateVpcEndpointServicePermissions, +ec2:ModifyVpcEndpointServicePermissions, +ec2:DeleteVpcEndpointServicePermissions, +ec2:DescribeVpcEndpointServicePermissions +``` + +### Delete +```json +ec2:CreateVpcEndpointServicePermissions, +ec2:ModifyVpcEndpointServicePermissions, +ec2:DeleteVpcEndpointServicePermissions, +ec2:DescribeVpcEndpointServicePermissions +``` diff --git a/website/docs/services/ec2/vpc_endpoint_service_permissions_list_only/index.md b/website/docs/services/ec2/vpc_endpoint_service_permissions_list_only/index.md new file mode 100644 index 0000000..a31ce68 --- /dev/null +++ b/website/docs/services/ec2/vpc_endpoint_service_permissions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_endpoint_service_permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_service_permissions_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_endpoint_service_permissions in a region or regions, for all properties use vpc_endpoint_service_permissions + +## Overview + + + + + + + +
Namevpc_endpoint_service_permissions_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointServicePermissions
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_endpoint_service_permissions in a region. +```sql +SELECT +region, +service_id +FROM aws.ec2.vpc_endpoint_service_permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoint_service_permissions_list_only resource, see vpc_endpoint_service_permissions + diff --git a/website/docs/services/ec2/vpc_endpoint_service_tags/index.md b/website/docs/services/ec2/vpc_endpoint_service_tags/index.md new file mode 100644 index 0000000..e0ae483 --- /dev/null +++ b/website/docs/services/ec2/vpc_endpoint_service_tags/index.md @@ -0,0 +1,87 @@ +--- +title: vpc_endpoint_service_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_service_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_endpoint_services in a region + +## Overview + + + + + + + +
Namevpc_endpoint_service_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointService
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
array
boolean
string
string
boolean
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_endpoint_services in a region. +```sql +SELECT +region, +network_load_balancer_arns, +contributor_insights_enabled, +payer_responsibility, +service_id, +acceptance_required, +gateway_load_balancer_arns, +tag_key, +tag_value +FROM aws.ec2.vpc_endpoint_service_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoint_service_tags resource, see vpc_endpoint_services + diff --git a/website/docs/services/ec2/vpc_endpoint_services/index.md b/website/docs/services/ec2/vpc_endpoint_services/index.md new file mode 100644 index 0000000..c564977 --- /dev/null +++ b/website/docs/services/ec2/vpc_endpoint_services/index.md @@ -0,0 +1,265 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_endpoint_service resource or lists vpc_endpoint_services in a region + +## Overview + + + + + + + +
Namevpc_endpoint_services
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointService
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
array
boolean
string
string
boolean
array
arrayThe tags to add to the VPC endpoint service.
stringAWS region.
+ +For more information, see AWS::EC2::VPCEndpointService. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_endpoint_services in a region. +```sql +SELECT +region, +network_load_balancer_arns, +contributor_insights_enabled, +payer_responsibility, +service_id, +acceptance_required, +gateway_load_balancer_arns, +tags +FROM aws.ec2.vpc_endpoint_services +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_endpoint_service. +```sql +SELECT +region, +network_load_balancer_arns, +contributor_insights_enabled, +payer_responsibility, +service_id, +acceptance_required, +gateway_load_balancer_arns, +tags +FROM aws.ec2.vpc_endpoint_services +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_endpoint_service resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_endpoint_services ( + NetworkLoadBalancerArns, + ContributorInsightsEnabled, + PayerResponsibility, + AcceptanceRequired, + GatewayLoadBalancerArns, + Tags, + region +) +SELECT +'{{ NetworkLoadBalancerArns }}', + '{{ ContributorInsightsEnabled }}', + '{{ PayerResponsibility }}', + '{{ AcceptanceRequired }}', + '{{ GatewayLoadBalancerArns }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_endpoint_services ( + NetworkLoadBalancerArns, + ContributorInsightsEnabled, + PayerResponsibility, + AcceptanceRequired, + GatewayLoadBalancerArns, + Tags, + region +) +SELECT + '{{ NetworkLoadBalancerArns }}', + '{{ ContributorInsightsEnabled }}', + '{{ PayerResponsibility }}', + '{{ AcceptanceRequired }}', + '{{ GatewayLoadBalancerArns }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_endpoint_service + props: + - name: NetworkLoadBalancerArns + value: + - '{{ NetworkLoadBalancerArns[0] }}' + - name: ContributorInsightsEnabled + value: '{{ ContributorInsightsEnabled }}' + - name: PayerResponsibility + value: '{{ PayerResponsibility }}' + - name: AcceptanceRequired + value: '{{ AcceptanceRequired }}' + - name: GatewayLoadBalancerArns + value: + - '{{ GatewayLoadBalancerArns[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpc_endpoint_services +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpc_endpoint_services resource, the following permissions are required: + +### Create +```json +ec2:CreateVpcEndpointServiceConfiguration, +ec2:ModifyVpcEndpointServicePayerResponsibility, +cloudwatch:ListManagedInsightRules, +cloudwatch:DeleteInsightRules, +cloudwatch:PutManagedInsightRules, +ec2:DescribeVpcEndpointServiceConfigurations, +ec2:CreateTags +``` + +### Update +```json +ec2:ModifyVpcEndpointServiceConfiguration, +ec2:DescribeVpcEndpointServiceConfigurations, +ec2:ModifyVpcEndpointServicePayerResponsibility, +cloudwatch:ListManagedInsightRules, +cloudwatch:DeleteInsightRules, +cloudwatch:PutManagedInsightRules, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Read +```json +ec2:DescribeVpcEndpointServiceConfigurations, +cloudwatch:ListManagedInsightRules +``` + +### Delete +```json +ec2:DeleteVpcEndpointServiceConfigurations, +ec2:DescribeVpcEndpointServiceConfigurations, +cloudwatch:ListManagedInsightRules, +cloudwatch:DeleteInsightRules, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeVpcEndpointServiceConfigurations, +cloudwatch:ListManagedInsightRules +``` diff --git a/website/docs/services/ec2/vpc_endpoint_services_list_only/index.md b/website/docs/services/ec2/vpc_endpoint_services_list_only/index.md new file mode 100644 index 0000000..a852133 --- /dev/null +++ b/website/docs/services/ec2/vpc_endpoint_services_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_endpoint_services_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_services_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_endpoint_services in a region or regions, for all properties use vpc_endpoint_services + +## Overview + + + + + + + +
Namevpc_endpoint_services_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointService
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_endpoint_services in a region. +```sql +SELECT +region, +service_id +FROM aws.ec2.vpc_endpoint_services_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoint_services_list_only resource, see vpc_endpoint_services + diff --git a/website/docs/services/ec2/vpc_endpoint_tags/index.md b/website/docs/services/ec2/vpc_endpoint_tags/index.md new file mode 100644 index 0000000..903abc1 --- /dev/null +++ b/website/docs/services/ec2/vpc_endpoint_tags/index.md @@ -0,0 +1,107 @@ +--- +title: vpc_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_endpoints in a region + +## Overview + + + + + + + +
Namevpc_endpoint_tags
TypeResource
DescriptionSpecifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).
An endpoint of type Interface establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.
An endpoint of type gateway serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [Why can't I connect to an S3 bucket using a gateway VPC endpoint?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/connect-s3-vpc-endpoint)
An endpoint of type GatewayLoadBalancer provides private connectivity between your VPC and virtual appliances from a service provider.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport.
This property is supported only for interface endpoints.
Default: false
string
string
object
array
array
string
arrayThe IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
arrayThe IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
string
stringThe ID of the VPC.
arrayThe IDs of the route tables. Routing is supported only for gateway endpoints.
stringThe name of the endpoint service.
objectAn endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.
For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. For example, if you have a JSON policy, you can convert it to YAML before including it in the YAML template, and CFNlong converts the policy to JSON format before calling the API actions for privatelink. Alternatively, you can include the JSON directly in the YAML, as shown in the following Properties section:
Properties: VpcEndpointType: 'Interface' ServiceName: !Sub 'com.amazonaws.${AWS::Region}.logs' PolicyDocument: '{ "Version":"2012-10-17", "Statement": [{ "Effect":"Allow", "Principal":"*", "Action":["logs:Describe*","logs:Get*","logs:List*","logs:FilterLogEvents"], "Resource":"*" }] }'
stringThe type of endpoint.
Default: Gateway
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_endpoints in a region. +```sql +SELECT +region, +private_dns_enabled, +ip_address_type, +creation_timestamp, +dns_options, +network_interface_ids, +dns_entries, +resource_configuration_arn, +security_group_ids, +subnet_ids, +service_network_arn, +vpc_id, +route_table_ids, +service_name, +policy_document, +vpc_endpoint_type, +id, +tag_key, +tag_value +FROM aws.ec2.vpc_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoint_tags resource, see vpc_endpoints + diff --git a/website/docs/services/ec2/vpc_endpoints/index.md b/website/docs/services/ec2/vpc_endpoints/index.md new file mode 100644 index 0000000..df18017 --- /dev/null +++ b/website/docs/services/ec2/vpc_endpoints/index.md @@ -0,0 +1,323 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_endpoint resource or lists 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/).
An endpoint of type Interface establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.
An endpoint of type gateway serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [Why can't I connect to an S3 bucket using a gateway VPC endpoint?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/connect-s3-vpc-endpoint)
An endpoint of type GatewayLoadBalancer provides private connectivity between your VPC and virtual appliances from a service provider.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport.
This property is supported only for interface endpoints.
Default: false
string
string
object
array
array
string
arrayThe IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
arrayThe IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
string
stringThe ID of the VPC.
arrayThe IDs of the route tables. Routing is supported only for gateway endpoints.
stringThe name of the endpoint service.
objectAn endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.
For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. For example, if you have a JSON policy, you can convert it to YAML before including it in the YAML template, and CFNlong converts the policy to JSON format before calling the API actions for privatelink. Alternatively, you can include the JSON directly in the YAML, as shown in the following Properties section:
Properties: VpcEndpointType: 'Interface' ServiceName: !Sub 'com.amazonaws.${AWS::Region}.logs' PolicyDocument: '{ "Version":"2012-10-17", "Statement": [{ "Effect":"Allow", "Principal":"*", "Action":["logs:Describe*","logs:Get*","logs:List*","logs:FilterLogEvents"], "Resource":"*" }] }'
stringThe type of endpoint.
Default: Gateway
string
array
stringAWS region.
+ +For more information, see AWS::EC2::VPCEndpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_endpoints in a region. +```sql +SELECT +region, +private_dns_enabled, +ip_address_type, +creation_timestamp, +dns_options, +network_interface_ids, +dns_entries, +resource_configuration_arn, +security_group_ids, +subnet_ids, +service_network_arn, +vpc_id, +route_table_ids, +service_name, +policy_document, +vpc_endpoint_type, +id, +tags +FROM aws.ec2.vpc_endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_endpoint. +```sql +SELECT +region, +private_dns_enabled, +ip_address_type, +creation_timestamp, +dns_options, +network_interface_ids, +dns_entries, +resource_configuration_arn, +security_group_ids, +subnet_ids, +service_network_arn, +vpc_id, +route_table_ids, +service_name, +policy_document, +vpc_endpoint_type, +id, +tags +FROM aws.ec2.vpc_endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_endpoints ( + VpcId, + region +) +SELECT +'{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_endpoints ( + PrivateDnsEnabled, + IpAddressType, + DnsOptions, + ResourceConfigurationArn, + SecurityGroupIds, + SubnetIds, + ServiceNetworkArn, + VpcId, + RouteTableIds, + ServiceName, + PolicyDocument, + VpcEndpointType, + Tags, + region +) +SELECT + '{{ PrivateDnsEnabled }}', + '{{ IpAddressType }}', + '{{ DnsOptions }}', + '{{ ResourceConfigurationArn }}', + '{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ ServiceNetworkArn }}', + '{{ VpcId }}', + '{{ RouteTableIds }}', + '{{ ServiceName }}', + '{{ PolicyDocument }}', + '{{ VpcEndpointType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_endpoint + props: + - name: PrivateDnsEnabled + value: '{{ PrivateDnsEnabled }}' + - name: IpAddressType + value: '{{ IpAddressType }}' + - name: DnsOptions + value: + PrivateDnsOnlyForInboundResolverEndpoint: '{{ PrivateDnsOnlyForInboundResolverEndpoint }}' + DnsRecordIpType: '{{ DnsRecordIpType }}' + - name: ResourceConfigurationArn + value: '{{ ResourceConfigurationArn }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: ServiceNetworkArn + value: '{{ ServiceNetworkArn }}' + - name: VpcId + value: '{{ VpcId }}' + - name: RouteTableIds + value: + - '{{ RouteTableIds[0] }}' + - name: ServiceName + value: '{{ ServiceName }}' + - name: PolicyDocument + value: {} + - name: VpcEndpointType + value: '{{ VpcEndpointType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpc_endpoints +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpc_endpoints resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpcEndpoints, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation +``` + +### Create +```json +ec2:CreateVpcEndpoint, +ec2:DescribeVpcEndpoints, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +vpc-lattice:CreateServiceNetworkVpcEndpointAssociation, +vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Update +```json +ec2:ModifyVpcEndpoint, +ec2:DescribeVpcEndpoints, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +vpc-lattice:CreateServiceNetworkVpcEndpointAssociation, +vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation, +ec2:CreateTags, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeVpcEndpoints, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation +``` + +### Delete +```json +ec2:DeleteVpcEndpoints, +ec2:DescribeVpcEndpoints, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation, +ec2:CreateTags, +ec2:DeleteTags +``` diff --git a/website/docs/services/ec2/vpc_endpoints_list_only/index.md b/website/docs/services/ec2/vpc_endpoints_list_only/index.md new file mode 100644 index 0000000..58e1e2d --- /dev/null +++ b/website/docs/services/ec2/vpc_endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoints_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_endpoints in a region or regions, for all properties use vpc_endpoints + +## Overview + + + + + + + +
Namevpc_endpoints_list_only
TypeResource
DescriptionSpecifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).
An endpoint of type Interface establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.
An endpoint of type gateway serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [Why can't I connect to an S3 bucket using a gateway VPC endpoint?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/connect-s3-vpc-endpoint)
An endpoint of type GatewayLoadBalancer provides private connectivity between your VPC and virtual appliances from a service provider.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_endpoints in a region. +```sql +SELECT +region, +id +FROM aws.ec2.vpc_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoints_list_only resource, see vpc_endpoints + diff --git a/website/docs/services/ec2/vpc_gateway_attachments/index.md b/website/docs/services/ec2/vpc_gateway_attachments/index.md new file mode 100644 index 0000000..4b17c4c --- /dev/null +++ b/website/docs/services/ec2/vpc_gateway_attachments/index.md @@ -0,0 +1,224 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_gateway_attachment resource or lists vpc_gateway_attachments in a region + +## Overview + + + + + + + +
Namevpc_gateway_attachments
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCGatewayAttachment
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringUsed to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
stringThe ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
stringThe ID of the VPC.
stringThe ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
stringAWS region.
+ +For more information, see AWS::EC2::VPCGatewayAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_gateway_attachments in a region. +```sql +SELECT +region, +attachment_type, +internet_gateway_id, +vpc_id, +vpn_gateway_id +FROM aws.ec2.vpc_gateway_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_gateway_attachment. +```sql +SELECT +region, +attachment_type, +internet_gateway_id, +vpc_id, +vpn_gateway_id +FROM aws.ec2.vpc_gateway_attachments +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_gateway_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_gateway_attachments ( + VpcId, + region +) +SELECT +'{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_gateway_attachments ( + InternetGatewayId, + VpcId, + VpnGatewayId, + region +) +SELECT + '{{ InternetGatewayId }}', + '{{ VpcId }}', + '{{ VpnGatewayId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_gateway_attachment + props: + - name: InternetGatewayId + value: '{{ InternetGatewayId }}' + - name: VpcId + value: '{{ VpcId }}' + - name: VpnGatewayId + value: '{{ VpnGatewayId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpc_gateway_attachments +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ec2:DescribeInternetGateways, +ec2:DescribeVpnGateways +``` diff --git a/website/docs/services/ec2/vpc_gateway_attachments_list_only/index.md b/website/docs/services/ec2/vpc_gateway_attachments_list_only/index.md new file mode 100644 index 0000000..46c45a0 --- /dev/null +++ b/website/docs/services/ec2/vpc_gateway_attachments_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: vpc_gateway_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_gateway_attachments_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_gateway_attachments in a region or regions, for all properties use vpc_gateway_attachments + +## Overview + + + + + + + +
Namevpc_gateway_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCGatewayAttachment
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringUsed to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
stringThe ID of the VPC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_gateway_attachments in a region. +```sql +SELECT +region, +attachment_type, +vpc_id +FROM aws.ec2.vpc_gateway_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_gateway_attachments_list_only resource, see vpc_gateway_attachments + diff --git a/website/docs/services/ec2/vpc_peering_connection_tags/index.md b/website/docs/services/ec2/vpc_peering_connection_tags/index.md new file mode 100644 index 0000000..02076ba --- /dev/null +++ b/website/docs/services/ec2/vpc_peering_connection_tags/index.md @@ -0,0 +1,87 @@ +--- +title: vpc_peering_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_peering_connection_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_peering_connections in a region + +## Overview + + + + + + + +
Namevpc_peering_connection_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCPeeringConnection
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
stringThe ID of the VPC.
stringThe ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
string
stringThe Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
stringThe AWS account ID of the owner of the accepter VPC.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_peering_connections in a region. +```sql +SELECT +region, +peer_role_arn, +vpc_id, +peer_vpc_id, +id, +peer_region, +peer_owner_id, +tag_key, +tag_value +FROM aws.ec2.vpc_peering_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_peering_connection_tags resource, see vpc_peering_connections + diff --git a/website/docs/services/ec2/vpc_peering_connections/index.md b/website/docs/services/ec2/vpc_peering_connections/index.md new file mode 100644 index 0000000..2295bd1 --- /dev/null +++ b/website/docs/services/ec2/vpc_peering_connections/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_peering_connection resource or lists vpc_peering_connections in a region + +## Overview + + + + + + + +
Namevpc_peering_connections
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCPeeringConnection
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
stringThe ID of the VPC.
stringThe ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
string
stringThe Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
stringThe AWS account ID of the owner of the accepter VPC.
array
stringAWS region.
+ +For more information, see AWS::EC2::VPCPeeringConnection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_peering_connections in a region. +```sql +SELECT +region, +peer_role_arn, +vpc_id, +peer_vpc_id, +id, +peer_region, +peer_owner_id, +tags +FROM aws.ec2.vpc_peering_connections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_peering_connection. +```sql +SELECT +region, +peer_role_arn, +vpc_id, +peer_vpc_id, +id, +peer_region, +peer_owner_id, +tags +FROM aws.ec2.vpc_peering_connections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_peering_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_peering_connections ( + VpcId, + PeerVpcId, + region +) +SELECT +'{{ VpcId }}', + '{{ PeerVpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpc_peering_connections ( + PeerRoleArn, + VpcId, + PeerVpcId, + PeerRegion, + PeerOwnerId, + Tags, + region +) +SELECT + '{{ PeerRoleArn }}', + '{{ VpcId }}', + '{{ PeerVpcId }}', + '{{ PeerRegion }}', + '{{ PeerOwnerId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_peering_connection + props: + - name: PeerRoleArn + value: '{{ PeerRoleArn }}' + - name: VpcId + value: '{{ VpcId }}' + - name: PeerVpcId + value: '{{ PeerVpcId }}' + - name: PeerRegion + value: '{{ PeerRegion }}' + - name: PeerOwnerId + value: '{{ PeerOwnerId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpc_peering_connections +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpc_peering_connections resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpcPeeringConnections +``` + +### Create +```json +ec2:CreateVpcPeeringConnection, +ec2:DescribeVpcPeeringConnections, +ec2:AcceptVpcPeeringConnection, +ec2:CreateTags, +sts:AssumeRole +``` + +### Update +```json +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeVpcPeeringConnections +``` + +### List +```json +ec2:DescribeVpcPeeringConnections +``` + +### Delete +```json +ec2:DeleteVpcPeeringConnection, +ec2:DescribeVpcPeeringConnections +``` diff --git a/website/docs/services/ec2/vpc_peering_connections_list_only/index.md b/website/docs/services/ec2/vpc_peering_connections_list_only/index.md new file mode 100644 index 0000000..adf2f9e --- /dev/null +++ b/website/docs/services/ec2/vpc_peering_connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_peering_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_peering_connections_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_peering_connections in a region or regions, for all properties use vpc_peering_connections + +## Overview + + + + + + + +
Namevpc_peering_connections_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCPeeringConnection
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_peering_connections in a region. +```sql +SELECT +region, +id +FROM aws.ec2.vpc_peering_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_peering_connections_list_only resource, see vpc_peering_connections + diff --git a/website/docs/services/ec2/vpc_tags/index.md b/website/docs/services/ec2/vpc_tags/index.md new file mode 100644 index 0000000..87b1d1b --- /dev/null +++ b/website/docs/services/ec2/vpc_tags/index.md @@ -0,0 +1,97 @@ +--- +title: vpc_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpcs in a region + +## Overview + + + + + + + +
Namevpc_tags
TypeResource
DescriptionSpecifies a virtual private cloud (VPC).
To add an IPv6 CIDR block to the VPC, see [AWS::EC2::VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html).
For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe allowed tenancy of instances launched into the VPC.
+ default: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
+ dedicated: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.

Updating InstanceTenancy requires no replacement only if you are updating its value from dedicated to default. Updating InstanceTenancy from default to dedicated requires replacement.
integerThe netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
array
stringThe IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
You must specify eitherCidrBlock or Ipv4IpamPoolId.
stringThe ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
You must specify eitherCidrBlock or Ipv4IpamPoolId.
string
booleanIndicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
array
string
booleanIndicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
You can only enable DNS hostnames if you've enabled DNS support.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpcs in a region. +```sql +SELECT +region, +vpc_id, +instance_tenancy, +ipv4_netmask_length, +cidr_block_associations, +cidr_block, +ipv4_ipam_pool_id, +default_network_acl, +enable_dns_support, +ipv6_cidr_blocks, +default_security_group, +enable_dns_hostnames, +tag_key, +tag_value +FROM aws.ec2.vpc_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_tags resource, see vpcs + diff --git a/website/docs/services/ec2/vpcdhcp_options_associations/index.md b/website/docs/services/ec2/vpcdhcp_options_associations/index.md new file mode 100644 index 0000000..fbe8960 --- /dev/null +++ b/website/docs/services/ec2/vpcdhcp_options_associations/index.md @@ -0,0 +1,203 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpcdhcp_options_association resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
stringThe ID of the VPC.
stringAWS region.
+ +For more information, see AWS::EC2::VPCDHCPOptionsAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpcdhcp_options_associations in a region. +```sql +SELECT +region, +dhcp_options_id, +vpc_id +FROM aws.ec2.vpcdhcp_options_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpcdhcp_options_association. +```sql +SELECT +region, +dhcp_options_id, +vpc_id +FROM aws.ec2.vpcdhcp_options_associations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpcdhcp_options_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpcdhcp_options_associations ( + DhcpOptionsId, + VpcId, + region +) +SELECT +'{{ DhcpOptionsId }}', + '{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpcdhcp_options_associations ( + DhcpOptionsId, + VpcId, + region +) +SELECT + '{{ DhcpOptionsId }}', + '{{ VpcId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpcdhcp_options_association + props: + - name: DhcpOptionsId + value: '{{ DhcpOptionsId }}' + - name: VpcId + value: '{{ VpcId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpcdhcp_options_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpcdhcp_options_associations resource, the following permissions are required: + +### Create +```json +ec2:AssociateDhcpOptions +``` + +### Update +```json +ec2:AssociateDhcpOptions +``` + +### Delete +```json +ec2:AssociateDhcpOptions +``` + +### Read +```json +ec2:DescribeVpcs +``` + +### List +```json +ec2:DescribeVpcs +``` diff --git a/website/docs/services/ec2/vpcdhcp_options_associations_list_only/index.md b/website/docs/services/ec2/vpcdhcp_options_associations_list_only/index.md new file mode 100644 index 0000000..9602411 --- /dev/null +++ b/website/docs/services/ec2/vpcdhcp_options_associations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: vpcdhcp_options_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpcdhcp_options_associations_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpcdhcp_options_associations in a region or regions, for all properties use vpcdhcp_options_associations + +## Overview + + + + + + + +
Namevpcdhcp_options_associations_list_only
TypeResource
DescriptionAssociates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
stringThe ID of the VPC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpcdhcp_options_associations in a region. +```sql +SELECT +region, +dhcp_options_id, +vpc_id +FROM aws.ec2.vpcdhcp_options_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpcdhcp_options_associations_list_only resource, see vpcdhcp_options_associations + diff --git a/website/docs/services/ec2/vpcs/index.md b/website/docs/services/ec2/vpcs/index.md new file mode 100644 index 0000000..1c47636 --- /dev/null +++ b/website/docs/services/ec2/vpcs/index.md @@ -0,0 +1,275 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc resource or lists vpcs in a region + +## Overview + + + + + + + +
Namevpcs
TypeResource
DescriptionSpecifies a virtual private cloud (VPC).
To add an IPv6 CIDR block to the VPC, see [AWS::EC2::VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html).
For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe allowed tenancy of instances launched into the VPC.
+ default: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
+ dedicated: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.

Updating InstanceTenancy requires no replacement only if you are updating its value from dedicated to default. Updating InstanceTenancy from default to dedicated requires replacement.
integerThe netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
array
stringThe IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
You must specify eitherCidrBlock or Ipv4IpamPoolId.
stringThe ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
You must specify eitherCidrBlock or Ipv4IpamPoolId.
string
booleanIndicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
array
string
booleanIndicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
You can only enable DNS hostnames if you've enabled DNS support.
arrayThe tags for the VPC.
stringAWS region.
+ +For more information, see AWS::EC2::VPC. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpcs in a region. +```sql +SELECT +region, +vpc_id, +instance_tenancy, +ipv4_netmask_length, +cidr_block_associations, +cidr_block, +ipv4_ipam_pool_id, +default_network_acl, +enable_dns_support, +ipv6_cidr_blocks, +default_security_group, +enable_dns_hostnames, +tags +FROM aws.ec2.vpcs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc. +```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.vpcs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpcs ( + InstanceTenancy, + Ipv4NetmaskLength, + CidrBlock, + Ipv4IpamPoolId, + EnableDnsSupport, + EnableDnsHostnames, + Tags, + region +) +SELECT +'{{ InstanceTenancy }}', + '{{ Ipv4NetmaskLength }}', + '{{ CidrBlock }}', + '{{ Ipv4IpamPoolId }}', + '{{ EnableDnsSupport }}', + '{{ EnableDnsHostnames }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpcs ( + InstanceTenancy, + Ipv4NetmaskLength, + CidrBlock, + Ipv4IpamPoolId, + EnableDnsSupport, + EnableDnsHostnames, + Tags, + region +) +SELECT + '{{ InstanceTenancy }}', + '{{ Ipv4NetmaskLength }}', + '{{ CidrBlock }}', + '{{ Ipv4IpamPoolId }}', + '{{ EnableDnsSupport }}', + '{{ EnableDnsHostnames }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc + props: + - name: InstanceTenancy + value: '{{ InstanceTenancy }}' + - name: Ipv4NetmaskLength + value: '{{ Ipv4NetmaskLength }}' + - name: CidrBlock + value: '{{ CidrBlock }}' + - name: Ipv4IpamPoolId + value: '{{ Ipv4IpamPoolId }}' + - name: EnableDnsSupport + value: '{{ EnableDnsSupport }}' + - name: EnableDnsHostnames + value: '{{ EnableDnsHostnames }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpcs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpcs resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpcs, +ec2:DescribeSecurityGroups, +ec2:DescribeNetworkAcls, +ec2:DescribeVpcAttribute +``` + +### Create +```json +ec2:CreateVpc, +ec2:DescribeVpcs, +ec2:ModifyVpcAttribute, +ec2:CreateTags +``` + +### Update +```json +ec2:CreateTags, +ec2:ModifyVpcAttribute, +ec2:DeleteTags, +ec2:ModifyVpcTenancy +``` + +### List +```json +ec2:DescribeVpcs +``` + +### Delete +```json +ec2:DeleteVpc, +ec2:DescribeVpcs +``` diff --git a/website/docs/services/ec2/vpcs_list_only/index.md b/website/docs/services/ec2/vpcs_list_only/index.md new file mode 100644 index 0000000..b483203 --- /dev/null +++ b/website/docs/services/ec2/vpcs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpcs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpcs_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpcs in a region or regions, for all properties use vpcs + +## Overview + + + + + + + +
Namevpcs_list_only
TypeResource
DescriptionSpecifies a virtual private cloud (VPC).
To add an IPv6 CIDR block to the VPC, see [AWS::EC2::VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html).
For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpcs in a region. +```sql +SELECT +region, +vpc_id +FROM aws.ec2.vpcs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpcs_list_only resource, see vpcs + diff --git a/website/docs/services/ec2/vpn_connection_routes/index.md b/website/docs/services/ec2/vpn_connection_routes/index.md new file mode 100644 index 0000000..ae5d782 --- /dev/null +++ b/website/docs/services/ec2/vpn_connection_routes/index.md @@ -0,0 +1,195 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpn_connection_route resource or lists vpn_connection_routes in a region + +## Overview + + + + + + + +
Namevpn_connection_routes
TypeResource
DescriptionSpecifies a static route for 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.
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe CIDR block associated with the local subnet of the customer network.
stringThe ID of the VPN connection.
stringAWS region.
+ +For more information, see AWS::EC2::VPNConnectionRoute. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpn_connection_routes in a region. +```sql +SELECT +region, +destination_cidr_block, +vpn_connection_id +FROM aws.ec2.vpn_connection_routes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpn_connection_route. +```sql +SELECT +region, +destination_cidr_block, +vpn_connection_id +FROM aws.ec2.vpn_connection_routes +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpn_connection_route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpn_connection_routes ( + DestinationCidrBlock, + VpnConnectionId, + region +) +SELECT +'{{ DestinationCidrBlock }}', + '{{ VpnConnectionId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpn_connection_routes ( + DestinationCidrBlock, + VpnConnectionId, + region +) +SELECT + '{{ DestinationCidrBlock }}', + '{{ VpnConnectionId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpn_connection_route + props: + - name: DestinationCidrBlock + value: '{{ DestinationCidrBlock }}' + - name: VpnConnectionId + value: '{{ VpnConnectionId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpn_connection_routes +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpn_connection_routes resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpnConnections +``` + +### Create +```json +ec2:CreateVpnConnectionRoute, +ec2:DescribeVpnConnections +``` + +### List +```json +ec2:DescribeVpnConnections +``` + +### Delete +```json +ec2:DeleteVpnConnectionRoute, +ec2:DescribeVpnConnections +``` diff --git a/website/docs/services/ec2/vpn_connection_routes_list_only/index.md b/website/docs/services/ec2/vpn_connection_routes_list_only/index.md new file mode 100644 index 0000000..a014ab5 --- /dev/null +++ b/website/docs/services/ec2/vpn_connection_routes_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: vpn_connection_routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connection_routes_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpn_connection_routes in a region or regions, for all properties use vpn_connection_routes + +## Overview + + + + + + + +
Namevpn_connection_routes_list_only
TypeResource
DescriptionSpecifies a static route for 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.
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe CIDR block associated with the local subnet of the customer network.
stringThe ID of the VPN connection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpn_connection_routes in a region. +```sql +SELECT +region, +destination_cidr_block, +vpn_connection_id +FROM aws.ec2.vpn_connection_routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpn_connection_routes_list_only resource, see vpn_connection_routes + diff --git a/website/docs/services/ec2/vpn_connection_tags/index.md b/website/docs/services/ec2/vpn_connection_tags/index.md new file mode 100644 index 0000000..0d7088a --- /dev/null +++ b/website/docs/services/ec2/vpn_connection_tags/index.md @@ -0,0 +1,105 @@ +--- +title: vpn_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connection_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpn_connections in a region + +## Overview + + + + + + + +
Namevpn_connection_tags
TypeResource
DescriptionSpecifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.
To specify a VPN connection between a transit gateway and customer gateway, use the TransitGatewayId and CustomerGatewayId properties.
To specify a VPN connection between a virtual private gateway and customer gateway, use the VpnGatewayId and CustomerGatewayId properties.
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IPv6 CIDR on the AWS side of the VPN connection.
Default: ::/0
stringThe IPv4 CIDR on the AWS side of the VPN connection.
Default: 0.0.0.0/0
arrayThe tunnel options for the VPN connection.
stringThe ID of the customer gateway at your end of the VPN connection.
stringThe type of IPv4 address assigned to the outside interface of the customer gateway device.
Valid values: PrivateIpv4 | PublicIpv4
Default: PublicIpv4
booleanIndicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify true.
booleanIndicate whether to enable acceleration for the VPN connection.
Default: false
stringThe ID of the transit gateway associated with the VPN connection.
You must specify either TransitGatewayId or VpnGatewayId, but not both.
stringThe type of VPN connection.
stringThe IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
stringThe ID of the virtual private gateway at the AWS side of the VPN connection.
You must specify either TransitGatewayId or VpnGatewayId, but not both.
stringThe transit gateway attachment ID to use for the VPN tunnel.
Required if OutsideIpAddressType is set to PrivateIpv4.
stringThe IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
string
stringIndicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpn_connections in a region. +```sql +SELECT +region, +remote_ipv6_network_cidr, +remote_ipv4_network_cidr, +vpn_tunnel_options_specifications, +customer_gateway_id, +outside_ip_address_type, +static_routes_only, +enable_acceleration, +transit_gateway_id, +type, +local_ipv4_network_cidr, +vpn_gateway_id, +transport_transit_gateway_attachment_id, +local_ipv6_network_cidr, +vpn_connection_id, +tunnel_inside_ip_version, +tag_key, +tag_value +FROM aws.ec2.vpn_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpn_connection_tags resource, see vpn_connections + diff --git a/website/docs/services/ec2/vpn_connections/index.md b/website/docs/services/ec2/vpn_connections/index.md new file mode 100644 index 0000000..1d8d11a --- /dev/null +++ b/website/docs/services/ec2/vpn_connections/index.md @@ -0,0 +1,335 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpn_connection resource or lists vpn_connections in a region + +## Overview + + + + + + + +
Namevpn_connections
TypeResource
DescriptionSpecifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.
To specify a VPN connection between a transit gateway and customer gateway, use the TransitGatewayId and CustomerGatewayId properties.
To specify a VPN connection between a virtual private gateway and customer gateway, use the VpnGatewayId and CustomerGatewayId properties.
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IPv6 CIDR on the AWS side of the VPN connection.
Default: ::/0
stringThe IPv4 CIDR on the AWS side of the VPN connection.
Default: 0.0.0.0/0
arrayThe tunnel options for the VPN connection.
stringThe ID of the customer gateway at your end of the VPN connection.
stringThe type of IPv4 address assigned to the outside interface of the customer gateway device.
Valid values: PrivateIpv4 | PublicIpv4
Default: PublicIpv4
booleanIndicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify true.
booleanIndicate whether to enable acceleration for the VPN connection.
Default: false
stringThe ID of the transit gateway associated with the VPN connection.
You must specify either TransitGatewayId or VpnGatewayId, but not both.
stringThe type of VPN connection.
stringThe IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
stringThe ID of the virtual private gateway at the AWS side of the VPN connection.
You must specify either TransitGatewayId or VpnGatewayId, but not both.
stringThe transit gateway attachment ID to use for the VPN tunnel.
Required if OutsideIpAddressType is set to PrivateIpv4.
stringThe IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
string
stringIndicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
arrayAny tags assigned to the VPN connection.
stringAWS region.
+ +For more information, see AWS::EC2::VPNConnection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpn_connections in a region. +```sql +SELECT +region, +remote_ipv6_network_cidr, +remote_ipv4_network_cidr, +vpn_tunnel_options_specifications, +customer_gateway_id, +outside_ip_address_type, +static_routes_only, +enable_acceleration, +transit_gateway_id, +type, +local_ipv4_network_cidr, +vpn_gateway_id, +transport_transit_gateway_attachment_id, +local_ipv6_network_cidr, +vpn_connection_id, +tunnel_inside_ip_version, +tags +FROM aws.ec2.vpn_connections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpn_connection. +```sql +SELECT +region, +remote_ipv6_network_cidr, +remote_ipv4_network_cidr, +vpn_tunnel_options_specifications, +customer_gateway_id, +outside_ip_address_type, +static_routes_only, +enable_acceleration, +transit_gateway_id, +type, +local_ipv4_network_cidr, +vpn_gateway_id, +transport_transit_gateway_attachment_id, +local_ipv6_network_cidr, +vpn_connection_id, +tunnel_inside_ip_version, +tags +FROM aws.ec2.vpn_connections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpn_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpn_connections ( + CustomerGatewayId, + Type, + region +) +SELECT +'{{ CustomerGatewayId }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpn_connections ( + RemoteIpv6NetworkCidr, + RemoteIpv4NetworkCidr, + VpnTunnelOptionsSpecifications, + CustomerGatewayId, + OutsideIpAddressType, + StaticRoutesOnly, + EnableAcceleration, + TransitGatewayId, + Type, + LocalIpv4NetworkCidr, + VpnGatewayId, + TransportTransitGatewayAttachmentId, + LocalIpv6NetworkCidr, + TunnelInsideIpVersion, + Tags, + region +) +SELECT + '{{ RemoteIpv6NetworkCidr }}', + '{{ RemoteIpv4NetworkCidr }}', + '{{ VpnTunnelOptionsSpecifications }}', + '{{ CustomerGatewayId }}', + '{{ OutsideIpAddressType }}', + '{{ StaticRoutesOnly }}', + '{{ EnableAcceleration }}', + '{{ TransitGatewayId }}', + '{{ Type }}', + '{{ LocalIpv4NetworkCidr }}', + '{{ VpnGatewayId }}', + '{{ TransportTransitGatewayAttachmentId }}', + '{{ LocalIpv6NetworkCidr }}', + '{{ TunnelInsideIpVersion }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpn_connection + props: + - name: RemoteIpv6NetworkCidr + value: '{{ RemoteIpv6NetworkCidr }}' + - name: RemoteIpv4NetworkCidr + value: '{{ RemoteIpv4NetworkCidr }}' + - name: VpnTunnelOptionsSpecifications + value: + - Phase2EncryptionAlgorithms: + - Value: '{{ Value }}' + Phase2DHGroupNumbers: + - Value: '{{ Value }}' + TunnelInsideIpv6Cidr: '{{ TunnelInsideIpv6Cidr }}' + StartupAction: '{{ StartupAction }}' + TunnelInsideCidr: '{{ TunnelInsideCidr }}' + IKEVersions: + - Value: '{{ Value }}' + LogOptions: + CloudwatchLogOptions: + LogEnabled: '{{ LogEnabled }}' + LogOutputFormat: '{{ LogOutputFormat }}' + LogGroupArn: '{{ LogGroupArn }}' + Phase1DHGroupNumbers: + - Value: '{{ Value }}' + ReplayWindowSize: '{{ ReplayWindowSize }}' + EnableTunnelLifecycleControl: '{{ EnableTunnelLifecycleControl }}' + RekeyMarginTimeSeconds: '{{ RekeyMarginTimeSeconds }}' + DPDTimeoutAction: '{{ DPDTimeoutAction }}' + Phase2LifetimeSeconds: '{{ Phase2LifetimeSeconds }}' + Phase2IntegrityAlgorithms: + - Value: '{{ Value }}' + Phase1IntegrityAlgorithms: + - Value: '{{ Value }}' + PreSharedKey: '{{ PreSharedKey }}' + Phase1LifetimeSeconds: '{{ Phase1LifetimeSeconds }}' + RekeyFuzzPercentage: '{{ RekeyFuzzPercentage }}' + Phase1EncryptionAlgorithms: + - Value: '{{ Value }}' + DPDTimeoutSeconds: '{{ DPDTimeoutSeconds }}' + - name: CustomerGatewayId + value: '{{ CustomerGatewayId }}' + - name: OutsideIpAddressType + value: '{{ OutsideIpAddressType }}' + - name: StaticRoutesOnly + value: '{{ StaticRoutesOnly }}' + - name: EnableAcceleration + value: '{{ EnableAcceleration }}' + - name: TransitGatewayId + value: '{{ TransitGatewayId }}' + - name: Type + value: '{{ Type }}' + - name: LocalIpv4NetworkCidr + value: '{{ LocalIpv4NetworkCidr }}' + - name: VpnGatewayId + value: '{{ VpnGatewayId }}' + - name: TransportTransitGatewayAttachmentId + value: '{{ TransportTransitGatewayAttachmentId }}' + - name: LocalIpv6NetworkCidr + value: '{{ LocalIpv6NetworkCidr }}' + - name: TunnelInsideIpVersion + value: '{{ TunnelInsideIpVersion }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpn_connections +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpn_connections resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpnConnections +``` + +### Create +```json +ec2:DescribeVpnConnections, +ec2:CreateVpnConnection, +ec2:CreateTags +``` + +### Update +```json +ec2:DescribeVpnConnections, +ec2:CreateTags, +ec2:DeleteTags +``` + +### List +```json +ec2:DescribeVpnConnections +``` + +### Delete +```json +ec2:DescribeVpnConnections, +ec2:DeleteVpnConnection +``` diff --git a/website/docs/services/ec2/vpn_connections_list_only/index.md b/website/docs/services/ec2/vpn_connections_list_only/index.md new file mode 100644 index 0000000..20b7cc1 --- /dev/null +++ b/website/docs/services/ec2/vpn_connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpn_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connections_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpn_connections in a region or regions, for all properties use vpn_connections + +## Overview + + + + + + + +
Namevpn_connections_list_only
TypeResource
DescriptionSpecifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.
To specify a VPN connection between a transit gateway and customer gateway, use the TransitGatewayId and CustomerGatewayId properties.
To specify a VPN connection between a virtual private gateway and customer gateway, use the VpnGatewayId and CustomerGatewayId properties.
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpn_connections in a region. +```sql +SELECT +region, +vpn_connection_id +FROM aws.ec2.vpn_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpn_connections_list_only resource, see vpn_connections + diff --git a/website/docs/services/ec2/vpn_gateway_tags/index.md b/website/docs/services/ec2/vpn_gateway_tags/index.md new file mode 100644 index 0000000..a019da4 --- /dev/null +++ b/website/docs/services/ec2/vpn_gateway_tags/index.md @@ -0,0 +1,81 @@ +--- +title: vpn_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_gateway_tags + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpn_gateways in a region + +## Overview + + + + + + + +
Namevpn_gateway_tags
TypeResource
DescriptionSpecifies 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.
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
integerThe private Autonomous System Number (ASN) for the Amazon side of a BGP session.
stringThe type of VPN connection the virtual private gateway supports.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpn_gateways in a region. +```sql +SELECT +region, +v_pn_gateway_id, +amazon_side_asn, +type, +tag_key, +tag_value +FROM aws.ec2.vpn_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpn_gateway_tags resource, see vpn_gateways + diff --git a/website/docs/services/ec2/vpn_gateways/index.md b/website/docs/services/ec2/vpn_gateways/index.md new file mode 100644 index 0000000..84ff831 --- /dev/null +++ b/website/docs/services/ec2/vpn_gateways/index.md @@ -0,0 +1,218 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpn_gateway resource or lists vpn_gateways in a region + +## Overview + + + + + + + +
Namevpn_gateways
TypeResource
DescriptionSpecifies 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.
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
integerThe private Autonomous System Number (ASN) for the Amazon side of a BGP session.
arrayAny tags assigned to the virtual private gateway.
stringThe type of VPN connection the virtual private gateway supports.
stringAWS region.
+ +For more information, see AWS::EC2::VPNGateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpn_gateways in a region. +```sql +SELECT +region, +v_pn_gateway_id, +amazon_side_asn, +tags, +type +FROM aws.ec2.vpn_gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpn_gateway. +```sql +SELECT +region, +v_pn_gateway_id, +amazon_side_asn, +tags, +type +FROM aws.ec2.vpn_gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpn_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpn_gateways ( + Type, + region +) +SELECT +'{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ec2.vpn_gateways ( + AmazonSideAsn, + Tags, + Type, + region +) +SELECT + '{{ AmazonSideAsn }}', + '{{ Tags }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpn_gateway + props: + - name: AmazonSideAsn + value: '{{ AmazonSideAsn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ec2.vpn_gateways +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vpn_gateways resource, the following permissions are required: + +### Create +```json +ec2:CreateVpnGateway, +ec2:DescribeVpnGateways, +ec2:CreateTags +``` + +### Read +```json +ec2:DescribeVpnGateways +``` + +### Update +```json +ec2:DescribeVpnGateways, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteVpnGateway, +ec2:DescribeVpnGateways +``` + +### List +```json +ec2:DescribeVpnGateways +``` diff --git a/website/docs/services/ec2/vpn_gateways_list_only/index.md b/website/docs/services/ec2/vpn_gateways_list_only/index.md new file mode 100644 index 0000000..571ef0f --- /dev/null +++ b/website/docs/services/ec2/vpn_gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpn_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_gateways_list_only + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpn_gateways in a region or regions, for all properties use vpn_gateways + +## Overview + + + + + + + +
Namevpn_gateways_list_only
TypeResource
DescriptionSpecifies 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.
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpn_gateways in a region. +```sql +SELECT +region, +v_pn_gateway_id +FROM aws.ec2.vpn_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpn_gateways_list_only resource, see vpn_gateways + diff --git a/website/docs/services/ecr/index.md b/website/docs/services/ecr/index.md new file mode 100644 index 0000000..339bc83 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The ecr service documentation. + +:::info Service Summary + +
+
+total resources: 14
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/ecr/public_repositories/index.md b/website/docs/services/ecr/public_repositories/index.md new file mode 100644 index 0000000..54c413f --- /dev/null +++ b/website/docs/services/ecr/public_repositories/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a public_repository resource or lists 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
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.
objectThe JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide.
string
objectThe CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see <link>
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::ECR::PublicRepository. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all public_repositories in a region. +```sql +SELECT +region, +repository_name, +repository_policy_text, +arn, +repository_catalog_data, +tags +FROM aws.ecr.public_repositories +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual public_repository. +```sql +SELECT +region, +repository_name, +repository_policy_text, +arn, +repository_catalog_data, +tags +FROM aws.ecr.public_repositories +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new public_repository resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.public_repositories ( + RepositoryName, + RepositoryPolicyText, + RepositoryCatalogData, + Tags, + region +) +SELECT +'{{ RepositoryName }}', + '{{ RepositoryPolicyText }}', + '{{ RepositoryCatalogData }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.public_repositories ( + RepositoryName, + RepositoryPolicyText, + RepositoryCatalogData, + Tags, + region +) +SELECT + '{{ RepositoryName }}', + '{{ RepositoryPolicyText }}', + '{{ RepositoryCatalogData }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: public_repository + props: + - name: RepositoryName + value: '{{ RepositoryName }}' + - name: RepositoryPolicyText + value: {} + - name: RepositoryCatalogData + value: + RepositoryDescription: '{{ RepositoryDescription }}' + Architectures: + - '{{ Architectures[0] }}' + OperatingSystems: + - '{{ OperatingSystems[0] }}' + AboutText: '{{ AboutText }}' + UsageText: '{{ UsageText }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ecr.public_repositories +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ecr-public:DescribeRepositories +``` diff --git a/website/docs/services/ecr/public_repositories_list_only/index.md b/website/docs/services/ecr/public_repositories_list_only/index.md new file mode 100644 index 0000000..a45f238 --- /dev/null +++ b/website/docs/services/ecr/public_repositories_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: public_repositories_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - public_repositories_list_only + - ecr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists public_repositories in a region or regions, for all properties use public_repositories + +## Overview + + + + + + + +
Namepublic_repositories_list_only
TypeResource
DescriptionThe AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all public_repositories in a region. +```sql +SELECT +region, +repository_name +FROM aws.ecr.public_repositories_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the public_repositories_list_only resource, see public_repositories + diff --git a/website/docs/services/ecr/public_repository_tags/index.md b/website/docs/services/ecr/public_repository_tags/index.md new file mode 100644 index 0000000..80caee2 --- /dev/null +++ b/website/docs/services/ecr/public_repository_tags/index.md @@ -0,0 +1,83 @@ +--- +title: public_repository_tags +hide_title: false +hide_table_of_contents: false +keywords: + - public_repository_tags + - ecr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for public_repositories in a region + +## Overview + + + + + + + +
Namepublic_repository_tags
TypeResource
DescriptionThe AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.
objectThe JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide.
string
objectThe CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see <link>
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all public_repositories in a region. +```sql +SELECT +region, +repository_name, +repository_policy_text, +arn, +repository_catalog_data, +tag_key, +tag_value +FROM aws.ecr.public_repository_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the public_repository_tags resource, see public_repositories + diff --git a/website/docs/services/ecr/pull_through_cache_rules/index.md b/website/docs/services/ecr/pull_through_cache_rules/index.md new file mode 100644 index 0000000..3fb04c4 --- /dev/null +++ b/website/docs/services/ecr/pull_through_cache_rules/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a pull_through_cache_rule resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ECRRepositoryPrefix is a custom alias for upstream registry url.
stringThe upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached
stringThe Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
stringThe name of the upstream registry.
stringAWS region.
+ +For more information, see AWS::ECR::PullThroughCacheRule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all pull_through_cache_rules in a region. +```sql +SELECT +region, +ecr_repository_prefix, +upstream_registry_url, +credential_arn, +upstream_registry +FROM aws.ecr.pull_through_cache_rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual pull_through_cache_rule. +```sql +SELECT +region, +ecr_repository_prefix, +upstream_registry_url, +credential_arn, +upstream_registry +FROM aws.ecr.pull_through_cache_rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pull_through_cache_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.pull_through_cache_rules ( + EcrRepositoryPrefix, + UpstreamRegistryUrl, + CredentialArn, + UpstreamRegistry, + region +) +SELECT +'{{ EcrRepositoryPrefix }}', + '{{ UpstreamRegistryUrl }}', + '{{ CredentialArn }}', + '{{ UpstreamRegistry }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.pull_through_cache_rules ( + EcrRepositoryPrefix, + UpstreamRegistryUrl, + CredentialArn, + UpstreamRegistry, + region +) +SELECT + '{{ EcrRepositoryPrefix }}', + '{{ UpstreamRegistryUrl }}', + '{{ CredentialArn }}', + '{{ UpstreamRegistry }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: pull_through_cache_rule + props: + - name: EcrRepositoryPrefix + value: '{{ EcrRepositoryPrefix }}' + - name: UpstreamRegistryUrl + value: '{{ UpstreamRegistryUrl }}' + - name: CredentialArn + value: '{{ CredentialArn }}' + - name: UpstreamRegistry + value: '{{ UpstreamRegistry }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ecr.pull_through_cache_rules +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ecr:DescribePullThroughCacheRules +``` + +### Update +```json +ecr:DescribePullThroughCacheRules, +ecr:CreatePullThroughCacheRule, +ecr:DeletePullThroughCacheRule, +iam:CreateServiceLinkedRole, +secretsmanager:GetSecretValue +``` + +### Delete +```json +ecr:DescribePullThroughCacheRules, +ecr:DeletePullThroughCacheRule +``` + +### List +```json +ecr:DescribePullThroughCacheRules +``` diff --git a/website/docs/services/ecr/pull_through_cache_rules_list_only/index.md b/website/docs/services/ecr/pull_through_cache_rules_list_only/index.md new file mode 100644 index 0000000..03b05b8 --- /dev/null +++ b/website/docs/services/ecr/pull_through_cache_rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pull_through_cache_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pull_through_cache_rules_list_only + - ecr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pull_through_cache_rules in a region or regions, for all properties use pull_through_cache_rules + +## Overview + + + + + + + +
Namepull_through_cache_rules_list_only
TypeResource
DescriptionThe AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ECRRepositoryPrefix is a custom alias for upstream registry url.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pull_through_cache_rules in a region. +```sql +SELECT +region, +ecr_repository_prefix +FROM aws.ecr.pull_through_cache_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pull_through_cache_rules_list_only resource, see pull_through_cache_rules + diff --git a/website/docs/services/ecr/registry_policies/index.md b/website/docs/services/ecr/registry_policies/index.md new file mode 100644 index 0000000..51ec87c --- /dev/null +++ b/website/docs/services/ecr/registry_policies/index.md @@ -0,0 +1,199 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a registry_policy resource or lists registry_policies in a region + +## Overview + + + + + + + +
Nameregistry_policies
TypeResource
DescriptionThe AWS::ECR::RegistryPolicy resource creates or updates the permissions policy for a private registry.
A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
objectThe JSON policy text for your registry.
stringAWS region.
+ +For more information, see AWS::ECR::RegistryPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all registry_policies in a region. +```sql +SELECT +region, +registry_id, +policy_text +FROM aws.ecr.registry_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual registry_policy. +```sql +SELECT +region, +registry_id, +policy_text +FROM aws.ecr.registry_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new registry_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.registry_policies ( + PolicyText, + region +) +SELECT +'{{ PolicyText }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.registry_policies ( + PolicyText, + region +) +SELECT + '{{ PolicyText }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: registry_policy + props: + - name: PolicyText + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ecr.registry_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the registry_policies resource, the following permissions are required: + +### Create +```json +ecr:GetRegistryPolicy, +ecr:PutRegistryPolicy +``` + +### Read +```json +ecr:GetRegistryPolicy +``` + +### List +```json +ecr:GetRegistryPolicy +``` + +### Update +```json +ecr:GetRegistryPolicy, +ecr:PutRegistryPolicy +``` + +### Delete +```json +ecr:DeleteRegistryPolicy +``` diff --git a/website/docs/services/ecr/registry_policies_list_only/index.md b/website/docs/services/ecr/registry_policies_list_only/index.md new file mode 100644 index 0000000..883f896 --- /dev/null +++ b/website/docs/services/ecr/registry_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: registry_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - registry_policies_list_only + - ecr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists registry_policies in a region or regions, for all properties use registry_policies + +## Overview + + + + + + + +
Nameregistry_policies_list_only
TypeResource
DescriptionThe AWS::ECR::RegistryPolicy resource creates or updates the permissions policy for a private registry.
A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all registry_policies in a region. +```sql +SELECT +region, +registry_id +FROM aws.ecr.registry_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the registry_policies_list_only resource, see registry_policies + diff --git a/website/docs/services/ecr/replication_configurations/index.md b/website/docs/services/ecr/replication_configurations/index.md new file mode 100644 index 0000000..fedcb85 --- /dev/null +++ b/website/docs/services/ecr/replication_configurations/index.md @@ -0,0 +1,204 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a replication_configuration resource or lists 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
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectThe AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html
stringThe RegistryId associated with the aws account.
stringAWS region.
+ +For more information, see AWS::ECR::ReplicationConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all replication_configurations in a region. +```sql +SELECT +region, +replication_configuration, +registry_id +FROM aws.ecr.replication_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual replication_configuration. +```sql +SELECT +region, +replication_configuration, +registry_id +FROM aws.ecr.replication_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new replication_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.replication_configurations ( + ReplicationConfiguration, + region +) +SELECT +'{{ ReplicationConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.replication_configurations ( + ReplicationConfiguration, + region +) +SELECT + '{{ ReplicationConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: replication_configuration + props: + - name: ReplicationConfiguration + value: + ReplicationConfiguration: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ecr.replication_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ecr:DescribeRegistry +``` + +### Update +```json +ecr:DescribeRegistry, +ecr:PutReplicationConfiguration, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +ecr:DescribeRegistry, +ecr:PutReplicationConfiguration, +iam:CreateServiceLinkedRole +``` + +### List +```json +ecr:DescribeRegistry +``` diff --git a/website/docs/services/ecr/replication_configurations_list_only/index.md b/website/docs/services/ecr/replication_configurations_list_only/index.md new file mode 100644 index 0000000..1bdea11 --- /dev/null +++ b/website/docs/services/ecr/replication_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: replication_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - replication_configurations_list_only + - ecr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists replication_configurations in a region or regions, for all properties use replication_configurations + +## Overview + + + + + + + +
Namereplication_configurations_list_only
TypeResource
DescriptionThe AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe RegistryId associated with the aws account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all replication_configurations in a region. +```sql +SELECT +region, +registry_id +FROM aws.ecr.replication_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replication_configurations_list_only resource, see replication_configurations + diff --git a/website/docs/services/ecr/repositories/index.md b/website/docs/services/ecr/repositories/index.md new file mode 100644 index 0000000..77b832b --- /dev/null +++ b/website/docs/services/ecr/repositories/index.md @@ -0,0 +1,292 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a repository resource or lists 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*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIf true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.
objectCreates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).
stringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
objectThe JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.
arrayAn array of key-value pairs to apply to this resource.
string
string
stringThe tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
objectThe image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
objectThe encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
stringAWS region.
+ +For more information, see AWS::ECR::Repository. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all repositories in a region. +```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.repositories +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual repository. +```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.repositories +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new repository resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.repositories ( + EmptyOnDelete, + LifecyclePolicy, + RepositoryName, + RepositoryPolicyText, + Tags, + ImageTagMutability, + ImageScanningConfiguration, + EncryptionConfiguration, + region +) +SELECT +'{{ EmptyOnDelete }}', + '{{ LifecyclePolicy }}', + '{{ RepositoryName }}', + '{{ RepositoryPolicyText }}', + '{{ Tags }}', + '{{ ImageTagMutability }}', + '{{ ImageScanningConfiguration }}', + '{{ EncryptionConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.repositories ( + EmptyOnDelete, + LifecyclePolicy, + RepositoryName, + RepositoryPolicyText, + Tags, + ImageTagMutability, + ImageScanningConfiguration, + EncryptionConfiguration, + region +) +SELECT + '{{ EmptyOnDelete }}', + '{{ LifecyclePolicy }}', + '{{ RepositoryName }}', + '{{ RepositoryPolicyText }}', + '{{ Tags }}', + '{{ ImageTagMutability }}', + '{{ ImageScanningConfiguration }}', + '{{ EncryptionConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: repository + props: + - name: EmptyOnDelete + value: '{{ EmptyOnDelete }}' + - name: LifecyclePolicy + value: + LifecyclePolicyText: '{{ LifecyclePolicyText }}' + RegistryId: '{{ RegistryId }}' + - name: RepositoryName + value: '{{ RepositoryName }}' + - name: RepositoryPolicyText + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ImageTagMutability + value: '{{ ImageTagMutability }}' + - name: ImageScanningConfiguration + value: + ScanOnPush: '{{ ScanOnPush }}' + - name: EncryptionConfiguration + value: + EncryptionType: '{{ EncryptionType }}' + KmsKey: '{{ KmsKey }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ecr.repositories +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ecr:DescribeRepositories +``` diff --git a/website/docs/services/ecr/repositories_list_only/index.md b/website/docs/services/ecr/repositories_list_only/index.md new file mode 100644 index 0000000..8e15b11 --- /dev/null +++ b/website/docs/services/ecr/repositories_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: repositories_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - repositories_list_only + - ecr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists repositories in a region or regions, for all properties use repositories + +## Overview + + + + + + + +
Namerepositories_list_only
TypeResource
DescriptionThe AWS::ECR::Repository resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all repositories in a region. +```sql +SELECT +region, +repository_name +FROM aws.ecr.repositories_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repositories_list_only resource, see repositories + diff --git a/website/docs/services/ecr/repository_creation_templates/index.md b/website/docs/services/ecr/repository_creation_templates/index.md new file mode 100644 index 0000000..b75885e --- /dev/null +++ b/website/docs/services/ecr/repository_creation_templates/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a repository_creation_template resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe prefix use to match the repository name and apply the template.
stringThe description of the template.
stringThe image tag mutability setting for the repository.
stringThe JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
stringThe JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
objectThe encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. By default, when no encryption configuration is set or the AES256 encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.
For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html
arrayAn array of key-value pairs to apply to this resource.
arrayA list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
stringThe ARN of the role to be assumed by ECR. This role must be in the same account as the registry that you are configuring.
stringCreate timestamp of the template.
stringUpdate timestamp of the template.
stringAWS region.
+ +For more information, see AWS::ECR::RepositoryCreationTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all repository_creation_templates in a region. +```sql +SELECT +region, +prefix, +description, +image_tag_mutability, +repository_policy, +lifecycle_policy, +encryption_configuration, +resource_tags, +applied_for, +custom_role_arn, +created_at, +updated_at +FROM aws.ecr.repository_creation_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual repository_creation_template. +```sql +SELECT +region, +prefix, +description, +image_tag_mutability, +repository_policy, +lifecycle_policy, +encryption_configuration, +resource_tags, +applied_for, +custom_role_arn, +created_at, +updated_at +FROM aws.ecr.repository_creation_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new repository_creation_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.repository_creation_templates ( + Prefix, + AppliedFor, + region +) +SELECT +'{{ Prefix }}', + '{{ AppliedFor }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecr.repository_creation_templates ( + Prefix, + Description, + ImageTagMutability, + RepositoryPolicy, + LifecyclePolicy, + EncryptionConfiguration, + ResourceTags, + AppliedFor, + CustomRoleArn, + region +) +SELECT + '{{ Prefix }}', + '{{ Description }}', + '{{ ImageTagMutability }}', + '{{ RepositoryPolicy }}', + '{{ LifecyclePolicy }}', + '{{ EncryptionConfiguration }}', + '{{ ResourceTags }}', + '{{ AppliedFor }}', + '{{ CustomRoleArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: repository_creation_template + props: + - name: Prefix + value: '{{ Prefix }}' + - name: Description + value: '{{ Description }}' + - name: ImageTagMutability + value: '{{ ImageTagMutability }}' + - name: RepositoryPolicy + value: '{{ RepositoryPolicy }}' + - name: LifecyclePolicy + value: '{{ LifecyclePolicy }}' + - name: EncryptionConfiguration + value: + EncryptionType: '{{ EncryptionType }}' + KmsKey: '{{ KmsKey }}' + - name: ResourceTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AppliedFor + value: + - '{{ AppliedFor[0] }}' + - name: CustomRoleArn + value: '{{ CustomRoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ecr.repository_creation_templates +WHERE data__Identifier = '' +AND 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, +ecr:CreateRepository, +iam:CreateServiceLinkedRole, +iam:PassRole +``` + +### Read +```json +ecr:DescribeRepositoryCreationTemplates +``` + +### Update +```json +ecr:DescribeRepositoryCreationTemplates, +ecr:UpdateRepositoryCreationTemplate, +ecr:PutLifecyclePolicy, +ecr:SetRepositoryPolicy, +ecr:CreateRepository, +iam:CreateServiceLinkedRole, +iam:PassRole +``` + +### Delete +```json +ecr:DeleteRepositoryCreationTemplate +``` + +### List +```json +ecr:DescribeRepositoryCreationTemplates +``` diff --git a/website/docs/services/ecr/repository_creation_templates_list_only/index.md b/website/docs/services/ecr/repository_creation_templates_list_only/index.md new file mode 100644 index 0000000..b7285af --- /dev/null +++ b/website/docs/services/ecr/repository_creation_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: repository_creation_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - repository_creation_templates_list_only + - ecr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists repository_creation_templates in a region or regions, for all properties use repository_creation_templates + +## Overview + + + + + + + +
Namerepository_creation_templates_list_only
TypeResource
DescriptionAWS::ECR::RepositoryCreationTemplate is used to create repository with configuration from a pre-defined template.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe prefix use to match the repository name and apply the template.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all repository_creation_templates in a region. +```sql +SELECT +region, +prefix +FROM aws.ecr.repository_creation_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_creation_templates_list_only resource, see repository_creation_templates + diff --git a/website/docs/services/ecr/repository_tags/index.md b/website/docs/services/ecr/repository_tags/index.md new file mode 100644 index 0000000..c7bfee6 --- /dev/null +++ b/website/docs/services/ecr/repository_tags/index.md @@ -0,0 +1,93 @@ +--- +title: repository_tags +hide_title: false +hide_table_of_contents: false +keywords: + - repository_tags + - ecr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for repositories in a region + +## Overview + + + + + + + +
Namerepository_tags
TypeResource
DescriptionThe AWS::ECR::Repository resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIf true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.
objectCreates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).
stringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
objectThe JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.
string
string
stringThe tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
objectThe image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
objectThe encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all repositories in a region. +```sql +SELECT +region, +empty_on_delete, +lifecycle_policy, +repository_name, +repository_policy_text, +arn, +repository_uri, +image_tag_mutability, +image_scanning_configuration, +encryption_configuration, +tag_key, +tag_value +FROM aws.ecr.repository_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_tags resource, see repositories + diff --git a/website/docs/services/ecs/cluster_capacity_provider_associations/index.md b/website/docs/services/ecs/cluster_capacity_provider_associations/index.md new file mode 100644 index 0000000..9d5e352 --- /dev/null +++ b/website/docs/services/ecs/cluster_capacity_provider_associations/index.md @@ -0,0 +1,221 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster_capacity_provider_association resource or lists cluster_capacity_provider_associations in a region + +## Overview + + + + + + + +
Namecluster_capacity_provider_associations
TypeResource
DescriptionAssociate a set of ECS Capacity Providers with a specified ECS Cluster
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
arrayList of capacity providers to associate with the cluster
arrayList of capacity providers to associate with the cluster
stringThe name of the cluster
stringAWS region.
+ +For more information, see AWS::ECS::ClusterCapacityProviderAssociations. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cluster_capacity_provider_associations in a region. +```sql +SELECT +region, +default_capacity_provider_strategy, +capacity_providers, +cluster +FROM aws.ecs.cluster_capacity_provider_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster_capacity_provider_association. +```sql +SELECT +region, +default_capacity_provider_strategy, +capacity_providers, +cluster +FROM aws.ecs.cluster_capacity_provider_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster_capacity_provider_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecs.cluster_capacity_provider_associations ( + DefaultCapacityProviderStrategy, + CapacityProviders, + Cluster, + region +) +SELECT +'{{ DefaultCapacityProviderStrategy }}', + '{{ CapacityProviders }}', + '{{ Cluster }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecs.cluster_capacity_provider_associations ( + DefaultCapacityProviderStrategy, + CapacityProviders, + Cluster, + region +) +SELECT + '{{ DefaultCapacityProviderStrategy }}', + '{{ CapacityProviders }}', + '{{ Cluster }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster_capacity_provider_association + props: + - name: DefaultCapacityProviderStrategy + value: + - CapacityProvider: '{{ CapacityProvider }}' + Base: '{{ Base }}' + Weight: '{{ Weight }}' + - name: CapacityProviders + value: + - null + - name: Cluster + value: '{{ Cluster }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ecs.cluster_capacity_provider_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the cluster_capacity_provider_associations resource, the following permissions are required: + +### Read +```json +ecs:DescribeClusters +``` + +### Create +```json +ecs:DescribeClusters, +ecs:PutClusterCapacityProviders, +ecs:DescribeCapacityProviders +``` + +### Update +```json +ecs:DescribeClusters, +ecs:PutClusterCapacityProviders +``` + +### List +```json +ecs:DescribeClusters, +ecs:ListClusters +``` + +### Delete +```json +ecs:PutClusterCapacityProviders, +ecs:DescribeClusters +``` diff --git a/website/docs/services/ecs/cluster_capacity_provider_associations_list_only/index.md b/website/docs/services/ecs/cluster_capacity_provider_associations_list_only/index.md new file mode 100644 index 0000000..07f3951 --- /dev/null +++ b/website/docs/services/ecs/cluster_capacity_provider_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cluster_capacity_provider_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_capacity_provider_associations_list_only + - ecs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cluster_capacity_provider_associations in a region or regions, for all properties use cluster_capacity_provider_associations + +## Overview + + + + + + + +
Namecluster_capacity_provider_associations_list_only
TypeResource
DescriptionAssociate a set of ECS Capacity Providers with a specified ECS Cluster
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the cluster
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cluster_capacity_provider_associations in a region. +```sql +SELECT +region, +cluster +FROM aws.ecs.cluster_capacity_provider_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_capacity_provider_associations_list_only resource, see cluster_capacity_provider_associations + diff --git a/website/docs/services/ecs/index.md b/website/docs/services/ecs/index.md new file mode 100644 index 0000000..0a854fb --- /dev/null +++ b/website/docs/services/ecs/index.md @@ -0,0 +1,45 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The ecs service documentation. + +:::info Service Summary + +
+
+total resources: 10
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/ecs/primary_task_sets/index.md b/website/docs/services/ecs/primary_task_sets/index.md new file mode 100644 index 0000000..8baa475 --- /dev/null +++ b/website/docs/services/ecs/primary_task_sets/index.md @@ -0,0 +1,171 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a primary_task_set resource or lists primary_task_sets in a region + +## Overview + + + + + + + +
Nameprimary_task_sets
TypeResource
DescriptionA pseudo-resource that manages which of your ECS task sets is primary.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID or full Amazon Resource Name (ARN) of the task set.
stringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
stringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
stringAWS region.
+ +For more information, see AWS::ECS::PrimaryTaskSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual primary_task_set. +```sql +SELECT +region, +task_set_id, +cluster, +service +FROM aws.ecs.primary_task_sets +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new primary_task_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecs.primary_task_sets ( + TaskSetId, + Cluster, + Service, + region +) +SELECT +'{{ TaskSetId }}', + '{{ Cluster }}', + '{{ Service }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecs.primary_task_sets ( + TaskSetId, + Cluster, + Service, + region +) +SELECT + '{{ TaskSetId }}', + '{{ Cluster }}', + '{{ Service }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: primary_task_set + props: + - name: TaskSetId + value: '{{ TaskSetId }}' + - name: Cluster + value: '{{ Cluster }}' + - name: Service + value: '{{ Service }}' + +``` + + + +## Permissions + +To operate on the primary_task_sets resource, the following permissions are required: + +### Create +```json +ecs:DescribeTaskSets, +ecs:UpdateServicePrimaryTaskSet +``` + +### Update +```json +ecs:DescribeTaskSets, +ecs:UpdateServicePrimaryTaskSet +``` diff --git a/website/docs/services/ecs/service_tags/index.md b/website/docs/services/ecs/service_tags/index.md new file mode 100644 index 0000000..ed44562 --- /dev/null +++ b/website/docs/services/ecs/service_tags/index.md @@ -0,0 +1,127 @@ +--- +title: service_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_tags + - ecs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for services in a region + +## Overview + + + + + + + +
Nameservice_tags
TypeResource
DescriptionThe AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.
The stack update fails if you change any properties that require replacement and at least one ECS Service Connect ServiceConnectConfiguration property the is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceConnectService must have a name that is unique in the namespace.
Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.
stringSpecifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.
You must set this to a value other than NONE when you use Cost Explorer. For more information, see [Amazon ECS usage reports](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html) in the *Amazon Elastic Container Service Developer Guide*.
The default is NONE.
string
arrayThe placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
arrayThe details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
arrayThe 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.
arrayThe capacity provider strategy to use for the service.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
A capacity provider strategy can contain a maximum of 20 capacity providers.
stringThe launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
string
stringIndicates whether to use Availability Zone rebalancing for the service.
For more information, see [Balancing an Amazon ECS service across Availability Zones](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).
There are two service scheduler strategies available:
+ REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.
+ DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
objectThe 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*.
integerThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0 is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to 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.
booleanSpecifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.
When you use Amazon ECS managed tags, you need to set the propagateTags request parameter.
booleanDetermines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.
arrayAn array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
stringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
arrayA list of load balancer objects to associate with the service. If you specify the Role property, LoadBalancers must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.
objectThe configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
integerThe number of instantiations of the specified task definition to place and keep running in your service.
For new services, if a desired count is not specified, a default value of 1 is used. When using the DAEMON scheduling strategy, the desired count is not required.
For existing services, if a desired count is not specified, it is omitted from the operation.
arrayThe VPC Lattice configuration for the service being created.
objectThe deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.
stringThe name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.
stringThe family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.
For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).
stringThe name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
The stack update fails if you change any properties that require replacement and the ServiceName is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceName must be unique in the cluster.
objectOptional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all services in a region. +```sql +SELECT +region, +platform_version, +propagate_tags, +service_arn, +placement_strategies, +service_registries, +volume_configurations, +capacity_provider_strategy, +launch_type, +name, +availability_zone_rebalancing, +scheduling_strategy, +network_configuration, +health_check_grace_period_seconds, +enable_ecs_managed_tags, +enable_execute_command, +placement_constraints, +cluster, +load_balancers, +service_connect_configuration, +desired_count, +vpc_lattice_configurations, +deployment_controller, +role, +task_definition, +service_name, +deployment_configuration, +tag_key, +tag_value +FROM aws.ecs.service_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_tags resource, see services + diff --git a/website/docs/services/ecs/services/index.md b/website/docs/services/ecs/services/index.md new file mode 100644 index 0000000..d05908c --- /dev/null +++ b/website/docs/services/ecs/services/index.md @@ -0,0 +1,501 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service resource or lists 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.
The stack update fails if you change any properties that require replacement and at least one ECS Service Connect ServiceConnectConfiguration property the is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceConnectService must have a name that is unique in the namespace.
Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.
stringSpecifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.
You must set this to a value other than NONE when you use Cost Explorer. For more information, see [Amazon ECS usage reports](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html) in the *Amazon Elastic Container Service Developer Guide*.
The default is NONE.
string
arrayThe placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
arrayThe details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
arrayThe 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.
arrayThe capacity provider strategy to use for the service.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
A capacity provider strategy can contain a maximum of 20 capacity providers.
stringThe launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
string
stringIndicates whether to use Availability Zone rebalancing for the service.
For more information, see [Balancing an Amazon ECS service across Availability Zones](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).
There are two service scheduler strategies available:
+ REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.
+ DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
objectThe 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*.
arrayThe metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
+ Maximum number of tags per resource - 50
+ For each resource, each tag key must be unique, and each tag key can have only one value.
+ Maximum key length - 128 Unicode characters in UTF-8
+ Maximum value length - 256 Unicode characters in UTF-8
+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ Tag keys and values are case-sensitive.
+ Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
integerThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0 is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to 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.
booleanSpecifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.
When you use Amazon ECS managed tags, you need to set the propagateTags request parameter.
booleanDetermines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.
arrayAn array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
stringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
arrayA list of load balancer objects to associate with the service. If you specify the Role property, LoadBalancers must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.
objectThe configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
integerThe number of instantiations of the specified task definition to place and keep running in your service.
For new services, if a desired count is not specified, a default value of 1 is used. When using the DAEMON scheduling strategy, the desired count is not required.
For existing services, if a desired count is not specified, it is omitted from the operation.
arrayThe VPC Lattice configuration for the service being created.
objectThe deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.
stringThe name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.
stringThe family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.
For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).
stringThe name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
The stack update fails if you change any properties that require replacement and the ServiceName is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceName must be unique in the cluster.
objectOptional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
stringAWS region.
+ +For more information, see AWS::ECS::Service. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all services in a region. +```sql +SELECT +region, +platform_version, +propagate_tags, +service_arn, +placement_strategies, +service_registries, +volume_configurations, +capacity_provider_strategy, +launch_type, +name, +availability_zone_rebalancing, +scheduling_strategy, +network_configuration, +tags, +health_check_grace_period_seconds, +enable_ecs_managed_tags, +enable_execute_command, +placement_constraints, +cluster, +load_balancers, +service_connect_configuration, +desired_count, +vpc_lattice_configurations, +deployment_controller, +role, +task_definition, +service_name, +deployment_configuration +FROM aws.ecs.services +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service. +```sql +SELECT +region, +platform_version, +propagate_tags, +service_arn, +placement_strategies, +service_registries, +volume_configurations, +capacity_provider_strategy, +launch_type, +name, +availability_zone_rebalancing, +scheduling_strategy, +network_configuration, +tags, +health_check_grace_period_seconds, +enable_ecs_managed_tags, +enable_execute_command, +placement_constraints, +cluster, +load_balancers, +service_connect_configuration, +desired_count, +vpc_lattice_configurations, +deployment_controller, +role, +task_definition, +service_name, +deployment_configuration +FROM aws.ecs.services +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecs.services ( + PlatformVersion, + PropagateTags, + PlacementStrategies, + ServiceRegistries, + VolumeConfigurations, + CapacityProviderStrategy, + LaunchType, + AvailabilityZoneRebalancing, + SchedulingStrategy, + NetworkConfiguration, + Tags, + HealthCheckGracePeriodSeconds, + EnableECSManagedTags, + EnableExecuteCommand, + PlacementConstraints, + Cluster, + LoadBalancers, + ServiceConnectConfiguration, + DesiredCount, + VpcLatticeConfigurations, + DeploymentController, + Role, + TaskDefinition, + ServiceName, + DeploymentConfiguration, + region +) +SELECT +'{{ PlatformVersion }}', + '{{ PropagateTags }}', + '{{ PlacementStrategies }}', + '{{ ServiceRegistries }}', + '{{ VolumeConfigurations }}', + '{{ CapacityProviderStrategy }}', + '{{ LaunchType }}', + '{{ AvailabilityZoneRebalancing }}', + '{{ SchedulingStrategy }}', + '{{ NetworkConfiguration }}', + '{{ Tags }}', + '{{ HealthCheckGracePeriodSeconds }}', + '{{ EnableECSManagedTags }}', + '{{ EnableExecuteCommand }}', + '{{ PlacementConstraints }}', + '{{ Cluster }}', + '{{ LoadBalancers }}', + '{{ ServiceConnectConfiguration }}', + '{{ DesiredCount }}', + '{{ VpcLatticeConfigurations }}', + '{{ DeploymentController }}', + '{{ Role }}', + '{{ TaskDefinition }}', + '{{ ServiceName }}', + '{{ DeploymentConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecs.services ( + PlatformVersion, + PropagateTags, + PlacementStrategies, + ServiceRegistries, + VolumeConfigurations, + CapacityProviderStrategy, + LaunchType, + AvailabilityZoneRebalancing, + SchedulingStrategy, + NetworkConfiguration, + Tags, + HealthCheckGracePeriodSeconds, + EnableECSManagedTags, + EnableExecuteCommand, + PlacementConstraints, + Cluster, + LoadBalancers, + ServiceConnectConfiguration, + DesiredCount, + VpcLatticeConfigurations, + DeploymentController, + Role, + TaskDefinition, + ServiceName, + DeploymentConfiguration, + region +) +SELECT + '{{ PlatformVersion }}', + '{{ PropagateTags }}', + '{{ PlacementStrategies }}', + '{{ ServiceRegistries }}', + '{{ VolumeConfigurations }}', + '{{ CapacityProviderStrategy }}', + '{{ LaunchType }}', + '{{ AvailabilityZoneRebalancing }}', + '{{ SchedulingStrategy }}', + '{{ NetworkConfiguration }}', + '{{ Tags }}', + '{{ HealthCheckGracePeriodSeconds }}', + '{{ EnableECSManagedTags }}', + '{{ EnableExecuteCommand }}', + '{{ PlacementConstraints }}', + '{{ Cluster }}', + '{{ LoadBalancers }}', + '{{ ServiceConnectConfiguration }}', + '{{ DesiredCount }}', + '{{ VpcLatticeConfigurations }}', + '{{ DeploymentController }}', + '{{ Role }}', + '{{ TaskDefinition }}', + '{{ ServiceName }}', + '{{ DeploymentConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service + props: + - name: PlatformVersion + value: '{{ PlatformVersion }}' + - name: PropagateTags + value: '{{ PropagateTags }}' + - name: PlacementStrategies + value: + - Field: '{{ Field }}' + Type: '{{ Type }}' + - name: ServiceRegistries + value: + - ContainerName: '{{ ContainerName }}' + Port: '{{ Port }}' + ContainerPort: '{{ ContainerPort }}' + RegistryArn: '{{ RegistryArn }}' + - name: VolumeConfigurations + value: + - ManagedEBSVolume: + SnapshotId: '{{ SnapshotId }}' + VolumeType: '{{ VolumeType }}' + KmsKeyId: '{{ KmsKeyId }}' + TagSpecifications: + - PropagateTags: '{{ PropagateTags }}' + ResourceType: '{{ ResourceType }}' + Tags: + - Value: '{{ Value }}' + Key: '{{ Key }}' + FilesystemType: '{{ FilesystemType }}' + Encrypted: '{{ Encrypted }}' + Throughput: '{{ Throughput }}' + Iops: '{{ Iops }}' + SizeInGiB: '{{ SizeInGiB }}' + RoleArn: '{{ RoleArn }}' + Name: '{{ Name }}' + - name: CapacityProviderStrategy + value: + - CapacityProvider: '{{ CapacityProvider }}' + Base: '{{ Base }}' + Weight: '{{ Weight }}' + - name: LaunchType + value: '{{ LaunchType }}' + - name: AvailabilityZoneRebalancing + value: '{{ AvailabilityZoneRebalancing }}' + - name: SchedulingStrategy + value: '{{ SchedulingStrategy }}' + - name: NetworkConfiguration + value: + AwsVpcConfiguration: + SecurityGroups: + - '{{ SecurityGroups[0] }}' + Subnets: + - '{{ Subnets[0] }}' + AssignPublicIp: '{{ AssignPublicIp }}' + - name: Tags + value: + - null + - name: HealthCheckGracePeriodSeconds + value: '{{ HealthCheckGracePeriodSeconds }}' + - name: EnableECSManagedTags + value: '{{ EnableECSManagedTags }}' + - name: EnableExecuteCommand + value: '{{ EnableExecuteCommand }}' + - name: PlacementConstraints + value: + - Type: '{{ Type }}' + Expression: '{{ Expression }}' + - name: Cluster + value: '{{ Cluster }}' + - name: LoadBalancers + value: + - TargetGroupArn: '{{ TargetGroupArn }}' + ContainerName: '{{ ContainerName }}' + ContainerPort: '{{ ContainerPort }}' + - name: ServiceConnectConfiguration + value: + Services: + - Timeout: + PerRequestTimeoutSeconds: '{{ PerRequestTimeoutSeconds }}' + IdleTimeoutSeconds: '{{ IdleTimeoutSeconds }}' + IngressPortOverride: '{{ IngressPortOverride }}' + ClientAliases: + - DnsName: '{{ DnsName }}' + Port: '{{ Port }}' + Tls: + IssuerCertificateAuthority: + AwsPcaAuthorityArn: '{{ AwsPcaAuthorityArn }}' + KmsKey: '{{ KmsKey }}' + RoleArn: '{{ RoleArn }}' + DiscoveryName: '{{ DiscoveryName }}' + PortName: '{{ PortName }}' + Enabled: '{{ Enabled }}' + LogConfiguration: + SecretOptions: + - ValueFrom: '{{ ValueFrom }}' + Name: '{{ Name }}' + Options: {} + LogDriver: '{{ LogDriver }}' + Namespace: '{{ Namespace }}' + - name: DesiredCount + value: '{{ DesiredCount }}' + - name: VpcLatticeConfigurations + value: + - TargetGroupArn: '{{ TargetGroupArn }}' + PortName: '{{ PortName }}' + RoleArn: '{{ RoleArn }}' + - name: DeploymentController + value: + Type: '{{ Type }}' + - name: Role + value: '{{ Role }}' + - name: TaskDefinition + value: '{{ TaskDefinition }}' + - name: ServiceName + value: '{{ ServiceName }}' + - name: DeploymentConfiguration + value: + Alarms: + AlarmNames: + - '{{ AlarmNames[0] }}' + Enable: '{{ Enable }}' + Rollback: '{{ Rollback }}' + DeploymentCircuitBreaker: + Enable: '{{ Enable }}' + Rollback: '{{ Rollback }}' + MaximumPercent: '{{ MaximumPercent }}' + MinimumHealthyPercent: '{{ MinimumHealthyPercent }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ecs.services +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the services resource, the following permissions are required: + +### Read +```json +ecs:DescribeServices +``` + +### Create +```json +ecs:CreateService, +ecs:DescribeServices, +iam:PassRole, +ecs:TagResource +``` + +### Update +```json +ecs:DescribeServices, +ecs:ListTagsForResource, +ecs:TagResource, +ecs:UntagResource, +ecs:UpdateService +``` + +### List +```json +ecs:DescribeServices, +ecs:ListClusters, +ecs:ListServices +``` + +### Delete +```json +ecs:DeleteService, +ecs:DescribeServices +``` diff --git a/website/docs/services/ecs/services_list_only/index.md b/website/docs/services/ecs/services_list_only/index.md new file mode 100644 index 0000000..3723354 --- /dev/null +++ b/website/docs/services/ecs/services_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: services_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - services_list_only + - ecs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists services in a region or regions, for all properties use services + +## Overview + + + + + + + +
Nameservices_list_only
TypeResource
DescriptionThe AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.
The stack update fails if you change any properties that require replacement and at least one ECS Service Connect ServiceConnectConfiguration property the is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceConnectService must have a name that is unique in the namespace.
Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all services in a region. +```sql +SELECT +region, +service_arn, +cluster +FROM aws.ecs.services_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the services_list_only resource, see services + diff --git a/website/docs/services/ecs/task_definition_tags/index.md b/website/docs/services/ecs/task_definition_tags/index.md new file mode 100644 index 0000000..5e77d82 --- /dev/null +++ b/website/docs/services/ecs/task_definition_tags/index.md @@ -0,0 +1,111 @@ +--- +title: task_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - task_definition_tags + - ecs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for task_definitions in a region + +## Overview + + + + + + + +
Nametask_definition_tags
TypeResource
DescriptionRegisters a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.
You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*.
String validation is done on the ECS side. If an invalid string value is given for TaskRoleArn, it may cause the Cloudformation job to hang.
stringThe IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.
+ For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
+ For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

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

This parameter is not supported for Windows containers or tasks run on FARGATElong.
arrayThe Elastic Inference accelerators to use for the containers in the task.
stringThe amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).
If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the cpu parameter.
+ 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
+ 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
+ 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
+ Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
+ Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
+ Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
+ Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
arrayAn array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on FARGATElong.
stringThe number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.
If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
+ 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
+ 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
+ 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
+ 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
+ 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
+ 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
+ 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
arrayThe task launch types the task definition was validated against. The valid values are EC2, FARGATE, and EXTERNAL. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
stringThe process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.
If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
booleanEnables fault injection and allows for fault injection requests to be accepted from the task's containers. The default value is false.
stringThe Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.
objectThe operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
objectThe configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayThe list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
The host and sourcePath parameters aren't supported for tasks run on FARGATElong.
arrayA list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.
objectThe ephemeral storage settings to use for tasks run with the task definition.
arrayThe metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
The following basic restrictions apply to tags:
+ Maximum number of tags per resource - 50
+ For each resource, each tag key must be unique, and each tag key can have only one value.
+ Maximum key length - 128 Unicode characters in UTF-8
+ Maximum value length - 256 Unicode characters in UTF-8
+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ Tag keys and values are case-sensitive.
+ Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
string
stringAWS region.
+ +For more information, see AWS::ECS::TaskDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all task_definitions in a region. +```sql +SELECT +region, +task_role_arn, +ipc_mode, +inference_accelerators, +memory, +placement_constraints, +cpu, +requires_compatibilities, +network_mode, +pid_mode, +enable_fault_injection, +execution_role_arn, +runtime_platform, +proxy_configuration, +volumes, +container_definitions, +family, +ephemeral_storage, +tags, +task_definition_arn +FROM aws.ecs.task_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual task_definition. +```sql +SELECT +region, +task_role_arn, +ipc_mode, +inference_accelerators, +memory, +placement_constraints, +cpu, +requires_compatibilities, +network_mode, +pid_mode, +enable_fault_injection, +execution_role_arn, +runtime_platform, +proxy_configuration, +volumes, +container_definitions, +family, +ephemeral_storage, +tags, +task_definition_arn +FROM aws.ecs.task_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new task_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecs.task_definitions ( + TaskRoleArn, + IpcMode, + InferenceAccelerators, + Memory, + PlacementConstraints, + Cpu, + RequiresCompatibilities, + NetworkMode, + PidMode, + EnableFaultInjection, + ExecutionRoleArn, + RuntimePlatform, + ProxyConfiguration, + Volumes, + ContainerDefinitions, + Family, + EphemeralStorage, + Tags, + region +) +SELECT +'{{ TaskRoleArn }}', + '{{ IpcMode }}', + '{{ InferenceAccelerators }}', + '{{ Memory }}', + '{{ PlacementConstraints }}', + '{{ Cpu }}', + '{{ RequiresCompatibilities }}', + '{{ NetworkMode }}', + '{{ PidMode }}', + '{{ EnableFaultInjection }}', + '{{ ExecutionRoleArn }}', + '{{ RuntimePlatform }}', + '{{ ProxyConfiguration }}', + '{{ Volumes }}', + '{{ ContainerDefinitions }}', + '{{ Family }}', + '{{ EphemeralStorage }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecs.task_definitions ( + TaskRoleArn, + IpcMode, + InferenceAccelerators, + Memory, + PlacementConstraints, + Cpu, + RequiresCompatibilities, + NetworkMode, + PidMode, + EnableFaultInjection, + ExecutionRoleArn, + RuntimePlatform, + ProxyConfiguration, + Volumes, + ContainerDefinitions, + Family, + EphemeralStorage, + Tags, + region +) +SELECT + '{{ TaskRoleArn }}', + '{{ IpcMode }}', + '{{ InferenceAccelerators }}', + '{{ Memory }}', + '{{ PlacementConstraints }}', + '{{ Cpu }}', + '{{ RequiresCompatibilities }}', + '{{ NetworkMode }}', + '{{ PidMode }}', + '{{ EnableFaultInjection }}', + '{{ ExecutionRoleArn }}', + '{{ RuntimePlatform }}', + '{{ ProxyConfiguration }}', + '{{ Volumes }}', + '{{ ContainerDefinitions }}', + '{{ Family }}', + '{{ EphemeralStorage }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: task_definition + props: + - name: TaskRoleArn + value: '{{ TaskRoleArn }}' + - name: IpcMode + value: '{{ IpcMode }}' + - name: InferenceAccelerators + value: + - DeviceType: '{{ DeviceType }}' + DeviceName: '{{ DeviceName }}' + - name: Memory + value: '{{ Memory }}' + - name: PlacementConstraints + value: + - Type: '{{ Type }}' + Expression: '{{ Expression }}' + - name: Cpu + value: '{{ Cpu }}' + - name: RequiresCompatibilities + value: + - '{{ RequiresCompatibilities[0] }}' + - name: NetworkMode + value: '{{ NetworkMode }}' + - name: PidMode + value: '{{ PidMode }}' + - name: EnableFaultInjection + value: '{{ EnableFaultInjection }}' + - name: ExecutionRoleArn + value: '{{ ExecutionRoleArn }}' + - name: RuntimePlatform + value: + OperatingSystemFamily: '{{ OperatingSystemFamily }}' + CpuArchitecture: '{{ CpuArchitecture }}' + - name: ProxyConfiguration + value: + ProxyConfigurationProperties: + - Value: '{{ Value }}' + Name: '{{ Name }}' + Type: '{{ Type }}' + ContainerName: '{{ ContainerName }}' + - name: Volumes + value: + - EFSVolumeConfiguration: + FilesystemId: '{{ FilesystemId }}' + TransitEncryption: '{{ TransitEncryption }}' + AuthorizationConfig: + IAM: '{{ IAM }}' + AccessPointId: '{{ AccessPointId }}' + RootDirectory: '{{ RootDirectory }}' + TransitEncryptionPort: '{{ TransitEncryptionPort }}' + Host: + SourcePath: '{{ SourcePath }}' + ConfiguredAtLaunch: '{{ ConfiguredAtLaunch }}' + DockerVolumeConfiguration: + DriverOpts: {} + Scope: '{{ Scope }}' + Autoprovision: '{{ Autoprovision }}' + Driver: '{{ Driver }}' + Labels: {} + FSxWindowsFileServerVolumeConfiguration: + AuthorizationConfig: + CredentialsParameter: '{{ CredentialsParameter }}' + Domain: '{{ Domain }}' + FileSystemId: '{{ FileSystemId }}' + RootDirectory: '{{ RootDirectory }}' + Name: '{{ Name }}' + - name: ContainerDefinitions + value: + - User: '{{ User }}' + Secrets: + - ValueFrom: '{{ ValueFrom }}' + Name: '{{ Name }}' + Memory: '{{ Memory }}' + Privileged: '{{ Privileged }}' + HealthCheck: + Command: + - '{{ Command[0] }}' + Timeout: '{{ Timeout }}' + Retries: '{{ Retries }}' + Interval: '{{ Interval }}' + StartPeriod: '{{ StartPeriod }}' + StartTimeout: '{{ StartTimeout }}' + VolumesFrom: + - ReadOnly: '{{ ReadOnly }}' + SourceContainer: '{{ SourceContainer }}' + Cpu: '{{ Cpu }}' + EntryPoint: + - '{{ EntryPoint[0] }}' + DnsServers: + - '{{ DnsServers[0] }}' + ReadonlyRootFilesystem: '{{ ReadonlyRootFilesystem }}' + Image: '{{ Image }}' + Essential: '{{ Essential }}' + LogConfiguration: + SecretOptions: + - null + Options: {} + LogDriver: '{{ LogDriver }}' + ResourceRequirements: + - Type: '{{ Type }}' + Value: '{{ Value }}' + EnvironmentFiles: + - Type: '{{ Type }}' + Value: '{{ Value }}' + Name: '{{ Name }}' + FirelensConfiguration: + Options: {} + Type: '{{ Type }}' + DockerSecurityOptions: + - '{{ DockerSecurityOptions[0] }}' + SystemControls: + - Value: '{{ Value }}' + Namespace: '{{ Namespace }}' + Interactive: '{{ Interactive }}' + DnsSearchDomains: + - '{{ DnsSearchDomains[0] }}' + CredentialSpecs: + - '{{ CredentialSpecs[0] }}' + Ulimits: + - SoftLimit: '{{ SoftLimit }}' + HardLimit: '{{ HardLimit }}' + Name: '{{ Name }}' + StopTimeout: '{{ StopTimeout }}' + WorkingDirectory: '{{ WorkingDirectory }}' + MemoryReservation: '{{ MemoryReservation }}' + RepositoryCredentials: + CredentialsParameter: '{{ CredentialsParameter }}' + ExtraHosts: + - Hostname: '{{ Hostname }}' + IpAddress: '{{ IpAddress }}' + Hostname: '{{ Hostname }}' + LinuxParameters: + Capabilities: + Add: + - '{{ Add[0] }}' + Drop: + - '{{ Drop[0] }}' + Swappiness: '{{ Swappiness }}' + Tmpfs: + - Size: '{{ Size }}' + ContainerPath: '{{ ContainerPath }}' + MountOptions: + - '{{ MountOptions[0] }}' + SharedMemorySize: '{{ SharedMemorySize }}' + Devices: + - HostPath: '{{ HostPath }}' + Permissions: + - '{{ Permissions[0] }}' + ContainerPath: '{{ ContainerPath }}' + InitProcessEnabled: '{{ InitProcessEnabled }}' + MaxSwap: '{{ MaxSwap }}' + VersionConsistency: '{{ VersionConsistency }}' + RestartPolicy: + IgnoredExitCodes: + - '{{ IgnoredExitCodes[0] }}' + RestartAttemptPeriod: '{{ RestartAttemptPeriod }}' + Enabled: '{{ Enabled }}' + DisableNetworking: '{{ DisableNetworking }}' + PseudoTerminal: '{{ PseudoTerminal }}' + MountPoints: + - ReadOnly: '{{ ReadOnly }}' + SourceVolume: '{{ SourceVolume }}' + ContainerPath: '{{ ContainerPath }}' + DependsOn: + - Condition: '{{ Condition }}' + ContainerName: '{{ ContainerName }}' + DockerLabels: {} + PortMappings: + - AppProtocol: '{{ AppProtocol }}' + ContainerPortRange: '{{ ContainerPortRange }}' + HostPort: '{{ HostPort }}' + ContainerPort: '{{ ContainerPort }}' + Protocol: '{{ Protocol }}' + Name: '{{ Name }}' + Command: + - '{{ Command[0] }}' + Environment: + - null + Links: + - '{{ Links[0] }}' + - name: Family + value: '{{ Family }}' + - name: EphemeralStorage + value: + SizeInGiB: '{{ SizeInGiB }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ecs.task_definitions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the task_definitions resource, the following permissions are required: + +### Read +```json +ecs:DescribeTaskDefinition +``` + +### Create +```json +ecs:RegisterTaskDefinition, +ecs:DescribeTaskDefinition, +ecs:TagResource, +iam:GetRole, +iam:PassRole +``` + +### Update +```json +ecs:TagResource, +ecs:UntagResource, +ecs:ListTagsForResource, +ecs:DescribeTaskDefinition, +iam:GetRole, +iam:PassRole +``` + +### List +```json +ecs:ListTaskDefinitions, +ecs:DescribeTaskDefinition +``` + +### Delete +```json +ecs:DeregisterTaskDefinition, +ecs:DescribeTaskDefinition, +iam:GetRole, +iam:PassRole +``` diff --git a/website/docs/services/ecs/task_definitions_list_only/index.md b/website/docs/services/ecs/task_definitions_list_only/index.md new file mode 100644 index 0000000..72ef9f2 --- /dev/null +++ b/website/docs/services/ecs/task_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: task_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - task_definitions_list_only + - ecs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists task_definitions in a region or regions, for all properties use task_definitions + +## Overview + + + + + + + +
Nametask_definitions_list_only
TypeResource
DescriptionRegisters a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.
You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all task_definitions in a region. +```sql +SELECT +region, +task_definition_arn +FROM aws.ecs.task_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_definitions_list_only resource, see task_definitions + diff --git a/website/docs/services/ecs/task_sets/index.md b/website/docs/services/ecs/task_sets/index.md new file mode 100644 index 0000000..1671a07 --- /dev/null +++ b/website/docs/services/ecs/task_sets/index.md @@ -0,0 +1,275 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a task_set resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe 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.
stringAn 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.
stringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
array
stringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
objectA floating-point percentage of the desired number of tasks to place and keep running in the task set.
arrayThe 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.
array
stringThe 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.
stringThe short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
objectAn object representing the network configuration for a task or service.
stringThe ID of the task set.
array
stringAWS region.
+ +For more information, see AWS::ECS::TaskSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual task_set. +```sql +SELECT +region, +platform_version, +external_id, +cluster, +load_balancers, +service, +scale, +service_registries, +capacity_provider_strategy, +launch_type, +task_definition, +network_configuration, +id, +tags +FROM aws.ecs.task_sets +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new task_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ecs.task_sets ( + Cluster, + Service, + TaskDefinition, + region +) +SELECT +'{{ Cluster }}', + '{{ Service }}', + '{{ TaskDefinition }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ecs.task_sets ( + PlatformVersion, + ExternalId, + Cluster, + LoadBalancers, + Service, + Scale, + ServiceRegistries, + CapacityProviderStrategy, + LaunchType, + TaskDefinition, + NetworkConfiguration, + Tags, + region +) +SELECT + '{{ PlatformVersion }}', + '{{ ExternalId }}', + '{{ Cluster }}', + '{{ LoadBalancers }}', + '{{ Service }}', + '{{ Scale }}', + '{{ ServiceRegistries }}', + '{{ CapacityProviderStrategy }}', + '{{ LaunchType }}', + '{{ TaskDefinition }}', + '{{ NetworkConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: task_set + props: + - name: PlatformVersion + value: '{{ PlatformVersion }}' + - name: ExternalId + value: '{{ ExternalId }}' + - name: Cluster + value: '{{ Cluster }}' + - name: LoadBalancers + value: + - TargetGroupArn: '{{ TargetGroupArn }}' + ContainerName: '{{ ContainerName }}' + ContainerPort: '{{ ContainerPort }}' + - name: Service + value: '{{ Service }}' + - name: Scale + value: + Value: null + Unit: '{{ Unit }}' + - name: ServiceRegistries + value: + - ContainerName: '{{ ContainerName }}' + Port: '{{ Port }}' + ContainerPort: '{{ ContainerPort }}' + RegistryArn: '{{ RegistryArn }}' + - name: CapacityProviderStrategy + value: + - CapacityProvider: '{{ CapacityProvider }}' + Base: '{{ Base }}' + Weight: '{{ Weight }}' + - name: LaunchType + value: '{{ LaunchType }}' + - name: TaskDefinition + value: '{{ TaskDefinition }}' + - name: NetworkConfiguration + value: + AwsVpcConfiguration: + SecurityGroups: + - '{{ SecurityGroups[0] }}' + Subnets: + - '{{ Subnets[0] }}' + AssignPublicIp: '{{ AssignPublicIp }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ecs.task_sets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the task_sets resource, the following permissions are required: + +### Read +```json +ecs:DescribeTaskSets +``` + +### Create +```json +ecs:CreateTaskSet, +ecs:DescribeTaskSets, +ecs:TagResource +``` + +### Update +```json +ecs:DescribeTaskSets, +ecs:TagResource, +ecs:UntagResource, +ecs:UpdateTaskSet +``` + +### Delete +```json +ecs:DeleteTaskSet, +ecs:DescribeTaskSets +``` diff --git a/website/docs/services/efs/access_points/index.md b/website/docs/services/efs/access_points/index.md new file mode 100644 index 0000000..3a7b436 --- /dev/null +++ b/website/docs/services/efs/access_points/index.md @@ -0,0 +1,245 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_point resource or lists 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).
This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe opaque string specified in the request to ensure idempotent creation.
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringThe ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2.
objectThe full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
objectThe directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
stringAWS region.
+ +For more information, see AWS::EFS::AccessPoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_points in a region. +```sql +SELECT +region, +access_point_id, +arn, +client_token, +access_point_tags, +file_system_id, +posix_user, +root_directory +FROM aws.efs.access_points +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_point. +```sql +SELECT +region, +access_point_id, +arn, +client_token, +access_point_tags, +file_system_id, +posix_user, +root_directory +FROM aws.efs.access_points +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.efs.access_points ( + FileSystemId, + region +) +SELECT +'{{ FileSystemId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.efs.access_points ( + ClientToken, + AccessPointTags, + FileSystemId, + PosixUser, + RootDirectory, + region +) +SELECT + '{{ ClientToken }}', + '{{ AccessPointTags }}', + '{{ FileSystemId }}', + '{{ PosixUser }}', + '{{ RootDirectory }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_point + props: + - name: ClientToken + value: '{{ ClientToken }}' + - name: AccessPointTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: FileSystemId + value: '{{ FileSystemId }}' + - name: PosixUser + value: + Uid: '{{ Uid }}' + Gid: '{{ Gid }}' + SecondaryGids: + - '{{ SecondaryGids[0] }}' + - name: RootDirectory + value: + Path: '{{ Path }}' + CreationInfo: + OwnerUid: '{{ OwnerUid }}' + OwnerGid: '{{ OwnerGid }}' + Permissions: '{{ Permissions }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.efs.access_points +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +elasticfilesystem:DescribeAccessPoints +``` + +### Delete +```json +elasticfilesystem:DeleteAccessPoint, +elasticfilesystem:DescribeAccessPoints +``` + +### List +```json +elasticfilesystem:DescribeAccessPoints +``` + +### Update +```json +elasticfilesystem:DescribeAccessPoints, +elasticfilesystem:ListTagsForResource, +elasticfilesystem:TagResource, +elasticfilesystem:UntagResource +``` diff --git a/website/docs/services/efs/access_points_list_only/index.md b/website/docs/services/efs/access_points_list_only/index.md new file mode 100644 index 0000000..6f68503 --- /dev/null +++ b/website/docs/services/efs/access_points_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_points_list_only + - efs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_points in a region or regions, for all properties use access_points + +## Overview + + + + + + + +
Nameaccess_points_list_only
TypeResource
DescriptionThe AWS::EFS::AccessPoint resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).
This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_points in a region. +```sql +SELECT +region, +access_point_id +FROM aws.efs.access_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_points_list_only resource, see access_points + diff --git a/website/docs/services/efs/file_systems/index.md b/website/docs/services/efs/file_systems/index.md new file mode 100644 index 0000000..1105dad --- /dev/null +++ b/website/docs/services/efs/file_systems/index.md @@ -0,0 +1,368 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a file_system resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
booleanA Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
arrayUse to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
stringThe ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:
+ Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.
+ ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
+ Key alias - A previously created display name for a key, for example alias/projectKey1.
+ Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

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

EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA, TransitionToArchive TransitionToPrimaryStorageClass. See the example requests in the following section for more information.
objectDescribes the protection on the file system.
stringThe performance mode of the file system. We recommend generalPurpose performance mode for all file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The maxIO mode is not supported on One Zone file systems.
Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
Default is generalPurpose.
numberThe throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ThroughputMode is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.
stringSpecifies the throughput mode for the file system. The mode can be bursting, provisioned, or elastic. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*.
Default is bursting.
objectThe FileSystemPolicy for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.
boolean(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False.
objectUse the BackupPolicy to turn automatic backups on or off for the file system.
stringFor One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format us-east-1a to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*.
One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
objectDescribes the replication configuration for a specific file system.
stringAWS region.
+ +For more information, see AWS::EFS::FileSystem. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all file_systems in a region. +```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_systems +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual file_system. +```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_systems +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new file_system resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.efs.file_systems ( + Encrypted, + FileSystemTags, + KmsKeyId, + LifecyclePolicies, + FileSystemProtection, + PerformanceMode, + ProvisionedThroughputInMibps, + ThroughputMode, + FileSystemPolicy, + BypassPolicyLockoutSafetyCheck, + BackupPolicy, + AvailabilityZoneName, + ReplicationConfiguration, + region +) +SELECT +'{{ Encrypted }}', + '{{ FileSystemTags }}', + '{{ KmsKeyId }}', + '{{ LifecyclePolicies }}', + '{{ FileSystemProtection }}', + '{{ PerformanceMode }}', + '{{ ProvisionedThroughputInMibps }}', + '{{ ThroughputMode }}', + '{{ FileSystemPolicy }}', + '{{ BypassPolicyLockoutSafetyCheck }}', + '{{ BackupPolicy }}', + '{{ AvailabilityZoneName }}', + '{{ ReplicationConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.efs.file_systems ( + Encrypted, + FileSystemTags, + KmsKeyId, + LifecyclePolicies, + FileSystemProtection, + PerformanceMode, + ProvisionedThroughputInMibps, + ThroughputMode, + FileSystemPolicy, + BypassPolicyLockoutSafetyCheck, + BackupPolicy, + AvailabilityZoneName, + ReplicationConfiguration, + region +) +SELECT + '{{ Encrypted }}', + '{{ FileSystemTags }}', + '{{ KmsKeyId }}', + '{{ LifecyclePolicies }}', + '{{ FileSystemProtection }}', + '{{ PerformanceMode }}', + '{{ ProvisionedThroughputInMibps }}', + '{{ ThroughputMode }}', + '{{ FileSystemPolicy }}', + '{{ BypassPolicyLockoutSafetyCheck }}', + '{{ BackupPolicy }}', + '{{ AvailabilityZoneName }}', + '{{ ReplicationConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: file_system + props: + - name: Encrypted + value: '{{ Encrypted }}' + - name: FileSystemTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: LifecyclePolicies + value: + - TransitionToIA: '{{ TransitionToIA }}' + TransitionToPrimaryStorageClass: '{{ TransitionToPrimaryStorageClass }}' + TransitionToArchive: '{{ TransitionToArchive }}' + - name: FileSystemProtection + value: + ReplicationOverwriteProtection: '{{ ReplicationOverwriteProtection }}' + - name: PerformanceMode + value: '{{ PerformanceMode }}' + - name: ProvisionedThroughputInMibps + value: null + - name: ThroughputMode + value: '{{ ThroughputMode }}' + - name: FileSystemPolicy + value: {} + - name: BypassPolicyLockoutSafetyCheck + value: '{{ BypassPolicyLockoutSafetyCheck }}' + - name: BackupPolicy + value: + Status: '{{ Status }}' + - name: AvailabilityZoneName + value: '{{ AvailabilityZoneName }}' + - name: ReplicationConfiguration + value: + Destinations: + - Status: '{{ Status }}' + StatusMessage: '{{ StatusMessage }}' + FileSystemId: '{{ FileSystemId }}' + Region: '{{ Region }}' + RoleArn: '{{ RoleArn }}' + AvailabilityZoneName: '{{ AvailabilityZoneName }}' + KmsKeyId: '{{ KmsKeyId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.efs.file_systems +WHERE data__Identifier = '' +AND 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, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### 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, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +elasticfilesystem:DescribeFileSystems, +elasticfilesystem:DeleteFileSystem, +elasticfilesystem:DeleteReplicationConfiguration, +elasticfilesystem:DescribeReplicationConfigurations +``` + +### List +```json +elasticfilesystem:DescribeBackupPolicy, +elasticfilesystem:DescribeFileSystemPolicy, +elasticfilesystem:DescribeFileSystems, +elasticfilesystem:DescribeLifecycleConfiguration, +elasticfilesystem:DescribeReplicationConfigurations +``` diff --git a/website/docs/services/efs/file_systems_list_only/index.md b/website/docs/services/efs/file_systems_list_only/index.md new file mode 100644 index 0000000..6604b4b --- /dev/null +++ b/website/docs/services/efs/file_systems_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: file_systems_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - file_systems_list_only + - efs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists file_systems in a region or regions, for all properties use file_systems + +## Overview + + + + + + + +
Namefile_systems_list_only
TypeResource
DescriptionThe AWS::EFS::FileSystem resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all file_systems in a region. +```sql +SELECT +region, +file_system_id +FROM aws.efs.file_systems_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the file_systems_list_only resource, see file_systems + diff --git a/website/docs/services/efs/index.md b/website/docs/services/efs/index.md new file mode 100644 index 0000000..4f77002 --- /dev/null +++ b/website/docs/services/efs/index.md @@ -0,0 +1,41 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The efs service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/efs/mount_targets/index.md b/website/docs/services/efs/mount_targets/index.md new file mode 100644 index 0000000..e7eb49a --- /dev/null +++ b/website/docs/services/efs/mount_targets/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mount_target resource or lists 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.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringValid IPv4 address within the address range of the specified subnet.
stringThe ID of the file system for which to create the mount target.
arrayUp to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified.
stringThe ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.
stringAWS region.
+ +For more information, see AWS::EFS::MountTarget. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mount_targets in a region. +```sql +SELECT +region, +id, +ip_address, +file_system_id, +security_groups, +subnet_id +FROM aws.efs.mount_targets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mount_target. +```sql +SELECT +region, +id, +ip_address, +file_system_id, +security_groups, +subnet_id +FROM aws.efs.mount_targets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mount_target resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.efs.mount_targets ( + FileSystemId, + SecurityGroups, + SubnetId, + region +) +SELECT +'{{ FileSystemId }}', + '{{ SecurityGroups }}', + '{{ SubnetId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.efs.mount_targets ( + IpAddress, + FileSystemId, + SecurityGroups, + SubnetId, + region +) +SELECT + '{{ IpAddress }}', + '{{ FileSystemId }}', + '{{ SecurityGroups }}', + '{{ SubnetId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mount_target + props: + - name: IpAddress + value: '{{ IpAddress }}' + - name: FileSystemId + value: '{{ FileSystemId }}' + - name: SecurityGroups + value: + - '{{ SecurityGroups[0] }}' + - name: SubnetId + value: '{{ SubnetId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.efs.mount_targets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the mount_targets resource, the following permissions are required: + +### Create +```json +elasticfilesystem:CreateMountTarget, +elasticfilesystem:DescribeMountTargets +``` + +### Read +```json +elasticfilesystem:DescribeMountTargets, +elasticfilesystem:DescribeMountTargetSecurityGroups +``` + +### Update +```json +elasticfilesystem:DescribeMountTargets, +elasticfilesystem:DescribeMountTargetSecurityGroups, +elasticfilesystem:ModifyMountTargetSecurityGroups +``` + +### Delete +```json +elasticfilesystem:DescribeMountTargets, +elasticfilesystem:DeleteMountTarget +``` + +### List +```json +elasticfilesystem:DescribeMountTargets, +elasticfilesystem:DescribeMountTargetSecurityGroups +``` diff --git a/website/docs/services/efs/mount_targets_list_only/index.md b/website/docs/services/efs/mount_targets_list_only/index.md new file mode 100644 index 0000000..7cbe2be --- /dev/null +++ b/website/docs/services/efs/mount_targets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: mount_targets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mount_targets_list_only + - efs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mount_targets in a region or regions, for all properties use mount_targets + +## Overview + + + + + + + +
Namemount_targets_list_only
TypeResource
DescriptionThe AWS::EFS::MountTarget resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mount_targets in a region. +```sql +SELECT +region, +id +FROM aws.efs.mount_targets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mount_targets_list_only resource, see mount_targets + diff --git a/website/docs/services/eks/access_entries/index.md b/website/docs/services/eks/access_entries/index.md new file mode 100644 index 0000000..dda2e60 --- /dev/null +++ b/website/docs/services/eks/access_entries/index.md @@ -0,0 +1,261 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_entry resource or lists access_entries in a region + +## Overview + + + + + + + +
Nameaccess_entries
TypeResource
DescriptionAn object representing an Amazon EKS AccessEntry.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe cluster that the access entry is created for.
stringThe principal ARN that the access entry is created for.
stringThe Kubernetes user that the access entry is associated with.
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the access entry.
arrayThe Kubernetes groups that the access entry is associated with.
arrayAn array of access policies that are associated with the access entry.
stringThe node type to associate with the access entry.
stringAWS region.
+ +For more information, see AWS::EKS::AccessEntry. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_entries in a region. +```sql +SELECT +region, +cluster_name, +principal_arn, +username, +tags, +access_entry_arn, +kubernetes_groups, +access_policies, +type +FROM aws.eks.access_entries +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_entry. +```sql +SELECT +region, +cluster_name, +principal_arn, +username, +tags, +access_entry_arn, +kubernetes_groups, +access_policies, +type +FROM aws.eks.access_entries +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_entry resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eks.access_entries ( + ClusterName, + PrincipalArn, + region +) +SELECT +'{{ ClusterName }}', + '{{ PrincipalArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eks.access_entries ( + ClusterName, + PrincipalArn, + Username, + Tags, + KubernetesGroups, + AccessPolicies, + Type, + region +) +SELECT + '{{ ClusterName }}', + '{{ PrincipalArn }}', + '{{ Username }}', + '{{ Tags }}', + '{{ KubernetesGroups }}', + '{{ AccessPolicies }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_entry + props: + - name: ClusterName + value: '{{ ClusterName }}' + - name: PrincipalArn + value: '{{ PrincipalArn }}' + - name: Username + value: '{{ Username }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: KubernetesGroups + value: + - '{{ KubernetesGroups[0] }}' + - name: AccessPolicies + value: + - PolicyArn: '{{ PolicyArn }}' + AccessScope: + Type: '{{ Type }}' + Namespaces: + - '{{ Namespaces[0] }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eks.access_entries +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +eks:ListAccessEntries +``` diff --git a/website/docs/services/eks/access_entries_list_only/index.md b/website/docs/services/eks/access_entries_list_only/index.md new file mode 100644 index 0000000..2147876 --- /dev/null +++ b/website/docs/services/eks/access_entries_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: access_entries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_entries_list_only + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_entries in a region or regions, for all properties use access_entries + +## Overview + + + + + + + +
Nameaccess_entries_list_only
TypeResource
DescriptionAn object representing an Amazon EKS AccessEntry.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe cluster that the access entry is created for.
stringThe principal ARN that the access entry is created for.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_entries in a region. +```sql +SELECT +region, +principal_arn, +cluster_name +FROM aws.eks.access_entries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_entries_list_only resource, see access_entries + diff --git a/website/docs/services/eks/access_entry_tags/index.md b/website/docs/services/eks/access_entry_tags/index.md new file mode 100644 index 0000000..902a82c --- /dev/null +++ b/website/docs/services/eks/access_entry_tags/index.md @@ -0,0 +1,89 @@ +--- +title: access_entry_tags +hide_title: false +hide_table_of_contents: false +keywords: + - access_entry_tags + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for access_entries in a region + +## Overview + + + + + + + +
Nameaccess_entry_tags
TypeResource
DescriptionAn object representing an Amazon EKS AccessEntry.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe cluster that the access entry is created for.
stringThe principal ARN that the access entry is created for.
stringThe Kubernetes user that the access entry is associated with.
stringThe ARN of the access entry.
arrayThe Kubernetes groups that the access entry is associated with.
arrayAn array of access policies that are associated with the access entry.
stringThe node type to associate with the access entry.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all access_entries in a region. +```sql +SELECT +region, +cluster_name, +principal_arn, +username, +access_entry_arn, +kubernetes_groups, +access_policies, +type, +tag_key, +tag_value +FROM aws.eks.access_entry_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_entry_tags resource, see access_entries + diff --git a/website/docs/services/eks/addon_tags/index.md b/website/docs/services/eks/addon_tags/index.md new file mode 100644 index 0000000..ae5f4d2 --- /dev/null +++ b/website/docs/services/eks/addon_tags/index.md @@ -0,0 +1,93 @@ +--- +title: addon_tags +hide_title: false +hide_table_of_contents: false +keywords: + - addon_tags + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for addons in a region + +## Overview + + + + + + + +
Nameaddon_tags
TypeResource
DescriptionResource Schema for AWS::EKS::Addon
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of Cluster
stringName of Addon
stringVersion of Addon
booleanPreserveOnDelete parameter value
stringResolve parameter value conflicts
stringIAM role to bind to the add-on's service account
arrayAn array of pod identities to apply to this add-on.
stringThe configuration values to use with the add-on
stringAmazon Resource Name (ARN) of the add-on
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all addons in a region. +```sql +SELECT +region, +cluster_name, +addon_name, +addon_version, +preserve_on_delete, +resolve_conflicts, +service_account_role_arn, +pod_identity_associations, +configuration_values, +arn, +tag_key, +tag_value +FROM aws.eks.addon_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the addon_tags resource, see addons + diff --git a/website/docs/services/eks/addons/index.md b/website/docs/services/eks/addons/index.md new file mode 100644 index 0000000..d6e4772 --- /dev/null +++ b/website/docs/services/eks/addons/index.md @@ -0,0 +1,279 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an addon resource or lists addons in a region + +## Overview + + + + + + + +
Nameaddons
TypeResource
DescriptionResource Schema for AWS::EKS::Addon
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of Cluster
stringName of Addon
stringVersion of Addon
booleanPreserveOnDelete parameter value
stringResolve parameter value conflicts
stringIAM role to bind to the add-on's service account
arrayAn array of pod identities to apply to this add-on.
stringThe configuration values to use with the add-on
stringAmazon Resource Name (ARN) of the add-on
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EKS::Addon. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all addons in a region. +```sql +SELECT +region, +cluster_name, +addon_name, +addon_version, +preserve_on_delete, +resolve_conflicts, +service_account_role_arn, +pod_identity_associations, +configuration_values, +arn, +tags +FROM aws.eks.addons +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual addon. +```sql +SELECT +region, +cluster_name, +addon_name, +addon_version, +preserve_on_delete, +resolve_conflicts, +service_account_role_arn, +pod_identity_associations, +configuration_values, +arn, +tags +FROM aws.eks.addons +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new addon resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eks.addons ( + ClusterName, + AddonName, + region +) +SELECT +'{{ ClusterName }}', + '{{ AddonName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eks.addons ( + ClusterName, + AddonName, + AddonVersion, + PreserveOnDelete, + ResolveConflicts, + ServiceAccountRoleArn, + PodIdentityAssociations, + ConfigurationValues, + Tags, + region +) +SELECT + '{{ ClusterName }}', + '{{ AddonName }}', + '{{ AddonVersion }}', + '{{ PreserveOnDelete }}', + '{{ ResolveConflicts }}', + '{{ ServiceAccountRoleArn }}', + '{{ PodIdentityAssociations }}', + '{{ ConfigurationValues }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: addon + props: + - name: ClusterName + value: '{{ ClusterName }}' + - name: AddonName + value: '{{ AddonName }}' + - name: AddonVersion + value: '{{ AddonVersion }}' + - name: PreserveOnDelete + value: '{{ PreserveOnDelete }}' + - name: ResolveConflicts + value: '{{ ResolveConflicts }}' + - name: ServiceAccountRoleArn + value: '{{ ServiceAccountRoleArn }}' + - name: PodIdentityAssociations + value: + - ClusterName: '{{ ClusterName }}' + RoleArn: '{{ RoleArn }}' + Namespace: '{{ Namespace }}' + ServiceAccount: '{{ ServiceAccount }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ConfigurationValues + value: '{{ ConfigurationValues }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eks.addons +WHERE data__Identifier = '' +AND 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, +iam:GetRole, +eks:CreatePodIdentityAssociation +``` + +### Read +```json +eks:DescribeAddon +``` + +### Delete +```json +eks:DeleteAddon, +eks:DescribeAddon, +eks:DeletePodIdentityAssociation +``` + +### List +```json +eks:ListAddons +``` + +### Update +```json +iam:PassRole, +iam:GetRole, +eks:UpdateAddon, +eks:DescribeAddon, +eks:DescribeUpdate, +eks:ListTagsForResource, +eks:TagResource, +eks:UntagResource, +eks:CreatePodIdentityAssociation, +eks:DeletePodIdentityAssociation +``` diff --git a/website/docs/services/eks/addons_list_only/index.md b/website/docs/services/eks/addons_list_only/index.md new file mode 100644 index 0000000..4341816 --- /dev/null +++ b/website/docs/services/eks/addons_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: addons_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - addons_list_only + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists addons in a region or regions, for all properties use addons + +## Overview + + + + + + + +
Nameaddons_list_only
TypeResource
DescriptionResource Schema for AWS::EKS::Addon
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringName of Cluster
stringName of Addon
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all addons in a region. +```sql +SELECT +region, +cluster_name, +addon_name +FROM aws.eks.addons_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the addons_list_only resource, see addons + diff --git a/website/docs/services/eks/cluster_tags/index.md b/website/docs/services/eks/cluster_tags/index.md new file mode 100644 index 0000000..e374c05 --- /dev/null +++ b/website/docs/services/eks/cluster_tags/index.md @@ -0,0 +1,119 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + + + +
Namecluster_tags
TypeResource
DescriptionAn object representing an Amazon EKS cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
objectThe Kubernetes network configuration for the cluster.
objectEnable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.
stringThe unique name to give to your cluster.
stringThe unique ID given to your cluster.
objectAn object representing the VPC configuration to use for an Amazon EKS cluster.
objectAn object representing the Outpost configuration to use for AWS EKS outpost cluster.
objectAn object representing the Access Config to use for the cluster.
objectAn object representing the Upgrade Policy to use for the cluster.
objectConfiguration fields for specifying on-premises node and pod CIDRs that are external to the VPC passed during cluster creation.
objectTodo: add description
objectTodo: add description
stringThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
stringThe desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
stringThe ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
stringThe endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
stringThe certificate-authority-data for your cluster.
stringThe cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
stringAmazon Resource Name (ARN) or alias of the customer master key (CMK).
stringThe issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
booleanSet this value to false to avoid creating the default networking add-ons when the cluster is created.
objectThe current zonal shift configuration to use for the cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +encryption_config, +kubernetes_network_config, +logging, +name, +id, +resources_vpc_config, +outpost_config, +access_config, +upgrade_policy, +remote_network_config, +compute_config, +storage_config, +role_arn, +version, +arn, +endpoint, +certificate_authority_data, +cluster_security_group_id, +encryption_config_key_arn, +open_id_connect_issuer_url, +bootstrap_self_managed_addons, +zonal_shift_config, +tag_key, +tag_value +FROM aws.eks.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + diff --git a/website/docs/services/eks/clusters/index.md b/website/docs/services/eks/clusters/index.md new file mode 100644 index 0000000..becead8 --- /dev/null +++ b/website/docs/services/eks/clusters/index.md @@ -0,0 +1,389 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster resource or lists clusters in a region + +## Overview + + + + + + + +
Nameclusters
TypeResource
DescriptionAn object representing an Amazon EKS cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
objectThe Kubernetes network configuration for the cluster.
objectEnable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.
stringThe unique name to give to your cluster.
stringThe unique ID given to your cluster.
objectAn object representing the VPC configuration to use for an Amazon EKS cluster.
objectAn object representing the Outpost configuration to use for AWS EKS outpost cluster.
objectAn object representing the Access Config to use for the cluster.
objectAn object representing the Upgrade Policy to use for the cluster.
objectConfiguration fields for specifying on-premises node and pod CIDRs that are external to the VPC passed during cluster creation.
objectTodo: add description
objectTodo: add description
stringThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
stringThe desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
stringThe endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
stringThe certificate-authority-data for your cluster.
stringThe cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
stringAmazon Resource Name (ARN) or alias of the customer master key (CMK).
stringThe issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
booleanSet this value to false to avoid creating the default networking add-ons when the cluster is created.
objectThe current zonal shift configuration to use for the cluster.
stringAWS region.
+ +For more information, see AWS::EKS::Cluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all clusters in a region. +```sql +SELECT +region, +encryption_config, +kubernetes_network_config, +logging, +name, +id, +resources_vpc_config, +outpost_config, +access_config, +upgrade_policy, +remote_network_config, +compute_config, +storage_config, +role_arn, +version, +tags, +arn, +endpoint, +certificate_authority_data, +cluster_security_group_id, +encryption_config_key_arn, +open_id_connect_issuer_url, +bootstrap_self_managed_addons, +zonal_shift_config +FROM aws.eks.clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster. +```sql +SELECT +region, +encryption_config, +kubernetes_network_config, +logging, +name, +id, +resources_vpc_config, +outpost_config, +access_config, +upgrade_policy, +remote_network_config, +compute_config, +storage_config, +role_arn, +version, +tags, +arn, +endpoint, +certificate_authority_data, +cluster_security_group_id, +encryption_config_key_arn, +open_id_connect_issuer_url, +bootstrap_self_managed_addons, +zonal_shift_config +FROM aws.eks.clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eks.clusters ( + ResourcesVpcConfig, + RoleArn, + region +) +SELECT +'{{ ResourcesVpcConfig }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eks.clusters ( + EncryptionConfig, + KubernetesNetworkConfig, + Logging, + Name, + ResourcesVpcConfig, + OutpostConfig, + AccessConfig, + UpgradePolicy, + RemoteNetworkConfig, + ComputeConfig, + StorageConfig, + RoleArn, + Version, + Tags, + BootstrapSelfManagedAddons, + ZonalShiftConfig, + region +) +SELECT + '{{ EncryptionConfig }}', + '{{ KubernetesNetworkConfig }}', + '{{ Logging }}', + '{{ Name }}', + '{{ ResourcesVpcConfig }}', + '{{ OutpostConfig }}', + '{{ AccessConfig }}', + '{{ UpgradePolicy }}', + '{{ RemoteNetworkConfig }}', + '{{ ComputeConfig }}', + '{{ StorageConfig }}', + '{{ RoleArn }}', + '{{ Version }}', + '{{ Tags }}', + '{{ BootstrapSelfManagedAddons }}', + '{{ ZonalShiftConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster + props: + - name: EncryptionConfig + value: + - Provider: + KeyArn: '{{ KeyArn }}' + Resources: + - '{{ Resources[0] }}' + - name: KubernetesNetworkConfig + value: + ServiceIpv4Cidr: '{{ ServiceIpv4Cidr }}' + ServiceIpv6Cidr: '{{ ServiceIpv6Cidr }}' + IpFamily: '{{ IpFamily }}' + ElasticLoadBalancing: + Enabled: '{{ Enabled }}' + - name: Logging + value: + ClusterLogging: + EnabledTypes: + - Type: '{{ Type }}' + - name: Name + value: '{{ Name }}' + - name: ResourcesVpcConfig + value: + EndpointPrivateAccess: '{{ EndpointPrivateAccess }}' + EndpointPublicAccess: '{{ EndpointPublicAccess }}' + PublicAccessCidrs: + - '{{ PublicAccessCidrs[0] }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: OutpostConfig + value: + OutpostArns: + - '{{ OutpostArns[0] }}' + ControlPlaneInstanceType: '{{ ControlPlaneInstanceType }}' + ControlPlanePlacement: + GroupName: '{{ GroupName }}' + - name: AccessConfig + value: + BootstrapClusterCreatorAdminPermissions: '{{ BootstrapClusterCreatorAdminPermissions }}' + AuthenticationMode: '{{ AuthenticationMode }}' + - name: UpgradePolicy + value: + SupportType: '{{ SupportType }}' + - name: RemoteNetworkConfig + value: + RemoteNodeNetworks: + - Cidrs: + - '{{ Cidrs[0] }}' + RemotePodNetworks: + - Cidrs: + - '{{ Cidrs[0] }}' + - name: ComputeConfig + value: + Enabled: '{{ Enabled }}' + NodeRoleArn: '{{ NodeRoleArn }}' + NodePools: + - '{{ NodePools[0] }}' + - name: StorageConfig + value: + BlockStorage: + Enabled: '{{ Enabled }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Version + value: '{{ Version }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: BootstrapSelfManagedAddons + value: '{{ BootstrapSelfManagedAddons }}' + - name: ZonalShiftConfig + value: + Enabled: '{{ Enabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eks.clusters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +```json +eks:CreateCluster, +eks:DescribeCluster, +eks:TagResource, +eks:CreateAccessEntry, +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 +``` + +### 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 +``` + +### List +```json +eks:ListClusters +``` diff --git a/website/docs/services/eks/clusters_list_only/index.md b/website/docs/services/eks/clusters_list_only/index.md new file mode 100644 index 0000000..e45851c --- /dev/null +++ b/website/docs/services/eks/clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + + + +
Nameclusters_list_only
TypeResource
DescriptionAn object representing an Amazon EKS cluster.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique name to give to your cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +name +FROM aws.eks.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + diff --git a/website/docs/services/eks/fargate_profile_tags/index.md b/website/docs/services/eks/fargate_profile_tags/index.md new file mode 100644 index 0000000..01202fc --- /dev/null +++ b/website/docs/services/eks/fargate_profile_tags/index.md @@ -0,0 +1,87 @@ +--- +title: fargate_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fargate_profile_tags + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fargate_profiles in a region + +## Overview + + + + + + + +
Namefargate_profile_tags
TypeResource
DescriptionResource Schema for AWS::EKS::FargateProfile
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the Cluster
stringName of FargateProfile
stringThe IAM policy arn for pods
string
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fargate_profiles in a region. +```sql +SELECT +region, +cluster_name, +fargate_profile_name, +pod_execution_role_arn, +arn, +subnets, +selectors, +tag_key, +tag_value +FROM aws.eks.fargate_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fargate_profile_tags resource, see fargate_profiles + diff --git a/website/docs/services/eks/fargate_profiles/index.md b/website/docs/services/eks/fargate_profiles/index.md new file mode 100644 index 0000000..9c9df2a --- /dev/null +++ b/website/docs/services/eks/fargate_profiles/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a fargate_profile resource or lists fargate_profiles in a region + +## Overview + + + + + + + +
Namefargate_profiles
TypeResource
DescriptionResource Schema for AWS::EKS::FargateProfile
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of the Cluster
stringName of FargateProfile
stringThe IAM policy arn for pods
string
array
array
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EKS::FargateProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all fargate_profiles in a region. +```sql +SELECT +region, +cluster_name, +fargate_profile_name, +pod_execution_role_arn, +arn, +subnets, +selectors, +tags +FROM aws.eks.fargate_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual fargate_profile. +```sql +SELECT +region, +cluster_name, +fargate_profile_name, +pod_execution_role_arn, +arn, +subnets, +selectors, +tags +FROM aws.eks.fargate_profiles +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new fargate_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eks.fargate_profiles ( + ClusterName, + PodExecutionRoleArn, + Selectors, + region +) +SELECT +'{{ ClusterName }}', + '{{ PodExecutionRoleArn }}', + '{{ Selectors }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eks.fargate_profiles ( + ClusterName, + FargateProfileName, + PodExecutionRoleArn, + Subnets, + Selectors, + Tags, + region +) +SELECT + '{{ ClusterName }}', + '{{ FargateProfileName }}', + '{{ PodExecutionRoleArn }}', + '{{ Subnets }}', + '{{ Selectors }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: fargate_profile + props: + - name: ClusterName + value: '{{ ClusterName }}' + - name: FargateProfileName + value: '{{ FargateProfileName }}' + - name: PodExecutionRoleArn + value: '{{ PodExecutionRoleArn }}' + - name: Subnets + value: + - '{{ Subnets[0] }}' + - name: Selectors + value: + - Namespace: '{{ Namespace }}' + Labels: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eks.fargate_profiles +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +eks:DescribeFargateProfile +``` + +### Delete +```json +eks:DeleteFargateProfile, +eks:DescribeFargateProfile +``` + +### List +```json +eks:ListFargateProfiles +``` + +### Update +```json +eks:DescribeFargateProfile, +eks:ListTagsForResource, +eks:TagResource, +eks:UntagResource +``` diff --git a/website/docs/services/eks/fargate_profiles_list_only/index.md b/website/docs/services/eks/fargate_profiles_list_only/index.md new file mode 100644 index 0000000..b910078 --- /dev/null +++ b/website/docs/services/eks/fargate_profiles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: fargate_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fargate_profiles_list_only + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fargate_profiles in a region or regions, for all properties use fargate_profiles + +## Overview + + + + + + + +
Namefargate_profiles_list_only
TypeResource
DescriptionResource Schema for AWS::EKS::FargateProfile
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringName of the Cluster
stringName of FargateProfile
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fargate_profiles in a region. +```sql +SELECT +region, +cluster_name, +fargate_profile_name +FROM aws.eks.fargate_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fargate_profiles_list_only resource, see fargate_profiles + diff --git a/website/docs/services/eks/identity_provider_config_tags/index.md b/website/docs/services/eks/identity_provider_config_tags/index.md new file mode 100644 index 0000000..7b223dc --- /dev/null +++ b/website/docs/services/eks/identity_provider_config_tags/index.md @@ -0,0 +1,85 @@ +--- +title: identity_provider_config_tags +hide_title: false +hide_table_of_contents: false +keywords: + - identity_provider_config_tags + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for identity_provider_configs in a region + +## Overview + + + + + + + +
Nameidentity_provider_config_tags
TypeResource
DescriptionAn object representing an Amazon EKS IdentityProviderConfig.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the identity provider configuration.
stringThe type of the identity provider configuration.
stringThe name of the OIDC provider configuration.
objectAn object representing an OpenID Connect (OIDC) configuration.
stringThe ARN of the configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all identity_provider_configs in a region. +```sql +SELECT +region, +cluster_name, +type, +identity_provider_config_name, +oidc, +identity_provider_config_arn, +tag_key, +tag_value +FROM aws.eks.identity_provider_config_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_provider_config_tags resource, see identity_provider_configs + diff --git a/website/docs/services/eks/identity_provider_configs/index.md b/website/docs/services/eks/identity_provider_configs/index.md new file mode 100644 index 0000000..6379123 --- /dev/null +++ b/website/docs/services/eks/identity_provider_configs/index.md @@ -0,0 +1,244 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an identity_provider_config resource or lists identity_provider_configs in a region + +## Overview + + + + + + + +
Nameidentity_provider_configs
TypeResource
DescriptionAn object representing an Amazon EKS IdentityProviderConfig.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the identity provider configuration.
stringThe type of the identity provider configuration.
stringThe name of the OIDC provider configuration.
objectAn object representing an OpenID Connect (OIDC) configuration.
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the configuration.
stringAWS region.
+ +For more information, see AWS::EKS::IdentityProviderConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all identity_provider_configs in a region. +```sql +SELECT +region, +cluster_name, +type, +identity_provider_config_name, +oidc, +tags, +identity_provider_config_arn +FROM aws.eks.identity_provider_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual identity_provider_config. +```sql +SELECT +region, +cluster_name, +type, +identity_provider_config_name, +oidc, +tags, +identity_provider_config_arn +FROM aws.eks.identity_provider_configs +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new identity_provider_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eks.identity_provider_configs ( + ClusterName, + Type, + region +) +SELECT +'{{ ClusterName }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eks.identity_provider_configs ( + ClusterName, + Type, + IdentityProviderConfigName, + Oidc, + Tags, + region +) +SELECT + '{{ ClusterName }}', + '{{ Type }}', + '{{ IdentityProviderConfigName }}', + '{{ Oidc }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: identity_provider_config + props: + - name: ClusterName + value: '{{ ClusterName }}' + - name: Type + value: '{{ Type }}' + - name: IdentityProviderConfigName + value: '{{ IdentityProviderConfigName }}' + - name: Oidc + value: + ClientId: '{{ ClientId }}' + GroupsClaim: '{{ GroupsClaim }}' + GroupsPrefix: '{{ GroupsPrefix }}' + IssuerUrl: '{{ IssuerUrl }}' + RequiredClaims: + - Key: '{{ Key }}' + Value: '{{ Value }}' + UsernameClaim: '{{ UsernameClaim }}' + UsernamePrefix: '{{ UsernamePrefix }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eks.identity_provider_configs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +eks:DescribeIdentityProviderConfig +``` + +### Update +```json +eks:DescribeIdentityProviderConfig, +eks:TagResource, +eks:UntagResource +``` + +### Delete +```json +eks:DisassociateIdentityProviderConfig, +eks:DescribeIdentityProviderConfig +``` + +### List +```json +eks:ListIdentityProviderConfigs +``` diff --git a/website/docs/services/eks/identity_provider_configs_list_only/index.md b/website/docs/services/eks/identity_provider_configs_list_only/index.md new file mode 100644 index 0000000..83f74ab --- /dev/null +++ b/website/docs/services/eks/identity_provider_configs_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: identity_provider_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_provider_configs_list_only + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_provider_configs in a region or regions, for all properties use identity_provider_configs + +## Overview + + + + + + + +
Nameidentity_provider_configs_list_only
TypeResource
DescriptionAn object representing an Amazon EKS IdentityProviderConfig.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the identity provider configuration.
stringThe type of the identity provider configuration.
stringThe name of the OIDC provider configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_provider_configs in a region. +```sql +SELECT +region, +identity_provider_config_name, +cluster_name, +type +FROM aws.eks.identity_provider_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_provider_configs_list_only resource, see identity_provider_configs + diff --git a/website/docs/services/eks/index.md b/website/docs/services/eks/index.md new file mode 100644 index 0000000..4a0421e --- /dev/null +++ b/website/docs/services/eks/index.md @@ -0,0 +1,56 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The eks service documentation. + +:::info Service Summary + +
+
+total resources: 21
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/eks/nodegroup_tags/index.md b/website/docs/services/eks/nodegroup_tags/index.md new file mode 100644 index 0000000..61567e7 --- /dev/null +++ b/website/docs/services/eks/nodegroup_tags/index.md @@ -0,0 +1,115 @@ +--- +title: nodegroup_tags +hide_title: false +hide_table_of_contents: false +keywords: + - nodegroup_tags + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for nodegroups in a region + +## Overview + + + + + + + +
Namenodegroup_tags
TypeResource
DescriptionResource schema for AWS::EKS::Nodegroup
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AMI type for your node group.
stringThe capacity type of your managed node group.
stringName of the cluster to create the node group in.
integerThe root device disk size (in GiB) for your node group instances.
booleanForce the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
arraySpecify the instance types for a node group.
objectThe Kubernetes labels to be applied to the nodes in the node group when they are created.
objectAn object representing a node group's launch template specification.
stringThe unique name to give your node group.
stringThe Amazon Resource Name (ARN) of the IAM role to associate with your node group.
stringThe AMI version of the Amazon EKS-optimized AMI to use with your node group.
objectThe remote access (SSH) configuration to use with your node group.
objectThe scaling configuration details for the Auto Scaling group that is created for your node group.
arrayThe subnets to use for the Auto Scaling group that is created for your node group.
arrayThe Kubernetes taints to be applied to the nodes in the node group when they are created.
objectThe node group update configuration.
objectThe node auto repair configuration for node group.
stringThe Kubernetes version to use for your managed nodes.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all nodegroups in a region. +```sql +SELECT +region, +ami_type, +capacity_type, +cluster_name, +disk_size, +force_update_enabled, +instance_types, +labels, +launch_template, +nodegroup_name, +node_role, +release_version, +remote_access, +scaling_config, +subnets, +taints, +update_config, +node_repair_config, +version, +id, +arn, +tag_key, +tag_value +FROM aws.eks.nodegroup_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the nodegroup_tags resource, see nodegroups + diff --git a/website/docs/services/eks/nodegroups/index.md b/website/docs/services/eks/nodegroups/index.md new file mode 100644 index 0000000..09608e0 --- /dev/null +++ b/website/docs/services/eks/nodegroups/index.md @@ -0,0 +1,372 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a nodegroup resource or lists nodegroups in a region + +## Overview + + + + + + + +
Namenodegroups
TypeResource
DescriptionResource schema for AWS::EKS::Nodegroup
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AMI type for your node group.
stringThe capacity type of your managed node group.
stringName of the cluster to create the node group in.
integerThe root device disk size (in GiB) for your node group instances.
booleanForce the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
arraySpecify the instance types for a node group.
objectThe Kubernetes labels to be applied to the nodes in the node group when they are created.
objectAn object representing a node group's launch template specification.
stringThe unique name to give your node group.
stringThe Amazon Resource Name (ARN) of the IAM role to associate with your node group.
stringThe AMI version of the Amazon EKS-optimized AMI to use with your node group.
objectThe remote access (SSH) configuration to use with your node group.
objectThe scaling configuration details for the Auto Scaling group that is created for your node group.
arrayThe subnets to use for the Auto Scaling group that is created for your node group.
objectThe metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
arrayThe Kubernetes taints to be applied to the nodes in the node group when they are created.
objectThe node group update configuration.
objectThe node auto repair configuration for node group.
stringThe Kubernetes version to use for your managed nodes.
string
string
stringAWS region.
+ +For more information, see AWS::EKS::Nodegroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all nodegroups in a region. +```sql +SELECT +region, +ami_type, +capacity_type, +cluster_name, +disk_size, +force_update_enabled, +instance_types, +labels, +launch_template, +nodegroup_name, +node_role, +release_version, +remote_access, +scaling_config, +subnets, +tags, +taints, +update_config, +node_repair_config, +version, +id, +arn +FROM aws.eks.nodegroups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual nodegroup. +```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, +node_repair_config, +version, +id, +arn +FROM aws.eks.nodegroups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new nodegroup resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eks.nodegroups ( + ClusterName, + NodeRole, + Subnets, + region +) +SELECT +'{{ ClusterName }}', + '{{ NodeRole }}', + '{{ Subnets }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eks.nodegroups ( + AmiType, + CapacityType, + ClusterName, + DiskSize, + ForceUpdateEnabled, + InstanceTypes, + Labels, + LaunchTemplate, + NodegroupName, + NodeRole, + ReleaseVersion, + RemoteAccess, + ScalingConfig, + Subnets, + Tags, + Taints, + UpdateConfig, + NodeRepairConfig, + Version, + region +) +SELECT + '{{ AmiType }}', + '{{ CapacityType }}', + '{{ ClusterName }}', + '{{ DiskSize }}', + '{{ ForceUpdateEnabled }}', + '{{ InstanceTypes }}', + '{{ Labels }}', + '{{ LaunchTemplate }}', + '{{ NodegroupName }}', + '{{ NodeRole }}', + '{{ ReleaseVersion }}', + '{{ RemoteAccess }}', + '{{ ScalingConfig }}', + '{{ Subnets }}', + '{{ Tags }}', + '{{ Taints }}', + '{{ UpdateConfig }}', + '{{ NodeRepairConfig }}', + '{{ Version }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: nodegroup + props: + - name: AmiType + value: '{{ AmiType }}' + - name: CapacityType + value: '{{ CapacityType }}' + - name: ClusterName + value: '{{ ClusterName }}' + - name: DiskSize + value: '{{ DiskSize }}' + - name: ForceUpdateEnabled + value: '{{ ForceUpdateEnabled }}' + - name: InstanceTypes + value: + - '{{ InstanceTypes[0] }}' + - name: Labels + value: {} + - name: LaunchTemplate + value: + Id: '{{ Id }}' + Version: '{{ Version }}' + Name: '{{ Name }}' + - name: NodegroupName + value: '{{ NodegroupName }}' + - name: NodeRole + value: '{{ NodeRole }}' + - name: ReleaseVersion + value: '{{ ReleaseVersion }}' + - name: RemoteAccess + value: + SourceSecurityGroups: + - '{{ SourceSecurityGroups[0] }}' + Ec2SshKey: '{{ Ec2SshKey }}' + - name: ScalingConfig + value: + MinSize: '{{ MinSize }}' + DesiredSize: '{{ DesiredSize }}' + MaxSize: '{{ MaxSize }}' + - name: Subnets + value: + - '{{ Subnets[0] }}' + - name: Tags + value: {} + - name: Taints + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + Effect: '{{ Effect }}' + - name: UpdateConfig + value: + MaxUnavailable: null + MaxUnavailablePercentage: null + - name: NodeRepairConfig + value: + Enabled: '{{ Enabled }}' + - name: Version + value: '{{ Version }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eks.nodegroups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +eks:DescribeNodegroup +``` + +### Delete +```json +eks:DeleteNodegroup, +eks:DescribeNodegroup +``` + +### List +```json +eks:ListNodegroups +``` + +### Update +```json +iam:GetRole, +iam:PassRole, +eks:DescribeNodegroup, +eks:DescribeUpdate, +eks:ListUpdates, +eks:TagResource, +eks:UntagResource, +eks:UpdateNodegroupConfig, +eks:UpdateNodegroupVersion +``` diff --git a/website/docs/services/eks/nodegroups_list_only/index.md b/website/docs/services/eks/nodegroups_list_only/index.md new file mode 100644 index 0000000..f1838dc --- /dev/null +++ b/website/docs/services/eks/nodegroups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: nodegroups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - nodegroups_list_only + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists nodegroups in a region or regions, for all properties use nodegroups + +## Overview + + + + + + + +
Namenodegroups_list_only
TypeResource
DescriptionResource schema for AWS::EKS::Nodegroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all nodegroups in a region. +```sql +SELECT +region, +id +FROM aws.eks.nodegroups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the nodegroups_list_only resource, see nodegroups + diff --git a/website/docs/services/eks/pod_identity_association_tags/index.md b/website/docs/services/eks/pod_identity_association_tags/index.md new file mode 100644 index 0000000..662468d --- /dev/null +++ b/website/docs/services/eks/pod_identity_association_tags/index.md @@ -0,0 +1,87 @@ +--- +title: pod_identity_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pod_identity_association_tags + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pod_identity_associations in a region + +## Overview + + + + + + + +
Namepod_identity_association_tags
TypeResource
DescriptionAn object representing an Amazon EKS PodIdentityAssociation.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe cluster that the pod identity association is created for.
stringThe IAM role ARN that the pod identity association is created for.
stringThe Kubernetes namespace that the pod identity association is created for.
stringThe Kubernetes service account that the pod identity association is created for.
stringThe ARN of the pod identity association.
stringThe ID of the pod identity association.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pod_identity_associations in a region. +```sql +SELECT +region, +cluster_name, +role_arn, +namespace, +service_account, +association_arn, +association_id, +tag_key, +tag_value +FROM aws.eks.pod_identity_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pod_identity_association_tags resource, see pod_identity_associations + diff --git a/website/docs/services/eks/pod_identity_associations/index.md b/website/docs/services/eks/pod_identity_associations/index.md new file mode 100644 index 0000000..b3b68de --- /dev/null +++ b/website/docs/services/eks/pod_identity_associations/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a pod_identity_association resource or lists pod_identity_associations in a region + +## Overview + + + + + + + +
Namepod_identity_associations
TypeResource
DescriptionAn object representing an Amazon EKS PodIdentityAssociation.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe cluster that the pod identity association is created for.
stringThe IAM role ARN that the pod identity association is created for.
stringThe Kubernetes namespace that the pod identity association is created for.
stringThe Kubernetes service account that the pod identity association is created for.
stringThe ARN of the pod identity association.
stringThe ID of the pod identity association.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EKS::PodIdentityAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all pod_identity_associations in a region. +```sql +SELECT +region, +cluster_name, +role_arn, +namespace, +service_account, +association_arn, +association_id, +tags +FROM aws.eks.pod_identity_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual pod_identity_association. +```sql +SELECT +region, +cluster_name, +role_arn, +namespace, +service_account, +association_arn, +association_id, +tags +FROM aws.eks.pod_identity_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pod_identity_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eks.pod_identity_associations ( + ClusterName, + RoleArn, + Namespace, + ServiceAccount, + region +) +SELECT +'{{ ClusterName }}', + '{{ RoleArn }}', + '{{ Namespace }}', + '{{ ServiceAccount }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eks.pod_identity_associations ( + ClusterName, + RoleArn, + Namespace, + ServiceAccount, + Tags, + region +) +SELECT + '{{ ClusterName }}', + '{{ RoleArn }}', + '{{ Namespace }}', + '{{ ServiceAccount }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: pod_identity_association + props: + - name: ClusterName + value: '{{ ClusterName }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Namespace + value: '{{ Namespace }}' + - name: ServiceAccount + value: '{{ ServiceAccount }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eks.pod_identity_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +eks:DescribePodIdentityAssociation +``` + +### Update +```json +eks:DescribePodIdentityAssociation, +eks:UpdatePodIdentityAssociation, +eks:TagResource, +eks:UntagResource, +iam:PassRole, +iam:GetRole +``` + +### Delete +```json +eks:DeletePodIdentityAssociation, +eks:DescribePodIdentityAssociation +``` + +### List +```json +eks:ListPodIdentityAssociations +``` diff --git a/website/docs/services/eks/pod_identity_associations_list_only/index.md b/website/docs/services/eks/pod_identity_associations_list_only/index.md new file mode 100644 index 0000000..f45d671 --- /dev/null +++ b/website/docs/services/eks/pod_identity_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pod_identity_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pod_identity_associations_list_only + - eks + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pod_identity_associations in a region or regions, for all properties use pod_identity_associations + +## Overview + + + + + + + +
Namepod_identity_associations_list_only
TypeResource
DescriptionAn object representing an Amazon EKS PodIdentityAssociation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the pod identity association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pod_identity_associations in a region. +```sql +SELECT +region, +association_arn +FROM aws.eks.pod_identity_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pod_identity_associations_list_only resource, see pod_identity_associations + diff --git a/website/docs/services/elasticache/global_replication_groups/index.md b/website/docs/services/elasticache/global_replication_groups/index.md new file mode 100644 index 0000000..2b30b64 --- /dev/null +++ b/website/docs/services/elasticache/global_replication_groups/index.md @@ -0,0 +1,281 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a global_replication_group resource or lists global_replication_groups in a region + +## Overview + + + + + + + +
Nameglobal_replication_groups
TypeResource
DescriptionThe AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix.
booleanAutomaticFailoverEnabled
stringThe cache node type of the Global Datastore
stringThe engine version of the Global Datastore.
stringThe engine of the Global Datastore.
stringCache parameter group name to use for the new engine version. This parameter cannot be modified independently.
integerIndicates the number of node groups in the Global Datastore.
stringThe optional description of the Global Datastore
stringThe name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
arrayThe replication groups that comprise the Global Datastore.
stringThe status of the Global Datastore
arrayDescribes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore
stringAWS region.
+ +For more information, see AWS::ElastiCache::GlobalReplicationGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all global_replication_groups in a region. +```sql +SELECT +region, +global_replication_group_id_suffix, +automatic_failover_enabled, +cache_node_type, +engine_version, +engine, +cache_parameter_group_name, +global_node_group_count, +global_replication_group_description, +global_replication_group_id, +members, +status, +regional_configurations +FROM aws.elasticache.global_replication_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual global_replication_group. +```sql +SELECT +region, +global_replication_group_id_suffix, +automatic_failover_enabled, +cache_node_type, +engine_version, +engine, +cache_parameter_group_name, +global_node_group_count, +global_replication_group_description, +global_replication_group_id, +members, +status, +regional_configurations +FROM aws.elasticache.global_replication_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new global_replication_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.global_replication_groups ( + Members, + region +) +SELECT +'{{ Members }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.global_replication_groups ( + GlobalReplicationGroupIdSuffix, + AutomaticFailoverEnabled, + CacheNodeType, + EngineVersion, + Engine, + CacheParameterGroupName, + GlobalNodeGroupCount, + GlobalReplicationGroupDescription, + Members, + RegionalConfigurations, + region +) +SELECT + '{{ GlobalReplicationGroupIdSuffix }}', + '{{ AutomaticFailoverEnabled }}', + '{{ CacheNodeType }}', + '{{ EngineVersion }}', + '{{ Engine }}', + '{{ CacheParameterGroupName }}', + '{{ GlobalNodeGroupCount }}', + '{{ GlobalReplicationGroupDescription }}', + '{{ Members }}', + '{{ RegionalConfigurations }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: global_replication_group + props: + - name: GlobalReplicationGroupIdSuffix + value: '{{ GlobalReplicationGroupIdSuffix }}' + - name: AutomaticFailoverEnabled + value: '{{ AutomaticFailoverEnabled }}' + - name: CacheNodeType + value: '{{ CacheNodeType }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: Engine + value: '{{ Engine }}' + - name: CacheParameterGroupName + value: '{{ CacheParameterGroupName }}' + - name: GlobalNodeGroupCount + value: '{{ GlobalNodeGroupCount }}' + - name: GlobalReplicationGroupDescription + value: '{{ GlobalReplicationGroupDescription }}' + - name: Members + value: + - ReplicationGroupId: '{{ ReplicationGroupId }}' + ReplicationGroupRegion: '{{ ReplicationGroupRegion }}' + Role: '{{ Role }}' + - name: RegionalConfigurations + value: + - ReplicationGroupId: '{{ ReplicationGroupId }}' + ReplicationGroupRegion: '{{ ReplicationGroupRegion }}' + ReshardingConfigurations: + - NodeGroupId: '{{ NodeGroupId }}' + PreferredAvailabilityZones: + - '{{ PreferredAvailabilityZones[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticache.global_replication_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the global_replication_groups resource, the following permissions are required: + +### Create +```json +elasticache:CreateGlobalReplicationGroup, +elasticache:DescribeGlobalReplicationGroups +``` + +### 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 +``` + +### List +```json +elasticache:DescribeGlobalReplicationGroups +``` diff --git a/website/docs/services/elasticache/global_replication_groups_list_only/index.md b/website/docs/services/elasticache/global_replication_groups_list_only/index.md new file mode 100644 index 0000000..03264f4 --- /dev/null +++ b/website/docs/services/elasticache/global_replication_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: global_replication_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - global_replication_groups_list_only + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists global_replication_groups in a region or regions, for all properties use global_replication_groups + +## Overview + + + + + + + +
Nameglobal_replication_groups_list_only
TypeResource
DescriptionThe AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all global_replication_groups in a region. +```sql +SELECT +region, +global_replication_group_id +FROM aws.elasticache.global_replication_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_replication_groups_list_only resource, see global_replication_groups + diff --git a/website/docs/services/elasticache/index.md b/website/docs/services/elasticache/index.md new file mode 100644 index 0000000..9f2d31c --- /dev/null +++ b/website/docs/services/elasticache/index.md @@ -0,0 +1,52 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The elasticache service documentation. + +:::info Service Summary + +
+
+total resources: 17
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/elasticache/parameter_group_tags/index.md b/website/docs/services/elasticache/parameter_group_tags/index.md new file mode 100644 index 0000000..b10d7ca --- /dev/null +++ b/website/docs/services/elasticache/parameter_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: parameter_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_group_tags + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for parameter_groups in a region + +## Overview + + + + + + + +
Nameparameter_group_tags
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::ParameterGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe description for this cache parameter group.
objectA comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide.
stringThe name of the Cache Parameter Group.
stringThe name of the cache parameter group family that this cache parameter group is compatible with.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all parameter_groups in a region. +```sql +SELECT +region, +description, +properties, +cache_parameter_group_name, +cache_parameter_group_family, +tag_key, +tag_value +FROM aws.elasticache.parameter_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameter_group_tags resource, see parameter_groups + diff --git a/website/docs/services/elasticache/parameter_groups/index.md b/website/docs/services/elasticache/parameter_groups/index.md new file mode 100644 index 0000000..33b2df6 --- /dev/null +++ b/website/docs/services/elasticache/parameter_groups/index.md @@ -0,0 +1,235 @@ +--- +title: parameter_groups +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a parameter_group resource or lists parameter_groups in a region + +## Overview + + + + + + + +
Nameparameter_groups
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::ParameterGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe description for this cache parameter group.
objectA comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide.
arrayTags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.
stringThe name of the Cache Parameter Group.
stringThe name of the cache parameter group family that this cache parameter group is compatible with.
stringAWS region.
+ +For more information, see AWS::ElastiCache::ParameterGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all parameter_groups in a region. +```sql +SELECT +region, +description, +properties, +tags, +cache_parameter_group_name, +cache_parameter_group_family +FROM aws.elasticache.parameter_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual parameter_group. +```sql +SELECT +region, +description, +properties, +tags, +cache_parameter_group_name, +cache_parameter_group_family +FROM aws.elasticache.parameter_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new parameter_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.parameter_groups ( + Description, + CacheParameterGroupFamily, + region +) +SELECT +'{{ Description }}', + '{{ CacheParameterGroupFamily }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.parameter_groups ( + Description, + Properties, + Tags, + CacheParameterGroupFamily, + region +) +SELECT + '{{ Description }}', + '{{ Properties }}', + '{{ Tags }}', + '{{ CacheParameterGroupFamily }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: parameter_group + props: + - name: Description + value: '{{ Description }}' + - name: Properties + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CacheParameterGroupFamily + value: '{{ CacheParameterGroupFamily }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticache.parameter_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the parameter_groups resource, the following permissions are required: + +### Create +```json +ElastiCache:CreateCacheParameterGroup, +ElastiCache:DescribeCacheParameterGroups, +ElastiCache:AddTagsToResource, +ElastiCache:ModifyCacheParameterGroup, +iam:CreateServiceLinkedRole, +iam:PutRolePolicy +``` + +### Read +```json +ElastiCache:DescribeCacheParameterGroups, +ElastiCache:DescribeCacheParameters, +ElastiCache:ListTagsForResource +``` + +### Update +```json +ElastiCache:ModifyCacheParameterGroup, +ElastiCache:DescribeCacheParameterGroups, +ElastiCache:DescribeCacheParameters, +ElastiCache:DescribeEngineDefaultParameters, +ElastiCache:AddTagsToResource, +ElastiCache:RemoveTagsFromResource +``` + +### Delete +```json +ElastiCache:DescribeCacheParameterGroups, +ElastiCache:DeleteCacheParameterGroup +``` + +### List +```json +ElastiCache:DescribeCacheParameterGroups +``` diff --git a/website/docs/services/elasticache/parameter_groups_list_only/index.md b/website/docs/services/elasticache/parameter_groups_list_only/index.md new file mode 100644 index 0000000..42fb320 --- /dev/null +++ b/website/docs/services/elasticache/parameter_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: parameter_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_groups_list_only + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists parameter_groups in a region or regions, for all properties use parameter_groups + +## Overview + + + + + + + +
Nameparameter_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::ParameterGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Cache Parameter Group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all parameter_groups in a region. +```sql +SELECT +region, +cache_parameter_group_name +FROM aws.elasticache.parameter_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameter_groups_list_only resource, see parameter_groups + diff --git a/website/docs/services/elasticache/serverless_cache_tags/index.md b/website/docs/services/elasticache/serverless_cache_tags/index.md new file mode 100644 index 0000000..96161c5 --- /dev/null +++ b/website/docs/services/elasticache/serverless_cache_tags/index.md @@ -0,0 +1,113 @@ +--- +title: serverless_cache_tags +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_cache_tags + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for serverless_caches in a region + +## Overview + + + + + + + +
Nameserverless_cache_tags
TypeResource
DescriptionThe AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Serverless Cache. This value must be unique.
stringThe description of the Serverless Cache.
stringThe engine name of the Serverless Cache.
stringThe major engine version of the Serverless Cache.
stringThe full engine version of the Serverless Cache.
objectThe cache capacity limit of the Serverless Cache.
stringThe ID of the KMS key used to encrypt the cluster.
arrayOne or more Amazon VPC security groups associated with this Serverless Cache.
arrayThe ARN's of snapshot to restore Serverless Cache.
stringThe ID of the user group.
arrayThe subnet id's of the Serverless Cache.
integerThe snapshot retention limit of the Serverless Cache.
stringThe daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
stringThe creation time of the Serverless Cache.
stringThe status of the Serverless Cache.
objectThe address and the port.
objectThe address and the port.
stringThe ARN of the Serverless Cache.
stringThe final snapshot name which is taken before Serverless Cache is deleted.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all serverless_caches in a region. +```sql +SELECT +region, +serverless_cache_name, +description, +engine, +major_engine_version, +full_engine_version, +cache_usage_limits, +kms_key_id, +security_group_ids, +snapshot_arns_to_restore, +user_group_id, +subnet_ids, +snapshot_retention_limit, +daily_snapshot_time, +create_time, +status, +endpoint, +reader_endpoint, +arn, +final_snapshot_name, +tag_key, +tag_value +FROM aws.elasticache.serverless_cache_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the serverless_cache_tags resource, see serverless_caches + diff --git a/website/docs/services/elasticache/serverless_caches/index.md b/website/docs/services/elasticache/serverless_caches/index.md new file mode 100644 index 0000000..a4062cd --- /dev/null +++ b/website/docs/services/elasticache/serverless_caches/index.md @@ -0,0 +1,342 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a serverless_cach resource or lists serverless_caches in a region + +## Overview + + + + + + + +
Nameserverless_caches
TypeResource
DescriptionThe AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Serverless Cache. This value must be unique.
stringThe description of the Serverless Cache.
stringThe engine name of the Serverless Cache.
stringThe major engine version of the Serverless Cache.
stringThe full engine version of the Serverless Cache.
objectThe cache capacity limit of the Serverless Cache.
stringThe ID of the KMS key used to encrypt the cluster.
arrayOne or more Amazon VPC security groups associated with this Serverless Cache.
arrayThe ARN's of snapshot to restore Serverless Cache.
arrayAn array of key-value pairs to apply to this Serverless Cache.
stringThe ID of the user group.
arrayThe subnet id's of the Serverless Cache.
integerThe snapshot retention limit of the Serverless Cache.
stringThe daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
stringThe creation time of the Serverless Cache.
stringThe status of the Serverless Cache.
objectThe address and the port.
objectThe address and the port.
stringThe ARN of the Serverless Cache.
stringThe final snapshot name which is taken before Serverless Cache is deleted.
stringAWS region.
+ +For more information, see AWS::ElastiCache::ServerlessCache. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all serverless_caches in a region. +```sql +SELECT +region, +serverless_cache_name, +description, +engine, +major_engine_version, +full_engine_version, +cache_usage_limits, +kms_key_id, +security_group_ids, +snapshot_arns_to_restore, +tags, +user_group_id, +subnet_ids, +snapshot_retention_limit, +daily_snapshot_time, +create_time, +status, +endpoint, +reader_endpoint, +arn, +final_snapshot_name +FROM aws.elasticache.serverless_caches +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual serverless_cach. +```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_caches +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new serverless_cach resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.serverless_caches ( + ServerlessCacheName, + Engine, + region +) +SELECT +'{{ ServerlessCacheName }}', + '{{ Engine }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.serverless_caches ( + ServerlessCacheName, + Description, + Engine, + MajorEngineVersion, + CacheUsageLimits, + KmsKeyId, + SecurityGroupIds, + SnapshotArnsToRestore, + Tags, + UserGroupId, + SubnetIds, + SnapshotRetentionLimit, + DailySnapshotTime, + Endpoint, + ReaderEndpoint, + FinalSnapshotName, + region +) +SELECT + '{{ ServerlessCacheName }}', + '{{ Description }}', + '{{ Engine }}', + '{{ MajorEngineVersion }}', + '{{ CacheUsageLimits }}', + '{{ KmsKeyId }}', + '{{ SecurityGroupIds }}', + '{{ SnapshotArnsToRestore }}', + '{{ Tags }}', + '{{ UserGroupId }}', + '{{ SubnetIds }}', + '{{ SnapshotRetentionLimit }}', + '{{ DailySnapshotTime }}', + '{{ Endpoint }}', + '{{ ReaderEndpoint }}', + '{{ FinalSnapshotName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: serverless_cach + props: + - name: ServerlessCacheName + value: '{{ ServerlessCacheName }}' + - name: Description + value: '{{ Description }}' + - name: Engine + value: '{{ Engine }}' + - name: MajorEngineVersion + value: '{{ MajorEngineVersion }}' + - name: CacheUsageLimits + value: + DataStorage: + Minimum: '{{ Minimum }}' + Maximum: '{{ Maximum }}' + Unit: '{{ Unit }}' + ECPUPerSecond: + Minimum: '{{ Minimum }}' + Maximum: '{{ Maximum }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: SnapshotArnsToRestore + value: + - '{{ SnapshotArnsToRestore[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: UserGroupId + value: '{{ UserGroupId }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: SnapshotRetentionLimit + value: '{{ SnapshotRetentionLimit }}' + - name: DailySnapshotTime + value: '{{ DailySnapshotTime }}' + - name: Endpoint + value: + Address: '{{ Address }}' + Port: '{{ Port }}' + - name: ReaderEndpoint + value: null + - name: FinalSnapshotName + value: '{{ FinalSnapshotName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticache.serverless_caches +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +elasticache:DescribeServerlessCaches, +elasticache:ListTagsForResource +``` diff --git a/website/docs/services/elasticache/serverless_caches_list_only/index.md b/website/docs/services/elasticache/serverless_caches_list_only/index.md new file mode 100644 index 0000000..b1b4921 --- /dev/null +++ b/website/docs/services/elasticache/serverless_caches_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: serverless_caches_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_caches_list_only + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists serverless_caches in a region or regions, for all properties use serverless_caches + +## Overview + + + + + + + +
Nameserverless_caches_list_only
TypeResource
DescriptionThe AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Serverless Cache. This value must be unique.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all serverless_caches in a region. +```sql +SELECT +region, +serverless_cache_name +FROM aws.elasticache.serverless_caches_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the serverless_caches_list_only resource, see serverless_caches + diff --git a/website/docs/services/elasticache/subnet_group_tags/index.md b/website/docs/services/elasticache/subnet_group_tags/index.md new file mode 100644 index 0000000..c8f8315 --- /dev/null +++ b/website/docs/services/elasticache/subnet_group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: subnet_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_group_tags + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for subnet_groups in a region + +## Overview + + + + + + + +
Namesubnet_group_tags
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::SubnetGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe description for the cache subnet group.
arrayThe EC2 subnet IDs for the cache subnet group.
stringThe name for the cache subnet group. This value is stored as a lowercase string.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all subnet_groups in a region. +```sql +SELECT +region, +description, +subnet_ids, +cache_subnet_group_name, +tag_key, +tag_value +FROM aws.elasticache.subnet_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_group_tags resource, see subnet_groups + diff --git a/website/docs/services/elasticache/subnet_groups/index.md b/website/docs/services/elasticache/subnet_groups/index.md new file mode 100644 index 0000000..d459cac --- /dev/null +++ b/website/docs/services/elasticache/subnet_groups/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a subnet_group resource or lists subnet_groups in a region + +## Overview + + + + + + + +
Namesubnet_groups
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::SubnetGroup
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe description for the cache subnet group.
arrayThe EC2 subnet IDs for the cache subnet group.
stringThe name for the cache subnet group. This value is stored as a lowercase string.
array
stringAWS region.
+ +For more information, see AWS::ElastiCache::SubnetGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all subnet_groups in a region. +```sql +SELECT +region, +description, +subnet_ids, +cache_subnet_group_name, +tags +FROM aws.elasticache.subnet_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual subnet_group. +```sql +SELECT +region, +description, +subnet_ids, +cache_subnet_group_name, +tags +FROM aws.elasticache.subnet_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new subnet_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.subnet_groups ( + Description, + SubnetIds, + region +) +SELECT +'{{ Description }}', + '{{ SubnetIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.subnet_groups ( + Description, + SubnetIds, + CacheSubnetGroupName, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ SubnetIds }}', + '{{ CacheSubnetGroupName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: subnet_group + props: + - name: Description + value: '{{ Description }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: CacheSubnetGroupName + value: '{{ CacheSubnetGroupName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticache.subnet_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +elasticache:DescribeCacheSubnetGroups, +elasticache:ListTagsForResource +``` + +### Delete +```json +elasticache:DeleteCacheSubnetGroup, +elasticache:DescribeCacheSubnetGroups, +elasticache:ListTagsForResource +``` + +### List +```json +elasticache:DescribeCacheSubnetGroups +``` + +### Update +```json +elasticache:ModifyCacheSubnetGroup, +elasticache:DescribeCacheSubnetGroups, +elasticache:AddTagsToResource, +elasticache:RemoveTagsFromResource +``` diff --git a/website/docs/services/elasticache/subnet_groups_list_only/index.md b/website/docs/services/elasticache/subnet_groups_list_only/index.md new file mode 100644 index 0000000..d57d369 --- /dev/null +++ b/website/docs/services/elasticache/subnet_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: subnet_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_groups_list_only + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnet_groups in a region or regions, for all properties use subnet_groups + +## Overview + + + + + + + +
Namesubnet_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::SubnetGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name for the cache subnet group. This value is stored as a lowercase string.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnet_groups in a region. +```sql +SELECT +region, +cache_subnet_group_name +FROM aws.elasticache.subnet_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_groups_list_only resource, see subnet_groups + diff --git a/website/docs/services/elasticache/user_group_tags/index.md b/website/docs/services/elasticache/user_group_tags/index.md new file mode 100644 index 0000000..084ddaf --- /dev/null +++ b/website/docs/services/elasticache/user_group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: user_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_group_tags + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for user_groups in a region + +## Overview + + + + + + + +
Nameuser_group_tags
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::UserGroup
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringIndicates user group status. Can be "creating", "active", "modifying", "deleting".
stringThe ID of the user group.
stringMust be redis.
arrayList of users associated to this user group.
stringThe Amazon Resource Name (ARN) of the user account.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all user_groups in a region. +```sql +SELECT +region, +status, +user_group_id, +engine, +user_ids, +arn, +tag_key, +tag_value +FROM aws.elasticache.user_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_group_tags resource, see user_groups + diff --git a/website/docs/services/elasticache/user_groups/index.md b/website/docs/services/elasticache/user_groups/index.md new file mode 100644 index 0000000..5464db9 --- /dev/null +++ b/website/docs/services/elasticache/user_groups/index.md @@ -0,0 +1,240 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_group resource or lists user_groups in a region + +## Overview + + + + + + + +
Nameuser_groups
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::UserGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringIndicates user group status. Can be "creating", "active", "modifying", "deleting".
stringThe ID of the user group.
stringMust be redis.
arrayList of users associated to this user group.
stringThe Amazon Resource Name (ARN) of the user account.
arrayAn array of key-value pairs to apply to this user.
stringAWS region.
+ +For more information, see AWS::ElastiCache::UserGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_groups in a region. +```sql +SELECT +region, +status, +user_group_id, +engine, +user_ids, +arn, +tags +FROM aws.elasticache.user_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_group. +```sql +SELECT +region, +status, +user_group_id, +engine, +user_ids, +arn, +tags +FROM aws.elasticache.user_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.user_groups ( + UserGroupId, + Engine, + UserIds, + region +) +SELECT +'{{ UserGroupId }}', + '{{ Engine }}', + '{{ UserIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.user_groups ( + UserGroupId, + Engine, + UserIds, + Tags, + region +) +SELECT + '{{ UserGroupId }}', + '{{ Engine }}', + '{{ UserIds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_group + props: + - name: UserGroupId + value: '{{ UserGroupId }}' + - name: Engine + value: '{{ Engine }}' + - name: UserIds + value: + - '{{ UserIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticache.user_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +elasticache:DescribeUserGroups, +elasticache:ListTagsForResource +``` diff --git a/website/docs/services/elasticache/user_groups_list_only/index.md b/website/docs/services/elasticache/user_groups_list_only/index.md new file mode 100644 index 0000000..f14c653 --- /dev/null +++ b/website/docs/services/elasticache/user_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: user_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_groups_list_only + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_groups in a region or regions, for all properties use user_groups + +## Overview + + + + + + + +
Nameuser_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::UserGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the user group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_groups in a region. +```sql +SELECT +region, +user_group_id +FROM aws.elasticache.user_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_groups_list_only resource, see user_groups + diff --git a/website/docs/services/elasticache/user_tags/index.md b/website/docs/services/elasticache/user_tags/index.md new file mode 100644 index 0000000..f2f32ca --- /dev/null +++ b/website/docs/services/elasticache/user_tags/index.md @@ -0,0 +1,93 @@ +--- +title: user_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_tags + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for users in a region + +## Overview + + + + + + + +
Nameuser_tags
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::User
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIndicates the user status. Can be "active", "modifying" or "deleting".
stringThe ID of the user.
stringThe username of the user.
stringThe target cache engine for the user.
stringAccess permissions string used for this user account.
booleanIndicates a password is not required for this user account.
arrayPasswords used for this user account. You can create up to two passwords for each user.
stringThe Amazon Resource Name (ARN) of the user account.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all users in a region. +```sql +SELECT +region, +status, +user_id, +user_name, +engine, +access_string, +no_password_required, +passwords, +arn, +authentication_mode, +tag_key, +tag_value +FROM aws.elasticache.user_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_tags resource, see users + diff --git a/website/docs/services/elasticache/users/index.md b/website/docs/services/elasticache/users/index.md new file mode 100644 index 0000000..aab5671 --- /dev/null +++ b/website/docs/services/elasticache/users/index.md @@ -0,0 +1,269 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a user resource or lists users in a region + +## Overview + + + + + + + +
Nameusers
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::User
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIndicates the user status. Can be "active", "modifying" or "deleting".
stringThe ID of the user.
stringThe username of the user.
stringThe target cache engine for the user.
stringAccess permissions string used for this user account.
booleanIndicates a password is not required for this user account.
arrayPasswords used for this user account. You can create up to two passwords for each user.
stringThe Amazon Resource Name (ARN) of the user account.
object
arrayAn array of key-value pairs to apply to this user.
stringAWS region.
+ +For more information, see AWS::ElastiCache::User. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all users in a region. +```sql +SELECT +region, +status, +user_id, +user_name, +engine, +access_string, +no_password_required, +passwords, +arn, +authentication_mode, +tags +FROM aws.elasticache.users +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user. +```sql +SELECT +region, +status, +user_id, +user_name, +engine, +access_string, +no_password_required, +passwords, +arn, +authentication_mode, +tags +FROM aws.elasticache.users +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.users ( + UserId, + UserName, + Engine, + region +) +SELECT +'{{ UserId }}', + '{{ UserName }}', + '{{ Engine }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticache.users ( + UserId, + UserName, + Engine, + AccessString, + NoPasswordRequired, + Passwords, + AuthenticationMode, + Tags, + region +) +SELECT + '{{ UserId }}', + '{{ UserName }}', + '{{ Engine }}', + '{{ AccessString }}', + '{{ NoPasswordRequired }}', + '{{ Passwords }}', + '{{ AuthenticationMode }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user + props: + - name: UserId + value: '{{ UserId }}' + - name: UserName + value: '{{ UserName }}' + - name: Engine + value: '{{ Engine }}' + - name: AccessString + value: '{{ AccessString }}' + - name: NoPasswordRequired + value: '{{ NoPasswordRequired }}' + - name: Passwords + value: + - '{{ Passwords[0] }}' + - name: AuthenticationMode + value: + Type: '{{ Type }}' + Passwords: + - '{{ Passwords[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticache.users +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +elasticache:DescribeUsers, +elasticache:ListTagsForResource +``` + +### Update +```json +elasticache:ModifyUser, +elasticache:DescribeUsers, +elasticache:ListTagsForResource, +elasticache:AddTagsToResource, +elasticache:RemoveTagsFromResource +``` + +### Delete +```json +elasticache:DeleteUser, +elasticache:DescribeUsers +``` + +### List +```json +elasticache:DescribeUsers, +elasticache:ListTagsForResource +``` diff --git a/website/docs/services/elasticache/users_list_only/index.md b/website/docs/services/elasticache/users_list_only/index.md new file mode 100644 index 0000000..387d69b --- /dev/null +++ b/website/docs/services/elasticache/users_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - users_list_only + - elasticache + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists users in a region or regions, for all properties use users + +## Overview + + + + + + + +
Nameusers_list_only
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::User
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the user.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all users in a region. +```sql +SELECT +region, +user_id +FROM aws.elasticache.users_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the users_list_only resource, see users + diff --git a/website/docs/services/elasticbeanstalk/application_versions/index.md b/website/docs/services/elasticbeanstalk/application_versions/index.md new file mode 100644 index 0000000..dc8611f --- /dev/null +++ b/website/docs/services/elasticbeanstalk/application_versions/index.md @@ -0,0 +1,218 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application_version resource or lists application_versions in a region + +## Overview + + + + + + + +
Nameapplication_versions
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::ApplicationVersion
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the Elastic Beanstalk application that is associated with this application version.
stringA description of this application version.
objectThe Amazon S3 bucket and key that identify the location of the source bundle for this version.
stringAWS region.
+ +For more information, see AWS::ElasticBeanstalk::ApplicationVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all application_versions in a region. +```sql +SELECT +region, +id, +application_name, +description, +source_bundle +FROM aws.elasticbeanstalk.application_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application_version. +```sql +SELECT +region, +id, +application_name, +description, +source_bundle +FROM aws.elasticbeanstalk.application_versions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticbeanstalk.application_versions ( + ApplicationName, + SourceBundle, + region +) +SELECT +'{{ ApplicationName }}', + '{{ SourceBundle }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticbeanstalk.application_versions ( + ApplicationName, + Description, + SourceBundle, + region +) +SELECT + '{{ ApplicationName }}', + '{{ Description }}', + '{{ SourceBundle }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application_version + props: + - name: ApplicationName + value: '{{ ApplicationName }}' + - name: Description + value: '{{ Description }}' + - name: SourceBundle + value: + S3Bucket: '{{ S3Bucket }}' + S3Key: '{{ S3Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticbeanstalk.application_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +elasticbeanstalk:DescribeApplicationVersions +``` + +### Update +```json +elasticbeanstalk:UpdateApplicationVersion +``` + +### Delete +```json +elasticbeanstalk:DeleteApplicationVersion +``` + +### List +```json +elasticbeanstalk:DescribeApplicationVersions +``` diff --git a/website/docs/services/elasticbeanstalk/application_versions_list_only/index.md b/website/docs/services/elasticbeanstalk/application_versions_list_only/index.md new file mode 100644 index 0000000..0ca0843 --- /dev/null +++ b/website/docs/services/elasticbeanstalk/application_versions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: application_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - application_versions_list_only + - elasticbeanstalk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists application_versions in a region or regions, for all properties use application_versions + +## Overview + + + + + + + +
Nameapplication_versions_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::ApplicationVersion
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe name of the Elastic Beanstalk application that is associated with this application version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all application_versions in a region. +```sql +SELECT +region, +application_name, +id +FROM aws.elasticbeanstalk.application_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_versions_list_only resource, see application_versions + diff --git a/website/docs/services/elasticbeanstalk/applications/index.md b/website/docs/services/elasticbeanstalk/applications/index.md new file mode 100644 index 0000000..d5ac506 --- /dev/null +++ b/website/docs/services/elasticbeanstalk/applications/index.md @@ -0,0 +1,223 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionThe AWS::ElasticBeanstalk::Application resource specifies an Elastic Beanstalk application.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
stringYour description of the application.
objectSpecifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
stringAWS region.
+ +For more information, see AWS::ElasticBeanstalk::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +application_name, +description, +resource_lifecycle_config +FROM aws.elasticbeanstalk.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +application_name, +description, +resource_lifecycle_config +FROM aws.elasticbeanstalk.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticbeanstalk.applications ( + ApplicationName, + Description, + ResourceLifecycleConfig, + region +) +SELECT +'{{ ApplicationName }}', + '{{ Description }}', + '{{ ResourceLifecycleConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticbeanstalk.applications ( + ApplicationName, + Description, + ResourceLifecycleConfig, + region +) +SELECT + '{{ ApplicationName }}', + '{{ Description }}', + '{{ ResourceLifecycleConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: ApplicationName + value: '{{ ApplicationName }}' + - name: Description + value: '{{ Description }}' + - name: ResourceLifecycleConfig + value: + ServiceRole: '{{ ServiceRole }}' + VersionLifecycleConfig: + MaxAgeRule: + DeleteSourceFromS3: '{{ DeleteSourceFromS3 }}' + Enabled: '{{ Enabled }}' + MaxAgeInDays: '{{ MaxAgeInDays }}' + MaxCountRule: + DeleteSourceFromS3: '{{ DeleteSourceFromS3 }}' + Enabled: '{{ Enabled }}' + MaxCount: '{{ MaxCount }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticbeanstalk.applications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +elasticbeanstalk:CreateApplication +``` + +### Read +```json +elasticbeanstalk:DescribeApplications +``` + +### Update +```json +elasticbeanstalk:UpdateApplication, +elasticbeanstalk:UpdateApplicationResourceLifecycle +``` + +### Delete +```json +elasticbeanstalk:DeleteApplication +``` + +### List +```json +elasticbeanstalk:DescribeApplications +``` diff --git a/website/docs/services/elasticbeanstalk/applications_list_only/index.md b/website/docs/services/elasticbeanstalk/applications_list_only/index.md new file mode 100644 index 0000000..b215876 --- /dev/null +++ b/website/docs/services/elasticbeanstalk/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - elasticbeanstalk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionThe AWS::ElasticBeanstalk::Application resource specifies an Elastic Beanstalk application.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_name +FROM aws.elasticbeanstalk.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/elasticbeanstalk/configuration_templates/index.md b/website/docs/services/elasticbeanstalk/configuration_templates/index.md new file mode 100644 index 0000000..7bc6d7e --- /dev/null +++ b/website/docs/services/elasticbeanstalk/configuration_templates/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configuration_template resource or lists configuration_templates in a region + +## Overview + + + + + + + +
Nameconfiguration_templates
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Elastic Beanstalk application to associate with this configuration template.
stringAn optional description for this configuration.
stringThe ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.
arrayOption values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide.
stringThe Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide.
stringThe name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide.
You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.
Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
objectAn Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in OptionSettings override any values obtained from the SourceConfiguration.
You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.
Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
stringThe name of the configuration template
stringAWS region.
+ +For more information, see AWS::ElasticBeanstalk::ConfigurationTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configuration_templates in a region. +```sql +SELECT +region, +application_name, +description, +environment_id, +option_settings, +platform_arn, +solution_stack_name, +source_configuration, +template_name +FROM aws.elasticbeanstalk.configuration_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual configuration_template. +```sql +SELECT +region, +application_name, +description, +environment_id, +option_settings, +platform_arn, +solution_stack_name, +source_configuration, +template_name +FROM aws.elasticbeanstalk.configuration_templates +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configuration_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticbeanstalk.configuration_templates ( + ApplicationName, + region +) +SELECT +'{{ ApplicationName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticbeanstalk.configuration_templates ( + ApplicationName, + Description, + EnvironmentId, + OptionSettings, + PlatformArn, + SolutionStackName, + SourceConfiguration, + region +) +SELECT + '{{ ApplicationName }}', + '{{ Description }}', + '{{ EnvironmentId }}', + '{{ OptionSettings }}', + '{{ PlatformArn }}', + '{{ SolutionStackName }}', + '{{ SourceConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configuration_template + props: + - name: ApplicationName + value: '{{ ApplicationName }}' + - name: Description + value: '{{ Description }}' + - name: EnvironmentId + value: '{{ EnvironmentId }}' + - name: OptionSettings + value: + - Namespace: '{{ Namespace }}' + OptionName: '{{ OptionName }}' + ResourceName: '{{ ResourceName }}' + Value: '{{ Value }}' + - name: PlatformArn + value: '{{ PlatformArn }}' + - name: SolutionStackName + value: '{{ SolutionStackName }}' + - name: SourceConfiguration + value: + ApplicationName: '{{ ApplicationName }}' + TemplateName: '{{ TemplateName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticbeanstalk.configuration_templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the configuration_templates resource, the following permissions are required: + +### Create +```json +elasticbeanstalk:CreateConfigurationTemplate +``` + +### Read +```json +elasticbeanstalk:DescribeConfigurationSettings +``` + +### Update +```json +elasticbeanstalk:UpdateConfigurationTemplate +``` + +### Delete +```json +elasticbeanstalk:DeleteConfigurationTemplate, +elasticbeanstalk:DescribeConfigurationSettings +``` + +### List +```json +elasticbeanstalk:DescribeApplications +``` diff --git a/website/docs/services/elasticbeanstalk/configuration_templates_list_only/index.md b/website/docs/services/elasticbeanstalk/configuration_templates_list_only/index.md new file mode 100644 index 0000000..ea43a13 --- /dev/null +++ b/website/docs/services/elasticbeanstalk/configuration_templates_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: configuration_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_templates_list_only + - elasticbeanstalk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_templates in a region or regions, for all properties use configuration_templates + +## Overview + + + + + + + +
Nameconfiguration_templates_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the Elastic Beanstalk application to associate with this configuration template.
stringThe name of the configuration template
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_templates in a region. +```sql +SELECT +region, +application_name, +template_name +FROM aws.elasticbeanstalk.configuration_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_templates_list_only resource, see configuration_templates + diff --git a/website/docs/services/elasticbeanstalk/environment_tags/index.md b/website/docs/services/elasticbeanstalk/environment_tags/index.md new file mode 100644 index 0000000..b524bf3 --- /dev/null +++ b/website/docs/services/elasticbeanstalk/environment_tags/index.md @@ -0,0 +1,99 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - elasticbeanstalk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + + + +
Nameenvironment_tags
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::Environment
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the custom platform to use with the environment.
stringThe name of the application that is associated with this environment.
stringYour description for this environment.
stringA unique name for the environment.
stringThe Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
objectSpecifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
stringThe name of the application version to deploy.
string
arrayKey-value pairs defining configuration options for this environment, such as the instance type.
stringThe name of the Elastic Beanstalk configuration template to use with the environment.
stringThe name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
stringIf specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +platform_arn, +application_name, +description, +environment_name, +operations_role, +tier, +version_label, +endpoint_url, +option_settings, +template_name, +solution_stack_name, +cname_prefix, +tag_key, +tag_value +FROM aws.elasticbeanstalk.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + diff --git a/website/docs/services/elasticbeanstalk/environments/index.md b/website/docs/services/elasticbeanstalk/environments/index.md new file mode 100644 index 0000000..fa62ad6 --- /dev/null +++ b/website/docs/services/elasticbeanstalk/environments/index.md @@ -0,0 +1,302 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment resource or lists environments in a region + +## Overview + + + + + + + +
Nameenvironments
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::Environment
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the custom platform to use with the environment.
stringThe name of the application that is associated with this environment.
stringYour description for this environment.
stringA unique name for the environment.
stringThe Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
objectSpecifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
stringThe name of the application version to deploy.
string
arrayKey-value pairs defining configuration options for this environment, such as the instance type.
stringThe name of the Elastic Beanstalk configuration template to use with the environment.
stringThe name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
stringIf specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
arraySpecifies the tags applied to resources in the environment.
stringAWS region.
+ +For more information, see AWS::ElasticBeanstalk::Environment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environments in a region. +```sql +SELECT +region, +platform_arn, +application_name, +description, +environment_name, +operations_role, +tier, +version_label, +endpoint_url, +option_settings, +template_name, +solution_stack_name, +cname_prefix, +tags +FROM aws.elasticbeanstalk.environments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment. +```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.environments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticbeanstalk.environments ( + ApplicationName, + region +) +SELECT +'{{ ApplicationName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticbeanstalk.environments ( + PlatformArn, + ApplicationName, + Description, + EnvironmentName, + OperationsRole, + Tier, + VersionLabel, + OptionSettings, + TemplateName, + SolutionStackName, + CNAMEPrefix, + Tags, + region +) +SELECT + '{{ PlatformArn }}', + '{{ ApplicationName }}', + '{{ Description }}', + '{{ EnvironmentName }}', + '{{ OperationsRole }}', + '{{ Tier }}', + '{{ VersionLabel }}', + '{{ OptionSettings }}', + '{{ TemplateName }}', + '{{ SolutionStackName }}', + '{{ CNAMEPrefix }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment + props: + - name: PlatformArn + value: '{{ PlatformArn }}' + - name: ApplicationName + value: '{{ ApplicationName }}' + - name: Description + value: '{{ Description }}' + - name: EnvironmentName + value: '{{ EnvironmentName }}' + - name: OperationsRole + value: '{{ OperationsRole }}' + - name: Tier + value: + Type: '{{ Type }}' + Version: '{{ Version }}' + Name: '{{ Name }}' + - name: VersionLabel + value: '{{ VersionLabel }}' + - name: OptionSettings + value: + - ResourceName: '{{ ResourceName }}' + Value: '{{ Value }}' + Namespace: '{{ Namespace }}' + OptionName: '{{ OptionName }}' + - name: TemplateName + value: '{{ TemplateName }}' + - name: SolutionStackName + value: '{{ SolutionStackName }}' + - name: CNAMEPrefix + value: '{{ CNAMEPrefix }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticbeanstalk.environments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Read +```json +elasticbeanstalk:DescribeEnvironments, +elasticbeanstalk:DescribeConfigurationSettings, +elasticbeanstalk:ListTagsForResource +``` + +### Create +```json +elasticbeanstalk:DescribeEnvironments, +elasticbeanstalk:CreateEnvironment, +elasticbeanstalk:AddTags, +elasticbeanstalk:ListTagsForResource, +iam:PassRole +``` + +### Update +```json +elasticbeanstalk:DescribeEnvironments, +elasticbeanstalk:UpdateEnvironment, +elasticbeanstalk:AssociateEnvironmentOperationsRole, +elasticbeanstalk:DisassociateEnvironmentOperationsRole, +elasticbeanstalk:AddTags, +elasticbeanstalk:ListTagsForResource, +elasticbeanstalk:RemoveTags, +s3:GetBucketLocation, +s3:GetBucketPolicy, +s3:ListBucket, +s3:PutBucketPolicy, +iam:PassRole +``` + +### List +```json +elasticbeanstalk:DescribeEnvironments, +elasticbeanstalk:ListTagsForResource +``` + +### Delete +```json +elasticbeanstalk:DescribeEnvironments, +elasticbeanstalk:TerminateEnvironment +``` diff --git a/website/docs/services/elasticbeanstalk/environments_list_only/index.md b/website/docs/services/elasticbeanstalk/environments_list_only/index.md new file mode 100644 index 0000000..89ccd90 --- /dev/null +++ b/website/docs/services/elasticbeanstalk/environments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::Environment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique name for the environment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +environment_name +FROM aws.elasticbeanstalk.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + diff --git a/website/docs/services/elasticbeanstalk/index.md b/website/docs/services/elasticbeanstalk/index.md new file mode 100644 index 0000000..a8d6f4b --- /dev/null +++ b/website/docs/services/elasticbeanstalk/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The elasticbeanstalk service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/elasticloadbalancingv2/index.md b/website/docs/services/elasticloadbalancingv2/index.md new file mode 100644 index 0000000..a6718fd --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/index.md @@ -0,0 +1,50 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The elasticloadbalancingv2 service documentation. + +:::info Service Summary + +
+
+total resources: 15
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/elasticloadbalancingv2/listener_rules/index.md b/website/docs/services/elasticloadbalancingv2/listener_rules/index.md new file mode 100644 index 0000000..f551b97 --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/listener_rules/index.md @@ -0,0 +1,296 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a listener_rule resource or lists 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.
For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the listener.
string
arrayThe actions.
The rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action.
integerThe rule priority. A listener can't have multiple rules with the same priority.
If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update.
arrayThe conditions.
The rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. A rule can also optionally include one or more of each of the following conditions: http-header and query-string.
boolean
stringAWS region.
+ +For more information, see AWS::ElasticLoadBalancingV2::ListenerRule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all listener_rules in a region. +```sql +SELECT +region, +listener_arn, +rule_arn, +actions, +priority, +conditions, +is_default +FROM aws.elasticloadbalancingv2.listener_rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual listener_rule. +```sql +SELECT +region, +listener_arn, +rule_arn, +actions, +priority, +conditions, +is_default +FROM aws.elasticloadbalancingv2.listener_rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new listener_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.listener_rules ( + Actions, + Priority, + Conditions, + region +) +SELECT +'{{ Actions }}', + '{{ Priority }}', + '{{ Conditions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.listener_rules ( + ListenerArn, + Actions, + Priority, + Conditions, + region +) +SELECT + '{{ ListenerArn }}', + '{{ Actions }}', + '{{ Priority }}', + '{{ Conditions }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: listener_rule + props: + - name: ListenerArn + value: '{{ ListenerArn }}' + - name: Actions + value: + - Order: '{{ Order }}' + TargetGroupArn: '{{ TargetGroupArn }}' + FixedResponseConfig: + ContentType: '{{ ContentType }}' + StatusCode: '{{ StatusCode }}' + MessageBody: '{{ MessageBody }}' + AuthenticateCognitoConfig: + OnUnauthenticatedRequest: '{{ OnUnauthenticatedRequest }}' + UserPoolClientId: '{{ UserPoolClientId }}' + UserPoolDomain: '{{ UserPoolDomain }}' + SessionTimeout: '{{ SessionTimeout }}' + Scope: '{{ Scope }}' + SessionCookieName: '{{ SessionCookieName }}' + UserPoolArn: '{{ UserPoolArn }}' + AuthenticationRequestExtraParams: {} + Type: '{{ Type }}' + RedirectConfig: + Path: '{{ Path }}' + Query: '{{ Query }}' + Port: '{{ Port }}' + Host: '{{ Host }}' + Protocol: '{{ Protocol }}' + StatusCode: '{{ StatusCode }}' + ForwardConfig: + TargetGroupStickinessConfig: + Enabled: '{{ Enabled }}' + DurationSeconds: '{{ DurationSeconds }}' + TargetGroups: + - TargetGroupArn: '{{ TargetGroupArn }}' + Weight: '{{ Weight }}' + AuthenticateOidcConfig: + OnUnauthenticatedRequest: '{{ OnUnauthenticatedRequest }}' + TokenEndpoint: '{{ TokenEndpoint }}' + SessionTimeout: '{{ SessionTimeout }}' + Scope: '{{ Scope }}' + Issuer: '{{ Issuer }}' + ClientSecret: '{{ ClientSecret }}' + UserInfoEndpoint: '{{ UserInfoEndpoint }}' + ClientId: '{{ ClientId }}' + AuthorizationEndpoint: '{{ AuthorizationEndpoint }}' + SessionCookieName: '{{ SessionCookieName }}' + UseExistingClientSecret: '{{ UseExistingClientSecret }}' + AuthenticationRequestExtraParams: {} + - name: Priority + value: '{{ Priority }}' + - name: Conditions + value: + - Field: '{{ Field }}' + Values: + - '{{ Values[0] }}' + HttpRequestMethodConfig: + Values: + - '{{ Values[0] }}' + PathPatternConfig: + Values: + - '{{ Values[0] }}' + HttpHeaderConfig: + Values: + - '{{ Values[0] }}' + HttpHeaderName: '{{ HttpHeaderName }}' + SourceIpConfig: + Values: + - '{{ Values[0] }}' + HostHeaderConfig: + Values: + - '{{ Values[0] }}' + QueryStringConfig: + Values: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticloadbalancingv2.listener_rules +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +elasticloadbalancing:DeleteRule, +elasticloadbalancing:DescribeRules +``` + +### List +```json +elasticloadbalancing:DescribeRules +``` + +### Read +```json +elasticloadbalancing:DescribeRules +``` + +### Update +```json +elasticloadbalancing:ModifyRule, +elasticloadbalancing:SetRulePriorities, +elasticloadbalancing:DescribeRules +``` diff --git a/website/docs/services/elasticloadbalancingv2/listener_rules_list_only/index.md b/website/docs/services/elasticloadbalancingv2/listener_rules_list_only/index.md new file mode 100644 index 0000000..7508760 --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/listener_rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: listener_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - listener_rules_list_only + - elasticloadbalancingv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists listener_rules in a region or regions, for all properties use listener_rules + +## Overview + + + + + + + +
Namelistener_rules_list_only
TypeResource
DescriptionSpecifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.
For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all listener_rules in a region. +```sql +SELECT +region, +rule_arn +FROM aws.elasticloadbalancingv2.listener_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the listener_rules_list_only resource, see listener_rules + diff --git a/website/docs/services/elasticloadbalancingv2/listeners/index.md b/website/docs/services/elasticloadbalancingv2/listeners/index.md new file mode 100644 index 0000000..09f4dea --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/listeners/index.md @@ -0,0 +1,314 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a listener resource or lists listeners in a region + +## Overview + + + + + + + +
Namelisteners
TypeResource
DescriptionSpecifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectThe mutual authentication configuration information.
arrayThe listener attributes.
array[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
string[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.
Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.
For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*.
stringThe Amazon Resource Name (ARN) of the load balancer.
arrayThe actions for the default rule. You cannot define a condition for a default rule.
To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html).
integerThe port on which the load balancer is listening. You can't specify a port for a Gateway Load Balancer.
arrayThe default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.
To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html).
stringThe protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load Balancer.
stringAWS region.
+ +For more information, see AWS::ElasticLoadBalancingV2::Listener. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all listeners in a region. +```sql +SELECT +region, +listener_arn, +mutual_authentication, +listener_attributes, +alpn_policy, +ssl_policy, +load_balancer_arn, +default_actions, +port, +certificates, +protocol +FROM aws.elasticloadbalancingv2.listeners +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual listener. +```sql +SELECT +region, +listener_arn, +mutual_authentication, +listener_attributes, +alpn_policy, +ssl_policy, +load_balancer_arn, +default_actions, +port, +certificates, +protocol +FROM aws.elasticloadbalancingv2.listeners +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new listener resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.listeners ( + LoadBalancerArn, + DefaultActions, + region +) +SELECT +'{{ LoadBalancerArn }}', + '{{ DefaultActions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.listeners ( + MutualAuthentication, + ListenerAttributes, + AlpnPolicy, + SslPolicy, + LoadBalancerArn, + DefaultActions, + Port, + Certificates, + Protocol, + region +) +SELECT + '{{ MutualAuthentication }}', + '{{ ListenerAttributes }}', + '{{ AlpnPolicy }}', + '{{ SslPolicy }}', + '{{ LoadBalancerArn }}', + '{{ DefaultActions }}', + '{{ Port }}', + '{{ Certificates }}', + '{{ Protocol }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: listener + props: + - name: MutualAuthentication + value: + IgnoreClientCertificateExpiry: '{{ IgnoreClientCertificateExpiry }}' + Mode: '{{ Mode }}' + TrustStoreArn: '{{ TrustStoreArn }}' + AdvertiseTrustStoreCaNames: '{{ AdvertiseTrustStoreCaNames }}' + - name: ListenerAttributes + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: AlpnPolicy + value: + - '{{ AlpnPolicy[0] }}' + - name: SslPolicy + value: '{{ SslPolicy }}' + - name: LoadBalancerArn + value: '{{ LoadBalancerArn }}' + - name: DefaultActions + value: + - Order: '{{ Order }}' + TargetGroupArn: '{{ TargetGroupArn }}' + FixedResponseConfig: + ContentType: '{{ ContentType }}' + StatusCode: '{{ StatusCode }}' + MessageBody: '{{ MessageBody }}' + AuthenticateCognitoConfig: + OnUnauthenticatedRequest: '{{ OnUnauthenticatedRequest }}' + UserPoolClientId: '{{ UserPoolClientId }}' + UserPoolDomain: '{{ UserPoolDomain }}' + SessionTimeout: '{{ SessionTimeout }}' + Scope: '{{ Scope }}' + SessionCookieName: '{{ SessionCookieName }}' + UserPoolArn: '{{ UserPoolArn }}' + AuthenticationRequestExtraParams: {} + Type: '{{ Type }}' + RedirectConfig: + Path: '{{ Path }}' + Query: '{{ Query }}' + Port: '{{ Port }}' + Host: '{{ Host }}' + Protocol: '{{ Protocol }}' + StatusCode: '{{ StatusCode }}' + ForwardConfig: + TargetGroupStickinessConfig: + Enabled: '{{ Enabled }}' + DurationSeconds: '{{ DurationSeconds }}' + TargetGroups: + - TargetGroupArn: '{{ TargetGroupArn }}' + Weight: '{{ Weight }}' + AuthenticateOidcConfig: + OnUnauthenticatedRequest: '{{ OnUnauthenticatedRequest }}' + TokenEndpoint: '{{ TokenEndpoint }}' + SessionTimeout: '{{ SessionTimeout }}' + Scope: '{{ Scope }}' + Issuer: '{{ Issuer }}' + ClientSecret: '{{ ClientSecret }}' + UserInfoEndpoint: '{{ UserInfoEndpoint }}' + ClientId: '{{ ClientId }}' + AuthorizationEndpoint: '{{ AuthorizationEndpoint }}' + SessionCookieName: '{{ SessionCookieName }}' + UseExistingClientSecret: '{{ UseExistingClientSecret }}' + AuthenticationRequestExtraParams: {} + - name: Port + value: '{{ Port }}' + - name: Certificates + value: + - CertificateArn: '{{ CertificateArn }}' + - name: Protocol + value: '{{ Protocol }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticloadbalancingv2.listeners +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the listeners resource, the following permissions are required: + +### Read +```json +elasticloadbalancing:DescribeListeners, +elasticloadbalancing:DescribeListenerAttributes +``` + +### Create +```json +elasticloadbalancing:CreateListener, +elasticloadbalancing:DescribeListeners, +cognito-idp:DescribeUserPoolClient, +elasticloadbalancing:ModifyListenerAttributes +``` + +### Update +```json +elasticloadbalancing:ModifyListener, +elasticloadbalancing:DescribeListeners, +cognito-idp:DescribeUserPoolClient, +elasticloadbalancing:ModifyListenerAttributes +``` + +### List +```json +elasticloadbalancing:DescribeListeners +``` + +### Delete +```json +elasticloadbalancing:DeleteListener, +elasticloadbalancing:DescribeListeners +``` diff --git a/website/docs/services/elasticloadbalancingv2/listeners_list_only/index.md b/website/docs/services/elasticloadbalancingv2/listeners_list_only/index.md new file mode 100644 index 0000000..f05a2ec --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/listeners_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: listeners_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - listeners_list_only + - elasticloadbalancingv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists listeners in a region or regions, for all properties use listeners + +## Overview + + + + + + + +
Namelisteners_list_only
TypeResource
DescriptionSpecifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all listeners in a region. +```sql +SELECT +region, +listener_arn +FROM aws.elasticloadbalancingv2.listeners_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the listeners_list_only resource, see listeners + diff --git a/website/docs/services/elasticloadbalancingv2/load_balancer_tags/index.md b/website/docs/services/elasticloadbalancingv2/load_balancer_tags/index.md new file mode 100644 index 0000000..eedeee2 --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/load_balancer_tags/index.md @@ -0,0 +1,107 @@ +--- +title: load_balancer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancer_tags + - elasticloadbalancingv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for load_balancers in a region + +## Overview + + + + + + + +
Nameload_balancer_tags
TypeResource
DescriptionSpecifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address type. Internal load balancers must use ipv4.
[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).
Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors.
[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).
string[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.
array[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
arrayThe load balancer attributes.
object
stringThe nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
The default is an Internet-facing load balancer.
You can't specify a scheme for a Gateway Load Balancer.
string
stringThe name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
string
string
arrayThe IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
stringThe type of load balancer. The default is application.
string
string
arrayThe IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.
stringIndicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all load_balancers in a region. +```sql +SELECT +region, +ip_address_type, +enable_prefix_for_ipv6_source_nat, +security_groups, +load_balancer_attributes, +minimum_load_balancer_capacity, +scheme, +dns_name, +name, +load_balancer_name, +load_balancer_full_name, +subnets, +type, +canonical_hosted_zone_id, +load_balancer_arn, +subnet_mappings, +enforce_security_group_inbound_rules_on_private_link_traffic, +tag_key, +tag_value +FROM aws.elasticloadbalancingv2.load_balancer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the load_balancer_tags resource, see load_balancers + diff --git a/website/docs/services/elasticloadbalancingv2/load_balancers/index.md b/website/docs/services/elasticloadbalancingv2/load_balancers/index.md new file mode 100644 index 0000000..329279a --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/load_balancers/index.md @@ -0,0 +1,333 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a load_balancer resource or lists load_balancers in a region + +## Overview + + + + + + + +
Nameload_balancers
TypeResource
DescriptionSpecifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address type. Internal load balancers must use ipv4.
[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).
Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors.
[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).
string[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.
array[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
arrayThe load balancer attributes.
object
stringThe nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
The default is an Internet-facing load balancer.
You can't specify a scheme for a Gateway Load Balancer.
string
stringThe name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
string
string
arrayThe IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
stringThe type of load balancer. The default is application.
string
arrayThe tags to assign to the load balancer.
string
arrayThe IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.
stringIndicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
stringAWS region.
+ +For more information, see AWS::ElasticLoadBalancingV2::LoadBalancer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all load_balancers in a region. +```sql +SELECT +region, +ip_address_type, +enable_prefix_for_ipv6_source_nat, +security_groups, +load_balancer_attributes, +minimum_load_balancer_capacity, +scheme, +dns_name, +name, +load_balancer_name, +load_balancer_full_name, +subnets, +type, +canonical_hosted_zone_id, +tags, +load_balancer_arn, +subnet_mappings, +enforce_security_group_inbound_rules_on_private_link_traffic +FROM aws.elasticloadbalancingv2.load_balancers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual load_balancer. +```sql +SELECT +region, +ip_address_type, +enable_prefix_for_ipv6_source_nat, +security_groups, +load_balancer_attributes, +minimum_load_balancer_capacity, +scheme, +dns_name, +name, +load_balancer_name, +load_balancer_full_name, +subnets, +type, +canonical_hosted_zone_id, +tags, +load_balancer_arn, +subnet_mappings, +enforce_security_group_inbound_rules_on_private_link_traffic +FROM aws.elasticloadbalancingv2.load_balancers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new load_balancer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.load_balancers ( + IpAddressType, + EnablePrefixForIpv6SourceNat, + SecurityGroups, + LoadBalancerAttributes, + MinimumLoadBalancerCapacity, + Scheme, + Name, + Subnets, + Type, + Tags, + SubnetMappings, + EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic, + region +) +SELECT +'{{ IpAddressType }}', + '{{ EnablePrefixForIpv6SourceNat }}', + '{{ SecurityGroups }}', + '{{ LoadBalancerAttributes }}', + '{{ MinimumLoadBalancerCapacity }}', + '{{ Scheme }}', + '{{ Name }}', + '{{ Subnets }}', + '{{ Type }}', + '{{ Tags }}', + '{{ SubnetMappings }}', + '{{ EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.load_balancers ( + IpAddressType, + EnablePrefixForIpv6SourceNat, + SecurityGroups, + LoadBalancerAttributes, + MinimumLoadBalancerCapacity, + Scheme, + Name, + Subnets, + Type, + Tags, + SubnetMappings, + EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic, + region +) +SELECT + '{{ IpAddressType }}', + '{{ EnablePrefixForIpv6SourceNat }}', + '{{ SecurityGroups }}', + '{{ LoadBalancerAttributes }}', + '{{ MinimumLoadBalancerCapacity }}', + '{{ Scheme }}', + '{{ Name }}', + '{{ Subnets }}', + '{{ Type }}', + '{{ Tags }}', + '{{ SubnetMappings }}', + '{{ EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: load_balancer + props: + - name: IpAddressType + value: '{{ IpAddressType }}' + - name: EnablePrefixForIpv6SourceNat + value: '{{ EnablePrefixForIpv6SourceNat }}' + - name: SecurityGroups + value: + - '{{ SecurityGroups[0] }}' + - name: LoadBalancerAttributes + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: MinimumLoadBalancerCapacity + value: + CapacityUnits: '{{ CapacityUnits }}' + - name: Scheme + value: '{{ Scheme }}' + - name: Name + value: '{{ Name }}' + - name: Subnets + value: + - '{{ Subnets[0] }}' + - name: Type + value: '{{ Type }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: SubnetMappings + value: + - SubnetId: '{{ SubnetId }}' + AllocationId: '{{ AllocationId }}' + PrivateIPv4Address: '{{ PrivateIPv4Address }}' + IPv6Address: '{{ IPv6Address }}' + SourceNatIpv6Prefix: '{{ SourceNatIpv6Prefix }}' + - name: EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic + value: '{{ EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticloadbalancingv2.load_balancers +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +elasticloadbalancing:DescribeLoadBalancers, +elasticloadbalancing:DeleteLoadBalancer +``` + +### List +```json +elasticloadbalancing:DescribeLoadBalancers +``` + +### Read +```json +elasticloadbalancing:DescribeLoadBalancers, +elasticloadbalancing:DescribeLoadBalancerAttributes, +elasticloadbalancing:DescribeCapacityReservation, +elasticloadbalancing:DescribeTags +``` + +### Update +```json +elasticloadbalancing:ModifyLoadBalancerAttributes, +elasticloadbalancing:ModifyCapacityReservation, +elasticloadbalancing:SetSubnets, +elasticloadbalancing:SetIpAddressType, +elasticloadbalancing:SetSecurityGroups, +elasticloadbalancing:AddTags, +elasticloadbalancing:RemoveTags +``` diff --git a/website/docs/services/elasticloadbalancingv2/load_balancers_list_only/index.md b/website/docs/services/elasticloadbalancingv2/load_balancers_list_only/index.md new file mode 100644 index 0000000..bead886 --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/load_balancers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: load_balancers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancers_list_only + - elasticloadbalancingv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists load_balancers in a region or regions, for all properties use load_balancers + +## Overview + + + + + + + +
Nameload_balancers_list_only
TypeResource
DescriptionSpecifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all load_balancers in a region. +```sql +SELECT +region, +load_balancer_arn +FROM aws.elasticloadbalancingv2.load_balancers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the load_balancers_list_only resource, see load_balancers + diff --git a/website/docs/services/elasticloadbalancingv2/target_group_tags/index.md b/website/docs/services/elasticloadbalancingv2/target_group_tags/index.md new file mode 100644 index 0000000..0033eb4 --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/target_group_tags/index.md @@ -0,0 +1,119 @@ +--- +title: target_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - target_group_tags + - elasticloadbalancingv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for target_groups in a region + +## Overview + + + + + + + +
Nametarget_group_tags
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of IP address used for this target group. The possible values are ipv4 and ipv6.
integerThe approximate amount of time, in seconds, between health checks of an individual target.
arrayThe Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
object[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
string[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
integerThe port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
arrayThe targets.
booleanIndicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
string[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
integerThe number of consecutive health check failures required before considering a target unhealthy.
integerThe amount of time, in seconds, during which no response from a target means a failed health check.
stringThe name of the target group.
stringThe identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.
stringThe full name of the target group.
integerThe number of consecutive health checks successes required before considering an unhealthy target healthy.
stringThe protocol the load balancer uses when performing health checks on targets.
arrayThe attributes.
stringThe type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
stringThe port the load balancer uses when performing health checks on targets.
stringThe ARN of the Target Group
stringThe protocol to use for routing traffic to the targets.
stringThe name of the target group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all target_groups in a region. +```sql +SELECT +region, +ip_address_type, +health_check_interval_seconds, +load_balancer_arns, +matcher, +health_check_path, +port, +targets, +health_check_enabled, +protocol_version, +unhealthy_threshold_count, +health_check_timeout_seconds, +name, +vpc_id, +target_group_full_name, +healthy_threshold_count, +health_check_protocol, +target_group_attributes, +target_type, +health_check_port, +target_group_arn, +protocol, +target_group_name, +tag_key, +tag_value +FROM aws.elasticloadbalancingv2.target_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the target_group_tags resource, see target_groups + diff --git a/website/docs/services/elasticloadbalancingv2/target_groups/index.md b/website/docs/services/elasticloadbalancingv2/target_groups/index.md new file mode 100644 index 0000000..9a0090e --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/target_groups/index.md @@ -0,0 +1,393 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a target_group resource or lists target_groups in a region + +## Overview + + + + + + + +
Nametarget_groups
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of IP address used for this target group. The possible values are ipv4 and ipv6.
integerThe approximate amount of time, in seconds, between health checks of an individual target.
arrayThe Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
object[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
string[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
integerThe port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
arrayThe targets.
booleanIndicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
string[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
integerThe number of consecutive health check failures required before considering a target unhealthy.
integerThe amount of time, in seconds, during which no response from a target means a failed health check.
stringThe name of the target group.
stringThe identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.
stringThe full name of the target group.
integerThe number of consecutive health checks successes required before considering an unhealthy target healthy.
stringThe protocol the load balancer uses when performing health checks on targets.
arrayThe attributes.
stringThe type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
stringThe port the load balancer uses when performing health checks on targets.
stringThe ARN of the Target Group
stringThe protocol to use for routing traffic to the targets.
stringThe name of the target group.
arrayThe tags.
stringAWS region.
+ +For more information, see AWS::ElasticLoadBalancingV2::TargetGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all target_groups in a region. +```sql +SELECT +region, +ip_address_type, +health_check_interval_seconds, +load_balancer_arns, +matcher, +health_check_path, +port, +targets, +health_check_enabled, +protocol_version, +unhealthy_threshold_count, +health_check_timeout_seconds, +name, +vpc_id, +target_group_full_name, +healthy_threshold_count, +health_check_protocol, +target_group_attributes, +target_type, +health_check_port, +target_group_arn, +protocol, +target_group_name, +tags +FROM aws.elasticloadbalancingv2.target_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual target_group. +```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_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new target_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.target_groups ( + IpAddressType, + HealthCheckIntervalSeconds, + Matcher, + HealthCheckPath, + Port, + Targets, + HealthCheckEnabled, + ProtocolVersion, + UnhealthyThresholdCount, + HealthCheckTimeoutSeconds, + Name, + VpcId, + HealthyThresholdCount, + HealthCheckProtocol, + TargetGroupAttributes, + TargetType, + HealthCheckPort, + Protocol, + Tags, + region +) +SELECT +'{{ IpAddressType }}', + '{{ HealthCheckIntervalSeconds }}', + '{{ Matcher }}', + '{{ HealthCheckPath }}', + '{{ Port }}', + '{{ Targets }}', + '{{ HealthCheckEnabled }}', + '{{ ProtocolVersion }}', + '{{ UnhealthyThresholdCount }}', + '{{ HealthCheckTimeoutSeconds }}', + '{{ Name }}', + '{{ VpcId }}', + '{{ HealthyThresholdCount }}', + '{{ HealthCheckProtocol }}', + '{{ TargetGroupAttributes }}', + '{{ TargetType }}', + '{{ HealthCheckPort }}', + '{{ Protocol }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.target_groups ( + IpAddressType, + HealthCheckIntervalSeconds, + Matcher, + HealthCheckPath, + Port, + Targets, + HealthCheckEnabled, + ProtocolVersion, + UnhealthyThresholdCount, + HealthCheckTimeoutSeconds, + Name, + VpcId, + HealthyThresholdCount, + HealthCheckProtocol, + TargetGroupAttributes, + TargetType, + HealthCheckPort, + Protocol, + Tags, + region +) +SELECT + '{{ IpAddressType }}', + '{{ HealthCheckIntervalSeconds }}', + '{{ Matcher }}', + '{{ HealthCheckPath }}', + '{{ Port }}', + '{{ Targets }}', + '{{ HealthCheckEnabled }}', + '{{ ProtocolVersion }}', + '{{ UnhealthyThresholdCount }}', + '{{ HealthCheckTimeoutSeconds }}', + '{{ Name }}', + '{{ VpcId }}', + '{{ HealthyThresholdCount }}', + '{{ HealthCheckProtocol }}', + '{{ TargetGroupAttributes }}', + '{{ TargetType }}', + '{{ HealthCheckPort }}', + '{{ Protocol }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: target_group + props: + - name: IpAddressType + value: '{{ IpAddressType }}' + - name: HealthCheckIntervalSeconds + value: '{{ HealthCheckIntervalSeconds }}' + - name: Matcher + value: + GrpcCode: '{{ GrpcCode }}' + HttpCode: '{{ HttpCode }}' + - name: HealthCheckPath + value: '{{ HealthCheckPath }}' + - name: Port + value: '{{ Port }}' + - name: Targets + value: + - AvailabilityZone: '{{ AvailabilityZone }}' + Id: '{{ Id }}' + Port: '{{ Port }}' + - name: HealthCheckEnabled + value: '{{ HealthCheckEnabled }}' + - name: ProtocolVersion + value: '{{ ProtocolVersion }}' + - name: UnhealthyThresholdCount + value: '{{ UnhealthyThresholdCount }}' + - name: HealthCheckTimeoutSeconds + value: '{{ HealthCheckTimeoutSeconds }}' + - name: Name + value: '{{ Name }}' + - name: VpcId + value: '{{ VpcId }}' + - name: HealthyThresholdCount + value: '{{ HealthyThresholdCount }}' + - name: HealthCheckProtocol + value: '{{ HealthCheckProtocol }}' + - name: TargetGroupAttributes + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: TargetType + value: '{{ TargetType }}' + - name: HealthCheckPort + value: '{{ HealthCheckPort }}' + - name: Protocol + value: '{{ Protocol }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticloadbalancingv2.target_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +elasticloadbalancing:DeleteTargetGroup, +elasticloadbalancing:DescribeTargetGroups +``` + +### List +```json +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/website/docs/services/elasticloadbalancingv2/target_groups_list_only/index.md b/website/docs/services/elasticloadbalancingv2/target_groups_list_only/index.md new file mode 100644 index 0000000..70d833c --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/target_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: target_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - target_groups_list_only + - elasticloadbalancingv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists target_groups in a region or regions, for all properties use target_groups + +## Overview + + + + + + + +
Nametarget_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the Target Group
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all target_groups in a region. +```sql +SELECT +region, +target_group_arn +FROM aws.elasticloadbalancingv2.target_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the target_groups_list_only resource, see target_groups + diff --git a/website/docs/services/elasticloadbalancingv2/trust_store_revocations/index.md b/website/docs/services/elasticloadbalancingv2/trust_store_revocations/index.md new file mode 100644 index 0000000..45dc557 --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/trust_store_revocations/index.md @@ -0,0 +1,207 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a trust_store_revocation resource or lists trust_store_revocations in a region + +## Overview + + + + + + + +
Nametrust_store_revocations
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStoreRevocation
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arrayThe attributes required to create a trust store revocation.
stringThe Amazon Resource Name (ARN) of the trust store.
integerThe ID associated with the revocation.
arrayThe data associated with a trust store revocation
stringAWS region.
+ +For more information, see AWS::ElasticLoadBalancingV2::TrustStoreRevocation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all trust_store_revocations in a region. +```sql +SELECT +region, +revocation_contents, +trust_store_arn, +revocation_id, +trust_store_revocations +FROM aws.elasticloadbalancingv2.trust_store_revocations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual trust_store_revocation. +```sql +SELECT +region, +revocation_contents, +trust_store_arn, +revocation_id, +trust_store_revocations +FROM aws.elasticloadbalancingv2.trust_store_revocations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new trust_store_revocation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.trust_store_revocations ( + RevocationContents, + TrustStoreArn, + region +) +SELECT +'{{ RevocationContents }}', + '{{ TrustStoreArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.trust_store_revocations ( + RevocationContents, + TrustStoreArn, + region +) +SELECT + '{{ RevocationContents }}', + '{{ TrustStoreArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: trust_store_revocation + props: + - name: RevocationContents + value: + - S3Bucket: '{{ S3Bucket }}' + S3Key: '{{ S3Key }}' + S3ObjectVersion: '{{ S3ObjectVersion }}' + RevocationType: '{{ RevocationType }}' + - name: TrustStoreArn + value: '{{ TrustStoreArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticloadbalancingv2.trust_store_revocations +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +elasticloadbalancing:DescribeTrustStoreRevocations, +elasticloadbalancing:RemoveTrustStoreRevocations +``` + +### List +```json +elasticloadbalancing:DescribeTrustStoreRevocations +``` + +### Read +```json +elasticloadbalancing:DescribeTrustStoreRevocations +``` diff --git a/website/docs/services/elasticloadbalancingv2/trust_store_revocations_list_only/index.md b/website/docs/services/elasticloadbalancingv2/trust_store_revocations_list_only/index.md new file mode 100644 index 0000000..7a99f67 --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/trust_store_revocations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: trust_store_revocations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trust_store_revocations_list_only + - elasticloadbalancingv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trust_store_revocations in a region or regions, for all properties use trust_store_revocations + +## Overview + + + + + + + +
Nametrust_store_revocations_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStoreRevocation
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the trust store.
integerThe ID associated with the revocation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trust_store_revocations in a region. +```sql +SELECT +region, +revocation_id, +trust_store_arn +FROM aws.elasticloadbalancingv2.trust_store_revocations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_store_revocations_list_only resource, see trust_store_revocations + diff --git a/website/docs/services/elasticloadbalancingv2/trust_store_tags/index.md b/website/docs/services/elasticloadbalancingv2/trust_store_tags/index.md new file mode 100644 index 0000000..8e1512a --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/trust_store_tags/index.md @@ -0,0 +1,89 @@ +--- +title: trust_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - trust_store_tags + - elasticloadbalancingv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for trust_stores in a region + +## Overview + + + + + + + +
Nametrust_store_tags
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStore
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the trust store.
stringThe name of the S3 bucket to fetch the CA certificate bundle from.
stringThe name of the S3 object to fetch the CA certificate bundle from.
stringThe version of the S3 bucket that contains the CA certificate bundle.
stringThe status of the trust store, could be either of ACTIVE or CREATING.
integerThe number of certificates associated with the trust store.
stringThe Amazon Resource Name (ARN) of the trust store.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all trust_stores in a region. +```sql +SELECT +region, +name, +ca_certificates_bundle_s3_bucket, +ca_certificates_bundle_s3_key, +ca_certificates_bundle_s3_object_version, +status, +number_of_ca_certificates, +trust_store_arn, +tag_key, +tag_value +FROM aws.elasticloadbalancingv2.trust_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_store_tags resource, see trust_stores + diff --git a/website/docs/services/elasticloadbalancingv2/trust_stores/index.md b/website/docs/services/elasticloadbalancingv2/trust_stores/index.md new file mode 100644 index 0000000..5b718b4 --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/trust_stores/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a trust_store resource or lists trust_stores in a region + +## Overview + + + + + + + +
Nametrust_stores
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStore
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the trust store.
stringThe name of the S3 bucket to fetch the CA certificate bundle from.
stringThe name of the S3 object to fetch the CA certificate bundle from.
stringThe version of the S3 bucket that contains the CA certificate bundle.
stringThe status of the trust store, could be either of ACTIVE or CREATING.
integerThe number of certificates associated with the trust store.
arrayThe tags to assign to the trust store.
stringThe Amazon Resource Name (ARN) of the trust store.
stringAWS region.
+ +For more information, see AWS::ElasticLoadBalancingV2::TrustStore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all trust_stores in a region. +```sql +SELECT +region, +name, +ca_certificates_bundle_s3_bucket, +ca_certificates_bundle_s3_key, +ca_certificates_bundle_s3_object_version, +status, +number_of_ca_certificates, +tags, +trust_store_arn +FROM aws.elasticloadbalancingv2.trust_stores +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual trust_store. +```sql +SELECT +region, +name, +ca_certificates_bundle_s3_bucket, +ca_certificates_bundle_s3_key, +ca_certificates_bundle_s3_object_version, +status, +number_of_ca_certificates, +tags, +trust_store_arn +FROM aws.elasticloadbalancingv2.trust_stores +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new trust_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.trust_stores ( + Name, + CaCertificatesBundleS3Bucket, + CaCertificatesBundleS3Key, + CaCertificatesBundleS3ObjectVersion, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ CaCertificatesBundleS3Bucket }}', + '{{ CaCertificatesBundleS3Key }}', + '{{ CaCertificatesBundleS3ObjectVersion }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.elasticloadbalancingv2.trust_stores ( + Name, + CaCertificatesBundleS3Bucket, + CaCertificatesBundleS3Key, + CaCertificatesBundleS3ObjectVersion, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ CaCertificatesBundleS3Bucket }}', + '{{ CaCertificatesBundleS3Key }}', + '{{ CaCertificatesBundleS3ObjectVersion }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: trust_store + props: + - name: Name + value: '{{ Name }}' + - name: CaCertificatesBundleS3Bucket + value: '{{ CaCertificatesBundleS3Bucket }}' + - name: CaCertificatesBundleS3Key + value: '{{ CaCertificatesBundleS3Key }}' + - name: CaCertificatesBundleS3ObjectVersion + value: '{{ CaCertificatesBundleS3ObjectVersion }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.elasticloadbalancingv2.trust_stores +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +elasticloadbalancing:DescribeTrustStores, +elasticloadbalancing:DeleteTrustStore +``` + +### List +```json +elasticloadbalancing:DescribeTrustStores, +s3:GetObject, +s3:GetObjectVersion +``` + +### Read +```json +elasticloadbalancing:DescribeTrustStores, +elasticloadbalancing:DescribeTags +``` + +### Update +```json +elasticloadbalancing:ModifyTrustStore, +elasticloadbalancing:AddTags, +elasticloadbalancing:RemoveTags, +s3:GetObject, +s3:GetObjectVersion +``` diff --git a/website/docs/services/elasticloadbalancingv2/trust_stores_list_only/index.md b/website/docs/services/elasticloadbalancingv2/trust_stores_list_only/index.md new file mode 100644 index 0000000..5ecb149 --- /dev/null +++ b/website/docs/services/elasticloadbalancingv2/trust_stores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: trust_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trust_stores_list_only + - elasticloadbalancingv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trust_stores in a region or regions, for all properties use trust_stores + +## Overview + + + + + + + +
Nametrust_stores_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStore
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the trust store.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trust_stores in a region. +```sql +SELECT +region, +trust_store_arn +FROM aws.elasticloadbalancingv2.trust_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_stores_list_only resource, see trust_stores + diff --git a/website/docs/services/emr/index.md b/website/docs/services/emr/index.md new file mode 100644 index 0000000..447d1d0 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The emr service documentation. + +:::info Service Summary + +
+
+total resources: 10
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/emr/security_configurations/index.md b/website/docs/services/emr/security_configurations/index.md new file mode 100644 index 0000000..f550fa9 --- /dev/null +++ b/website/docs/services/emr/security_configurations/index.md @@ -0,0 +1,192 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_configuration resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the security configuration.
objectThe security configuration details in JSON format.
stringAWS region.
+ +For more information, see AWS::EMR::SecurityConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_configurations in a region. +```sql +SELECT +region, +name, +security_configuration +FROM aws.emr.security_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_configuration. +```sql +SELECT +region, +name, +security_configuration +FROM aws.emr.security_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.emr.security_configurations ( + SecurityConfiguration, + region +) +SELECT +'{{ SecurityConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.emr.security_configurations ( + Name, + SecurityConfiguration, + region +) +SELECT + '{{ Name }}', + '{{ SecurityConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_configuration + props: + - name: Name + value: '{{ Name }}' + - name: SecurityConfiguration + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.emr.security_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the security_configurations resource, the following permissions are required: + +### Create +```json +elasticmapreduce:CreateSecurityConfiguration, +elasticmapreduce:DescribeSecurityConfiguration +``` + +### Read +```json +elasticmapreduce:DescribeSecurityConfiguration +``` + +### Delete +```json +elasticmapreduce:DeleteSecurityConfiguration +``` + +### List +```json +elasticmapreduce:ListSecurityConfigurations +``` diff --git a/website/docs/services/emr/security_configurations_list_only/index.md b/website/docs/services/emr/security_configurations_list_only/index.md new file mode 100644 index 0000000..4dd823c --- /dev/null +++ b/website/docs/services/emr/security_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: security_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_configurations_list_only + - emr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_configurations in a region or regions, for all properties use security_configurations + +## Overview + + + + + + + +
Namesecurity_configurations_list_only
TypeResource
DescriptionUse a SecurityConfiguration resource to configure data encryption, Kerberos authentication, and Amazon S3 authorization for EMRFS.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the security configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_configurations in a region. +```sql +SELECT +region, +name +FROM aws.emr.security_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_configurations_list_only resource, see security_configurations + diff --git a/website/docs/services/emr/studio_session_mappings/index.md b/website/docs/services/emr/studio_session_mappings/index.md new file mode 100644 index 0000000..b5fa2e2 --- /dev/null +++ b/website/docs/services/emr/studio_session_mappings/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a studio_session_mapping resource or lists studio_session_mappings in a region + +## Overview + + + + + + + +
Namestudio_session_mappings
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.
stringSpecifies whether the identity to map to the Studio is a user or a group.
stringThe Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. Session policies refine Studio user permissions without the need to use multiple IAM user roles.
stringThe ID of the Amazon EMR Studio to which the user or group will be mapped.
stringAWS region.
+ +For more information, see AWS::EMR::StudioSessionMapping. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all studio_session_mappings in a region. +```sql +SELECT +region, +identity_name, +identity_type, +session_policy_arn, +studio_id +FROM aws.emr.studio_session_mappings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual studio_session_mapping. +```sql +SELECT +region, +identity_name, +identity_type, +session_policy_arn, +studio_id +FROM aws.emr.studio_session_mappings +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new studio_session_mapping resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.emr.studio_session_mappings ( + IdentityName, + IdentityType, + SessionPolicyArn, + StudioId, + region +) +SELECT +'{{ IdentityName }}', + '{{ IdentityType }}', + '{{ SessionPolicyArn }}', + '{{ StudioId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.emr.studio_session_mappings ( + IdentityName, + IdentityType, + SessionPolicyArn, + StudioId, + region +) +SELECT + '{{ IdentityName }}', + '{{ IdentityType }}', + '{{ SessionPolicyArn }}', + '{{ StudioId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: studio_session_mapping + props: + - name: IdentityName + value: '{{ IdentityName }}' + - name: IdentityType + value: '{{ IdentityType }}' + - name: SessionPolicyArn + value: '{{ SessionPolicyArn }}' + - name: StudioId + value: '{{ StudioId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.emr.studio_session_mappings +WHERE data__Identifier = '' +AND 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, +sso:CreateApplication, +sso:PutApplicationAuthenticationMethod, +sso:PutApplicationGrant, +sso:PutApplicationAccessScope, +sso:PutApplicationAssignmentConfiguration, +sso:DescribeApplication, +sso:DeleteApplication, +sso:DeleteApplicationAuthenticationMethod, +sso:DeleteApplicationAccessScope, +sso:DeleteApplicationGrant, +sso:ListInstances, +sso-directory:CreateUser, +sso-directory:CreateGroup, +sso:CreateApplicationAssignment, +sso:DescribeInstance, +sso:DeleteApplicationAssignment, +sso:ListApplicationAssignments +``` + +### 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 +``` + +### List +```json +elasticmapreduce:ListStudioSessionMappings +``` diff --git a/website/docs/services/emr/studio_session_mappings_list_only/index.md b/website/docs/services/emr/studio_session_mappings_list_only/index.md new file mode 100644 index 0000000..f88af62 --- /dev/null +++ b/website/docs/services/emr/studio_session_mappings_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: studio_session_mappings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - studio_session_mappings_list_only + - emr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists studio_session_mappings in a region or regions, for all properties use studio_session_mappings + +## Overview + + + + + + + +
Namestudio_session_mappings_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.
stringSpecifies whether the identity to map to the Studio is a user or a group.
stringThe ID of the Amazon EMR Studio to which the user or group will be mapped.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all studio_session_mappings in a region. +```sql +SELECT +region, +studio_id, +identity_type, +identity_name +FROM aws.emr.studio_session_mappings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studio_session_mappings_list_only resource, see studio_session_mappings + diff --git a/website/docs/services/emr/studio_tags/index.md b/website/docs/services/emr/studio_tags/index.md new file mode 100644 index 0000000..69a0e1d --- /dev/null +++ b/website/docs/services/emr/studio_tags/index.md @@ -0,0 +1,113 @@ +--- +title: studio_tags +hide_title: false +hide_table_of_contents: false +keywords: + - studio_tags + - emr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for studios in a region + +## Overview + + + + + + + +
Namestudio_tags
TypeResource
DescriptionResource schema for AWS::EMR::Studio
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the EMR Studio.
stringSpecifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
stringThe default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
stringA detailed description of the Studio.
stringThe ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId.
stringA descriptive name for the Amazon EMR Studio.
stringThe IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
stringThe ID of the EMR Studio.
arrayA list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
stringThe unique Studio access URL.
stringThe IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.
stringThe ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
stringThe ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId.
stringYour identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
stringThe name of relay state parameter for external Identity Provider.
booleanA Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
stringSpecifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
stringThe ARN of the IAM Identity Center instance to create the Studio application.
stringThe AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all studios in a region. +```sql +SELECT +region, +arn, +auth_mode, +default_s3_location, +description, +engine_security_group_id, +name, +service_role, +studio_id, +subnet_ids, +url, +user_role, +vpc_id, +workspace_security_group_id, +idp_auth_url, +idp_relay_state_parameter_name, +trusted_identity_propagation_enabled, +idc_user_assignment, +idc_instance_arn, +encryption_key_arn, +tag_key, +tag_value +FROM aws.emr.studio_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studio_tags resource, see studios + diff --git a/website/docs/services/emr/studios/index.md b/website/docs/services/emr/studios/index.md new file mode 100644 index 0000000..18a55a6 --- /dev/null +++ b/website/docs/services/emr/studios/index.md @@ -0,0 +1,343 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a studio resource or lists studios in a region + +## Overview + + + + + + + +
Namestudios
TypeResource
DescriptionResource schema for AWS::EMR::Studio
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the EMR Studio.
stringSpecifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
stringThe default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
stringA detailed description of the Studio.
stringThe ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId.
stringA descriptive name for the Amazon EMR Studio.
stringThe IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
stringThe ID of the EMR Studio.
arrayA list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
arrayA list of tags to associate with the Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
stringThe unique Studio access URL.
stringThe IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.
stringThe ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
stringThe ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId.
stringYour identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
stringThe name of relay state parameter for external Identity Provider.
booleanA Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
stringSpecifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
stringThe ARN of the IAM Identity Center instance to create the Studio application.
stringThe AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
stringAWS region.
+ +For more information, see AWS::EMR::Studio. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all studios in a region. +```sql +SELECT +region, +arn, +auth_mode, +default_s3_location, +description, +engine_security_group_id, +name, +service_role, +studio_id, +subnet_ids, +tags, +url, +user_role, +vpc_id, +workspace_security_group_id, +idp_auth_url, +idp_relay_state_parameter_name, +trusted_identity_propagation_enabled, +idc_user_assignment, +idc_instance_arn, +encryption_key_arn +FROM aws.emr.studios +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual studio. +```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.studios +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new studio resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.emr.studios ( + AuthMode, + DefaultS3Location, + EngineSecurityGroupId, + Name, + ServiceRole, + SubnetIds, + VpcId, + WorkspaceSecurityGroupId, + region +) +SELECT +'{{ AuthMode }}', + '{{ DefaultS3Location }}', + '{{ EngineSecurityGroupId }}', + '{{ Name }}', + '{{ ServiceRole }}', + '{{ SubnetIds }}', + '{{ VpcId }}', + '{{ WorkspaceSecurityGroupId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.emr.studios ( + AuthMode, + DefaultS3Location, + Description, + EngineSecurityGroupId, + Name, + ServiceRole, + SubnetIds, + Tags, + UserRole, + VpcId, + WorkspaceSecurityGroupId, + IdpAuthUrl, + IdpRelayStateParameterName, + TrustedIdentityPropagationEnabled, + IdcUserAssignment, + IdcInstanceArn, + EncryptionKeyArn, + region +) +SELECT + '{{ AuthMode }}', + '{{ DefaultS3Location }}', + '{{ Description }}', + '{{ EngineSecurityGroupId }}', + '{{ Name }}', + '{{ ServiceRole }}', + '{{ SubnetIds }}', + '{{ Tags }}', + '{{ UserRole }}', + '{{ VpcId }}', + '{{ WorkspaceSecurityGroupId }}', + '{{ IdpAuthUrl }}', + '{{ IdpRelayStateParameterName }}', + '{{ TrustedIdentityPropagationEnabled }}', + '{{ IdcUserAssignment }}', + '{{ IdcInstanceArn }}', + '{{ EncryptionKeyArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: studio + props: + - name: AuthMode + value: '{{ AuthMode }}' + - name: DefaultS3Location + value: '{{ DefaultS3Location }}' + - name: Description + value: '{{ Description }}' + - name: EngineSecurityGroupId + value: '{{ EngineSecurityGroupId }}' + - name: Name + value: '{{ Name }}' + - name: ServiceRole + value: '{{ ServiceRole }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: UserRole + value: null + - name: VpcId + value: '{{ VpcId }}' + - name: WorkspaceSecurityGroupId + value: '{{ WorkspaceSecurityGroupId }}' + - name: IdpAuthUrl + value: '{{ IdpAuthUrl }}' + - name: IdpRelayStateParameterName + value: '{{ IdpRelayStateParameterName }}' + - name: TrustedIdentityPropagationEnabled + value: '{{ TrustedIdentityPropagationEnabled }}' + - name: IdcUserAssignment + value: '{{ IdcUserAssignment }}' + - name: IdcInstanceArn + value: '{{ IdcInstanceArn }}' + - name: EncryptionKeyArn + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.emr.studios +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +elasticmapreduce:DescribeStudio, +sso:GetManagedApplicationInstance +``` + +### Update +```json +elasticmapreduce:UpdateStudio, +elasticmapreduce:DescribeStudio, +elasticmapreduce:AddTags, +elasticmapreduce:RemoveTags +``` + +### Delete +```json +elasticmapreduce:DeleteStudio, +elasticmapreduce:DescribeStudio, +sso:DeleteManagedApplicationInstance +``` + +### List +```json +elasticmapreduce:ListStudios +``` diff --git a/website/docs/services/emr/studios_list_only/index.md b/website/docs/services/emr/studios_list_only/index.md new file mode 100644 index 0000000..ac1cf48 --- /dev/null +++ b/website/docs/services/emr/studios_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: studios_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - studios_list_only + - emr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists studios in a region or regions, for all properties use studios + +## Overview + + + + + + + +
Namestudios_list_only
TypeResource
DescriptionResource schema for AWS::EMR::Studio
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the EMR Studio.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all studios in a region. +```sql +SELECT +region, +studio_id +FROM aws.emr.studios_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studios_list_only resource, see studios + diff --git a/website/docs/services/emr/wal_workspace_tags/index.md b/website/docs/services/emr/wal_workspace_tags/index.md new file mode 100644 index 0000000..e10c688 --- /dev/null +++ b/website/docs/services/emr/wal_workspace_tags/index.md @@ -0,0 +1,77 @@ +--- +title: wal_workspace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - wal_workspace_tags + - emr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for wal_workspaces in a region + +## Overview + + + + + + + +
Namewal_workspace_tags
TypeResource
DescriptionResource schema for AWS::EMR::WALWorkspace Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the emrwal container
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all wal_workspaces in a region. +```sql +SELECT +region, +wal_workspace_name, +tag_key, +tag_value +FROM aws.emr.wal_workspace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wal_workspace_tags resource, see wal_workspaces + diff --git a/website/docs/services/emr/wal_workspaces/index.md b/website/docs/services/emr/wal_workspaces/index.md new file mode 100644 index 0000000..42f399d --- /dev/null +++ b/website/docs/services/emr/wal_workspaces/index.md @@ -0,0 +1,209 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a wal_workspace resource or lists wal_workspaces in a region + +## Overview + + + + + + + +
Namewal_workspaces
TypeResource
DescriptionResource schema for AWS::EMR::WALWorkspace Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the emrwal container
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::EMR::WALWorkspace. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all wal_workspaces in a region. +```sql +SELECT +region, +wal_workspace_name, +tags +FROM aws.emr.wal_workspaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual wal_workspace. +```sql +SELECT +region, +wal_workspace_name, +tags +FROM aws.emr.wal_workspaces +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new wal_workspace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.emr.wal_workspaces ( + WALWorkspaceName, + Tags, + region +) +SELECT +'{{ WALWorkspaceName }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.emr.wal_workspaces ( + WALWorkspaceName, + Tags, + region +) +SELECT + '{{ WALWorkspaceName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: wal_workspace + props: + - name: WALWorkspaceName + value: '{{ WALWorkspaceName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.emr.wal_workspaces +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +emrwal:ListTagsForResource +``` + +### Delete +```json +emrwal:DeleteWorkspace +``` + +### List +```json +emrwal:ListWorkspaces +``` + +### Update +```json +emrwal:TagResource, +emrwal:UntagResource, +emrwal:ListTagsForResource +``` diff --git a/website/docs/services/emr/wal_workspaces_list_only/index.md b/website/docs/services/emr/wal_workspaces_list_only/index.md new file mode 100644 index 0000000..738befb --- /dev/null +++ b/website/docs/services/emr/wal_workspaces_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: wal_workspaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - wal_workspaces_list_only + - emr + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists wal_workspaces in a region or regions, for all properties use wal_workspaces + +## Overview + + + + + + + +
Namewal_workspaces_list_only
TypeResource
DescriptionResource schema for AWS::EMR::WALWorkspace Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the emrwal container
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all wal_workspaces in a region. +```sql +SELECT +region, +wal_workspace_name +FROM aws.emr.wal_workspaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wal_workspaces_list_only resource, see wal_workspaces + diff --git a/website/docs/services/emrcontainers/index.md b/website/docs/services/emrcontainers/index.md new file mode 100644 index 0000000..c18ccdd --- /dev/null +++ b/website/docs/services/emrcontainers/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The emrcontainers service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/emrcontainers/virtual_cluster_tags/index.md b/website/docs/services/emrcontainers/virtual_cluster_tags/index.md new file mode 100644 index 0000000..42839b1 --- /dev/null +++ b/website/docs/services/emrcontainers/virtual_cluster_tags/index.md @@ -0,0 +1,83 @@ +--- +title: virtual_cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - virtual_cluster_tags + - emrcontainers + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for virtual_clusters in a region + +## Overview + + + + + + + +
Namevirtual_cluster_tags
TypeResource
DescriptionResource Schema of AWS::EMRContainers::VirtualCluster Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
objectContainer provider of the virtual cluster.
stringId of the virtual cluster.
stringName of the virtual cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all virtual_clusters in a region. +```sql +SELECT +region, +arn, +container_provider, +id, +name, +tag_key, +tag_value +FROM aws.emrcontainers.virtual_cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the virtual_cluster_tags resource, see virtual_clusters + diff --git a/website/docs/services/emrcontainers/virtual_clusters/index.md b/website/docs/services/emrcontainers/virtual_clusters/index.md new file mode 100644 index 0000000..42ec25a --- /dev/null +++ b/website/docs/services/emrcontainers/virtual_clusters/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a virtual_cluster resource or lists virtual_clusters in a region + +## Overview + + + + + + + +
Namevirtual_clusters
TypeResource
DescriptionResource Schema of AWS::EMRContainers::VirtualCluster Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
objectContainer provider of the virtual cluster.
stringId of the virtual cluster.
stringName of the virtual cluster.
arrayAn array of key-value pairs to apply to this virtual cluster.
stringAWS region.
+ +For more information, see AWS::EMRContainers::VirtualCluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all virtual_clusters in a region. +```sql +SELECT +region, +arn, +container_provider, +id, +name, +tags +FROM aws.emrcontainers.virtual_clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual virtual_cluster. +```sql +SELECT +region, +arn, +container_provider, +id, +name, +tags +FROM aws.emrcontainers.virtual_clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new virtual_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.emrcontainers.virtual_clusters ( + ContainerProvider, + Name, + region +) +SELECT +'{{ ContainerProvider }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.emrcontainers.virtual_clusters ( + ContainerProvider, + Name, + Tags, + region +) +SELECT + '{{ ContainerProvider }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: virtual_cluster + props: + - name: ContainerProvider + value: + Type: '{{ Type }}' + Id: '{{ Id }}' + Info: + EksInfo: + Namespace: '{{ Namespace }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.emrcontainers.virtual_clusters +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +emr-containers:DescribeVirtualCluster +``` + +### Delete +```json +emr-containers:DeleteVirtualCluster, +emr-containers:DescribeVirtualCluster +``` + +### List +```json +emr-containers:ListVirtualClusters +``` + +### Update +```json +emr-containers:DescribeVirtualCluster, +emr-containers:ListTagsForResource, +emr-containers:TagResource, +emr-containers:UntagResource +``` diff --git a/website/docs/services/emrcontainers/virtual_clusters_list_only/index.md b/website/docs/services/emrcontainers/virtual_clusters_list_only/index.md new file mode 100644 index 0000000..c0e7983 --- /dev/null +++ b/website/docs/services/emrcontainers/virtual_clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: virtual_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - virtual_clusters_list_only + - emrcontainers + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists virtual_clusters in a region or regions, for all properties use virtual_clusters + +## Overview + + + + + + + +
Namevirtual_clusters_list_only
TypeResource
DescriptionResource Schema of AWS::EMRContainers::VirtualCluster Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId of the virtual cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all virtual_clusters in a region. +```sql +SELECT +region, +id +FROM aws.emrcontainers.virtual_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the virtual_clusters_list_only resource, see virtual_clusters + diff --git a/website/docs/services/emrserverless/application_tags/index.md b/website/docs/services/emrserverless/application_tags/index.md new file mode 100644 index 0000000..f6a4087 --- /dev/null +++ b/website/docs/services/emrserverless/application_tags/index.md @@ -0,0 +1,109 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - emrserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource schema for AWS::EMRServerless::Application Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe cpu architecture of an application.
stringUser friendly Application name.
stringEMR release label.
stringThe type of the application
arrayInitial capacity initialized when an Application is started.
objectMaximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit.
objectConfiguration for Auto Start of Application.
objectConfiguration for Auto Stop of Application.
objectThe image configuration.
objectMonitoring configuration for batch and interactive JobRun.
arrayRuntime configuration for batch and interactive JobRun.
object
objectNetwork Configuration for customer VPC connectivity.
stringThe Amazon Resource Name (ARN) of the EMR Serverless Application.
stringThe ID of the EMR Serverless Application.
objectThe key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.
objectThe scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +architecture, +name, +release_label, +type, +initial_capacity, +maximum_capacity, +auto_start_configuration, +auto_stop_configuration, +image_configuration, +monitoring_configuration, +runtime_configuration, +interactive_configuration, +network_configuration, +arn, +application_id, +worker_type_specifications, +scheduler_configuration, +tag_key, +tag_value +FROM aws.emrserverless.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/emrserverless/applications/index.md b/website/docs/services/emrserverless/applications/index.md new file mode 100644 index 0000000..8861106 --- /dev/null +++ b/website/docs/services/emrserverless/applications/index.md @@ -0,0 +1,402 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionResource schema for AWS::EMRServerless::Application Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe cpu architecture of an application.
stringUser friendly Application name.
stringEMR release label.
stringThe type of the application
arrayInitial capacity initialized when an Application is started.
objectMaximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit.
arrayTag map with key and value
objectConfiguration for Auto Start of Application.
objectConfiguration for Auto Stop of Application.
objectThe image configuration.
objectMonitoring configuration for batch and interactive JobRun.
arrayRuntime configuration for batch and interactive JobRun.
object
objectNetwork Configuration for customer VPC connectivity.
stringThe Amazon Resource Name (ARN) of the EMR Serverless Application.
stringThe ID of the EMR Serverless Application.
objectThe key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.
objectThe scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.
stringAWS region.
+ +For more information, see AWS::EMRServerless::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```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, +interactive_configuration, +network_configuration, +arn, +application_id, +worker_type_specifications, +scheduler_configuration +FROM aws.emrserverless.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```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, +interactive_configuration, +network_configuration, +arn, +application_id, +worker_type_specifications, +scheduler_configuration +FROM aws.emrserverless.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.emrserverless.applications ( + ReleaseLabel, + Type, + region +) +SELECT +'{{ ReleaseLabel }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.emrserverless.applications ( + Architecture, + Name, + ReleaseLabel, + Type, + InitialCapacity, + MaximumCapacity, + Tags, + AutoStartConfiguration, + AutoStopConfiguration, + ImageConfiguration, + MonitoringConfiguration, + RuntimeConfiguration, + InteractiveConfiguration, + NetworkConfiguration, + WorkerTypeSpecifications, + SchedulerConfiguration, + region +) +SELECT + '{{ Architecture }}', + '{{ Name }}', + '{{ ReleaseLabel }}', + '{{ Type }}', + '{{ InitialCapacity }}', + '{{ MaximumCapacity }}', + '{{ Tags }}', + '{{ AutoStartConfiguration }}', + '{{ AutoStopConfiguration }}', + '{{ ImageConfiguration }}', + '{{ MonitoringConfiguration }}', + '{{ RuntimeConfiguration }}', + '{{ InteractiveConfiguration }}', + '{{ NetworkConfiguration }}', + '{{ WorkerTypeSpecifications }}', + '{{ SchedulerConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: Architecture + value: '{{ Architecture }}' + - name: Name + value: '{{ Name }}' + - name: ReleaseLabel + value: '{{ ReleaseLabel }}' + - name: Type + value: '{{ Type }}' + - name: InitialCapacity + value: + - Key: '{{ Key }}' + Value: + WorkerCount: '{{ WorkerCount }}' + WorkerConfiguration: + Cpu: '{{ Cpu }}' + Memory: '{{ Memory }}' + Disk: '{{ Disk }}' + DiskType: '{{ DiskType }}' + - name: MaximumCapacity + value: + Cpu: null + Memory: null + Disk: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AutoStartConfiguration + value: + Enabled: '{{ Enabled }}' + - name: AutoStopConfiguration + value: + Enabled: '{{ Enabled }}' + IdleTimeoutMinutes: '{{ IdleTimeoutMinutes }}' + - name: ImageConfiguration + value: + ImageUri: '{{ ImageUri }}' + - name: MonitoringConfiguration + value: + S3MonitoringConfiguration: null + ManagedPersistenceMonitoringConfiguration: null + CloudWatchLoggingConfiguration: null + - name: RuntimeConfiguration + value: + - Classification: '{{ Classification }}' + Properties: {} + Configurations: + - null + - name: InteractiveConfiguration + value: + LivyEndpointEnabled: '{{ LivyEndpointEnabled }}' + StudioEnabled: '{{ StudioEnabled }}' + - name: NetworkConfiguration + value: + SubnetIds: + - '{{ SubnetIds[0] }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + - name: WorkerTypeSpecifications + value: {} + - name: SchedulerConfiguration + value: + QueueTimeoutMinutes: '{{ QueueTimeoutMinutes }}' + MaxConcurrentRuns: '{{ MaxConcurrentRuns }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.emrserverless.applications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +kms:CreateKey, +kms:CreateAlias, +kms:DescribeKey, +kms:EnableKey, +kms:ListGrants, +kms:ListAliases, +kms:ListKeyPolicies, +kms:ListKeys, +kms:PutKeyPolicy, +kms:UpdateKeyDescription, +kms:UpdateAlias, +kms:UpdatePrimaryRegion, +kms:RevokeGrant, +kms:DisableKey, +kms:DisableKeyRotation, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:DeleteAlias, +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 +``` + +### 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:CreateKey, +kms:CreateAlias, +kms:DescribeKey, +kms:EnableKey, +kms:ListGrants, +kms:ListAliases, +kms:ListKeyPolicies, +kms:ListKeys, +kms:PutKeyPolicy, +kms:UpdateKeyDescription, +kms:UpdateAlias, +kms:UpdatePrimaryRegion, +kms:RevokeGrant, +kms:DisableKey, +kms:DisableKeyRotation, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:DeleteAlias, +kms:ScheduleKeyDeletion, +kms:CancelKeyDeletion, +kms:GenerateDataKey, +kms:TagResource, +kms:UntagResource, +kms:Decrypt +``` + +### Delete +```json +emr-serverless:DeleteApplication, +emr-serverless:GetApplication +``` + +### List +```json +emr-serverless:ListApplications +``` diff --git a/website/docs/services/emrserverless/applications_list_only/index.md b/website/docs/services/emrserverless/applications_list_only/index.md new file mode 100644 index 0000000..a19e681 --- /dev/null +++ b/website/docs/services/emrserverless/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - emrserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource schema for AWS::EMRServerless::Application Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the EMR Serverless Application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_id +FROM aws.emrserverless.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/emrserverless/index.md b/website/docs/services/emrserverless/index.md new file mode 100644 index 0000000..c9aed06 --- /dev/null +++ b/website/docs/services/emrserverless/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The emrserverless service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/entityresolution/id_mapping_workflow_tags/index.md b/website/docs/services/entityresolution/id_mapping_workflow_tags/index.md new file mode 100644 index 0000000..d7966ac --- /dev/null +++ b/website/docs/services/entityresolution/id_mapping_workflow_tags/index.md @@ -0,0 +1,93 @@ +--- +title: id_mapping_workflow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - id_mapping_workflow_tags + - entityresolution + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for id_mapping_workflows in a region + +## Overview + + + + + + + +
Nameid_mapping_workflow_tags
TypeResource
DescriptionIdMappingWorkflow defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the IdMappingWorkflow
array
object
stringThe name of the IdMappingWorkflow
stringThe time of this SchemaMapping got created
array
stringThe default IdMappingWorkflow arn
stringThe time of this SchemaMapping got last updated at
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all id_mapping_workflows in a region. +```sql +SELECT +region, +description, +input_source_config, +id_mapping_techniques, +workflow_name, +created_at, +output_source_config, +workflow_arn, +updated_at, +role_arn, +tag_key, +tag_value +FROM aws.entityresolution.id_mapping_workflow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_mapping_workflow_tags resource, see id_mapping_workflows + diff --git a/website/docs/services/entityresolution/id_mapping_workflows/index.md b/website/docs/services/entityresolution/id_mapping_workflows/index.md new file mode 100644 index 0000000..95d5bfd --- /dev/null +++ b/website/docs/services/entityresolution/id_mapping_workflows/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an id_mapping_workflow resource or lists id_mapping_workflows in a region + +## Overview + + + + + + + +
Nameid_mapping_workflows
TypeResource
DescriptionIdMappingWorkflow defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the IdMappingWorkflow
array
object
stringThe name of the IdMappingWorkflow
stringThe time of this SchemaMapping got created
array
stringThe default IdMappingWorkflow arn
stringThe time of this SchemaMapping got last updated at
string
array
stringAWS region.
+ +For more information, see AWS::EntityResolution::IdMappingWorkflow. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all id_mapping_workflows in a region. +```sql +SELECT +region, +description, +input_source_config, +id_mapping_techniques, +workflow_name, +created_at, +output_source_config, +workflow_arn, +updated_at, +role_arn, +tags +FROM aws.entityresolution.id_mapping_workflows +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual id_mapping_workflow. +```sql +SELECT +region, +description, +input_source_config, +id_mapping_techniques, +workflow_name, +created_at, +output_source_config, +workflow_arn, +updated_at, +role_arn, +tags +FROM aws.entityresolution.id_mapping_workflows +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new id_mapping_workflow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.entityresolution.id_mapping_workflows ( + InputSourceConfig, + IdMappingTechniques, + WorkflowName, + RoleArn, + region +) +SELECT +'{{ InputSourceConfig }}', + '{{ IdMappingTechniques }}', + '{{ WorkflowName }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.entityresolution.id_mapping_workflows ( + Description, + InputSourceConfig, + IdMappingTechniques, + WorkflowName, + OutputSourceConfig, + RoleArn, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ InputSourceConfig }}', + '{{ IdMappingTechniques }}', + '{{ WorkflowName }}', + '{{ OutputSourceConfig }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: id_mapping_workflow + props: + - name: Description + value: '{{ Description }}' + - name: InputSourceConfig + value: + - Type: '{{ Type }}' + InputSourceARN: '{{ InputSourceARN }}' + SchemaArn: '{{ SchemaArn }}' + - name: IdMappingTechniques + value: + RuleBasedProperties: + AttributeMatchingModel: '{{ AttributeMatchingModel }}' + RuleDefinitionType: '{{ RuleDefinitionType }}' + Rules: + - RuleName: '{{ RuleName }}' + MatchingKeys: + - '{{ MatchingKeys[0] }}' + RecordMatchingModel: '{{ RecordMatchingModel }}' + ProviderProperties: + ProviderServiceArn: '{{ ProviderServiceArn }}' + ProviderConfiguration: {} + IntermediateSourceConfiguration: + IntermediateS3Path: '{{ IntermediateS3Path }}' + IdMappingType: '{{ IdMappingType }}' + - name: WorkflowName + value: '{{ WorkflowName }}' + - name: OutputSourceConfig + value: + - KMSArn: '{{ KMSArn }}' + OutputS3Path: '{{ OutputS3Path }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.entityresolution.id_mapping_workflows +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the id_mapping_workflows resource, the following permissions are required: + +### Read +```json +entityresolution:GetIdMappingWorkflow, +entityresolution:ListTagsForResource +``` + +### Create +```json +entityresolution:CreateIdMappingWorkflow, +entityresolution:GetIdMappingWorkflow, +entityresolution:TagResource, +kms:CreateGrant, +kms:DescribeKey, +iam:PassRole +``` + +### Update +```json +entityresolution:GetIdMappingWorkflow, +entityresolution:UpdateIdMappingWorkflow, +entityresolution:ListTagsForResource, +entityresolution:TagResource, +entityresolution:UntagResource, +iam:PassRole, +kms:CreateGrant, +kms:DescribeKey +``` + +### List +```json +entityresolution:ListIdMappingWorkflows +``` + +### Delete +```json +entityresolution:DeleteIdMappingWorkflow, +entityresolution:GetIdMappingWorkflow, +entityresolution:UntagResource +``` diff --git a/website/docs/services/entityresolution/id_mapping_workflows_list_only/index.md b/website/docs/services/entityresolution/id_mapping_workflows_list_only/index.md new file mode 100644 index 0000000..0bf62a1 --- /dev/null +++ b/website/docs/services/entityresolution/id_mapping_workflows_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: id_mapping_workflows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - id_mapping_workflows_list_only + - entityresolution + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists id_mapping_workflows in a region or regions, for all properties use id_mapping_workflows + +## Overview + + + + + + + +
Nameid_mapping_workflows_list_only
TypeResource
DescriptionIdMappingWorkflow defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the IdMappingWorkflow
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all id_mapping_workflows in a region. +```sql +SELECT +region, +workflow_name +FROM aws.entityresolution.id_mapping_workflows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_mapping_workflows_list_only resource, see id_mapping_workflows + diff --git a/website/docs/services/entityresolution/id_namespace_tags/index.md b/website/docs/services/entityresolution/id_namespace_tags/index.md new file mode 100644 index 0000000..5407fd8 --- /dev/null +++ b/website/docs/services/entityresolution/id_namespace_tags/index.md @@ -0,0 +1,93 @@ +--- +title: id_namespace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - id_namespace_tags + - entityresolution + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for id_namespaces in a region + +## Overview + + + + + + + +
Nameid_namespace_tags
TypeResource
DescriptionIdNamespace defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
array
string
string
stringThe arn associated with the IdNamespace
stringThe date and time when the IdNamespace was created
stringThe date and time when the IdNamespace was updated
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all id_namespaces in a region. +```sql +SELECT +region, +id_namespace_name, +description, +input_source_config, +id_mapping_workflow_properties, +type, +role_arn, +id_namespace_arn, +created_at, +updated_at, +tag_key, +tag_value +FROM aws.entityresolution.id_namespace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_namespace_tags resource, see id_namespaces + diff --git a/website/docs/services/entityresolution/id_namespaces/index.md b/website/docs/services/entityresolution/id_namespaces/index.md new file mode 100644 index 0000000..ec1ea01 --- /dev/null +++ b/website/docs/services/entityresolution/id_namespaces/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an id_namespace resource or lists id_namespaces in a region + +## Overview + + + + + + + +
Nameid_namespaces
TypeResource
DescriptionIdNamespace defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
array
string
string
stringThe arn associated with the IdNamespace
stringThe date and time when the IdNamespace was created
stringThe date and time when the IdNamespace was updated
array
stringAWS region.
+ +For more information, see AWS::EntityResolution::IdNamespace. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all id_namespaces in a region. +```sql +SELECT +region, +id_namespace_name, +description, +input_source_config, +id_mapping_workflow_properties, +type, +role_arn, +id_namespace_arn, +created_at, +updated_at, +tags +FROM aws.entityresolution.id_namespaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual id_namespace. +```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_namespaces +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new id_namespace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.entityresolution.id_namespaces ( + IdNamespaceName, + Type, + region +) +SELECT +'{{ IdNamespaceName }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.entityresolution.id_namespaces ( + IdNamespaceName, + Description, + InputSourceConfig, + IdMappingWorkflowProperties, + Type, + RoleArn, + Tags, + region +) +SELECT + '{{ IdNamespaceName }}', + '{{ Description }}', + '{{ InputSourceConfig }}', + '{{ IdMappingWorkflowProperties }}', + '{{ Type }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: id_namespace + props: + - name: IdNamespaceName + value: '{{ IdNamespaceName }}' + - name: Description + value: '{{ Description }}' + - name: InputSourceConfig + value: + - InputSourceARN: '{{ InputSourceARN }}' + SchemaName: null + - name: IdMappingWorkflowProperties + value: + - IdMappingType: '{{ IdMappingType }}' + RuleBasedProperties: + Rules: + - RuleName: '{{ RuleName }}' + MatchingKeys: + - '{{ MatchingKeys[0] }}' + RuleDefinitionTypes: + - '{{ RuleDefinitionTypes[0] }}' + AttributeMatchingModel: '{{ AttributeMatchingModel }}' + RecordMatchingModels: + - '{{ RecordMatchingModels[0] }}' + ProviderProperties: + ProviderServiceArn: '{{ ProviderServiceArn }}' + ProviderConfiguration: {} + - name: Type + value: '{{ Type }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.entityresolution.id_namespaces +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +entityresolution:ListIdNamespaces +``` diff --git a/website/docs/services/entityresolution/id_namespaces_list_only/index.md b/website/docs/services/entityresolution/id_namespaces_list_only/index.md new file mode 100644 index 0000000..72f7f7f --- /dev/null +++ b/website/docs/services/entityresolution/id_namespaces_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: id_namespaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - id_namespaces_list_only + - entityresolution + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists id_namespaces in a region or regions, for all properties use id_namespaces + +## Overview + + + + + + + +
Nameid_namespaces_list_only
TypeResource
DescriptionIdNamespace defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all id_namespaces in a region. +```sql +SELECT +region, +id_namespace_name +FROM aws.entityresolution.id_namespaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_namespaces_list_only resource, see id_namespaces + diff --git a/website/docs/services/entityresolution/index.md b/website/docs/services/entityresolution/index.md new file mode 100644 index 0000000..c2c1999 --- /dev/null +++ b/website/docs/services/entityresolution/index.md @@ -0,0 +1,49 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The entityresolution service documentation. + +:::info Service Summary + +
+
+total resources: 14
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/entityresolution/matching_workflow_tags/index.md b/website/docs/services/entityresolution/matching_workflow_tags/index.md new file mode 100644 index 0000000..5a76d6e --- /dev/null +++ b/website/docs/services/entityresolution/matching_workflow_tags/index.md @@ -0,0 +1,95 @@ +--- +title: matching_workflow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - matching_workflow_tags + - entityresolution + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for matching_workflows in a region + +## Overview + + + + + + + +
Namematching_workflow_tags
TypeResource
DescriptionMatchingWorkflow defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the MatchingWorkflow
stringThe description of the MatchingWorkflow
array
array
object
string
stringThe default MatchingWorkflow arn
stringThe time of this SchemaMapping got created
stringThe time of this SchemaMapping got last updated at
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all matching_workflows in a region. +```sql +SELECT +region, +workflow_name, +description, +input_source_config, +output_source_config, +resolution_techniques, +role_arn, +workflow_arn, +created_at, +updated_at, +incremental_run_config, +tag_key, +tag_value +FROM aws.entityresolution.matching_workflow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matching_workflow_tags resource, see matching_workflows + diff --git a/website/docs/services/entityresolution/matching_workflows/index.md b/website/docs/services/entityresolution/matching_workflows/index.md new file mode 100644 index 0000000..641b2ac --- /dev/null +++ b/website/docs/services/entityresolution/matching_workflows/index.md @@ -0,0 +1,314 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a matching_workflow resource or lists matching_workflows in a region + +## Overview + + + + + + + +
Namematching_workflows
TypeResource
DescriptionMatchingWorkflow defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the MatchingWorkflow
stringThe description of the MatchingWorkflow
array
array
object
string
array
stringThe default MatchingWorkflow arn
stringThe time of this SchemaMapping got created
stringThe time of this SchemaMapping got last updated at
object
stringAWS region.
+ +For more information, see AWS::EntityResolution::MatchingWorkflow. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all matching_workflows in a region. +```sql +SELECT +region, +workflow_name, +description, +input_source_config, +output_source_config, +resolution_techniques, +role_arn, +tags, +workflow_arn, +created_at, +updated_at, +incremental_run_config +FROM aws.entityresolution.matching_workflows +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual matching_workflow. +```sql +SELECT +region, +workflow_name, +description, +input_source_config, +output_source_config, +resolution_techniques, +role_arn, +tags, +workflow_arn, +created_at, +updated_at, +incremental_run_config +FROM aws.entityresolution.matching_workflows +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new matching_workflow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.entityresolution.matching_workflows ( + WorkflowName, + InputSourceConfig, + OutputSourceConfig, + ResolutionTechniques, + RoleArn, + region +) +SELECT +'{{ WorkflowName }}', + '{{ InputSourceConfig }}', + '{{ OutputSourceConfig }}', + '{{ ResolutionTechniques }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.entityresolution.matching_workflows ( + WorkflowName, + Description, + InputSourceConfig, + OutputSourceConfig, + ResolutionTechniques, + RoleArn, + Tags, + IncrementalRunConfig, + region +) +SELECT + '{{ WorkflowName }}', + '{{ Description }}', + '{{ InputSourceConfig }}', + '{{ OutputSourceConfig }}', + '{{ ResolutionTechniques }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ IncrementalRunConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: matching_workflow + props: + - name: WorkflowName + value: '{{ WorkflowName }}' + - name: Description + value: '{{ Description }}' + - name: InputSourceConfig + value: + - InputSourceARN: '{{ InputSourceARN }}' + SchemaArn: '{{ SchemaArn }}' + ApplyNormalization: '{{ ApplyNormalization }}' + - name: OutputSourceConfig + value: + - OutputS3Path: '{{ OutputS3Path }}' + Output: + - Name: '{{ Name }}' + Hashed: '{{ Hashed }}' + KMSArn: '{{ KMSArn }}' + ApplyNormalization: '{{ ApplyNormalization }}' + - name: ResolutionTechniques + value: + ResolutionType: '{{ ResolutionType }}' + RuleBasedProperties: + Rules: + - RuleName: '{{ RuleName }}' + MatchingKeys: + - null + AttributeMatchingModel: '{{ AttributeMatchingModel }}' + MatchPurpose: '{{ MatchPurpose }}' + ProviderProperties: + ProviderServiceArn: '{{ ProviderServiceArn }}' + ProviderConfiguration: {} + IntermediateSourceConfiguration: + IntermediateS3Path: '{{ IntermediateS3Path }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: IncrementalRunConfig + value: + IncrementalRunType: '{{ IncrementalRunType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.entityresolution.matching_workflows +WHERE data__Identifier = '' +AND 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, +events:PutRule, +events:DeleteRule, +events:PutTargets, +events:ListTargetsByRule +``` + +### Read +```json +entityresolution:GetMatchingWorkflow, +entityresolution:ListTagsForResource +``` + +### Delete +```json +entityresolution:DeleteMatchingWorkflow, +entityresolution:GetMatchingWorkflow, +entityresolution:UntagResource, +events:PutRule, +events:DeleteRule, +events:PutTargets, +events:RemoveTargets, +events:ListTargetsByRule +``` + +### List +```json +entityresolution:ListMatchingWorkflows +``` + +### Update +```json +entityresolution:GetMatchingWorkflow, +entityresolution:UpdateMatchingWorkflow, +entityresolution:ListTagsForResource, +entityresolution:TagResource, +entityresolution:UntagResource, +iam:PassRole, +kms:CreateGrant, +kms:DescribeKey, +events:PutRule, +events:DeleteRule, +events:PutTargets, +events:RemoveTargets, +events:ListTargetsByRule +``` diff --git a/website/docs/services/entityresolution/matching_workflows_list_only/index.md b/website/docs/services/entityresolution/matching_workflows_list_only/index.md new file mode 100644 index 0000000..b827d2f --- /dev/null +++ b/website/docs/services/entityresolution/matching_workflows_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: matching_workflows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - matching_workflows_list_only + - entityresolution + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists matching_workflows in a region or regions, for all properties use matching_workflows + +## Overview + + + + + + + +
Namematching_workflows_list_only
TypeResource
DescriptionMatchingWorkflow defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the MatchingWorkflow
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all matching_workflows in a region. +```sql +SELECT +region, +workflow_name +FROM aws.entityresolution.matching_workflows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matching_workflows_list_only resource, see matching_workflows + diff --git a/website/docs/services/entityresolution/policy_statements/index.md b/website/docs/services/entityresolution/policy_statements/index.md new file mode 100644 index 0000000..26c6ec5 --- /dev/null +++ b/website/docs/services/entityresolution/policy_statements/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a policy_statement resource or lists policy_statements in a region + +## Overview + + + + + + + +
Namepolicy_statements
TypeResource
DescriptionPolicy Statement defined in AWS Entity Resolution Service
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringArn of the resource to which the policy statement is being attached.
stringThe Statement Id of the policy statement that is being attached.
string
array
array
string
stringAWS region.
+ +For more information, see AWS::EntityResolution::PolicyStatement. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all policy_statements in a region. +```sql +SELECT +region, +arn, +statement_id, +effect, +action, +principal, +condition +FROM aws.entityresolution.policy_statements +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual policy_statement. +```sql +SELECT +region, +arn, +statement_id, +effect, +action, +principal, +condition +FROM aws.entityresolution.policy_statements +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new policy_statement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.entityresolution.policy_statements ( + Arn, + StatementId, + region +) +SELECT +'{{ Arn }}', + '{{ StatementId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.entityresolution.policy_statements ( + Arn, + StatementId, + Effect, + Action, + Principal, + Condition, + region +) +SELECT + '{{ Arn }}', + '{{ StatementId }}', + '{{ Effect }}', + '{{ Action }}', + '{{ Principal }}', + '{{ Condition }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: policy_statement + props: + - name: Arn + value: '{{ Arn }}' + - name: StatementId + value: '{{ StatementId }}' + - name: Effect + value: '{{ Effect }}' + - name: Action + value: + - '{{ Action[0] }}' + - name: Principal + value: + - '{{ Principal[0] }}' + - name: Condition + value: '{{ Condition }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.entityresolution.policy_statements +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the policy_statements resource, the following permissions are required: + +### Create +```json +entityresolution:AddPolicyStatement +``` + +### Read +```json +entityresolution:GetPolicy +``` + +### Update +```json +entityresolution:AddPolicyStatement, +entityresolution:DeletePolicyStatement +``` + +### Delete +```json +entityresolution:DeletePolicyStatement, +entityresolution:GetPolicy +``` + +### List +```json +entityresolution:GetPolicy +``` diff --git a/website/docs/services/entityresolution/policy_statements_list_only/index.md b/website/docs/services/entityresolution/policy_statements_list_only/index.md new file mode 100644 index 0000000..b6f8459 --- /dev/null +++ b/website/docs/services/entityresolution/policy_statements_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: policy_statements_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policy_statements_list_only + - entityresolution + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policy_statements in a region or regions, for all properties use policy_statements + +## Overview + + + + + + + +
Namepolicy_statements_list_only
TypeResource
DescriptionPolicy Statement defined in AWS Entity Resolution Service
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringArn of the resource to which the policy statement is being attached.
stringThe Statement Id of the policy statement that is being attached.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policy_statements in a region. +```sql +SELECT +region, +arn, +statement_id +FROM aws.entityresolution.policy_statements_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_statements_list_only resource, see policy_statements + diff --git a/website/docs/services/entityresolution/schema_mapping_tags/index.md b/website/docs/services/entityresolution/schema_mapping_tags/index.md new file mode 100644 index 0000000..41d5060 --- /dev/null +++ b/website/docs/services/entityresolution/schema_mapping_tags/index.md @@ -0,0 +1,89 @@ +--- +title: schema_mapping_tags +hide_title: false +hide_table_of_contents: false +keywords: + - schema_mapping_tags + - entityresolution + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for schema_mappings in a region + +## Overview + + + + + + + +
Nameschema_mapping_tags
TypeResource
DescriptionSchemaMapping defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the SchemaMapping
stringThe description of the SchemaMapping
arrayThe SchemaMapping attributes input
stringThe SchemaMapping arn associated with the Schema
stringThe time of this SchemaMapping got created
stringThe time of this SchemaMapping got last updated at
booleanThe boolean value that indicates whether or not a SchemaMapping has MatchingWorkflows that are associated with
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all schema_mappings in a region. +```sql +SELECT +region, +schema_name, +description, +mapped_input_fields, +schema_arn, +created_at, +updated_at, +has_workflows, +tag_key, +tag_value +FROM aws.entityresolution.schema_mapping_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schema_mapping_tags resource, see schema_mappings + diff --git a/website/docs/services/entityresolution/schema_mappings/index.md b/website/docs/services/entityresolution/schema_mappings/index.md new file mode 100644 index 0000000..4bf6d85 --- /dev/null +++ b/website/docs/services/entityresolution/schema_mappings/index.md @@ -0,0 +1,245 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a schema_mapping resource or lists schema_mappings in a region + +## Overview + + + + + + + +
Nameschema_mappings
TypeResource
DescriptionSchemaMapping defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the SchemaMapping
stringThe description of the SchemaMapping
arrayThe SchemaMapping attributes input
array
stringThe SchemaMapping arn associated with the Schema
stringThe time of this SchemaMapping got created
stringThe time of this SchemaMapping got last updated at
booleanThe boolean value that indicates whether or not a SchemaMapping has MatchingWorkflows that are associated with
stringAWS region.
+ +For more information, see AWS::EntityResolution::SchemaMapping. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all schema_mappings in a region. +```sql +SELECT +region, +schema_name, +description, +mapped_input_fields, +tags, +schema_arn, +created_at, +updated_at, +has_workflows +FROM aws.entityresolution.schema_mappings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual schema_mapping. +```sql +SELECT +region, +schema_name, +description, +mapped_input_fields, +tags, +schema_arn, +created_at, +updated_at, +has_workflows +FROM aws.entityresolution.schema_mappings +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new schema_mapping resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.entityresolution.schema_mappings ( + SchemaName, + MappedInputFields, + region +) +SELECT +'{{ SchemaName }}', + '{{ MappedInputFields }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.entityresolution.schema_mappings ( + SchemaName, + Description, + MappedInputFields, + Tags, + region +) +SELECT + '{{ SchemaName }}', + '{{ Description }}', + '{{ MappedInputFields }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: schema_mapping + props: + - name: SchemaName + value: '{{ SchemaName }}' + - name: Description + value: '{{ Description }}' + - name: MappedInputFields + value: + - FieldName: '{{ FieldName }}' + Type: '{{ Type }}' + SubType: '{{ SubType }}' + GroupName: null + MatchKey: null + Hashed: '{{ Hashed }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.entityresolution.schema_mappings +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +entityresolution:GetSchemaMapping, +entityresolution:ListTagsForResource +``` + +### Delete +```json +entityresolution:DeleteSchemaMapping, +entityresolution:GetSchemaMapping +``` + +### Update +```json +entityresolution:GetSchemaMapping, +entityresolution:UpdateSchemaMapping, +entityresolution:ListTagsForResource, +entityresolution:TagResource, +entityresolution:UntagResource +``` + +### List +```json +entityresolution:ListSchemaMappings +``` diff --git a/website/docs/services/entityresolution/schema_mappings_list_only/index.md b/website/docs/services/entityresolution/schema_mappings_list_only/index.md new file mode 100644 index 0000000..1caa7b3 --- /dev/null +++ b/website/docs/services/entityresolution/schema_mappings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: schema_mappings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schema_mappings_list_only + - entityresolution + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schema_mappings in a region or regions, for all properties use schema_mappings + +## Overview + + + + + + + +
Nameschema_mappings_list_only
TypeResource
DescriptionSchemaMapping defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the SchemaMapping
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schema_mappings in a region. +```sql +SELECT +region, +schema_name +FROM aws.entityresolution.schema_mappings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schema_mappings_list_only resource, see schema_mappings + diff --git a/website/docs/services/events/api_destinations/index.md b/website/docs/services/events/api_destinations/index.md new file mode 100644 index 0000000..70daa06 --- /dev/null +++ b/website/docs/services/events/api_destinations/index.md @@ -0,0 +1,239 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an api_destination resource or lists api_destinations in a region + +## Overview + + + + + + + +
Nameapi_destinations
TypeResource
DescriptionResource Type definition for AWS::Events::ApiDestination.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of the apiDestination.
string
stringThe arn of the connection.
stringThe arn of the api destination.
integer
stringUrl endpoint to invoke.
string
stringAWS region.
+ +For more information, see AWS::Events::ApiDestination. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all api_destinations in a region. +```sql +SELECT +region, +name, +description, +connection_arn, +arn, +invocation_rate_limit_per_second, +invocation_endpoint, +http_method +FROM aws.events.api_destinations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual api_destination. +```sql +SELECT +region, +name, +description, +connection_arn, +arn, +invocation_rate_limit_per_second, +invocation_endpoint, +http_method +FROM aws.events.api_destinations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new api_destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.events.api_destinations ( + ConnectionArn, + InvocationEndpoint, + HttpMethod, + region +) +SELECT +'{{ ConnectionArn }}', + '{{ InvocationEndpoint }}', + '{{ HttpMethod }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.events.api_destinations ( + Name, + Description, + ConnectionArn, + InvocationRateLimitPerSecond, + InvocationEndpoint, + HttpMethod, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ ConnectionArn }}', + '{{ InvocationRateLimitPerSecond }}', + '{{ InvocationEndpoint }}', + '{{ HttpMethod }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: api_destination + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: ConnectionArn + value: '{{ ConnectionArn }}' + - name: InvocationRateLimitPerSecond + value: '{{ InvocationRateLimitPerSecond }}' + - name: InvocationEndpoint + value: '{{ InvocationEndpoint }}' + - name: HttpMethod + value: '{{ HttpMethod }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.events.api_destinations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the api_destinations resource, the following permissions are required: + +### Create +```json +events:CreateApiDestination, +events:DescribeApiDestination +``` + +### Read +```json +events:DescribeApiDestination +``` + +### Update +```json +events:UpdateApiDestination, +events:DescribeApiDestination +``` + +### Delete +```json +events:DeleteApiDestination, +events:DescribeApiDestination +``` + +### List +```json +events:ListApiDestinations +``` diff --git a/website/docs/services/events/api_destinations_list_only/index.md b/website/docs/services/events/api_destinations_list_only/index.md new file mode 100644 index 0000000..763d19f --- /dev/null +++ b/website/docs/services/events/api_destinations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: api_destinations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - api_destinations_list_only + - events + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists api_destinations in a region or regions, for all properties use api_destinations + +## Overview + + + + + + + +
Nameapi_destinations_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::ApiDestination.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the apiDestination.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all api_destinations in a region. +```sql +SELECT +region, +name +FROM aws.events.api_destinations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_destinations_list_only resource, see api_destinations + diff --git a/website/docs/services/events/archives/index.md b/website/docs/services/events/archives/index.md new file mode 100644 index 0000000..d794bc8 --- /dev/null +++ b/website/docs/services/events/archives/index.md @@ -0,0 +1,228 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an archive resource or lists archives in a region + +## Overview + + + + + + + +
Namearchives
TypeResource
DescriptionResource Type definition for AWS::Events::Archive
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
integer
stringAWS region.
+ +For more information, see AWS::Events::Archive. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all archives in a region. +```sql +SELECT +region, +archive_name, +source_arn, +description, +event_pattern, +arn, +retention_days +FROM aws.events.archives +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual archive. +```sql +SELECT +region, +archive_name, +source_arn, +description, +event_pattern, +arn, +retention_days +FROM aws.events.archives +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new archive resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.events.archives ( + SourceArn, + region +) +SELECT +'{{ SourceArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.events.archives ( + ArchiveName, + SourceArn, + Description, + EventPattern, + RetentionDays, + region +) +SELECT + '{{ ArchiveName }}', + '{{ SourceArn }}', + '{{ Description }}', + '{{ EventPattern }}', + '{{ RetentionDays }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: archive + props: + - name: ArchiveName + value: '{{ ArchiveName }}' + - name: SourceArn + value: '{{ SourceArn }}' + - name: Description + value: '{{ Description }}' + - name: EventPattern + value: {} + - name: RetentionDays + value: '{{ RetentionDays }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.events.archives +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the archives resource, the following permissions are required: + +### Create +```json +events:DescribeArchive, +events:CreateArchive +``` + +### Delete +```json +events:DescribeArchive, +events:DeleteArchive +``` + +### List +```json +events:ListArchives +``` + +### Update +```json +events:DescribeArchive, +events:UpdateArchive +``` + +### Read +```json +events:DescribeArchive +``` diff --git a/website/docs/services/events/archives_list_only/index.md b/website/docs/services/events/archives_list_only/index.md new file mode 100644 index 0000000..2412c89 --- /dev/null +++ b/website/docs/services/events/archives_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: archives_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - archives_list_only + - events + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists archives in a region or regions, for all properties use archives + +## Overview + + + + + + + +
Namearchives_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::Archive
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all archives in a region. +```sql +SELECT +region, +archive_name +FROM aws.events.archives_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the archives_list_only resource, see archives + diff --git a/website/docs/services/events/connections/index.md b/website/docs/services/events/connections/index.md new file mode 100644 index 0000000..964e659 --- /dev/null +++ b/website/docs/services/events/connections/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connection resource or lists connections in a region + +## Overview + + + + + + + +
Nameconnections
TypeResource
DescriptionResource Type definition for AWS::Events::Connection.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of the connection.
stringThe arn of the connection resource.
stringThe arn of the secrets manager secret created in the customer account.
stringDescription of the connection.
string
object
objectThe private resource the HTTP request will be sent to.
stringAWS region.
+ +For more information, see AWS::Events::Connection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connections in a region. +```sql +SELECT +region, +name, +arn, +secret_arn, +description, +authorization_type, +auth_parameters, +invocation_connectivity_parameters +FROM aws.events.connections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connection. +```sql +SELECT +region, +name, +arn, +secret_arn, +description, +authorization_type, +auth_parameters, +invocation_connectivity_parameters +FROM aws.events.connections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.events.connections ( + Name, + Description, + AuthorizationType, + AuthParameters, + InvocationConnectivityParameters, + region +) +SELECT +'{{ Name }}', + '{{ Description }}', + '{{ AuthorizationType }}', + '{{ AuthParameters }}', + '{{ InvocationConnectivityParameters }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.events.connections ( + Name, + Description, + AuthorizationType, + AuthParameters, + InvocationConnectivityParameters, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ AuthorizationType }}', + '{{ AuthParameters }}', + '{{ InvocationConnectivityParameters }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connection + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: AuthorizationType + value: '{{ AuthorizationType }}' + - name: AuthParameters + value: + ApiKeyAuthParameters: + ApiKeyName: '{{ ApiKeyName }}' + ApiKeyValue: '{{ ApiKeyValue }}' + BasicAuthParameters: + Username: '{{ Username }}' + Password: '{{ Password }}' + OAuthParameters: + ClientParameters: + ClientID: '{{ ClientID }}' + ClientSecret: '{{ ClientSecret }}' + AuthorizationEndpoint: '{{ AuthorizationEndpoint }}' + HttpMethod: '{{ HttpMethod }}' + OAuthHttpParameters: + HeaderParameters: + - Key: '{{ Key }}' + Value: '{{ Value }}' + IsValueSecret: '{{ IsValueSecret }}' + QueryStringParameters: + - null + BodyParameters: + - null + InvocationHttpParameters: null + ConnectivityParameters: + ResourceParameters: + ResourceConfigurationArn: '{{ ResourceConfigurationArn }}' + ResourceAssociationArn: '{{ ResourceAssociationArn }}' + - name: InvocationConnectivityParameters + value: + ResourceParameters: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.events.connections +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +events:DescribeConnection +``` + +### Update +```json +events:UpdateConnection, +events:DescribeConnection, +secretsmanager:CreateSecret, +secretsmanager:UpdateSecret, +secretsmanager:GetSecretValue, +secretsmanager:PutSecretValue +``` + +### Delete +```json +events:DeleteConnection, +events:DescribeConnection +``` + +### List +```json +events:ListConnections +``` diff --git a/website/docs/services/events/connections_list_only/index.md b/website/docs/services/events/connections_list_only/index.md new file mode 100644 index 0000000..4efd127 --- /dev/null +++ b/website/docs/services/events/connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connections_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connections in a region or regions, for all properties use connections + +## Overview + + + + + + + +
Nameconnections_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::Connection.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the connection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connections in a region. +```sql +SELECT +region, +name +FROM aws.events.connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connections_list_only resource, see connections + diff --git a/website/docs/services/events/endpoints/index.md b/website/docs/services/events/endpoints/index.md new file mode 100644 index 0000000..dbe9191 --- /dev/null +++ b/website/docs/services/events/endpoints/index.md @@ -0,0 +1,260 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an endpoint resource or lists endpoints in a region + +## Overview + + + + + + + +
Nameendpoints
TypeResource
DescriptionResource Type definition for AWS::Events::Endpoint.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
array
string
string
string
string
stringAWS region.
+ +For more information, see AWS::Events::Endpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all endpoints in a region. +```sql +SELECT +region, +name, +arn, +role_arn, +description, +routing_config, +replication_config, +event_buses, +endpoint_id, +endpoint_url, +state, +state_reason +FROM aws.events.endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual endpoint. +```sql +SELECT +region, +name, +arn, +role_arn, +description, +routing_config, +replication_config, +event_buses, +endpoint_id, +endpoint_url, +state, +state_reason +FROM aws.events.endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.events.endpoints ( + RoutingConfig, + EventBuses, + region +) +SELECT +'{{ RoutingConfig }}', + '{{ EventBuses }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.events.endpoints ( + Name, + RoleArn, + Description, + RoutingConfig, + ReplicationConfig, + EventBuses, + region +) +SELECT + '{{ Name }}', + '{{ RoleArn }}', + '{{ Description }}', + '{{ RoutingConfig }}', + '{{ ReplicationConfig }}', + '{{ EventBuses }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: endpoint + props: + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Description + value: '{{ Description }}' + - name: RoutingConfig + value: + FailoverConfig: + Primary: + HealthCheck: '{{ HealthCheck }}' + Secondary: + Route: '{{ Route }}' + - name: ReplicationConfig + value: + State: '{{ State }}' + - name: EventBuses + value: + - EventBusArn: '{{ EventBusArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.events.endpoints +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +events:DescribeEndpoint +``` + +### Update +```json +events:DescribeEndpoint, +events:UpdateEndpoint, +route53:GetHealthCheck, +iam:PassRole +``` + +### Delete +```json +events:DeleteEndpoint, +events:DescribeEndpoint +``` + +### List +```json +events:ListEndpoints +``` diff --git a/website/docs/services/events/endpoints_list_only/index.md b/website/docs/services/events/endpoints_list_only/index.md new file mode 100644 index 0000000..be536bf --- /dev/null +++ b/website/docs/services/events/endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints_list_only + - events + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoints in a region or regions, for all properties use endpoints + +## Overview + + + + + + + +
Nameendpoints_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::Endpoint.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoints in a region. +```sql +SELECT +region, +name +FROM aws.events.endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the endpoints_list_only resource, see endpoints + diff --git a/website/docs/services/events/event_bus_tags/index.md b/website/docs/services/events/event_bus_tags/index.md new file mode 100644 index 0000000..6d83839 --- /dev/null +++ b/website/docs/services/events/event_bus_tags/index.md @@ -0,0 +1,89 @@ +--- +title: event_bus_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_bus_tags + - events + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_buses in a region + +## Overview + + + + + + + +
Nameevent_bus_tags
TypeResource
DescriptionResource type definition for AWS::Events::EventBus
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringIf you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
stringThe name of the event bus.
stringThe description of the event bus.
stringKms Key Identifier used to encrypt events at rest in the event bus.
objectA JSON string that describes the permission policy statement for the event bus.
stringThe Amazon Resource Name (ARN) for the event bus.
objectDead Letter Queue for the event bus.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_buses in a region. +```sql +SELECT +region, +event_source_name, +name, +description, +kms_key_identifier, +policy, +arn, +dead_letter_config, +tag_key, +tag_value +FROM aws.events.event_bus_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_bus_tags resource, see event_buses + diff --git a/website/docs/services/events/event_buses/index.md b/website/docs/services/events/event_buses/index.md new file mode 100644 index 0000000..be6d19d --- /dev/null +++ b/website/docs/services/events/event_buses/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_bus resource or lists event_buses in a region + +## Overview + + + + + + + +
Nameevent_buses
TypeResource
DescriptionResource type definition for AWS::Events::EventBus
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringIf you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
stringThe name of the event bus.
arrayAny tags assigned to the event bus.
stringThe description of the event bus.
stringKms Key Identifier used to encrypt events at rest in the event bus.
objectA JSON string that describes the permission policy statement for the event bus.
stringThe Amazon Resource Name (ARN) for the event bus.
objectDead Letter Queue for the event bus.
stringAWS region.
+ +For more information, see AWS::Events::EventBus. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_buses in a region. +```sql +SELECT +region, +event_source_name, +name, +tags, +description, +kms_key_identifier, +policy, +arn, +dead_letter_config +FROM aws.events.event_buses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_bus. +```sql +SELECT +region, +event_source_name, +name, +tags, +description, +kms_key_identifier, +policy, +arn, +dead_letter_config +FROM aws.events.event_buses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_bus resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.events.event_buses ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.events.event_buses ( + EventSourceName, + Name, + Tags, + Description, + KmsKeyIdentifier, + Policy, + DeadLetterConfig, + region +) +SELECT + '{{ EventSourceName }}', + '{{ Name }}', + '{{ Tags }}', + '{{ Description }}', + '{{ KmsKeyIdentifier }}', + '{{ Policy }}', + '{{ DeadLetterConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_bus + props: + - name: EventSourceName + value: '{{ EventSourceName }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Description + value: '{{ Description }}' + - name: KmsKeyIdentifier + value: '{{ KmsKeyIdentifier }}' + - name: Policy + value: {} + - name: DeadLetterConfig + value: + Arn: '{{ Arn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.events.event_buses +WHERE data__Identifier = '' +AND 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, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Read +```json +events:DescribeEventBus, +events:ListTagsForResource +``` + +### Update +```json +events:TagResource, +events:UntagResource, +events:PutPermission, +events:DescribeEventBus, +events:UpdateEventBus, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +events:DescribeEventBus, +events:UpdateEventBus, +events:ListTagsForResource, +events:UntagResource, +events:RemovePermission, +events:DeleteEventBus +``` + +### List +```json +events:ListEventBuses, +events:ListTagsForResource +``` diff --git a/website/docs/services/events/event_buses_list_only/index.md b/website/docs/services/events/event_buses_list_only/index.md new file mode 100644 index 0000000..8ff5240 --- /dev/null +++ b/website/docs/services/events/event_buses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: event_buses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_buses_list_only + - events + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_buses in a region or regions, for all properties use event_buses + +## Overview + + + + + + + +
Nameevent_buses_list_only
TypeResource
DescriptionResource type definition for AWS::Events::EventBus
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the event bus.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_buses in a region. +```sql +SELECT +region, +name +FROM aws.events.event_buses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_buses_list_only resource, see event_buses + diff --git a/website/docs/services/events/index.md b/website/docs/services/events/index.md new file mode 100644 index 0000000..4d9a641 --- /dev/null +++ b/website/docs/services/events/index.md @@ -0,0 +1,48 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The events service documentation. + +:::info Service Summary + +
+
+total resources: 13
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/events/rules/index.md b/website/docs/services/events/rules/index.md new file mode 100644 index 0000000..37a1712 --- /dev/null +++ b/website/docs/services/events/rules/index.md @@ -0,0 +1,352 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a rule resource or lists rules in a region + +## Overview + + + + + + + +
Namerules
TypeResource
DescriptionResource Type definition for AWS::Events::Rule
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
objectThe event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
stringThe scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
stringThe description of the rule.
stringThe state of the rule.
arrayAdds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
stringThe ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
stringThe Amazon Resource Name (ARN) of the role that is used for target invocation.
stringThe name of the rule.
stringAWS region.
+ +For more information, see AWS::Events::Rule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rules in a region. +```sql +SELECT +region, +event_bus_name, +event_pattern, +schedule_expression, +description, +state, +targets, +arn, +role_arn, +name +FROM aws.events.rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual rule. +```sql +SELECT +region, +event_bus_name, +event_pattern, +schedule_expression, +description, +state, +targets, +arn, +role_arn, +name +FROM aws.events.rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.events.rules ( + EventBusName, + EventPattern, + ScheduleExpression, + Description, + State, + Targets, + RoleArn, + Name, + region +) +SELECT +'{{ EventBusName }}', + '{{ EventPattern }}', + '{{ ScheduleExpression }}', + '{{ Description }}', + '{{ State }}', + '{{ Targets }}', + '{{ RoleArn }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.events.rules ( + EventBusName, + EventPattern, + ScheduleExpression, + Description, + State, + Targets, + RoleArn, + Name, + region +) +SELECT + '{{ EventBusName }}', + '{{ EventPattern }}', + '{{ ScheduleExpression }}', + '{{ Description }}', + '{{ State }}', + '{{ Targets }}', + '{{ RoleArn }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: rule + props: + - name: EventBusName + value: '{{ EventBusName }}' + - name: EventPattern + value: {} + - name: ScheduleExpression + value: '{{ ScheduleExpression }}' + - name: Description + value: '{{ Description }}' + - name: State + value: '{{ State }}' + - name: Targets + value: + - InputPath: '{{ InputPath }}' + HttpParameters: + PathParameterValues: + - '{{ PathParameterValues[0] }}' + HeaderParameters: {} + QueryStringParameters: {} + DeadLetterConfig: + Arn: '{{ Arn }}' + RunCommandParameters: + RunCommandTargets: + - Values: + - '{{ Values[0] }}' + Key: '{{ Key }}' + InputTransformer: + InputPathsMap: {} + InputTemplate: '{{ InputTemplate }}' + KinesisParameters: + PartitionKeyPath: '{{ PartitionKeyPath }}' + RoleArn: '{{ RoleArn }}' + RedshiftDataParameters: + StatementName: '{{ StatementName }}' + Sqls: + - '{{ Sqls[0] }}' + Database: '{{ Database }}' + SecretManagerArn: '{{ SecretManagerArn }}' + DbUser: '{{ DbUser }}' + Sql: '{{ Sql }}' + WithEvent: '{{ WithEvent }}' + AppSyncParameters: + GraphQLOperation: '{{ GraphQLOperation }}' + Input: '{{ Input }}' + SqsParameters: + MessageGroupId: '{{ MessageGroupId }}' + EcsParameters: + PlatformVersion: '{{ PlatformVersion }}' + Group: '{{ Group }}' + EnableECSManagedTags: '{{ EnableECSManagedTags }}' + EnableExecuteCommand: '{{ EnableExecuteCommand }}' + PlacementConstraints: + - Type: '{{ Type }}' + Expression: '{{ Expression }}' + PropagateTags: '{{ PropagateTags }}' + TaskCount: '{{ TaskCount }}' + PlacementStrategies: + - Field: '{{ Field }}' + Type: '{{ Type }}' + CapacityProviderStrategy: + - CapacityProvider: '{{ CapacityProvider }}' + Base: '{{ Base }}' + Weight: '{{ Weight }}' + LaunchType: '{{ LaunchType }}' + ReferenceId: '{{ ReferenceId }}' + TagList: + - Value: '{{ Value }}' + Key: '{{ Key }}' + NetworkConfiguration: + AwsVpcConfiguration: + SecurityGroups: + - '{{ SecurityGroups[0] }}' + Subnets: + - '{{ Subnets[0] }}' + AssignPublicIp: '{{ AssignPublicIp }}' + TaskDefinitionArn: '{{ TaskDefinitionArn }}' + BatchParameters: + ArrayProperties: + Size: '{{ Size }}' + JobName: '{{ JobName }}' + RetryStrategy: + Attempts: '{{ Attempts }}' + JobDefinition: '{{ JobDefinition }}' + Id: '{{ Id }}' + Arn: '{{ Arn }}' + SageMakerPipelineParameters: + PipelineParameterList: + - Value: '{{ Value }}' + Name: '{{ Name }}' + RetryPolicy: + MaximumRetryAttempts: '{{ MaximumRetryAttempts }}' + MaximumEventAgeInSeconds: '{{ MaximumEventAgeInSeconds }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.events.rules +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the rules resource, the following permissions are required: + +### Read +```json +iam:PassRole, +events:DescribeRule, +events:ListTargetsByRule +``` + +### Create +```json +iam:PassRole, +events:DescribeRule, +events:PutRule, +events:PutTargets +``` + +### Update +```json +iam:PassRole, +events:DescribeRule, +events:PutRule, +events:RemoveTargets, +events:PutTargets +``` + +### List +```json +events:ListRules +``` + +### Delete +```json +iam:PassRole, +events:DescribeRule, +events:DeleteRule, +events:RemoveTargets, +events:ListTargetsByRule +``` diff --git a/website/docs/services/events/rules_list_only/index.md b/website/docs/services/events/rules_list_only/index.md new file mode 100644 index 0000000..78a0945 --- /dev/null +++ b/website/docs/services/events/rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rules_list_only + - events + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rules in a region or regions, for all properties use rules + +## Overview + + + + + + + +
Namerules_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::Rule
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rules in a region. +```sql +SELECT +region, +arn +FROM aws.events.rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rules_list_only resource, see rules + diff --git a/website/docs/services/eventschemas/discoverer_tags/index.md b/website/docs/services/eventschemas/discoverer_tags/index.md new file mode 100644 index 0000000..10d145c --- /dev/null +++ b/website/docs/services/eventschemas/discoverer_tags/index.md @@ -0,0 +1,87 @@ +--- +title: discoverer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - discoverer_tags + - eventschemas + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for discoverers in a region + +## Overview + + + + + + + +
Namediscoverer_tags
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Discoverer
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the discoverer.
stringThe Id of the discoverer.
stringA description for the discoverer.
stringThe ARN of the event bus.
booleanDefines whether event schemas from other accounts are discovered. Default is True.
stringDefines the current state of the discoverer.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all discoverers in a region. +```sql +SELECT +region, +discoverer_arn, +discoverer_id, +description, +source_arn, +cross_account, +state, +tag_key, +tag_value +FROM aws.eventschemas.discoverer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the discoverer_tags resource, see discoverers + diff --git a/website/docs/services/eventschemas/discoverers/index.md b/website/docs/services/eventschemas/discoverers/index.md new file mode 100644 index 0000000..a4b1efa --- /dev/null +++ b/website/docs/services/eventschemas/discoverers/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a discoverer resource or lists discoverers in a region + +## Overview + + + + + + + +
Namediscoverers
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Discoverer
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the discoverer.
stringThe Id of the discoverer.
stringA description for the discoverer.
stringThe ARN of the event bus.
booleanDefines whether event schemas from other accounts are discovered. Default is True.
stringDefines the current state of the discoverer.
arrayTags associated with the resource.
stringAWS region.
+ +For more information, see AWS::EventSchemas::Discoverer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all discoverers in a region. +```sql +SELECT +region, +discoverer_arn, +discoverer_id, +description, +source_arn, +cross_account, +state, +tags +FROM aws.eventschemas.discoverers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual discoverer. +```sql +SELECT +region, +discoverer_arn, +discoverer_id, +description, +source_arn, +cross_account, +state, +tags +FROM aws.eventschemas.discoverers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new discoverer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eventschemas.discoverers ( + SourceArn, + region +) +SELECT +'{{ SourceArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eventschemas.discoverers ( + Description, + SourceArn, + CrossAccount, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ SourceArn }}', + '{{ CrossAccount }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: discoverer + props: + - name: Description + value: '{{ Description }}' + - name: SourceArn + value: '{{ SourceArn }}' + - name: CrossAccount + value: '{{ CrossAccount }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eventschemas.discoverers +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +schemas:ListDiscoverers +``` diff --git a/website/docs/services/eventschemas/discoverers_list_only/index.md b/website/docs/services/eventschemas/discoverers_list_only/index.md new file mode 100644 index 0000000..eb58e2d --- /dev/null +++ b/website/docs/services/eventschemas/discoverers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: discoverers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - discoverers_list_only + - eventschemas + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists discoverers in a region or regions, for all properties use discoverers + +## Overview + + + + + + + +
Namediscoverers_list_only
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Discoverer
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the discoverer.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all discoverers in a region. +```sql +SELECT +region, +discoverer_arn +FROM aws.eventschemas.discoverers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the discoverers_list_only resource, see discoverers + diff --git a/website/docs/services/eventschemas/index.md b/website/docs/services/eventschemas/index.md new file mode 100644 index 0000000..dfca3e9 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The eventschemas service documentation. + +:::info Service Summary + +
+
+total resources: 10
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/eventschemas/registries/index.md b/website/docs/services/eventschemas/registries/index.md new file mode 100644 index 0000000..588295c --- /dev/null +++ b/website/docs/services/eventschemas/registries/index.md @@ -0,0 +1,224 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a registry resource or lists registries in a region + +## Overview + + + + + + + +
Nameregistries
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Registry
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the schema registry.
stringA description of the registry to be created.
stringThe ARN of the registry.
arrayTags associated with the resource.
stringAWS region.
+ +For more information, see AWS::EventSchemas::Registry. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all registries in a region. +```sql +SELECT +region, +registry_name, +description, +registry_arn, +tags +FROM aws.eventschemas.registries +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual registry. +```sql +SELECT +region, +registry_name, +description, +registry_arn, +tags +FROM aws.eventschemas.registries +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new registry resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eventschemas.registries ( + RegistryName, + Description, + Tags, + region +) +SELECT +'{{ RegistryName }}', + '{{ Description }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eventschemas.registries ( + RegistryName, + Description, + Tags, + region +) +SELECT + '{{ RegistryName }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: registry + props: + - name: RegistryName + value: '{{ RegistryName }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eventschemas.registries +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the registries resource, the following permissions are required: + +### Create +```json +schemas:DescribeRegistry, +schemas:CreateRegistry, +schemas:TagResource +``` + +### Read +```json +schemas:DescribeRegistry +``` + +### Update +```json +schemas:DescribeRegistry, +schemas:UpdateRegistry, +schemas:TagResource, +schemas:UntagResource, +schemas:ListTagsForResource +``` + +### Delete +```json +schemas:DescribeRegistry, +schemas:DeleteRegistry +``` + +### List +```json +schemas:ListRegistries +``` diff --git a/website/docs/services/eventschemas/registries_list_only/index.md b/website/docs/services/eventschemas/registries_list_only/index.md new file mode 100644 index 0000000..99ac5a3 --- /dev/null +++ b/website/docs/services/eventschemas/registries_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: registries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - registries_list_only + - eventschemas + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists registries in a region or regions, for all properties use registries + +## Overview + + + + + + + +
Nameregistries_list_only
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Registry
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the registry.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all registries in a region. +```sql +SELECT +region, +registry_arn +FROM aws.eventschemas.registries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the registries_list_only resource, see registries + diff --git a/website/docs/services/eventschemas/registry_policies/index.md b/website/docs/services/eventschemas/registry_policies/index.md new file mode 100644 index 0000000..d76f990 --- /dev/null +++ b/website/docs/services/eventschemas/registry_policies/index.md @@ -0,0 +1,197 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a registry_policy resource or lists registry_policies in a region + +## Overview + + + + + + + +
Nameregistry_policies
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::RegistryPolicy
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
object
string
string
stringAWS region.
+ +For more information, see AWS::EventSchemas::RegistryPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual registry_policy. +```sql +SELECT +region, +id, +policy, +registry_name, +revision_id +FROM aws.eventschemas.registry_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new registry_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eventschemas.registry_policies ( + Policy, + RegistryName, + region +) +SELECT +'{{ Policy }}', + '{{ RegistryName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eventschemas.registry_policies ( + Policy, + RegistryName, + RevisionId, + region +) +SELECT + '{{ Policy }}', + '{{ RegistryName }}', + '{{ RevisionId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: registry_policy + props: + - name: Policy + value: {} + - name: RegistryName + value: '{{ RegistryName }}' + - name: RevisionId + value: '{{ RevisionId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eventschemas.registry_policies +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +schemas:DeleteResourcePolicy, +schemas:GetResourcePolicy +``` + +### Update +```json +schemas:PutResourcePolicy, +schemas:GetResourcePolicy +``` + +### Read +```json +schemas:GetResourcePolicy +``` diff --git a/website/docs/services/eventschemas/registry_tags/index.md b/website/docs/services/eventschemas/registry_tags/index.md new file mode 100644 index 0000000..b6acef9 --- /dev/null +++ b/website/docs/services/eventschemas/registry_tags/index.md @@ -0,0 +1,81 @@ +--- +title: registry_tags +hide_title: false +hide_table_of_contents: false +keywords: + - registry_tags + - eventschemas + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for registries in a region + +## Overview + + + + + + + +
Nameregistry_tags
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Registry
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the schema registry.
stringA description of the registry to be created.
stringThe ARN of the registry.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all registries in a region. +```sql +SELECT +region, +registry_name, +description, +registry_arn, +tag_key, +tag_value +FROM aws.eventschemas.registry_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the registry_tags resource, see registries + diff --git a/website/docs/services/eventschemas/schema_tags/index.md b/website/docs/services/eventschemas/schema_tags/index.md new file mode 100644 index 0000000..06e8cdc --- /dev/null +++ b/website/docs/services/eventschemas/schema_tags/index.md @@ -0,0 +1,93 @@ +--- +title: schema_tags +hide_title: false +hide_table_of_contents: false +keywords: + - schema_tags + - eventschemas + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for schemata in a region + +## Overview + + + + + + + +
Nameschema_tags
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Schema
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
stringA description of the schema.
stringThe version number of the schema.
stringThe source of the schema definition.
stringThe name of the schema registry.
stringThe ARN of the schema.
stringThe name of the schema.
stringThe last modified time of the schema.
stringThe date the schema version was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all schemata in a region. +```sql +SELECT +region, +type, +description, +schema_version, +content, +registry_name, +schema_arn, +schema_name, +last_modified, +version_created_date, +tag_key, +tag_value +FROM aws.eventschemas.schema_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schema_tags resource, see schemata + diff --git a/website/docs/services/eventschemas/schemata/index.md b/website/docs/services/eventschemas/schemata/index.md new file mode 100644 index 0000000..8a9764f --- /dev/null +++ b/website/docs/services/eventschemas/schemata/index.md @@ -0,0 +1,256 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a schema resource or lists schemata in a region + +## Overview + + + + + + + +
Nameschemata
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Schema
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
stringA description of the schema.
stringThe version number of the schema.
stringThe source of the schema definition.
stringThe name of the schema registry.
stringThe ARN of the schema.
stringThe name of the schema.
stringThe last modified time of the schema.
stringThe date the schema version was created.
arrayTags associated with the resource.
stringAWS region.
+ +For more information, see AWS::EventSchemas::Schema. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all schemata in a region. +```sql +SELECT +region, +type, +description, +schema_version, +content, +registry_name, +schema_arn, +schema_name, +last_modified, +version_created_date, +tags +FROM aws.eventschemas.schemata +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual schema. +```sql +SELECT +region, +type, +description, +schema_version, +content, +registry_name, +schema_arn, +schema_name, +last_modified, +version_created_date, +tags +FROM aws.eventschemas.schemata +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new schema resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.eventschemas.schemata ( + Type, + Content, + RegistryName, + region +) +SELECT +'{{ Type }}', + '{{ Content }}', + '{{ RegistryName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.eventschemas.schemata ( + Type, + Description, + Content, + RegistryName, + SchemaName, + Tags, + region +) +SELECT + '{{ Type }}', + '{{ Description }}', + '{{ Content }}', + '{{ RegistryName }}', + '{{ SchemaName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: schema + props: + - name: Type + value: '{{ Type }}' + - name: Description + value: '{{ Description }}' + - name: Content + value: '{{ Content }}' + - name: RegistryName + value: '{{ RegistryName }}' + - name: SchemaName + value: '{{ SchemaName }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.eventschemas.schemata +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the schemata resource, the following permissions are required: + +### Create +```json +schemas:DescribeSchema, +schemas:CreateSchema, +schemas:TagResource +``` + +### Read +```json +schemas:DescribeSchema +``` + +### Update +```json +schemas:DescribeSchema, +schemas:UpdateSchema, +schemas:TagResource, +schemas:UntagResource, +schemas:ListTagsForResource +``` + +### Delete +```json +schemas:DescribeSchema, +schemas:DeleteSchema, +schemas:DeleteSchemaVersion +``` + +### List +```json +schemas:ListSchemas, +schemas:ListSchemaVersions +``` diff --git a/website/docs/services/eventschemas/schemata_list_only/index.md b/website/docs/services/eventschemas/schemata_list_only/index.md new file mode 100644 index 0000000..3e91a5d --- /dev/null +++ b/website/docs/services/eventschemas/schemata_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: schemata_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schemata_list_only + - eventschemas + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schemata in a region or regions, for all properties use schemata + +## Overview + + + + + + + +
Nameschemata_list_only
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Schema
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the schema.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schemata in a region. +```sql +SELECT +region, +schema_arn +FROM aws.eventschemas.schemata_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schemata_list_only resource, see schemata + diff --git a/website/docs/services/evidently/experiments/index.md b/website/docs/services/evidently/experiments/index.md new file mode 100644 index 0000000..721dc34 --- /dev/null +++ b/website/docs/services/evidently/experiments/index.md @@ -0,0 +1,284 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an experiment resource or lists experiments in a region + +## Overview + + + + + + + +
Nameexperiments
TypeResource
DescriptionResource Type definition for AWS::Evidently::Experiment.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
objectStart Experiment. Default is False
string
array
array
integer
object
string
boolean
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Evidently::Experiment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual experiment. +```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.experiments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new experiment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.evidently.experiments ( + Name, + Project, + Treatments, + MetricGoals, + OnlineAbConfig, + region +) +SELECT +'{{ Name }}', + '{{ Project }}', + '{{ Treatments }}', + '{{ MetricGoals }}', + '{{ OnlineAbConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.evidently.experiments ( + Name, + Project, + Description, + RunningStatus, + RandomizationSalt, + Treatments, + MetricGoals, + SamplingRate, + OnlineAbConfig, + Segment, + RemoveSegment, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Project }}', + '{{ Description }}', + '{{ RunningStatus }}', + '{{ RandomizationSalt }}', + '{{ Treatments }}', + '{{ MetricGoals }}', + '{{ SamplingRate }}', + '{{ OnlineAbConfig }}', + '{{ Segment }}', + '{{ RemoveSegment }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: experiment + props: + - name: Name + value: '{{ Name }}' + - name: Project + value: '{{ Project }}' + - name: Description + value: '{{ Description }}' + - name: RunningStatus + value: + Status: '{{ Status }}' + AnalysisCompleteTime: '{{ AnalysisCompleteTime }}' + Reason: '{{ Reason }}' + DesiredState: '{{ DesiredState }}' + - name: RandomizationSalt + value: '{{ RandomizationSalt }}' + - name: Treatments + value: + - TreatmentName: '{{ TreatmentName }}' + Description: '{{ Description }}' + Feature: '{{ Feature }}' + Variation: '{{ Variation }}' + - name: MetricGoals + value: + - MetricName: '{{ MetricName }}' + EntityIdKey: '{{ EntityIdKey }}' + ValueKey: '{{ ValueKey }}' + EventPattern: '{{ EventPattern }}' + UnitLabel: '{{ UnitLabel }}' + DesiredChange: '{{ DesiredChange }}' + - name: SamplingRate + value: '{{ SamplingRate }}' + - name: OnlineAbConfig + value: + ControlTreatmentName: '{{ ControlTreatmentName }}' + TreatmentWeights: + - Treatment: '{{ Treatment }}' + SplitWeight: '{{ SplitWeight }}' + - name: Segment + value: '{{ Segment }}' + - name: RemoveSegment + value: '{{ RemoveSegment }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.evidently.experiments +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/evidently/features/index.md b/website/docs/services/evidently/features/index.md new file mode 100644 index 0000000..d7db4bb --- /dev/null +++ b/website/docs/services/evidently/features/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a feature resource or lists features in a region + +## Overview + + + + + + + +
Namefeatures
TypeResource
DescriptionResource Type definition for AWS::Evidently::Feature.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
string
array
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Evidently::Feature. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual feature. +```sql +SELECT +region, +arn, +project, +name, +description, +evaluation_strategy, +variations, +default_variation, +entity_overrides, +tags +FROM aws.evidently.features +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new feature resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.evidently.features ( + Project, + Name, + Variations, + region +) +SELECT +'{{ Project }}', + '{{ Name }}', + '{{ Variations }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.evidently.features ( + Project, + Name, + Description, + EvaluationStrategy, + Variations, + DefaultVariation, + EntityOverrides, + Tags, + region +) +SELECT + '{{ Project }}', + '{{ Name }}', + '{{ Description }}', + '{{ EvaluationStrategy }}', + '{{ Variations }}', + '{{ DefaultVariation }}', + '{{ EntityOverrides }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: feature + props: + - name: Project + value: '{{ Project }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: EvaluationStrategy + value: '{{ EvaluationStrategy }}' + - name: Variations + value: + - VariationName: '{{ VariationName }}' + BooleanValue: '{{ BooleanValue }}' + StringValue: '{{ StringValue }}' + LongValue: null + DoubleValue: null + - name: DefaultVariation + value: '{{ DefaultVariation }}' + - name: EntityOverrides + value: + - EntityId: '{{ EntityId }}' + Variation: '{{ Variation }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.evidently.features +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the features resource, the following permissions are required: + +### Create +```json +evidently:CreateFeature, +evidently:TagResource, +evidently:GetFeature +``` + +### 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/website/docs/services/evidently/index.md b/website/docs/services/evidently/index.md new file mode 100644 index 0000000..59622fd --- /dev/null +++ b/website/docs/services/evidently/index.md @@ -0,0 +1,42 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The evidently service documentation. + +:::info Service Summary + +
+
+total resources: 7
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/evidently/launches/index.md b/website/docs/services/evidently/launches/index.md new file mode 100644 index 0000000..4927a15 --- /dev/null +++ b/website/docs/services/evidently/launches/index.md @@ -0,0 +1,268 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a launch resource or lists launches in a region + +## Overview + + + + + + + +
Namelaunches
TypeResource
DescriptionResource Type definition for AWS::Evidently::Launch.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
array
array
arrayAn array of key-value pairs to apply to this resource.
objectStart or Stop Launch Launch. Default is not started.
stringAWS region.
+ +For more information, see AWS::Evidently::Launch. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual launch. +```sql +SELECT +region, +arn, +name, +project, +description, +randomization_salt, +scheduled_splits_config, +groups, +metric_monitors, +tags, +execution_status +FROM aws.evidently.launches +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new launch resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.evidently.launches ( + Name, + Project, + ScheduledSplitsConfig, + Groups, + region +) +SELECT +'{{ Name }}', + '{{ Project }}', + '{{ ScheduledSplitsConfig }}', + '{{ Groups }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.evidently.launches ( + Name, + Project, + Description, + RandomizationSalt, + ScheduledSplitsConfig, + Groups, + MetricMonitors, + Tags, + ExecutionStatus, + region +) +SELECT + '{{ Name }}', + '{{ Project }}', + '{{ Description }}', + '{{ RandomizationSalt }}', + '{{ ScheduledSplitsConfig }}', + '{{ Groups }}', + '{{ MetricMonitors }}', + '{{ Tags }}', + '{{ ExecutionStatus }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: launch + props: + - name: Name + value: '{{ Name }}' + - name: Project + value: '{{ Project }}' + - name: Description + value: '{{ Description }}' + - name: RandomizationSalt + value: '{{ RandomizationSalt }}' + - name: ScheduledSplitsConfig + value: + - StartTime: '{{ StartTime }}' + GroupWeights: + - GroupName: '{{ GroupName }}' + SplitWeight: '{{ SplitWeight }}' + SegmentOverrides: + - Segment: '{{ Segment }}' + EvaluationOrder: '{{ EvaluationOrder }}' + Weights: + - null + - name: Groups + value: + - GroupName: '{{ GroupName }}' + Description: '{{ Description }}' + Feature: '{{ Feature }}' + Variation: '{{ Variation }}' + - name: MetricMonitors + value: + - MetricName: '{{ MetricName }}' + EntityIdKey: '{{ EntityIdKey }}' + ValueKey: '{{ ValueKey }}' + EventPattern: '{{ EventPattern }}' + UnitLabel: '{{ UnitLabel }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ExecutionStatus + value: + Status: '{{ Status }}' + DesiredState: '{{ DesiredState }}' + Reason: '{{ Reason }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.evidently.launches +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/evidently/projects/index.md b/website/docs/services/evidently/projects/index.md new file mode 100644 index 0000000..661c0c0 --- /dev/null +++ b/website/docs/services/evidently/projects/index.md @@ -0,0 +1,265 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a project resource or lists projects in a region + +## Overview + + + + + + + +
Nameprojects
TypeResource
DescriptionResource Type definition for AWS::Evidently::Project
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
objectDestinations for data.
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Evidently::Project. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual project. +```sql +SELECT +region, +arn, +name, +description, +data_delivery, +app_config_resource, +tags +FROM aws.evidently.projects +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.evidently.projects ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.evidently.projects ( + Name, + Description, + DataDelivery, + AppConfigResource, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ DataDelivery }}', + '{{ AppConfigResource }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: project + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: DataDelivery + value: + S3: + BucketName: '{{ BucketName }}' + Prefix: '{{ Prefix }}' + LogGroup: '{{ LogGroup }}' + - name: AppConfigResource + value: + ApplicationId: '{{ ApplicationId }}' + EnvironmentId: '{{ EnvironmentId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.evidently.projects +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/evidently/segment_tags/index.md b/website/docs/services/evidently/segment_tags/index.md new file mode 100644 index 0000000..ad0d0ba --- /dev/null +++ b/website/docs/services/evidently/segment_tags/index.md @@ -0,0 +1,83 @@ +--- +title: segment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - segment_tags + - evidently + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for segments in a region + +## Overview + + + + + + + +
Namesegment_tags
TypeResource
DescriptionResource Type definition for AWS::Evidently::Segment
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all segments in a region. +```sql +SELECT +region, +arn, +name, +description, +pattern, +tag_key, +tag_value +FROM aws.evidently.segment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the segment_tags resource, see segments + diff --git a/website/docs/services/evidently/segments/index.md b/website/docs/services/evidently/segments/index.md new file mode 100644 index 0000000..27b32e5 --- /dev/null +++ b/website/docs/services/evidently/segments/index.md @@ -0,0 +1,216 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a segment resource or lists segments in a region + +## Overview + + + + + + + +
Namesegments
TypeResource
DescriptionResource Type definition for AWS::Evidently::Segment
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Evidently::Segment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all segments in a region. +```sql +SELECT +region, +arn, +name, +description, +pattern, +tags +FROM aws.evidently.segments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual segment. +```sql +SELECT +region, +arn, +name, +description, +pattern, +tags +FROM aws.evidently.segments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new segment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.evidently.segments ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.evidently.segments ( + Name, + Description, + Pattern, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Pattern }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: segment + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Pattern + value: '{{ Pattern }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.evidently.segments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the segments resource, the following permissions are required: + +### Create +```json +evidently:CreateSegment, +evidently:GetSegment, +evidently:TagResource +``` + +### Read +```json +evidently:GetSegment, +evidently:ListTagsForResource +``` + +### Delete +```json +evidently:DeleteSegment, +evidently:GetSegment, +evidently:UntagResource +``` + +### List +```json +evidently:ListSegment, +evidently:ListTagsForResource +``` diff --git a/website/docs/services/evidently/segments_list_only/index.md b/website/docs/services/evidently/segments_list_only/index.md new file mode 100644 index 0000000..c3002e7 --- /dev/null +++ b/website/docs/services/evidently/segments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: segments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - segments_list_only + - evidently + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists segments in a region or regions, for all properties use segments + +## Overview + + + + + + + +
Namesegments_list_only
TypeResource
DescriptionResource Type definition for AWS::Evidently::Segment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all segments in a region. +```sql +SELECT +region, +arn +FROM aws.evidently.segments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the segments_list_only resource, see segments + diff --git a/website/docs/services/finspace/environment_tags/index.md b/website/docs/services/finspace/environment_tags/index.md new file mode 100644 index 0000000..f32a646 --- /dev/null +++ b/website/docs/services/finspace/environment_tags/index.md @@ -0,0 +1,103 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - finspace + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + + + +
Nameenvironment_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier for representing FinSpace Environment
stringName of the Environment
stringAWS account ID associated with the Environment
stringDescription of the Environment
stringState of the Environment
stringURL used to login to the Environment
stringARN of the Environment
stringSageMaker Studio Domain URL associated with the Environment
stringKMS key used to encrypt customer data within FinSpace Environment infrastructure
stringID for FinSpace created account used to store Environment artifacts
stringFederation mode used with the Environment
objectAdditional parameters to identify Federation mode
objectParameters of the first Superuser for the FinSpace Environment
arrayARNs of FinSpace Data Bundles to install
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +environment_id, +name, +aws_account_id, +description, +status, +environment_url, +environment_arn, +sage_maker_studio_domain_url, +kms_key_id, +dedicated_service_account_id, +federation_mode, +federation_parameters, +superuser_parameters, +data_bundles, +tag_key, +tag_value +FROM aws.finspace.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + diff --git a/website/docs/services/finspace/environments/index.md b/website/docs/services/finspace/environments/index.md new file mode 100644 index 0000000..1d3ae00 --- /dev/null +++ b/website/docs/services/finspace/environments/index.md @@ -0,0 +1,282 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment resource or lists environments in a region + +## Overview + + + + + + + +
Nameenvironments
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier for representing FinSpace Environment
stringName of the Environment
stringAWS account ID associated with the Environment
stringDescription of the Environment
stringState of the Environment
stringURL used to login to the Environment
stringARN of the Environment
stringSageMaker Studio Domain URL associated with the Environment
stringKMS key used to encrypt customer data within FinSpace Environment infrastructure
stringID for FinSpace created account used to store Environment artifacts
stringFederation mode used with the Environment
objectAdditional parameters to identify Federation mode
objectParameters of the first Superuser for the FinSpace Environment
arrayARNs of FinSpace Data Bundles to install
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::FinSpace::Environment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environments in a region. +```sql +SELECT +region, +environment_id, +name, +aws_account_id, +description, +status, +environment_url, +environment_arn, +sage_maker_studio_domain_url, +kms_key_id, +dedicated_service_account_id, +federation_mode, +federation_parameters, +superuser_parameters, +data_bundles, +tags +FROM aws.finspace.environments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment. +```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.environments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.finspace.environments ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.finspace.environments ( + Name, + Description, + KmsKeyId, + FederationMode, + FederationParameters, + SuperuserParameters, + DataBundles, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ KmsKeyId }}', + '{{ FederationMode }}', + '{{ FederationParameters }}', + '{{ SuperuserParameters }}', + '{{ DataBundles }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: FederationMode + value: '{{ FederationMode }}' + - name: FederationParameters + value: + SamlMetadataURL: '{{ SamlMetadataURL }}' + FederationProviderName: '{{ FederationProviderName }}' + SamlMetadataDocument: '{{ SamlMetadataDocument }}' + ApplicationCallBackURL: '{{ ApplicationCallBackURL }}' + FederationURN: '{{ FederationURN }}' + AttributeMap: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: SuperuserParameters + value: + FirstName: '{{ FirstName }}' + LastName: '{{ LastName }}' + EmailAddress: '{{ EmailAddress }}' + - name: DataBundles + value: + - '{{ DataBundles[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.finspace.environments +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +finspace:GetEnvironment +``` + +### Update +```json +finspace:UpdateEnvironment +``` + +### Delete +```json +finspace:DeleteEnvironment, +finspace:GetEnvironment +``` + +### List +```json +finspace:ListEnvironments +``` diff --git a/website/docs/services/finspace/environments_list_only/index.md b/website/docs/services/finspace/environments_list_only/index.md new file mode 100644 index 0000000..c4db3b9 --- /dev/null +++ b/website/docs/services/finspace/environments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique identifier for representing FinSpace Environment
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +environment_id +FROM aws.finspace.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + diff --git a/website/docs/services/finspace/index.md b/website/docs/services/finspace/index.md new file mode 100644 index 0000000..b8ab66e --- /dev/null +++ b/website/docs/services/finspace/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The finspace service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/fis/experiment_template_tags/index.md b/website/docs/services/fis/experiment_template_tags/index.md new file mode 100644 index 0000000..72718b3 --- /dev/null +++ b/website/docs/services/fis/experiment_template_tags/index.md @@ -0,0 +1,93 @@ +--- +title: experiment_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - experiment_template_tags + - fis + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for experiment_templates in a region + +## Overview + + + + + + + +
Nameexperiment_template_tags
TypeResource
DescriptionResource schema for AWS::FIS::ExperimentTemplate
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA description for the experiment template.
objectThe targets for the experiment.
objectThe actions for the experiment.
arrayOne or more stop conditions.
object
stringThe Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all experiment_templates in a region. +```sql +SELECT +region, +id, +description, +targets, +actions, +stop_conditions, +log_configuration, +role_arn, +experiment_options, +experiment_report_configuration, +tag_key, +tag_value +FROM aws.fis.experiment_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the experiment_template_tags resource, see experiment_templates + diff --git a/website/docs/services/fis/experiment_templates/index.md b/website/docs/services/fis/experiment_templates/index.md new file mode 100644 index 0000000..e96b2e6 --- /dev/null +++ b/website/docs/services/fis/experiment_templates/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an experiment_template resource or lists experiment_templates in a region + +## Overview + + + + + + + +
Nameexperiment_templates
TypeResource
DescriptionResource schema for AWS::FIS::ExperimentTemplate
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA description for the experiment template.
objectThe targets for the experiment.
objectThe actions for the experiment.
arrayOne or more stop conditions.
object
stringThe Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
object
object
object
stringAWS region.
+ +For more information, see AWS::FIS::ExperimentTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all experiment_templates in a region. +```sql +SELECT +region, +id, +description, +targets, +actions, +stop_conditions, +log_configuration, +role_arn, +tags, +experiment_options, +experiment_report_configuration +FROM aws.fis.experiment_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual experiment_template. +```sql +SELECT +region, +id, +description, +targets, +actions, +stop_conditions, +log_configuration, +role_arn, +tags, +experiment_options, +experiment_report_configuration +FROM aws.fis.experiment_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new experiment_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.fis.experiment_templates ( + Description, + Targets, + StopConditions, + RoleArn, + Tags, + region +) +SELECT +'{{ Description }}', + '{{ Targets }}', + '{{ StopConditions }}', + '{{ RoleArn }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.fis.experiment_templates ( + Description, + Targets, + Actions, + StopConditions, + LogConfiguration, + RoleArn, + Tags, + ExperimentOptions, + ExperimentReportConfiguration, + region +) +SELECT + '{{ Description }}', + '{{ Targets }}', + '{{ Actions }}', + '{{ StopConditions }}', + '{{ LogConfiguration }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ ExperimentOptions }}', + '{{ ExperimentReportConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: experiment_template + props: + - name: Description + value: '{{ Description }}' + - name: Targets + value: {} + - name: Actions + value: {} + - name: StopConditions + value: + - Source: '{{ Source }}' + Value: '{{ Value }}' + - name: LogConfiguration + value: + CloudWatchLogsConfiguration: + LogGroupArn: '{{ LogGroupArn }}' + S3Configuration: + BucketName: '{{ BucketName }}' + Prefix: '{{ Prefix }}' + LogSchemaVersion: '{{ LogSchemaVersion }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: {} + - name: ExperimentOptions + value: + AccountTargeting: '{{ AccountTargeting }}' + EmptyTargetResolutionMode: '{{ EmptyTargetResolutionMode }}' + - name: ExperimentReportConfiguration + value: + Outputs: + ExperimentReportS3Configuration: + BucketName: '{{ BucketName }}' + Prefix: '{{ Prefix }}' + DataSources: + CloudWatchDashboards: + - DashboardIdentifier: '{{ DashboardIdentifier }}' + PreExperimentDuration: '{{ PreExperimentDuration }}' + PostExperimentDuration: '{{ PostExperimentDuration }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.fis.experiment_templates +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +fis:GetExperimentTemplate, +fis:ListTagsForResource +``` + +### Update +```json +fis:UpdateExperimentTemplate, +fis:TagResource, +fis:UntagResource, +iam:PassRole +``` + +### Delete +```json +fis:DeleteExperimentTemplate +``` + +### List +```json +fis:ListExperimentTemplates, +fis:ListTagsForResource +``` diff --git a/website/docs/services/fis/experiment_templates_list_only/index.md b/website/docs/services/fis/experiment_templates_list_only/index.md new file mode 100644 index 0000000..815d5d5 --- /dev/null +++ b/website/docs/services/fis/experiment_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: experiment_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - experiment_templates_list_only + - fis + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists experiment_templates in a region or regions, for all properties use experiment_templates + +## Overview + + + + + + + +
Nameexperiment_templates_list_only
TypeResource
DescriptionResource schema for AWS::FIS::ExperimentTemplate
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all experiment_templates in a region. +```sql +SELECT +region, +id +FROM aws.fis.experiment_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the experiment_templates_list_only resource, see experiment_templates + diff --git a/website/docs/services/fis/index.md b/website/docs/services/fis/index.md new file mode 100644 index 0000000..580a600 --- /dev/null +++ b/website/docs/services/fis/index.md @@ -0,0 +1,40 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The fis service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/fis/target_account_configurations/index.md b/website/docs/services/fis/target_account_configurations/index.md new file mode 100644 index 0000000..5b400d2 --- /dev/null +++ b/website/docs/services/fis/target_account_configurations/index.md @@ -0,0 +1,219 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a target_account_configuration resource or lists target_account_configurations in a region + +## Overview + + + + + + + +
Nametarget_account_configurations
TypeResource
DescriptionResource schema for AWS::FIS::TargetAccountConfiguration
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of the experiment template.
stringThe AWS account ID of the target account.
stringThe Amazon Resource Name (ARN) of an IAM role for the target account.
stringThe description of the target account.
stringAWS region.
+ +For more information, see AWS::FIS::TargetAccountConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all target_account_configurations in a region. +```sql +SELECT +region, +experiment_template_id, +account_id, +role_arn, +description +FROM aws.fis.target_account_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual target_account_configuration. +```sql +SELECT +region, +experiment_template_id, +account_id, +role_arn, +description +FROM aws.fis.target_account_configurations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new target_account_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.fis.target_account_configurations ( + ExperimentTemplateId, + AccountId, + RoleArn, + region +) +SELECT +'{{ ExperimentTemplateId }}', + '{{ AccountId }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.fis.target_account_configurations ( + ExperimentTemplateId, + AccountId, + RoleArn, + Description, + region +) +SELECT + '{{ ExperimentTemplateId }}', + '{{ AccountId }}', + '{{ RoleArn }}', + '{{ Description }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: target_account_configuration + props: + - name: ExperimentTemplateId + value: '{{ ExperimentTemplateId }}' + - name: AccountId + value: '{{ AccountId }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Description + value: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.fis.target_account_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the target_account_configurations resource, the following permissions are required: + +### Create +```json +fis:CreateTargetAccountConfiguration +``` + +### Read +```json +fis:GetTargetAccountConfiguration +``` + +### Update +```json +fis:UpdateTargetAccountConfiguration +``` + +### Delete +```json +fis:DeleteTargetAccountConfiguration +``` + +### List +```json +fis:ListTargetAccountConfigurations +``` diff --git a/website/docs/services/fis/target_account_configurations_list_only/index.md b/website/docs/services/fis/target_account_configurations_list_only/index.md new file mode 100644 index 0000000..249574f --- /dev/null +++ b/website/docs/services/fis/target_account_configurations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: target_account_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - target_account_configurations_list_only + - fis + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists target_account_configurations in a region or regions, for all properties use target_account_configurations + +## Overview + + + + + + + +
Nametarget_account_configurations_list_only
TypeResource
DescriptionResource schema for AWS::FIS::TargetAccountConfiguration
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the experiment template.
stringThe AWS account ID of the target account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all target_account_configurations in a region. +```sql +SELECT +region, +experiment_template_id, +account_id +FROM aws.fis.target_account_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the target_account_configurations_list_only resource, see target_account_configurations + diff --git a/website/docs/services/fms/index.md b/website/docs/services/fms/index.md new file mode 100644 index 0000000..39b76d6 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The fms service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/fms/notification_channels/index.md b/website/docs/services/fms/notification_channels/index.md new file mode 100644 index 0000000..7bb3c98 --- /dev/null +++ b/website/docs/services/fms/notification_channels/index.md @@ -0,0 +1,205 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a notification_channel resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA resource ARN.
stringA resource ARN.
stringAWS region.
+ +For more information, see AWS::FMS::NotificationChannel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all notification_channels in a region. +```sql +SELECT +region, +sns_role_name, +sns_topic_arn +FROM aws.fms.notification_channels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual notification_channel. +```sql +SELECT +region, +sns_role_name, +sns_topic_arn +FROM aws.fms.notification_channels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new notification_channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.fms.notification_channels ( + SnsRoleName, + SnsTopicArn, + region +) +SELECT +'{{ SnsRoleName }}', + '{{ SnsTopicArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.fms.notification_channels ( + SnsRoleName, + SnsTopicArn, + region +) +SELECT + '{{ SnsRoleName }}', + '{{ SnsTopicArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: notification_channel + props: + - name: SnsRoleName + value: '{{ SnsRoleName }}' + - name: SnsTopicArn + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.fms.notification_channels +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the notification_channels resource, the following permissions are required: + +### Create +```json +fms:PutNotificationChannel, +iam:PassRole +``` + +### Update +```json +fms:PutNotificationChannel, +iam:PassRole +``` + +### Read +```json +fms:GetNotificationChannel +``` + +### Delete +```json +fms:DeleteNotificationChannel +``` + +### List +```json +fms:GetNotificationChannel +``` diff --git a/website/docs/services/fms/notification_channels_list_only/index.md b/website/docs/services/fms/notification_channels_list_only/index.md new file mode 100644 index 0000000..758fd37 --- /dev/null +++ b/website/docs/services/fms/notification_channels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: notification_channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - notification_channels_list_only + - fms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists notification_channels in a region or regions, for all properties use notification_channels + +## Overview + + + + + + + +
Namenotification_channels_list_only
TypeResource
DescriptionDesignates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA resource ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all notification_channels in a region. +```sql +SELECT +region, +sns_topic_arn +FROM aws.fms.notification_channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the notification_channels_list_only resource, see notification_channels + diff --git a/website/docs/services/fms/policies/index.md b/website/docs/services/fms/policies/index.md new file mode 100644 index 0000000..57abcef --- /dev/null +++ b/website/docs/services/fms/policies/index.md @@ -0,0 +1,360 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a policy resource or lists policies in a region + +## Overview + + + + + + + +
Namepolicies
TypeResource
DescriptionCreates an AWS Firewall Manager policy.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectAn FMS includeMap or excludeMap.
boolean
objectAn FMS includeMap or excludeMap.
string
string
string
boolean
array
stringAn AWS resource type
array
array
objectFirewall security service policy data.
stringA resource ARN.
boolean
boolean
array
stringAWS region.
+ +For more information, see AWS::FMS::Policy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all policies in a region. +```sql +SELECT +region, +exclude_map, +exclude_resource_tags, +include_map, +id, +policy_name, +policy_description, +remediation_enabled, +resource_tags, +resource_type, +resource_type_list, +resource_set_ids, +security_service_policy_data, +arn, +delete_all_policy_resources, +resources_clean_up, +tags +FROM aws.fms.policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual policy. +```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.policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.fms.policies ( + ExcludeResourceTags, + PolicyName, + RemediationEnabled, + SecurityServicePolicyData, + region +) +SELECT +'{{ ExcludeResourceTags }}', + '{{ PolicyName }}', + '{{ RemediationEnabled }}', + '{{ SecurityServicePolicyData }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.fms.policies ( + ExcludeMap, + ExcludeResourceTags, + IncludeMap, + PolicyName, + PolicyDescription, + RemediationEnabled, + ResourceTags, + ResourceType, + ResourceTypeList, + ResourceSetIds, + SecurityServicePolicyData, + DeleteAllPolicyResources, + ResourcesCleanUp, + Tags, + region +) +SELECT + '{{ ExcludeMap }}', + '{{ ExcludeResourceTags }}', + '{{ IncludeMap }}', + '{{ PolicyName }}', + '{{ PolicyDescription }}', + '{{ RemediationEnabled }}', + '{{ ResourceTags }}', + '{{ ResourceType }}', + '{{ ResourceTypeList }}', + '{{ ResourceSetIds }}', + '{{ SecurityServicePolicyData }}', + '{{ DeleteAllPolicyResources }}', + '{{ ResourcesCleanUp }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: policy + props: + - name: ExcludeMap + value: + ACCOUNT: + - '{{ ACCOUNT[0] }}' + ORGUNIT: + - '{{ ORGUNIT[0] }}' + - name: ExcludeResourceTags + value: '{{ ExcludeResourceTags }}' + - name: IncludeMap + value: null + - name: PolicyName + value: '{{ PolicyName }}' + - name: PolicyDescription + value: '{{ PolicyDescription }}' + - name: RemediationEnabled + value: '{{ RemediationEnabled }}' + - name: ResourceTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ResourceType + value: '{{ ResourceType }}' + - name: ResourceTypeList + value: + - null + - name: ResourceSetIds + value: + - '{{ ResourceSetIds[0] }}' + - name: SecurityServicePolicyData + value: + ManagedServiceData: '{{ ManagedServiceData }}' + Type: '{{ Type }}' + PolicyOption: + NetworkFirewallPolicy: + FirewallDeploymentModel: '{{ FirewallDeploymentModel }}' + ThirdPartyFirewallPolicy: + FirewallDeploymentModel: null + NetworkAclCommonPolicy: + NetworkAclEntrySet: + FirstEntries: + - CidrBlock: '{{ CidrBlock }}' + Egress: '{{ Egress }}' + IcmpTypeCode: + Code: '{{ Code }}' + Type: '{{ Type }}' + Ipv6CidrBlock: '{{ Ipv6CidrBlock }}' + PortRange: + From: '{{ From }}' + To: '{{ To }}' + Protocol: '{{ Protocol }}' + RuleAction: '{{ RuleAction }}' + ForceRemediateForFirstEntries: '{{ ForceRemediateForFirstEntries }}' + LastEntries: null + ForceRemediateForLastEntries: '{{ ForceRemediateForLastEntries }}' + - name: DeleteAllPolicyResources + value: '{{ DeleteAllPolicyResources }}' + - name: ResourcesCleanUp + value: '{{ ResourcesCleanUp }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.fms.policies +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +fms:ListPolicies, +fms:ListTagsForResource +``` diff --git a/website/docs/services/fms/policies_list_only/index.md b/website/docs/services/fms/policies_list_only/index.md new file mode 100644 index 0000000..67437ca --- /dev/null +++ b/website/docs/services/fms/policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policies_list_only + - fms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policies in a region or regions, for all properties use policies + +## Overview + + + + + + + +
Namepolicies_list_only
TypeResource
DescriptionCreates an AWS Firewall Manager policy.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policies in a region. +```sql +SELECT +region, +id +FROM aws.fms.policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policies_list_only resource, see policies + diff --git a/website/docs/services/fms/policy_tags/index.md b/website/docs/services/fms/policy_tags/index.md new file mode 100644 index 0000000..76a941f --- /dev/null +++ b/website/docs/services/fms/policy_tags/index.md @@ -0,0 +1,105 @@ +--- +title: policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - policy_tags + - fms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for policies in a region + +## Overview + + + + + + + +
Namepolicy_tags
TypeResource
DescriptionCreates an AWS Firewall Manager policy.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectAn FMS includeMap or excludeMap.
boolean
objectAn FMS includeMap or excludeMap.
string
string
string
boolean
array
stringAn AWS resource type
array
array
objectFirewall security service policy data.
stringA resource ARN.
boolean
boolean
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all policies in a region. +```sql +SELECT +region, +exclude_map, +exclude_resource_tags, +include_map, +id, +policy_name, +policy_description, +remediation_enabled, +resource_tags, +resource_type, +resource_type_list, +resource_set_ids, +security_service_policy_data, +arn, +delete_all_policy_resources, +resources_clean_up, +tag_key, +tag_value +FROM aws.fms.policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_tags resource, see policies + diff --git a/website/docs/services/fms/resource_set_tags/index.md b/website/docs/services/fms/resource_set_tags/index.md new file mode 100644 index 0000000..63eb2d3 --- /dev/null +++ b/website/docs/services/fms/resource_set_tags/index.md @@ -0,0 +1,85 @@ +--- +title: resource_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resource_set_tags + - fms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resource_sets in a region + +## Overview + + + + + + + +
Nameresource_set_tags
TypeResource
DescriptionCreates an AWS Firewall Manager resource set.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA Base62 ID
string
string
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resource_sets in a region. +```sql +SELECT +region, +id, +name, +description, +resource_type_list, +resources, +tag_key, +tag_value +FROM aws.fms.resource_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_set_tags resource, see resource_sets + diff --git a/website/docs/services/fms/resource_sets/index.md b/website/docs/services/fms/resource_sets/index.md new file mode 100644 index 0000000..0030bbf --- /dev/null +++ b/website/docs/services/fms/resource_sets/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_set resource or lists resource_sets in a region + +## Overview + + + + + + + +
Nameresource_sets
TypeResource
DescriptionCreates an AWS Firewall Manager resource set.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA Base62 ID
string
string
array
array
array
stringAWS region.
+ +For more information, see AWS::FMS::ResourceSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_sets in a region. +```sql +SELECT +region, +id, +name, +description, +resource_type_list, +resources, +tags +FROM aws.fms.resource_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_set. +```sql +SELECT +region, +id, +name, +description, +resource_type_list, +resources, +tags +FROM aws.fms.resource_sets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.fms.resource_sets ( + Name, + ResourceTypeList, + region +) +SELECT +'{{ Name }}', + '{{ ResourceTypeList }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.fms.resource_sets ( + Name, + Description, + ResourceTypeList, + Resources, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ ResourceTypeList }}', + '{{ Resources }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_set + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: ResourceTypeList + value: + - '{{ ResourceTypeList[0] }}' + - name: Resources + value: + - '{{ Resources[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.fms.resource_sets +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +fms:ListResourceSets +``` diff --git a/website/docs/services/fms/resource_sets_list_only/index.md b/website/docs/services/fms/resource_sets_list_only/index.md new file mode 100644 index 0000000..c43aedd --- /dev/null +++ b/website/docs/services/fms/resource_sets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_sets_list_only + - fms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_sets in a region or regions, for all properties use resource_sets + +## Overview + + + + + + + +
Nameresource_sets_list_only
TypeResource
DescriptionCreates an AWS Firewall Manager resource set.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA Base62 ID
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_sets in a region. +```sql +SELECT +region, +id +FROM aws.fms.resource_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_sets_list_only resource, see resource_sets + diff --git a/website/docs/services/forecast/dataset_group_tags/index.md b/website/docs/services/forecast/dataset_group_tags/index.md new file mode 100644 index 0000000..948b013 --- /dev/null +++ b/website/docs/services/forecast/dataset_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: dataset_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_group_tags + - forecast + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dataset_groups in a region + +## Overview + + + + + + + +
Namedataset_group_tags
TypeResource
DescriptionRepresents a dataset group that holds a collection of related datasets
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
stringA name for the dataset group.
stringThe domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.
stringThe Amazon Resource Name (ARN) of the dataset group to delete.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dataset_groups in a region. +```sql +SELECT +region, +dataset_arns, +dataset_group_name, +domain, +dataset_group_arn, +tag_key, +tag_value +FROM aws.forecast.dataset_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_group_tags resource, see dataset_groups + diff --git a/website/docs/services/forecast/dataset_groups/index.md b/website/docs/services/forecast/dataset_groups/index.md new file mode 100644 index 0000000..6ed3af8 --- /dev/null +++ b/website/docs/services/forecast/dataset_groups/index.md @@ -0,0 +1,223 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dataset_group resource or lists dataset_groups in a region + +## Overview + + + + + + + +
Namedataset_groups
TypeResource
DescriptionRepresents a dataset group that holds a collection of related datasets
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arrayAn array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
stringA name for the dataset group.
stringThe domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.
arrayThe tags of Application Insights application.
stringThe Amazon Resource Name (ARN) of the dataset group to delete.
stringAWS region.
+ +For more information, see AWS::Forecast::DatasetGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dataset_groups in a region. +```sql +SELECT +region, +dataset_arns, +dataset_group_name, +domain, +tags, +dataset_group_arn +FROM aws.forecast.dataset_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dataset_group. +```sql +SELECT +region, +dataset_arns, +dataset_group_name, +domain, +tags, +dataset_group_arn +FROM aws.forecast.dataset_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dataset_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.forecast.dataset_groups ( + DatasetGroupName, + Domain, + region +) +SELECT +'{{ DatasetGroupName }}', + '{{ Domain }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.forecast.dataset_groups ( + DatasetArns, + DatasetGroupName, + Domain, + Tags, + region +) +SELECT + '{{ DatasetArns }}', + '{{ DatasetGroupName }}', + '{{ Domain }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dataset_group + props: + - name: DatasetArns + value: + - '{{ DatasetArns[0] }}' + - name: DatasetGroupName + value: '{{ DatasetGroupName }}' + - name: Domain + value: '{{ Domain }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.forecast.dataset_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the dataset_groups resource, the following permissions are required: + +### Create +```json +forecast:CreateDatasetGroup +``` + +### Read +```json +forecast:DescribeDatasetGroup +``` + +### Update +```json +forecast:UpdateDatasetGroup +``` + +### Delete +```json +forecast:DeleteDatasetGroup +``` + +### List +```json +forecast:ListDatasetGroups +``` diff --git a/website/docs/services/forecast/dataset_groups_list_only/index.md b/website/docs/services/forecast/dataset_groups_list_only/index.md new file mode 100644 index 0000000..f32818d --- /dev/null +++ b/website/docs/services/forecast/dataset_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dataset_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_groups_list_only + - forecast + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dataset_groups in a region or regions, for all properties use dataset_groups + +## Overview + + + + + + + +
Namedataset_groups_list_only
TypeResource
DescriptionRepresents a dataset group that holds a collection of related datasets
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the dataset group to delete.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dataset_groups in a region. +```sql +SELECT +region, +dataset_group_arn +FROM aws.forecast.dataset_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_groups_list_only resource, see dataset_groups + diff --git a/website/docs/services/forecast/dataset_tags/index.md b/website/docs/services/forecast/dataset_tags/index.md new file mode 100644 index 0000000..f333de5 --- /dev/null +++ b/website/docs/services/forecast/dataset_tags/index.md @@ -0,0 +1,89 @@ +--- +title: dataset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_tags + - forecast + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for datasets in a region + +## Overview + + + + + + + +
Namedataset_tags
TypeResource
DescriptionResource Type Definition for AWS::Forecast::Dataset
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA name for the dataset
stringThe dataset type
stringFrequency of data collection. This parameter is required for RELATED_TIME_SERIES
stringThe domain associated with the dataset
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all datasets in a region. +```sql +SELECT +region, +arn, +dataset_name, +dataset_type, +data_frequency, +domain, +encryption_config, +schema, +tag_key, +tag_value +FROM aws.forecast.dataset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_tags resource, see datasets + diff --git a/website/docs/services/forecast/datasets/index.md b/website/docs/services/forecast/datasets/index.md new file mode 100644 index 0000000..36ef0c8 --- /dev/null +++ b/website/docs/services/forecast/datasets/index.md @@ -0,0 +1,242 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dataset resource or lists datasets in a region + +## Overview + + + + + + + +
Namedatasets
TypeResource
DescriptionResource Type Definition for AWS::Forecast::Dataset
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA name for the dataset
stringThe dataset type
stringFrequency of data collection. This parameter is required for RELATED_TIME_SERIES
stringThe domain associated with the dataset
object
object
array
stringAWS region.
+ +For more information, see AWS::Forecast::Dataset. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all datasets in a region. +```sql +SELECT +region, +arn, +dataset_name, +dataset_type, +data_frequency, +domain, +encryption_config, +schema, +tags +FROM aws.forecast.datasets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dataset. +```sql +SELECT +region, +arn, +dataset_name, +dataset_type, +data_frequency, +domain, +encryption_config, +schema, +tags +FROM aws.forecast.datasets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dataset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.forecast.datasets ( + DatasetName, + DatasetType, + Domain, + Schema, + region +) +SELECT +'{{ DatasetName }}', + '{{ DatasetType }}', + '{{ Domain }}', + '{{ Schema }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.forecast.datasets ( + DatasetName, + DatasetType, + DataFrequency, + Domain, + EncryptionConfig, + Schema, + Tags, + region +) +SELECT + '{{ DatasetName }}', + '{{ DatasetType }}', + '{{ DataFrequency }}', + '{{ Domain }}', + '{{ EncryptionConfig }}', + '{{ Schema }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dataset + props: + - name: DatasetName + value: '{{ DatasetName }}' + - name: DatasetType + value: '{{ DatasetType }}' + - name: DataFrequency + value: '{{ DataFrequency }}' + - name: Domain + value: '{{ Domain }}' + - name: EncryptionConfig + value: + KmsKeyArn: '{{ KmsKeyArn }}' + RoleArn: '{{ RoleArn }}' + - name: Schema + value: + Attributes: + - AttributeName: '{{ AttributeName }}' + AttributeType: '{{ AttributeType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.forecast.datasets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the datasets resource, the following permissions are required: + +### Create +```json +forecast:CreateDataset +``` + +### Read +```json +forecast:DescribeDataset +``` + +### Delete +```json +forecast:DeleteDataset +``` + +### List +```json +forecast:ListDatasets +``` diff --git a/website/docs/services/forecast/datasets_list_only/index.md b/website/docs/services/forecast/datasets_list_only/index.md new file mode 100644 index 0000000..e77f514 --- /dev/null +++ b/website/docs/services/forecast/datasets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: datasets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - datasets_list_only + - forecast + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists datasets in a region or regions, for all properties use datasets + +## Overview + + + + + + + +
Namedatasets_list_only
TypeResource
DescriptionResource Type Definition for AWS::Forecast::Dataset
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all datasets in a region. +```sql +SELECT +region, +arn +FROM aws.forecast.datasets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datasets_list_only resource, see datasets + diff --git a/website/docs/services/forecast/index.md b/website/docs/services/forecast/index.md new file mode 100644 index 0000000..58a5a6e --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The forecast service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/frauddetector/detector_tags/index.md b/website/docs/services/frauddetector/detector_tags/index.md new file mode 100644 index 0000000..e0b04f4 --- /dev/null +++ b/website/docs/services/frauddetector/detector_tags/index.md @@ -0,0 +1,97 @@ +--- +title: detector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - detector_tags + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for detectors in a region + +## Overview + + + + + + + +
Namedetector_tags
TypeResource
DescriptionA resource schema for a Detector in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the detector
stringThe desired detector version status for the detector
stringThe active version ID of the detector
string
stringThe description of the detector.
array
objectThe event type to associate this detector with.
stringThe ARN of the detector.
stringThe time when the detector was created.
stringThe time when the detector was last updated.
arrayThe models to associate with this detector.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all detectors in a region. +```sql +SELECT +region, +detector_id, +detector_version_status, +detector_version_id, +rule_execution_mode, +description, +rules, +event_type, +arn, +created_time, +last_updated_time, +associated_models, +tag_key, +tag_value +FROM aws.frauddetector.detector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detector_tags resource, see detectors + diff --git a/website/docs/services/frauddetector/detectors/index.md b/website/docs/services/frauddetector/detectors/index.md new file mode 100644 index 0000000..7a5ba31 --- /dev/null +++ b/website/docs/services/frauddetector/detectors/index.md @@ -0,0 +1,397 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a detector resource or lists detectors in a region + +## Overview + + + + + + + +
Namedetectors
TypeResource
DescriptionA resource schema for a Detector in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the detector
stringThe desired detector version status for the detector
stringThe active version ID of the detector
string
arrayTags associated with this detector.
stringThe description of the detector.
array
objectThe event type to associate this detector with.
stringThe ARN of the detector.
stringThe time when the detector was created.
stringThe time when the detector was last updated.
arrayThe models to associate with this detector.
stringAWS region.
+ +For more information, see AWS::FraudDetector::Detector. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all detectors in a region. +```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.detectors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual detector. +```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.detectors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new detector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.detectors ( + DetectorId, + Rules, + EventType, + region +) +SELECT +'{{ DetectorId }}', + '{{ Rules }}', + '{{ EventType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.detectors ( + DetectorId, + DetectorVersionStatus, + RuleExecutionMode, + Tags, + Description, + Rules, + EventType, + AssociatedModels, + region +) +SELECT + '{{ DetectorId }}', + '{{ DetectorVersionStatus }}', + '{{ RuleExecutionMode }}', + '{{ Tags }}', + '{{ Description }}', + '{{ Rules }}', + '{{ EventType }}', + '{{ AssociatedModels }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: detector + props: + - name: DetectorId + value: '{{ DetectorId }}' + - name: DetectorVersionStatus + value: '{{ DetectorVersionStatus }}' + - name: RuleExecutionMode + value: '{{ RuleExecutionMode }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Description + value: '{{ Description }}' + - name: Rules + value: + - RuleId: '{{ RuleId }}' + RuleVersion: '{{ RuleVersion }}' + DetectorId: '{{ DetectorId }}' + Expression: '{{ Expression }}' + Language: '{{ Language }}' + Outcomes: + - Name: '{{ Name }}' + Tags: + - null + Description: '{{ Description }}' + Arn: '{{ Arn }}' + Description: '{{ Description }}' + Tags: + - null + CreatedTime: '{{ CreatedTime }}' + LastUpdatedTime: '{{ LastUpdatedTime }}' + - name: EventType + value: + Name: '{{ Name }}' + Tags: + - null + Description: '{{ Description }}' + EventVariables: + - Arn: '{{ Arn }}' + Inline: '{{ Inline }}' + Name: '{{ Name }}' + DataSource: '{{ DataSource }}' + DataType: '{{ DataType }}' + DefaultValue: '{{ DefaultValue }}' + VariableType: '{{ VariableType }}' + Description: '{{ Description }}' + Tags: + - null + CreatedTime: '{{ CreatedTime }}' + LastUpdatedTime: '{{ LastUpdatedTime }}' + Labels: + - Name: '{{ Name }}' + Tags: + - null + Description: '{{ Description }}' + EntityTypes: + - Arn: '{{ Arn }}' + Inline: '{{ Inline }}' + Name: '{{ Name }}' + Description: '{{ Description }}' + Tags: + - null + CreatedTime: '{{ CreatedTime }}' + LastUpdatedTime: '{{ LastUpdatedTime }}' + - name: AssociatedModels + value: + - Arn: '{{ Arn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.frauddetector.detectors +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### 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/website/docs/services/frauddetector/detectors_list_only/index.md b/website/docs/services/frauddetector/detectors_list_only/index.md new file mode 100644 index 0000000..d385da2 --- /dev/null +++ b/website/docs/services/frauddetector/detectors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: detectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - detectors_list_only + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists detectors in a region or regions, for all properties use detectors + +## Overview + + + + + + + +
Namedetectors_list_only
TypeResource
DescriptionA resource schema for a Detector in Amazon Fraud Detector.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the detector.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all detectors in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.detectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detectors_list_only resource, see detectors + diff --git a/website/docs/services/frauddetector/event_type_tags/index.md b/website/docs/services/frauddetector/event_type_tags/index.md new file mode 100644 index 0000000..d7da14a --- /dev/null +++ b/website/docs/services/frauddetector/event_type_tags/index.md @@ -0,0 +1,91 @@ +--- +title: event_type_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_type_tags + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_types in a region + +## Overview + + + + + + + +
Nameevent_type_tags
TypeResource
DescriptionA resource schema for an EventType in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the event type
stringThe description of the event type.
array
array
array
stringThe ARN of the event type.
stringThe time when the event type was created.
stringThe time when the event type was last updated.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_types in a region. +```sql +SELECT +region, +name, +description, +event_variables, +labels, +entity_types, +arn, +created_time, +last_updated_time, +tag_key, +tag_value +FROM aws.frauddetector.event_type_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_type_tags resource, see event_types + diff --git a/website/docs/services/frauddetector/event_types/index.md b/website/docs/services/frauddetector/event_types/index.md new file mode 100644 index 0000000..a4757de --- /dev/null +++ b/website/docs/services/frauddetector/event_types/index.md @@ -0,0 +1,317 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_type resource or lists event_types in a region + +## Overview + + + + + + + +
Nameevent_types
TypeResource
DescriptionA resource schema for an EventType in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the event type
arrayTags associated with this event type.
stringThe description of the event type.
array
array
array
stringThe ARN of the event type.
stringThe time when the event type was created.
stringThe time when the event type was last updated.
stringAWS region.
+ +For more information, see AWS::FraudDetector::EventType. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_types in a region. +```sql +SELECT +region, +name, +tags, +description, +event_variables, +labels, +entity_types, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.event_types +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_type. +```sql +SELECT +region, +name, +tags, +description, +event_variables, +labels, +entity_types, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.event_types +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.event_types ( + Name, + EventVariables, + Labels, + EntityTypes, + region +) +SELECT +'{{ Name }}', + '{{ EventVariables }}', + '{{ Labels }}', + '{{ EntityTypes }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.event_types ( + Name, + Tags, + Description, + EventVariables, + Labels, + EntityTypes, + region +) +SELECT + '{{ Name }}', + '{{ Tags }}', + '{{ Description }}', + '{{ EventVariables }}', + '{{ Labels }}', + '{{ EntityTypes }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_type + props: + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Description + value: '{{ Description }}' + - name: EventVariables + value: + - Arn: '{{ Arn }}' + Inline: '{{ Inline }}' + Name: '{{ Name }}' + DataSource: '{{ DataSource }}' + DataType: '{{ DataType }}' + DefaultValue: '{{ DefaultValue }}' + VariableType: '{{ VariableType }}' + Description: '{{ Description }}' + Tags: + - null + CreatedTime: '{{ CreatedTime }}' + LastUpdatedTime: '{{ LastUpdatedTime }}' + - name: Labels + value: + - Name: '{{ Name }}' + Tags: + - null + Description: '{{ Description }}' + - name: EntityTypes + value: + - Arn: '{{ Arn }}' + Inline: '{{ Inline }}' + Name: '{{ Name }}' + Description: '{{ Description }}' + Tags: + - null + CreatedTime: '{{ CreatedTime }}' + LastUpdatedTime: '{{ LastUpdatedTime }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.frauddetector.event_types +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +frauddetector:BatchGetVariable, +frauddetector:GetVariables, +frauddetector:GetEventTypes, +frauddetector:GetLabels, +frauddetector:GetEntityTypes, +frauddetector:ListTagsForResource +``` diff --git a/website/docs/services/frauddetector/event_types_list_only/index.md b/website/docs/services/frauddetector/event_types_list_only/index.md new file mode 100644 index 0000000..0869f4b --- /dev/null +++ b/website/docs/services/frauddetector/event_types_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: event_types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_types_list_only + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_types in a region or regions, for all properties use event_types + +## Overview + + + + + + + +
Nameevent_types_list_only
TypeResource
DescriptionA resource schema for an EventType in Amazon Fraud Detector.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the event type.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_types in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.event_types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_types_list_only resource, see event_types + diff --git a/website/docs/services/frauddetector/index.md b/website/docs/services/frauddetector/index.md new file mode 100644 index 0000000..79f96c4 --- /dev/null +++ b/website/docs/services/frauddetector/index.md @@ -0,0 +1,53 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The frauddetector service documentation. + +:::info Service Summary + +
+
+total resources: 18
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/frauddetector/label_tags/index.md b/website/docs/services/frauddetector/label_tags/index.md new file mode 100644 index 0000000..c822a82 --- /dev/null +++ b/website/docs/services/frauddetector/label_tags/index.md @@ -0,0 +1,85 @@ +--- +title: label_tags +hide_title: false +hide_table_of_contents: false +keywords: + - label_tags + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for labels in a region + +## Overview + + + + + + + +
Namelabel_tags
TypeResource
DescriptionAn label for fraud detector.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the label.
stringThe label description.
stringThe label ARN.
stringThe timestamp when the label was created.
stringThe timestamp when the label was last updated.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all labels in a region. +```sql +SELECT +region, +name, +description, +arn, +created_time, +last_updated_time, +tag_key, +tag_value +FROM aws.frauddetector.label_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the label_tags resource, see labels + diff --git a/website/docs/services/frauddetector/labels/index.md b/website/docs/services/frauddetector/labels/index.md new file mode 100644 index 0000000..c98e5d2 --- /dev/null +++ b/website/docs/services/frauddetector/labels/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a label resource or lists labels in a region + +## Overview + + + + + + + +
Namelabels
TypeResource
DescriptionAn label for fraud detector.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the label.
arrayTags associated with this label.
stringThe label description.
stringThe label ARN.
stringThe timestamp when the label was created.
stringThe timestamp when the label was last updated.
stringAWS region.
+ +For more information, see AWS::FraudDetector::Label. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all labels in a region. +```sql +SELECT +region, +name, +tags, +description, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.labels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual label. +```sql +SELECT +region, +name, +tags, +description, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.labels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new label resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.labels ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.labels ( + Name, + Tags, + Description, + region +) +SELECT + '{{ Name }}', + '{{ Tags }}', + '{{ Description }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: label + props: + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Description + value: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.frauddetector.labels +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +frauddetector:GetLabels, +frauddetector:ListTagsForResource +``` + +### Update +```json +frauddetector:GetLabels, +frauddetector:PutLabel, +frauddetector:ListTagsForResource, +frauddetector:TagResource, +frauddetector:UntagResource +``` + +### Delete +```json +frauddetector:GetLabels, +frauddetector:DeleteLabel +``` + +### List +```json +frauddetector:GetLabels, +frauddetector:ListTagsForResource +``` diff --git a/website/docs/services/frauddetector/labels_list_only/index.md b/website/docs/services/frauddetector/labels_list_only/index.md new file mode 100644 index 0000000..d820438 --- /dev/null +++ b/website/docs/services/frauddetector/labels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: labels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - labels_list_only + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists labels in a region or regions, for all properties use labels + +## Overview + + + + + + + +
Namelabels_list_only
TypeResource
DescriptionAn label for fraud detector.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe label ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all labels in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.labels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the labels_list_only resource, see labels + diff --git a/website/docs/services/frauddetector/list_tags/index.md b/website/docs/services/frauddetector/list_tags/index.md new file mode 100644 index 0000000..c3c465e --- /dev/null +++ b/website/docs/services/frauddetector/list_tags/index.md @@ -0,0 +1,89 @@ +--- +title: list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - list_tags + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for lists in a region + +## Overview + + + + + + + +
Namelist_tags
TypeResource
DescriptionA resource schema for a List in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe list ARN.
stringThe name of the list.
stringThe description of the list.
stringThe variable type of the list.
stringThe time when the list was created.
stringThe time when the list was last updated.
arrayThe elements in this list.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all lists in a region. +```sql +SELECT +region, +arn, +name, +description, +variable_type, +created_time, +last_updated_time, +elements, +tag_key, +tag_value +FROM aws.frauddetector.list_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the list_tags resource, see lists + diff --git a/website/docs/services/frauddetector/lists/index.md b/website/docs/services/frauddetector/lists/index.md new file mode 100644 index 0000000..5d7b560 --- /dev/null +++ b/website/docs/services/frauddetector/lists/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a list resource or lists lists in a region + +## Overview + + + + + + + +
Namelists
TypeResource
DescriptionA resource schema for a List in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe list ARN.
stringThe name of the list.
stringThe description of the list.
stringThe variable type of the list.
stringThe time when the list was created.
stringThe time when the list was last updated.
arrayTags associated with this list.
arrayThe elements in this list.
stringAWS region.
+ +For more information, see AWS::FraudDetector::List. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all lists in a region. +```sql +SELECT +region, +arn, +name, +description, +variable_type, +created_time, +last_updated_time, +tags, +elements +FROM aws.frauddetector.lists +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual list. +```sql +SELECT +region, +arn, +name, +description, +variable_type, +created_time, +last_updated_time, +tags, +elements +FROM aws.frauddetector.lists +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.lists ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.lists ( + Name, + Description, + VariableType, + Tags, + Elements, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ VariableType }}', + '{{ Tags }}', + '{{ Elements }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: list + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: VariableType + value: '{{ VariableType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Elements + value: + - '{{ Elements[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.frauddetector.lists +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +frauddetector:GetListElements, +frauddetector:GetListsMetadata, +frauddetector:ListTagsForResource +``` diff --git a/website/docs/services/frauddetector/lists_list_only/index.md b/website/docs/services/frauddetector/lists_list_only/index.md new file mode 100644 index 0000000..d88026b --- /dev/null +++ b/website/docs/services/frauddetector/lists_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - lists_list_only + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists lists in a region or regions, for all properties use lists + +## Overview + + + + + + + +
Namelists_list_only
TypeResource
DescriptionA resource schema for a List in Amazon Fraud Detector.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe list ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all lists in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.lists_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lists_list_only resource, see lists + diff --git a/website/docs/services/frauddetector/outcome_tags/index.md b/website/docs/services/frauddetector/outcome_tags/index.md new file mode 100644 index 0000000..8fb464a --- /dev/null +++ b/website/docs/services/frauddetector/outcome_tags/index.md @@ -0,0 +1,85 @@ +--- +title: outcome_tags +hide_title: false +hide_table_of_contents: false +keywords: + - outcome_tags + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for outcomes in a region + +## Overview + + + + + + + +
Nameoutcome_tags
TypeResource
DescriptionAn outcome for rule evaluation.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the outcome.
stringThe outcome description.
stringThe outcome ARN.
stringThe timestamp when the outcome was created.
stringThe timestamp when the outcome was last updated.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all outcomes in a region. +```sql +SELECT +region, +name, +description, +arn, +created_time, +last_updated_time, +tag_key, +tag_value +FROM aws.frauddetector.outcome_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the outcome_tags resource, see outcomes + diff --git a/website/docs/services/frauddetector/outcomes/index.md b/website/docs/services/frauddetector/outcomes/index.md new file mode 100644 index 0000000..4e98ca6 --- /dev/null +++ b/website/docs/services/frauddetector/outcomes/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an outcome resource or lists outcomes in a region + +## Overview + + + + + + + +
Nameoutcomes
TypeResource
DescriptionAn outcome for rule evaluation.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the outcome.
arrayTags associated with this outcome.
stringThe outcome description.
stringThe outcome ARN.
stringThe timestamp when the outcome was created.
stringThe timestamp when the outcome was last updated.
stringAWS region.
+ +For more information, see AWS::FraudDetector::Outcome. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all outcomes in a region. +```sql +SELECT +region, +name, +tags, +description, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.outcomes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual outcome. +```sql +SELECT +region, +name, +tags, +description, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.outcomes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new outcome resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.outcomes ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.outcomes ( + Name, + Tags, + Description, + region +) +SELECT + '{{ Name }}', + '{{ Tags }}', + '{{ Description }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: outcome + props: + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Description + value: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.frauddetector.outcomes +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +frauddetector:GetOutcomes, +frauddetector:ListTagsForResource +``` + +### Update +```json +frauddetector:GetOutcomes, +frauddetector:PutOutcome, +frauddetector:ListTagsForResource, +frauddetector:TagResource, +frauddetector:UntagResource +``` + +### Delete +```json +frauddetector:GetOutcomes, +frauddetector:DeleteOutcome +``` + +### List +```json +frauddetector:GetOutcomes, +frauddetector:ListTagsForResource +``` diff --git a/website/docs/services/frauddetector/outcomes_list_only/index.md b/website/docs/services/frauddetector/outcomes_list_only/index.md new file mode 100644 index 0000000..5897e01 --- /dev/null +++ b/website/docs/services/frauddetector/outcomes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: outcomes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - outcomes_list_only + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists outcomes in a region or regions, for all properties use outcomes + +## Overview + + + + + + + +
Nameoutcomes_list_only
TypeResource
DescriptionAn outcome for rule evaluation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe outcome ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all outcomes in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.outcomes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the outcomes_list_only resource, see outcomes + diff --git a/website/docs/services/frauddetector/variable_tags/index.md b/website/docs/services/frauddetector/variable_tags/index.md new file mode 100644 index 0000000..8f06eb7 --- /dev/null +++ b/website/docs/services/frauddetector/variable_tags/index.md @@ -0,0 +1,93 @@ +--- +title: variable_tags +hide_title: false +hide_table_of_contents: false +keywords: + - variable_tags + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for variables in a region + +## Overview + + + + + + + +
Namevariable_tags
TypeResource
DescriptionA resource schema for a Variable in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the variable.
stringThe source of the data.
stringThe data type.
stringThe default value for the variable when no value is received.
stringThe description.
stringThe variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
stringThe ARN of the variable.
stringThe time when the variable was created.
stringThe time when the variable was last updated.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all variables in a region. +```sql +SELECT +region, +name, +data_source, +data_type, +default_value, +description, +variable_type, +arn, +created_time, +last_updated_time, +tag_key, +tag_value +FROM aws.frauddetector.variable_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the variable_tags resource, see variables + diff --git a/website/docs/services/frauddetector/variables/index.md b/website/docs/services/frauddetector/variables/index.md new file mode 100644 index 0000000..ace957f --- /dev/null +++ b/website/docs/services/frauddetector/variables/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a variable resource or lists variables in a region + +## Overview + + + + + + + +
Namevariables
TypeResource
DescriptionA resource schema for a Variable in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the variable.
stringThe source of the data.
stringThe data type.
stringThe default value for the variable when no value is received.
stringThe description.
arrayTags associated with this variable.
stringThe variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
stringThe ARN of the variable.
stringThe time when the variable was created.
stringThe time when the variable was last updated.
stringAWS region.
+ +For more information, see AWS::FraudDetector::Variable. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all variables in a region. +```sql +SELECT +region, +name, +data_source, +data_type, +default_value, +description, +tags, +variable_type, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.variables +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual variable. +```sql +SELECT +region, +name, +data_source, +data_type, +default_value, +description, +tags, +variable_type, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.variables +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new variable resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.variables ( + Name, + DataSource, + DataType, + DefaultValue, + region +) +SELECT +'{{ Name }}', + '{{ DataSource }}', + '{{ DataType }}', + '{{ DefaultValue }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.frauddetector.variables ( + Name, + DataSource, + DataType, + DefaultValue, + Description, + Tags, + VariableType, + region +) +SELECT + '{{ Name }}', + '{{ DataSource }}', + '{{ DataType }}', + '{{ DefaultValue }}', + '{{ Description }}', + '{{ Tags }}', + '{{ VariableType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: variable + props: + - name: Name + value: '{{ Name }}' + - name: DataSource + value: '{{ DataSource }}' + - name: DataType + value: '{{ DataType }}' + - name: DefaultValue + value: '{{ DefaultValue }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VariableType + value: '{{ VariableType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.frauddetector.variables +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +frauddetector:GetVariables, +frauddetector:ListTagsForResource +``` + +### Update +```json +frauddetector:GetVariables, +frauddetector:UpdateVariable, +frauddetector:ListTagsForResource, +frauddetector:TagResource, +frauddetector:UntagResource +``` + +### Delete +```json +frauddetector:GetVariables, +frauddetector:DeleteVariable +``` + +### List +```json +frauddetector:GetVariables, +frauddetector:ListTagsForResource +``` diff --git a/website/docs/services/frauddetector/variables_list_only/index.md b/website/docs/services/frauddetector/variables_list_only/index.md new file mode 100644 index 0000000..c394c7a --- /dev/null +++ b/website/docs/services/frauddetector/variables_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: variables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - variables_list_only + - frauddetector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists variables in a region or regions, for all properties use variables + +## Overview + + + + + + + +
Namevariables_list_only
TypeResource
DescriptionA resource schema for a Variable in Amazon Fraud Detector.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the variable.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all variables in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.variables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the variables_list_only resource, see variables + diff --git a/website/docs/services/fsx/data_repository_association_tags/index.md b/website/docs/services/fsx/data_repository_association_tags/index.md new file mode 100644 index 0000000..bc1d3d8 --- /dev/null +++ b/website/docs/services/fsx/data_repository_association_tags/index.md @@ -0,0 +1,91 @@ +--- +title: data_repository_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_repository_association_tags + - fsx + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_repository_associations in a region + +## Overview + + + + + + + +
Namedata_repository_association_tags
TypeResource
DescriptionCreates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding scratch_1 deployment type.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe ID of the file system on which the data repository association is configured.
stringA path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.
stringThe path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.
booleanA boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.
integerFor files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
objectThe configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_repository_associations in a region. +```sql +SELECT +region, +association_id, +resource_arn, +file_system_id, +file_system_path, +data_repository_path, +batch_import_meta_data_on_create, +imported_file_chunk_size, +s3, +tag_key, +tag_value +FROM aws.fsx.data_repository_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_repository_association_tags resource, see data_repository_associations + diff --git a/website/docs/services/fsx/data_repository_associations/index.md b/website/docs/services/fsx/data_repository_associations/index.md new file mode 100644 index 0000000..bb6f474 --- /dev/null +++ b/website/docs/services/fsx/data_repository_associations/index.md @@ -0,0 +1,269 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_repository_association resource or lists 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.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe ID of the file system on which the data repository association is configured.
stringA path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.
stringThe path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.
booleanA boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.
integerFor files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
objectThe configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
+ +For more information, see AWS::FSx::DataRepositoryAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_repository_associations in a region. +```sql +SELECT +region, +association_id, +resource_arn, +file_system_id, +file_system_path, +data_repository_path, +batch_import_meta_data_on_create, +imported_file_chunk_size, +s3, +tags +FROM aws.fsx.data_repository_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_repository_association. +```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_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_repository_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.fsx.data_repository_associations ( + FileSystemId, + FileSystemPath, + DataRepositoryPath, + region +) +SELECT +'{{ FileSystemId }}', + '{{ FileSystemPath }}', + '{{ DataRepositoryPath }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.fsx.data_repository_associations ( + FileSystemId, + FileSystemPath, + DataRepositoryPath, + BatchImportMetaDataOnCreate, + ImportedFileChunkSize, + S3, + Tags, + region +) +SELECT + '{{ FileSystemId }}', + '{{ FileSystemPath }}', + '{{ DataRepositoryPath }}', + '{{ BatchImportMetaDataOnCreate }}', + '{{ ImportedFileChunkSize }}', + '{{ S3 }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_repository_association + props: + - name: FileSystemId + value: '{{ FileSystemId }}' + - name: FileSystemPath + value: '{{ FileSystemPath }}' + - name: DataRepositoryPath + value: '{{ DataRepositoryPath }}' + - name: BatchImportMetaDataOnCreate + value: '{{ BatchImportMetaDataOnCreate }}' + - name: ImportedFileChunkSize + value: '{{ ImportedFileChunkSize }}' + - name: S3 + value: + AutoImportPolicy: + Events: + - '{{ Events[0] }}' + AutoExportPolicy: + Events: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.fsx.data_repository_associations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +fsx:DescribeDataRepositoryAssociations +``` diff --git a/website/docs/services/fsx/data_repository_associations_list_only/index.md b/website/docs/services/fsx/data_repository_associations_list_only/index.md new file mode 100644 index 0000000..bc71638 --- /dev/null +++ b/website/docs/services/fsx/data_repository_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: data_repository_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_repository_associations_list_only + - fsx + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_repository_associations in a region or regions, for all properties use data_repository_associations + +## Overview + + + + + + + +
Namedata_repository_associations_list_only
TypeResource
DescriptionCreates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding scratch_1 deployment type.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_repository_associations in a region. +```sql +SELECT +region, +association_id +FROM aws.fsx.data_repository_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_repository_associations_list_only resource, see data_repository_associations + diff --git a/website/docs/services/fsx/index.md b/website/docs/services/fsx/index.md new file mode 100644 index 0000000..13c9490 --- /dev/null +++ b/website/docs/services/fsx/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The fsx service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/gamelift/aliases/index.md b/website/docs/services/gamelift/aliases/index.md new file mode 100644 index 0000000..f4f2f74 --- /dev/null +++ b/website/docs/services/gamelift/aliases/index.md @@ -0,0 +1,216 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an alias resource or lists aliases in a region + +## Overview + + + + + + + +
Namealiases
TypeResource
DescriptionThe AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringA human-readable description of the alias.
stringA descriptive label that is associated with an alias. Alias names do not need to be unique.
objectA routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.
stringUnique alias ID
stringAWS region.
+ +For more information, see AWS::GameLift::Alias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all aliases in a region. +```sql +SELECT +region, +description, +name, +routing_strategy, +alias_id +FROM aws.gamelift.aliases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual alias. +```sql +SELECT +region, +description, +name, +routing_strategy, +alias_id +FROM aws.gamelift.aliases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.aliases ( + Name, + RoutingStrategy, + region +) +SELECT +'{{ Name }}', + '{{ RoutingStrategy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.aliases ( + Description, + Name, + RoutingStrategy, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ RoutingStrategy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: alias + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: RoutingStrategy + value: + Message: '{{ Message }}' + FleetId: '{{ FleetId }}' + Type: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.aliases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the aliases resource, the following permissions are required: + +### Create +```json +gamelift:CreateAlias +``` + +### Read +```json +gamelift:DescribeAlias +``` + +### Update +```json +gamelift:UpdateAlias +``` + +### Delete +```json +gamelift:DeleteAlias +``` + +### List +```json +gamelift:ListAliases +``` diff --git a/website/docs/services/gamelift/aliases_list_only/index.md b/website/docs/services/gamelift/aliases_list_only/index.md new file mode 100644 index 0000000..4095c16 --- /dev/null +++ b/website/docs/services/gamelift/aliases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - aliases_list_only + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists aliases in a region or regions, for all properties use aliases + +## Overview + + + + + + + +
Namealiases_list_only
TypeResource
DescriptionThe AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique alias ID
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all aliases in a region. +```sql +SELECT +region, +alias_id +FROM aws.gamelift.aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the aliases_list_only resource, see aliases + diff --git a/website/docs/services/gamelift/builds/index.md b/website/docs/services/gamelift/builds/index.md new file mode 100644 index 0000000..0fbbf39 --- /dev/null +++ b/website/docs/services/gamelift/builds/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a build resource or lists builds in a region + +## Overview + + + + + + + +
Namebuilds
TypeResource
DescriptionResource Type definition for AWS::GameLift::Build
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
stringA descriptive label that is associated with a build. Build names do not need to be unique.
stringThe operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
objectInformation indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.
stringVersion information that is associated with this build. Version strings do not need to be unique.
stringA server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.
stringAWS region.
+ +For more information, see AWS::GameLift::Build. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all builds in a region. +```sql +SELECT +region, +build_id, +name, +operating_system, +storage_location, +version, +server_sdk_version +FROM aws.gamelift.builds +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual build. +```sql +SELECT +region, +build_id, +name, +operating_system, +storage_location, +version, +server_sdk_version +FROM aws.gamelift.builds +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new build resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.builds ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.builds ( + Name, + OperatingSystem, + StorageLocation, + Version, + ServerSdkVersion, + region +) +SELECT + '{{ Name }}', + '{{ OperatingSystem }}', + '{{ StorageLocation }}', + '{{ Version }}', + '{{ ServerSdkVersion }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: build + props: + - name: Name + value: '{{ Name }}' + - name: OperatingSystem + value: '{{ OperatingSystem }}' + - name: StorageLocation + value: + Bucket: '{{ Bucket }}' + Key: '{{ Key }}' + ObjectVersion: '{{ ObjectVersion }}' + RoleArn: '{{ RoleArn }}' + - name: Version + value: '{{ Version }}' + - name: ServerSdkVersion + value: '{{ ServerSdkVersion }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.builds +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the builds resource, the following permissions are required: + +### Create +```json +gamelift:DescribeBuild, +gamelift:CreateBuild +``` + +### Read +```json +gamelift:DescribeBuild +``` + +### Update +```json +gamelift:UpdateBuild +``` + +### Delete +```json +gamelift:DescribeBuild, +gamelift:DeleteBuild +``` + +### List +```json +gamelift:ListBuilds +``` diff --git a/website/docs/services/gamelift/builds_list_only/index.md b/website/docs/services/gamelift/builds_list_only/index.md new file mode 100644 index 0000000..957e16e --- /dev/null +++ b/website/docs/services/gamelift/builds_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: builds_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - builds_list_only + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists builds in a region or regions, for all properties use builds + +## Overview + + + + + + + +
Namebuilds_list_only
TypeResource
DescriptionResource Type definition for AWS::GameLift::Build
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all builds in a region. +```sql +SELECT +region, +build_id +FROM aws.gamelift.builds_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the builds_list_only resource, see builds + diff --git a/website/docs/services/gamelift/container_fleet_tags/index.md b/website/docs/services/gamelift/container_fleet_tags/index.md new file mode 100644 index 0000000..26f41b3 --- /dev/null +++ b/website/docs/services/gamelift/container_fleet_tags/index.md @@ -0,0 +1,123 @@ +--- +title: container_fleet_tags +hide_title: false +hide_table_of_contents: false +keywords: + - container_fleet_tags + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for container_fleets in a region + +## Overview + + + + + + + +
Namecontainer_fleet_tags
TypeResource
DescriptionThe AWS::GameLift::ContainerFleet resource creates an Amazon GameLift (GameLift) container fleet to host game servers.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique fleet ID
stringA unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
stringA human-readable description of a fleet.
stringThe name of the container group definition that will be created per game server. You must specify GAME_SERVER container group. You have the option to also specify one PER_INSTANCE container group.
stringThe Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
stringThe name of the container group definition that will be created per instance. This field is optional if you specify GameServerContainerGroupDefinitionName.
stringThe Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
objectDefines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.
arrayA range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
integerThe number of desired game server container groups per instance, a number between 1-5000.
integerThe maximum number of game server container groups per instance, a number between 1-5000.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
stringThe current status of the container fleet.
objectProvides information about the last deployment ID and its status.
objectProvides details about how to drain old tasks and replace them with new updated tasks.
stringThe name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
stringIndicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
array
arrayA list of rules that control how a fleet is scaled.
arrayThe name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
stringA game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
objectA policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
objectA policy the location and provider of logs from the fleet.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all container_fleets in a region. +```sql +SELECT +region, +fleet_id, +fleet_role_arn, +description, +game_server_container_group_definition_name, +game_server_container_group_definition_arn, +per_instance_container_group_definition_name, +per_instance_container_group_definition_arn, +instance_connection_port_range, +instance_inbound_permissions, +game_server_container_groups_per_instance, +maximum_game_server_container_groups_per_instance, +creation_time, +status, +deployment_details, +deployment_configuration, +instance_type, +billing_type, +locations, +scaling_policies, +metric_groups, +new_game_session_protection_policy, +game_session_creation_limit_policy, +log_configuration, +fleet_arn, +tag_key, +tag_value +FROM aws.gamelift.container_fleet_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_fleet_tags resource, see container_fleets + diff --git a/website/docs/services/gamelift/container_fleets/index.md b/website/docs/services/gamelift/container_fleets/index.md new file mode 100644 index 0000000..90a8da5 --- /dev/null +++ b/website/docs/services/gamelift/container_fleets/index.md @@ -0,0 +1,399 @@ +--- +title: container_fleets +hide_title: false +hide_table_of_contents: false +keywords: + - container_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a container_fleet resource or lists container_fleets in a region + +## Overview + + + + + + + +
Namecontainer_fleets
TypeResource
DescriptionThe AWS::GameLift::ContainerFleet resource creates an Amazon GameLift (GameLift) container fleet to host game servers.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique fleet ID
stringA unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
stringA human-readable description of a fleet.
stringThe name of the container group definition that will be created per game server. You must specify GAME_SERVER container group. You have the option to also specify one PER_INSTANCE container group.
stringThe Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
stringThe name of the container group definition that will be created per instance. This field is optional if you specify GameServerContainerGroupDefinitionName.
stringThe Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
objectDefines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.
arrayA range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
integerThe number of desired game server container groups per instance, a number between 1-5000.
integerThe maximum number of game server container groups per instance, a number between 1-5000.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
stringThe current status of the container fleet.
objectProvides information about the last deployment ID and its status.
objectProvides details about how to drain old tasks and replace them with new updated tasks.
stringThe name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
stringIndicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
array
arrayA list of rules that control how a fleet is scaled.
arrayThe name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
stringA game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
objectA policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
objectA policy the location and provider of logs from the fleet.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
stringAWS region.
+ +For more information, see AWS::GameLift::ContainerFleet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all container_fleets in a region. +```sql +SELECT +region, +fleet_id, +fleet_role_arn, +description, +game_server_container_group_definition_name, +game_server_container_group_definition_arn, +per_instance_container_group_definition_name, +per_instance_container_group_definition_arn, +instance_connection_port_range, +instance_inbound_permissions, +game_server_container_groups_per_instance, +maximum_game_server_container_groups_per_instance, +creation_time, +status, +deployment_details, +deployment_configuration, +instance_type, +billing_type, +locations, +scaling_policies, +metric_groups, +new_game_session_protection_policy, +game_session_creation_limit_policy, +log_configuration, +tags, +fleet_arn +FROM aws.gamelift.container_fleets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual container_fleet. +```sql +SELECT +region, +fleet_id, +fleet_role_arn, +description, +game_server_container_group_definition_name, +game_server_container_group_definition_arn, +per_instance_container_group_definition_name, +per_instance_container_group_definition_arn, +instance_connection_port_range, +instance_inbound_permissions, +game_server_container_groups_per_instance, +maximum_game_server_container_groups_per_instance, +creation_time, +status, +deployment_details, +deployment_configuration, +instance_type, +billing_type, +locations, +scaling_policies, +metric_groups, +new_game_session_protection_policy, +game_session_creation_limit_policy, +log_configuration, +tags, +fleet_arn +FROM aws.gamelift.container_fleets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new container_fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.container_fleets ( + FleetRoleArn, + region +) +SELECT +'{{ FleetRoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.container_fleets ( + FleetRoleArn, + Description, + GameServerContainerGroupDefinitionName, + PerInstanceContainerGroupDefinitionName, + InstanceConnectionPortRange, + InstanceInboundPermissions, + GameServerContainerGroupsPerInstance, + DeploymentConfiguration, + InstanceType, + BillingType, + Locations, + ScalingPolicies, + MetricGroups, + NewGameSessionProtectionPolicy, + GameSessionCreationLimitPolicy, + LogConfiguration, + Tags, + region +) +SELECT + '{{ FleetRoleArn }}', + '{{ Description }}', + '{{ GameServerContainerGroupDefinitionName }}', + '{{ PerInstanceContainerGroupDefinitionName }}', + '{{ InstanceConnectionPortRange }}', + '{{ InstanceInboundPermissions }}', + '{{ GameServerContainerGroupsPerInstance }}', + '{{ DeploymentConfiguration }}', + '{{ InstanceType }}', + '{{ BillingType }}', + '{{ Locations }}', + '{{ ScalingPolicies }}', + '{{ MetricGroups }}', + '{{ NewGameSessionProtectionPolicy }}', + '{{ GameSessionCreationLimitPolicy }}', + '{{ LogConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: container_fleet + props: + - name: FleetRoleArn + value: '{{ FleetRoleArn }}' + - name: Description + value: '{{ Description }}' + - name: GameServerContainerGroupDefinitionName + value: '{{ GameServerContainerGroupDefinitionName }}' + - name: PerInstanceContainerGroupDefinitionName + value: '{{ PerInstanceContainerGroupDefinitionName }}' + - name: InstanceConnectionPortRange + value: + FromPort: '{{ FromPort }}' + ToPort: '{{ ToPort }}' + - name: InstanceInboundPermissions + value: + - FromPort: '{{ FromPort }}' + IpRange: '{{ IpRange }}' + Protocol: '{{ Protocol }}' + ToPort: '{{ ToPort }}' + - name: GameServerContainerGroupsPerInstance + value: '{{ GameServerContainerGroupsPerInstance }}' + - name: DeploymentConfiguration + value: + ProtectionStrategy: '{{ ProtectionStrategy }}' + MinimumHealthyPercentage: '{{ MinimumHealthyPercentage }}' + ImpairmentStrategy: '{{ ImpairmentStrategy }}' + - name: InstanceType + value: '{{ InstanceType }}' + - name: BillingType + value: '{{ BillingType }}' + - name: Locations + value: + - Location: + LocationName: '{{ LocationName }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + LocationCapacity: + DesiredEC2Instances: '{{ DesiredEC2Instances }}' + MinSize: '{{ MinSize }}' + MaxSize: '{{ MaxSize }}' + - name: ScalingPolicies + value: + - ComparisonOperator: '{{ ComparisonOperator }}' + EvaluationPeriods: '{{ EvaluationPeriods }}' + Location: null + MetricName: '{{ MetricName }}' + Name: '{{ Name }}' + PolicyType: '{{ PolicyType }}' + ScalingAdjustment: '{{ ScalingAdjustment }}' + ScalingAdjustmentType: '{{ ScalingAdjustmentType }}' + Status: '{{ Status }}' + TargetConfiguration: + TargetValue: null + Threshold: null + UpdateStatus: '{{ UpdateStatus }}' + - name: MetricGroups + value: + - '{{ MetricGroups[0] }}' + - name: NewGameSessionProtectionPolicy + value: '{{ NewGameSessionProtectionPolicy }}' + - name: GameSessionCreationLimitPolicy + value: + NewGameSessionsPerCreator: '{{ NewGameSessionsPerCreator }}' + PolicyPeriodInMinutes: '{{ PolicyPeriodInMinutes }}' + - name: LogConfiguration + value: + LogDestination: '{{ LogDestination }}' + S3BucketName: '{{ S3BucketName }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.container_fleets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the container_fleets resource, the following permissions are required: + +### Create +```json +gamelift:CreateContainerFleet, +gamelift:DescribeContainerFleet, +gamelift:DescribeFleetDeployment, +gamelift:DescribeFleetLocationAttributes, +gamelift:DescribeFleetLocationCapacity, +gamelift:DescribeScalingPolicies, +gamelift:ListTagsForResource, +gamelift:PutScalingPolicy, +gamelift:StopFleetActions, +gamelift:TagResource, +gamelift:UpdateFleetCapacity, +iam:PassRole +``` + +### Read +```json +gamelift:DescribeContainerFleet, +gamelift:DescribeFleetLocationAttributes, +gamelift:DescribeFleetLocationCapacity, +gamelift:DescribeScalingPolicies, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DeleteContainerFleet, +gamelift:DescribeContainerFleet +``` + +### List +```json +gamelift:ListContainerFleets +``` + +### Update +```json +gamelift:CreateFleetLocations, +gamelift:DeleteFleetLocations, +gamelift:DeleteScalingPolicy, +gamelift:DescribeContainerFleet, +gamelift:DescribeFleetDeployment, +gamelift:DescribeFleetLocationAttributes, +gamelift:DescribeFleetLocationCapacity, +gamelift:DescribeScalingPolicies, +gamelift:ListTagsForResource, +gamelift:PutScalingPolicy, +gamelift:StartFleetActions, +gamelift:StopFleetActions, +gamelift:TagResource, +gamelift:UntagResource, +gamelift:UpdateContainerFleet, +gamelift:UpdateFleetCapacity, +iam:PassRole +``` diff --git a/website/docs/services/gamelift/container_fleets_list_only/index.md b/website/docs/services/gamelift/container_fleets_list_only/index.md new file mode 100644 index 0000000..a744edd --- /dev/null +++ b/website/docs/services/gamelift/container_fleets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: container_fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - container_fleets_list_only + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists container_fleets in a region or regions, for all properties use container_fleets + +## Overview + + + + + + + +
Namecontainer_fleets_list_only
TypeResource
DescriptionThe AWS::GameLift::ContainerFleet resource creates an Amazon GameLift (GameLift) container fleet to host game servers.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique fleet ID
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all container_fleets in a region. +```sql +SELECT +region, +fleet_id +FROM aws.gamelift.container_fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_fleets_list_only resource, see container_fleets + diff --git a/website/docs/services/gamelift/container_group_definition_tags/index.md b/website/docs/services/gamelift/container_group_definition_tags/index.md new file mode 100644 index 0000000..278ab0e --- /dev/null +++ b/website/docs/services/gamelift/container_group_definition_tags/index.md @@ -0,0 +1,103 @@ +--- +title: container_group_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - container_group_definition_tags + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for container_group_definitions in a region + +## Overview + + + + + + + +
Namecontainer_group_definition_tags
TypeResource
DescriptionThe AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
stringThe operating system of the container group
stringA descriptive label for the container group definition.
stringThe scope of the container group
integerThe total memory limit of container groups following this definition in MiB
numberThe total amount of virtual CPUs on the container group definition
objectSpecifies the information required to run game servers with this container group
arrayA collection of support container definitions that define the containers in this group.
integerThe version of this ContainerGroupDefinition
integerA specific ContainerGroupDefinition version to be updated
stringThe description of this version
stringA string indicating ContainerGroupDefinition status.
stringA string indicating the reason for ContainerGroupDefinition status.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all container_group_definitions in a region. +```sql +SELECT +region, +container_group_definition_arn, +creation_time, +operating_system, +name, +container_group_type, +total_memory_limit_mebibytes, +total_vcpu_limit, +game_server_container_definition, +support_container_definitions, +version_number, +source_version_number, +version_description, +status, +status_reason, +tag_key, +tag_value +FROM aws.gamelift.container_group_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_group_definition_tags resource, see container_group_definitions + diff --git a/website/docs/services/gamelift/container_group_definitions/index.md b/website/docs/services/gamelift/container_group_definitions/index.md new file mode 100644 index 0000000..3e0331d --- /dev/null +++ b/website/docs/services/gamelift/container_group_definitions/index.md @@ -0,0 +1,331 @@ +--- +title: container_group_definitions +hide_title: false +hide_table_of_contents: false +keywords: + - container_group_definitions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a container_group_definition resource or lists container_group_definitions in a region + +## Overview + + + + + + + +
Namecontainer_group_definitions
TypeResource
DescriptionThe AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
stringThe operating system of the container group
stringA descriptive label for the container group definition.
stringThe scope of the container group
integerThe total memory limit of container groups following this definition in MiB
numberThe total amount of virtual CPUs on the container group definition
objectSpecifies the information required to run game servers with this container group
arrayA collection of support container definitions that define the containers in this group.
integerThe version of this ContainerGroupDefinition
integerA specific ContainerGroupDefinition version to be updated
stringThe description of this version
stringA string indicating ContainerGroupDefinition status.
stringA string indicating the reason for ContainerGroupDefinition status.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::GameLift::ContainerGroupDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all container_group_definitions in a region. +```sql +SELECT +region, +container_group_definition_arn, +creation_time, +operating_system, +name, +container_group_type, +total_memory_limit_mebibytes, +total_vcpu_limit, +game_server_container_definition, +support_container_definitions, +version_number, +source_version_number, +version_description, +status, +status_reason, +tags +FROM aws.gamelift.container_group_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual container_group_definition. +```sql +SELECT +region, +container_group_definition_arn, +creation_time, +operating_system, +name, +container_group_type, +total_memory_limit_mebibytes, +total_vcpu_limit, +game_server_container_definition, +support_container_definitions, +version_number, +source_version_number, +version_description, +status, +status_reason, +tags +FROM aws.gamelift.container_group_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new container_group_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.container_group_definitions ( + OperatingSystem, + Name, + TotalMemoryLimitMebibytes, + TotalVcpuLimit, + region +) +SELECT +'{{ OperatingSystem }}', + '{{ Name }}', + '{{ TotalMemoryLimitMebibytes }}', + '{{ TotalVcpuLimit }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.container_group_definitions ( + OperatingSystem, + Name, + ContainerGroupType, + TotalMemoryLimitMebibytes, + TotalVcpuLimit, + GameServerContainerDefinition, + SupportContainerDefinitions, + SourceVersionNumber, + VersionDescription, + Tags, + region +) +SELECT + '{{ OperatingSystem }}', + '{{ Name }}', + '{{ ContainerGroupType }}', + '{{ TotalMemoryLimitMebibytes }}', + '{{ TotalVcpuLimit }}', + '{{ GameServerContainerDefinition }}', + '{{ SupportContainerDefinitions }}', + '{{ SourceVersionNumber }}', + '{{ VersionDescription }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: container_group_definition + props: + - name: OperatingSystem + value: '{{ OperatingSystem }}' + - name: Name + value: '{{ Name }}' + - name: ContainerGroupType + value: '{{ ContainerGroupType }}' + - name: TotalMemoryLimitMebibytes + value: '{{ TotalMemoryLimitMebibytes }}' + - name: TotalVcpuLimit + value: null + - name: GameServerContainerDefinition + value: + ContainerName: '{{ ContainerName }}' + DependsOn: + - ContainerName: '{{ ContainerName }}' + Condition: '{{ Condition }}' + ServerSdkVersion: '{{ ServerSdkVersion }}' + ImageUri: '{{ ImageUri }}' + ResolvedImageDigest: '{{ ResolvedImageDigest }}' + EnvironmentOverride: + - Name: '{{ Name }}' + Value: '{{ Value }}' + PortConfiguration: + ContainerPortRanges: + - FromPort: '{{ FromPort }}' + Protocol: '{{ Protocol }}' + ToPort: '{{ ToPort }}' + MountPoints: + - InstancePath: '{{ InstancePath }}' + ContainerPath: '{{ ContainerPath }}' + AccessLevel: '{{ AccessLevel }}' + - name: SupportContainerDefinitions + value: + - ContainerName: '{{ ContainerName }}' + Vcpu: null + DependsOn: + - null + Essential: '{{ Essential }}' + ImageUri: '{{ ImageUri }}' + ResolvedImageDigest: '{{ ResolvedImageDigest }}' + MemoryHardLimitMebibytes: '{{ MemoryHardLimitMebibytes }}' + EnvironmentOverride: + - null + PortConfiguration: null + HealthCheck: + Command: + - '{{ Command[0] }}' + Interval: '{{ Interval }}' + Timeout: '{{ Timeout }}' + Retries: '{{ Retries }}' + StartPeriod: '{{ StartPeriod }}' + MountPoints: + - null + - name: SourceVersionNumber + value: '{{ SourceVersionNumber }}' + - name: VersionDescription + value: '{{ VersionDescription }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.container_group_definitions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the container_group_definitions resource, the following permissions are required: + +### Create +```json +gamelift:CreateContainerGroupDefinition, +gamelift:DescribeContainerGroupDefinition, +gamelift:ListTagsForResource, +gamelift:TagResource, +ecr:BatchCheckLayerAvailability, +ecr:BatchGetImage, +ecr:GetDownloadUrlForLayer, +ecr:DescribeImages +``` + +### Read +```json +gamelift:DescribeContainerGroupDefinition, +gamelift:ListTagsForResource +``` + +### Update +```json +gamelift:UpdateContainerGroupDefinition, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource +``` + +### Delete +```json +gamelift:DescribeContainerGroupDefinition, +gamelift:DeleteContainerGroupDefinition +``` + +### List +```json +gamelift:ListContainerGroupDefinitions +``` diff --git a/website/docs/services/gamelift/container_group_definitions_list_only/index.md b/website/docs/services/gamelift/container_group_definitions_list_only/index.md new file mode 100644 index 0000000..75352f3 --- /dev/null +++ b/website/docs/services/gamelift/container_group_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: container_group_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - container_group_definitions_list_only + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists container_group_definitions in a region or regions, for all properties use container_group_definitions + +## Overview + + + + + + + +
Namecontainer_group_definitions_list_only
TypeResource
DescriptionThe AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA descriptive label for the container group definition.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all container_group_definitions in a region. +```sql +SELECT +region, +name +FROM aws.gamelift.container_group_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_group_definitions_list_only resource, see container_group_definitions + diff --git a/website/docs/services/gamelift/fleets/index.md b/website/docs/services/gamelift/fleets/index.md new file mode 100644 index 0000000..e50173c --- /dev/null +++ b/website/docs/services/gamelift/fleets/index.md @@ -0,0 +1,444 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a fleet resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayA list of rules that control how a fleet is scaled.
undefinedConfiguration for Anywhere fleet.
stringDetermines whether to apply fleet or location capacities on fleet creation.
objectIndicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created.
stringComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
stringA human-readable description of a fleet.
integer[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
arrayA range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
stringThe name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
stringIndicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
stringA unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
stringCredentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
array
arrayThis parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
integer[DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
arrayThe name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
integer[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
stringA descriptive label that is associated with a fleet. Fleet names do not need to be unique.
stringA game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
stringA unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
stringA unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.
objectA policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
stringUnique fleet ID
stringA unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
stringA unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.
objectInstructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.
This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.
stringThis parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
stringThis parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
stringAWS region.
+ +For more information, see AWS::GameLift::Fleet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all fleets in a region. +```sql +SELECT +region, +scaling_policies, +anywhere_configuration, +apply_capacity, +certificate_configuration, +compute_type, +description, +desired_ec2_instances, +e_c2_inbound_permissions, +e_c2_instance_type, +fleet_type, +instance_role_arn, +instance_role_credentials_provider, +locations, +log_paths, +max_size, +metric_groups, +min_size, +name, +new_game_session_protection_policy, +peer_vpc_aws_account_id, +peer_vpc_id, +resource_creation_limit_policy, +fleet_id, +build_id, +script_id, +runtime_configuration, +server_launch_parameters, +server_launch_path +FROM aws.gamelift.fleets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual fleet. +```sql +SELECT +region, +scaling_policies, +anywhere_configuration, +apply_capacity, +certificate_configuration, +compute_type, +description, +desired_ec2_instances, +e_c2_inbound_permissions, +e_c2_instance_type, +fleet_type, +instance_role_arn, +instance_role_credentials_provider, +locations, +log_paths, +max_size, +metric_groups, +min_size, +name, +new_game_session_protection_policy, +peer_vpc_aws_account_id, +peer_vpc_id, +resource_creation_limit_policy, +fleet_id, +build_id, +script_id, +runtime_configuration, +server_launch_parameters, +server_launch_path +FROM aws.gamelift.fleets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.fleets ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.fleets ( + ScalingPolicies, + AnywhereConfiguration, + ApplyCapacity, + CertificateConfiguration, + ComputeType, + Description, + DesiredEC2Instances, + EC2InboundPermissions, + EC2InstanceType, + FleetType, + InstanceRoleARN, + InstanceRoleCredentialsProvider, + Locations, + LogPaths, + MaxSize, + MetricGroups, + MinSize, + Name, + NewGameSessionProtectionPolicy, + PeerVpcAwsAccountId, + PeerVpcId, + ResourceCreationLimitPolicy, + BuildId, + ScriptId, + RuntimeConfiguration, + ServerLaunchParameters, + ServerLaunchPath, + region +) +SELECT + '{{ ScalingPolicies }}', + '{{ AnywhereConfiguration }}', + '{{ ApplyCapacity }}', + '{{ CertificateConfiguration }}', + '{{ ComputeType }}', + '{{ Description }}', + '{{ DesiredEC2Instances }}', + '{{ EC2InboundPermissions }}', + '{{ EC2InstanceType }}', + '{{ FleetType }}', + '{{ InstanceRoleARN }}', + '{{ InstanceRoleCredentialsProvider }}', + '{{ Locations }}', + '{{ LogPaths }}', + '{{ MaxSize }}', + '{{ MetricGroups }}', + '{{ MinSize }}', + '{{ Name }}', + '{{ NewGameSessionProtectionPolicy }}', + '{{ PeerVpcAwsAccountId }}', + '{{ PeerVpcId }}', + '{{ ResourceCreationLimitPolicy }}', + '{{ BuildId }}', + '{{ ScriptId }}', + '{{ RuntimeConfiguration }}', + '{{ ServerLaunchParameters }}', + '{{ ServerLaunchPath }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: fleet + props: + - name: ScalingPolicies + value: + - ComparisonOperator: '{{ ComparisonOperator }}' + EvaluationPeriods: '{{ EvaluationPeriods }}' + Location: + LocationName: '{{ LocationName }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + MetricName: '{{ MetricName }}' + Name: '{{ Name }}' + PolicyType: '{{ PolicyType }}' + ScalingAdjustment: '{{ ScalingAdjustment }}' + ScalingAdjustmentType: '{{ ScalingAdjustmentType }}' + Status: '{{ Status }}' + TargetConfiguration: + TargetValue: null + Threshold: null + UpdateStatus: '{{ UpdateStatus }}' + - name: AnywhereConfiguration + value: null + - name: ApplyCapacity + value: '{{ ApplyCapacity }}' + - name: CertificateConfiguration + value: + CertificateType: '{{ CertificateType }}' + - name: ComputeType + value: '{{ ComputeType }}' + - name: Description + value: '{{ Description }}' + - name: DesiredEC2Instances + value: '{{ DesiredEC2Instances }}' + - name: EC2InboundPermissions + value: + - FromPort: '{{ FromPort }}' + IpRange: '{{ IpRange }}' + Protocol: '{{ Protocol }}' + ToPort: '{{ ToPort }}' + - name: EC2InstanceType + value: '{{ EC2InstanceType }}' + - name: FleetType + value: '{{ FleetType }}' + - name: InstanceRoleARN + value: '{{ InstanceRoleARN }}' + - name: InstanceRoleCredentialsProvider + value: '{{ InstanceRoleCredentialsProvider }}' + - name: Locations + value: + - Location: null + LocationCapacity: + DesiredEC2Instances: '{{ DesiredEC2Instances }}' + MinSize: '{{ MinSize }}' + MaxSize: '{{ MaxSize }}' + - name: LogPaths + value: + - '{{ LogPaths[0] }}' + - name: MaxSize + value: '{{ MaxSize }}' + - name: MetricGroups + value: + - '{{ MetricGroups[0] }}' + - name: MinSize + value: '{{ MinSize }}' + - name: Name + value: '{{ Name }}' + - name: NewGameSessionProtectionPolicy + value: '{{ NewGameSessionProtectionPolicy }}' + - name: PeerVpcAwsAccountId + value: '{{ PeerVpcAwsAccountId }}' + - name: PeerVpcId + value: '{{ PeerVpcId }}' + - name: ResourceCreationLimitPolicy + value: + NewGameSessionsPerCreator: '{{ NewGameSessionsPerCreator }}' + PolicyPeriodInMinutes: '{{ PolicyPeriodInMinutes }}' + - name: BuildId + value: '{{ BuildId }}' + - name: ScriptId + value: '{{ ScriptId }}' + - name: RuntimeConfiguration + value: + GameSessionActivationTimeoutSeconds: '{{ GameSessionActivationTimeoutSeconds }}' + MaxConcurrentGameSessionActivations: '{{ MaxConcurrentGameSessionActivations }}' + ServerProcesses: + - ConcurrentExecutions: '{{ ConcurrentExecutions }}' + LaunchPath: '{{ LaunchPath }}' + Parameters: '{{ Parameters }}' + - name: ServerLaunchParameters + value: '{{ ServerLaunchParameters }}' + - name: ServerLaunchPath + value: '{{ ServerLaunchPath }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.fleets +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +gamelift:ListFleets +``` diff --git a/website/docs/services/gamelift/fleets_list_only/index.md b/website/docs/services/gamelift/fleets_list_only/index.md new file mode 100644 index 0000000..46589a1 --- /dev/null +++ b/website/docs/services/gamelift/fleets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleets_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleets in a region or regions, for all properties use fleets + +## Overview + + + + + + + +
Namefleets_list_only
TypeResource
DescriptionThe AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique fleet ID
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleets in a region. +```sql +SELECT +region, +fleet_id +FROM aws.gamelift.fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleets_list_only resource, see fleets + diff --git a/website/docs/services/gamelift/game_server_group_tags/index.md b/website/docs/services/gamelift/game_server_group_tags/index.md new file mode 100644 index 0000000..bf46fa8 --- /dev/null +++ b/website/docs/services/gamelift/game_server_group_tags/index.md @@ -0,0 +1,101 @@ +--- +title: game_server_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - game_server_group_tags + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for game_server_groups in a region + +## Overview + + + + + + + +
Namegame_server_group_tags
TypeResource
DescriptionThe AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
objectConfiguration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringThe fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.
stringThe type of delete to perform.
stringA generated unique ID for the game server group.
stringAn identifier for the new game server group.
stringA flag that indicates whether instances in the game server group are protected from early termination.
arrayA set of EC2 instance types to use when creating instances in the group.
objectThe EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
numberThe maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
numberThe minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringThe Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
arrayA list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all game_server_groups in a region. +```sql +SELECT +region, +auto_scaling_group_arn, +auto_scaling_policy, +balancing_strategy, +delete_option, +game_server_group_arn, +game_server_group_name, +game_server_protection_policy, +instance_definitions, +launch_template, +max_size, +min_size, +role_arn, +vpc_subnets, +tag_key, +tag_value +FROM aws.gamelift.game_server_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the game_server_group_tags resource, see game_server_groups + diff --git a/website/docs/services/gamelift/game_server_groups/index.md b/website/docs/services/gamelift/game_server_groups/index.md new file mode 100644 index 0000000..d8ff80b --- /dev/null +++ b/website/docs/services/gamelift/game_server_groups/index.md @@ -0,0 +1,341 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a game_server_group resource or lists game_server_groups in a region + +## Overview + + + + + + + +
Namegame_server_groups
TypeResource
DescriptionThe AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
objectConfiguration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringThe fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.
stringThe type of delete to perform.
stringA generated unique ID for the game server group.
stringAn identifier for the new game server group.
stringA flag that indicates whether instances in the game server group are protected from early termination.
arrayA set of EC2 instance types to use when creating instances in the group.
objectThe EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
numberThe maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
numberThe minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringThe Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
arrayA list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead.
arrayA list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringAWS region.
+ +For more information, see AWS::GameLift::GameServerGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all game_server_groups in a region. +```sql +SELECT +region, +auto_scaling_group_arn, +auto_scaling_policy, +balancing_strategy, +delete_option, +game_server_group_arn, +game_server_group_name, +game_server_protection_policy, +instance_definitions, +launch_template, +max_size, +min_size, +role_arn, +tags, +vpc_subnets +FROM aws.gamelift.game_server_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual game_server_group. +```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_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new game_server_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.game_server_groups ( + GameServerGroupName, + InstanceDefinitions, + RoleArn, + region +) +SELECT +'{{ GameServerGroupName }}', + '{{ InstanceDefinitions }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.game_server_groups ( + AutoScalingPolicy, + BalancingStrategy, + DeleteOption, + GameServerGroupName, + GameServerProtectionPolicy, + InstanceDefinitions, + LaunchTemplate, + MaxSize, + MinSize, + RoleArn, + Tags, + VpcSubnets, + region +) +SELECT + '{{ AutoScalingPolicy }}', + '{{ BalancingStrategy }}', + '{{ DeleteOption }}', + '{{ GameServerGroupName }}', + '{{ GameServerProtectionPolicy }}', + '{{ InstanceDefinitions }}', + '{{ LaunchTemplate }}', + '{{ MaxSize }}', + '{{ MinSize }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ VpcSubnets }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: game_server_group + props: + - name: AutoScalingPolicy + value: + EstimatedInstanceWarmup: null + TargetTrackingConfiguration: + TargetValue: null + - name: BalancingStrategy + value: '{{ BalancingStrategy }}' + - name: DeleteOption + value: '{{ DeleteOption }}' + - name: GameServerGroupName + value: '{{ GameServerGroupName }}' + - name: GameServerProtectionPolicy + value: '{{ GameServerProtectionPolicy }}' + - name: InstanceDefinitions + value: + - InstanceType: '{{ InstanceType }}' + WeightedCapacity: '{{ WeightedCapacity }}' + - name: LaunchTemplate + value: + LaunchTemplateId: '{{ LaunchTemplateId }}' + LaunchTemplateName: '{{ LaunchTemplateName }}' + Version: '{{ Version }}' + - name: MaxSize + value: null + - name: MinSize + value: null + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VpcSubnets + value: + - '{{ VpcSubnets[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.game_server_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +gamelift:ListGameServerGroups +``` diff --git a/website/docs/services/gamelift/game_server_groups_list_only/index.md b/website/docs/services/gamelift/game_server_groups_list_only/index.md new file mode 100644 index 0000000..4c6cfe8 --- /dev/null +++ b/website/docs/services/gamelift/game_server_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: game_server_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - game_server_groups_list_only + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists game_server_groups in a region or regions, for all properties use game_server_groups + +## Overview + + + + + + + +
Namegame_server_groups_list_only
TypeResource
DescriptionThe AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA generated unique ID for the game server group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all game_server_groups in a region. +```sql +SELECT +region, +game_server_group_arn +FROM aws.gamelift.game_server_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the game_server_groups_list_only resource, see game_server_groups + diff --git a/website/docs/services/gamelift/game_session_queue_tags/index.md b/website/docs/services/gamelift/game_session_queue_tags/index.md new file mode 100644 index 0000000..c997c10 --- /dev/null +++ b/website/docs/services/gamelift/game_session_queue_tags/index.md @@ -0,0 +1,93 @@ +--- +title: game_session_queue_tags +hide_title: false +hide_table_of_contents: false +keywords: + - game_session_queue_tags + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for game_session_queues in a region + +## Overview + + + + + + + +
Namegame_session_queue_tags
TypeResource
DescriptionThe AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
integerThe maximum time, in seconds, that a new game session placement request remains in the queue.
arrayA list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
arrayA set of policies that act as a sliding cap on player latency.
stringInformation that is added to all events that are related to this game session queue.
stringAn SNS topic ARN that is set up to receive game session placement notifications.
objectA list of locations where a queue is allowed to place new game sessions.
objectCustom settings to use when prioritizing destinations and locations for game session placements.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all game_session_queues in a region. +```sql +SELECT +region, +name, +timeout_in_seconds, +destinations, +player_latency_policies, +custom_event_data, +notification_target, +filter_configuration, +priority_configuration, +arn, +tag_key, +tag_value +FROM aws.gamelift.game_session_queue_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the game_session_queue_tags resource, see game_session_queues + diff --git a/website/docs/services/gamelift/game_session_queues/index.md b/website/docs/services/gamelift/game_session_queues/index.md new file mode 100644 index 0000000..718f10f --- /dev/null +++ b/website/docs/services/gamelift/game_session_queues/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a game_session_queue resource or lists game_session_queues in a region + +## Overview + + + + + + + +
Namegame_session_queues
TypeResource
DescriptionThe AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
integerThe maximum time, in seconds, that a new game session placement request remains in the queue.
arrayA list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
arrayA set of policies that act as a sliding cap on player latency.
stringInformation that is added to all events that are related to this game session queue.
stringAn SNS topic ARN that is set up to receive game session placement notifications.
objectA list of locations where a queue is allowed to place new game sessions.
objectCustom settings to use when prioritizing destinations and locations for game session placements.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::GameLift::GameSessionQueue. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all game_session_queues in a region. +```sql +SELECT +region, +name, +timeout_in_seconds, +destinations, +player_latency_policies, +custom_event_data, +notification_target, +filter_configuration, +priority_configuration, +arn, +tags +FROM aws.gamelift.game_session_queues +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual game_session_queue. +```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_queues +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new game_session_queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.game_session_queues ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.game_session_queues ( + Name, + TimeoutInSeconds, + Destinations, + PlayerLatencyPolicies, + CustomEventData, + NotificationTarget, + FilterConfiguration, + PriorityConfiguration, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ TimeoutInSeconds }}', + '{{ Destinations }}', + '{{ PlayerLatencyPolicies }}', + '{{ CustomEventData }}', + '{{ NotificationTarget }}', + '{{ FilterConfiguration }}', + '{{ PriorityConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: game_session_queue + props: + - name: Name + value: '{{ Name }}' + - name: TimeoutInSeconds + value: '{{ TimeoutInSeconds }}' + - name: Destinations + value: + - DestinationArn: '{{ DestinationArn }}' + - name: PlayerLatencyPolicies + value: + - MaximumIndividualPlayerLatencyMilliseconds: '{{ MaximumIndividualPlayerLatencyMilliseconds }}' + PolicyDurationSeconds: '{{ PolicyDurationSeconds }}' + - name: CustomEventData + value: '{{ CustomEventData }}' + - name: NotificationTarget + value: '{{ NotificationTarget }}' + - name: FilterConfiguration + value: + AllowedLocations: + - '{{ AllowedLocations[0] }}' + - name: PriorityConfiguration + value: + LocationOrder: + - '{{ LocationOrder[0] }}' + PriorityOrder: + - '{{ PriorityOrder[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.game_session_queues +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +gamelift:DescribeGameSessionQueues, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DescribeGameSessionQueues, +gamelift:DeleteGameSessionQueue +``` + +### Update +```json +gamelift:UpdateGameSessionQueue, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource +``` + +### List +```json +gamelift:DescribeGameSessionQueues +``` diff --git a/website/docs/services/gamelift/game_session_queues_list_only/index.md b/website/docs/services/gamelift/game_session_queues_list_only/index.md new file mode 100644 index 0000000..63d77c8 --- /dev/null +++ b/website/docs/services/gamelift/game_session_queues_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: game_session_queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - game_session_queues_list_only + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists game_session_queues in a region or regions, for all properties use game_session_queues + +## Overview + + + + + + + +
Namegame_session_queues_list_only
TypeResource
DescriptionThe AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all game_session_queues in a region. +```sql +SELECT +region, +name +FROM aws.gamelift.game_session_queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the game_session_queues_list_only resource, see game_session_queues + diff --git a/website/docs/services/gamelift/index.md b/website/docs/services/gamelift/index.md new file mode 100644 index 0000000..e02943f --- /dev/null +++ b/website/docs/services/gamelift/index.md @@ -0,0 +1,65 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The gamelift service documentation. + +:::info Service Summary + +
+
+total resources: 30
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/gamelift/location_tags/index.md b/website/docs/services/gamelift/location_tags/index.md new file mode 100644 index 0000000..18d8661 --- /dev/null +++ b/website/docs/services/gamelift/location_tags/index.md @@ -0,0 +1,79 @@ +--- +title: location_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_tags + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for locations in a region + +## Overview + + + + + + + +
Namelocation_tags
TypeResource
DescriptionThe AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all locations in a region. +```sql +SELECT +region, +location_name, +location_arn, +tag_key, +tag_value +FROM aws.gamelift.location_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_tags resource, see locations + diff --git a/website/docs/services/gamelift/locations/index.md b/website/docs/services/gamelift/locations/index.md new file mode 100644 index 0000000..ef78354 --- /dev/null +++ b/website/docs/services/gamelift/locations/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a location resource or lists locations in a region + +## Overview + + + + + + + +
Namelocations
TypeResource
DescriptionThe AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::GameLift::Location. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all locations in a region. +```sql +SELECT +region, +location_name, +location_arn, +tags +FROM aws.gamelift.locations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual location. +```sql +SELECT +region, +location_name, +location_arn, +tags +FROM aws.gamelift.locations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new location resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.locations ( + LocationName, + region +) +SELECT +'{{ LocationName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.locations ( + LocationName, + Tags, + region +) +SELECT + '{{ LocationName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: location + props: + - name: LocationName + value: '{{ LocationName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.locations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +gamelift:ListLocations, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DeleteLocation +``` + +### List +```json +gamelift:ListLocations +``` + +### Update +```json +gamelift:ListLocations, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource +``` diff --git a/website/docs/services/gamelift/locations_list_only/index.md b/website/docs/services/gamelift/locations_list_only/index.md new file mode 100644 index 0000000..f0e29a8 --- /dev/null +++ b/website/docs/services/gamelift/locations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: locations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - locations_list_only + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists locations in a region or regions, for all properties use locations + +## Overview + + + + + + + +
Namelocations_list_only
TypeResource
DescriptionThe AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all locations in a region. +```sql +SELECT +region, +location_name +FROM aws.gamelift.locations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locations_list_only resource, see locations + diff --git a/website/docs/services/gamelift/matchmaking_configuration_tags/index.md b/website/docs/services/gamelift/matchmaking_configuration_tags/index.md new file mode 100644 index 0000000..052897e --- /dev/null +++ b/website/docs/services/gamelift/matchmaking_configuration_tags/index.md @@ -0,0 +1,109 @@ +--- +title: matchmaking_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_configuration_tags + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for matchmaking_configurations in a region + +## Overview + + + + + + + +
Namematchmaking_configuration_tags
TypeResource
DescriptionThe AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanA flag that indicates whether a match that was created with this configuration must be accepted by the matched players
integerThe length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
integerThe number of player slots in a match to keep open for future players.
stringThe method used to backfill game sessions created with this matchmaking configuration.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
stringA time stamp indicating when this data object was created.
stringInformation to attach to all events related to the matchmaking configuration.
stringA descriptive label that is associated with matchmaking configuration.
stringIndicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
arrayA set of custom properties for a game session, formatted as key:value pairs.
stringA set of custom game session properties, formatted as a single string value.
arrayThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
stringA unique identifier for the matchmaking configuration.
stringAn SNS topic ARN that is set up to receive matchmaking notifications.
integerThe maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
stringThe Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
stringA unique identifier for the matchmaking rule set to use with this configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all matchmaking_configurations in a region. +```sql +SELECT +region, +acceptance_required, +acceptance_timeout_seconds, +additional_player_count, +backfill_mode, +arn, +creation_time, +custom_event_data, +description, +flex_match_mode, +game_properties, +game_session_data, +game_session_queue_arns, +name, +notification_target, +request_timeout_seconds, +rule_set_arn, +rule_set_name, +tag_key, +tag_value +FROM aws.gamelift.matchmaking_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matchmaking_configuration_tags resource, see matchmaking_configurations + diff --git a/website/docs/services/gamelift/matchmaking_configurations/index.md b/website/docs/services/gamelift/matchmaking_configurations/index.md new file mode 100644 index 0000000..0b84d6f --- /dev/null +++ b/website/docs/services/gamelift/matchmaking_configurations/index.md @@ -0,0 +1,329 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a matchmaking_configuration resource or lists matchmaking_configurations in a region + +## Overview + + + + + + + +
Namematchmaking_configurations
TypeResource
DescriptionThe AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanA flag that indicates whether a match that was created with this configuration must be accepted by the matched players
integerThe length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
integerThe number of player slots in a match to keep open for future players.
stringThe method used to backfill game sessions created with this matchmaking configuration.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
stringA time stamp indicating when this data object was created.
stringInformation to attach to all events related to the matchmaking configuration.
stringA descriptive label that is associated with matchmaking configuration.
stringIndicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
arrayA set of custom properties for a game session, formatted as key:value pairs.
stringA set of custom game session properties, formatted as a single string value.
arrayThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
stringA unique identifier for the matchmaking configuration.
stringAn SNS topic ARN that is set up to receive matchmaking notifications.
integerThe maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
stringThe Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
stringA unique identifier for the matchmaking rule set to use with this configuration.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::GameLift::MatchmakingConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all matchmaking_configurations in a region. +```sql +SELECT +region, +acceptance_required, +acceptance_timeout_seconds, +additional_player_count, +backfill_mode, +arn, +creation_time, +custom_event_data, +description, +flex_match_mode, +game_properties, +game_session_data, +game_session_queue_arns, +name, +notification_target, +request_timeout_seconds, +rule_set_arn, +rule_set_name, +tags +FROM aws.gamelift.matchmaking_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual matchmaking_configuration. +```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_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new matchmaking_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.matchmaking_configurations ( + AcceptanceRequired, + Name, + RequestTimeoutSeconds, + RuleSetName, + region +) +SELECT +'{{ AcceptanceRequired }}', + '{{ Name }}', + '{{ RequestTimeoutSeconds }}', + '{{ RuleSetName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.matchmaking_configurations ( + AcceptanceRequired, + AcceptanceTimeoutSeconds, + AdditionalPlayerCount, + BackfillMode, + CreationTime, + CustomEventData, + Description, + FlexMatchMode, + GameProperties, + GameSessionData, + GameSessionQueueArns, + Name, + NotificationTarget, + RequestTimeoutSeconds, + RuleSetArn, + RuleSetName, + Tags, + region +) +SELECT + '{{ AcceptanceRequired }}', + '{{ AcceptanceTimeoutSeconds }}', + '{{ AdditionalPlayerCount }}', + '{{ BackfillMode }}', + '{{ CreationTime }}', + '{{ CustomEventData }}', + '{{ Description }}', + '{{ FlexMatchMode }}', + '{{ GameProperties }}', + '{{ GameSessionData }}', + '{{ GameSessionQueueArns }}', + '{{ Name }}', + '{{ NotificationTarget }}', + '{{ RequestTimeoutSeconds }}', + '{{ RuleSetArn }}', + '{{ RuleSetName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: matchmaking_configuration + props: + - name: AcceptanceRequired + value: '{{ AcceptanceRequired }}' + - name: AcceptanceTimeoutSeconds + value: '{{ AcceptanceTimeoutSeconds }}' + - name: AdditionalPlayerCount + value: '{{ AdditionalPlayerCount }}' + - name: BackfillMode + value: '{{ BackfillMode }}' + - name: CreationTime + value: '{{ CreationTime }}' + - name: CustomEventData + value: '{{ CustomEventData }}' + - name: Description + value: '{{ Description }}' + - name: FlexMatchMode + value: '{{ FlexMatchMode }}' + - name: GameProperties + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: GameSessionData + value: '{{ GameSessionData }}' + - name: GameSessionQueueArns + value: + - '{{ GameSessionQueueArns[0] }}' + - name: Name + value: '{{ Name }}' + - name: NotificationTarget + value: '{{ NotificationTarget }}' + - name: RequestTimeoutSeconds + value: '{{ RequestTimeoutSeconds }}' + - name: RuleSetArn + value: '{{ RuleSetArn }}' + - name: RuleSetName + value: '{{ RuleSetName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.matchmaking_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +gamelift:DescribeMatchmakingConfigurations, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DescribeMatchmakingConfigurations, +gamelift:DeleteMatchmakingConfiguration +``` + +### List +```json +gamelift:DescribeMatchmakingConfigurations +``` + +### Update +```json +gamelift:DescribeMatchmakingConfigurations, +gamelift:UpdateMatchmakingConfiguration, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource +``` diff --git a/website/docs/services/gamelift/matchmaking_configurations_list_only/index.md b/website/docs/services/gamelift/matchmaking_configurations_list_only/index.md new file mode 100644 index 0000000..6bdfdb7 --- /dev/null +++ b/website/docs/services/gamelift/matchmaking_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: matchmaking_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_configurations_list_only + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists matchmaking_configurations in a region or regions, for all properties use matchmaking_configurations + +## Overview + + + + + + + +
Namematchmaking_configurations_list_only
TypeResource
DescriptionThe AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for the matchmaking configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all matchmaking_configurations in a region. +```sql +SELECT +region, +name +FROM aws.gamelift.matchmaking_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matchmaking_configurations_list_only resource, see matchmaking_configurations + diff --git a/website/docs/services/gamelift/matchmaking_rule_set_tags/index.md b/website/docs/services/gamelift/matchmaking_rule_set_tags/index.md new file mode 100644 index 0000000..cfdb59d --- /dev/null +++ b/website/docs/services/gamelift/matchmaking_rule_set_tags/index.md @@ -0,0 +1,83 @@ +--- +title: matchmaking_rule_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_rule_set_tags + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for matchmaking_rule_sets in a region + +## Overview + + + + + + + +
Namematchmaking_rule_set_tags
TypeResource
DescriptionThe AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the matchmaking rule set.
stringA collection of matchmaking rules, formatted as a JSON string.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all matchmaking_rule_sets in a region. +```sql +SELECT +region, +name, +rule_set_body, +creation_time, +arn, +tag_key, +tag_value +FROM aws.gamelift.matchmaking_rule_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matchmaking_rule_set_tags resource, see matchmaking_rule_sets + diff --git a/website/docs/services/gamelift/matchmaking_rule_sets/index.md b/website/docs/services/gamelift/matchmaking_rule_sets/index.md new file mode 100644 index 0000000..6493c3c --- /dev/null +++ b/website/docs/services/gamelift/matchmaking_rule_sets/index.md @@ -0,0 +1,227 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a matchmaking_rule_set resource or lists matchmaking_rule_sets in a region + +## Overview + + + + + + + +
Namematchmaking_rule_sets
TypeResource
DescriptionThe AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the matchmaking rule set.
stringA collection of matchmaking rules, formatted as a JSON string.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::GameLift::MatchmakingRuleSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all matchmaking_rule_sets in a region. +```sql +SELECT +region, +name, +rule_set_body, +creation_time, +arn, +tags +FROM aws.gamelift.matchmaking_rule_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual matchmaking_rule_set. +```sql +SELECT +region, +name, +rule_set_body, +creation_time, +arn, +tags +FROM aws.gamelift.matchmaking_rule_sets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new matchmaking_rule_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.matchmaking_rule_sets ( + Name, + RuleSetBody, + region +) +SELECT +'{{ Name }}', + '{{ RuleSetBody }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.matchmaking_rule_sets ( + Name, + RuleSetBody, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ RuleSetBody }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: matchmaking_rule_set + props: + - name: Name + value: '{{ Name }}' + - name: RuleSetBody + value: '{{ RuleSetBody }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.matchmaking_rule_sets +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +gamelift:DescribeMatchmakingRuleSets, +gamelift:ValidateMatchmakingRuleSet, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DeleteMatchmakingRuleSet +``` + +### Update +```json +gamelift:DescribeMatchmakingRuleSets, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource +``` + +### List +```json +gamelift:DescribeMatchmakingRuleSets +``` diff --git a/website/docs/services/gamelift/matchmaking_rule_sets_list_only/index.md b/website/docs/services/gamelift/matchmaking_rule_sets_list_only/index.md new file mode 100644 index 0000000..21f6aa0 --- /dev/null +++ b/website/docs/services/gamelift/matchmaking_rule_sets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: matchmaking_rule_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_rule_sets_list_only + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists matchmaking_rule_sets in a region or regions, for all properties use matchmaking_rule_sets + +## Overview + + + + + + + +
Namematchmaking_rule_sets_list_only
TypeResource
DescriptionThe AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for the matchmaking rule set.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all matchmaking_rule_sets in a region. +```sql +SELECT +region, +name +FROM aws.gamelift.matchmaking_rule_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matchmaking_rule_sets_list_only resource, see matchmaking_rule_sets + diff --git a/website/docs/services/gamelift/script_tags/index.md b/website/docs/services/gamelift/script_tags/index.md new file mode 100644 index 0000000..04e415f --- /dev/null +++ b/website/docs/services/gamelift/script_tags/index.md @@ -0,0 +1,89 @@ +--- +title: script_tags +hide_title: false +hide_table_of_contents: false +keywords: + - script_tags + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scripts in a region + +## Overview + + + + + + + +
Namescript_tags
TypeResource
DescriptionThe AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringA descriptive label that is associated with a script. Script names do not need to be unique.
objectThe location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
stringThe version that is associated with a script. Version strings do not need to be unique.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
stringA unique identifier for the Realtime script
integerThe file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scripts in a region. +```sql +SELECT +region, +name, +storage_location, +version, +creation_time, +arn, +id, +size_on_disk, +tag_key, +tag_value +FROM aws.gamelift.script_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the script_tags resource, see scripts + diff --git a/website/docs/services/gamelift/scripts/index.md b/website/docs/services/gamelift/scripts/index.md new file mode 100644 index 0000000..1bdc6ef --- /dev/null +++ b/website/docs/services/gamelift/scripts/index.md @@ -0,0 +1,245 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a script resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringA descriptive label that is associated with a script. Script names do not need to be unique.
objectThe location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
stringThe version that is associated with a script. Version strings do not need to be unique.
arrayAn array of key-value pairs to apply to this resource.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
stringA unique identifier for the Realtime script
integerThe file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
stringAWS region.
+ +For more information, see AWS::GameLift::Script. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scripts in a region. +```sql +SELECT +region, +name, +storage_location, +version, +tags, +creation_time, +arn, +id, +size_on_disk +FROM aws.gamelift.scripts +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual script. +```sql +SELECT +region, +name, +storage_location, +version, +tags, +creation_time, +arn, +id, +size_on_disk +FROM aws.gamelift.scripts +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new script resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.scripts ( + StorageLocation, + region +) +SELECT +'{{ StorageLocation }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.gamelift.scripts ( + Name, + StorageLocation, + Version, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ StorageLocation }}', + '{{ Version }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: script + props: + - name: Name + value: '{{ Name }}' + - name: StorageLocation + value: + Bucket: '{{ Bucket }}' + Key: '{{ Key }}' + ObjectVersion: '{{ ObjectVersion }}' + RoleArn: '{{ RoleArn }}' + - name: Version + value: '{{ Version }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.gamelift.scripts +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +gamelift:DescribeScript, +gamelift:ListScripts, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DeleteScript +``` + +### List +```json +gamelift:ListScripts, +gamelift:DescribeScript +``` + +### Update +```json +gamelift:DescribeScript, +gamelift:UpdateScript, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource, +iam:PassRole +``` diff --git a/website/docs/services/gamelift/scripts_list_only/index.md b/website/docs/services/gamelift/scripts_list_only/index.md new file mode 100644 index 0000000..9464839 --- /dev/null +++ b/website/docs/services/gamelift/scripts_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: scripts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scripts_list_only + - gamelift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scripts in a region or regions, for all properties use scripts + +## Overview + + + + + + + +
Namescripts_list_only
TypeResource
DescriptionThe AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for the Realtime script
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scripts in a region. +```sql +SELECT +region, +id +FROM aws.gamelift.scripts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scripts_list_only resource, see scripts + diff --git a/website/docs/services/globalaccelerator/accelerator_tags/index.md b/website/docs/services/globalaccelerator/accelerator_tags/index.md new file mode 100644 index 0000000..32beace --- /dev/null +++ b/website/docs/services/globalaccelerator/accelerator_tags/index.md @@ -0,0 +1,93 @@ +--- +title: accelerator_tags +hide_title: false +hide_table_of_contents: false +keywords: + - accelerator_tags + - globalaccelerator + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for accelerators in a region + +## Overview + + + + + + + +
Nameaccelerator_tags
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::Accelerator
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of accelerator.
stringIP Address type.
arrayThe IP addresses from BYOIP Prefix pool.
booleanIndicates whether an accelerator is enabled. The value is true or false.
stringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
arrayThe IPv4 addresses assigned to the accelerator.
arrayThe IPv6 addresses assigned if the accelerator is dualstack
stringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
stringThe Amazon Resource Name (ARN) of the accelerator.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all accelerators in a region. +```sql +SELECT +region, +name, +ip_address_type, +ip_addresses, +enabled, +dns_name, +ipv4_addresses, +ipv6_addresses, +dual_stack_dns_name, +accelerator_arn, +tag_key, +tag_value +FROM aws.globalaccelerator.accelerator_tags +; +``` + + +## Permissions + +For permissions required to operate on the accelerator_tags resource, see accelerators + diff --git a/website/docs/services/globalaccelerator/accelerators/index.md b/website/docs/services/globalaccelerator/accelerators/index.md new file mode 100644 index 0000000..5dcc947 --- /dev/null +++ b/website/docs/services/globalaccelerator/accelerators/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an accelerator resource or lists accelerators in a region + +## Overview + + + + + + + +
Nameaccelerators
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::Accelerator
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of accelerator.
stringIP Address type.
arrayThe IP addresses from BYOIP Prefix pool.
booleanIndicates whether an accelerator is enabled. The value is true or false.
stringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
arrayThe IPv4 addresses assigned to the accelerator.
arrayThe IPv6 addresses assigned if the accelerator is dualstack
stringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
stringThe Amazon Resource Name (ARN) of the accelerator.
array
stringAWS region.
+ +For more information, see AWS::GlobalAccelerator::Accelerator. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all accelerators in a region. +```sql +SELECT +region, +name, +ip_address_type, +ip_addresses, +enabled, +dns_name, +ipv4_addresses, +ipv6_addresses, +dual_stack_dns_name, +accelerator_arn, +tags +FROM aws.globalaccelerator.accelerators +; +``` +Gets all properties from an individual accelerator. +```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.accelerators +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new accelerator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.globalaccelerator.accelerators ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.globalaccelerator.accelerators ( + Name, + IpAddressType, + IpAddresses, + Enabled, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ IpAddressType }}', + '{{ IpAddresses }}', + '{{ Enabled }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: accelerator + props: + - name: Name + value: '{{ Name }}' + - name: IpAddressType + value: '{{ IpAddressType }}' + - name: IpAddresses + value: + - '{{ IpAddresses[0] }}' + - name: Enabled + value: '{{ Enabled }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.globalaccelerator.accelerators +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the accelerators resource, the following permissions are required: + +### Create +```json +globalaccelerator:CreateAccelerator, +globalaccelerator:DescribeAccelerator, +globalaccelerator:TagResource +``` + +### Read +```json +globalaccelerator:DescribeAccelerator +``` + +### Update +```json +globalaccelerator:UpdateAccelerator, +globalaccelerator:TagResource, +globalaccelerator:UntagResource, +globalaccelerator:DescribeAccelerator +``` + +### Delete +```json +globalaccelerator:UpdateAccelerator, +globalaccelerator:DeleteAccelerator, +globalaccelerator:DescribeAccelerator +``` + +### List +```json +globalaccelerator:ListAccelerators +``` diff --git a/website/docs/services/globalaccelerator/accelerators_list_only/index.md b/website/docs/services/globalaccelerator/accelerators_list_only/index.md new file mode 100644 index 0000000..54350c0 --- /dev/null +++ b/website/docs/services/globalaccelerator/accelerators_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: accelerators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - accelerators_list_only + - globalaccelerator + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists accelerators in a region or regions, for all properties use accelerators + +## Overview + + + + + + + +
Nameaccelerators_list_only
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::Accelerator
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the accelerator.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all accelerators in a region. +```sql +SELECT +region, +accelerator_arn +FROM aws.globalaccelerator.accelerators_list_only +; +``` + + +## Permissions + +For permissions required to operate on the accelerators_list_only resource, see accelerators + diff --git a/website/docs/services/globalaccelerator/cross_account_attachment_tags/index.md b/website/docs/services/globalaccelerator/cross_account_attachment_tags/index.md new file mode 100644 index 0000000..0085c18 --- /dev/null +++ b/website/docs/services/globalaccelerator/cross_account_attachment_tags/index.md @@ -0,0 +1,83 @@ +--- +title: cross_account_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cross_account_attachment_tags + - globalaccelerator + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cross_account_attachments in a region + +## Overview + + + + + + + +
Namecross_account_attachment_tags
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Friendly identifier of the attachment.
stringThe Amazon Resource Name (ARN) of the attachment.
arrayPrincipals to share the resources with.
arrayResources shared using the attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cross_account_attachments in a region. +```sql +SELECT +region, +name, +attachment_arn, +principals, +resources, +tag_key, +tag_value +FROM aws.globalaccelerator.cross_account_attachment_tags +; +``` + + +## Permissions + +For permissions required to operate on the cross_account_attachment_tags resource, see cross_account_attachments + diff --git a/website/docs/services/globalaccelerator/cross_account_attachments/index.md b/website/docs/services/globalaccelerator/cross_account_attachments/index.md new file mode 100644 index 0000000..2733daf --- /dev/null +++ b/website/docs/services/globalaccelerator/cross_account_attachments/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cross_account_attachment resource or lists cross_account_attachments in a region + +## Overview + + + + + + + +
Namecross_account_attachments
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Friendly identifier of the attachment.
stringThe Amazon Resource Name (ARN) of the attachment.
arrayPrincipals to share the resources with.
arrayResources shared using the attachment.
array
stringAWS region.
+ +For more information, see AWS::GlobalAccelerator::CrossAccountAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cross_account_attachments in a region. +```sql +SELECT +region, +name, +attachment_arn, +principals, +resources, +tags +FROM aws.globalaccelerator.cross_account_attachments +; +``` +Gets all properties from an individual cross_account_attachment. +```sql +SELECT +region, +name, +attachment_arn, +principals, +resources, +tags +FROM aws.globalaccelerator.cross_account_attachments +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cross_account_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.globalaccelerator.cross_account_attachments ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.globalaccelerator.cross_account_attachments ( + Name, + Principals, + Resources, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Principals }}', + '{{ Resources }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cross_account_attachment + props: + - name: Name + value: '{{ Name }}' + - name: Principals + value: + - '{{ Principals[0] }}' + - name: Resources + value: + - EndpointId: '{{ EndpointId }}' + Cidr: '{{ Cidr }}' + Region: '{{ Region }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.globalaccelerator.cross_account_attachments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the cross_account_attachments resource, the following permissions are required: + +### Create +```json +globalaccelerator:DescribeCrossAccountAttachment, +globalaccelerator:CreateCrossAccountAttachment, +globalaccelerator:TagResource +``` + +### Read +```json +globalaccelerator:DescribeCrossAccountAttachment +``` + +### Update +```json +globalaccelerator:UpdateCrossAccountAttachment, +globalaccelerator:DescribeCrossAccountAttachment, +globalaccelerator:TagResource, +globalaccelerator:UntagResource +``` + +### Delete +```json +globalaccelerator:DescribeCrossAccountAttachment, +globalaccelerator:DeleteCrossAccountAttachment +``` + +### List +```json +globalaccelerator:ListCrossAccountAttachments +``` diff --git a/website/docs/services/globalaccelerator/cross_account_attachments_list_only/index.md b/website/docs/services/globalaccelerator/cross_account_attachments_list_only/index.md new file mode 100644 index 0000000..cbca5b5 --- /dev/null +++ b/website/docs/services/globalaccelerator/cross_account_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cross_account_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cross_account_attachments_list_only + - globalaccelerator + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cross_account_attachments in a region or regions, for all properties use cross_account_attachments + +## Overview + + + + + + + +
Namecross_account_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cross_account_attachments in a region. +```sql +SELECT +region, +attachment_arn +FROM aws.globalaccelerator.cross_account_attachments_list_only +; +``` + + +## Permissions + +For permissions required to operate on the cross_account_attachments_list_only resource, see cross_account_attachments + diff --git a/website/docs/services/globalaccelerator/endpoint_groups/index.md b/website/docs/services/globalaccelerator/endpoint_groups/index.md new file mode 100644 index 0000000..4c73f18 --- /dev/null +++ b/website/docs/services/globalaccelerator/endpoint_groups/index.md @@ -0,0 +1,278 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an endpoint_group resource or lists endpoint_groups in a region + +## Overview + + + + + + + +
Nameendpoint_groups
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::EndpointGroup
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the listener
stringThe name of the AWS Region where the endpoint group is located
arrayThe list of endpoint objects.
numberThe percentage of traffic to sent to an AWS Region
integerThe port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
stringThe protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
string
integerThe time in seconds between each health check for an endpoint. Must be a value of 10 or 30
integerThe number of consecutive health checks required to set the state of the endpoint to unhealthy.
stringThe Amazon Resource Name (ARN) of the endpoint group
array
stringAWS region.
+ +For more information, see AWS::GlobalAccelerator::EndpointGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all endpoint_groups in a region. +```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_groups +; +``` +Gets all properties from an individual endpoint_group. +```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_groups +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new endpoint_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.globalaccelerator.endpoint_groups ( + ListenerArn, + EndpointGroupRegion, + region +) +SELECT +'{{ ListenerArn }}', + '{{ EndpointGroupRegion }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.globalaccelerator.endpoint_groups ( + ListenerArn, + EndpointGroupRegion, + EndpointConfigurations, + TrafficDialPercentage, + HealthCheckPort, + HealthCheckProtocol, + HealthCheckPath, + HealthCheckIntervalSeconds, + ThresholdCount, + PortOverrides, + region +) +SELECT + '{{ ListenerArn }}', + '{{ EndpointGroupRegion }}', + '{{ EndpointConfigurations }}', + '{{ TrafficDialPercentage }}', + '{{ HealthCheckPort }}', + '{{ HealthCheckProtocol }}', + '{{ HealthCheckPath }}', + '{{ HealthCheckIntervalSeconds }}', + '{{ ThresholdCount }}', + '{{ PortOverrides }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: endpoint_group + props: + - name: ListenerArn + value: '{{ ListenerArn }}' + - name: EndpointGroupRegion + value: '{{ EndpointGroupRegion }}' + - name: EndpointConfigurations + value: + - EndpointId: '{{ EndpointId }}' + AttachmentArn: '{{ AttachmentArn }}' + Weight: '{{ Weight }}' + ClientIPPreservationEnabled: '{{ ClientIPPreservationEnabled }}' + - name: TrafficDialPercentage + value: null + - name: HealthCheckPort + value: '{{ HealthCheckPort }}' + - name: HealthCheckProtocol + value: '{{ HealthCheckProtocol }}' + - name: HealthCheckPath + value: '{{ HealthCheckPath }}' + - name: HealthCheckIntervalSeconds + value: '{{ HealthCheckIntervalSeconds }}' + - name: ThresholdCount + value: '{{ ThresholdCount }}' + - name: PortOverrides + value: + - ListenerPort: '{{ ListenerPort }}' + EndpointPort: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.globalaccelerator.endpoint_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### Read +```json +globalaccelerator:DescribeEndpointGroup +``` + +### Update +```json +globalaccelerator:UpdateEndpointGroup, +globalaccelerator:DescribeEndpointGroup, +globalaccelerator:DescribeListener, +globalaccelerator:DescribeAccelerator +``` + +### Delete +```json +globalaccelerator:DeleteEndpointGroup, +globalaccelerator:DescribeEndpointGroup, +globalaccelerator:DescribeAccelerator +``` + +### List +```json +globalaccelerator:ListEndpointGroups +``` diff --git a/website/docs/services/globalaccelerator/endpoint_groups_list_only/index.md b/website/docs/services/globalaccelerator/endpoint_groups_list_only/index.md new file mode 100644 index 0000000..cd30932 --- /dev/null +++ b/website/docs/services/globalaccelerator/endpoint_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: endpoint_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_groups_list_only + - globalaccelerator + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoint_groups in a region or regions, for all properties use endpoint_groups + +## Overview + + + + + + + +
Nameendpoint_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::EndpointGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the endpoint group
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoint_groups in a region. +```sql +SELECT +region, +endpoint_group_arn +FROM aws.globalaccelerator.endpoint_groups_list_only +; +``` + + +## Permissions + +For permissions required to operate on the endpoint_groups_list_only resource, see endpoint_groups + diff --git a/website/docs/services/globalaccelerator/index.md b/website/docs/services/globalaccelerator/index.md new file mode 100644 index 0000000..e48184f --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The globalaccelerator service documentation. + +:::info Service Summary + +
+
+total resources: 10
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/globalaccelerator/listeners/index.md b/website/docs/services/globalaccelerator/listeners/index.md new file mode 100644 index 0000000..7367412 --- /dev/null +++ b/website/docs/services/globalaccelerator/listeners/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a listener resource or lists listeners in a region + +## Overview + + + + + + + +
Namelisteners
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::Listener
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the listener.
stringThe Amazon Resource Name (ARN) of the accelerator.
array
stringThe protocol for the listener.
stringClient affinity lets you direct all requests from a user to the same endpoint.
stringAWS region.
+ +For more information, see AWS::GlobalAccelerator::Listener. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all listeners in a region. +```sql +SELECT +region, +listener_arn, +accelerator_arn, +port_ranges, +protocol, +client_affinity +FROM aws.globalaccelerator.listeners +; +``` +Gets all properties from an individual listener. +```sql +SELECT +region, +listener_arn, +accelerator_arn, +port_ranges, +protocol, +client_affinity +FROM aws.globalaccelerator.listeners +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new listener resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.globalaccelerator.listeners ( + AcceleratorArn, + PortRanges, + Protocol, + region +) +SELECT +'{{ AcceleratorArn }}', + '{{ PortRanges }}', + '{{ Protocol }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.globalaccelerator.listeners ( + AcceleratorArn, + PortRanges, + Protocol, + ClientAffinity, + region +) +SELECT + '{{ AcceleratorArn }}', + '{{ PortRanges }}', + '{{ Protocol }}', + '{{ ClientAffinity }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: listener + props: + - name: AcceleratorArn + value: '{{ AcceleratorArn }}' + - name: PortRanges + value: + - FromPort: '{{ FromPort }}' + ToPort: null + - name: Protocol + value: '{{ Protocol }}' + - name: ClientAffinity + value: '{{ ClientAffinity }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.globalaccelerator.listeners +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the listeners resource, the following permissions are required: + +### Create +```json +globalaccelerator:CreateListener, +globalaccelerator:DescribeListener, +globalaccelerator:DescribeAccelerator +``` + +### Read +```json +globalaccelerator:DescribeListener +``` + +### Update +```json +globalaccelerator:UpdateListener, +globalaccelerator:DescribeListener, +globalaccelerator:DescribeAccelerator +``` + +### Delete +```json +globalaccelerator:DescribeListener, +globalaccelerator:DeleteListener, +globalaccelerator:DescribeAccelerator +``` + +### List +```json +globalaccelerator:ListListeners +``` diff --git a/website/docs/services/globalaccelerator/listeners_list_only/index.md b/website/docs/services/globalaccelerator/listeners_list_only/index.md new file mode 100644 index 0000000..47d6ced --- /dev/null +++ b/website/docs/services/globalaccelerator/listeners_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: listeners_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - listeners_list_only + - globalaccelerator + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists listeners in a region or regions, for all properties use listeners + +## Overview + + + + + + + +
Namelisteners_list_only
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::Listener
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the listener.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all listeners in a region. +```sql +SELECT +region, +listener_arn +FROM aws.globalaccelerator.listeners_list_only +; +``` + + +## Permissions + +For permissions required to operate on the listeners_list_only resource, see listeners + diff --git a/website/docs/services/glue/crawler_tags/index.md b/website/docs/services/glue/crawler_tags/index.md new file mode 100644 index 0000000..e0ad2f9 --- /dev/null +++ b/website/docs/services/glue/crawler_tags/index.md @@ -0,0 +1,101 @@ +--- +title: crawler_tags +hide_title: false +hide_table_of_contents: false +keywords: + - crawler_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for crawlers in a region + +## Overview + + + + + + + +
Namecrawler_tags
TypeResource
DescriptionResource Type definition for AWS::Glue::Crawler
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayA list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
stringA description of the crawler.
objectThe policy that specifies update and delete behaviors for the crawler. The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl. The SchemaChangePolicy does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of the SchemaChangePolicy on a crawler. The SchemaChangePolicy consists of two components, UpdateBehavior and DeleteBehavior.
stringCrawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior.
objectWhen crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in AWS Glue in the developer guide.
stringThe name of the database in which the crawler's output is stored.
objectSpecifies data stores to crawl.
stringThe name of the SecurityConfiguration structure to be used by this crawler.
stringThe name of the crawler.
stringThe Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
objectSpecifies AWS Lake Formation configuration settings for the crawler
objectA scheduling object using a cron statement to schedule an event.
stringThe prefix added to the names of tables that are created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all crawlers in a region. +```sql +SELECT +region, +classifiers, +description, +schema_change_policy, +configuration, +recrawl_policy, +database_name, +targets, +crawler_security_configuration, +name, +role, +lake_formation_configuration, +schedule, +table_prefix, +tag_key, +tag_value +FROM aws.glue.crawler_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the crawler_tags resource, see crawlers + diff --git a/website/docs/services/glue/crawlers/index.md b/website/docs/services/glue/crawlers/index.md new file mode 100644 index 0000000..08fc25f --- /dev/null +++ b/website/docs/services/glue/crawlers/index.md @@ -0,0 +1,346 @@ +--- +title: crawlers +hide_title: false +hide_table_of_contents: false +keywords: + - crawlers + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a crawler resource or lists crawlers in a region + +## Overview + + + + + + + +
Namecrawlers
TypeResource
DescriptionResource Type definition for AWS::Glue::Crawler
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayA list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
stringA description of the crawler.
objectThe policy that specifies update and delete behaviors for the crawler. The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl. The SchemaChangePolicy does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of the SchemaChangePolicy on a crawler. The SchemaChangePolicy consists of two components, UpdateBehavior and DeleteBehavior.
stringCrawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior.
objectWhen crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in AWS Glue in the developer guide.
stringThe name of the database in which the crawler's output is stored.
objectSpecifies data stores to crawl.
stringThe name of the SecurityConfiguration structure to be used by this crawler.
stringThe name of the crawler.
stringThe Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
objectSpecifies AWS Lake Formation configuration settings for the crawler
objectA scheduling object using a cron statement to schedule an event.
stringThe prefix added to the names of tables that are created.
objectThe tags to use with this crawler.
stringAWS region.
+ +For more information, see AWS::Glue::Crawler. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all crawlers in a region. +```sql +SELECT +region, +classifiers, +description, +schema_change_policy, +configuration, +recrawl_policy, +database_name, +targets, +crawler_security_configuration, +name, +role, +lake_formation_configuration, +schedule, +table_prefix, +tags +FROM aws.glue.crawlers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual crawler. +```sql +SELECT +region, +classifiers, +description, +schema_change_policy, +configuration, +recrawl_policy, +database_name, +targets, +crawler_security_configuration, +name, +role, +lake_formation_configuration, +schedule, +table_prefix, +tags +FROM aws.glue.crawlers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new crawler resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.glue.crawlers ( + Targets, + Role, + region +) +SELECT +'{{ Targets }}', + '{{ Role }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.glue.crawlers ( + Classifiers, + Description, + SchemaChangePolicy, + Configuration, + RecrawlPolicy, + DatabaseName, + Targets, + CrawlerSecurityConfiguration, + Name, + Role, + LakeFormationConfiguration, + Schedule, + TablePrefix, + Tags, + region +) +SELECT + '{{ Classifiers }}', + '{{ Description }}', + '{{ SchemaChangePolicy }}', + '{{ Configuration }}', + '{{ RecrawlPolicy }}', + '{{ DatabaseName }}', + '{{ Targets }}', + '{{ CrawlerSecurityConfiguration }}', + '{{ Name }}', + '{{ Role }}', + '{{ LakeFormationConfiguration }}', + '{{ Schedule }}', + '{{ TablePrefix }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: crawler + props: + - name: Classifiers + value: + - '{{ Classifiers[0] }}' + - name: Description + value: '{{ Description }}' + - name: SchemaChangePolicy + value: + UpdateBehavior: '{{ UpdateBehavior }}' + DeleteBehavior: '{{ DeleteBehavior }}' + - name: Configuration + value: '{{ Configuration }}' + - name: RecrawlPolicy + value: + RecrawlBehavior: '{{ RecrawlBehavior }}' + - name: DatabaseName + value: '{{ DatabaseName }}' + - name: Targets + value: + S3Targets: + - ConnectionName: '{{ ConnectionName }}' + Path: '{{ Path }}' + SampleSize: '{{ SampleSize }}' + Exclusions: + - '{{ Exclusions[0] }}' + DlqEventQueueArn: '{{ DlqEventQueueArn }}' + EventQueueArn: '{{ EventQueueArn }}' + CatalogTargets: + - ConnectionName: '{{ ConnectionName }}' + DatabaseName: '{{ DatabaseName }}' + DlqEventQueueArn: '{{ DlqEventQueueArn }}' + Tables: + - '{{ Tables[0] }}' + EventQueueArn: '{{ EventQueueArn }}' + DeltaTargets: + - ConnectionName: '{{ ConnectionName }}' + CreateNativeDeltaTable: '{{ CreateNativeDeltaTable }}' + WriteManifest: '{{ WriteManifest }}' + DeltaTables: + - '{{ DeltaTables[0] }}' + MongoDBTargets: + - ConnectionName: '{{ ConnectionName }}' + Path: '{{ Path }}' + JdbcTargets: + - ConnectionName: '{{ ConnectionName }}' + Path: '{{ Path }}' + Exclusions: + - '{{ Exclusions[0] }}' + EnableAdditionalMetadata: + - '{{ EnableAdditionalMetadata[0] }}' + DynamoDBTargets: + - Path: '{{ Path }}' + IcebergTargets: + - ConnectionName: '{{ ConnectionName }}' + Paths: + - '{{ Paths[0] }}' + Exclusions: + - '{{ Exclusions[0] }}' + MaximumTraversalDepth: '{{ MaximumTraversalDepth }}' + - name: CrawlerSecurityConfiguration + value: '{{ CrawlerSecurityConfiguration }}' + - name: Name + value: '{{ Name }}' + - name: Role + value: '{{ Role }}' + - name: LakeFormationConfiguration + value: + UseLakeFormationCredentials: '{{ UseLakeFormationCredentials }}' + AccountId: '{{ AccountId }}' + - name: Schedule + value: + ScheduleExpression: '{{ ScheduleExpression }}' + - name: TablePrefix + value: '{{ TablePrefix }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.glue.crawlers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the crawlers resource, the following permissions are required: + +### Create +```json +glue:CreateCrawler, +glue:GetCrawler, +glue:TagResource, +iam:PassRole +``` + +### Read +```json +glue:GetCrawler, +glue:GetTags, +iam:PassRole +``` + +### Update +```json +glue:UpdateCrawler, +glue:UntagResource, +glue:TagResource, +iam:PassRole +``` + +### Delete +```json +glue:DeleteCrawler, +glue:GetCrawler, +glue:StopCrawler, +iam:PassRole +``` + +### List +```json +glue:ListCrawlers, +iam:PassRole +``` diff --git a/website/docs/services/glue/crawlers_list_only/index.md b/website/docs/services/glue/crawlers_list_only/index.md new file mode 100644 index 0000000..0ac206f --- /dev/null +++ b/website/docs/services/glue/crawlers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: crawlers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - crawlers_list_only + - glue + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists crawlers in a region or regions, for all properties use crawlers + +## Overview + + + + + + + +
Namecrawlers_list_only
TypeResource
DescriptionResource Type definition for AWS::Glue::Crawler
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the crawler.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all crawlers in a region. +```sql +SELECT +region, +name +FROM aws.glue.crawlers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the crawlers_list_only resource, see crawlers + diff --git a/website/docs/services/glue/databases/index.md b/website/docs/services/glue/databases/index.md new file mode 100644 index 0000000..a2d49bf --- /dev/null +++ b/website/docs/services/glue/databases/index.md @@ -0,0 +1,249 @@ +--- +title: databases +hide_title: false +hide_table_of_contents: false +keywords: + - databases + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a database resource or lists databases in a region + +## Overview + + + + + + + +
Namedatabases
TypeResource
DescriptionResource Type definition for AWS::Glue::Database
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe AWS account ID for the account in which to create the catalog object.
objectThe metadata for the database.
stringThe name of the database. For hive compatibility, this is folded to lowercase when it is store.
stringAWS region.
+ +For more information, see AWS::Glue::Database. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all databases in a region. +```sql +SELECT +region, +catalog_id, +database_input, +database_name +FROM aws.glue.databases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual database. +```sql +SELECT +region, +catalog_id, +database_input, +database_name +FROM aws.glue.databases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new database resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.glue.databases ( + CatalogId, + DatabaseInput, + region +) +SELECT +'{{ CatalogId }}', + '{{ DatabaseInput }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.glue.databases ( + CatalogId, + DatabaseInput, + DatabaseName, + region +) +SELECT + '{{ CatalogId }}', + '{{ DatabaseInput }}', + '{{ DatabaseName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: database + props: + - name: CatalogId + value: '{{ CatalogId }}' + - name: DatabaseInput + value: + LocationUri: '{{ LocationUri }}' + CreateTableDefaultPermissions: + - Permissions: + - '{{ Permissions[0] }}' + Principal: + DataLakePrincipalIdentifier: '{{ DataLakePrincipalIdentifier }}' + Description: '{{ Description }}' + Parameters: {} + TargetDatabase: + DatabaseName: '{{ DatabaseName }}' + Region: '{{ Region }}' + CatalogId: '{{ CatalogId }}' + FederatedDatabase: + ConnectionName: '{{ ConnectionName }}' + Identifier: '{{ Identifier }}' + Name: '{{ Name }}' + - name: DatabaseName + value: '{{ DatabaseName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.glue.databases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the databases resource, the following permissions are required: + +### Create +```json +glue:CreateDatabase, +glue:GetDatabase, +glue:PassConnection, +glue:CreateConnection, +lakeformation:ListResources, +lakeformation:DescribeResource, +lakeformation:DescribeLakeFormationIdentityCenterConfiguration +``` + +### Read +```json +glue:GetDatabase, +glue:GetConnection, +lakeformation:ListResources, +lakeformation:DescribeResource, +lakeformation:DescribeLakeFormationIdentityCenterConfiguration +``` + +### Update +```json +glue:UpdateDatabase, +glue:UpdateConnection, +lakeformation:ListResources, +lakeformation:DescribeResource, +lakeformation:DescribeLakeFormationIdentityCenterConfiguration +``` + +### Delete +```json +glue:DeleteDatabase, +glue:GetDatabase, +glue:DeleteConnection, +glue:GetConnection, +lakeformation:ListResources, +lakeformation:DescribeResource, +lakeformation:DescribeLakeFormationIdentityCenterConfiguration +``` + +### List +```json +glue:GetDatabases, +lakeformation:ListResources, +lakeformation:DescribeResource, +lakeformation:DescribeLakeFormationIdentityCenterConfiguration +``` diff --git a/website/docs/services/glue/databases_list_only/index.md b/website/docs/services/glue/databases_list_only/index.md new file mode 100644 index 0000000..117d892 --- /dev/null +++ b/website/docs/services/glue/databases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: databases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - databases_list_only + - glue + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists databases in a region or regions, for all properties use databases + +## Overview + + + + + + + +
Namedatabases_list_only
TypeResource
DescriptionResource Type definition for AWS::Glue::Database
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the database. For hive compatibility, this is folded to lowercase when it is store.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all databases in a region. +```sql +SELECT +region, +database_name +FROM aws.glue.databases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the databases_list_only resource, see databases + diff --git a/website/docs/services/glue/index.md b/website/docs/services/glue/index.md new file mode 100644 index 0000000..429a60f --- /dev/null +++ b/website/docs/services/glue/index.md @@ -0,0 +1,53 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The glue service documentation. + +:::info Service Summary + +
+
+total resources: 18
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/glue/job_tags/index.md b/website/docs/services/glue/job_tags/index.md new file mode 100644 index 0000000..86314e0 --- /dev/null +++ b/website/docs/services/glue/job_tags/index.md @@ -0,0 +1,119 @@ +--- +title: job_tags +hide_title: false +hide_table_of_contents: false +keywords: + - job_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for jobs in a region + +## Overview + + + + + + + +
Namejob_tags
TypeResource
DescriptionResource Type definition for AWS::Glue::Job
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectSpecifies the connections used by a job
numberThe maximum number of times to retry this job after a JobRun fails
stringA description of the job.
integerThe maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.
numberThe number of capacity units that are allocated to this job.
stringThe name you assign to the job definition
stringThe name or Amazon Resource Name (ARN) of the IAM role associated with this job.
objectThe default arguments for this job, specified as name-value pairs.
objectSpecifies configuration properties of a notification.
stringTThe type of predefined worker that is allocated when a job runs.
stringIndicates whether the job is run with a standard or flexible execution class.
stringThis field is reserved for future use.
objectThe code that executes a job.
stringGlue version determines the versions of Apache Spark and Python that AWS Glue supports.
objectThe maximum number of concurrent runs that are allowed for this job.
stringThe name of the SecurityConfiguration structure to be used with this job.
integerThe number of workers of a defined workerType that are allocated when a job runs.
numberThe number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
objectNon-overridable arguments for this job, specified as name-value pairs.
stringProperty description not available.
stringProperty description not available.
booleanProperty description not available.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all jobs in a region. +```sql +SELECT +region, +connections, +max_retries, +description, +timeout, +allocated_capacity, +name, +role, +default_arguments, +notification_property, +worker_type, +execution_class, +log_uri, +command, +glue_version, +execution_property, +security_configuration, +number_of_workers, +max_capacity, +non_overridable_arguments, +maintenance_window, +job_mode, +job_run_queuing_enabled, +tag_key, +tag_value +FROM aws.glue.job_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_tags resource, see jobs + diff --git a/website/docs/services/glue/jobs/index.md b/website/docs/services/glue/jobs/index.md new file mode 100644 index 0000000..91432c4 --- /dev/null +++ b/website/docs/services/glue/jobs/index.md @@ -0,0 +1,369 @@ +--- +title: jobs +hide_title: false +hide_table_of_contents: false +keywords: + - jobs + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a job resource or lists jobs in a region + +## Overview + + + + + + + +
Namejobs
TypeResource
DescriptionResource Type definition for AWS::Glue::Job
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectSpecifies the connections used by a job
numberThe maximum number of times to retry this job after a JobRun fails
stringA description of the job.
integerThe maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.
numberThe number of capacity units that are allocated to this job.
stringThe name you assign to the job definition
stringThe name or Amazon Resource Name (ARN) of the IAM role associated with this job.
objectThe default arguments for this job, specified as name-value pairs.
objectSpecifies configuration properties of a notification.
stringTThe type of predefined worker that is allocated when a job runs.
stringIndicates whether the job is run with a standard or flexible execution class.
stringThis field is reserved for future use.
objectThe code that executes a job.
stringGlue version determines the versions of Apache Spark and Python that AWS Glue supports.
objectThe maximum number of concurrent runs that are allowed for this job.
stringThe name of the SecurityConfiguration structure to be used with this job.
integerThe number of workers of a defined workerType that are allocated when a job runs.
objectThe tags to use with this job.
numberThe number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
objectNon-overridable arguments for this job, specified as name-value pairs.
stringProperty description not available.
stringProperty description not available.
booleanProperty description not available.
stringAWS region.
+ +For more information, see AWS::Glue::Job. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all jobs in a region. +```sql +SELECT +region, +connections, +max_retries, +description, +timeout, +allocated_capacity, +name, +role, +default_arguments, +notification_property, +worker_type, +execution_class, +log_uri, +command, +glue_version, +execution_property, +security_configuration, +number_of_workers, +tags, +max_capacity, +non_overridable_arguments, +maintenance_window, +job_mode, +job_run_queuing_enabled +FROM aws.glue.jobs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual job. +```sql +SELECT +region, +connections, +max_retries, +description, +timeout, +allocated_capacity, +name, +role, +default_arguments, +notification_property, +worker_type, +execution_class, +log_uri, +command, +glue_version, +execution_property, +security_configuration, +number_of_workers, +tags, +max_capacity, +non_overridable_arguments, +maintenance_window, +job_mode, +job_run_queuing_enabled +FROM aws.glue.jobs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new job resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.glue.jobs ( + Role, + Command, + region +) +SELECT +'{{ Role }}', + '{{ Command }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.glue.jobs ( + Connections, + MaxRetries, + Description, + Timeout, + AllocatedCapacity, + Name, + Role, + DefaultArguments, + NotificationProperty, + WorkerType, + ExecutionClass, + LogUri, + Command, + GlueVersion, + ExecutionProperty, + SecurityConfiguration, + NumberOfWorkers, + Tags, + MaxCapacity, + NonOverridableArguments, + MaintenanceWindow, + JobMode, + JobRunQueuingEnabled, + region +) +SELECT + '{{ Connections }}', + '{{ MaxRetries }}', + '{{ Description }}', + '{{ Timeout }}', + '{{ AllocatedCapacity }}', + '{{ Name }}', + '{{ Role }}', + '{{ DefaultArguments }}', + '{{ NotificationProperty }}', + '{{ WorkerType }}', + '{{ ExecutionClass }}', + '{{ LogUri }}', + '{{ Command }}', + '{{ GlueVersion }}', + '{{ ExecutionProperty }}', + '{{ SecurityConfiguration }}', + '{{ NumberOfWorkers }}', + '{{ Tags }}', + '{{ MaxCapacity }}', + '{{ NonOverridableArguments }}', + '{{ MaintenanceWindow }}', + '{{ JobMode }}', + '{{ JobRunQueuingEnabled }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: job + props: + - name: Connections + value: + Connections: + - '{{ Connections[0] }}' + - name: MaxRetries + value: null + - name: Description + value: '{{ Description }}' + - name: Timeout + value: '{{ Timeout }}' + - name: AllocatedCapacity + value: null + - name: Name + value: '{{ Name }}' + - name: Role + value: '{{ Role }}' + - name: DefaultArguments + value: {} + - name: NotificationProperty + value: + NotifyDelayAfter: '{{ NotifyDelayAfter }}' + - name: WorkerType + value: '{{ WorkerType }}' + - name: ExecutionClass + value: '{{ ExecutionClass }}' + - name: LogUri + value: '{{ LogUri }}' + - name: Command + value: + Name: '{{ Name }}' + PythonVersion: '{{ PythonVersion }}' + Runtime: '{{ Runtime }}' + ScriptLocation: '{{ ScriptLocation }}' + - name: GlueVersion + value: '{{ GlueVersion }}' + - name: ExecutionProperty + value: + MaxConcurrentRuns: null + - name: SecurityConfiguration + value: '{{ SecurityConfiguration }}' + - name: NumberOfWorkers + value: '{{ NumberOfWorkers }}' + - name: Tags + value: {} + - name: MaxCapacity + value: null + - name: NonOverridableArguments + value: {} + - name: MaintenanceWindow + value: '{{ MaintenanceWindow }}' + - name: JobMode + value: '{{ JobMode }}' + - name: JobRunQueuingEnabled + value: '{{ JobRunQueuingEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.glue.jobs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the jobs resource, the following permissions are required: + +### Create +```json +iam:GetRole, +iam:PassRole, +glue:CreateJob, +glue:GetJob, +glue:TagResource +``` + +### Read +```json +glue:GetJob, +glue:GetTags +``` + +### Delete +```json +glue:DeleteJob, +glue:GetJob, +glue:UntagResource +``` + +### Update +```json +iam:GetRole, +iam:PassRole, +glue:UpdateJob, +glue:UntagResource, +glue:TagResource +``` + +### List +```json +glue:ListJobs +``` diff --git a/website/docs/services/glue/jobs_list_only/index.md b/website/docs/services/glue/jobs_list_only/index.md new file mode 100644 index 0000000..42dd6a2 --- /dev/null +++ b/website/docs/services/glue/jobs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: jobs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - jobs_list_only + - glue + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists jobs in a region or regions, for all properties use jobs + +## Overview + + + + + + + +
Namejobs_list_only
TypeResource
DescriptionResource Type definition for AWS::Glue::Job
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name you assign to the job definition
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all jobs in a region. +```sql +SELECT +region, +name +FROM aws.glue.jobs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the jobs_list_only resource, see jobs + diff --git a/website/docs/services/glue/schema_version_metadata/index.md b/website/docs/services/glue/schema_version_metadata/index.md new file mode 100644 index 0000000..2f15c66 --- /dev/null +++ b/website/docs/services/glue/schema_version_metadata/index.md @@ -0,0 +1,202 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a schema_version_metadatum resource or lists schema_version_metadata in a region + +## Overview + + + + + + + +
Nameschema_version_metadata
TypeResource
DescriptionThis resource adds Key-Value metadata to a Schema version of Glue Schema Registry.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringRepresents the version ID associated with the schema version.
stringMetadata key
stringMetadata value
stringAWS region.
+ +For more information, see AWS::Glue::SchemaVersionMetadata. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all schema_version_metadata in a region. +```sql +SELECT +region, +schema_version_id, +key, +value +FROM aws.glue.schema_version_metadata +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual schema_version_metadatum. +```sql +SELECT +region, +schema_version_id, +key, +value +FROM aws.glue.schema_version_metadata +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new schema_version_metadatum resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.glue.schema_version_metadata ( + SchemaVersionId, + Key, + Value, + region +) +SELECT +'{{ SchemaVersionId }}', + '{{ Key }}', + '{{ Value }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.glue.schema_version_metadata ( + SchemaVersionId, + Key, + Value, + region +) +SELECT + '{{ SchemaVersionId }}', + '{{ Key }}', + '{{ Value }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: schema_version_metadatum + props: + - name: SchemaVersionId + value: '{{ SchemaVersionId }}' + - name: Key + value: '{{ Key }}' + - name: Value + value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.glue.schema_version_metadata +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the schema_version_metadata resource, the following permissions are required: + +### Create +```json +glue:putSchemaVersionMetadata +``` + +### Read +```json +glue:querySchemaVersionMetadata +``` + +### Delete +```json +glue:removeSchemaVersionMetadata +``` + +### List +```json +glue:querySchemaVersionMetadata +``` diff --git a/website/docs/services/glue/schema_version_metadata_list_only/index.md b/website/docs/services/glue/schema_version_metadata_list_only/index.md new file mode 100644 index 0000000..fc1e633 --- /dev/null +++ b/website/docs/services/glue/schema_version_metadata_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: schema_version_metadata_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schema_version_metadata_list_only + - glue + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schema_version_metadata in a region or regions, for all properties use schema_version_metadata + +## Overview + + + + + + + +
Nameschema_version_metadata_list_only
TypeResource
DescriptionThis resource adds Key-Value metadata to a Schema version of Glue Schema Registry.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringRepresents the version ID associated with the schema version.
stringMetadata key
stringMetadata value
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schema_version_metadata in a region. +```sql +SELECT +region, +schema_version_id, +key, +value +FROM aws.glue.schema_version_metadata_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schema_version_metadata_list_only resource, see schema_version_metadata + diff --git a/website/docs/services/glue/schema_versions/index.md b/website/docs/services/glue/schema_versions/index.md new file mode 100644 index 0000000..a3e84e1 --- /dev/null +++ b/website/docs/services/glue/schema_versions/index.md @@ -0,0 +1,202 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a schema_version resource or lists schema_versions in a region + +## Overview + + + + + + + +
Nameschema_versions
TypeResource
DescriptionThis resource represents an individual schema version of a schema defined in Glue Schema Registry.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectIdentifier for the schema where the schema version will be created.
stringComplete definition of the schema in plain-text.
stringRepresents the version ID associated with the schema version.
stringAWS region.
+ +For more information, see AWS::Glue::SchemaVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all schema_versions in a region. +```sql +SELECT +region, +schema, +schema_definition, +version_id +FROM aws.glue.schema_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual schema_version. +```sql +SELECT +region, +schema, +schema_definition, +version_id +FROM aws.glue.schema_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new schema_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.glue.schema_versions ( + Schema, + SchemaDefinition, + region +) +SELECT +'{{ Schema }}', + '{{ SchemaDefinition }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.glue.schema_versions ( + Schema, + SchemaDefinition, + region +) +SELECT + '{{ Schema }}', + '{{ SchemaDefinition }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: schema_version + props: + - name: Schema + value: + SchemaArn: '{{ SchemaArn }}' + SchemaName: '{{ SchemaName }}' + RegistryName: '{{ RegistryName }}' + - name: SchemaDefinition + value: '{{ SchemaDefinition }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.glue.schema_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +glue:GetSchemaVersion +``` + +### Delete +```json +glue:DeleteSchemaVersions, +glue:GetSchemaVersion +``` + +### List +```json +glue:ListSchemaVersions +``` diff --git a/website/docs/services/glue/schema_versions_list_only/index.md b/website/docs/services/glue/schema_versions_list_only/index.md new file mode 100644 index 0000000..75a7608 --- /dev/null +++ b/website/docs/services/glue/schema_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: schema_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schema_versions_list_only + - glue + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schema_versions in a region or regions, for all properties use schema_versions + +## Overview + + + + + + + +
Nameschema_versions_list_only
TypeResource
DescriptionThis resource represents an individual schema version of a schema defined in Glue Schema Registry.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringRepresents the version ID associated with the schema version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schema_versions in a region. +```sql +SELECT +region, +version_id +FROM aws.glue.schema_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schema_versions_list_only resource, see schema_versions + diff --git a/website/docs/services/glue/trigger_tags/index.md b/website/docs/services/glue/trigger_tags/index.md new file mode 100644 index 0000000..8c09fc9 --- /dev/null +++ b/website/docs/services/glue/trigger_tags/index.md @@ -0,0 +1,93 @@ +--- +title: trigger_tags +hide_title: false +hide_table_of_contents: false +keywords: + - trigger_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for triggers in a region + +## Overview + + + + + + + +
Nametrigger_tags
TypeResource
DescriptionResource Type definition for AWS::Glue::Trigger
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of trigger that this is.
booleanSet to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.
stringA description of this trigger.
arrayThe actions initiated by this trigger.
objectBatch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
stringThe name of the workflow associated with the trigger.
stringA cron expression used to specify the schedule.
stringThe name of the trigger.
objectThe predicate of this trigger, which defines when it will fire.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all triggers in a region. +```sql +SELECT +region, +type, +start_on_creation, +description, +actions, +event_batching_condition, +workflow_name, +schedule, +name, +predicate, +tag_key, +tag_value +FROM aws.glue.trigger_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trigger_tags resource, see triggers + diff --git a/website/docs/services/glue/triggers/index.md b/website/docs/services/glue/triggers/index.md new file mode 100644 index 0000000..c154978 --- /dev/null +++ b/website/docs/services/glue/triggers/index.md @@ -0,0 +1,281 @@ +--- +title: triggers +hide_title: false +hide_table_of_contents: false +keywords: + - triggers + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a trigger resource or lists triggers in a region + +## Overview + + + + + + + +
Nametriggers
TypeResource
DescriptionResource Type definition for AWS::Glue::Trigger
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of trigger that this is.
booleanSet to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.
stringA description of this trigger.
arrayThe actions initiated by this trigger.
objectBatch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
stringThe name of the workflow associated with the trigger.
stringA cron expression used to specify the schedule.
objectThe tags to use with this trigger.
stringThe name of the trigger.
objectThe predicate of this trigger, which defines when it will fire.
stringAWS region.
+ +For more information, see AWS::Glue::Trigger. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all triggers in a region. +```sql +SELECT +region, +type, +start_on_creation, +description, +actions, +event_batching_condition, +workflow_name, +schedule, +tags, +name, +predicate +FROM aws.glue.triggers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual trigger. +```sql +SELECT +region, +type, +start_on_creation, +description, +actions, +event_batching_condition, +workflow_name, +schedule, +tags, +name, +predicate +FROM aws.glue.triggers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new trigger resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.glue.triggers ( + Type, + Actions, + region +) +SELECT +'{{ Type }}', + '{{ Actions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.glue.triggers ( + Type, + StartOnCreation, + Description, + Actions, + EventBatchingCondition, + WorkflowName, + Schedule, + Tags, + Name, + Predicate, + region +) +SELECT + '{{ Type }}', + '{{ StartOnCreation }}', + '{{ Description }}', + '{{ Actions }}', + '{{ EventBatchingCondition }}', + '{{ WorkflowName }}', + '{{ Schedule }}', + '{{ Tags }}', + '{{ Name }}', + '{{ Predicate }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: trigger + props: + - name: Type + value: '{{ Type }}' + - name: StartOnCreation + value: '{{ StartOnCreation }}' + - name: Description + value: '{{ Description }}' + - name: Actions + value: + - NotificationProperty: + NotifyDelayAfter: '{{ NotifyDelayAfter }}' + CrawlerName: '{{ CrawlerName }}' + Timeout: '{{ Timeout }}' + JobName: '{{ JobName }}' + Arguments: {} + SecurityConfiguration: '{{ SecurityConfiguration }}' + - name: EventBatchingCondition + value: + BatchSize: '{{ BatchSize }}' + BatchWindow: '{{ BatchWindow }}' + - name: WorkflowName + value: '{{ WorkflowName }}' + - name: Schedule + value: '{{ Schedule }}' + - name: Tags + value: {} + - name: Name + value: '{{ Name }}' + - name: Predicate + value: + Logical: '{{ Logical }}' + Conditions: + - JobName: '{{ JobName }}' + CrawlerName: '{{ CrawlerName }}' + State: '{{ State }}' + CrawlState: '{{ CrawlState }}' + LogicalOperator: '{{ LogicalOperator }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.glue.triggers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the triggers resource, the following permissions are required: + +### Create +```json +glue:CreateTrigger, +glue:GetTrigger, +glue:TagResource +``` + +### Read +```json +glue:GetTrigger, +glue:GetTags +``` + +### Update +```json +glue:UpdateTrigger, +glue:UntagResource, +glue:TagResource +``` + +### Delete +```json +glue:DeleteTrigger, +glue:GetTrigger +``` + +### List +```json +glue:ListTriggers +``` diff --git a/website/docs/services/glue/triggers_list_only/index.md b/website/docs/services/glue/triggers_list_only/index.md new file mode 100644 index 0000000..5f39cc7 --- /dev/null +++ b/website/docs/services/glue/triggers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: triggers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - triggers_list_only + - glue + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists triggers in a region or regions, for all properties use triggers + +## Overview + + + + + + + +
Nametriggers_list_only
TypeResource
DescriptionResource Type definition for AWS::Glue::Trigger
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the trigger.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all triggers in a region. +```sql +SELECT +region, +name +FROM aws.glue.triggers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the triggers_list_only resource, see triggers + diff --git a/website/docs/services/glue/usage_profile_tags/index.md b/website/docs/services/glue/usage_profile_tags/index.md new file mode 100644 index 0000000..833d592 --- /dev/null +++ b/website/docs/services/glue/usage_profile_tags/index.md @@ -0,0 +1,83 @@ +--- +title: usage_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - usage_profile_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for usage_profiles in a region + +## Overview + + + + + + + +
Nameusage_profile_tags
TypeResource
DescriptionThis creates a Resource of UsageProfile type.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the UsageProfile.
stringThe description of the UsageProfile.
undefinedUsageProfile configuration for supported service ex: (Jobs, Sessions).
stringCreation time.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all usage_profiles in a region. +```sql +SELECT +region, +name, +description, +configuration, +created_on, +tag_key, +tag_value +FROM aws.glue.usage_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the usage_profile_tags resource, see usage_profiles + diff --git a/website/docs/services/glue/usage_profiles/index.md b/website/docs/services/glue/usage_profiles/index.md new file mode 100644 index 0000000..04b864f --- /dev/null +++ b/website/docs/services/glue/usage_profiles/index.md @@ -0,0 +1,229 @@ +--- +title: usage_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - usage_profiles + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an usage_profile resource or lists usage_profiles in a region + +## Overview + + + + + + + +
Nameusage_profiles
TypeResource
DescriptionThis creates a Resource of UsageProfile type.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the UsageProfile.
stringThe description of the UsageProfile.
undefinedUsageProfile configuration for supported service ex: (Jobs, Sessions).
arrayThe tags to be applied to this UsageProfiles.
stringCreation time.
stringAWS region.
+ +For more information, see AWS::Glue::UsageProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all usage_profiles in a region. +```sql +SELECT +region, +name, +description, +configuration, +tags, +created_on +FROM aws.glue.usage_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual usage_profile. +```sql +SELECT +region, +name, +description, +configuration, +tags, +created_on +FROM aws.glue.usage_profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new usage_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.glue.usage_profiles ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.glue.usage_profiles ( + Name, + Description, + Configuration, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Configuration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: usage_profile + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Configuration + value: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.glue.usage_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the usage_profiles resource, the following permissions are required: + +### Create +```json +glue:CreateUsageProfile, +glue:GetUsageProfile, +glue:GetTags, +glue:TagResource +``` + +### Read +```json +glue:GetUsageProfile, +glue:GetTags +``` + +### Update +```json +glue:UpdateUsageProfile, +glue:GetUsageProfile, +glue:TagResource, +glue:UntagResource, +glue:GetTags +``` + +### Delete +```json +glue:DeleteUsageProfile, +glue:GetUsageProfile +``` + +### List +```json +glue:ListUsageProfiles +``` diff --git a/website/docs/services/glue/usage_profiles_list_only/index.md b/website/docs/services/glue/usage_profiles_list_only/index.md new file mode 100644 index 0000000..1ee266b --- /dev/null +++ b/website/docs/services/glue/usage_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: usage_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - usage_profiles_list_only + - glue + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists usage_profiles in a region or regions, for all properties use usage_profiles + +## Overview + + + + + + + +
Nameusage_profiles_list_only
TypeResource
DescriptionThis creates a Resource of UsageProfile type.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the UsageProfile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all usage_profiles in a region. +```sql +SELECT +region, +name +FROM aws.glue.usage_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the usage_profiles_list_only resource, see usage_profiles + diff --git a/website/docs/services/grafana/index.md b/website/docs/services/grafana/index.md new file mode 100644 index 0000000..87bbcdb --- /dev/null +++ b/website/docs/services/grafana/index.md @@ -0,0 +1,37 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The grafana service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/grafana/workspaces/index.md b/website/docs/services/grafana/workspaces/index.md new file mode 100644 index 0000000..755999b --- /dev/null +++ b/website/docs/services/grafana/workspaces/index.md @@ -0,0 +1,401 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a workspace resource or lists workspaces in a region + +## Overview + + + + + + + +
Nameworkspaces
TypeResource
DescriptionDefinition of AWS::Grafana::Workspace Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayList of authentication providers to enable.
stringThe client ID of the AWS SSO Managed Application.
objectSAML configuration data associated with an AMG workspace.
objectThe configuration settings for Network Access Control.
objectThe configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
stringValid SAML configuration statuses.
stringA unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
stringThese enums represent the status of a workspace.
stringTimestamp when the workspace was created.
stringTimestamp when the workspace was last modified
stringThe version of Grafana to support in your workspace.
stringEndpoint for the Grafana workspace.
stringThese enums represent valid account access types. Specifically these enums determine whether the workspace can access AWS resources in the AWS account only, or whether it can also access resources in other accounts in the same organization. If the value CURRENT_ACCOUNT is used, a workspace role ARN must be provided. If the value is ORGANIZATION, a list of organizational units must be provided.
stringThe name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
stringThese enums represent valid permission types to use when creating or configuring a Grafana workspace. The SERVICE_MANAGED permission type means the Managed Grafana service will create a workspace IAM role on your behalf. The CUSTOMER_MANAGED permission type means that the customer is expected to provide an IAM role that the Grafana workspace can use to query data sources.
stringThe name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
arrayList of data sources on the service managed IAM role.
stringDescription of a workspace.
stringThe id that uniquely identifies a Grafana workspace.
stringThe user friendly name of a workspace.
arrayList of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
arrayList of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
stringIAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
booleanAllow workspace admins to install plugins
stringAWS region.
+ +For more information, see AWS::Grafana::Workspace. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all workspaces in a region. +```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.workspaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual workspace. +```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.workspaces +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workspace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.grafana.workspaces ( + AuthenticationProviders, + AccountAccessType, + PermissionType, + region +) +SELECT +'{{ AuthenticationProviders }}', + '{{ AccountAccessType }}', + '{{ PermissionType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.grafana.workspaces ( + AuthenticationProviders, + SamlConfiguration, + NetworkAccessControl, + VpcConfiguration, + ClientToken, + GrafanaVersion, + AccountAccessType, + OrganizationRoleName, + PermissionType, + StackSetName, + DataSources, + Description, + Name, + NotificationDestinations, + OrganizationalUnits, + RoleArn, + PluginAdminEnabled, + region +) +SELECT + '{{ AuthenticationProviders }}', + '{{ SamlConfiguration }}', + '{{ NetworkAccessControl }}', + '{{ VpcConfiguration }}', + '{{ ClientToken }}', + '{{ GrafanaVersion }}', + '{{ AccountAccessType }}', + '{{ OrganizationRoleName }}', + '{{ PermissionType }}', + '{{ StackSetName }}', + '{{ DataSources }}', + '{{ Description }}', + '{{ Name }}', + '{{ NotificationDestinations }}', + '{{ OrganizationalUnits }}', + '{{ RoleArn }}', + '{{ PluginAdminEnabled }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: workspace + props: + - name: AuthenticationProviders + value: + - '{{ AuthenticationProviders[0] }}' + - name: SamlConfiguration + value: + IdpMetadata: + Url: '{{ Url }}' + Xml: '{{ Xml }}' + AssertionAttributes: + Name: '{{ Name }}' + Login: '{{ Login }}' + Email: '{{ Email }}' + Groups: '{{ Groups }}' + Role: '{{ Role }}' + Org: '{{ Org }}' + RoleValues: + Editor: + - '{{ Editor[0] }}' + Admin: + - '{{ Admin[0] }}' + AllowedOrganizations: + - '{{ AllowedOrganizations[0] }}' + LoginValidityDuration: null + - name: NetworkAccessControl + value: + PrefixListIds: + - '{{ PrefixListIds[0] }}' + VpceIds: + - '{{ VpceIds[0] }}' + - name: VpcConfiguration + value: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: ClientToken + value: '{{ ClientToken }}' + - name: GrafanaVersion + value: '{{ GrafanaVersion }}' + - name: AccountAccessType + value: '{{ AccountAccessType }}' + - name: OrganizationRoleName + value: '{{ OrganizationRoleName }}' + - name: PermissionType + value: '{{ PermissionType }}' + - name: StackSetName + value: '{{ StackSetName }}' + - name: DataSources + value: + - '{{ DataSources[0] }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: NotificationDestinations + value: + - '{{ NotificationDestinations[0] }}' + - name: OrganizationalUnits + value: + - '{{ OrganizationalUnits[0] }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: PluginAdminEnabled + value: '{{ PluginAdminEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.grafana.workspaces +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +grafana:ListWorkspaces, +grafana:DescribeWorkspaceAuthentication, +grafana:DescribeWorkspaceConfiguration +``` diff --git a/website/docs/services/grafana/workspaces_list_only/index.md b/website/docs/services/grafana/workspaces_list_only/index.md new file mode 100644 index 0000000..63769ea --- /dev/null +++ b/website/docs/services/grafana/workspaces_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: workspaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces_list_only + - grafana + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workspaces in a region or regions, for all properties use workspaces + +## Overview + + + + + + + +
Nameworkspaces_list_only
TypeResource
DescriptionDefinition of AWS::Grafana::Workspace Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe id that uniquely identifies a Grafana workspace.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workspaces in a region. +```sql +SELECT +region, +id +FROM aws.grafana.workspaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspaces_list_only resource, see workspaces + diff --git a/website/docs/services/greengrassv2/component_version_tags/index.md b/website/docs/services/greengrassv2/component_version_tags/index.md new file mode 100644 index 0000000..81e4304 --- /dev/null +++ b/website/docs/services/greengrassv2/component_version_tags/index.md @@ -0,0 +1,85 @@ +--- +title: component_version_tags +hide_title: false +hide_table_of_contents: false +keywords: + - component_version_tags + - greengrassv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for component_versions in a region + +## Overview + + + + + + + +
Namecomponent_version_tags
TypeResource
DescriptionResource for Greengrass component version.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all component_versions in a region. +```sql +SELECT +region, +arn, +component_name, +component_version, +inline_recipe, +lambda_function, +tag_key, +tag_value +FROM aws.greengrassv2.component_version_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_version_tags resource, see component_versions + diff --git a/website/docs/services/greengrassv2/component_versions/index.md b/website/docs/services/greengrassv2/component_versions/index.md new file mode 100644 index 0000000..b01e90a --- /dev/null +++ b/website/docs/services/greengrassv2/component_versions/index.md @@ -0,0 +1,265 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a component_version resource or lists component_versions in a region + +## Overview + + + + + + + +
Namecomponent_versions
TypeResource
DescriptionResource for Greengrass component version.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
stringAWS region.
+ +For more information, see AWS::GreengrassV2::ComponentVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all component_versions in a region. +```sql +SELECT +region, +arn, +component_name, +component_version, +inline_recipe, +lambda_function, +tags +FROM aws.greengrassv2.component_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual component_version. +```sql +SELECT +region, +arn, +component_name, +component_version, +inline_recipe, +lambda_function, +tags +FROM aws.greengrassv2.component_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new component_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.greengrassv2.component_versions ( + InlineRecipe, + LambdaFunction, + Tags, + region +) +SELECT +'{{ InlineRecipe }}', + '{{ LambdaFunction }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.greengrassv2.component_versions ( + InlineRecipe, + LambdaFunction, + Tags, + region +) +SELECT + '{{ InlineRecipe }}', + '{{ LambdaFunction }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: component_version + props: + - name: InlineRecipe + value: '{{ InlineRecipe }}' + - name: LambdaFunction + value: + LambdaArn: '{{ LambdaArn }}' + ComponentName: '{{ ComponentName }}' + ComponentVersion: '{{ ComponentVersion }}' + ComponentPlatforms: + - Name: '{{ Name }}' + Attributes: {} + ComponentDependencies: {} + ComponentLambdaParameters: + EventSources: + - Topic: '{{ Topic }}' + Type: '{{ Type }}' + MaxQueueSize: '{{ MaxQueueSize }}' + MaxInstancesCount: '{{ MaxInstancesCount }}' + MaxIdleTimeInSeconds: '{{ MaxIdleTimeInSeconds }}' + TimeoutInSeconds: '{{ TimeoutInSeconds }}' + StatusTimeoutInSeconds: '{{ StatusTimeoutInSeconds }}' + Pinned: '{{ Pinned }}' + InputPayloadEncodingType: '{{ InputPayloadEncodingType }}' + ExecArgs: + - '{{ ExecArgs[0] }}' + EnvironmentVariables: {} + LinuxProcessParams: + IsolationMode: '{{ IsolationMode }}' + ContainerParams: + MemorySizeInKB: '{{ MemorySizeInKB }}' + MountROSysfs: '{{ MountROSysfs }}' + Volumes: + - SourcePath: '{{ SourcePath }}' + DestinationPath: null + Permission: '{{ Permission }}' + AddGroupOwner: '{{ AddGroupOwner }}' + Devices: + - Path: null + Permission: null + AddGroupOwner: null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.greengrassv2.component_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +greengrass:DescribeComponent, +greengrass:ListTagsForResource +``` + +### Update +```json +greengrass:DescribeComponent, +greengrass:ListTagsForResource, +greengrass:TagResource, +greengrass:UntagResource +``` + +### Delete +```json +greengrass:DeleteComponent +``` + +### List +```json +greengrass:ListComponentVersions +``` diff --git a/website/docs/services/greengrassv2/component_versions_list_only/index.md b/website/docs/services/greengrassv2/component_versions_list_only/index.md new file mode 100644 index 0000000..5b903c1 --- /dev/null +++ b/website/docs/services/greengrassv2/component_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: component_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - component_versions_list_only + - greengrassv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists component_versions in a region or regions, for all properties use component_versions + +## Overview + + + + + + + +
Namecomponent_versions_list_only
TypeResource
DescriptionResource for Greengrass component version.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all component_versions in a region. +```sql +SELECT +region, +arn +FROM aws.greengrassv2.component_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_versions_list_only resource, see component_versions + diff --git a/website/docs/services/greengrassv2/deployment_tags/index.md b/website/docs/services/greengrassv2/deployment_tags/index.md new file mode 100644 index 0000000..a1b380f --- /dev/null +++ b/website/docs/services/greengrassv2/deployment_tags/index.md @@ -0,0 +1,89 @@ +--- +title: deployment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_tags + - greengrassv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for deployments in a region + +## Overview + + + + + + + +
Namedeployment_tags
TypeResource
DescriptionResource for Greengrass V2 deployment.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all deployments in a region. +```sql +SELECT +region, +target_arn, +parent_target_arn, +deployment_id, +deployment_name, +components, +iot_job_configuration, +deployment_policies, +tag_key, +tag_value +FROM aws.greengrassv2.deployment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployment_tags resource, see deployments + diff --git a/website/docs/services/greengrassv2/deployments/index.md b/website/docs/services/greengrassv2/deployments/index.md new file mode 100644 index 0000000..b706ba4 --- /dev/null +++ b/website/docs/services/greengrassv2/deployments/index.md @@ -0,0 +1,285 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a deployment resource or lists deployments in a region + +## Overview + + + + + + + +
Namedeployments
TypeResource
DescriptionResource for Greengrass V2 deployment.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
object
object
stringAWS region.
+ +For more information, see AWS::GreengrassV2::Deployment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all deployments in a region. +```sql +SELECT +region, +target_arn, +parent_target_arn, +deployment_id, +deployment_name, +components, +iot_job_configuration, +deployment_policies, +tags +FROM aws.greengrassv2.deployments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual deployment. +```sql +SELECT +region, +target_arn, +parent_target_arn, +deployment_id, +deployment_name, +components, +iot_job_configuration, +deployment_policies, +tags +FROM aws.greengrassv2.deployments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new deployment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.greengrassv2.deployments ( + TargetArn, + region +) +SELECT +'{{ TargetArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.greengrassv2.deployments ( + TargetArn, + ParentTargetArn, + DeploymentName, + Components, + IotJobConfiguration, + DeploymentPolicies, + Tags, + region +) +SELECT + '{{ TargetArn }}', + '{{ ParentTargetArn }}', + '{{ DeploymentName }}', + '{{ Components }}', + '{{ IotJobConfiguration }}', + '{{ DeploymentPolicies }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: deployment + props: + - name: TargetArn + value: '{{ TargetArn }}' + - name: ParentTargetArn + value: '{{ ParentTargetArn }}' + - name: DeploymentName + value: '{{ DeploymentName }}' + - name: Components + value: {} + - name: IotJobConfiguration + value: + JobExecutionsRolloutConfig: + ExponentialRate: + BaseRatePerMinute: '{{ BaseRatePerMinute }}' + IncrementFactor: null + RateIncreaseCriteria: {} + MaximumPerMinute: '{{ MaximumPerMinute }}' + AbortConfig: + CriteriaList: + - FailureType: '{{ FailureType }}' + Action: '{{ Action }}' + ThresholdPercentage: null + MinNumberOfExecutedThings: '{{ MinNumberOfExecutedThings }}' + TimeoutConfig: + InProgressTimeoutInMinutes: '{{ InProgressTimeoutInMinutes }}' + - name: DeploymentPolicies + value: + FailureHandlingPolicy: '{{ FailureHandlingPolicy }}' + ComponentUpdatePolicy: + TimeoutInSeconds: '{{ TimeoutInSeconds }}' + Action: '{{ Action }}' + ConfigurationValidationPolicy: + TimeoutInSeconds: '{{ TimeoutInSeconds }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.greengrassv2.deployments +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +greengrass:ListDeployments, +iot:DescribeJob, +iot:DescribeThing, +iot:DescribeThingGroup, +iot:GetThingShadow +``` diff --git a/website/docs/services/greengrassv2/deployments_list_only/index.md b/website/docs/services/greengrassv2/deployments_list_only/index.md new file mode 100644 index 0000000..8174234 --- /dev/null +++ b/website/docs/services/greengrassv2/deployments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: deployments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployments in a region or regions, for all properties use deployments + +## Overview + + + + + + + +
Namedeployments_list_only
TypeResource
DescriptionResource for Greengrass V2 deployment.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployments in a region. +```sql +SELECT +region, +deployment_id +FROM aws.greengrassv2.deployments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployments_list_only resource, see deployments + diff --git a/website/docs/services/greengrassv2/index.md b/website/docs/services/greengrassv2/index.md new file mode 100644 index 0000000..6ca30f1 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The greengrassv2 service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/groundstation/config_tags/index.md b/website/docs/services/groundstation/config_tags/index.md new file mode 100644 index 0000000..28408f9 --- /dev/null +++ b/website/docs/services/groundstation/config_tags/index.md @@ -0,0 +1,85 @@ +--- +title: config_tags +hide_title: false +hide_table_of_contents: false +keywords: + - config_tags + - groundstation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configs in a region + +## Overview + + + + + + + +
Nameconfig_tags
TypeResource
DescriptionAWS Ground Station config resource type for CloudFormation.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configs in a region. +```sql +SELECT +region, +name, +type, +config_data, +arn, +id, +tag_key, +tag_value +FROM aws.groundstation.config_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the config_tags resource, see configs + diff --git a/website/docs/services/groundstation/configs/index.md b/website/docs/services/groundstation/configs/index.md new file mode 100644 index 0000000..b42242a --- /dev/null +++ b/website/docs/services/groundstation/configs/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a config resource or lists configs in a region + +## Overview + + + + + + + +
Nameconfigs
TypeResource
DescriptionAWS Ground Station config resource type for CloudFormation.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
array
string
object
string
string
stringAWS region.
+ +For more information, see AWS::GroundStation::Config. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configs in a region. +```sql +SELECT +region, +name, +tags, +type, +config_data, +arn, +id +FROM aws.groundstation.configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual config. +```sql +SELECT +region, +name, +tags, +type, +config_data, +arn, +id +FROM aws.groundstation.configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.groundstation.configs ( + Name, + ConfigData, + region +) +SELECT +'{{ Name }}', + '{{ ConfigData }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.groundstation.configs ( + Name, + Tags, + ConfigData, + region +) +SELECT + '{{ Name }}', + '{{ Tags }}', + '{{ ConfigData }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: config + props: + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ConfigData + value: + AntennaDownlinkConfig: + SpectrumConfig: + CenterFrequency: + Value: null + Units: '{{ Units }}' + Bandwidth: + Value: null + Units: '{{ Units }}' + Polarization: '{{ Polarization }}' + TrackingConfig: + Autotrack: '{{ Autotrack }}' + DataflowEndpointConfig: + DataflowEndpointName: '{{ DataflowEndpointName }}' + DataflowEndpointRegion: '{{ DataflowEndpointRegion }}' + AntennaDownlinkDemodDecodeConfig: + SpectrumConfig: null + DemodulationConfig: + UnvalidatedJSON: '{{ UnvalidatedJSON }}' + DecodeConfig: + UnvalidatedJSON: null + AntennaUplinkConfig: + SpectrumConfig: + CenterFrequency: null + Polarization: null + TargetEirp: + Value: null + Units: '{{ Units }}' + TransmitDisabled: '{{ TransmitDisabled }}' + UplinkEchoConfig: + Enabled: '{{ Enabled }}' + AntennaUplinkConfigArn: '{{ AntennaUplinkConfigArn }}' + S3RecordingConfig: + BucketArn: '{{ BucketArn }}' + RoleArn: '{{ RoleArn }}' + Prefix: '{{ Prefix }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.groundstation.configs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the configs resource, the following permissions are required: + +### Create +```json +groundstation:CreateConfig, +groundstation:TagResource, +iam:PassRole +``` + +### Read +```json +groundstation:GetConfig, +groundstation:ListTagsForResource +``` + +### Update +```json +groundstation:UpdateConfig, +groundstation:ListTagsForResource, +groundstation:TagResource, +groundstation:UntagResource, +iam:PassRole +``` + +### Delete +```json +groundstation:DeleteConfig +``` + +### List +```json +groundstation:ListConfigs +``` diff --git a/website/docs/services/groundstation/configs_list_only/index.md b/website/docs/services/groundstation/configs_list_only/index.md new file mode 100644 index 0000000..9b2b650 --- /dev/null +++ b/website/docs/services/groundstation/configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configs_list_only + - groundstation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configs in a region or regions, for all properties use configs + +## Overview + + + + + + + +
Nameconfigs_list_only
TypeResource
DescriptionAWS Ground Station config resource type for CloudFormation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configs in a region. +```sql +SELECT +region, +arn +FROM aws.groundstation.configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configs_list_only resource, see configs + diff --git a/website/docs/services/groundstation/dataflow_endpoint_group_tags/index.md b/website/docs/services/groundstation/dataflow_endpoint_group_tags/index.md new file mode 100644 index 0000000..4ed408b --- /dev/null +++ b/website/docs/services/groundstation/dataflow_endpoint_group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: dataflow_endpoint_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dataflow_endpoint_group_tags + - groundstation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dataflow_endpoint_groups in a region + +## Overview + + + + + + + +
Namedataflow_endpoint_group_tags
TypeResource
DescriptionAWS Ground Station DataflowEndpointGroup schema for CloudFormation
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
integerAmount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
integerAmount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dataflow_endpoint_groups in a region. +```sql +SELECT +region, +id, +arn, +endpoint_details, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +tag_key, +tag_value +FROM aws.groundstation.dataflow_endpoint_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataflow_endpoint_group_tags resource, see dataflow_endpoint_groups + diff --git a/website/docs/services/groundstation/dataflow_endpoint_groups/index.md b/website/docs/services/groundstation/dataflow_endpoint_groups/index.md new file mode 100644 index 0000000..6cbcfe0 --- /dev/null +++ b/website/docs/services/groundstation/dataflow_endpoint_groups/index.md @@ -0,0 +1,259 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dataflow_endpoint_group resource or lists dataflow_endpoint_groups in a region + +## Overview + + + + + + + +
Namedataflow_endpoint_groups
TypeResource
DescriptionAWS Ground Station DataflowEndpointGroup schema for CloudFormation
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
array
integerAmount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
integerAmount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
array
stringAWS region.
+ +For more information, see AWS::GroundStation::DataflowEndpointGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dataflow_endpoint_groups in a region. +```sql +SELECT +region, +id, +arn, +endpoint_details, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +tags +FROM aws.groundstation.dataflow_endpoint_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dataflow_endpoint_group. +```sql +SELECT +region, +id, +arn, +endpoint_details, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +tags +FROM aws.groundstation.dataflow_endpoint_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dataflow_endpoint_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.groundstation.dataflow_endpoint_groups ( + EndpointDetails, + region +) +SELECT +'{{ EndpointDetails }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.groundstation.dataflow_endpoint_groups ( + EndpointDetails, + ContactPrePassDurationSeconds, + ContactPostPassDurationSeconds, + Tags, + region +) +SELECT + '{{ EndpointDetails }}', + '{{ ContactPrePassDurationSeconds }}', + '{{ ContactPostPassDurationSeconds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dataflow_endpoint_group + props: + - name: EndpointDetails + value: + - SecurityDetails: + SubnetIds: + - '{{ SubnetIds[0] }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + RoleArn: '{{ RoleArn }}' + Endpoint: + Name: '{{ Name }}' + Address: + Name: '{{ Name }}' + Port: '{{ Port }}' + Mtu: '{{ Mtu }}' + AwsGroundStationAgentEndpoint: + Name: '{{ Name }}' + EgressAddress: + SocketAddress: null + Mtu: '{{ Mtu }}' + IngressAddress: + SocketAddress: + Name: '{{ Name }}' + PortRange: + Minimum: '{{ Minimum }}' + Maximum: '{{ Maximum }}' + Mtu: '{{ Mtu }}' + AgentStatus: '{{ AgentStatus }}' + AuditResults: '{{ AuditResults }}' + - name: ContactPrePassDurationSeconds + value: '{{ ContactPrePassDurationSeconds }}' + - name: ContactPostPassDurationSeconds + value: '{{ ContactPostPassDurationSeconds }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.groundstation.dataflow_endpoint_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +groundstation:ListTagsForResource, +groundstation:TagResource, +groundstation:UntagResource +``` + +### Read +```json +groundstation:GetDataflowEndpointGroup, +groundstation:ListTagsForResource +``` + +### Delete +```json +groundstation:DeleteDataflowEndpointGroup, +groundstation:GetDataflowEndpointGroup +``` + +### List +```json +groundstation:ListDataflowEndpointGroups +``` diff --git a/website/docs/services/groundstation/dataflow_endpoint_groups_list_only/index.md b/website/docs/services/groundstation/dataflow_endpoint_groups_list_only/index.md new file mode 100644 index 0000000..e101771 --- /dev/null +++ b/website/docs/services/groundstation/dataflow_endpoint_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dataflow_endpoint_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dataflow_endpoint_groups_list_only + - groundstation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dataflow_endpoint_groups in a region or regions, for all properties use dataflow_endpoint_groups + +## Overview + + + + + + + +
Namedataflow_endpoint_groups_list_only
TypeResource
DescriptionAWS Ground Station DataflowEndpointGroup schema for CloudFormation
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dataflow_endpoint_groups in a region. +```sql +SELECT +region, +id +FROM aws.groundstation.dataflow_endpoint_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataflow_endpoint_groups_list_only resource, see dataflow_endpoint_groups + diff --git a/website/docs/services/groundstation/index.md b/website/docs/services/groundstation/index.md new file mode 100644 index 0000000..eda9486 --- /dev/null +++ b/website/docs/services/groundstation/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The groundstation service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/groundstation/mission_profile_tags/index.md b/website/docs/services/groundstation/mission_profile_tags/index.md new file mode 100644 index 0000000..e913c39 --- /dev/null +++ b/website/docs/services/groundstation/mission_profile_tags/index.md @@ -0,0 +1,97 @@ +--- +title: mission_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mission_profile_tags + - groundstation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mission_profiles in a region + +## Overview + + + + + + + +
Namemission_profile_tags
TypeResource
DescriptionAWS Ground Station Mission Profile resource type for CloudFormation.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA name used to identify a mission profile.
integerPre-pass time needed before the contact.
integerPost-pass time needed after the contact.
integerVisibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts.
objectThe ARN of a KMS Key used for encrypting data during transmission from the source to destination locations.
stringThe ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage.
array
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mission_profiles in a region. +```sql +SELECT +region, +name, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +minimum_viable_contact_duration_seconds, +streams_kms_key, +streams_kms_role, +dataflow_edges, +tracking_config_arn, +id, +arn, +region, +tag_key, +tag_value +FROM aws.groundstation.mission_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mission_profile_tags resource, see mission_profiles + diff --git a/website/docs/services/groundstation/mission_profiles/index.md b/website/docs/services/groundstation/mission_profiles/index.md new file mode 100644 index 0000000..8f4722a --- /dev/null +++ b/website/docs/services/groundstation/mission_profiles/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mission_profile resource or lists mission_profiles in a region + +## Overview + + + + + + + +
Namemission_profiles
TypeResource
DescriptionAWS Ground Station Mission Profile resource type for CloudFormation.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA name used to identify a mission profile.
integerPre-pass time needed before the contact.
integerPost-pass time needed after the contact.
integerVisibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts.
objectThe ARN of a KMS Key used for encrypting data during transmission from the source to destination locations.
stringThe ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage.
array
string
array
string
string
string
stringAWS region.
+ +For more information, see AWS::GroundStation::MissionProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mission_profiles in a region. +```sql +SELECT +region, +name, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +minimum_viable_contact_duration_seconds, +streams_kms_key, +streams_kms_role, +dataflow_edges, +tracking_config_arn, +tags, +id, +arn, +region +FROM aws.groundstation.mission_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mission_profile. +```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_profiles +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mission_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.groundstation.mission_profiles ( + Name, + MinimumViableContactDurationSeconds, + DataflowEdges, + TrackingConfigArn, + region +) +SELECT +'{{ Name }}', + '{{ MinimumViableContactDurationSeconds }}', + '{{ DataflowEdges }}', + '{{ TrackingConfigArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.groundstation.mission_profiles ( + Name, + ContactPrePassDurationSeconds, + ContactPostPassDurationSeconds, + MinimumViableContactDurationSeconds, + StreamsKmsKey, + StreamsKmsRole, + DataflowEdges, + TrackingConfigArn, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ ContactPrePassDurationSeconds }}', + '{{ ContactPostPassDurationSeconds }}', + '{{ MinimumViableContactDurationSeconds }}', + '{{ StreamsKmsKey }}', + '{{ StreamsKmsRole }}', + '{{ DataflowEdges }}', + '{{ TrackingConfigArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mission_profile + props: + - name: Name + value: '{{ Name }}' + - name: ContactPrePassDurationSeconds + value: '{{ ContactPrePassDurationSeconds }}' + - name: ContactPostPassDurationSeconds + value: '{{ ContactPostPassDurationSeconds }}' + - name: MinimumViableContactDurationSeconds + value: '{{ MinimumViableContactDurationSeconds }}' + - name: StreamsKmsKey + value: + KmsKeyArn: '{{ KmsKeyArn }}' + KmsAliasArn: '{{ KmsAliasArn }}' + - name: StreamsKmsRole + value: '{{ StreamsKmsRole }}' + - name: DataflowEdges + value: + - Source: '{{ Source }}' + Destination: '{{ Destination }}' + - name: TrackingConfigArn + value: '{{ TrackingConfigArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.groundstation.mission_profiles +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +groundstation:ListMissionProfiles +``` diff --git a/website/docs/services/groundstation/mission_profiles_list_only/index.md b/website/docs/services/groundstation/mission_profiles_list_only/index.md new file mode 100644 index 0000000..0799054 --- /dev/null +++ b/website/docs/services/groundstation/mission_profiles_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: mission_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mission_profiles_list_only + - groundstation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mission_profiles in a region or regions, for all properties use mission_profiles + +## Overview + + + + + + + +
Namemission_profiles_list_only
TypeResource
DescriptionAWS Ground Station Mission Profile resource type for CloudFormation.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mission_profiles in a region. +```sql +SELECT +region, +id, +arn +FROM aws.groundstation.mission_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mission_profiles_list_only resource, see mission_profiles + diff --git a/website/docs/services/guardduty/detector_tags/index.md b/website/docs/services/guardduty/detector_tags/index.md new file mode 100644 index 0000000..75dc391 --- /dev/null +++ b/website/docs/services/guardduty/detector_tags/index.md @@ -0,0 +1,85 @@ +--- +title: detector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - detector_tags + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for detectors in a region + +## Overview + + + + + + + +
Namedetector_tags
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Detector
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
boolean
object
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all detectors in a region. +```sql +SELECT +region, +finding_publishing_frequency, +enable, +data_sources, +features, +id, +tag_key, +tag_value +FROM aws.guardduty.detector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detector_tags resource, see detectors + diff --git a/website/docs/services/guardduty/detectors/index.md b/website/docs/services/guardduty/detectors/index.md new file mode 100644 index 0000000..5f33f38 --- /dev/null +++ b/website/docs/services/guardduty/detectors/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a detector resource or lists detectors in a region + +## Overview + + + + + + + +
Namedetectors
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Detector
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
boolean
object
array
string
array
stringAWS region.
+ +For more information, see AWS::GuardDuty::Detector. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all detectors in a region. +```sql +SELECT +region, +finding_publishing_frequency, +enable, +data_sources, +features, +id, +tags +FROM aws.guardduty.detectors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual detector. +```sql +SELECT +region, +finding_publishing_frequency, +enable, +data_sources, +features, +id, +tags +FROM aws.guardduty.detectors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new detector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.detectors ( + Enable, + region +) +SELECT +'{{ Enable }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.detectors ( + FindingPublishingFrequency, + Enable, + DataSources, + Features, + Tags, + region +) +SELECT + '{{ FindingPublishingFrequency }}', + '{{ Enable }}', + '{{ DataSources }}', + '{{ Features }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: detector + props: + - name: FindingPublishingFrequency + value: '{{ FindingPublishingFrequency }}' + - name: Enable + value: '{{ Enable }}' + - name: DataSources + value: + S3Logs: + Enable: '{{ Enable }}' + Kubernetes: + AuditLogs: + Enable: '{{ Enable }}' + MalwareProtection: + ScanEc2InstanceWithFindings: + EbsVolumes: '{{ EbsVolumes }}' + - name: Features + value: + - Name: '{{ Name }}' + Status: '{{ Status }}' + AdditionalConfiguration: + - Name: '{{ Name }}' + Status: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.guardduty.detectors +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +guardduty:GetDetector, +guardduty:ListTagsForResource +``` + +### Delete +```json +guardduty:ListDetectors, +guardduty:DeleteDetector, +guardduty:GetDetector +``` + +### Update +```json +guardduty:UpdateDetector, +guardduty:GetDetector, +guardduty:ListDetectors, +iam:CreateServiceLinkedRole, +iam:GetRole, +guardduty:TagResource, +guardduty:UntagResource +``` + +### List +```json +guardduty:ListDetectors +``` diff --git a/website/docs/services/guardduty/detectors_list_only/index.md b/website/docs/services/guardduty/detectors_list_only/index.md new file mode 100644 index 0000000..60fda99 --- /dev/null +++ b/website/docs/services/guardduty/detectors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: detectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - detectors_list_only + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists detectors in a region or regions, for all properties use detectors + +## Overview + + + + + + + +
Namedetectors_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Detector
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all detectors in a region. +```sql +SELECT +region, +id +FROM aws.guardduty.detectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detectors_list_only resource, see detectors + diff --git a/website/docs/services/guardduty/filter_tags/index.md b/website/docs/services/guardduty/filter_tags/index.md new file mode 100644 index 0000000..5386df1 --- /dev/null +++ b/website/docs/services/guardduty/filter_tags/index.md @@ -0,0 +1,87 @@ +--- +title: filter_tags +hide_title: false +hide_table_of_contents: false +keywords: + - filter_tags + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for filters in a region + +## Overview + + + + + + + +
Namefilter_tags
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Filter
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
integer
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all filters in a region. +```sql +SELECT +region, +action, +description, +detector_id, +finding_criteria, +rank, +name, +tag_key, +tag_value +FROM aws.guardduty.filter_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the filter_tags resource, see filters + diff --git a/website/docs/services/guardduty/filters/index.md b/website/docs/services/guardduty/filters/index.md new file mode 100644 index 0000000..29f7176 --- /dev/null +++ b/website/docs/services/guardduty/filters/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a filter resource or lists filters in a region + +## Overview + + + + + + + +
Namefilters
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Filter
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
integer
string
array
stringAWS region.
+ +For more information, see AWS::GuardDuty::Filter. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all filters in a region. +```sql +SELECT +region, +action, +description, +detector_id, +finding_criteria, +rank, +name, +tags +FROM aws.guardduty.filters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual filter. +```sql +SELECT +region, +action, +description, +detector_id, +finding_criteria, +rank, +name, +tags +FROM aws.guardduty.filters +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.filters ( + DetectorId, + FindingCriteria, + Name, + region +) +SELECT +'{{ DetectorId }}', + '{{ FindingCriteria }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.filters ( + Action, + Description, + DetectorId, + FindingCriteria, + Rank, + Name, + Tags, + region +) +SELECT + '{{ Action }}', + '{{ Description }}', + '{{ DetectorId }}', + '{{ FindingCriteria }}', + '{{ Rank }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: filter + props: + - name: Action + value: '{{ Action }}' + - name: Description + value: '{{ Description }}' + - name: DetectorId + value: '{{ DetectorId }}' + - name: FindingCriteria + value: + Criterion: {} + - name: Rank + value: '{{ Rank }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.guardduty.filters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the filters resource, the following permissions are required: + +### Create +```json +guardduty:CreateFilter, +guardduty:GetFilter, +guardduty:TagResource +``` + +### Read +```json +guardduty:GetFilter, +guardduty:ListTagsForResource +``` + +### Delete +```json +guardduty:ListDetectors, +guardduty:ListFilters, +guardduty:GetFilter, +guardduty:DeleteFilter +``` + +### Update +```json +guardduty:UpdateFilter, +guardduty:GetFilter, +guardduty:ListFilters, +guardduty:TagResource, +guardduty:UntagResource +``` + +### List +```json +guardduty:ListFilters +``` diff --git a/website/docs/services/guardduty/filters_list_only/index.md b/website/docs/services/guardduty/filters_list_only/index.md new file mode 100644 index 0000000..0bc06a1 --- /dev/null +++ b/website/docs/services/guardduty/filters_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - filters_list_only + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists filters in a region or regions, for all properties use filters + +## Overview + + + + + + + +
Namefilters_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Filter
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all filters in a region. +```sql +SELECT +region, +detector_id, +name +FROM aws.guardduty.filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the filters_list_only resource, see filters + diff --git a/website/docs/services/guardduty/index.md b/website/docs/services/guardduty/index.md new file mode 100644 index 0000000..376bcd3 --- /dev/null +++ b/website/docs/services/guardduty/index.md @@ -0,0 +1,54 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The guardduty service documentation. + +:::info Service Summary + +
+
+total resources: 19
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/guardduty/ip_set_tags/index.md b/website/docs/services/guardduty/ip_set_tags/index.md new file mode 100644 index 0000000..63d0fbc --- /dev/null +++ b/website/docs/services/guardduty/ip_set_tags/index.md @@ -0,0 +1,87 @@ +--- +title: ip_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ip_set_tags + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ip_sets in a region + +## Overview + + + + + + + +
Nameip_set_tags
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::IPSet
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ip_sets in a region. +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tag_key, +tag_value +FROM aws.guardduty.ip_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ip_set_tags resource, see ip_sets + diff --git a/website/docs/services/guardduty/ip_sets/index.md b/website/docs/services/guardduty/ip_sets/index.md new file mode 100644 index 0000000..b40f665 --- /dev/null +++ b/website/docs/services/guardduty/ip_sets/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ip_set resource or lists ip_sets in a region + +## Overview + + + + + + + +
Nameip_sets
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::IPSet
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
string
array
stringAWS region.
+ +For more information, see AWS::GuardDuty::IPSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ip_sets in a region. +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tags +FROM aws.guardduty.ip_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ip_set. +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tags +FROM aws.guardduty.ip_sets +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ip_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.ip_sets ( + Format, + Location, + region +) +SELECT +'{{ Format }}', + '{{ Location }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.ip_sets ( + Format, + Activate, + DetectorId, + Name, + Location, + Tags, + region +) +SELECT + '{{ Format }}', + '{{ Activate }}', + '{{ DetectorId }}', + '{{ Name }}', + '{{ Location }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ip_set + props: + - name: Format + value: '{{ Format }}' + - name: Activate + value: '{{ Activate }}' + - name: DetectorId + value: '{{ DetectorId }}' + - name: Name + value: '{{ Name }}' + - name: Location + value: '{{ Location }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.guardduty.ip_sets +WHERE data__Identifier = '' +AND 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 +``` + +### 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, +guardduty:TagResource, +guardduty:UntagResource +``` + +### List +```json +guardduty:ListIPSets +``` diff --git a/website/docs/services/guardduty/ip_sets_list_only/index.md b/website/docs/services/guardduty/ip_sets_list_only/index.md new file mode 100644 index 0000000..37fd97d --- /dev/null +++ b/website/docs/services/guardduty/ip_sets_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: ip_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ip_sets_list_only + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ip_sets in a region or regions, for all properties use ip_sets + +## Overview + + + + + + + +
Nameip_sets_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::IPSet
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ip_sets in a region. +```sql +SELECT +region, +id, +detector_id +FROM aws.guardduty.ip_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ip_sets_list_only resource, see ip_sets + diff --git a/website/docs/services/guardduty/malware_protection_plan_tags/index.md b/website/docs/services/guardduty/malware_protection_plan_tags/index.md new file mode 100644 index 0000000..c3fcf72 --- /dev/null +++ b/website/docs/services/guardduty/malware_protection_plan_tags/index.md @@ -0,0 +1,91 @@ +--- +title: malware_protection_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - malware_protection_plan_tags + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for malware_protection_plans in a region + +## Overview + + + + + + + +
Namemalware_protection_plan_tags
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::MalwareProtectionPlan
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier associated with Malware Protection plan resource.
stringAmazon Resource Name (ARN) of the protected resource.
stringIAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource.
objectInformation about the protected resource. Presently, S3Bucket is the only supported protected resource.
objectSpecifies the action that is to be applied to the Malware Protection plan resource.
stringThe timestamp when the Malware Protection plan resource was created.
stringStatus of the Malware Protection plan resource.
arrayStatus details associated with the Malware Protection plan resource status.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all malware_protection_plans in a region. +```sql +SELECT +region, +malware_protection_plan_id, +arn, +role, +protected_resource, +actions, +created_at, +status, +status_reasons, +tag_key, +tag_value +FROM aws.guardduty.malware_protection_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the malware_protection_plan_tags resource, see malware_protection_plans + diff --git a/website/docs/services/guardduty/malware_protection_plans/index.md b/website/docs/services/guardduty/malware_protection_plans/index.md new file mode 100644 index 0000000..b36827e --- /dev/null +++ b/website/docs/services/guardduty/malware_protection_plans/index.md @@ -0,0 +1,248 @@ +--- +title: malware_protection_plans +hide_title: false +hide_table_of_contents: false +keywords: + - malware_protection_plans + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a malware_protection_plan resource or lists malware_protection_plans in a region + +## Overview + + + + + + + +
Namemalware_protection_plans
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::MalwareProtectionPlan
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier associated with Malware Protection plan resource.
stringAmazon Resource Name (ARN) of the protected resource.
stringIAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource.
objectInformation about the protected resource. Presently, S3Bucket is the only supported protected resource.
objectSpecifies the action that is to be applied to the Malware Protection plan resource.
stringThe timestamp when the Malware Protection plan resource was created.
stringStatus of the Malware Protection plan resource.
arrayStatus details associated with the Malware Protection plan resource status.
arrayThe tags to be added to the created Malware Protection plan resource. Each tag consists of a key and an optional value, both of which you need to specify.
stringAWS region.
+ +For more information, see AWS::GuardDuty::MalwareProtectionPlan. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all malware_protection_plans in a region. +```sql +SELECT +region, +malware_protection_plan_id, +arn, +role, +protected_resource, +actions, +created_at, +status, +status_reasons, +tags +FROM aws.guardduty.malware_protection_plans +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual malware_protection_plan. +```sql +SELECT +region, +malware_protection_plan_id, +arn, +role, +protected_resource, +actions, +created_at, +status, +status_reasons, +tags +FROM aws.guardduty.malware_protection_plans +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new malware_protection_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.malware_protection_plans ( + Role, + ProtectedResource, + region +) +SELECT +'{{ Role }}', + '{{ ProtectedResource }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.malware_protection_plans ( + Role, + ProtectedResource, + Actions, + Tags, + region +) +SELECT + '{{ Role }}', + '{{ ProtectedResource }}', + '{{ Actions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: malware_protection_plan + props: + - name: Role + value: '{{ Role }}' + - name: ProtectedResource + value: + S3Bucket: + BucketName: '{{ BucketName }}' + ObjectPrefixes: + - '{{ ObjectPrefixes[0] }}' + - name: Actions + value: + Tagging: + Status: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.guardduty.malware_protection_plans +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the malware_protection_plans resource, the following permissions are required: + +### Create +```json +guardduty:CreateMalwareProtectionPlan, +guardduty:GetMalwareProtectionPlan, +guardduty:TagResource, +iam:PassRole +``` + +### Read +```json +guardduty:GetMalwareProtectionPlan +``` + +### Delete +```json +guardduty:DeleteMalwareProtectionPlan, +guardduty:GetMalwareProtectionPlan +``` + +### Update +```json +guardduty:UpdateMalwareProtectionPlan, +guardduty:GetMalwareProtectionPlan, +guardduty:TagResource, +guardduty:UntagResource, +iam:PassRole +``` + +### List +```json +guardduty:ListMalwareProtectionPlans +``` diff --git a/website/docs/services/guardduty/malware_protection_plans_list_only/index.md b/website/docs/services/guardduty/malware_protection_plans_list_only/index.md new file mode 100644 index 0000000..e5a2f5f --- /dev/null +++ b/website/docs/services/guardduty/malware_protection_plans_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: malware_protection_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - malware_protection_plans_list_only + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists malware_protection_plans in a region or regions, for all properties use malware_protection_plans + +## Overview + + + + + + + +
Namemalware_protection_plans_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::MalwareProtectionPlan
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier associated with Malware Protection plan resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all malware_protection_plans in a region. +```sql +SELECT +region, +malware_protection_plan_id +FROM aws.guardduty.malware_protection_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the malware_protection_plans_list_only resource, see malware_protection_plans + diff --git a/website/docs/services/guardduty/masters/index.md b/website/docs/services/guardduty/masters/index.md new file mode 100644 index 0000000..9a05da2 --- /dev/null +++ b/website/docs/services/guardduty/masters/index.md @@ -0,0 +1,202 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a master resource or lists masters in a region + +## Overview + + + + + + + +
Namemasters
TypeResource
DescriptionGuardDuty Master resource schema
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringID of the account used as the master account.
stringValue used to validate the master account to the member account.
stringUnique ID of the detector of the GuardDuty member account.
stringAWS region.
+ +For more information, see AWS::GuardDuty::Master. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all masters in a region. +```sql +SELECT +region, +master_id, +invitation_id, +detector_id +FROM aws.guardduty.masters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual master. +```sql +SELECT +region, +master_id, +invitation_id, +detector_id +FROM aws.guardduty.masters +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new master resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.masters ( + MasterId, + DetectorId, + region +) +SELECT +'{{ MasterId }}', + '{{ DetectorId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.masters ( + MasterId, + InvitationId, + DetectorId, + region +) +SELECT + '{{ MasterId }}', + '{{ InvitationId }}', + '{{ DetectorId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: master + props: + - name: MasterId + value: '{{ MasterId }}' + - name: InvitationId + value: '{{ InvitationId }}' + - name: DetectorId + value: '{{ DetectorId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.guardduty.masters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the masters resource, the following permissions are required: + +### Create +```json +guardduty:ListInvitations, +guardduty:AcceptInvitation, +guardduty:GetMasterAccount +``` + +### Read +```json +guardduty:GetMasterAccount +``` + +### Delete +```json +guardduty:DisassociateFromMasterAccount +``` + +### List +```json +guardduty:GetMasterAccount +``` diff --git a/website/docs/services/guardduty/masters_list_only/index.md b/website/docs/services/guardduty/masters_list_only/index.md new file mode 100644 index 0000000..5fa9e88 --- /dev/null +++ b/website/docs/services/guardduty/masters_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: masters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - masters_list_only + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists masters in a region or regions, for all properties use masters + +## Overview + + + + + + + +
Namemasters_list_only
TypeResource
DescriptionGuardDuty Master resource schema
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringID of the account used as the master account.
stringUnique ID of the detector of the GuardDuty member account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all masters in a region. +```sql +SELECT +region, +detector_id, +master_id +FROM aws.guardduty.masters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the masters_list_only resource, see masters + diff --git a/website/docs/services/guardduty/members/index.md b/website/docs/services/guardduty/members/index.md new file mode 100644 index 0000000..b990b8e --- /dev/null +++ b/website/docs/services/guardduty/members/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a member resource or lists members in a region + +## Overview + + + + + + + +
Namemembers
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Member
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
boolean
string
stringAWS region.
+ +For more information, see AWS::GuardDuty::Member. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all members in a region. +```sql +SELECT +region, +status, +member_id, +email, +message, +disable_email_notification, +detector_id +FROM aws.guardduty.members +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual member. +```sql +SELECT +region, +status, +member_id, +email, +message, +disable_email_notification, +detector_id +FROM aws.guardduty.members +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new member resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.members ( + Email, + region +) +SELECT +'{{ Email }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.members ( + Status, + MemberId, + Email, + Message, + DisableEmailNotification, + DetectorId, + region +) +SELECT + '{{ Status }}', + '{{ MemberId }}', + '{{ Email }}', + '{{ Message }}', + '{{ DisableEmailNotification }}', + '{{ DetectorId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: member + props: + - name: Status + value: '{{ Status }}' + - name: MemberId + value: '{{ MemberId }}' + - name: Email + value: '{{ Email }}' + - name: Message + value: '{{ Message }}' + - name: DisableEmailNotification + value: '{{ DisableEmailNotification }}' + - name: DetectorId + value: '{{ DetectorId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.guardduty.members +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the members resource, the following permissions are required: + +### Create +```json +guardduty:CreateMembers, +guardduty:GetMembers +``` + +### 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 +``` + +### List +```json +guardduty:ListMembers +``` diff --git a/website/docs/services/guardduty/members_list_only/index.md b/website/docs/services/guardduty/members_list_only/index.md new file mode 100644 index 0000000..5875966 --- /dev/null +++ b/website/docs/services/guardduty/members_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: members_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - members_list_only + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists members in a region or regions, for all properties use members + +## Overview + + + + + + + +
Namemembers_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Member
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all members in a region. +```sql +SELECT +region, +detector_id, +member_id +FROM aws.guardduty.members_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the members_list_only resource, see members + diff --git a/website/docs/services/guardduty/threat_intel_set_tags/index.md b/website/docs/services/guardduty/threat_intel_set_tags/index.md new file mode 100644 index 0000000..61ca5fb --- /dev/null +++ b/website/docs/services/guardduty/threat_intel_set_tags/index.md @@ -0,0 +1,87 @@ +--- +title: threat_intel_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - threat_intel_set_tags + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for threat_intel_sets in a region + +## Overview + + + + + + + +
Namethreat_intel_set_tags
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::ThreatIntelSet
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all threat_intel_sets in a region. +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tag_key, +tag_value +FROM aws.guardduty.threat_intel_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the threat_intel_set_tags resource, see threat_intel_sets + diff --git a/website/docs/services/guardduty/threat_intel_sets/index.md b/website/docs/services/guardduty/threat_intel_sets/index.md new file mode 100644 index 0000000..91b076c --- /dev/null +++ b/website/docs/services/guardduty/threat_intel_sets/index.md @@ -0,0 +1,248 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a threat_intel_set resource or lists threat_intel_sets in a region + +## Overview + + + + + + + +
Namethreat_intel_sets
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::ThreatIntelSet
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
string
array
stringAWS region.
+ +For more information, see AWS::GuardDuty::ThreatIntelSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all threat_intel_sets in a region. +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tags +FROM aws.guardduty.threat_intel_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual threat_intel_set. +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tags +FROM aws.guardduty.threat_intel_sets +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new threat_intel_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.threat_intel_sets ( + Format, + Location, + region +) +SELECT +'{{ Format }}', + '{{ Location }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.guardduty.threat_intel_sets ( + Format, + Activate, + DetectorId, + Name, + Location, + Tags, + region +) +SELECT + '{{ Format }}', + '{{ Activate }}', + '{{ DetectorId }}', + '{{ Name }}', + '{{ Location }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: threat_intel_set + props: + - name: Format + value: '{{ Format }}' + - name: Activate + value: '{{ Activate }}' + - name: DetectorId + value: '{{ DetectorId }}' + - name: Name + value: '{{ Name }}' + - name: Location + value: '{{ Location }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.guardduty.threat_intel_sets +WHERE data__Identifier = '' +AND 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 +``` + +### 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, +guardduty:TagResource, +guardduty:UntagResource +``` + +### List +```json +guardduty:ListThreatIntelSets +``` diff --git a/website/docs/services/guardduty/threat_intel_sets_list_only/index.md b/website/docs/services/guardduty/threat_intel_sets_list_only/index.md new file mode 100644 index 0000000..ad7d805 --- /dev/null +++ b/website/docs/services/guardduty/threat_intel_sets_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: threat_intel_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - threat_intel_sets_list_only + - guardduty + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists threat_intel_sets in a region or regions, for all properties use threat_intel_sets + +## Overview + + + + + + + +
Namethreat_intel_sets_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::ThreatIntelSet
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all threat_intel_sets in a region. +```sql +SELECT +region, +id, +detector_id +FROM aws.guardduty.threat_intel_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the threat_intel_sets_list_only resource, see threat_intel_sets + diff --git a/website/docs/services/healthimaging/datastore_tags/index.md b/website/docs/services/healthimaging/datastore_tags/index.md new file mode 100644 index 0000000..efa9131 --- /dev/null +++ b/website/docs/services/healthimaging/datastore_tags/index.md @@ -0,0 +1,89 @@ +--- +title: datastore_tags +hide_title: false +hide_table_of_contents: false +keywords: + - datastore_tags + - healthimaging + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for datastores in a region + +## Overview + + + + + + + +
Namedatastore_tags
TypeResource
DescriptionDefinition of AWS::HealthImaging::Datastore Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Datastore's ARN.
stringUser friendly name for Datastore.
string
stringA string to denote the Datastore's state.
stringARN referencing a KMS key or KMS key alias.
stringThe timestamp when the data store was created.
stringThe timestamp when the data store was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all datastores in a region. +```sql +SELECT +region, +datastore_arn, +datastore_name, +datastore_id, +datastore_status, +kms_key_arn, +created_at, +updated_at, +tag_key, +tag_value +FROM aws.healthimaging.datastore_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datastore_tags resource, see datastores + diff --git a/website/docs/services/healthimaging/datastores/index.md b/website/docs/services/healthimaging/datastores/index.md new file mode 100644 index 0000000..d41b7a9 --- /dev/null +++ b/website/docs/services/healthimaging/datastores/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a datastore resource or lists datastores in a region + +## Overview + + + + + + + +
Namedatastores
TypeResource
DescriptionDefinition of AWS::HealthImaging::Datastore Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Datastore's ARN.
stringUser friendly name for Datastore.
string
stringA string to denote the Datastore's state.
stringARN referencing a KMS key or KMS key alias.
stringThe timestamp when the data store was created.
stringThe timestamp when the data store was created.
objectA Map of key value pairs for Tags.
stringAWS region.
+ +For more information, see AWS::HealthImaging::Datastore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all datastores in a region. +```sql +SELECT +region, +datastore_arn, +datastore_name, +datastore_id, +datastore_status, +kms_key_arn, +created_at, +updated_at, +tags +FROM aws.healthimaging.datastores +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual datastore. +```sql +SELECT +region, +datastore_arn, +datastore_name, +datastore_id, +datastore_status, +kms_key_arn, +created_at, +updated_at, +tags +FROM aws.healthimaging.datastores +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new datastore resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.healthimaging.datastores ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.healthimaging.datastores ( + DatastoreName, + KmsKeyArn, + Tags, + region +) +SELECT + '{{ DatastoreName }}', + '{{ KmsKeyArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: datastore + props: + - name: DatastoreName + value: '{{ DatastoreName }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.healthimaging.datastores +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +medical-imaging:ListDatastores +``` diff --git a/website/docs/services/healthimaging/datastores_list_only/index.md b/website/docs/services/healthimaging/datastores_list_only/index.md new file mode 100644 index 0000000..cf4dc08 --- /dev/null +++ b/website/docs/services/healthimaging/datastores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: datastores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - datastores_list_only + - healthimaging + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists datastores in a region or regions, for all properties use datastores + +## Overview + + + + + + + +
Namedatastores_list_only
TypeResource
DescriptionDefinition of AWS::HealthImaging::Datastore Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all datastores in a region. +```sql +SELECT +region, +datastore_id +FROM aws.healthimaging.datastores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datastores_list_only resource, see datastores + diff --git a/website/docs/services/healthimaging/index.md b/website/docs/services/healthimaging/index.md new file mode 100644 index 0000000..bf8090c --- /dev/null +++ b/website/docs/services/healthimaging/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The healthimaging service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/healthlake/fhir_datastore_tags/index.md b/website/docs/services/healthlake/fhir_datastore_tags/index.md new file mode 100644 index 0000000..7e15ae2 --- /dev/null +++ b/website/docs/services/healthlake/fhir_datastore_tags/index.md @@ -0,0 +1,95 @@ +--- +title: fhir_datastore_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fhir_datastore_tags + - healthlake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fhir_datastores in a region + +## Overview + + + + + + + +
Namefhir_datastore_tags
TypeResource
DescriptionHealthLake FHIR Datastore
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe time that a Data Store was created.
stringThe Amazon Resource Name used in the creation of the Data Store.
stringThe AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL.
stringThe AWS-generated ID number for the Data Store.
stringThe user-generated name for the Data Store.
stringThe status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
stringThe FHIR version. Only R4 version data is supported.
objectThe preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.
objectThe server-side encryption key configuration for a customer provided encryption key.
objectThe identity provider configuration for the datastore
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fhir_datastores in a region. +```sql +SELECT +region, +created_at, +datastore_arn, +datastore_endpoint, +datastore_id, +datastore_name, +datastore_status, +datastore_type_version, +preload_data_config, +sse_configuration, +identity_provider_configuration, +tag_key, +tag_value +FROM aws.healthlake.fhir_datastore_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fhir_datastore_tags resource, see fhir_datastores + diff --git a/website/docs/services/healthlake/fhir_datastores/index.md b/website/docs/services/healthlake/fhir_datastores/index.md new file mode 100644 index 0000000..724b34e --- /dev/null +++ b/website/docs/services/healthlake/fhir_datastores/index.md @@ -0,0 +1,285 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a fhir_datastore resource or lists fhir_datastores in a region + +## Overview + + + + + + + +
Namefhir_datastores
TypeResource
DescriptionHealthLake FHIR Datastore
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe time that a Data Store was created.
stringThe Amazon Resource Name used in the creation of the Data Store.
stringThe AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL.
stringThe AWS-generated ID number for the Data Store.
stringThe user-generated name for the Data Store.
stringThe status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
stringThe FHIR version. Only R4 version data is supported.
objectThe preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.
objectThe server-side encryption key configuration for a customer provided encryption key.
objectThe identity provider configuration for the datastore
array
stringAWS region.
+ +For more information, see AWS::HealthLake::FHIRDatastore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all fhir_datastores in a region. +```sql +SELECT +region, +created_at, +datastore_arn, +datastore_endpoint, +datastore_id, +datastore_name, +datastore_status, +datastore_type_version, +preload_data_config, +sse_configuration, +identity_provider_configuration, +tags +FROM aws.healthlake.fhir_datastores +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual fhir_datastore. +```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_datastores +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new fhir_datastore resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.healthlake.fhir_datastores ( + DatastoreTypeVersion, + region +) +SELECT +'{{ DatastoreTypeVersion }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.healthlake.fhir_datastores ( + DatastoreName, + DatastoreTypeVersion, + PreloadDataConfig, + SseConfiguration, + IdentityProviderConfiguration, + Tags, + region +) +SELECT + '{{ DatastoreName }}', + '{{ DatastoreTypeVersion }}', + '{{ PreloadDataConfig }}', + '{{ SseConfiguration }}', + '{{ IdentityProviderConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: fhir_datastore + props: + - name: DatastoreName + value: '{{ DatastoreName }}' + - name: DatastoreTypeVersion + value: '{{ DatastoreTypeVersion }}' + - name: PreloadDataConfig + value: + PreloadDataType: '{{ PreloadDataType }}' + - name: SseConfiguration + value: + KmsEncryptionConfig: + CmkType: '{{ CmkType }}' + KmsKeyId: '{{ KmsKeyId }}' + - name: IdentityProviderConfiguration + value: + AuthorizationStrategy: '{{ AuthorizationStrategy }}' + FineGrainedAuthorizationEnabled: '{{ FineGrainedAuthorizationEnabled }}' + Metadata: '{{ Metadata }}' + IdpLambdaArn: '{{ IdpLambdaArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.healthlake.fhir_datastores +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +healthlake:ListFHIRDatastores +``` diff --git a/website/docs/services/healthlake/fhir_datastores_list_only/index.md b/website/docs/services/healthlake/fhir_datastores_list_only/index.md new file mode 100644 index 0000000..73124b5 --- /dev/null +++ b/website/docs/services/healthlake/fhir_datastores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: fhir_datastores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fhir_datastores_list_only + - healthlake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fhir_datastores in a region or regions, for all properties use fhir_datastores + +## Overview + + + + + + + +
Namefhir_datastores_list_only
TypeResource
DescriptionHealthLake FHIR Datastore
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe AWS-generated ID number for the Data Store.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fhir_datastores in a region. +```sql +SELECT +region, +datastore_id +FROM aws.healthlake.fhir_datastores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fhir_datastores_list_only resource, see fhir_datastores + diff --git a/website/docs/services/healthlake/index.md b/website/docs/services/healthlake/index.md new file mode 100644 index 0000000..e63fdb6 --- /dev/null +++ b/website/docs/services/healthlake/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The healthlake service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/iam/group_policies/index.md b/website/docs/services/iam/group_policies/index.md new file mode 100644 index 0000000..8d016ee --- /dev/null +++ b/website/docs/services/iam/group_policies/index.md @@ -0,0 +1,194 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a group_policy resource or lists group_policies in a region + +## Overview + + + + + + + +
Namegroup_policies
TypeResource
DescriptionAdds or updates an inline policy document that is embedded in the specified IAM group.
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*.
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*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectThe policy document.
You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.
The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:
+ Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
+ The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
+ The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
stringThe name of the policy document.
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringThe name of the group to associate the policy with.
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: _+=,.@-.
stringAWS region.
+ +For more information, see AWS::IAM::GroupPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual group_policy. +```sql +SELECT +region, +policy_document, +policy_name, +group_name +FROM aws.iam.group_policies +WHERE data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new group_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.group_policies ( + PolicyName, + GroupName, + region +) +SELECT +'{{ PolicyName }}', + '{{ GroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.group_policies ( + PolicyDocument, + PolicyName, + GroupName, + region +) +SELECT + '{{ PolicyDocument }}', + '{{ PolicyName }}', + '{{ GroupName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: group_policy + props: + - name: PolicyDocument + value: {} + - name: PolicyName + value: '{{ PolicyName }}' + - name: GroupName + value: '{{ GroupName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.group_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the group_policies resource, the following permissions are required: + +### Create +```json +iam:PutGroupPolicy, +iam:GetGroupPolicy +``` + +### Read +```json +iam:GetGroupPolicy +``` + +### Update +```json +iam:PutGroupPolicy, +iam:GetGroupPolicy +``` + +### Delete +```json +iam:DeleteGroupPolicy, +iam:GetGroupPolicy +``` diff --git a/website/docs/services/iam/groups/index.md b/website/docs/services/iam/groups/index.md new file mode 100644 index 0000000..85c40fe --- /dev/null +++ b/website/docs/services/iam/groups/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a group resource or lists groups in a region + +## Overview + + + + + + + +
Namegroups
TypeResource
DescriptionCreates a new group.
For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the group to create. Do not include the path in this value.
The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
arrayThe Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
stringThe path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
arrayAdds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group).
The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.
For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
stringAWS region.
+ +For more information, see AWS::IAM::Group. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all groups in a region. +```sql +SELECT +region, +arn, +group_name, +managed_policy_arns, +path, +policies +FROM aws.iam.groups +; +``` +Gets all properties from an individual group. +```sql +SELECT +region, +arn, +group_name, +managed_policy_arns, +path, +policies +FROM aws.iam.groups +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.groups ( + GroupName, + ManagedPolicyArns, + Path, + Policies, + region +) +SELECT +'{{ GroupName }}', + '{{ ManagedPolicyArns }}', + '{{ Path }}', + '{{ Policies }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.groups ( + GroupName, + ManagedPolicyArns, + Path, + Policies, + region +) +SELECT + '{{ GroupName }}', + '{{ ManagedPolicyArns }}', + '{{ Path }}', + '{{ Policies }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: group + props: + - name: GroupName + value: '{{ GroupName }}' + - name: ManagedPolicyArns + value: + - '{{ ManagedPolicyArns[0] }}' + - name: Path + value: '{{ Path }}' + - name: Policies + value: + - PolicyDocument: {} + PolicyName: '{{ PolicyName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +```json +iam:CreateGroup, +iam:PutGroupPolicy, +iam:AttachGroupPolicy, +iam:GetGroupPolicy, +iam:GetGroup +``` + +### 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 +``` + +### List +```json +iam:ListGroups +``` diff --git a/website/docs/services/iam/groups_list_only/index.md b/website/docs/services/iam/groups_list_only/index.md new file mode 100644 index 0000000..c01603c --- /dev/null +++ b/website/docs/services/iam/groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - groups_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists groups in a region or regions, for all properties use groups + +## Overview + + + + + + + +
Namegroups_list_only
TypeResource
DescriptionCreates a new group.
For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the group to create. Do not include the path in this value.
The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all groups in a region. +```sql +SELECT +region, +group_name +FROM aws.iam.groups_list_only +; +``` + + +## Permissions + +For permissions required to operate on the groups_list_only resource, see groups + diff --git a/website/docs/services/iam/index.md b/website/docs/services/iam/index.md new file mode 100644 index 0000000..c939558 --- /dev/null +++ b/website/docs/services/iam/index.md @@ -0,0 +1,63 @@ +--- +title: iam +hide_title: false +hide_table_of_contents: false +keywords: + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The iam service documentation. + +:::info Service Summary + +
+
+total resources: 28
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/iam/instance_profiles/index.md b/website/docs/services/iam/instance_profiles/index.md new file mode 100644 index 0000000..30bd5d0 --- /dev/null +++ b/website/docs/services/iam/instance_profiles/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an instance_profile resource or lists 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).
For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
arrayThe name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions.
stringThe name of the instance profile to create.
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
string
stringAWS region.
+ +For more information, see AWS::IAM::InstanceProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all instance_profiles in a region. +```sql +SELECT +region, +path, +roles, +instance_profile_name, +arn +FROM aws.iam.instance_profiles +; +``` +Gets all properties from an individual instance_profile. +```sql +SELECT +region, +path, +roles, +instance_profile_name, +arn +FROM aws.iam.instance_profiles +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.instance_profiles ( + Roles, + region +) +SELECT +'{{ Roles }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.instance_profiles ( + Path, + Roles, + InstanceProfileName, + region +) +SELECT + '{{ Path }}', + '{{ Roles }}', + '{{ InstanceProfileName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: instance_profile + props: + - name: Path + value: '{{ Path }}' + - name: Roles + value: + - '{{ Roles[0] }}' + - name: InstanceProfileName + value: '{{ InstanceProfileName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.instance_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the instance_profiles resource, the following permissions are required: + +### Create +```json +iam:CreateInstanceProfile, +iam:PassRole, +iam:AddRoleToInstanceProfile, +iam:GetInstanceProfile +``` + +### Read +```json +iam:GetInstanceProfile +``` + +### Update +```json +iam:PassRole, +iam:RemoveRoleFromInstanceProfile, +iam:AddRoleToInstanceProfile, +iam:GetInstanceProfile +``` + +### Delete +```json +iam:GetInstanceProfile, +iam:RemoveRoleFromInstanceProfile, +iam:DeleteInstanceProfile +``` + +### List +```json +iam:ListInstanceProfiles +``` diff --git a/website/docs/services/iam/instance_profiles_list_only/index.md b/website/docs/services/iam/instance_profiles_list_only/index.md new file mode 100644 index 0000000..ca6c361 --- /dev/null +++ b/website/docs/services/iam/instance_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: instance_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profiles_list_only + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instance_profiles in a region or regions, for all properties use instance_profiles + +## Overview + + + + + + + +
Nameinstance_profiles_list_only
TypeResource
DescriptionCreates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).
For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the instance profile to create.
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instance_profiles in a region. +```sql +SELECT +region, +instance_profile_name +FROM aws.iam.instance_profiles_list_only +; +``` + + +## Permissions + +For permissions required to operate on the instance_profiles_list_only resource, see instance_profiles + diff --git a/website/docs/services/iam/managed_policies/index.md b/website/docs/services/iam/managed_policies/index.md new file mode 100644 index 0000000..64f37de --- /dev/null +++ b/website/docs/services/iam/managed_policies/index.md @@ -0,0 +1,284 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a managed_policy resource or lists managed_policies in a region + +## Overview + + + + + + + +
Namemanaged_policies
TypeResource
DescriptionCreates a new managed policy for your AWS-account.
This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.
As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.
For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA friendly description of the policy.
Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
The policy description is immutable. After a value is assigned, it cannot be changed.
arrayThe name (friendly name, not ARN) of the group to attach the policy to.
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringThe friendly name of the policy.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
stringThe path for the policy.
For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
You cannot use an asterisk (*) in the path name.
objectThe JSON policy document that you want to use as the content for the new policy.
You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).
To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*.
The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:
+ Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
+ The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
+ The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
arrayThe name (friendly name, not ARN) of the role to attach the policy to.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy) has a Ref to a role and if a resource (such as AWS::ECS::Service) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that CFN deletes the AWS::ECS::Service resource before deleting its role's policy.
arrayThe name (friendly name, not ARN) of the IAM user to attach the policy to.
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
string
integer
string
string
string
boolean
integer
string
stringAWS region.
+ +For more information, see AWS::IAM::ManagedPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all managed_policies in a region. +```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_policies +; +``` +Gets all properties from an individual managed_policy. +```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_policies +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new managed_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.managed_policies ( + PolicyDocument, + region +) +SELECT +'{{ PolicyDocument }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.managed_policies ( + Description, + Groups, + ManagedPolicyName, + Path, + PolicyDocument, + Roles, + Users, + region +) +SELECT + '{{ Description }}', + '{{ Groups }}', + '{{ ManagedPolicyName }}', + '{{ Path }}', + '{{ PolicyDocument }}', + '{{ Roles }}', + '{{ Users }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: managed_policy + props: + - name: Description + value: '{{ Description }}' + - name: Groups + value: + - '{{ Groups[0] }}' + - name: ManagedPolicyName + value: '{{ ManagedPolicyName }}' + - name: Path + value: '{{ Path }}' + - name: PolicyDocument + value: {} + - name: Roles + value: + - '{{ Roles[0] }}' + - name: Users + value: + - '{{ Users[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.managed_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the managed_policies resource, the following permissions are required: + +### Create +```json +iam:CreatePolicy, +iam:AttachGroupPolicy, +iam:AttachUserPolicy, +iam:AttachRolePolicy +``` + +### 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 +``` + +### List +```json +iam:ListPolicies +``` diff --git a/website/docs/services/iam/managed_policies_list_only/index.md b/website/docs/services/iam/managed_policies_list_only/index.md new file mode 100644 index 0000000..3bb1fc2 --- /dev/null +++ b/website/docs/services/iam/managed_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: managed_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - managed_policies_list_only + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists managed_policies in a region or regions, for all properties use managed_policies + +## Overview + + + + + + + +
Namemanaged_policies_list_only
TypeResource
DescriptionCreates a new managed policy for your AWS-account.
This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.
As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.
For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all managed_policies in a region. +```sql +SELECT +region, +policy_arn +FROM aws.iam.managed_policies_list_only +; +``` + + +## Permissions + +For permissions required to operate on the managed_policies_list_only resource, see managed_policies + diff --git a/website/docs/services/iam/oidc_provider_tags/index.md b/website/docs/services/iam/oidc_provider_tags/index.md new file mode 100644 index 0000000..1515e7f --- /dev/null +++ b/website/docs/services/iam/oidc_provider_tags/index.md @@ -0,0 +1,83 @@ +--- +title: oidc_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - oidc_provider_tags + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for oidc_providers in a region + +## Overview + + + + + + + +
Nameoidc_provider_tags
TypeResource
DescriptionResource Type definition for AWS::IAM::OIDCProvider
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
array
string
array
stringAmazon Resource Name (ARN) of the OIDC provider
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all oidc_providers in a region. +```sql +SELECT +region, +client_id_list, +url, +thumbprint_list, +arn, +tag_key, +tag_value +FROM aws.iam.oidc_provider_tags +; +``` + + +## Permissions + +For permissions required to operate on the oidc_provider_tags resource, see oidc_providers + diff --git a/website/docs/services/iam/oidc_providers/index.md b/website/docs/services/iam/oidc_providers/index.md new file mode 100644 index 0000000..11bc560 --- /dev/null +++ b/website/docs/services/iam/oidc_providers/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an oidc_provider resource or lists oidc_providers in a region + +## Overview + + + + + + + +
Nameoidc_providers
TypeResource
DescriptionResource Type definition for AWS::IAM::OIDCProvider
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
array
string
array
stringAmazon Resource Name (ARN) of the OIDC provider
array
stringAWS region.
+ +For more information, see AWS::IAM::OIDCProvider. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all oidc_providers in a region. +```sql +SELECT +region, +client_id_list, +url, +thumbprint_list, +arn, +tags +FROM aws.iam.oidc_providers +; +``` +Gets all properties from an individual oidc_provider. +```sql +SELECT +region, +client_id_list, +url, +thumbprint_list, +arn, +tags +FROM aws.iam.oidc_providers +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new oidc_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.oidc_providers ( + ClientIdList, + Url, + ThumbprintList, + Tags, + region +) +SELECT +'{{ ClientIdList }}', + '{{ Url }}', + '{{ ThumbprintList }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.oidc_providers ( + ClientIdList, + Url, + ThumbprintList, + Tags, + region +) +SELECT + '{{ ClientIdList }}', + '{{ Url }}', + '{{ ThumbprintList }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: oidc_provider + props: + - name: ClientIdList + value: + - '{{ ClientIdList[0] }}' + - name: Url + value: '{{ Url }}' + - name: ThumbprintList + value: + - '{{ ThumbprintList[0] }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.oidc_providers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the oidc_providers resource, the following permissions are required: + +### Create +```json +iam:CreateOpenIDConnectProvider, +iam:TagOpenIDConnectProvider, +iam:GetOpenIDConnectProvider +``` + +### Read +```json +iam:GetOpenIDConnectProvider +``` + +### Update +```json +iam:UpdateOpenIDConnectProviderThumbprint, +iam:RemoveClientIDFromOpenIDConnectProvider, +iam:AddClientIDToOpenIDConnectProvider, +iam:GetOpenIDConnectProvider, +iam:TagOpenIDConnectProvider, +iam:UntagOpenIDConnectProvider, +iam:ListOpenIDConnectProviderTags +``` + +### Delete +```json +iam:DeleteOpenIDConnectProvider +``` + +### List +```json +iam:ListOpenIDConnectProvider, +iam:GetOpenIDConnectProvider +``` diff --git a/website/docs/services/iam/oidc_providers_list_only/index.md b/website/docs/services/iam/oidc_providers_list_only/index.md new file mode 100644 index 0000000..5541c97 --- /dev/null +++ b/website/docs/services/iam/oidc_providers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: oidc_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - oidc_providers_list_only + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists oidc_providers in a region or regions, for all properties use oidc_providers + +## Overview + + + + + + + +
Nameoidc_providers_list_only
TypeResource
DescriptionResource Type definition for AWS::IAM::OIDCProvider
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN) of the OIDC provider
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all oidc_providers in a region. +```sql +SELECT +region, +arn +FROM aws.iam.oidc_providers_list_only +; +``` + + +## Permissions + +For permissions required to operate on the oidc_providers_list_only resource, see oidc_providers + diff --git a/website/docs/services/iam/role_policies/index.md b/website/docs/services/iam/role_policies/index.md new file mode 100644 index 0000000..4ebb40c --- /dev/null +++ b/website/docs/services/iam/role_policies/index.md @@ -0,0 +1,194 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a role_policy resource or lists role_policies in a region + +## Overview + + + + + + + +
Namerole_policies
TypeResource
DescriptionAdds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, 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*.
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*.
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*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectThe policy document.
You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.
The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:
+ Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
+ The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
+ The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
stringThe name of the policy document.
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringThe name of the role to associate the policy with.
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: _+=,.@-
stringAWS region.
+ +For more information, see AWS::IAM::RolePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual role_policy. +```sql +SELECT +region, +policy_document, +policy_name, +role_name +FROM aws.iam.role_policies +WHERE data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new role_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.role_policies ( + PolicyName, + RoleName, + region +) +SELECT +'{{ PolicyName }}', + '{{ RoleName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.role_policies ( + PolicyDocument, + PolicyName, + RoleName, + region +) +SELECT + '{{ PolicyDocument }}', + '{{ PolicyName }}', + '{{ RoleName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: role_policy + props: + - name: PolicyDocument + value: {} + - name: PolicyName + value: '{{ PolicyName }}' + - name: RoleName + value: '{{ RoleName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.role_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the role_policies resource, the following permissions are required: + +### Create +```json +iam:PutRolePolicy, +iam:GetRolePolicy +``` + +### Read +```json +iam:GetRolePolicy +``` + +### Update +```json +iam:PutRolePolicy, +iam:GetRolePolicy +``` + +### Delete +```json +iam:DeleteRolePolicy, +iam:GetRolePolicy +``` diff --git a/website/docs/services/iam/role_tags/index.md b/website/docs/services/iam/role_tags/index.md new file mode 100644 index 0000000..bac146f --- /dev/null +++ b/website/docs/services/iam/role_tags/index.md @@ -0,0 +1,95 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for roles in a region + +## Overview + + + + + + + +
Namerole_tags
TypeResource
DescriptionCreates a new role for your AWS-account.
For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectThe trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.
stringA description of the role that you provide.
arrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
integerThe maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.
stringThe path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
stringThe ARN of the policy used to set the permissions boundary for the role.
For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
arrayAdds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).
A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.
For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
If an external policy (such as AWS::IAM::Policy or 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.
string
stringA name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all roles in a region. +```sql +SELECT +region, +arn, +assume_role_policy_document, +description, +managed_policy_arns, +max_session_duration, +path, +permissions_boundary, +policies, +role_id, +role_name, +tag_key, +tag_value +FROM aws.iam.role_tags +; +``` + + +## Permissions + +For permissions required to operate on the role_tags resource, see roles + diff --git a/website/docs/services/iam/roles/index.md b/website/docs/services/iam/roles/index.md new file mode 100644 index 0000000..9f56fac --- /dev/null +++ b/website/docs/services/iam/roles/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a role resource or lists roles in a region + +## Overview + + + + + + + +
Nameroles
TypeResource
DescriptionCreates a new role for your AWS-account.
For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectThe trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.
stringA description of the role that you provide.
arrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
integerThe maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.
stringThe path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
stringThe ARN of the policy used to set the permissions boundary for the role.
For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
arrayAdds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).
A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.
For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
If an external policy (such as AWS::IAM::Policy or 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.
string
stringA name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
arrayA list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.
stringAWS region.
+ +For more information, see AWS::IAM::Role. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all roles in a region. +```sql +SELECT +region, +arn, +assume_role_policy_document, +description, +managed_policy_arns, +max_session_duration, +path, +permissions_boundary, +policies, +role_id, +role_name, +tags +FROM aws.iam.roles +; +``` +Gets all properties from an individual role. +```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.roles +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new role resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.roles ( + AssumeRolePolicyDocument, + region +) +SELECT +'{{ AssumeRolePolicyDocument }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.roles ( + AssumeRolePolicyDocument, + Description, + ManagedPolicyArns, + MaxSessionDuration, + Path, + PermissionsBoundary, + Policies, + RoleName, + Tags, + region +) +SELECT + '{{ AssumeRolePolicyDocument }}', + '{{ Description }}', + '{{ ManagedPolicyArns }}', + '{{ MaxSessionDuration }}', + '{{ Path }}', + '{{ PermissionsBoundary }}', + '{{ Policies }}', + '{{ RoleName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: role + props: + - name: AssumeRolePolicyDocument + value: {} + - name: Description + value: '{{ Description }}' + - name: ManagedPolicyArns + value: + - '{{ ManagedPolicyArns[0] }}' + - name: MaxSessionDuration + value: '{{ MaxSessionDuration }}' + - name: Path + value: '{{ Path }}' + - name: PermissionsBoundary + value: '{{ PermissionsBoundary }}' + - name: Policies + value: + - PolicyDocument: {} + PolicyName: '{{ PolicyName }}' + - name: RoleName + value: '{{ RoleName }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.roles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### 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 +``` + +### List +```json +iam:ListRoles +``` diff --git a/website/docs/services/iam/roles_list_only/index.md b/website/docs/services/iam/roles_list_only/index.md new file mode 100644 index 0000000..b0f2c4e --- /dev/null +++ b/website/docs/services/iam/roles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: roles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - roles_list_only + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists roles in a region or regions, for all properties use roles + +## Overview + + + + + + + +
Nameroles_list_only
TypeResource
DescriptionCreates a new role for your AWS-account.
For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all roles in a region. +```sql +SELECT +region, +role_name +FROM aws.iam.roles_list_only +; +``` + + +## Permissions + +For permissions required to operate on the roles_list_only resource, see roles + diff --git a/website/docs/services/iam/saml_provider_tags/index.md b/website/docs/services/iam/saml_provider_tags/index.md new file mode 100644 index 0000000..c8a5757 --- /dev/null +++ b/website/docs/services/iam/saml_provider_tags/index.md @@ -0,0 +1,81 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for saml_providers in a region + +## Overview + + + + + + + +
Namesaml_provider_tags
TypeResource
DescriptionResource Type definition for AWS::IAM::SAMLProvider
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
stringAmazon Resource Name (ARN) of the SAML provider
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all saml_providers in a region. +```sql +SELECT +region, +name, +saml_metadata_document, +arn, +tag_key, +tag_value +FROM aws.iam.saml_provider_tags +; +``` + + +## Permissions + +For permissions required to operate on the saml_provider_tags resource, see saml_providers + diff --git a/website/docs/services/iam/saml_providers/index.md b/website/docs/services/iam/saml_providers/index.md new file mode 100644 index 0000000..cb12b71 --- /dev/null +++ b/website/docs/services/iam/saml_providers/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a saml_provider resource or lists saml_providers in a region + +## Overview + + + + + + + +
Namesaml_providers
TypeResource
DescriptionResource Type definition for AWS::IAM::SAMLProvider
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
stringAmazon Resource Name (ARN) of the SAML provider
array
stringAWS region.
+ +For more information, see AWS::IAM::SAMLProvider. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all saml_providers in a region. +```sql +SELECT +region, +name, +saml_metadata_document, +arn, +tags +FROM aws.iam.saml_providers +; +``` +Gets all properties from an individual saml_provider. +```sql +SELECT +region, +name, +saml_metadata_document, +arn, +tags +FROM aws.iam.saml_providers +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new saml_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.saml_providers ( + SamlMetadataDocument, + region +) +SELECT +'{{ SamlMetadataDocument }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.saml_providers ( + Name, + SamlMetadataDocument, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ SamlMetadataDocument }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: saml_provider + props: + - name: Name + value: '{{ Name }}' + - name: SamlMetadataDocument + value: '{{ SamlMetadataDocument }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.saml_providers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the saml_providers resource, the following permissions are required: + +### Create +```json +iam:CreateSAMLProvider, +iam:GetSAMLProvider, +iam:TagSAMLProvider +``` + +### Read +```json +iam:GetSAMLProvider +``` + +### Update +```json +iam:UpdateSAMLProvider, +iam:GetSAMLProvider, +iam:TagSAMLProvider, +iam:ListSAMLProviderTags, +iam:UntagSAMLProvider +``` + +### Delete +```json +iam:DeleteSAMLProvider +``` + +### List +```json +iam:ListSAMLProviders, +iam:GetSAMLProvider +``` diff --git a/website/docs/services/iam/saml_providers_list_only/index.md b/website/docs/services/iam/saml_providers_list_only/index.md new file mode 100644 index 0000000..f5057df --- /dev/null +++ b/website/docs/services/iam/saml_providers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: saml_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - saml_providers_list_only + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists saml_providers in a region or regions, for all properties use saml_providers + +## Overview + + + + + + + +
Namesaml_providers_list_only
TypeResource
DescriptionResource Type definition for AWS::IAM::SAMLProvider
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN) of the SAML provider
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all saml_providers in a region. +```sql +SELECT +region, +arn +FROM aws.iam.saml_providers_list_only +; +``` + + +## Permissions + +For permissions required to operate on the saml_providers_list_only resource, see saml_providers + diff --git a/website/docs/services/iam/server_certificate_tags/index.md b/website/docs/services/iam/server_certificate_tags/index.md new file mode 100644 index 0000000..ddbb150 --- /dev/null +++ b/website/docs/services/iam/server_certificate_tags/index.md @@ -0,0 +1,87 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for server_certificates in a region + +## Overview + + + + + + + +
Nameserver_certificate_tags
TypeResource
DescriptionResource Type definition for AWS::IAM::ServerCertificate
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringAmazon Resource Name (ARN) of the server certificate
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all server_certificates in a region. +```sql +SELECT +region, +certificate_body, +certificate_chain, +server_certificate_name, +path, +private_key, +arn, +tag_key, +tag_value +FROM aws.iam.server_certificate_tags +; +``` + + +## Permissions + +For permissions required to operate on the server_certificate_tags resource, see server_certificates + diff --git a/website/docs/services/iam/server_certificates/index.md b/website/docs/services/iam/server_certificates/index.md new file mode 100644 index 0000000..4123a97 --- /dev/null +++ b/website/docs/services/iam/server_certificates/index.md @@ -0,0 +1,250 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a server_certificate resource or lists server_certificates in a region + +## Overview + + + + + + + +
Nameserver_certificates
TypeResource
DescriptionResource Type definition for AWS::IAM::ServerCertificate
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringAmazon Resource Name (ARN) of the server certificate
array
stringAWS region.
+ +For more information, see AWS::IAM::ServerCertificate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all server_certificates in a region. +```sql +SELECT +region, +certificate_body, +certificate_chain, +server_certificate_name, +path, +private_key, +arn, +tags +FROM aws.iam.server_certificates +; +``` +Gets all properties from an individual server_certificate. +```sql +SELECT +region, +certificate_body, +certificate_chain, +server_certificate_name, +path, +private_key, +arn, +tags +FROM aws.iam.server_certificates +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new server_certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.server_certificates ( + CertificateBody, + CertificateChain, + ServerCertificateName, + Path, + PrivateKey, + Tags, + region +) +SELECT +'{{ CertificateBody }}', + '{{ CertificateChain }}', + '{{ ServerCertificateName }}', + '{{ Path }}', + '{{ PrivateKey }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.server_certificates ( + CertificateBody, + CertificateChain, + ServerCertificateName, + Path, + PrivateKey, + Tags, + region +) +SELECT + '{{ CertificateBody }}', + '{{ CertificateChain }}', + '{{ ServerCertificateName }}', + '{{ Path }}', + '{{ PrivateKey }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: server_certificate + props: + - name: CertificateBody + value: '{{ CertificateBody }}' + - name: CertificateChain + value: '{{ CertificateChain }}' + - name: ServerCertificateName + value: '{{ ServerCertificateName }}' + - name: Path + value: '{{ Path }}' + - name: PrivateKey + value: '{{ PrivateKey }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.server_certificates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the server_certificates resource, the following permissions are required: + +### Create +```json +iam:UploadServerCertificate, +iam:TagServerCertificate, +iam:GetServerCertificate +``` + +### Read +```json +iam:GetServerCertificate +``` + +### Update +```json +iam:TagServerCertificate, +iam:UntagServerCertificate, +iam:ListServerCertificateTags, +iam:GetServerCertificate +``` + +### Delete +```json +iam:DeleteServerCertificate +``` + +### List +```json +iam:ListServerCertificates, +iam:GetServerCertificate +``` diff --git a/website/docs/services/iam/server_certificates_list_only/index.md b/website/docs/services/iam/server_certificates_list_only/index.md new file mode 100644 index 0000000..3696b14 --- /dev/null +++ b/website/docs/services/iam/server_certificates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: server_certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - server_certificates_list_only + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists server_certificates in a region or regions, for all properties use server_certificates + +## Overview + + + + + + + +
Nameserver_certificates_list_only
TypeResource
DescriptionResource Type definition for AWS::IAM::ServerCertificate
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all server_certificates in a region. +```sql +SELECT +region, +server_certificate_name +FROM aws.iam.server_certificates_list_only +; +``` + + +## Permissions + +For permissions required to operate on the server_certificates_list_only resource, see server_certificates + diff --git a/website/docs/services/iam/service_linked_roles/index.md b/website/docs/services/iam/service_linked_roles/index.md new file mode 100644 index 0000000..7cfc129 --- /dev/null +++ b/website/docs/services/iam/service_linked_roles/index.md @@ -0,0 +1,195 @@ +--- +title: service_linked_roles +hide_title: false +hide_table_of_contents: false +keywords: + - service_linked_roles + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_linked_role resource or lists service_linked_roles in a region + +## Overview + + + + + + + +
Nameservice_linked_roles
TypeResource
DescriptionResource Type definition for AWS::IAM::ServiceLinkedRole
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the role.
stringA string that you provide, which is combined with the service-provided prefix to form the complete role name.
stringThe description of the role.
stringThe service principal for the AWS service to which this role is attached.
stringAWS region.
+ +For more information, see AWS::IAM::ServiceLinkedRole. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual service_linked_role. +```sql +SELECT +region, +role_name, +custom_suffix, +description, +aws_service_name +FROM aws.iam.service_linked_roles +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_linked_role resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.service_linked_roles ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.service_linked_roles ( + CustomSuffix, + Description, + AWSServiceName, + region +) +SELECT + '{{ CustomSuffix }}', + '{{ Description }}', + '{{ AWSServiceName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_linked_role + props: + - name: CustomSuffix + value: '{{ CustomSuffix }}' + - name: Description + value: '{{ Description }}' + - name: AWSServiceName + value: '{{ AWSServiceName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.service_linked_roles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the service_linked_roles resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +iam:GetRole +``` + +### Read +```json +iam:GetRole +``` + +### Update +```json +iam:UpdateRole, +iam:GetRole +``` + +### Delete +```json +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus, +iam:GetRole +``` diff --git a/website/docs/services/iam/user_policies/index.md b/website/docs/services/iam/user_policies/index.md new file mode 100644 index 0000000..a212b8e --- /dev/null +++ b/website/docs/services/iam/user_policies/index.md @@ -0,0 +1,194 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_policy resource or lists user_policies in a region + +## Overview + + + + + + + +
Nameuser_policies
TypeResource
DescriptionAdds or updates an inline policy document that is embedded in the specified IAM user.
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*.
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*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectThe policy document.
You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.
The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:
+ Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
+ The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
+ The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
stringThe name of the policy document.
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringThe name of the user to associate the policy with.
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: _+=,.@-
stringAWS region.
+ +For more information, see AWS::IAM::UserPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual user_policy. +```sql +SELECT +region, +policy_document, +policy_name, +user_name +FROM aws.iam.user_policies +WHERE data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.user_policies ( + PolicyName, + UserName, + region +) +SELECT +'{{ PolicyName }}', + '{{ UserName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.user_policies ( + PolicyDocument, + PolicyName, + UserName, + region +) +SELECT + '{{ PolicyDocument }}', + '{{ PolicyName }}', + '{{ UserName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_policy + props: + - name: PolicyDocument + value: {} + - name: PolicyName + value: '{{ PolicyName }}' + - name: UserName + value: '{{ UserName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.user_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the user_policies resource, the following permissions are required: + +### Create +```json +iam:PutUserPolicy, +iam:GetUserPolicy +``` + +### Read +```json +iam:GetUserPolicy +``` + +### Update +```json +iam:PutUserPolicy, +iam:GetUserPolicy +``` + +### Delete +```json +iam:DeleteUserPolicy, +iam:GetUserPolicy +``` diff --git a/website/docs/services/iam/user_tags/index.md b/website/docs/services/iam/user_tags/index.md new file mode 100644 index 0000000..fefdc3b --- /dev/null +++ b/website/docs/services/iam/user_tags/index.md @@ -0,0 +1,91 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for users in a region + +## Overview + + + + + + + +
Nameuser_tags
TypeResource
DescriptionCreates a new IAM user for your AWS-account.
For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
arrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.
For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
arrayAdds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).
The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.
For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
stringThe name of the user to create. Do not include the path in this value.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
arrayA list of group names to which you want to add the user.
string
objectCreates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.
You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.
For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.
stringThe ARN of the managed policy that is used to set the permissions boundary for the user.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all users in a region. +```sql +SELECT +region, +path, +managed_policy_arns, +policies, +user_name, +groups, +arn, +login_profile, +permissions_boundary, +tag_key, +tag_value +FROM aws.iam.user_tags +; +``` + + +## Permissions + +For permissions required to operate on the user_tags resource, see users + diff --git a/website/docs/services/iam/users/index.md b/website/docs/services/iam/users/index.md new file mode 100644 index 0000000..e8c73d8 --- /dev/null +++ b/website/docs/services/iam/users/index.md @@ -0,0 +1,307 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a user resource or lists users in a region + +## Overview + + + + + + + +
Nameusers
TypeResource
DescriptionCreates a new IAM user for your AWS-account.
For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
arrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.
For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
arrayAdds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).
The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.
For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
stringThe name of the user to create. Do not include the path in this value.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
arrayA list of group names to which you want to add the user.
string
objectCreates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.
You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.
For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.
arrayA list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
stringThe ARN of the managed policy that is used to set the permissions boundary for the user.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.
stringAWS region.
+ +For more information, see AWS::IAM::User. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all users in a region. +```sql +SELECT +region, +path, +managed_policy_arns, +policies, +user_name, +groups, +arn, +login_profile, +tags, +permissions_boundary +FROM aws.iam.users +; +``` +Gets all properties from an individual user. +```sql +SELECT +region, +path, +managed_policy_arns, +policies, +user_name, +groups, +arn, +login_profile, +tags, +permissions_boundary +FROM aws.iam.users +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.users ( + Path, + ManagedPolicyArns, + Policies, + UserName, + Groups, + LoginProfile, + Tags, + PermissionsBoundary, + region +) +SELECT +'{{ Path }}', + '{{ ManagedPolicyArns }}', + '{{ Policies }}', + '{{ UserName }}', + '{{ Groups }}', + '{{ LoginProfile }}', + '{{ Tags }}', + '{{ PermissionsBoundary }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.users ( + Path, + ManagedPolicyArns, + Policies, + UserName, + Groups, + LoginProfile, + Tags, + PermissionsBoundary, + region +) +SELECT + '{{ Path }}', + '{{ ManagedPolicyArns }}', + '{{ Policies }}', + '{{ UserName }}', + '{{ Groups }}', + '{{ LoginProfile }}', + '{{ Tags }}', + '{{ PermissionsBoundary }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user + props: + - name: Path + value: '{{ Path }}' + - name: ManagedPolicyArns + value: + - '{{ ManagedPolicyArns[0] }}' + - name: Policies + value: + - PolicyDocument: {} + PolicyName: '{{ PolicyName }}' + - name: UserName + value: '{{ UserName }}' + - name: Groups + value: + - '{{ Groups[0] }}' + - name: LoginProfile + value: + PasswordResetRequired: '{{ PasswordResetRequired }}' + Password: '{{ Password }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: PermissionsBoundary + value: '{{ PermissionsBoundary }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.users +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### 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 +``` + +### List +```json +iam:listUsers +``` diff --git a/website/docs/services/iam/users_list_only/index.md b/website/docs/services/iam/users_list_only/index.md new file mode 100644 index 0000000..8666acb --- /dev/null +++ b/website/docs/services/iam/users_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - users_list_only + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists users in a region or regions, for all properties use users + +## Overview + + + + + + + +
Nameusers_list_only
TypeResource
DescriptionCreates a new IAM user for your AWS-account.
For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the user to create. Do not include the path in this value.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all users in a region. +```sql +SELECT +region, +user_name +FROM aws.iam.users_list_only +; +``` + + +## Permissions + +For permissions required to operate on the users_list_only resource, see users + diff --git a/website/docs/services/iam/virtualmfa_device_tags/index.md b/website/docs/services/iam/virtualmfa_device_tags/index.md new file mode 100644 index 0000000..190b832 --- /dev/null +++ b/website/docs/services/iam/virtualmfa_device_tags/index.md @@ -0,0 +1,83 @@ +--- +title: virtualmfa_device_tags +hide_title: false +hide_table_of_contents: false +keywords: + - virtualmfa_device_tags + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for virtualmfa_devices in a region + +## Overview + + + + + + + +
Namevirtualmfa_device_tags
TypeResource
DescriptionResource Type definition for AWS::IAM::VirtualMFADevice
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all virtualmfa_devices in a region. +```sql +SELECT +region, +virtual_mfa_device_name, +path, +serial_number, +users, +tag_key, +tag_value +FROM aws.iam.virtualmfa_device_tags +; +``` + + +## Permissions + +For permissions required to operate on the virtualmfa_device_tags resource, see virtualmfa_devices + diff --git a/website/docs/services/iam/virtualmfa_devices/index.md b/website/docs/services/iam/virtualmfa_devices/index.md new file mode 100644 index 0000000..bd68a69 --- /dev/null +++ b/website/docs/services/iam/virtualmfa_devices/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a virtualmfa_device resource or lists virtualmfa_devices in a region + +## Overview + + + + + + + +
Namevirtualmfa_devices
TypeResource
DescriptionResource Type definition for AWS::IAM::VirtualMFADevice
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
array
stringAWS region.
+ +For more information, see AWS::IAM::VirtualMFADevice. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all virtualmfa_devices in a region. +```sql +SELECT +region, +virtual_mfa_device_name, +path, +serial_number, +users, +tags +FROM aws.iam.virtualmfa_devices +; +``` +Gets all properties from an individual virtualmfa_device. +```sql +SELECT +region, +virtual_mfa_device_name, +path, +serial_number, +users, +tags +FROM aws.iam.virtualmfa_devices +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new virtualmfa_device resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iam.virtualmfa_devices ( + Users, + region +) +SELECT +'{{ Users }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iam.virtualmfa_devices ( + VirtualMfaDeviceName, + Path, + Users, + Tags, + region +) +SELECT + '{{ VirtualMfaDeviceName }}', + '{{ Path }}', + '{{ Users }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: virtualmfa_device + props: + - name: VirtualMfaDeviceName + value: '{{ VirtualMfaDeviceName }}' + - name: Path + value: '{{ Path }}' + - name: Users + value: + - '{{ Users[0] }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iam.virtualmfa_devices +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the virtualmfa_devices resource, the following permissions are required: + +### Create +```json +iam:CreateVirtualMFADevice, +iam:EnableMFADevice, +iam:ListVirtualMFADevices +``` + +### Read +```json +iam:ListVirtualMFADevices +``` + +### Update +```json +iam:TagMFADevice, +iam:UntagMFADevice +``` + +### Delete +```json +iam:DeleteVirtualMFADevice, +iam:DeactivateMFADevice +``` + +### List +```json +iam:ListVirtualMFADevices +``` diff --git a/website/docs/services/iam/virtualmfa_devices_list_only/index.md b/website/docs/services/iam/virtualmfa_devices_list_only/index.md new file mode 100644 index 0000000..b8b1ccb --- /dev/null +++ b/website/docs/services/iam/virtualmfa_devices_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: virtualmfa_devices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - virtualmfa_devices_list_only + - iam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists virtualmfa_devices in a region or regions, for all properties use virtualmfa_devices + +## Overview + + + + + + + +
Namevirtualmfa_devices_list_only
TypeResource
DescriptionResource Type definition for AWS::IAM::VirtualMFADevice
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all virtualmfa_devices in a region. +```sql +SELECT +region, +serial_number +FROM aws.iam.virtualmfa_devices_list_only +; +``` + + +## Permissions + +For permissions required to operate on the virtualmfa_devices_list_only resource, see virtualmfa_devices + diff --git a/website/docs/services/identitystore/group_memberships/index.md b/website/docs/services/identitystore/group_memberships/index.md new file mode 100644 index 0000000..c9e781c --- /dev/null +++ b/website/docs/services/identitystore/group_memberships/index.md @@ -0,0 +1,208 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a group_membership resource or lists group_memberships in a region + +## Overview + + + + + + + +
Namegroup_memberships
TypeResource
DescriptionResource Type Definition for AWS:IdentityStore::GroupMembership
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for a group in the identity store.
stringThe globally unique identifier for the identity store.
objectAn object containing the identifier of a group member.
stringThe identifier for a GroupMembership in the identity store.
stringAWS region.
+ +For more information, see AWS::IdentityStore::GroupMembership. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all group_memberships in a region. +```sql +SELECT +region, +group_id, +identity_store_id, +member_id, +membership_id +FROM aws.identitystore.group_memberships +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual group_membership. +```sql +SELECT +region, +group_id, +identity_store_id, +member_id, +membership_id +FROM aws.identitystore.group_memberships +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new group_membership resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.identitystore.group_memberships ( + GroupId, + IdentityStoreId, + MemberId, + region +) +SELECT +'{{ GroupId }}', + '{{ IdentityStoreId }}', + '{{ MemberId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.identitystore.group_memberships ( + GroupId, + IdentityStoreId, + MemberId, + region +) +SELECT + '{{ GroupId }}', + '{{ IdentityStoreId }}', + '{{ MemberId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: group_membership + props: + - name: GroupId + value: '{{ GroupId }}' + - name: IdentityStoreId + value: '{{ IdentityStoreId }}' + - name: MemberId + value: + UserId: '{{ UserId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.identitystore.group_memberships +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the group_memberships resource, the following permissions are required: + +### Create +```json +identitystore:CreateGroupMembership, +identitystore:DescribeGroupMembership +``` + +### Read +```json +identitystore:DescribeGroupMembership +``` + +### Delete +```json +identitystore:DeleteGroupMembership, +identitystore:DescribeGroupMembership +``` + +### List +```json +identitystore:ListGroupMemberships +``` diff --git a/website/docs/services/identitystore/group_memberships_list_only/index.md b/website/docs/services/identitystore/group_memberships_list_only/index.md new file mode 100644 index 0000000..7340ee2 --- /dev/null +++ b/website/docs/services/identitystore/group_memberships_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: group_memberships_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - group_memberships_list_only + - identitystore + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists group_memberships in a region or regions, for all properties use group_memberships + +## Overview + + + + + + + +
Namegroup_memberships_list_only
TypeResource
DescriptionResource Type Definition for AWS:IdentityStore::GroupMembership
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe globally unique identifier for the identity store.
stringThe identifier for a GroupMembership in the identity store.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all group_memberships in a region. +```sql +SELECT +region, +membership_id, +identity_store_id +FROM aws.identitystore.group_memberships_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the group_memberships_list_only resource, see group_memberships + diff --git a/website/docs/services/identitystore/groups/index.md b/website/docs/services/identitystore/groups/index.md new file mode 100644 index 0000000..221dd8b --- /dev/null +++ b/website/docs/services/identitystore/groups/index.md @@ -0,0 +1,216 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a group resource or lists groups in a region + +## Overview + + + + + + + +
Namegroups
TypeResource
DescriptionResource Type definition for AWS::IdentityStore::Group
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringA string containing the description of the group.
stringA string containing the name of the group. This value is commonly displayed when the group is referenced.
stringThe unique identifier for a group in the identity store.
stringThe globally unique identifier for the identity store.
stringAWS region.
+ +For more information, see AWS::IdentityStore::Group. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all groups in a region. +```sql +SELECT +region, +description, +display_name, +group_id, +identity_store_id +FROM aws.identitystore.groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual group. +```sql +SELECT +region, +description, +display_name, +group_id, +identity_store_id +FROM aws.identitystore.groups +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.identitystore.groups ( + DisplayName, + IdentityStoreId, + region +) +SELECT +'{{ DisplayName }}', + '{{ IdentityStoreId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.identitystore.groups ( + Description, + DisplayName, + IdentityStoreId, + region +) +SELECT + '{{ Description }}', + '{{ DisplayName }}', + '{{ IdentityStoreId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: group + props: + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: IdentityStoreId + value: '{{ IdentityStoreId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.identitystore.groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +```json +identitystore:CreateGroup, +identitystore:DescribeGroup +``` + +### Read +```json +identitystore:DescribeGroup +``` + +### Update +```json +identitystore:DescribeGroup, +identitystore:UpdateGroup +``` + +### Delete +```json +identitystore:DescribeGroup, +identitystore:DeleteGroup +``` + +### List +```json +identitystore:ListGroups +``` diff --git a/website/docs/services/identitystore/groups_list_only/index.md b/website/docs/services/identitystore/groups_list_only/index.md new file mode 100644 index 0000000..a56200a --- /dev/null +++ b/website/docs/services/identitystore/groups_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - groups_list_only + - identitystore + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists groups in a region or regions, for all properties use groups + +## Overview + + + + + + + +
Namegroups_list_only
TypeResource
DescriptionResource Type definition for AWS::IdentityStore::Group
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe unique identifier for a group in the identity store.
stringThe globally unique identifier for the identity store.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all groups in a region. +```sql +SELECT +region, +group_id, +identity_store_id +FROM aws.identitystore.groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the groups_list_only resource, see groups + diff --git a/website/docs/services/identitystore/index.md b/website/docs/services/identitystore/index.md new file mode 100644 index 0000000..f2a25c4 --- /dev/null +++ b/website/docs/services/identitystore/index.md @@ -0,0 +1,39 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The identitystore service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/imagebuilder/component_tags/index.md b/website/docs/services/imagebuilder/component_tags/index.md new file mode 100644 index 0000000..6d1c763 --- /dev/null +++ b/website/docs/services/imagebuilder/component_tags/index.md @@ -0,0 +1,99 @@ +--- +title: component_tags +hide_title: false +hide_table_of_contents: false +keywords: + - component_tags + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for components in a region + +## Overview + + + + + + + +
Namecomponent_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Component
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the component.
stringThe name of the component.
stringThe version of the component.
stringThe description of the component.
stringThe change description of the component.
stringThe type of the component denotes whether the component is used to build the image or only to test it.
stringThe platform of the component.
stringThe data of the component.
stringThe KMS key identifier used to encrypt the component.
booleanThe encryption status of the component.
stringThe uri of the component.
arrayThe operating system (OS) version supported by the component.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all components in a region. +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +platform, +data, +kms_key_id, +encrypted, +uri, +supported_os_versions, +tag_key, +tag_value +FROM aws.imagebuilder.component_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_tags resource, see components + diff --git a/website/docs/services/imagebuilder/components/index.md b/website/docs/services/imagebuilder/components/index.md new file mode 100644 index 0000000..4928cac --- /dev/null +++ b/website/docs/services/imagebuilder/components/index.md @@ -0,0 +1,278 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a component resource or lists components in a region + +## Overview + + + + + + + +
Namecomponents
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Component
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the component.
stringThe name of the component.
stringThe version of the component.
stringThe description of the component.
stringThe change description of the component.
stringThe type of the component denotes whether the component is used to build the image or only to test it.
stringThe platform of the component.
stringThe data of the component.
stringThe KMS key identifier used to encrypt the component.
booleanThe encryption status of the component.
objectThe tags associated with the component.
stringThe uri of the component.
arrayThe operating system (OS) version supported by the component.
stringAWS region.
+ +For more information, see AWS::ImageBuilder::Component. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all components in a region. +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +platform, +data, +kms_key_id, +encrypted, +tags, +uri, +supported_os_versions +FROM aws.imagebuilder.components +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual component. +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +platform, +data, +kms_key_id, +encrypted, +tags, +uri, +supported_os_versions +FROM aws.imagebuilder.components +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new component resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.components ( + Name, + Version, + Platform, + region +) +SELECT +'{{ Name }}', + '{{ Version }}', + '{{ Platform }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.components ( + Name, + Version, + Description, + ChangeDescription, + Platform, + Data, + KmsKeyId, + Tags, + Uri, + SupportedOsVersions, + region +) +SELECT + '{{ Name }}', + '{{ Version }}', + '{{ Description }}', + '{{ ChangeDescription }}', + '{{ Platform }}', + '{{ Data }}', + '{{ KmsKeyId }}', + '{{ Tags }}', + '{{ Uri }}', + '{{ SupportedOsVersions }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: component + props: + - name: Name + value: '{{ Name }}' + - name: Version + value: '{{ Version }}' + - name: Description + value: '{{ Description }}' + - name: ChangeDescription + value: '{{ ChangeDescription }}' + - name: Platform + value: '{{ Platform }}' + - name: Data + value: '{{ Data }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: Tags + value: {} + - name: Uri + value: '{{ Uri }}' + - name: SupportedOsVersions + value: + - '{{ SupportedOsVersions[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.imagebuilder.components +WHERE data__Identifier = '' +AND 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:GenerateDataKeyPair, +kms:GenerateDataKeyPairWithoutPlaintext, +kms:GenerateDataKeyWithoutPlaintext, +kms:Encrypt, +kms:Decrypt, +s3:GetObject, +s3:HeadBucket, +s3:GetBucketLocation, +imagebuilder:TagResource, +imagebuilder:GetComponent, +imagebuilder:CreateComponent +``` + +### Read +```json +imagebuilder:GetComponent, +kms:Decrypt +``` + +### Delete +```json +imagebuilder:GetComponent, +imagebuilder:UnTagResource, +imagebuilder:DeleteComponent +``` + +### List +```json +imagebuilder:ListComponents, +imagebuilder:ListComponentBuildVersions +``` diff --git a/website/docs/services/imagebuilder/components_list_only/index.md b/website/docs/services/imagebuilder/components_list_only/index.md new file mode 100644 index 0000000..31f0f6e --- /dev/null +++ b/website/docs/services/imagebuilder/components_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: components_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - components_list_only + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists components in a region or regions, for all properties use components + +## Overview + + + + + + + +
Namecomponents_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Component
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the component.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all components in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.components_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the components_list_only resource, see components + diff --git a/website/docs/services/imagebuilder/container_recipe_tags/index.md b/website/docs/services/imagebuilder/container_recipe_tags/index.md new file mode 100644 index 0000000..d62c7a9 --- /dev/null +++ b/website/docs/services/imagebuilder/container_recipe_tags/index.md @@ -0,0 +1,105 @@ +--- +title: container_recipe_tags +hide_title: false +hide_table_of_contents: false +keywords: + - container_recipe_tags + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for container_recipes in a region + +## Overview + + + + + + + +
Namecontainer_recipe_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ContainerRecipe
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the container recipe.
stringThe name of the container recipe.
stringThe description of the container recipe.
stringThe semantic version of the container recipe (<major>.<minor>.<patch>).
arrayComponents for build and test that are included in the container recipe.
objectA group of options that can be used to configure an instance for building and testing container images.
stringDockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
stringThe S3 URI for the Dockerfile that will be used to build your container image.
stringSpecifies the operating system platform when you use a custom source image.
stringSpecifies the type of container, such as Docker.
stringSpecifies the operating system version for the source image.
objectThe destination repository for the container image.
stringIdentifies which KMS key is used to encrypt the container image.
stringThe source image for the container recipe.
stringThe working directory to be used during build and test workflows.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all container_recipes in a region. +```sql +SELECT +region, +arn, +name, +description, +version, +components, +instance_configuration, +dockerfile_template_data, +dockerfile_template_uri, +platform_override, +container_type, +image_os_version_override, +target_repository, +kms_key_id, +parent_image, +working_directory, +tag_key, +tag_value +FROM aws.imagebuilder.container_recipe_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_recipe_tags resource, see container_recipes + diff --git a/website/docs/services/imagebuilder/container_recipes/index.md b/website/docs/services/imagebuilder/container_recipes/index.md new file mode 100644 index 0000000..13b2061 --- /dev/null +++ b/website/docs/services/imagebuilder/container_recipes/index.md @@ -0,0 +1,355 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a container_recipe resource or lists container_recipes in a region + +## Overview + + + + + + + +
Namecontainer_recipes
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ContainerRecipe
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the container recipe.
stringThe name of the container recipe.
stringThe description of the container recipe.
stringThe semantic version of the container recipe (<major>.<minor>.<patch>).
arrayComponents for build and test that are included in the container recipe.
objectA group of options that can be used to configure an instance for building and testing container images.
stringDockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
stringThe S3 URI for the Dockerfile that will be used to build your container image.
stringSpecifies the operating system platform when you use a custom source image.
stringSpecifies the type of container, such as Docker.
stringSpecifies the operating system version for the source image.
objectThe destination repository for the container image.
stringIdentifies which KMS key is used to encrypt the container image.
stringThe source image for the container recipe.
stringThe working directory to be used during build and test workflows.
objectTags that are attached to the container recipe.
stringAWS region.
+ +For more information, see AWS::ImageBuilder::ContainerRecipe. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all container_recipes in a region. +```sql +SELECT +region, +arn, +name, +description, +version, +components, +instance_configuration, +dockerfile_template_data, +dockerfile_template_uri, +platform_override, +container_type, +image_os_version_override, +target_repository, +kms_key_id, +parent_image, +working_directory, +tags +FROM aws.imagebuilder.container_recipes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual container_recipe. +```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_recipes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new container_recipe resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.container_recipes ( + Name, + Description, + Version, + Components, + InstanceConfiguration, + DockerfileTemplateData, + DockerfileTemplateUri, + PlatformOverride, + ContainerType, + ImageOsVersionOverride, + TargetRepository, + KmsKeyId, + ParentImage, + WorkingDirectory, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ Description }}', + '{{ Version }}', + '{{ Components }}', + '{{ InstanceConfiguration }}', + '{{ DockerfileTemplateData }}', + '{{ DockerfileTemplateUri }}', + '{{ PlatformOverride }}', + '{{ ContainerType }}', + '{{ ImageOsVersionOverride }}', + '{{ TargetRepository }}', + '{{ KmsKeyId }}', + '{{ ParentImage }}', + '{{ WorkingDirectory }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.container_recipes ( + Name, + Description, + Version, + Components, + InstanceConfiguration, + DockerfileTemplateData, + DockerfileTemplateUri, + PlatformOverride, + ContainerType, + ImageOsVersionOverride, + TargetRepository, + KmsKeyId, + ParentImage, + WorkingDirectory, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Version }}', + '{{ Components }}', + '{{ InstanceConfiguration }}', + '{{ DockerfileTemplateData }}', + '{{ DockerfileTemplateUri }}', + '{{ PlatformOverride }}', + '{{ ContainerType }}', + '{{ ImageOsVersionOverride }}', + '{{ TargetRepository }}', + '{{ KmsKeyId }}', + '{{ ParentImage }}', + '{{ WorkingDirectory }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: container_recipe + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Version + value: '{{ Version }}' + - name: Components + value: + - ComponentArn: '{{ ComponentArn }}' + Parameters: + - Name: '{{ Name }}' + Value: + - '{{ Value[0] }}' + - name: InstanceConfiguration + value: + Image: '{{ Image }}' + BlockDeviceMappings: + - DeviceName: '{{ DeviceName }}' + VirtualName: '{{ VirtualName }}' + NoDevice: '{{ NoDevice }}' + Ebs: + Encrypted: '{{ Encrypted }}' + DeleteOnTermination: '{{ DeleteOnTermination }}' + Iops: '{{ Iops }}' + KmsKeyId: '{{ KmsKeyId }}' + SnapshotId: '{{ SnapshotId }}' + Throughput: '{{ Throughput }}' + VolumeSize: '{{ VolumeSize }}' + VolumeType: '{{ VolumeType }}' + - name: DockerfileTemplateData + value: '{{ DockerfileTemplateData }}' + - name: DockerfileTemplateUri + value: '{{ DockerfileTemplateUri }}' + - name: PlatformOverride + value: '{{ PlatformOverride }}' + - name: ContainerType + value: '{{ ContainerType }}' + - name: ImageOsVersionOverride + value: '{{ ImageOsVersionOverride }}' + - name: TargetRepository + value: + Service: '{{ Service }}' + RepositoryName: '{{ RepositoryName }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: ParentImage + value: '{{ ParentImage }}' + - name: WorkingDirectory + value: '{{ WorkingDirectory }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.imagebuilder.container_recipes +WHERE data__Identifier = '' +AND 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, +kms:GenerateDataKeyPair, +kms:GenerateDataKeyPairWithoutPlaintext, +kms:GenerateDataKeyWithoutPlaintext, +s3:GetObject, +s3:ListBucket, +ecr:DescribeRepositories, +ec2:DescribeImages +``` + +### Read +```json +imagebuilder:GetContainerRecipe, +kms:Decrypt +``` + +### Delete +```json +imagebuilder:UnTagResource, +imagebuilder:GetContainerRecipe, +imagebuilder:DeleteContainerRecipe +``` + +### List +```json +imagebuilder:ListContainerRecipes +``` diff --git a/website/docs/services/imagebuilder/container_recipes_list_only/index.md b/website/docs/services/imagebuilder/container_recipes_list_only/index.md new file mode 100644 index 0000000..9ce741e --- /dev/null +++ b/website/docs/services/imagebuilder/container_recipes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: container_recipes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - container_recipes_list_only + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists container_recipes in a region or regions, for all properties use container_recipes + +## Overview + + + + + + + +
Namecontainer_recipes_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ContainerRecipe
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the container recipe.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all container_recipes in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.container_recipes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_recipes_list_only resource, see container_recipes + diff --git a/website/docs/services/imagebuilder/distribution_configuration_tags/index.md b/website/docs/services/imagebuilder/distribution_configuration_tags/index.md new file mode 100644 index 0000000..5f0bac7 --- /dev/null +++ b/website/docs/services/imagebuilder/distribution_configuration_tags/index.md @@ -0,0 +1,83 @@ +--- +title: distribution_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - distribution_configuration_tags + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for distribution_configurations in a region + +## Overview + + + + + + + +
Namedistribution_configuration_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::DistributionConfiguration
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringThe name of the distribution configuration.
stringThe description of the distribution configuration.
arrayThe distributions of the distribution configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all distribution_configurations in a region. +```sql +SELECT +region, +arn, +name, +description, +distributions, +tag_key, +tag_value +FROM aws.imagebuilder.distribution_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the distribution_configuration_tags resource, see distribution_configurations + diff --git a/website/docs/services/imagebuilder/distribution_configurations/index.md b/website/docs/services/imagebuilder/distribution_configurations/index.md new file mode 100644 index 0000000..4ecc81e --- /dev/null +++ b/website/docs/services/imagebuilder/distribution_configurations/index.md @@ -0,0 +1,273 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a distribution_configuration resource or lists distribution_configurations in a region + +## Overview + + + + + + + +
Namedistribution_configurations
TypeResource
DescriptionResource schema for AWS::ImageBuilder::DistributionConfiguration
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringThe name of the distribution configuration.
stringThe description of the distribution configuration.
arrayThe distributions of the distribution configuration.
objectThe tags associated with the component.
stringAWS region.
+ +For more information, see AWS::ImageBuilder::DistributionConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all distribution_configurations in a region. +```sql +SELECT +region, +arn, +name, +description, +distributions, +tags +FROM aws.imagebuilder.distribution_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual distribution_configuration. +```sql +SELECT +region, +arn, +name, +description, +distributions, +tags +FROM aws.imagebuilder.distribution_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new distribution_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.distribution_configurations ( + Name, + Distributions, + region +) +SELECT +'{{ Name }}', + '{{ Distributions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.distribution_configurations ( + Name, + Description, + Distributions, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Distributions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: distribution_configuration + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Distributions + value: + - Region: '{{ Region }}' + AmiDistributionConfiguration: + Name: '{{ Name }}' + KmsKeyId: '{{ KmsKeyId }}' + Description: '{{ Description }}' + AmiTags: {} + TargetAccountIds: + - '{{ TargetAccountIds[0] }}' + LaunchPermissionConfiguration: + UserIds: + - '{{ UserIds[0] }}' + UserGroups: + - '{{ UserGroups[0] }}' + OrganizationArns: + - '{{ OrganizationArns[0] }}' + OrganizationalUnitArns: + - '{{ OrganizationalUnitArns[0] }}' + ContainerDistributionConfiguration: + Description: '{{ Description }}' + ContainerTags: + - '{{ ContainerTags[0] }}' + TargetRepository: + Service: '{{ Service }}' + RepositoryName: '{{ RepositoryName }}' + LicenseConfigurationArns: + - '{{ LicenseConfigurationArns[0] }}' + LaunchTemplateConfigurations: + - LaunchTemplateId: '{{ LaunchTemplateId }}' + AccountId: '{{ AccountId }}' + SetDefaultVersion: '{{ SetDefaultVersion }}' + FastLaunchConfigurations: + - AccountId: '{{ AccountId }}' + Enabled: '{{ Enabled }}' + LaunchTemplate: + LaunchTemplateId: '{{ LaunchTemplateId }}' + LaunchTemplateName: '{{ LaunchTemplateName }}' + LaunchTemplateVersion: '{{ LaunchTemplateVersion }}' + MaxParallelLaunches: '{{ MaxParallelLaunches }}' + SnapshotConfiguration: + TargetResourceCount: '{{ TargetResourceCount }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.imagebuilder.distribution_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +ec2:DescribeLaunchTemplates, +ec2:CreateLaunchTemplateVersion, +ec2:ModifyLaunchTemplate, +imagebuilder:GetDistributionConfiguration, +imagebuilder:UpdateDistributionConfiguration +``` + +### Read +```json +imagebuilder:GetDistributionConfiguration +``` + +### Delete +```json +imagebuilder:GetDistributionConfiguration, +imagebuilder:UnTagResource, +imagebuilder:DeleteDistributionConfiguration +``` + +### List +```json +imagebuilder:ListDistributionConfigurations +``` diff --git a/website/docs/services/imagebuilder/distribution_configurations_list_only/index.md b/website/docs/services/imagebuilder/distribution_configurations_list_only/index.md new file mode 100644 index 0000000..c8f3cad --- /dev/null +++ b/website/docs/services/imagebuilder/distribution_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: distribution_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - distribution_configurations_list_only + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists distribution_configurations in a region or regions, for all properties use distribution_configurations + +## Overview + + + + + + + +
Namedistribution_configurations_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::DistributionConfiguration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all distribution_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.distribution_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the distribution_configurations_list_only resource, see distribution_configurations + diff --git a/website/docs/services/imagebuilder/image_pipeline_tags/index.md b/website/docs/services/imagebuilder/image_pipeline_tags/index.md new file mode 100644 index 0000000..b502523 --- /dev/null +++ b/website/docs/services/imagebuilder/image_pipeline_tags/index.md @@ -0,0 +1,103 @@ +--- +title: image_pipeline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - image_pipeline_tags + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for image_pipelines in a region + +## Overview + + + + + + + +
Nameimage_pipeline_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ImagePipeline
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image pipeline.
stringThe name of the image pipeline.
stringThe description of the image pipeline.
objectThe image tests configuration of the image pipeline.
stringThe status of the image pipeline.
objectThe schedule of the image pipeline.
stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
stringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
arrayWorkflows to define the image build process
booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
objectContains settings for vulnerability scans.
stringThe execution role name/ARN for the image build, if provided
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all image_pipelines in a region. +```sql +SELECT +region, +arn, +name, +description, +image_tests_configuration, +status, +schedule, +image_recipe_arn, +container_recipe_arn, +distribution_configuration_arn, +infrastructure_configuration_arn, +workflows, +enhanced_image_metadata_enabled, +image_scanning_configuration, +execution_role, +tag_key, +tag_value +FROM aws.imagebuilder.image_pipeline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_pipeline_tags resource, see image_pipelines + diff --git a/website/docs/services/imagebuilder/image_pipelines/index.md b/website/docs/services/imagebuilder/image_pipelines/index.md new file mode 100644 index 0000000..c0001bf --- /dev/null +++ b/website/docs/services/imagebuilder/image_pipelines/index.md @@ -0,0 +1,346 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an image_pipeline resource or lists image_pipelines in a region + +## Overview + + + + + + + +
Nameimage_pipelines
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ImagePipeline
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image pipeline.
stringThe name of the image pipeline.
stringThe description of the image pipeline.
objectThe image tests configuration of the image pipeline.
stringThe status of the image pipeline.
objectThe schedule of the image pipeline.
stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
stringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
arrayWorkflows to define the image build process
booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
objectContains settings for vulnerability scans.
stringThe execution role name/ARN for the image build, if provided
objectThe tags of this image pipeline.
stringAWS region.
+ +For more information, see AWS::ImageBuilder::ImagePipeline. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all image_pipelines in a region. +```sql +SELECT +region, +arn, +name, +description, +image_tests_configuration, +status, +schedule, +image_recipe_arn, +container_recipe_arn, +distribution_configuration_arn, +infrastructure_configuration_arn, +workflows, +enhanced_image_metadata_enabled, +image_scanning_configuration, +execution_role, +tags +FROM aws.imagebuilder.image_pipelines +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual image_pipeline. +```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_pipelines +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new image_pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.image_pipelines ( + Name, + Description, + ImageTestsConfiguration, + Status, + Schedule, + ImageRecipeArn, + ContainerRecipeArn, + DistributionConfigurationArn, + InfrastructureConfigurationArn, + Workflows, + EnhancedImageMetadataEnabled, + ImageScanningConfiguration, + ExecutionRole, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ Description }}', + '{{ ImageTestsConfiguration }}', + '{{ Status }}', + '{{ Schedule }}', + '{{ ImageRecipeArn }}', + '{{ ContainerRecipeArn }}', + '{{ DistributionConfigurationArn }}', + '{{ InfrastructureConfigurationArn }}', + '{{ Workflows }}', + '{{ EnhancedImageMetadataEnabled }}', + '{{ ImageScanningConfiguration }}', + '{{ ExecutionRole }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.image_pipelines ( + Name, + Description, + ImageTestsConfiguration, + Status, + Schedule, + ImageRecipeArn, + ContainerRecipeArn, + DistributionConfigurationArn, + InfrastructureConfigurationArn, + Workflows, + EnhancedImageMetadataEnabled, + ImageScanningConfiguration, + ExecutionRole, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ ImageTestsConfiguration }}', + '{{ Status }}', + '{{ Schedule }}', + '{{ ImageRecipeArn }}', + '{{ ContainerRecipeArn }}', + '{{ DistributionConfigurationArn }}', + '{{ InfrastructureConfigurationArn }}', + '{{ Workflows }}', + '{{ EnhancedImageMetadataEnabled }}', + '{{ ImageScanningConfiguration }}', + '{{ ExecutionRole }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: image_pipeline + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: ImageTestsConfiguration + value: + ImageTestsEnabled: '{{ ImageTestsEnabled }}' + TimeoutMinutes: '{{ TimeoutMinutes }}' + - name: Status + value: '{{ Status }}' + - name: Schedule + value: + ScheduleExpression: '{{ ScheduleExpression }}' + PipelineExecutionStartCondition: '{{ PipelineExecutionStartCondition }}' + - name: ImageRecipeArn + value: '{{ ImageRecipeArn }}' + - name: ContainerRecipeArn + value: '{{ ContainerRecipeArn }}' + - name: DistributionConfigurationArn + value: '{{ DistributionConfigurationArn }}' + - name: InfrastructureConfigurationArn + value: '{{ InfrastructureConfigurationArn }}' + - name: Workflows + value: + - WorkflowArn: '{{ WorkflowArn }}' + Parameters: + - Name: '{{ Name }}' + Value: + - '{{ Value[0] }}' + ParallelGroup: '{{ ParallelGroup }}' + OnFailure: '{{ OnFailure }}' + - name: EnhancedImageMetadataEnabled + value: '{{ EnhancedImageMetadataEnabled }}' + - name: ImageScanningConfiguration + value: + EcrConfiguration: + ContainerTags: + - '{{ ContainerTags[0] }}' + RepositoryName: '{{ RepositoryName }}' + ImageScanningEnabled: '{{ ImageScanningEnabled }}' + - name: ExecutionRole + value: '{{ ExecutionRole }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.imagebuilder.image_pipelines +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +iam:PassRole, +imagebuilder:GetImagePipeline, +imagebuilder:UpdateImagePipeline, +imagebuilder:GetWorkflow +``` + +### Read +```json +imagebuilder:GetImagePipeline +``` + +### Delete +```json +imagebuilder:UnTagResource, +imagebuilder:GetImagePipeline, +imagebuilder:DeleteImagePipeline +``` + +### List +```json +imagebuilder:ListImagePipelines +``` diff --git a/website/docs/services/imagebuilder/image_pipelines_list_only/index.md b/website/docs/services/imagebuilder/image_pipelines_list_only/index.md new file mode 100644 index 0000000..8c93091 --- /dev/null +++ b/website/docs/services/imagebuilder/image_pipelines_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: image_pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - image_pipelines_list_only + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists image_pipelines in a region or regions, for all properties use image_pipelines + +## Overview + + + + + + + +
Nameimage_pipelines_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ImagePipeline
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image pipeline.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all image_pipelines in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.image_pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_pipelines_list_only resource, see image_pipelines + diff --git a/website/docs/services/imagebuilder/image_recipe_tags/index.md b/website/docs/services/imagebuilder/image_recipe_tags/index.md new file mode 100644 index 0000000..89c6eae --- /dev/null +++ b/website/docs/services/imagebuilder/image_recipe_tags/index.md @@ -0,0 +1,93 @@ +--- +title: image_recipe_tags +hide_title: false +hide_table_of_contents: false +keywords: + - image_recipe_tags + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for image_recipes in a region + +## Overview + + + + + + + +
Nameimage_recipe_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ImageRecipe
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image recipe.
stringThe name of the image recipe.
stringThe description of the image recipe.
stringThe version of the image recipe.
arrayThe components of the image recipe.
arrayThe block device mappings to apply when creating images from this recipe.
stringThe parent image of the image recipe.
stringThe working directory to be used during build and test workflows.
objectSpecify additional settings and launch scripts for your build instances.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all image_recipes in a region. +```sql +SELECT +region, +arn, +name, +description, +version, +components, +block_device_mappings, +parent_image, +working_directory, +additional_instance_configuration, +tag_key, +tag_value +FROM aws.imagebuilder.image_recipe_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_recipe_tags resource, see image_recipes + diff --git a/website/docs/services/imagebuilder/image_recipes/index.md b/website/docs/services/imagebuilder/image_recipes/index.md new file mode 100644 index 0000000..c0941b1 --- /dev/null +++ b/website/docs/services/imagebuilder/image_recipes/index.md @@ -0,0 +1,278 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an image_recipe resource or lists image_recipes in a region + +## Overview + + + + + + + +
Nameimage_recipes
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ImageRecipe
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image recipe.
stringThe name of the image recipe.
stringThe description of the image recipe.
stringThe version of the image recipe.
arrayThe components of the image recipe.
arrayThe block device mappings to apply when creating images from this recipe.
stringThe parent image of the image recipe.
stringThe working directory to be used during build and test workflows.
objectSpecify additional settings and launch scripts for your build instances.
objectThe tags of the image recipe.
stringAWS region.
+ +For more information, see AWS::ImageBuilder::ImageRecipe. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all image_recipes in a region. +```sql +SELECT +region, +arn, +name, +description, +version, +components, +block_device_mappings, +parent_image, +working_directory, +additional_instance_configuration, +tags +FROM aws.imagebuilder.image_recipes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual image_recipe. +```sql +SELECT +region, +arn, +name, +description, +version, +components, +block_device_mappings, +parent_image, +working_directory, +additional_instance_configuration, +tags +FROM aws.imagebuilder.image_recipes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new image_recipe resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.image_recipes ( + Name, + Version, + Components, + ParentImage, + region +) +SELECT +'{{ Name }}', + '{{ Version }}', + '{{ Components }}', + '{{ ParentImage }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.image_recipes ( + Name, + Description, + Version, + Components, + BlockDeviceMappings, + ParentImage, + WorkingDirectory, + AdditionalInstanceConfiguration, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Version }}', + '{{ Components }}', + '{{ BlockDeviceMappings }}', + '{{ ParentImage }}', + '{{ WorkingDirectory }}', + '{{ AdditionalInstanceConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: image_recipe + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Version + value: '{{ Version }}' + - name: Components + value: + - ComponentArn: '{{ ComponentArn }}' + Parameters: + - Name: '{{ Name }}' + Value: + - '{{ Value[0] }}' + - name: BlockDeviceMappings + value: + - DeviceName: '{{ DeviceName }}' + VirtualName: '{{ VirtualName }}' + NoDevice: '{{ NoDevice }}' + Ebs: + Encrypted: '{{ Encrypted }}' + DeleteOnTermination: '{{ DeleteOnTermination }}' + Iops: '{{ Iops }}' + KmsKeyId: '{{ KmsKeyId }}' + SnapshotId: '{{ SnapshotId }}' + Throughput: '{{ Throughput }}' + VolumeSize: '{{ VolumeSize }}' + VolumeType: '{{ VolumeType }}' + - name: ParentImage + value: '{{ ParentImage }}' + - name: WorkingDirectory + value: '{{ WorkingDirectory }}' + - name: AdditionalInstanceConfiguration + value: + SystemsManagerAgent: + UninstallAfterBuild: '{{ UninstallAfterBuild }}' + UserDataOverride: '{{ UserDataOverride }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.imagebuilder.image_recipes +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +imagebuilder:GetImageRecipe +``` + +### Delete +```json +imagebuilder:UnTagResource, +imagebuilder:GetImageRecipe, +imagebuilder:DeleteImageRecipe +``` + +### List +```json +imagebuilder:ListImageRecipes +``` diff --git a/website/docs/services/imagebuilder/image_recipes_list_only/index.md b/website/docs/services/imagebuilder/image_recipes_list_only/index.md new file mode 100644 index 0000000..1a467e5 --- /dev/null +++ b/website/docs/services/imagebuilder/image_recipes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: image_recipes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - image_recipes_list_only + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists image_recipes in a region or regions, for all properties use image_recipes + +## Overview + + + + + + + +
Nameimage_recipes_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ImageRecipe
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image recipe.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all image_recipes in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.image_recipes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_recipes_list_only resource, see image_recipes + diff --git a/website/docs/services/imagebuilder/image_tags/index.md b/website/docs/services/imagebuilder/image_tags/index.md new file mode 100644 index 0000000..9885185 --- /dev/null +++ b/website/docs/services/imagebuilder/image_tags/index.md @@ -0,0 +1,101 @@ +--- +title: image_tags +hide_title: false +hide_table_of_contents: false +keywords: + - image_tags + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for images in a region + +## Overview + + + + + + + +
Nameimage_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Image
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectContains settings for vulnerability scans.
stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
arrayWorkflows to define the image build process
stringURI for containers created in current Region with default ECR image tag
stringThe name of the image.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringThe AMI ID of the EC2 AMI in current region.
objectThe image tests configuration used when creating this image.
stringThe Amazon Resource Name (ARN) of the image.
booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
stringThe execution role name/ARN for the image build, if provided
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all images in a region. +```sql +SELECT +region, +image_scanning_configuration, +container_recipe_arn, +workflows, +image_uri, +name, +infrastructure_configuration_arn, +image_recipe_arn, +distribution_configuration_arn, +image_id, +image_tests_configuration, +arn, +enhanced_image_metadata_enabled, +execution_role, +tag_key, +tag_value +FROM aws.imagebuilder.image_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_tags resource, see images + diff --git a/website/docs/services/imagebuilder/images/index.md b/website/docs/services/imagebuilder/images/index.md new file mode 100644 index 0000000..310c6fb --- /dev/null +++ b/website/docs/services/imagebuilder/images/index.md @@ -0,0 +1,306 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an image resource or lists images in a region + +## Overview + + + + + + + +
Nameimages
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Image
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectContains settings for vulnerability scans.
stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
arrayWorkflows to define the image build process
stringURI for containers created in current Region with default ECR image tag
stringThe name of the image.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringThe AMI ID of the EC2 AMI in current region.
objectThe image tests configuration used when creating this image.
stringThe Amazon Resource Name (ARN) of the image.
booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
stringThe execution role name/ARN for the image build, if provided
objectThe tags associated with the image.
stringAWS region.
+ +For more information, see AWS::ImageBuilder::Image. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all images in a region. +```sql +SELECT +region, +image_scanning_configuration, +container_recipe_arn, +workflows, +image_uri, +name, +infrastructure_configuration_arn, +image_recipe_arn, +distribution_configuration_arn, +image_id, +image_tests_configuration, +arn, +enhanced_image_metadata_enabled, +execution_role, +tags +FROM aws.imagebuilder.images +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual image. +```sql +SELECT +region, +image_scanning_configuration, +container_recipe_arn, +workflows, +image_uri, +name, +infrastructure_configuration_arn, +image_recipe_arn, +distribution_configuration_arn, +image_id, +image_tests_configuration, +arn, +enhanced_image_metadata_enabled, +execution_role, +tags +FROM aws.imagebuilder.images +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new image resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.images ( + ImageScanningConfiguration, + ContainerRecipeArn, + Workflows, + InfrastructureConfigurationArn, + ImageRecipeArn, + DistributionConfigurationArn, + ImageTestsConfiguration, + EnhancedImageMetadataEnabled, + ExecutionRole, + Tags, + region +) +SELECT +'{{ ImageScanningConfiguration }}', + '{{ ContainerRecipeArn }}', + '{{ Workflows }}', + '{{ InfrastructureConfigurationArn }}', + '{{ ImageRecipeArn }}', + '{{ DistributionConfigurationArn }}', + '{{ ImageTestsConfiguration }}', + '{{ EnhancedImageMetadataEnabled }}', + '{{ ExecutionRole }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.images ( + ImageScanningConfiguration, + ContainerRecipeArn, + Workflows, + InfrastructureConfigurationArn, + ImageRecipeArn, + DistributionConfigurationArn, + ImageTestsConfiguration, + EnhancedImageMetadataEnabled, + ExecutionRole, + Tags, + region +) +SELECT + '{{ ImageScanningConfiguration }}', + '{{ ContainerRecipeArn }}', + '{{ Workflows }}', + '{{ InfrastructureConfigurationArn }}', + '{{ ImageRecipeArn }}', + '{{ DistributionConfigurationArn }}', + '{{ ImageTestsConfiguration }}', + '{{ EnhancedImageMetadataEnabled }}', + '{{ ExecutionRole }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: image + props: + - name: ImageScanningConfiguration + value: + EcrConfiguration: + ContainerTags: + - '{{ ContainerTags[0] }}' + RepositoryName: '{{ RepositoryName }}' + ImageScanningEnabled: '{{ ImageScanningEnabled }}' + - name: ContainerRecipeArn + value: '{{ ContainerRecipeArn }}' + - name: Workflows + value: + - WorkflowArn: '{{ WorkflowArn }}' + Parameters: + - Name: '{{ Name }}' + Value: + - '{{ Value[0] }}' + ParallelGroup: '{{ ParallelGroup }}' + OnFailure: '{{ OnFailure }}' + - name: InfrastructureConfigurationArn + value: '{{ InfrastructureConfigurationArn }}' + - name: ImageRecipeArn + value: '{{ ImageRecipeArn }}' + - name: DistributionConfigurationArn + value: '{{ DistributionConfigurationArn }}' + - name: ImageTestsConfiguration + value: + ImageTestsEnabled: '{{ ImageTestsEnabled }}' + TimeoutMinutes: '{{ TimeoutMinutes }}' + - name: EnhancedImageMetadataEnabled + value: '{{ EnhancedImageMetadataEnabled }}' + - name: ExecutionRole + value: '{{ ExecutionRole }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.imagebuilder.images +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the images resource, the following permissions are required: + +### Read +```json +imagebuilder:GetImage +``` + +### 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, +imagebuilder:ListImageBuildVersions +``` + +### Delete +```json +imagebuilder:GetImage, +imagebuilder:DeleteImage, +imagebuilder:UnTagResource, +imagebuilder:CancelImageCreation +``` diff --git a/website/docs/services/imagebuilder/images_list_only/index.md b/website/docs/services/imagebuilder/images_list_only/index.md new file mode 100644 index 0000000..e1b8b97 --- /dev/null +++ b/website/docs/services/imagebuilder/images_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: images_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - images_list_only + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists images in a region or regions, for all properties use images + +## Overview + + + + + + + +
Nameimages_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Image
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all images in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.images_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the images_list_only resource, see images + diff --git a/website/docs/services/imagebuilder/index.md b/website/docs/services/imagebuilder/index.md new file mode 100644 index 0000000..f4d5e25 --- /dev/null +++ b/website/docs/services/imagebuilder/index.md @@ -0,0 +1,62 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The imagebuilder service documentation. + +:::info Service Summary + +
+
+total resources: 27
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/imagebuilder/infrastructure_configuration_tags/index.md b/website/docs/services/imagebuilder/infrastructure_configuration_tags/index.md new file mode 100644 index 0000000..85aac1e --- /dev/null +++ b/website/docs/services/imagebuilder/infrastructure_configuration_tags/index.md @@ -0,0 +1,103 @@ +--- +title: infrastructure_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - infrastructure_configuration_tags + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for infrastructure_configurations in a region + +## Overview + + + + + + + +
Nameinfrastructure_configuration_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::InfrastructureConfiguration
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
stringThe name of the infrastructure configuration.
stringThe description of the infrastructure configuration.
arrayThe instance types of the infrastructure configuration.
arrayThe security group IDs of the infrastructure configuration.
objectThe logging configuration of the infrastructure configuration.
stringThe subnet ID of the infrastructure configuration.
stringThe EC2 key pair of the infrastructure configuration..
booleanThe terminate instance on failure configuration of the infrastructure configuration.
stringThe instance profile of the infrastructure configuration.
objectThe instance metadata option settings for the infrastructure configuration.
stringThe SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration.
objectThe tags attached to the resource created by Image Builder.
objectThe placement option settings for the infrastructure configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all infrastructure_configurations in a region. +```sql +SELECT +region, +arn, +name, +description, +instance_types, +security_group_ids, +logging, +subnet_id, +key_pair, +terminate_instance_on_failure, +instance_profile_name, +instance_metadata_options, +sns_topic_arn, +resource_tags, +placement, +tag_key, +tag_value +FROM aws.imagebuilder.infrastructure_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the infrastructure_configuration_tags resource, see infrastructure_configurations + diff --git a/website/docs/services/imagebuilder/infrastructure_configurations/index.md b/website/docs/services/imagebuilder/infrastructure_configurations/index.md new file mode 100644 index 0000000..46f0f25 --- /dev/null +++ b/website/docs/services/imagebuilder/infrastructure_configurations/index.md @@ -0,0 +1,313 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an infrastructure_configuration resource or lists infrastructure_configurations in a region + +## Overview + + + + + + + +
Nameinfrastructure_configurations
TypeResource
DescriptionResource schema for AWS::ImageBuilder::InfrastructureConfiguration
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
stringThe name of the infrastructure configuration.
stringThe description of the infrastructure configuration.
arrayThe instance types of the infrastructure configuration.
arrayThe security group IDs of the infrastructure configuration.
objectThe logging configuration of the infrastructure configuration.
stringThe subnet ID of the infrastructure configuration.
stringThe EC2 key pair of the infrastructure configuration..
booleanThe terminate instance on failure configuration of the infrastructure configuration.
stringThe instance profile of the infrastructure configuration.
objectThe instance metadata option settings for the infrastructure configuration.
stringThe SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration.
objectThe tags attached to the resource created by Image Builder.
objectThe tags associated with the component.
objectThe placement option settings for the infrastructure configuration.
stringAWS region.
+ +For more information, see AWS::ImageBuilder::InfrastructureConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all infrastructure_configurations in a region. +```sql +SELECT +region, +arn, +name, +description, +instance_types, +security_group_ids, +logging, +subnet_id, +key_pair, +terminate_instance_on_failure, +instance_profile_name, +instance_metadata_options, +sns_topic_arn, +resource_tags, +tags, +placement +FROM aws.imagebuilder.infrastructure_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual infrastructure_configuration. +```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, +placement +FROM aws.imagebuilder.infrastructure_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new infrastructure_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.infrastructure_configurations ( + Name, + InstanceProfileName, + region +) +SELECT +'{{ Name }}', + '{{ InstanceProfileName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.infrastructure_configurations ( + Name, + Description, + InstanceTypes, + SecurityGroupIds, + Logging, + SubnetId, + KeyPair, + TerminateInstanceOnFailure, + InstanceProfileName, + InstanceMetadataOptions, + SnsTopicArn, + ResourceTags, + Tags, + Placement, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ InstanceTypes }}', + '{{ SecurityGroupIds }}', + '{{ Logging }}', + '{{ SubnetId }}', + '{{ KeyPair }}', + '{{ TerminateInstanceOnFailure }}', + '{{ InstanceProfileName }}', + '{{ InstanceMetadataOptions }}', + '{{ SnsTopicArn }}', + '{{ ResourceTags }}', + '{{ Tags }}', + '{{ Placement }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: infrastructure_configuration + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: InstanceTypes + value: + - '{{ InstanceTypes[0] }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: Logging + value: + S3Logs: + S3BucketName: '{{ S3BucketName }}' + S3KeyPrefix: '{{ S3KeyPrefix }}' + - name: SubnetId + value: '{{ SubnetId }}' + - name: KeyPair + value: '{{ KeyPair }}' + - name: TerminateInstanceOnFailure + value: '{{ TerminateInstanceOnFailure }}' + - name: InstanceProfileName + value: '{{ InstanceProfileName }}' + - name: InstanceMetadataOptions + value: + HttpPutResponseHopLimit: '{{ HttpPutResponseHopLimit }}' + HttpTokens: '{{ HttpTokens }}' + - name: SnsTopicArn + value: '{{ SnsTopicArn }}' + - name: ResourceTags + value: {} + - name: Tags + value: {} + - name: Placement + value: + AvailabilityZone: '{{ AvailabilityZone }}' + Tenancy: '{{ Tenancy }}' + HostId: '{{ HostId }}' + HostResourceGroupArn: '{{ HostResourceGroupArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.imagebuilder.infrastructure_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +iam:PassRole, +sns:Publish, +imagebuilder:GetInfrastructureConfiguration, +imagebuilder:UpdateInfrastructureConfiguration +``` + +### Read +```json +imagebuilder:GetInfrastructureConfiguration +``` + +### Delete +```json +imagebuilder:UnTagResource, +imagebuilder:GetInfrastructureConfiguration, +imagebuilder:DeleteInfrastructureConfiguration +``` + +### List +```json +imagebuilder:ListInfrastructureConfigurations +``` diff --git a/website/docs/services/imagebuilder/infrastructure_configurations_list_only/index.md b/website/docs/services/imagebuilder/infrastructure_configurations_list_only/index.md new file mode 100644 index 0000000..91f7426 --- /dev/null +++ b/website/docs/services/imagebuilder/infrastructure_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: infrastructure_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - infrastructure_configurations_list_only + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists infrastructure_configurations in a region or regions, for all properties use infrastructure_configurations + +## Overview + + + + + + + +
Nameinfrastructure_configurations_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::InfrastructureConfiguration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all infrastructure_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.infrastructure_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the infrastructure_configurations_list_only resource, see infrastructure_configurations + diff --git a/website/docs/services/imagebuilder/lifecycle_policies/index.md b/website/docs/services/imagebuilder/lifecycle_policies/index.md new file mode 100644 index 0000000..d6af099 --- /dev/null +++ b/website/docs/services/imagebuilder/lifecycle_policies/index.md @@ -0,0 +1,288 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a lifecycle_policy resource or lists lifecycle_policies in a region + +## Overview + + + + + + + +
Namelifecycle_policies
TypeResource
DescriptionResource schema for AWS::ImageBuilder::LifecyclePolicy
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the lifecycle policy.
stringThe name of the lifecycle policy.
stringThe description of the lifecycle policy.
stringThe status of the lifecycle policy.
stringThe execution role of the lifecycle policy.
stringThe resource type of the lifecycle policy.
arrayThe policy details of the lifecycle policy.
objectThe resource selection of the lifecycle policy.
objectThe tags associated with the lifecycle policy.
stringAWS region.
+ +For more information, see AWS::ImageBuilder::LifecyclePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all lifecycle_policies in a region. +```sql +SELECT +region, +arn, +name, +description, +status, +execution_role, +resource_type, +policy_details, +resource_selection, +tags +FROM aws.imagebuilder.lifecycle_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual lifecycle_policy. +```sql +SELECT +region, +arn, +name, +description, +status, +execution_role, +resource_type, +policy_details, +resource_selection, +tags +FROM aws.imagebuilder.lifecycle_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new lifecycle_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.lifecycle_policies ( + Name, + ExecutionRole, + ResourceType, + PolicyDetails, + ResourceSelection, + region +) +SELECT +'{{ Name }}', + '{{ ExecutionRole }}', + '{{ ResourceType }}', + '{{ PolicyDetails }}', + '{{ ResourceSelection }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.lifecycle_policies ( + Name, + Description, + Status, + ExecutionRole, + ResourceType, + PolicyDetails, + ResourceSelection, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Status }}', + '{{ ExecutionRole }}', + '{{ ResourceType }}', + '{{ PolicyDetails }}', + '{{ ResourceSelection }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: lifecycle_policy + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Status + value: '{{ Status }}' + - name: ExecutionRole + value: '{{ ExecutionRole }}' + - name: ResourceType + value: '{{ ResourceType }}' + - name: PolicyDetails + value: + - Action: + Type: '{{ Type }}' + IncludeResources: + Amis: '{{ Amis }}' + Containers: '{{ Containers }}' + Snapshots: '{{ Snapshots }}' + Filter: + Type: '{{ Type }}' + Value: '{{ Value }}' + Unit: '{{ Unit }}' + RetainAtLeast: '{{ RetainAtLeast }}' + ExclusionRules: + TagMap: {} + Amis: + IsPublic: '{{ IsPublic }}' + Regions: + - '{{ Regions[0] }}' + SharedAccounts: + - '{{ SharedAccounts[0] }}' + LastLaunched: + Value: '{{ Value }}' + Unit: null + TagMap: {} + - name: ResourceSelection + value: + Recipes: + - Name: '{{ Name }}' + SemanticVersion: '{{ SemanticVersion }}' + TagMap: {} + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.imagebuilder.lifecycle_policies +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +iam:PassRole, +imagebuilder:GetLifecyclePolicy, +imagebuilder:UpdateLifecyclePolicy +``` + +### Read +```json +imagebuilder:GetLifecyclePolicy +``` + +### Delete +```json +imagebuilder:GetLifecyclePolicy, +imagebuilder:DeleteLifecyclePolicy, +imagebuilder:UnTagResource +``` + +### List +```json +imagebuilder:ListLifecyclePolicies +``` diff --git a/website/docs/services/imagebuilder/lifecycle_policies_list_only/index.md b/website/docs/services/imagebuilder/lifecycle_policies_list_only/index.md new file mode 100644 index 0000000..9a2f750 --- /dev/null +++ b/website/docs/services/imagebuilder/lifecycle_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: lifecycle_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_policies_list_only + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists lifecycle_policies in a region or regions, for all properties use lifecycle_policies + +## Overview + + + + + + + +
Namelifecycle_policies_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::LifecyclePolicy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the lifecycle policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all lifecycle_policies in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.lifecycle_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lifecycle_policies_list_only resource, see lifecycle_policies + diff --git a/website/docs/services/imagebuilder/lifecycle_policy_tags/index.md b/website/docs/services/imagebuilder/lifecycle_policy_tags/index.md new file mode 100644 index 0000000..d9aa439 --- /dev/null +++ b/website/docs/services/imagebuilder/lifecycle_policy_tags/index.md @@ -0,0 +1,91 @@ +--- +title: lifecycle_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_policy_tags + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for lifecycle_policies in a region + +## Overview + + + + + + + +
Namelifecycle_policy_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::LifecyclePolicy
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the lifecycle policy.
stringThe name of the lifecycle policy.
stringThe description of the lifecycle policy.
stringThe status of the lifecycle policy.
stringThe execution role of the lifecycle policy.
stringThe resource type of the lifecycle policy.
arrayThe policy details of the lifecycle policy.
objectThe resource selection of the lifecycle policy.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all lifecycle_policies in a region. +```sql +SELECT +region, +arn, +name, +description, +status, +execution_role, +resource_type, +policy_details, +resource_selection, +tag_key, +tag_value +FROM aws.imagebuilder.lifecycle_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lifecycle_policy_tags resource, see lifecycle_policies + diff --git a/website/docs/services/imagebuilder/workflow_tags/index.md b/website/docs/services/imagebuilder/workflow_tags/index.md new file mode 100644 index 0000000..9e5d119 --- /dev/null +++ b/website/docs/services/imagebuilder/workflow_tags/index.md @@ -0,0 +1,93 @@ +--- +title: workflow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workflow_tags + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workflows in a region + +## Overview + + + + + + + +
Nameworkflow_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Workflow
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the workflow.
stringThe name of the workflow.
stringThe version of the workflow.
stringThe description of the workflow.
stringThe change description of the workflow.
stringThe type of the workflow denotes whether the workflow is used to build, test, or distribute.
stringThe data of the workflow.
stringThe uri of the workflow.
stringThe KMS key identifier used to encrypt the workflow.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workflows in a region. +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +data, +uri, +kms_key_id, +tag_key, +tag_value +FROM aws.imagebuilder.workflow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflow_tags resource, see workflows + diff --git a/website/docs/services/imagebuilder/workflows/index.md b/website/docs/services/imagebuilder/workflows/index.md new file mode 100644 index 0000000..68c871f --- /dev/null +++ b/website/docs/services/imagebuilder/workflows/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a workflow resource or lists workflows in a region + +## Overview + + + + + + + +
Nameworkflows
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Workflow
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the workflow.
stringThe name of the workflow.
stringThe version of the workflow.
stringThe description of the workflow.
stringThe change description of the workflow.
stringThe type of the workflow denotes whether the workflow is used to build, test, or distribute.
stringThe data of the workflow.
stringThe uri of the workflow.
stringThe KMS key identifier used to encrypt the workflow.
objectThe tags associated with the workflow.
stringAWS region.
+ +For more information, see AWS::ImageBuilder::Workflow. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all workflows in a region. +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +data, +uri, +kms_key_id, +tags +FROM aws.imagebuilder.workflows +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual workflow. +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +data, +uri, +kms_key_id, +tags +FROM aws.imagebuilder.workflows +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workflow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.workflows ( + Name, + Version, + Type, + region +) +SELECT +'{{ Name }}', + '{{ Version }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.imagebuilder.workflows ( + Name, + Version, + Description, + ChangeDescription, + Type, + Data, + Uri, + KmsKeyId, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Version }}', + '{{ Description }}', + '{{ ChangeDescription }}', + '{{ Type }}', + '{{ Data }}', + '{{ Uri }}', + '{{ KmsKeyId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: workflow + props: + - name: Name + value: '{{ Name }}' + - name: Version + value: '{{ Version }}' + - name: Description + value: '{{ Description }}' + - name: ChangeDescription + value: '{{ ChangeDescription }}' + - name: Type + value: '{{ Type }}' + - name: Data + value: '{{ Data }}' + - name: Uri + value: '{{ Uri }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.imagebuilder.workflows +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the workflows resource, the following permissions are required: + +### Create +```json +iam:GetRole, +kms:GenerateDataKey, +kms:GenerateDataKeyPair, +kms:GenerateDataKeyPairWithoutPlaintext, +kms:GenerateDataKeyWithoutPlaintext, +kms:Encrypt, +kms:Decrypt, +s3:GetObject, +s3:HeadBucket, +s3:GetBucketLocation, +imagebuilder:TagResource, +imagebuilder:GetWorkflow, +imagebuilder:CreateWorkflow +``` + +### Read +```json +imagebuilder:GetWorkflow, +kms:Decrypt +``` + +### Delete +```json +imagebuilder:GetWorkflow, +imagebuilder:UnTagResource, +imagebuilder:DeleteWorkflow +``` + +### List +```json +imagebuilder:ListWorkflows, +imagebuilder:ListWorkflowBuildVersions +``` diff --git a/website/docs/services/imagebuilder/workflows_list_only/index.md b/website/docs/services/imagebuilder/workflows_list_only/index.md new file mode 100644 index 0000000..d961054 --- /dev/null +++ b/website/docs/services/imagebuilder/workflows_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: workflows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workflows_list_only + - imagebuilder + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workflows in a region or regions, for all properties use workflows + +## Overview + + + + + + + +
Nameworkflows_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Workflow
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the workflow.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workflows in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.workflows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflows_list_only resource, see workflows + diff --git a/website/docs/services/inspector/assessment_targets/index.md b/website/docs/services/inspector/assessment_targets/index.md new file mode 100644 index 0000000..113d8fa --- /dev/null +++ b/website/docs/services/inspector/assessment_targets/index.md @@ -0,0 +1,209 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an assessment_target resource or lists assessment_targets in a region + +## Overview + + + + + + + +
Nameassessment_targets
TypeResource
DescriptionResource Type definition for AWS::Inspector::AssessmentTarget
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +For more information, see AWS::Inspector::AssessmentTarget. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all assessment_targets in a region. +```sql +SELECT +region, +arn, +assessment_target_name, +resource_group_arn +FROM aws.inspector.assessment_targets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual assessment_target. +```sql +SELECT +region, +arn, +assessment_target_name, +resource_group_arn +FROM aws.inspector.assessment_targets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new assessment_target resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.inspector.assessment_targets ( + AssessmentTargetName, + ResourceGroupArn, + region +) +SELECT +'{{ AssessmentTargetName }}', + '{{ ResourceGroupArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.inspector.assessment_targets ( + AssessmentTargetName, + ResourceGroupArn, + region +) +SELECT + '{{ AssessmentTargetName }}', + '{{ ResourceGroupArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: assessment_target + props: + - name: AssessmentTargetName + value: '{{ AssessmentTargetName }}' + - name: ResourceGroupArn + value: '{{ ResourceGroupArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.inspector.assessment_targets +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +inspector:DescribeAssessmentTargets, +inspector:UpdateAssessmentTarget +``` + +### Read +```json +inspector:DescribeAssessmentTargets +``` + +### Delete +```json +inspector:DeleteAssessmentTarget +``` + +### List +```json +inspector:ListAssessmentTargets +``` diff --git a/website/docs/services/inspector/assessment_targets_list_only/index.md b/website/docs/services/inspector/assessment_targets_list_only/index.md new file mode 100644 index 0000000..4c20216 --- /dev/null +++ b/website/docs/services/inspector/assessment_targets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: assessment_targets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assessment_targets_list_only + - inspector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assessment_targets in a region or regions, for all properties use assessment_targets + +## Overview + + + + + + + +
Nameassessment_targets_list_only
TypeResource
DescriptionResource Type definition for AWS::Inspector::AssessmentTarget
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assessment_targets in a region. +```sql +SELECT +region, +arn +FROM aws.inspector.assessment_targets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assessment_targets_list_only resource, see assessment_targets + diff --git a/website/docs/services/inspector/assessment_templates/index.md b/website/docs/services/inspector/assessment_templates/index.md new file mode 100644 index 0000000..9082a7e --- /dev/null +++ b/website/docs/services/inspector/assessment_templates/index.md @@ -0,0 +1,224 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an assessment_template resource or lists assessment_templates in a region + +## Overview + + + + + + + +
Nameassessment_templates
TypeResource
DescriptionResource Type definition for AWS::Inspector::AssessmentTemplate
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
string
array
array
stringAWS region.
+ +For more information, see AWS::Inspector::AssessmentTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all assessment_templates in a region. +```sql +SELECT +region, +arn, +assessment_target_arn, +duration_in_seconds, +assessment_template_name, +rules_package_arns, +user_attributes_for_findings +FROM aws.inspector.assessment_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual assessment_template. +```sql +SELECT +region, +arn, +assessment_target_arn, +duration_in_seconds, +assessment_template_name, +rules_package_arns, +user_attributes_for_findings +FROM aws.inspector.assessment_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new assessment_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.inspector.assessment_templates ( + AssessmentTargetArn, + DurationInSeconds, + RulesPackageArns, + region +) +SELECT +'{{ AssessmentTargetArn }}', + '{{ DurationInSeconds }}', + '{{ RulesPackageArns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.inspector.assessment_templates ( + AssessmentTargetArn, + DurationInSeconds, + AssessmentTemplateName, + RulesPackageArns, + UserAttributesForFindings, + region +) +SELECT + '{{ AssessmentTargetArn }}', + '{{ DurationInSeconds }}', + '{{ AssessmentTemplateName }}', + '{{ RulesPackageArns }}', + '{{ UserAttributesForFindings }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: assessment_template + props: + - name: AssessmentTargetArn + value: '{{ AssessmentTargetArn }}' + - name: DurationInSeconds + value: '{{ DurationInSeconds }}' + - name: AssessmentTemplateName + value: '{{ AssessmentTemplateName }}' + - name: RulesPackageArns + value: + - '{{ RulesPackageArns[0] }}' + - name: UserAttributesForFindings + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.inspector.assessment_templates +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +inspector:DescribeAssessmentTemplates +``` + +### Delete +```json +inspector:DeleteAssessmentTemplate +``` + +### List +```json +inspector:ListAssessmentTemplates +``` diff --git a/website/docs/services/inspector/assessment_templates_list_only/index.md b/website/docs/services/inspector/assessment_templates_list_only/index.md new file mode 100644 index 0000000..23fe3e6 --- /dev/null +++ b/website/docs/services/inspector/assessment_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: assessment_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assessment_templates_list_only + - inspector + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assessment_templates in a region or regions, for all properties use assessment_templates + +## Overview + + + + + + + +
Nameassessment_templates_list_only
TypeResource
DescriptionResource Type definition for AWS::Inspector::AssessmentTemplate
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assessment_templates in a region. +```sql +SELECT +region, +arn +FROM aws.inspector.assessment_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assessment_templates_list_only resource, see assessment_templates + diff --git a/website/docs/services/inspector/index.md b/website/docs/services/inspector/index.md new file mode 100644 index 0000000..2538bc7 --- /dev/null +++ b/website/docs/services/inspector/index.md @@ -0,0 +1,40 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The inspector service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/inspector/resource_groups/index.md b/website/docs/services/inspector/resource_groups/index.md new file mode 100644 index 0000000..6ffcfe9 --- /dev/null +++ b/website/docs/services/inspector/resource_groups/index.md @@ -0,0 +1,171 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_group resource or lists resource_groups in a region + +## Overview + + + + + + + +
Nameresource_groups
TypeResource
DescriptionResource Type definition for AWS::Inspector::ResourceGroup
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
array
stringAWS region.
+ +For more information, see AWS::Inspector::ResourceGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual resource_group. +```sql +SELECT +region, +arn, +resource_group_tags +FROM aws.inspector.resource_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.inspector.resource_groups ( + ResourceGroupTags, + region +) +SELECT +'{{ ResourceGroupTags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.inspector.resource_groups ( + ResourceGroupTags, + region +) +SELECT + '{{ ResourceGroupTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_group + props: + - name: ResourceGroupTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.inspector.resource_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_groups resource, the following permissions are required: + +### Create +```json +inspector:CreateResourceGroup +``` + +### Read +```json +inspector:CreateResourceGroup +``` + +### Delete +```json +inspector:CreateResourceGroup +``` diff --git a/website/docs/services/inspectorv2/cis_scan_configuration_tags/index.md b/website/docs/services/inspectorv2/cis_scan_configuration_tags/index.md new file mode 100644 index 0000000..7152571 --- /dev/null +++ b/website/docs/services/inspectorv2/cis_scan_configuration_tags/index.md @@ -0,0 +1,85 @@ +--- +title: cis_scan_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cis_scan_configuration_tags + - inspectorv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cis_scan_configurations in a region + +## Overview + + + + + + + +
Namecis_scan_configuration_tags
TypeResource
DescriptionCIS Scan Configuration resource schema
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of the scan
string
undefinedChoose a Schedule cadence
undefined
stringCIS Scan configuration unique identifier
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cis_scan_configurations in a region. +```sql +SELECT +region, +scan_name, +security_level, +schedule, +targets, +arn, +tag_key, +tag_value +FROM aws.inspectorv2.cis_scan_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cis_scan_configuration_tags resource, see cis_scan_configurations + diff --git a/website/docs/services/inspectorv2/cis_scan_configurations/index.md b/website/docs/services/inspectorv2/cis_scan_configurations/index.md new file mode 100644 index 0000000..90bc23b --- /dev/null +++ b/website/docs/services/inspectorv2/cis_scan_configurations/index.md @@ -0,0 +1,241 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cis_scan_configuration resource or lists cis_scan_configurations in a region + +## Overview + + + + + + + +
Namecis_scan_configurations
TypeResource
DescriptionCIS Scan Configuration resource schema
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of the scan
string
undefinedChoose a Schedule cadence
undefined
stringCIS Scan configuration unique identifier
object
stringAWS region.
+ +For more information, see AWS::InspectorV2::CisScanConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cis_scan_configurations in a region. +```sql +SELECT +region, +scan_name, +security_level, +schedule, +targets, +arn, +tags +FROM aws.inspectorv2.cis_scan_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cis_scan_configuration. +```sql +SELECT +region, +scan_name, +security_level, +schedule, +targets, +arn, +tags +FROM aws.inspectorv2.cis_scan_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cis_scan_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.inspectorv2.cis_scan_configurations ( + ScanName, + SecurityLevel, + Schedule, + Targets, + region +) +SELECT +'{{ ScanName }}', + '{{ SecurityLevel }}', + '{{ Schedule }}', + '{{ Targets }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.inspectorv2.cis_scan_configurations ( + ScanName, + SecurityLevel, + Schedule, + Targets, + Tags, + region +) +SELECT + '{{ ScanName }}', + '{{ SecurityLevel }}', + '{{ Schedule }}', + '{{ Targets }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cis_scan_configuration + props: + - name: ScanName + value: '{{ ScanName }}' + - name: SecurityLevel + value: '{{ SecurityLevel }}' + - name: Schedule + value: null + - name: Targets + value: null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.inspectorv2.cis_scan_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +inspector2:ListCisScanConfigurations, +inspector2:ListTagsForResource +``` diff --git a/website/docs/services/inspectorv2/cis_scan_configurations_list_only/index.md b/website/docs/services/inspectorv2/cis_scan_configurations_list_only/index.md new file mode 100644 index 0000000..c1c66a9 --- /dev/null +++ b/website/docs/services/inspectorv2/cis_scan_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cis_scan_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cis_scan_configurations_list_only + - inspectorv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cis_scan_configurations in a region or regions, for all properties use cis_scan_configurations + +## Overview + + + + + + + +
Namecis_scan_configurations_list_only
TypeResource
DescriptionCIS Scan Configuration resource schema
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringCIS Scan configuration unique identifier
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cis_scan_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.inspectorv2.cis_scan_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cis_scan_configurations_list_only resource, see cis_scan_configurations + diff --git a/website/docs/services/inspectorv2/filters/index.md b/website/docs/services/inspectorv2/filters/index.md new file mode 100644 index 0000000..b89d705 --- /dev/null +++ b/website/docs/services/inspectorv2/filters/index.md @@ -0,0 +1,273 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a filter resource or lists filters in a region + +## Overview + + + + + + + +
Namefilters
TypeResource
DescriptionInspector Filter resource schema
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringFindings filter name.
stringFindings filter description.
objectFindings filter criteria.
stringFindings filter action.
stringFindings filter ARN.
stringAWS region.
+ +For more information, see AWS::InspectorV2::Filter. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all filters in a region. +```sql +SELECT +region, +name, +description, +filter_criteria, +filter_action, +arn +FROM aws.inspectorv2.filters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual filter. +```sql +SELECT +region, +name, +description, +filter_criteria, +filter_action, +arn +FROM aws.inspectorv2.filters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.inspectorv2.filters ( + Name, + FilterCriteria, + FilterAction, + region +) +SELECT +'{{ Name }}', + '{{ FilterCriteria }}', + '{{ FilterAction }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.inspectorv2.filters ( + Name, + Description, + FilterCriteria, + FilterAction, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ FilterCriteria }}', + '{{ FilterAction }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: filter + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: FilterCriteria + value: + AwsAccountId: + - Comparison: '{{ Comparison }}' + Value: '{{ Value }}' + ComponentId: null + ComponentType: null + Ec2InstanceImageId: null + Ec2InstanceSubnetId: null + Ec2InstanceVpcId: null + EcrImageArchitecture: null + EcrImageHash: null + EcrImageTags: null + EcrImagePushedAt: + - EndInclusive: '{{ EndInclusive }}' + StartInclusive: null + EcrImageRegistry: null + EcrImageRepositoryName: null + FindingArn: null + FindingStatus: null + FindingType: null + FirstObservedAt: null + InspectorScore: + - LowerInclusive: null + UpperInclusive: null + LastObservedAt: null + NetworkProtocol: null + PortRange: + - BeginInclusive: '{{ BeginInclusive }}' + EndInclusive: null + RelatedVulnerabilities: null + ResourceId: null + ResourceTags: + - Comparison: '{{ Comparison }}' + Key: '{{ Key }}' + Value: '{{ Value }}' + ResourceType: null + Severity: null + Title: null + UpdatedAt: null + VendorSeverity: null + VulnerabilityId: null + VulnerabilitySource: null + VulnerablePackages: + - Architecture: null + Epoch: null + Name: null + Release: null + SourceLayerHash: null + Version: null + - name: FilterAction + value: '{{ FilterAction }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.inspectorv2.filters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the filters resource, the following permissions are required: + +### Create +```json +inspector2:CreateFilter, +inspector2:ListFilters +``` + +### Read +```json +inspector2:ListFilters +``` + +### Update +```json +inspector2:ListFilters, +inspector2:UpdateFilter +``` + +### Delete +```json +inspector2:DeleteFilter, +inspector2:ListFilters +``` + +### List +```json +inspector2:ListFilters +``` diff --git a/website/docs/services/inspectorv2/filters_list_only/index.md b/website/docs/services/inspectorv2/filters_list_only/index.md new file mode 100644 index 0000000..d6724c2 --- /dev/null +++ b/website/docs/services/inspectorv2/filters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - filters_list_only + - inspectorv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists filters in a region or regions, for all properties use filters + +## Overview + + + + + + + +
Namefilters_list_only
TypeResource
DescriptionInspector Filter resource schema
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringFindings filter ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all filters in a region. +```sql +SELECT +region, +arn +FROM aws.inspectorv2.filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the filters_list_only resource, see filters + diff --git a/website/docs/services/inspectorv2/index.md b/website/docs/services/inspectorv2/index.md new file mode 100644 index 0000000..51f23d4 --- /dev/null +++ b/website/docs/services/inspectorv2/index.md @@ -0,0 +1,40 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The inspectorv2 service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/internetmonitor/index.md b/website/docs/services/internetmonitor/index.md new file mode 100644 index 0000000..fc62846 --- /dev/null +++ b/website/docs/services/internetmonitor/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The internetmonitor service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/internetmonitor/monitor_tags/index.md b/website/docs/services/internetmonitor/monitor_tags/index.md new file mode 100644 index 0000000..d2c2592 --- /dev/null +++ b/website/docs/services/internetmonitor/monitor_tags/index.md @@ -0,0 +1,107 @@ +--- +title: monitor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - monitor_tags + - internetmonitor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for monitors in a region + +## Overview + + + + + + + +
Namemonitor_tags
TypeResource
DescriptionRepresents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
stringThe date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
string
string
string
boolean
string
string
array
array
array
string
integer
integer
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all monitors in a region. +```sql +SELECT +region, +created_at, +modified_at, +monitor_arn, +monitor_name, +linked_account_id, +include_linked_accounts, +processing_status, +processing_status_info, +resources, +resources_to_add, +resources_to_remove, +status, +max_city_networks_to_monitor, +traffic_percentage_to_monitor, +internet_measurements_log_delivery, +health_events_config, +tag_key, +tag_value +FROM aws.internetmonitor.monitor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the monitor_tags resource, see monitors + diff --git a/website/docs/services/internetmonitor/monitors/index.md b/website/docs/services/internetmonitor/monitors/index.md new file mode 100644 index 0000000..1063cf7 --- /dev/null +++ b/website/docs/services/internetmonitor/monitors/index.md @@ -0,0 +1,332 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a monitor resource or lists 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
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
stringThe date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
string
string
string
boolean
string
string
array
array
array
string
array
integer
integer
object
object
stringAWS region.
+ +For more information, see AWS::InternetMonitor::Monitor. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all monitors in a region. +```sql +SELECT +region, +created_at, +modified_at, +monitor_arn, +monitor_name, +linked_account_id, +include_linked_accounts, +processing_status, +processing_status_info, +resources, +resources_to_add, +resources_to_remove, +status, +tags, +max_city_networks_to_monitor, +traffic_percentage_to_monitor, +internet_measurements_log_delivery, +health_events_config +FROM aws.internetmonitor.monitors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual monitor. +```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.monitors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new monitor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.internetmonitor.monitors ( + MonitorName, + region +) +SELECT +'{{ MonitorName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.internetmonitor.monitors ( + MonitorName, + LinkedAccountId, + IncludeLinkedAccounts, + Resources, + ResourcesToAdd, + ResourcesToRemove, + Status, + Tags, + MaxCityNetworksToMonitor, + TrafficPercentageToMonitor, + InternetMeasurementsLogDelivery, + HealthEventsConfig, + region +) +SELECT + '{{ MonitorName }}', + '{{ LinkedAccountId }}', + '{{ IncludeLinkedAccounts }}', + '{{ Resources }}', + '{{ ResourcesToAdd }}', + '{{ ResourcesToRemove }}', + '{{ Status }}', + '{{ Tags }}', + '{{ MaxCityNetworksToMonitor }}', + '{{ TrafficPercentageToMonitor }}', + '{{ InternetMeasurementsLogDelivery }}', + '{{ HealthEventsConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: monitor + props: + - name: MonitorName + value: '{{ MonitorName }}' + - name: LinkedAccountId + value: '{{ LinkedAccountId }}' + - name: IncludeLinkedAccounts + value: '{{ IncludeLinkedAccounts }}' + - name: Resources + value: + - '{{ Resources[0] }}' + - name: ResourcesToAdd + value: + - '{{ ResourcesToAdd[0] }}' + - name: ResourcesToRemove + value: + - '{{ ResourcesToRemove[0] }}' + - name: Status + value: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: MaxCityNetworksToMonitor + value: '{{ MaxCityNetworksToMonitor }}' + - name: TrafficPercentageToMonitor + value: '{{ TrafficPercentageToMonitor }}' + - name: InternetMeasurementsLogDelivery + value: + S3Config: + BucketName: '{{ BucketName }}' + BucketPrefix: '{{ BucketPrefix }}' + LogDeliveryStatus: '{{ LogDeliveryStatus }}' + - name: HealthEventsConfig + value: + AvailabilityScoreThreshold: null + PerformanceScoreThreshold: null + AvailabilityLocalHealthEventsConfig: + Status: '{{ Status }}' + HealthScoreThreshold: null + MinTrafficImpact: null + PerformanceLocalHealthEventsConfig: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.internetmonitor.monitors +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +internetmonitor:ListMonitors, +internetmonitor:GetMonitor, +internetmonitor:ListTagsForResource, +logs:GetLogDelivery +``` diff --git a/website/docs/services/internetmonitor/monitors_list_only/index.md b/website/docs/services/internetmonitor/monitors_list_only/index.md new file mode 100644 index 0000000..c2e61e7 --- /dev/null +++ b/website/docs/services/internetmonitor/monitors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: monitors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - monitors_list_only + - internetmonitor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists monitors in a region or regions, for all properties use monitors + +## Overview + + + + + + + +
Namemonitors_list_only
TypeResource
DescriptionRepresents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all monitors in a region. +```sql +SELECT +region, +monitor_name +FROM aws.internetmonitor.monitors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the monitors_list_only resource, see monitors + diff --git a/website/docs/services/invoicing/index.md b/website/docs/services/invoicing/index.md new file mode 100644 index 0000000..e99746e --- /dev/null +++ b/website/docs/services/invoicing/index.md @@ -0,0 +1,37 @@ +--- +title: invoicing +hide_title: false +hide_table_of_contents: false +keywords: + - invoicing + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The invoicing service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/invoicing/invoice_units/index.md b/website/docs/services/invoicing/invoice_units/index.md new file mode 100644 index 0000000..a1d87b2 --- /dev/null +++ b/website/docs/services/invoicing/invoice_units/index.md @@ -0,0 +1,247 @@ +--- +title: invoice_units +hide_title: false +hide_table_of_contents: false +keywords: + - invoice_units + - invoicing + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an invoice_unit resource or lists invoice_units in a region + +## Overview + + + + + + + +
Nameinvoice_units
TypeResource
DescriptionAn invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you to separate AWS account costs and configures your invoice for each business entity.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
boolean
object
number
array
stringAWS region.
+ +For more information, see AWS::Invoicing::InvoiceUnit. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all invoice_units in a region. +```sql +SELECT +region, +invoice_unit_arn, +invoice_receiver, +name, +description, +tax_inheritance_disabled, +rule, +last_modified, +resource_tags +FROM aws.invoicing.invoice_units +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual invoice_unit. +```sql +SELECT +region, +invoice_unit_arn, +invoice_receiver, +name, +description, +tax_inheritance_disabled, +rule, +last_modified, +resource_tags +FROM aws.invoicing.invoice_units +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new invoice_unit resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.invoicing.invoice_units ( + InvoiceReceiver, + Name, + Rule, + region +) +SELECT +'{{ InvoiceReceiver }}', + '{{ Name }}', + '{{ Rule }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.invoicing.invoice_units ( + InvoiceReceiver, + Name, + Description, + TaxInheritanceDisabled, + Rule, + ResourceTags, + region +) +SELECT + '{{ InvoiceReceiver }}', + '{{ Name }}', + '{{ Description }}', + '{{ TaxInheritanceDisabled }}', + '{{ Rule }}', + '{{ ResourceTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: invoice_unit + props: + - name: InvoiceReceiver + value: '{{ InvoiceReceiver }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: TaxInheritanceDisabled + value: '{{ TaxInheritanceDisabled }}' + - name: Rule + value: + LinkedAccounts: + - '{{ LinkedAccounts[0] }}' + - name: ResourceTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.invoicing.invoice_units +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the invoice_units resource, the following permissions are required: + +### Create +```json +invoicing:CreateInvoiceUnit, +invoicing:TagResource +``` + +### Read +```json +invoicing:GetInvoiceUnit, +invoicing:ListTagsForResource +``` + +### Update +```json +invoicing:UpdateInvoiceUnit, +invoicing:UntagResource, +invoicing:TagResource +``` + +### Delete +```json +invoicing:DeleteInvoiceUnit +``` + +### List +```json +invoicing:ListInvoiceUnits +``` diff --git a/website/docs/services/invoicing/invoice_units_list_only/index.md b/website/docs/services/invoicing/invoice_units_list_only/index.md new file mode 100644 index 0000000..799e011 --- /dev/null +++ b/website/docs/services/invoicing/invoice_units_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: invoice_units_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - invoice_units_list_only + - invoicing + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists invoice_units in a region or regions, for all properties use invoice_units + +## Overview + + + + + + + +
Nameinvoice_units_list_only
TypeResource
DescriptionAn invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you to separate AWS account costs and configures your invoice for each business entity.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all invoice_units in a region. +```sql +SELECT +region, +invoice_unit_arn +FROM aws.invoicing.invoice_units_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the invoice_units_list_only resource, see invoice_units + diff --git a/website/docs/services/iot/account_audit_configurations/index.md b/website/docs/services/iot/account_audit_configurations/index.md new file mode 100644 index 0000000..d22c841 --- /dev/null +++ b/website/docs/services/iot/account_audit_configurations/index.md @@ -0,0 +1,245 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an account_audit_configuration resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
objectSpecifies which audit checks are enabled and disabled for this account.
objectInformation about the targets to which audit notifications are sent.
stringThe ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.
stringAWS region.
+ +For more information, see AWS::IoT::AccountAuditConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all account_audit_configurations in a region. +```sql +SELECT +region, +account_id, +audit_check_configurations, +audit_notification_target_configurations, +role_arn +FROM aws.iot.account_audit_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual account_audit_configuration. +```sql +SELECT +region, +account_id, +audit_check_configurations, +audit_notification_target_configurations, +role_arn +FROM aws.iot.account_audit_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new account_audit_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.account_audit_configurations ( + AccountId, + AuditCheckConfigurations, + RoleArn, + region +) +SELECT +'{{ AccountId }}', + '{{ AuditCheckConfigurations }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.account_audit_configurations ( + AccountId, + AuditCheckConfigurations, + AuditNotificationTargetConfigurations, + RoleArn, + region +) +SELECT + '{{ AccountId }}', + '{{ AuditCheckConfigurations }}', + '{{ AuditNotificationTargetConfigurations }}', + '{{ RoleArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: account_audit_configuration + props: + - name: AccountId + value: '{{ AccountId }}' + - name: AuditCheckConfigurations + value: + AuthenticatedCognitoRoleOverlyPermissiveCheck: + Enabled: '{{ Enabled }}' + CaCertificateExpiringCheck: null + CaCertificateKeyQualityCheck: null + ConflictingClientIdsCheck: null + DeviceCertificateExpiringCheck: null + DeviceCertificateKeyQualityCheck: null + DeviceCertificateSharedCheck: null + IotPolicyOverlyPermissiveCheck: null + IotRoleAliasAllowsAccessToUnusedServicesCheck: null + IotRoleAliasOverlyPermissiveCheck: null + LoggingDisabledCheck: null + RevokedCaCertificateStillActiveCheck: null + RevokedDeviceCertificateStillActiveCheck: null + UnauthenticatedCognitoRoleOverlyPermissiveCheck: null + IntermediateCaRevokedForActiveDeviceCertificatesCheck: null + IoTPolicyPotentialMisConfigurationCheck: null + - name: AuditNotificationTargetConfigurations + value: + Sns: + TargetArn: '{{ TargetArn }}' + RoleArn: '{{ RoleArn }}' + Enabled: '{{ Enabled }}' + - name: RoleArn + value: '{{ RoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.account_audit_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iot:DescribeAccountAuditConfiguration +``` + +### Update +```json +iot:UpdateAccountAuditConfiguration, +iot:DescribeAccountAuditConfiguration, +iam:PassRole +``` + +### Delete +```json +iot:DescribeAccountAuditConfiguration, +iot:DeleteAccountAuditConfiguration +``` + +### List +```json +iot:DescribeAccountAuditConfiguration +``` diff --git a/website/docs/services/iot/account_audit_configurations_list_only/index.md b/website/docs/services/iot/account_audit_configurations_list_only/index.md new file mode 100644 index 0000000..d54055b --- /dev/null +++ b/website/docs/services/iot/account_audit_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: account_audit_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - account_audit_configurations_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists account_audit_configurations in a region or regions, for all properties use account_audit_configurations + +## Overview + + + + + + + +
Nameaccount_audit_configurations_list_only
TypeResource
DescriptionConfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all account_audit_configurations in a region. +```sql +SELECT +region, +account_id +FROM aws.iot.account_audit_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the account_audit_configurations_list_only resource, see account_audit_configurations + diff --git a/website/docs/services/iot/authorizer_tags/index.md b/website/docs/services/iot/authorizer_tags/index.md new file mode 100644 index 0000000..2a36937 --- /dev/null +++ b/website/docs/services/iot/authorizer_tags/index.md @@ -0,0 +1,91 @@ +--- +title: authorizer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - authorizer_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for authorizers in a region + +## Overview + + + + + + + +
Nameauthorizer_tags
TypeResource
DescriptionCreates an authorizer.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
object
boolean
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all authorizers in a region. +```sql +SELECT +region, +authorizer_function_arn, +arn, +authorizer_name, +signing_disabled, +status, +token_key_name, +token_signing_public_keys, +enable_caching_for_http, +tag_key, +tag_value +FROM aws.iot.authorizer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the authorizer_tags resource, see authorizers + diff --git a/website/docs/services/iot/authorizers/index.md b/website/docs/services/iot/authorizers/index.md new file mode 100644 index 0000000..8763207 --- /dev/null +++ b/website/docs/services/iot/authorizers/index.md @@ -0,0 +1,258 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an authorizer resource or lists authorizers in a region + +## Overview + + + + + + + +
Nameauthorizers
TypeResource
DescriptionCreates an authorizer.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
object
boolean
array
stringAWS region.
+ +For more information, see AWS::IoT::Authorizer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all authorizers in a region. +```sql +SELECT +region, +authorizer_function_arn, +arn, +authorizer_name, +signing_disabled, +status, +token_key_name, +token_signing_public_keys, +enable_caching_for_http, +tags +FROM aws.iot.authorizers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual authorizer. +```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.authorizers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new authorizer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.authorizers ( + AuthorizerFunctionArn, + region +) +SELECT +'{{ AuthorizerFunctionArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.authorizers ( + AuthorizerFunctionArn, + AuthorizerName, + SigningDisabled, + Status, + TokenKeyName, + TokenSigningPublicKeys, + EnableCachingForHttp, + Tags, + region +) +SELECT + '{{ AuthorizerFunctionArn }}', + '{{ AuthorizerName }}', + '{{ SigningDisabled }}', + '{{ Status }}', + '{{ TokenKeyName }}', + '{{ TokenSigningPublicKeys }}', + '{{ EnableCachingForHttp }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: authorizer + props: + - name: AuthorizerFunctionArn + value: '{{ AuthorizerFunctionArn }}' + - name: AuthorizerName + value: '{{ AuthorizerName }}' + - name: SigningDisabled + value: '{{ SigningDisabled }}' + - name: Status + value: '{{ Status }}' + - name: TokenKeyName + value: '{{ TokenKeyName }}' + - name: TokenSigningPublicKeys + value: {} + - name: EnableCachingForHttp + value: '{{ EnableCachingForHttp }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.authorizers +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iot:ListAuthorizers +``` diff --git a/website/docs/services/iot/authorizers_list_only/index.md b/website/docs/services/iot/authorizers_list_only/index.md new file mode 100644 index 0000000..866b24f --- /dev/null +++ b/website/docs/services/iot/authorizers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: authorizers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - authorizers_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists authorizers in a region or regions, for all properties use authorizers + +## Overview + + + + + + + +
Nameauthorizers_list_only
TypeResource
DescriptionCreates an authorizer.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all authorizers in a region. +```sql +SELECT +region, +authorizer_name +FROM aws.iot.authorizers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the authorizers_list_only resource, see authorizers + diff --git a/website/docs/services/iot/billing_group_tags/index.md b/website/docs/services/iot/billing_group_tags/index.md new file mode 100644 index 0000000..084969c --- /dev/null +++ b/website/docs/services/iot/billing_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: billing_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - billing_group_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for billing_groups in a region + +## Overview + + + + + + + +
Namebilling_group_tags
TypeResource
DescriptionResource Type definition for AWS::IoT::BillingGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all billing_groups in a region. +```sql +SELECT +region, +id, +arn, +billing_group_name, +billing_group_properties, +tag_key, +tag_value +FROM aws.iot.billing_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the billing_group_tags resource, see billing_groups + diff --git a/website/docs/services/iot/billing_groups/index.md b/website/docs/services/iot/billing_groups/index.md new file mode 100644 index 0000000..c39a0e5 --- /dev/null +++ b/website/docs/services/iot/billing_groups/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a billing_group resource or lists billing_groups in a region + +## Overview + + + + + + + +
Namebilling_groups
TypeResource
DescriptionResource Type definition for AWS::IoT::BillingGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
arrayAn array of key-value pairs to apply to this resource.
object
stringAWS region.
+ +For more information, see AWS::IoT::BillingGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all billing_groups in a region. +```sql +SELECT +region, +id, +arn, +billing_group_name, +tags, +billing_group_properties +FROM aws.iot.billing_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual billing_group. +```sql +SELECT +region, +id, +arn, +billing_group_name, +tags, +billing_group_properties +FROM aws.iot.billing_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new billing_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.billing_groups ( + BillingGroupName, + Tags, + BillingGroupProperties, + region +) +SELECT +'{{ BillingGroupName }}', + '{{ Tags }}', + '{{ BillingGroupProperties }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.billing_groups ( + BillingGroupName, + Tags, + BillingGroupProperties, + region +) +SELECT + '{{ BillingGroupName }}', + '{{ Tags }}', + '{{ BillingGroupProperties }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: billing_group + props: + - name: BillingGroupName + value: '{{ BillingGroupName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: BillingGroupProperties + value: + BillingGroupDescription: '{{ BillingGroupDescription }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.billing_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +iot:DescribeBillingGroup, +iot:DeleteBillingGroup +``` + +### List +```json +iot:ListBillingGroups, +iot:ListTagsForResource +``` + +### Read +```json +iot:DescribeBillingGroup, +iot:ListTagsForResource +``` + +### Update +```json +iot:DescribeBillingGroup, +iot:UpdateBillingGroup, +iot:ListTagsForResource, +iot:TagResource, +iot:UntagResource +``` diff --git a/website/docs/services/iot/billing_groups_list_only/index.md b/website/docs/services/iot/billing_groups_list_only/index.md new file mode 100644 index 0000000..0703773 --- /dev/null +++ b/website/docs/services/iot/billing_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: billing_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - billing_groups_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists billing_groups in a region or regions, for all properties use billing_groups + +## Overview + + + + + + + +
Namebilling_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::BillingGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all billing_groups in a region. +```sql +SELECT +region, +billing_group_name +FROM aws.iot.billing_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the billing_groups_list_only resource, see billing_groups + diff --git a/website/docs/services/iot/ca_certificate_tags/index.md b/website/docs/services/iot/ca_certificate_tags/index.md new file mode 100644 index 0000000..0c9fe2e --- /dev/null +++ b/website/docs/services/iot/ca_certificate_tags/index.md @@ -0,0 +1,93 @@ +--- +title: ca_certificate_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ca_certificate_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ca_certificates in a region + +## Overview + + + + + + + +
Nameca_certificate_tags
TypeResource
DescriptionRegisters a CA Certificate in IoT.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe private key verification certificate.
string
string
string
boolean
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ca_certificates in a region. +```sql +SELECT +region, +ca_certificate_pem, +verification_certificate_pem, +status, +certificate_mode, +auto_registration_status, +remove_auto_registration, +registration_config, +id, +arn, +tag_key, +tag_value +FROM aws.iot.ca_certificate_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ca_certificate_tags resource, see ca_certificates + diff --git a/website/docs/services/iot/ca_certificates/index.md b/website/docs/services/iot/ca_certificates/index.md new file mode 100644 index 0000000..6f8c65a --- /dev/null +++ b/website/docs/services/iot/ca_certificates/index.md @@ -0,0 +1,270 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a ca_certificate resource or lists ca_certificates in a region + +## Overview + + + + + + + +
Nameca_certificates
TypeResource
DescriptionRegisters a CA Certificate in IoT.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe private key verification certificate.
string
string
string
boolean
object
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IoT::CACertificate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ca_certificates in a region. +```sql +SELECT +region, +ca_certificate_pem, +verification_certificate_pem, +status, +certificate_mode, +auto_registration_status, +remove_auto_registration, +registration_config, +id, +arn, +tags +FROM aws.iot.ca_certificates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ca_certificate. +```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_certificates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ca_certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.ca_certificates ( + CACertificatePem, + Status, + region +) +SELECT +'{{ CACertificatePem }}', + '{{ Status }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.ca_certificates ( + CACertificatePem, + VerificationCertificatePem, + Status, + CertificateMode, + AutoRegistrationStatus, + RemoveAutoRegistration, + RegistrationConfig, + Tags, + region +) +SELECT + '{{ CACertificatePem }}', + '{{ VerificationCertificatePem }}', + '{{ Status }}', + '{{ CertificateMode }}', + '{{ AutoRegistrationStatus }}', + '{{ RemoveAutoRegistration }}', + '{{ RegistrationConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ca_certificate + props: + - name: CACertificatePem + value: '{{ CACertificatePem }}' + - name: VerificationCertificatePem + value: '{{ VerificationCertificatePem }}' + - name: Status + value: '{{ Status }}' + - name: CertificateMode + value: '{{ CertificateMode }}' + - name: AutoRegistrationStatus + value: '{{ AutoRegistrationStatus }}' + - name: RemoveAutoRegistration + value: '{{ RemoveAutoRegistration }}' + - name: RegistrationConfig + value: + TemplateBody: '{{ TemplateBody }}' + RoleArn: '{{ RoleArn }}' + TemplateName: '{{ TemplateName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.ca_certificates +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iot:ListCACertificates +``` diff --git a/website/docs/services/iot/ca_certificates_list_only/index.md b/website/docs/services/iot/ca_certificates_list_only/index.md new file mode 100644 index 0000000..ee1f2cd --- /dev/null +++ b/website/docs/services/iot/ca_certificates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: ca_certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ca_certificates_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ca_certificates in a region or regions, for all properties use ca_certificates + +## Overview + + + + + + + +
Nameca_certificates_list_only
TypeResource
DescriptionRegisters a CA Certificate in IoT.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ca_certificates in a region. +```sql +SELECT +region, +id +FROM aws.iot.ca_certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ca_certificates_list_only resource, see ca_certificates + diff --git a/website/docs/services/iot/certificate_provider_tags/index.md b/website/docs/services/iot/certificate_provider_tags/index.md new file mode 100644 index 0000000..3480aa3 --- /dev/null +++ b/website/docs/services/iot/certificate_provider_tags/index.md @@ -0,0 +1,83 @@ +--- +title: certificate_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_provider_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for certificate_providers in a region + +## Overview + + + + + + + +
Namecertificate_provider_tags
TypeResource
DescriptionUse the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all certificate_providers in a region. +```sql +SELECT +region, +certificate_provider_name, +lambda_function_arn, +account_default_for_operations, +arn, +tag_key, +tag_value +FROM aws.iot.certificate_provider_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_provider_tags resource, see certificate_providers + diff --git a/website/docs/services/iot/certificate_providers/index.md b/website/docs/services/iot/certificate_providers/index.md new file mode 100644 index 0000000..2660c22 --- /dev/null +++ b/website/docs/services/iot/certificate_providers/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a certificate_provider resource or lists certificate_providers in a region + +## Overview + + + + + + + +
Namecertificate_providers
TypeResource
DescriptionUse the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
array
arrayAn array of key-value pairs to apply to this resource.
string
stringAWS region.
+ +For more information, see AWS::IoT::CertificateProvider. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all certificate_providers in a region. +```sql +SELECT +region, +certificate_provider_name, +lambda_function_arn, +account_default_for_operations, +tags, +arn +FROM aws.iot.certificate_providers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual certificate_provider. +```sql +SELECT +region, +certificate_provider_name, +lambda_function_arn, +account_default_for_operations, +tags, +arn +FROM aws.iot.certificate_providers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new certificate_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.certificate_providers ( + LambdaFunctionArn, + AccountDefaultForOperations, + region +) +SELECT +'{{ LambdaFunctionArn }}', + '{{ AccountDefaultForOperations }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.certificate_providers ( + CertificateProviderName, + LambdaFunctionArn, + AccountDefaultForOperations, + Tags, + region +) +SELECT + '{{ CertificateProviderName }}', + '{{ LambdaFunctionArn }}', + '{{ AccountDefaultForOperations }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: certificate_provider + props: + - name: CertificateProviderName + value: '{{ CertificateProviderName }}' + - name: LambdaFunctionArn + value: '{{ LambdaFunctionArn }}' + - name: AccountDefaultForOperations + value: + - '{{ AccountDefaultForOperations[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.certificate_providers +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iot:DescribeCertificateProvider, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateCertificateProvider, +iot:DescribeCertificateProvider, +iot:TagResource, +iot:UntagResource, +iot:ListTagsForResource +``` + +### Delete +```json +iot:DeleteCertificateProvider, +iot:DescribeCertificateProvider +``` + +### List +```json +iot:ListCertificateProviders +``` diff --git a/website/docs/services/iot/certificate_providers_list_only/index.md b/website/docs/services/iot/certificate_providers_list_only/index.md new file mode 100644 index 0000000..10b727b --- /dev/null +++ b/website/docs/services/iot/certificate_providers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: certificate_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_providers_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists certificate_providers in a region or regions, for all properties use certificate_providers + +## Overview + + + + + + + +
Namecertificate_providers_list_only
TypeResource
DescriptionUse the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all certificate_providers in a region. +```sql +SELECT +region, +certificate_provider_name +FROM aws.iot.certificate_providers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_providers_list_only resource, see certificate_providers + diff --git a/website/docs/services/iot/certificates/index.md b/website/docs/services/iot/certificates/index.md new file mode 100644 index 0000000..841d6aa --- /dev/null +++ b/website/docs/services/iot/certificates/index.md @@ -0,0 +1,234 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a certificate resource or lists certificates in a region + +## Overview + + + + + + + +
Namecertificates
TypeResource
DescriptionUse the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
stringAWS region.
+ +For more information, see AWS::IoT::Certificate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all certificates in a region. +```sql +SELECT +region, +ca_certificate_pem, +certificate_pem, +certificate_signing_request, +certificate_mode, +status, +id, +arn +FROM aws.iot.certificates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual certificate. +```sql +SELECT +region, +ca_certificate_pem, +certificate_pem, +certificate_signing_request, +certificate_mode, +status, +id, +arn +FROM aws.iot.certificates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.certificates ( + Status, + region +) +SELECT +'{{ Status }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.certificates ( + CACertificatePem, + CertificatePem, + CertificateSigningRequest, + CertificateMode, + Status, + region +) +SELECT + '{{ CACertificatePem }}', + '{{ CertificatePem }}', + '{{ CertificateSigningRequest }}', + '{{ CertificateMode }}', + '{{ Status }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: certificate + props: + - name: CACertificatePem + value: '{{ CACertificatePem }}' + - name: CertificatePem + value: '{{ CertificatePem }}' + - name: CertificateSigningRequest + value: '{{ CertificateSigningRequest }}' + - name: CertificateMode + value: '{{ CertificateMode }}' + - name: Status + value: '{{ Status }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.certificates +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iot:DescribeCertificate +``` + +### Update +```json +iot:UpdateCertificate, +iot:DescribeCertificate +``` + +### Delete +```json +iot:DeleteCertificate, +iot:UpdateCertificate, +iot:DescribeCertificate +``` + +### List +```json +iot:ListCertificates +``` diff --git a/website/docs/services/iot/certificates_list_only/index.md b/website/docs/services/iot/certificates_list_only/index.md new file mode 100644 index 0000000..056f188 --- /dev/null +++ b/website/docs/services/iot/certificates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - certificates_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists certificates in a region or regions, for all properties use certificates + +## Overview + + + + + + + +
Namecertificates_list_only
TypeResource
DescriptionUse the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all certificates in a region. +```sql +SELECT +region, +id +FROM aws.iot.certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificates_list_only resource, see certificates + diff --git a/website/docs/services/iot/command_tags/index.md b/website/docs/services/iot/command_tags/index.md new file mode 100644 index 0000000..717bca9 --- /dev/null +++ b/website/docs/services/iot/command_tags/index.md @@ -0,0 +1,99 @@ +--- +title: command_tags +hide_title: false +hide_table_of_contents: false +keywords: + - command_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for commands in a region + +## Overview + + + + + + + +
Namecommand_tags
TypeResource
DescriptionRepresents the resource definition of AWS IoT Command.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the command.
stringThe unique identifier for the command.
stringThe date and time when the command was created.
booleanA flag indicating whether the command is deprecated.
stringThe description of the command.
stringThe display name for the command.
stringThe date and time when the command was last updated.
arrayThe list of mandatory parameters for the command.
stringThe namespace to which the command belongs.
stringThe customer role associated with the command.
objectThe payload associated with the command.
booleanA flag indicating whether the command is pending deletion.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all commands in a region. +```sql +SELECT +region, +command_arn, +command_id, +created_at, +deprecated, +description, +display_name, +last_updated_at, +mandatory_parameters, +namespace, +role_arn, +payload, +pending_deletion, +tag_key, +tag_value +FROM aws.iot.command_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the command_tags resource, see commands + diff --git a/website/docs/services/iot/commands/index.md b/website/docs/services/iot/commands/index.md new file mode 100644 index 0000000..e04475a --- /dev/null +++ b/website/docs/services/iot/commands/index.md @@ -0,0 +1,299 @@ +--- +title: commands +hide_title: false +hide_table_of_contents: false +keywords: + - commands + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a command resource or lists commands in a region + +## Overview + + + + + + + +
Namecommands
TypeResource
DescriptionRepresents the resource definition of AWS IoT Command.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the command.
stringThe unique identifier for the command.
stringThe date and time when the command was created.
booleanA flag indicating whether the command is deprecated.
stringThe description of the command.
stringThe display name for the command.
stringThe date and time when the command was last updated.
arrayThe list of mandatory parameters for the command.
stringThe namespace to which the command belongs.
stringThe customer role associated with the command.
objectThe payload associated with the command.
booleanA flag indicating whether the command is pending deletion.
arrayThe tags to be associated with the command.
stringAWS region.
+ +For more information, see AWS::IoT::Command. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all commands in a region. +```sql +SELECT +region, +command_arn, +command_id, +created_at, +deprecated, +description, +display_name, +last_updated_at, +mandatory_parameters, +namespace, +role_arn, +payload, +pending_deletion, +tags +FROM aws.iot.commands +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual command. +```sql +SELECT +region, +command_arn, +command_id, +created_at, +deprecated, +description, +display_name, +last_updated_at, +mandatory_parameters, +namespace, +role_arn, +payload, +pending_deletion, +tags +FROM aws.iot.commands +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new command resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.commands ( + CommandId, + region +) +SELECT +'{{ CommandId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.commands ( + CommandId, + CreatedAt, + Deprecated, + Description, + DisplayName, + LastUpdatedAt, + MandatoryParameters, + Namespace, + RoleArn, + Payload, + PendingDeletion, + Tags, + region +) +SELECT + '{{ CommandId }}', + '{{ CreatedAt }}', + '{{ Deprecated }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ LastUpdatedAt }}', + '{{ MandatoryParameters }}', + '{{ Namespace }}', + '{{ RoleArn }}', + '{{ Payload }}', + '{{ PendingDeletion }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: command + props: + - name: CommandId + value: '{{ CommandId }}' + - name: CreatedAt + value: '{{ CreatedAt }}' + - name: Deprecated + value: '{{ Deprecated }}' + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: LastUpdatedAt + value: '{{ LastUpdatedAt }}' + - name: MandatoryParameters + value: + - Name: '{{ Name }}' + Value: + S: '{{ S }}' + B: '{{ B }}' + I: '{{ I }}' + L: '{{ L }}' + D: null + BIN: '{{ BIN }}' + UL: '{{ UL }}' + DefaultValue: null + Description: '{{ Description }}' + - name: Namespace + value: '{{ Namespace }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Payload + value: + Content: '{{ Content }}' + ContentType: '{{ ContentType }}' + - name: PendingDeletion + value: '{{ PendingDeletion }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.commands +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the commands resource, the following permissions are required: + +### Create +```json +iam:PassRole, +iot:CreateCommand, +iot:TagResource +``` + +### Read +```json +iot:GetCommand, +iot:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +iot:UpdateCommand, +iot:GetCommand, +iot:TagResource, +iot:UntagResource, +iot:ListTagsForResource +``` + +### Delete +```json +iot:GetCommand, +iot:UpdateCommand, +iot:DeleteCommand +``` + +### List +```json +iot:ListCommands +``` diff --git a/website/docs/services/iot/commands_list_only/index.md b/website/docs/services/iot/commands_list_only/index.md new file mode 100644 index 0000000..aff1233 --- /dev/null +++ b/website/docs/services/iot/commands_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: commands_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - commands_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists commands in a region or regions, for all properties use commands + +## Overview + + + + + + + +
Namecommands_list_only
TypeResource
DescriptionRepresents the resource definition of AWS IoT Command.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier for the command.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all commands in a region. +```sql +SELECT +region, +command_id +FROM aws.iot.commands_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the commands_list_only resource, see commands + diff --git a/website/docs/services/iot/custom_metric_tags/index.md b/website/docs/services/iot/custom_metric_tags/index.md new file mode 100644 index 0000000..8995315 --- /dev/null +++ b/website/docs/services/iot/custom_metric_tags/index.md @@ -0,0 +1,83 @@ +--- +title: custom_metric_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_metric_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_metrics in a region + +## Overview + + + + + + + +
Namecustom_metric_tags
TypeResource
DescriptionA custom metric published by your devices to Device Defender.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
stringField represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
stringThe type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
stringThe Amazon Resource Number (ARN) of the custom metric.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_metrics in a region. +```sql +SELECT +region, +metric_name, +display_name, +metric_type, +metric_arn, +tag_key, +tag_value +FROM aws.iot.custom_metric_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_metric_tags resource, see custom_metrics + diff --git a/website/docs/services/iot/custom_metrics/index.md b/website/docs/services/iot/custom_metrics/index.md new file mode 100644 index 0000000..f4cb127 --- /dev/null +++ b/website/docs/services/iot/custom_metrics/index.md @@ -0,0 +1,226 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a custom_metric resource or lists custom_metrics in a region + +## Overview + + + + + + + +
Namecustom_metrics
TypeResource
DescriptionA custom metric published by your devices to Device Defender.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
stringField represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
stringThe type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
stringThe Amazon Resource Number (ARN) of the custom metric.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IoT::CustomMetric. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all custom_metrics in a region. +```sql +SELECT +region, +metric_name, +display_name, +metric_type, +metric_arn, +tags +FROM aws.iot.custom_metrics +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual custom_metric. +```sql +SELECT +region, +metric_name, +display_name, +metric_type, +metric_arn, +tags +FROM aws.iot.custom_metrics +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new custom_metric resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.custom_metrics ( + MetricType, + region +) +SELECT +'{{ MetricType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.custom_metrics ( + MetricName, + DisplayName, + MetricType, + Tags, + region +) +SELECT + '{{ MetricName }}', + '{{ DisplayName }}', + '{{ MetricType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: custom_metric + props: + - name: MetricName + value: '{{ MetricName }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: MetricType + value: '{{ MetricType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.custom_metrics +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the custom_metrics resource, the following permissions are required: + +### Create +```json +iot:CreateCustomMetric, +iot:TagResource +``` + +### Read +```json +iot:DescribeCustomMetric, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateCustomMetric, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource +``` + +### Delete +```json +iot:DescribeCustomMetric, +iot:DeleteCustomMetric +``` + +### List +```json +iot:ListCustomMetrics +``` diff --git a/website/docs/services/iot/custom_metrics_list_only/index.md b/website/docs/services/iot/custom_metrics_list_only/index.md new file mode 100644 index 0000000..2598788 --- /dev/null +++ b/website/docs/services/iot/custom_metrics_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: custom_metrics_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_metrics_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_metrics in a region or regions, for all properties use custom_metrics + +## Overview + + + + + + + +
Namecustom_metrics_list_only
TypeResource
DescriptionA custom metric published by your devices to Device Defender.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_metrics in a region. +```sql +SELECT +region, +metric_name +FROM aws.iot.custom_metrics_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_metrics_list_only resource, see custom_metrics + diff --git a/website/docs/services/iot/dimension_tags/index.md b/website/docs/services/iot/dimension_tags/index.md new file mode 100644 index 0000000..0d22855 --- /dev/null +++ b/website/docs/services/iot/dimension_tags/index.md @@ -0,0 +1,83 @@ +--- +title: dimension_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dimension_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dimensions in a region + +## Overview + + + + + + + +
Namedimension_tags
TypeResource
DescriptionA dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the dimension.
stringSpecifies the type of the dimension.
arraySpecifies the value or list of values for the dimension.
stringThe ARN (Amazon resource name) of the created dimension.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dimensions in a region. +```sql +SELECT +region, +name, +type, +string_values, +arn, +tag_key, +tag_value +FROM aws.iot.dimension_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dimension_tags resource, see dimensions + diff --git a/website/docs/services/iot/dimensions/index.md b/website/docs/services/iot/dimensions/index.md new file mode 100644 index 0000000..82a409f --- /dev/null +++ b/website/docs/services/iot/dimensions/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dimension resource or lists 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.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the dimension.
stringSpecifies the type of the dimension.
arraySpecifies the value or list of values for the dimension.
arrayMetadata that can be used to manage the dimension.
stringThe ARN (Amazon resource name) of the created dimension.
stringAWS region.
+ +For more information, see AWS::IoT::Dimension. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dimensions in a region. +```sql +SELECT +region, +name, +type, +string_values, +tags, +arn +FROM aws.iot.dimensions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dimension. +```sql +SELECT +region, +name, +type, +string_values, +tags, +arn +FROM aws.iot.dimensions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dimension resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.dimensions ( + Type, + StringValues, + region +) +SELECT +'{{ Type }}', + '{{ StringValues }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.dimensions ( + Name, + Type, + StringValues, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Type }}', + '{{ StringValues }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dimension + props: + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: StringValues + value: + - '{{ StringValues[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.dimensions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the dimensions resource, the following permissions are required: + +### Create +```json +iot:CreateDimension, +iot:TagResource +``` + +### Read +```json +iot:DescribeDimension, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateDimension, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource +``` + +### Delete +```json +iot:DescribeDimension, +iot:DeleteDimension +``` + +### List +```json +iot:ListDimensions +``` diff --git a/website/docs/services/iot/dimensions_list_only/index.md b/website/docs/services/iot/dimensions_list_only/index.md new file mode 100644 index 0000000..9925fc3 --- /dev/null +++ b/website/docs/services/iot/dimensions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dimensions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dimensions_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dimensions in a region or regions, for all properties use dimensions + +## Overview + + + + + + + +
Namedimensions_list_only
TypeResource
DescriptionA dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for the dimension.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dimensions in a region. +```sql +SELECT +region, +name +FROM aws.iot.dimensions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dimensions_list_only resource, see dimensions + diff --git a/website/docs/services/iot/domain_configuration_tags/index.md b/website/docs/services/iot/domain_configuration_tags/index.md new file mode 100644 index 0000000..eb0cb1b --- /dev/null +++ b/website/docs/services/iot/domain_configuration_tags/index.md @@ -0,0 +1,105 @@ +--- +title: domain_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_configuration_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domain_configurations in a region + +## Overview + + + + + + + +
Namedomain_configuration_tags
TypeResource
DescriptionCreate and manage a Domain Configuration
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
array
string
string
string
string
string
object
array
object
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domain_configurations in a region. +```sql +SELECT +region, +domain_configuration_name, +authorizer_config, +domain_name, +server_certificate_arns, +service_type, +validation_certificate_arn, +arn, +domain_configuration_status, +domain_type, +server_certificate_config, +server_certificates, +tls_config, +authentication_type, +application_protocol, +client_certificate_config, +tag_key, +tag_value +FROM aws.iot.domain_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_configuration_tags resource, see domain_configurations + diff --git a/website/docs/services/iot/domain_configurations/index.md b/website/docs/services/iot/domain_configurations/index.md new file mode 100644 index 0000000..075205e --- /dev/null +++ b/website/docs/services/iot/domain_configurations/index.md @@ -0,0 +1,309 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain_configuration resource or lists domain_configurations in a region + +## Overview + + + + + + + +
Namedomain_configurations
TypeResource
DescriptionCreate and manage a Domain Configuration
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
array
string
string
string
string
string
object
array
object
string
string
object
array
stringAWS region.
+ +For more information, see AWS::IoT::DomainConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domain_configurations in a region. +```sql +SELECT +region, +domain_configuration_name, +authorizer_config, +domain_name, +server_certificate_arns, +service_type, +validation_certificate_arn, +arn, +domain_configuration_status, +domain_type, +server_certificate_config, +server_certificates, +tls_config, +authentication_type, +application_protocol, +client_certificate_config, +tags +FROM aws.iot.domain_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain_configuration. +```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, +authentication_type, +application_protocol, +client_certificate_config, +tags +FROM aws.iot.domain_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.domain_configurations ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.domain_configurations ( + DomainConfigurationName, + AuthorizerConfig, + DomainName, + ServerCertificateArns, + ServiceType, + ValidationCertificateArn, + DomainConfigurationStatus, + ServerCertificateConfig, + TlsConfig, + AuthenticationType, + ApplicationProtocol, + ClientCertificateConfig, + Tags, + region +) +SELECT + '{{ DomainConfigurationName }}', + '{{ AuthorizerConfig }}', + '{{ DomainName }}', + '{{ ServerCertificateArns }}', + '{{ ServiceType }}', + '{{ ValidationCertificateArn }}', + '{{ DomainConfigurationStatus }}', + '{{ ServerCertificateConfig }}', + '{{ TlsConfig }}', + '{{ AuthenticationType }}', + '{{ ApplicationProtocol }}', + '{{ ClientCertificateConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain_configuration + props: + - name: DomainConfigurationName + value: '{{ DomainConfigurationName }}' + - name: AuthorizerConfig + value: + AllowAuthorizerOverride: '{{ AllowAuthorizerOverride }}' + DefaultAuthorizerName: '{{ DefaultAuthorizerName }}' + - name: DomainName + value: '{{ DomainName }}' + - name: ServerCertificateArns + value: + - '{{ ServerCertificateArns[0] }}' + - name: ServiceType + value: '{{ ServiceType }}' + - name: ValidationCertificateArn + value: '{{ ValidationCertificateArn }}' + - name: DomainConfigurationStatus + value: '{{ DomainConfigurationStatus }}' + - name: ServerCertificateConfig + value: + EnableOCSPCheck: '{{ EnableOCSPCheck }}' + OcspLambdaArn: '{{ OcspLambdaArn }}' + OcspAuthorizedResponderArn: '{{ OcspAuthorizedResponderArn }}' + - name: TlsConfig + value: + SecurityPolicy: '{{ SecurityPolicy }}' + - name: AuthenticationType + value: '{{ AuthenticationType }}' + - name: ApplicationProtocol + value: '{{ ApplicationProtocol }}' + - name: ClientCertificateConfig + value: + ClientCertificateCallbackArn: '{{ ClientCertificateCallbackArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.domain_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iot:ListDomainConfigurations +``` diff --git a/website/docs/services/iot/domain_configurations_list_only/index.md b/website/docs/services/iot/domain_configurations_list_only/index.md new file mode 100644 index 0000000..18982ec --- /dev/null +++ b/website/docs/services/iot/domain_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domain_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domain_configurations_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domain_configurations in a region or regions, for all properties use domain_configurations + +## Overview + + + + + + + +
Namedomain_configurations_list_only
TypeResource
DescriptionCreate and manage a Domain Configuration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domain_configurations in a region. +```sql +SELECT +region, +domain_configuration_name +FROM aws.iot.domain_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_configurations_list_only resource, see domain_configurations + diff --git a/website/docs/services/iot/fleet_metric_tags/index.md b/website/docs/services/iot/fleet_metric_tags/index.md new file mode 100644 index 0000000..559355f --- /dev/null +++ b/website/docs/services/iot/fleet_metric_tags/index.md @@ -0,0 +1,101 @@ +--- +title: fleet_metric_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_metric_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fleet_metrics in a region + +## Overview + + + + + + + +
Namefleet_metric_tags
TypeResource
DescriptionAn aggregated metric of certain devices in your fleet
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the fleet metric
stringThe description of a fleet metric
stringThe Fleet Indexing query used by a fleet metric
integerThe period of metric emission in seconds
stringThe aggregation field to perform aggregation and metric emission
stringThe version of a Fleet Indexing query used by a fleet metric
stringThe index name of a fleet metric
stringThe unit of data points emitted by a fleet metric
objectAggregation types supported by Fleet Indexing
stringThe Amazon Resource Number (ARN) of a fleet metric metric
stringThe creation date of a fleet metric
stringThe last modified date of a fleet metric
numberThe version of a fleet metric
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fleet_metrics in a region. +```sql +SELECT +region, +metric_name, +description, +query_string, +period, +aggregation_field, +query_version, +index_name, +unit, +aggregation_type, +metric_arn, +creation_date, +last_modified_date, +version, +tag_key, +tag_value +FROM aws.iot.fleet_metric_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_metric_tags resource, see fleet_metrics + diff --git a/website/docs/services/iot/fleet_metrics/index.md b/website/docs/services/iot/fleet_metrics/index.md new file mode 100644 index 0000000..bd0ae26 --- /dev/null +++ b/website/docs/services/iot/fleet_metrics/index.md @@ -0,0 +1,282 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a fleet_metric resource or lists fleet_metrics in a region + +## Overview + + + + + + + +
Namefleet_metrics
TypeResource
DescriptionAn aggregated metric of certain devices in your fleet
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the fleet metric
stringThe description of a fleet metric
stringThe Fleet Indexing query used by a fleet metric
integerThe period of metric emission in seconds
stringThe aggregation field to perform aggregation and metric emission
stringThe version of a Fleet Indexing query used by a fleet metric
stringThe index name of a fleet metric
stringThe unit of data points emitted by a fleet metric
objectAggregation types supported by Fleet Indexing
stringThe Amazon Resource Number (ARN) of a fleet metric metric
stringThe creation date of a fleet metric
stringThe last modified date of a fleet metric
numberThe version of a fleet metric
arrayAn array of key-value pairs to apply to this resource
stringAWS region.
+ +For more information, see AWS::IoT::FleetMetric. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all fleet_metrics in a region. +```sql +SELECT +region, +metric_name, +description, +query_string, +period, +aggregation_field, +query_version, +index_name, +unit, +aggregation_type, +metric_arn, +creation_date, +last_modified_date, +version, +tags +FROM aws.iot.fleet_metrics +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual fleet_metric. +```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_metrics +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new fleet_metric resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.fleet_metrics ( + MetricName, + region +) +SELECT +'{{ MetricName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.fleet_metrics ( + MetricName, + Description, + QueryString, + Period, + AggregationField, + QueryVersion, + IndexName, + Unit, + AggregationType, + Tags, + region +) +SELECT + '{{ MetricName }}', + '{{ Description }}', + '{{ QueryString }}', + '{{ Period }}', + '{{ AggregationField }}', + '{{ QueryVersion }}', + '{{ IndexName }}', + '{{ Unit }}', + '{{ AggregationType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: fleet_metric + props: + - name: MetricName + value: '{{ MetricName }}' + - name: Description + value: '{{ Description }}' + - name: QueryString + value: '{{ QueryString }}' + - name: Period + value: '{{ Period }}' + - name: AggregationField + value: '{{ AggregationField }}' + - name: QueryVersion + value: '{{ QueryVersion }}' + - name: IndexName + value: '{{ IndexName }}' + - name: Unit + value: '{{ Unit }}' + - name: AggregationType + value: + Name: '{{ Name }}' + Values: + - '{{ Values[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.fleet_metrics +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iot:DescribeFleetMetric, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateFleetMetric, +iot:DescribeFleetMetric, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource +``` + +### Delete +```json +iot:DeleteFleetMetric, +iot:DescribeFleetMetric +``` + +### List +```json +iot:ListFleetMetrics +``` diff --git a/website/docs/services/iot/fleet_metrics_list_only/index.md b/website/docs/services/iot/fleet_metrics_list_only/index.md new file mode 100644 index 0000000..2c06aa7 --- /dev/null +++ b/website/docs/services/iot/fleet_metrics_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: fleet_metrics_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_metrics_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleet_metrics in a region or regions, for all properties use fleet_metrics + +## Overview + + + + + + + +
Namefleet_metrics_list_only
TypeResource
DescriptionAn aggregated metric of certain devices in your fleet
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the fleet metric
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleet_metrics in a region. +```sql +SELECT +region, +metric_name +FROM aws.iot.fleet_metrics_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_metrics_list_only resource, see fleet_metrics + diff --git a/website/docs/services/iot/index.md b/website/docs/services/iot/index.md new file mode 100644 index 0000000..e3f1796 --- /dev/null +++ b/website/docs/services/iot/index.md @@ -0,0 +1,110 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The iot service documentation. + +:::info Service Summary + +
+
+total resources: 75
+
+
+ +::: + +## Resources +
+ + +
\ No newline at end of file diff --git a/website/docs/services/iot/job_template_tags/index.md b/website/docs/services/iot/job_template_tags/index.md new file mode 100644 index 0000000..9a79494 --- /dev/null +++ b/website/docs/services/iot/job_template_tags/index.md @@ -0,0 +1,101 @@ +--- +title: job_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - job_template_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for job_templates in a region + +## Overview + + + + + + + +
Namejob_template_tags
TypeResource
DescriptionJob templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringOptional for copying a JobTemplate from a pre-existing Job configuration.
string
stringA description of the Job Template.
stringThe job document. Required if you don't specify a value for documentSource.
stringAn S3 link to the job document to use in the template. Required if you don't specify a value for document.
objectSpecifies the amount of time each device has to finish its execution of the job.
objectAllows you to create a staged rollout of a job.
objectThe criteria that determine when and how a job abort takes place.
objectConfiguration for pre-signed S3 URLs.
object
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all job_templates in a region. +```sql +SELECT +region, +arn, +job_arn, +job_template_id, +description, +document, +document_source, +timeout_config, +job_executions_rollout_config, +abort_config, +presigned_url_config, +job_executions_retry_config, +maintenance_windows, +destination_package_versions, +tag_key, +tag_value +FROM aws.iot.job_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_template_tags resource, see job_templates + diff --git a/website/docs/services/iot/job_templates/index.md b/website/docs/services/iot/job_templates/index.md new file mode 100644 index 0000000..a6801d8 --- /dev/null +++ b/website/docs/services/iot/job_templates/index.md @@ -0,0 +1,447 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a job_template resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringOptional for copying a JobTemplate from a pre-existing Job configuration.
string
stringA description of the Job Template.
stringThe job document. Required if you don't specify a value for documentSource.
stringAn S3 link to the job document to use in the template. Required if you don't specify a value for document.
objectSpecifies the amount of time each device has to finish its execution of the job.
objectAllows you to create a staged rollout of a job.
objectThe criteria that determine when and how a job abort takes place.
objectConfiguration for pre-signed S3 URLs.
object
array
array
arrayMetadata that can be used to manage the JobTemplate.
stringAWS region.
+ +For more information, see AWS::IoT::JobTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all job_templates in a region. +```sql +SELECT +region, +arn, +job_arn, +job_template_id, +description, +document, +document_source, +timeout_config, +job_executions_rollout_config, +abort_config, +presigned_url_config, +job_executions_retry_config, +maintenance_windows, +destination_package_versions, +tags +FROM aws.iot.job_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual job_template. +```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_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new job_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.job_templates ( + JobTemplateId, + Description, + region +) +SELECT +'{{ JobTemplateId }}', + '{{ Description }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.job_templates ( + JobArn, + JobTemplateId, + Description, + Document, + DocumentSource, + TimeoutConfig, + JobExecutionsRolloutConfig, + AbortConfig, + PresignedUrlConfig, + JobExecutionsRetryConfig, + MaintenanceWindows, + DestinationPackageVersions, + Tags, + region +) +SELECT + '{{ JobArn }}', + '{{ JobTemplateId }}', + '{{ Description }}', + '{{ Document }}', + '{{ DocumentSource }}', + '{{ TimeoutConfig }}', + '{{ JobExecutionsRolloutConfig }}', + '{{ AbortConfig }}', + '{{ PresignedUrlConfig }}', + '{{ JobExecutionsRetryConfig }}', + '{{ MaintenanceWindows }}', + '{{ DestinationPackageVersions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: job_template + props: + - name: JobArn + value: '{{ JobArn }}' + - name: JobTemplateId + value: '{{ JobTemplateId }}' + - name: Description + value: '{{ Description }}' + - name: Document + value: '{{ Document }}' + - name: DocumentSource + value: '{{ DocumentSource }}' + - name: TimeoutConfig + value: + InProgressTimeoutInMinutes: '{{ InProgressTimeoutInMinutes }}' + - name: JobExecutionsRolloutConfig + value: + ExponentialRolloutRate: + BaseRatePerMinute: '{{ BaseRatePerMinute }}' + IncrementFactor: null + RateIncreaseCriteria: + NumberOfNotifiedThings: '{{ NumberOfNotifiedThings }}' + NumberOfSucceededThings: '{{ NumberOfSucceededThings }}' + MaximumPerMinute: '{{ MaximumPerMinute }}' + - name: AbortConfig + value: + CriteriaList: + - Action: + CloudwatchAlarm: + StateValue: '{{ StateValue }}' + AlarmName: '{{ AlarmName }}' + StateReason: '{{ StateReason }}' + RoleArn: '{{ RoleArn }}' + CloudwatchLogs: + LogGroupName: '{{ LogGroupName }}' + RoleArn: '{{ RoleArn }}' + BatchMode: '{{ BatchMode }}' + CloudwatchMetric: + MetricName: '{{ MetricName }}' + MetricValue: '{{ MetricValue }}' + MetricNamespace: '{{ MetricNamespace }}' + MetricUnit: '{{ MetricUnit }}' + RoleArn: '{{ RoleArn }}' + MetricTimestamp: '{{ MetricTimestamp }}' + DynamoDB: + TableName: '{{ TableName }}' + PayloadField: '{{ PayloadField }}' + RangeKeyField: '{{ RangeKeyField }}' + HashKeyField: '{{ HashKeyField }}' + RangeKeyValue: '{{ RangeKeyValue }}' + RangeKeyType: '{{ RangeKeyType }}' + HashKeyType: '{{ HashKeyType }}' + HashKeyValue: '{{ HashKeyValue }}' + RoleArn: '{{ RoleArn }}' + DynamoDBv2: + PutItem: + TableName: '{{ TableName }}' + RoleArn: '{{ RoleArn }}' + Elasticsearch: + Type: '{{ Type }}' + Index: '{{ Index }}' + Id: '{{ Id }}' + Endpoint: '{{ Endpoint }}' + RoleArn: '{{ RoleArn }}' + Firehose: + DeliveryStreamName: '{{ DeliveryStreamName }}' + RoleArn: '{{ RoleArn }}' + Separator: '{{ Separator }}' + BatchMode: '{{ BatchMode }}' + Http: + ConfirmationUrl: '{{ ConfirmationUrl }}' + Headers: + - Value: '{{ Value }}' + Key: '{{ Key }}' + Url: '{{ Url }}' + Auth: + Sigv4: + ServiceName: '{{ ServiceName }}' + SigningRegion: '{{ SigningRegion }}' + RoleArn: '{{ RoleArn }}' + IotAnalytics: + RoleArn: '{{ RoleArn }}' + ChannelName: '{{ ChannelName }}' + BatchMode: '{{ BatchMode }}' + IotEvents: + InputName: '{{ InputName }}' + RoleArn: '{{ RoleArn }}' + MessageId: '{{ MessageId }}' + BatchMode: '{{ BatchMode }}' + IotSiteWise: + RoleArn: '{{ RoleArn }}' + PutAssetPropertyValueEntries: + - PropertyAlias: '{{ PropertyAlias }}' + PropertyValues: + - Value: + StringValue: '{{ StringValue }}' + DoubleValue: '{{ DoubleValue }}' + BooleanValue: '{{ BooleanValue }}' + IntegerValue: '{{ IntegerValue }}' + Timestamp: + TimeInSeconds: '{{ TimeInSeconds }}' + OffsetInNanos: '{{ OffsetInNanos }}' + Quality: '{{ Quality }}' + AssetId: '{{ AssetId }}' + EntryId: '{{ EntryId }}' + PropertyId: '{{ PropertyId }}' + Kafka: + DestinationArn: '{{ DestinationArn }}' + Topic: '{{ Topic }}' + Key: '{{ Key }}' + Partition: '{{ Partition }}' + ClientProperties: {} + Headers: + - Value: '{{ Value }}' + Key: '{{ Key }}' + Kinesis: + PartitionKey: '{{ PartitionKey }}' + StreamName: '{{ StreamName }}' + RoleArn: '{{ RoleArn }}' + Lambda: + FunctionArn: '{{ FunctionArn }}' + Location: + RoleArn: '{{ RoleArn }}' + TrackerName: '{{ TrackerName }}' + DeviceId: '{{ DeviceId }}' + Latitude: '{{ Latitude }}' + Longitude: '{{ Longitude }}' + Timestamp: + Value: '{{ Value }}' + Unit: '{{ Unit }}' + OpenSearch: + Type: '{{ Type }}' + Index: '{{ Index }}' + Id: '{{ Id }}' + Endpoint: '{{ Endpoint }}' + RoleArn: '{{ RoleArn }}' + Republish: + Qos: '{{ Qos }}' + Topic: '{{ Topic }}' + RoleArn: '{{ RoleArn }}' + Headers: + PayloadFormatIndicator: '{{ PayloadFormatIndicator }}' + ContentType: '{{ ContentType }}' + ResponseTopic: '{{ ResponseTopic }}' + CorrelationData: '{{ CorrelationData }}' + MessageExpiry: '{{ MessageExpiry }}' + UserProperties: + - Key: '{{ Key }}' + Value: '{{ Value }}' + S3: + BucketName: '{{ BucketName }}' + Key: '{{ Key }}' + RoleArn: '{{ RoleArn }}' + CannedAcl: '{{ CannedAcl }}' + Sns: + TargetArn: '{{ TargetArn }}' + MessageFormat: '{{ MessageFormat }}' + RoleArn: '{{ RoleArn }}' + Sqs: + RoleArn: '{{ RoleArn }}' + UseBase64: '{{ UseBase64 }}' + QueueUrl: '{{ QueueUrl }}' + StepFunctions: + ExecutionNamePrefix: '{{ ExecutionNamePrefix }}' + StateMachineName: '{{ StateMachineName }}' + RoleArn: '{{ RoleArn }}' + Timestream: + RoleArn: '{{ RoleArn }}' + DatabaseName: '{{ DatabaseName }}' + TableName: '{{ TableName }}' + Dimensions: + - Name: '{{ Name }}' + Value: '{{ Value }}' + Timestamp: + Value: '{{ Value }}' + Unit: '{{ Unit }}' + FailureType: '{{ FailureType }}' + MinNumberOfExecutedThings: '{{ MinNumberOfExecutedThings }}' + ThresholdPercentage: null + - name: PresignedUrlConfig + value: + RoleArn: '{{ RoleArn }}' + ExpiresInSec: '{{ ExpiresInSec }}' + - name: JobExecutionsRetryConfig + value: + RetryCriteriaList: + - NumberOfRetries: '{{ NumberOfRetries }}' + FailureType: '{{ FailureType }}' + - name: MaintenanceWindows + value: + - StartTime: '{{ StartTime }}' + DurationInMinutes: '{{ DurationInMinutes }}' + - name: DestinationPackageVersions + value: + - '{{ DestinationPackageVersions[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.job_templates +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iot:DescribeJobTemplate +``` + +### Delete +```json +iot:DeleteJobTemplate +``` + +### List +```json +iot:ListJobTemplates +``` diff --git a/website/docs/services/iot/job_templates_list_only/index.md b/website/docs/services/iot/job_templates_list_only/index.md new file mode 100644 index 0000000..6cd3108 --- /dev/null +++ b/website/docs/services/iot/job_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: job_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - job_templates_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists job_templates in a region or regions, for all properties use job_templates + +## Overview + + + + + + + +
Namejob_templates_list_only
TypeResource
DescriptionJob templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all job_templates in a region. +```sql +SELECT +region, +job_template_id +FROM aws.iot.job_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_templates_list_only resource, see job_templates + diff --git a/website/docs/services/iot/loggings/index.md b/website/docs/services/iot/loggings/index.md new file mode 100644 index 0000000..226325c --- /dev/null +++ b/website/docs/services/iot/loggings/index.md @@ -0,0 +1,217 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a logging resource or lists 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.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
stringThe ARN of the role that allows IoT to write to Cloudwatch logs.
stringThe log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.
stringAWS region.
+ +For more information, see AWS::IoT::Logging. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all loggings in a region. +```sql +SELECT +region, +account_id, +role_arn, +default_log_level +FROM aws.iot.loggings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual logging. +```sql +SELECT +region, +account_id, +role_arn, +default_log_level +FROM aws.iot.loggings +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new logging resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.loggings ( + AccountId, + RoleArn, + DefaultLogLevel, + region +) +SELECT +'{{ AccountId }}', + '{{ RoleArn }}', + '{{ DefaultLogLevel }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.loggings ( + AccountId, + RoleArn, + DefaultLogLevel, + region +) +SELECT + '{{ AccountId }}', + '{{ RoleArn }}', + '{{ DefaultLogLevel }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: logging + props: + - name: AccountId + value: '{{ AccountId }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: DefaultLogLevel + value: '{{ DefaultLogLevel }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.loggings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the loggings resource, the following permissions are required: + +### Create +```json +iot:SetV2LoggingOptions, +iot:GetV2LoggingOptions, +iam:PassRole +``` + +### Read +```json +iot:GetV2LoggingOptions +``` + +### Update +```json +iot:SetV2LoggingOptions, +iot:GetV2LoggingOptions, +iam:PassRole +``` + +### Delete +```json +iot:SetV2LoggingOptions, +iot:GetV2LoggingOptions +``` + +### List +```json +iot:GetV2LoggingOptions +``` diff --git a/website/docs/services/iot/loggings_list_only/index.md b/website/docs/services/iot/loggings_list_only/index.md new file mode 100644 index 0000000..18c0dd8 --- /dev/null +++ b/website/docs/services/iot/loggings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: loggings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - loggings_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists loggings in a region or regions, for all properties use loggings + +## Overview + + + + + + + +
Nameloggings_list_only
TypeResource
DescriptionLogging Options enable you to configure your IoT V2 logging role and default logging level so that you can monitor progress events logs as it passes from your devices through Iot core service.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all loggings in a region. +```sql +SELECT +region, +account_id +FROM aws.iot.loggings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the loggings_list_only resource, see loggings + diff --git a/website/docs/services/iot/mitigation_action_tags/index.md b/website/docs/services/iot/mitigation_action_tags/index.md new file mode 100644 index 0000000..16d1d1c --- /dev/null +++ b/website/docs/services/iot/mitigation_action_tags/index.md @@ -0,0 +1,85 @@ +--- +title: mitigation_action_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mitigation_action_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mitigation_actions in a region + +## Overview + + + + + + + +
Namemitigation_action_tags
TypeResource
DescriptionMitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the mitigation action.
string
objectThe set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mitigation_actions in a region. +```sql +SELECT +region, +action_name, +role_arn, +action_params, +mitigation_action_arn, +mitigation_action_id, +tag_key, +tag_value +FROM aws.iot.mitigation_action_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mitigation_action_tags resource, see mitigation_actions + diff --git a/website/docs/services/iot/mitigation_actions/index.md b/website/docs/services/iot/mitigation_actions/index.md new file mode 100644 index 0000000..787e3d4 --- /dev/null +++ b/website/docs/services/iot/mitigation_actions/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mitigation_action resource or lists 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.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the mitigation action.
string
arrayAn array of key-value pairs to apply to this resource.
objectThe set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).
string
string
stringAWS region.
+ +For more information, see AWS::IoT::MitigationAction. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mitigation_actions in a region. +```sql +SELECT +region, +action_name, +role_arn, +tags, +action_params, +mitigation_action_arn, +mitigation_action_id +FROM aws.iot.mitigation_actions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mitigation_action. +```sql +SELECT +region, +action_name, +role_arn, +tags, +action_params, +mitigation_action_arn, +mitigation_action_id +FROM aws.iot.mitigation_actions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mitigation_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.mitigation_actions ( + RoleArn, + ActionParams, + region +) +SELECT +'{{ RoleArn }}', + '{{ ActionParams }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.mitigation_actions ( + ActionName, + RoleArn, + Tags, + ActionParams, + region +) +SELECT + '{{ ActionName }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ ActionParams }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mitigation_action + props: + - name: ActionName + value: '{{ ActionName }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ActionParams + value: + AddThingsToThingGroupParams: + OverrideDynamicGroups: '{{ OverrideDynamicGroups }}' + ThingGroupNames: + - '{{ ThingGroupNames[0] }}' + EnableIoTLoggingParams: + LogLevel: '{{ LogLevel }}' + RoleArnForLogging: '{{ RoleArnForLogging }}' + PublishFindingToSnsParams: + TopicArn: '{{ TopicArn }}' + ReplaceDefaultPolicyVersionParams: + TemplateName: '{{ TemplateName }}' + UpdateCACertificateParams: + Action: '{{ Action }}' + UpdateDeviceCertificateParams: + Action: '{{ Action }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.mitigation_actions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iot:DescribeMitigationAction, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateMitigationAction, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource, +iam:PassRole +``` + +### Delete +```json +iot:DescribeMitigationAction, +iot:DeleteMitigationAction +``` + +### List +```json +iot:ListMitigationActions +``` diff --git a/website/docs/services/iot/mitigation_actions_list_only/index.md b/website/docs/services/iot/mitigation_actions_list_only/index.md new file mode 100644 index 0000000..b18ba15 --- /dev/null +++ b/website/docs/services/iot/mitigation_actions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: mitigation_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mitigation_actions_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mitigation_actions in a region or regions, for all properties use mitigation_actions + +## Overview + + + + + + + +
Namemitigation_actions_list_only
TypeResource
DescriptionMitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for the mitigation action.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mitigation_actions in a region. +```sql +SELECT +region, +action_name +FROM aws.iot.mitigation_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mitigation_actions_list_only resource, see mitigation_actions + diff --git a/website/docs/services/iot/policies/index.md b/website/docs/services/iot/policies/index.md new file mode 100644 index 0000000..e6d0fd8 --- /dev/null +++ b/website/docs/services/iot/policies/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a policy resource or lists policies in a region + +## Overview + + + + + + + +
Namepolicies
TypeResource
DescriptionResource Type definition for AWS::IoT::Policy
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
array
stringAWS region.
+ +For more information, see AWS::IoT::Policy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all policies in a region. +```sql +SELECT +region, +id, +arn, +policy_document, +policy_name, +tags +FROM aws.iot.policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual policy. +```sql +SELECT +region, +id, +arn, +policy_document, +policy_name, +tags +FROM aws.iot.policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.policies ( + PolicyDocument, + region +) +SELECT +'{{ PolicyDocument }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.policies ( + PolicyDocument, + PolicyName, + Tags, + region +) +SELECT + '{{ PolicyDocument }}', + '{{ PolicyName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: policy + props: + - name: PolicyDocument + value: {} + - name: PolicyName + value: '{{ PolicyName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.policies +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iot:ListPolicies +``` diff --git a/website/docs/services/iot/policies_list_only/index.md b/website/docs/services/iot/policies_list_only/index.md new file mode 100644 index 0000000..68bd071 --- /dev/null +++ b/website/docs/services/iot/policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policies_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policies in a region or regions, for all properties use policies + +## Overview + + + + + + + +
Namepolicies_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::Policy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policies in a region. +```sql +SELECT +region, +id +FROM aws.iot.policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policies_list_only resource, see policies + diff --git a/website/docs/services/iot/policy_tags/index.md b/website/docs/services/iot/policy_tags/index.md new file mode 100644 index 0000000..ed19f64 --- /dev/null +++ b/website/docs/services/iot/policy_tags/index.md @@ -0,0 +1,83 @@ +--- +title: policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - policy_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for policies in a region + +## Overview + + + + + + + +
Namepolicy_tags
TypeResource
DescriptionResource Type definition for AWS::IoT::Policy
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all policies in a region. +```sql +SELECT +region, +id, +arn, +policy_document, +policy_name, +tag_key, +tag_value +FROM aws.iot.policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_tags resource, see policies + diff --git a/website/docs/services/iot/provisioning_template_tags/index.md b/website/docs/services/iot/provisioning_template_tags/index.md new file mode 100644 index 0000000..39bf454 --- /dev/null +++ b/website/docs/services/iot/provisioning_template_tags/index.md @@ -0,0 +1,91 @@ +--- +title: provisioning_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - provisioning_template_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for provisioning_templates in a region + +## Overview + + + + + + + +
Nameprovisioning_template_tags
TypeResource
DescriptionCreates a fleet provisioning template.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all provisioning_templates in a region. +```sql +SELECT +region, +template_arn, +template_name, +description, +enabled, +provisioning_role_arn, +template_body, +template_type, +pre_provisioning_hook, +tag_key, +tag_value +FROM aws.iot.provisioning_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the provisioning_template_tags resource, see provisioning_templates + diff --git a/website/docs/services/iot/provisioning_templates/index.md b/website/docs/services/iot/provisioning_templates/index.md new file mode 100644 index 0000000..5d3b32f --- /dev/null +++ b/website/docs/services/iot/provisioning_templates/index.md @@ -0,0 +1,268 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a provisioning_template resource or lists provisioning_templates in a region + +## Overview + + + + + + + +
Nameprovisioning_templates
TypeResource
DescriptionCreates a fleet provisioning template.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
string
object
array
stringAWS region.
+ +For more information, see AWS::IoT::ProvisioningTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all provisioning_templates in a region. +```sql +SELECT +region, +template_arn, +template_name, +description, +enabled, +provisioning_role_arn, +template_body, +template_type, +pre_provisioning_hook, +tags +FROM aws.iot.provisioning_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual provisioning_template. +```sql +SELECT +region, +template_arn, +template_name, +description, +enabled, +provisioning_role_arn, +template_body, +template_type, +pre_provisioning_hook, +tags +FROM aws.iot.provisioning_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new provisioning_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.provisioning_templates ( + ProvisioningRoleArn, + TemplateBody, + region +) +SELECT +'{{ ProvisioningRoleArn }}', + '{{ TemplateBody }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.provisioning_templates ( + TemplateName, + Description, + Enabled, + ProvisioningRoleArn, + TemplateBody, + TemplateType, + PreProvisioningHook, + Tags, + region +) +SELECT + '{{ TemplateName }}', + '{{ Description }}', + '{{ Enabled }}', + '{{ ProvisioningRoleArn }}', + '{{ TemplateBody }}', + '{{ TemplateType }}', + '{{ PreProvisioningHook }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: provisioning_template + props: + - name: TemplateName + value: '{{ TemplateName }}' + - name: Description + value: '{{ Description }}' + - name: Enabled + value: '{{ Enabled }}' + - name: ProvisioningRoleArn + value: '{{ ProvisioningRoleArn }}' + - name: TemplateBody + value: '{{ TemplateBody }}' + - name: TemplateType + value: '{{ TemplateType }}' + - name: PreProvisioningHook + value: + TargetArn: '{{ TargetArn }}' + PayloadVersion: '{{ PayloadVersion }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.provisioning_templates +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iot:ListProvisioningTemplates +``` diff --git a/website/docs/services/iot/provisioning_templates_list_only/index.md b/website/docs/services/iot/provisioning_templates_list_only/index.md new file mode 100644 index 0000000..9c21911 --- /dev/null +++ b/website/docs/services/iot/provisioning_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: provisioning_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - provisioning_templates_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists provisioning_templates in a region or regions, for all properties use provisioning_templates + +## Overview + + + + + + + +
Nameprovisioning_templates_list_only
TypeResource
DescriptionCreates a fleet provisioning template.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all provisioning_templates in a region. +```sql +SELECT +region, +template_name +FROM aws.iot.provisioning_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the provisioning_templates_list_only resource, see provisioning_templates + diff --git a/website/docs/services/iot/resource_specific_loggings/index.md b/website/docs/services/iot/resource_specific_loggings/index.md new file mode 100644 index 0000000..86b8e75 --- /dev/null +++ b/website/docs/services/iot/resource_specific_loggings/index.md @@ -0,0 +1,218 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_specific_logging resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE.
stringThe target name.
stringThe log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.
stringUnique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.
stringAWS region.
+ +For more information, see AWS::IoT::ResourceSpecificLogging. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_specific_loggings in a region. +```sql +SELECT +region, +target_type, +target_name, +log_level, +target_id +FROM aws.iot.resource_specific_loggings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_specific_logging. +```sql +SELECT +region, +target_type, +target_name, +log_level, +target_id +FROM aws.iot.resource_specific_loggings +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_specific_logging resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.resource_specific_loggings ( + TargetType, + TargetName, + LogLevel, + region +) +SELECT +'{{ TargetType }}', + '{{ TargetName }}', + '{{ LogLevel }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.resource_specific_loggings ( + TargetType, + TargetName, + LogLevel, + region +) +SELECT + '{{ TargetType }}', + '{{ TargetName }}', + '{{ LogLevel }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_specific_logging + props: + - name: TargetType + value: '{{ TargetType }}' + - name: TargetName + value: '{{ TargetName }}' + - name: LogLevel + value: '{{ LogLevel }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.resource_specific_loggings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_specific_loggings resource, the following permissions are required: + +### Create +```json +iot:ListV2LoggingLevels, +iot:SetV2LoggingLevel +``` + +### Read +```json +iot:ListV2LoggingLevels +``` + +### Update +```json +iot:ListV2LoggingLevels, +iot:SetV2LoggingLevel +``` + +### Delete +```json +iot:ListV2LoggingLevels, +iot:DeleteV2LoggingLevel +``` + +### List +```json +iot:ListV2LoggingLevels +``` diff --git a/website/docs/services/iot/resource_specific_loggings_list_only/index.md b/website/docs/services/iot/resource_specific_loggings_list_only/index.md new file mode 100644 index 0000000..99352b4 --- /dev/null +++ b/website/docs/services/iot/resource_specific_loggings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_specific_loggings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_specific_loggings_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_specific_loggings in a region or regions, for all properties use resource_specific_loggings + +## Overview + + + + + + + +
Nameresource_specific_loggings_list_only
TypeResource
DescriptionResource-specific logging allows you to specify a logging level for a specific thing group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_specific_loggings in a region. +```sql +SELECT +region, +target_id +FROM aws.iot.resource_specific_loggings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_specific_loggings_list_only resource, see resource_specific_loggings + diff --git a/website/docs/services/iot/role_alias_tags/index.md b/website/docs/services/iot/role_alias_tags/index.md new file mode 100644 index 0000000..33c648f --- /dev/null +++ b/website/docs/services/iot/role_alias_tags/index.md @@ -0,0 +1,83 @@ +--- +title: role_alias_tags +hide_title: false +hide_table_of_contents: false +keywords: + - role_alias_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for role_aliases in a region + +## Overview + + + + + + + +
Namerole_alias_tags
TypeResource
DescriptionUse the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all role_aliases in a region. +```sql +SELECT +region, +role_alias, +role_alias_arn, +role_arn, +credential_duration_seconds, +tag_key, +tag_value +FROM aws.iot.role_alias_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the role_alias_tags resource, see role_aliases + diff --git a/website/docs/services/iot/role_aliases/index.md b/website/docs/services/iot/role_aliases/index.md new file mode 100644 index 0000000..f114cfb --- /dev/null +++ b/website/docs/services/iot/role_aliases/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a role_alias resource or lists role_aliases in a region + +## Overview + + + + + + + +
Namerole_aliases
TypeResource
DescriptionUse the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
integer
array
stringAWS region.
+ +For more information, see AWS::IoT::RoleAlias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all role_aliases in a region. +```sql +SELECT +region, +role_alias, +role_alias_arn, +role_arn, +credential_duration_seconds, +tags +FROM aws.iot.role_aliases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual role_alias. +```sql +SELECT +region, +role_alias, +role_alias_arn, +role_arn, +credential_duration_seconds, +tags +FROM aws.iot.role_aliases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new role_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.role_aliases ( + RoleArn, + region +) +SELECT +'{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.role_aliases ( + RoleAlias, + RoleArn, + CredentialDurationSeconds, + Tags, + region +) +SELECT + '{{ RoleAlias }}', + '{{ RoleArn }}', + '{{ CredentialDurationSeconds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: role_alias + props: + - name: RoleAlias + value: '{{ RoleAlias }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: CredentialDurationSeconds + value: '{{ CredentialDurationSeconds }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.role_aliases +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iot:ListRoleAliases +``` diff --git a/website/docs/services/iot/role_aliases_list_only/index.md b/website/docs/services/iot/role_aliases_list_only/index.md new file mode 100644 index 0000000..0b36791 --- /dev/null +++ b/website/docs/services/iot/role_aliases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: role_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - role_aliases_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists role_aliases in a region or regions, for all properties use role_aliases + +## Overview + + + + + + + +
Namerole_aliases_list_only
TypeResource
DescriptionUse the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all role_aliases in a region. +```sql +SELECT +region, +role_alias +FROM aws.iot.role_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the role_aliases_list_only resource, see role_aliases + diff --git a/website/docs/services/iot/scheduled_audit_tags/index.md b/website/docs/services/iot/scheduled_audit_tags/index.md new file mode 100644 index 0000000..d1d691d --- /dev/null +++ b/website/docs/services/iot/scheduled_audit_tags/index.md @@ -0,0 +1,87 @@ +--- +title: scheduled_audit_tags +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_audit_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scheduled_audits in a region + +## Overview + + + + + + + +
Namescheduled_audit_tags
TypeResource
DescriptionScheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to give to the scheduled audit.
stringHow often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
stringThe day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY.
stringThe day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
arrayWhich checks are performed during the scheduled audit. Checks must be enabled for your account.
stringThe ARN (Amazon resource name) of the scheduled audit.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scheduled_audits in a region. +```sql +SELECT +region, +scheduled_audit_name, +frequency, +day_of_month, +day_of_week, +target_check_names, +scheduled_audit_arn, +tag_key, +tag_value +FROM aws.iot.scheduled_audit_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_audit_tags resource, see scheduled_audits + diff --git a/website/docs/services/iot/scheduled_audits/index.md b/website/docs/services/iot/scheduled_audits/index.md new file mode 100644 index 0000000..1d9a04a --- /dev/null +++ b/website/docs/services/iot/scheduled_audits/index.md @@ -0,0 +1,244 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a scheduled_audit resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to give to the scheduled audit.
stringHow often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
stringThe day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY.
stringThe day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
arrayWhich checks are performed during the scheduled audit. Checks must be enabled for your account.
stringThe ARN (Amazon resource name) of the scheduled audit.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IoT::ScheduledAudit. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scheduled_audits in a region. +```sql +SELECT +region, +scheduled_audit_name, +frequency, +day_of_month, +day_of_week, +target_check_names, +scheduled_audit_arn, +tags +FROM aws.iot.scheduled_audits +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual scheduled_audit. +```sql +SELECT +region, +scheduled_audit_name, +frequency, +day_of_month, +day_of_week, +target_check_names, +scheduled_audit_arn, +tags +FROM aws.iot.scheduled_audits +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scheduled_audit resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.scheduled_audits ( + Frequency, + TargetCheckNames, + region +) +SELECT +'{{ Frequency }}', + '{{ TargetCheckNames }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.scheduled_audits ( + ScheduledAuditName, + Frequency, + DayOfMonth, + DayOfWeek, + TargetCheckNames, + Tags, + region +) +SELECT + '{{ ScheduledAuditName }}', + '{{ Frequency }}', + '{{ DayOfMonth }}', + '{{ DayOfWeek }}', + '{{ TargetCheckNames }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: scheduled_audit + props: + - name: ScheduledAuditName + value: '{{ ScheduledAuditName }}' + - name: Frequency + value: '{{ Frequency }}' + - name: DayOfMonth + value: '{{ DayOfMonth }}' + - name: DayOfWeek + value: '{{ DayOfWeek }}' + - name: TargetCheckNames + value: + - '{{ TargetCheckNames[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.scheduled_audits +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iot:DescribeScheduledAudit, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateScheduledAudit, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource +``` + +### Delete +```json +iot:DescribeScheduledAudit, +iot:DeleteScheduledAudit +``` + +### List +```json +iot:ListScheduledAudits +``` diff --git a/website/docs/services/iot/scheduled_audits_list_only/index.md b/website/docs/services/iot/scheduled_audits_list_only/index.md new file mode 100644 index 0000000..f52a473 --- /dev/null +++ b/website/docs/services/iot/scheduled_audits_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: scheduled_audits_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_audits_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scheduled_audits in a region or regions, for all properties use scheduled_audits + +## Overview + + + + + + + +
Namescheduled_audits_list_only
TypeResource
DescriptionScheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name you want to give to the scheduled audit.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scheduled_audits in a region. +```sql +SELECT +region, +scheduled_audit_name +FROM aws.iot.scheduled_audits_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_audits_list_only resource, see scheduled_audits + diff --git a/website/docs/services/iot/security_profile_tags/index.md b/website/docs/services/iot/security_profile_tags/index.md new file mode 100644 index 0000000..3e4f59a --- /dev/null +++ b/website/docs/services/iot/security_profile_tags/index.md @@ -0,0 +1,91 @@ +--- +title: security_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - security_profile_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for security_profiles in a region + +## Overview + + + + + + + +
Namesecurity_profile_tags
TypeResource
DescriptionA security profile defines a set of expected behaviors for devices in your account.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the security profile.
stringA description of the security profile.
arraySpecifies the behaviors that, when violated by a device (thing), cause an alert.
objectSpecifies the destinations to which alerts are sent.
arrayA list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
objectA structure containing the mqtt topic for metrics export.
arrayA set of target ARNs that the security profile is attached to.
stringThe ARN (Amazon resource name) of the created security profile.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all security_profiles in a region. +```sql +SELECT +region, +security_profile_name, +security_profile_description, +behaviors, +alert_targets, +additional_metrics_to_retain_v2, +metrics_export_config, +target_arns, +security_profile_arn, +tag_key, +tag_value +FROM aws.iot.security_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_profile_tags resource, see security_profiles + diff --git a/website/docs/services/iot/security_profiles/index.md b/website/docs/services/iot/security_profiles/index.md new file mode 100644 index 0000000..a4e2c6f --- /dev/null +++ b/website/docs/services/iot/security_profiles/index.md @@ -0,0 +1,295 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_profile resource or lists security_profiles in a region + +## Overview + + + + + + + +
Namesecurity_profiles
TypeResource
DescriptionA security profile defines a set of expected behaviors for devices in your account.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the security profile.
stringA description of the security profile.
arraySpecifies the behaviors that, when violated by a device (thing), cause an alert.
objectSpecifies the destinations to which alerts are sent.
arrayA list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
objectA structure containing the mqtt topic for metrics export.
arrayMetadata that can be used to manage the security profile.
arrayA set of target ARNs that the security profile is attached to.
stringThe ARN (Amazon resource name) of the created security profile.
stringAWS region.
+ +For more information, see AWS::IoT::SecurityProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_profiles in a region. +```sql +SELECT +region, +security_profile_name, +security_profile_description, +behaviors, +alert_targets, +additional_metrics_to_retain_v2, +metrics_export_config, +tags, +target_arns, +security_profile_arn +FROM aws.iot.security_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_profile. +```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_profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.security_profiles ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.security_profiles ( + SecurityProfileName, + SecurityProfileDescription, + Behaviors, + AlertTargets, + AdditionalMetricsToRetainV2, + MetricsExportConfig, + Tags, + TargetArns, + region +) +SELECT + '{{ SecurityProfileName }}', + '{{ SecurityProfileDescription }}', + '{{ Behaviors }}', + '{{ AlertTargets }}', + '{{ AdditionalMetricsToRetainV2 }}', + '{{ MetricsExportConfig }}', + '{{ Tags }}', + '{{ TargetArns }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_profile + props: + - name: SecurityProfileName + value: '{{ SecurityProfileName }}' + - name: SecurityProfileDescription + value: '{{ SecurityProfileDescription }}' + - name: Behaviors + value: + - Name: '{{ Name }}' + Metric: '{{ Metric }}' + MetricDimension: + DimensionName: '{{ DimensionName }}' + Operator: '{{ Operator }}' + Criteria: + ComparisonOperator: '{{ ComparisonOperator }}' + Value: + Count: '{{ Count }}' + Cidrs: + - '{{ Cidrs[0] }}' + Ports: + - '{{ Ports[0] }}' + Number: null + Numbers: + - null + Strings: + - '{{ Strings[0] }}' + DurationSeconds: '{{ DurationSeconds }}' + ConsecutiveDatapointsToAlarm: '{{ ConsecutiveDatapointsToAlarm }}' + ConsecutiveDatapointsToClear: '{{ ConsecutiveDatapointsToClear }}' + StatisticalThreshold: + Statistic: '{{ Statistic }}' + MlDetectionConfig: + ConfidenceLevel: '{{ ConfidenceLevel }}' + SuppressAlerts: '{{ SuppressAlerts }}' + ExportMetric: '{{ ExportMetric }}' + - name: AlertTargets + value: {} + - name: AdditionalMetricsToRetainV2 + value: + - Metric: '{{ Metric }}' + MetricDimension: null + ExportMetric: null + - name: MetricsExportConfig + value: + MqttTopic: '{{ MqttTopic }}' + RoleArn: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TargetArns + value: + - '{{ TargetArns[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.security_profiles +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iot:ListSecurityProfiles +``` diff --git a/website/docs/services/iot/security_profiles_list_only/index.md b/website/docs/services/iot/security_profiles_list_only/index.md new file mode 100644 index 0000000..ea7d0b9 --- /dev/null +++ b/website/docs/services/iot/security_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: security_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_profiles_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_profiles in a region or regions, for all properties use security_profiles + +## Overview + + + + + + + +
Namesecurity_profiles_list_only
TypeResource
DescriptionA security profile defines a set of expected behaviors for devices in your account.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for the security profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_profiles in a region. +```sql +SELECT +region, +security_profile_name +FROM aws.iot.security_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_profiles_list_only resource, see security_profiles + diff --git a/website/docs/services/iot/software_package_tags/index.md b/website/docs/services/iot/software_package_tags/index.md new file mode 100644 index 0000000..31e66d2 --- /dev/null +++ b/website/docs/services/iot/software_package_tags/index.md @@ -0,0 +1,81 @@ +--- +title: software_package_tags +hide_title: false +hide_table_of_contents: false +keywords: + - software_package_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for software_packages in a region + +## Overview + + + + + + + +
Namesoftware_package_tags
TypeResource
Descriptionresource definition
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all software_packages in a region. +```sql +SELECT +region, +description, +package_arn, +package_name, +tag_key, +tag_value +FROM aws.iot.software_package_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the software_package_tags resource, see software_packages + diff --git a/website/docs/services/iot/software_package_version_tags/index.md b/website/docs/services/iot/software_package_version_tags/index.md new file mode 100644 index 0000000..1255b28 --- /dev/null +++ b/website/docs/services/iot/software_package_version_tags/index.md @@ -0,0 +1,89 @@ +--- +title: software_package_version_tags +hide_title: false +hide_table_of_contents: false +keywords: + - software_package_version_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for software_package_versions in a region + +## Overview + + + + + + + +
Namesoftware_package_version_tags
TypeResource
Descriptionresource definition
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all software_package_versions in a region. +```sql +SELECT +region, +attributes, +description, +error_reason, +package_name, +package_version_arn, +status, +version_name, +tag_key, +tag_value +FROM aws.iot.software_package_version_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the software_package_version_tags resource, see software_package_versions + diff --git a/website/docs/services/iot/software_package_versions/index.md b/website/docs/services/iot/software_package_versions/index.md new file mode 100644 index 0000000..277800d --- /dev/null +++ b/website/docs/services/iot/software_package_versions/index.md @@ -0,0 +1,245 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a software_package_version resource or lists software_package_versions in a region + +## Overview + + + + + + + +
Namesoftware_package_versions
TypeResource
Descriptionresource definition
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
string
stringAWS region.
+ +For more information, see AWS::IoT::SoftwarePackageVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all software_package_versions in a region. +```sql +SELECT +region, +attributes, +description, +error_reason, +package_name, +package_version_arn, +status, +tags, +version_name +FROM aws.iot.software_package_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual software_package_version. +```sql +SELECT +region, +attributes, +description, +error_reason, +package_name, +package_version_arn, +status, +tags, +version_name +FROM aws.iot.software_package_versions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new software_package_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.software_package_versions ( + PackageName, + region +) +SELECT +'{{ PackageName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.software_package_versions ( + Attributes, + Description, + PackageName, + Tags, + VersionName, + region +) +SELECT + '{{ Attributes }}', + '{{ Description }}', + '{{ PackageName }}', + '{{ Tags }}', + '{{ VersionName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: software_package_version + props: + - name: Attributes + value: {} + - name: Description + value: '{{ Description }}' + - name: PackageName + value: '{{ PackageName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VersionName + value: '{{ VersionName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.software_package_versions +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iot:ListPackageVersions +``` diff --git a/website/docs/services/iot/software_package_versions_list_only/index.md b/website/docs/services/iot/software_package_versions_list_only/index.md new file mode 100644 index 0000000..e49510f --- /dev/null +++ b/website/docs/services/iot/software_package_versions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: software_package_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - software_package_versions_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists software_package_versions in a region or regions, for all properties use software_package_versions + +## Overview + + + + + + + +
Namesoftware_package_versions_list_only
TypeResource
Descriptionresource definition
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all software_package_versions in a region. +```sql +SELECT +region, +package_name, +version_name +FROM aws.iot.software_package_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the software_package_versions_list_only resource, see software_package_versions + diff --git a/website/docs/services/iot/software_packages/index.md b/website/docs/services/iot/software_packages/index.md new file mode 100644 index 0000000..888f75a --- /dev/null +++ b/website/docs/services/iot/software_packages/index.md @@ -0,0 +1,234 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a software_package resource or lists software_packages in a region + +## Overview + + + + + + + +
Namesoftware_packages
TypeResource
Descriptionresource definition
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IoT::SoftwarePackage. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all software_packages in a region. +```sql +SELECT +region, +description, +package_arn, +package_name, +tags +FROM aws.iot.software_packages +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual software_package. +```sql +SELECT +region, +description, +package_arn, +package_name, +tags +FROM aws.iot.software_packages +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new software_package resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.software_packages ( + Description, + PackageName, + Tags, + region +) +SELECT +'{{ Description }}', + '{{ PackageName }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.software_packages ( + Description, + PackageName, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ PackageName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: software_package + props: + - name: Description + value: '{{ Description }}' + - name: PackageName + value: '{{ PackageName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.software_packages +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iot:ListPackages +``` diff --git a/website/docs/services/iot/software_packages_list_only/index.md b/website/docs/services/iot/software_packages_list_only/index.md new file mode 100644 index 0000000..62273b7 --- /dev/null +++ b/website/docs/services/iot/software_packages_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: software_packages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - software_packages_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists software_packages in a region or regions, for all properties use software_packages + +## Overview + + + + + + + +
Namesoftware_packages_list_only
TypeResource
Descriptionresource definition
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all software_packages in a region. +```sql +SELECT +region, +package_name +FROM aws.iot.software_packages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the software_packages_list_only resource, see software_packages + diff --git a/website/docs/services/iot/thing_group_tags/index.md b/website/docs/services/iot/thing_group_tags/index.md new file mode 100644 index 0000000..0f66902 --- /dev/null +++ b/website/docs/services/iot/thing_group_tags/index.md @@ -0,0 +1,87 @@ +--- +title: thing_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - thing_group_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for thing_groups in a region + +## Overview + + + + + + + +
Namething_group_tags
TypeResource
DescriptionResource Type definition for AWS::IoT::ThingGroup
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all thing_groups in a region. +```sql +SELECT +region, +id, +arn, +thing_group_name, +parent_group_name, +query_string, +thing_group_properties, +tag_key, +tag_value +FROM aws.iot.thing_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the thing_group_tags resource, see thing_groups + diff --git a/website/docs/services/iot/thing_groups/index.md b/website/docs/services/iot/thing_groups/index.md new file mode 100644 index 0000000..a4c3be9 --- /dev/null +++ b/website/docs/services/iot/thing_groups/index.md @@ -0,0 +1,254 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a thing_group resource or lists thing_groups in a region + +## Overview + + + + + + + +
Namething_groups
TypeResource
DescriptionResource Type definition for AWS::IoT::ThingGroup
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IoT::ThingGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all thing_groups in a region. +```sql +SELECT +region, +id, +arn, +thing_group_name, +parent_group_name, +query_string, +thing_group_properties, +tags +FROM aws.iot.thing_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual thing_group. +```sql +SELECT +region, +id, +arn, +thing_group_name, +parent_group_name, +query_string, +thing_group_properties, +tags +FROM aws.iot.thing_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new thing_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.thing_groups ( + ThingGroupName, + ParentGroupName, + QueryString, + ThingGroupProperties, + Tags, + region +) +SELECT +'{{ ThingGroupName }}', + '{{ ParentGroupName }}', + '{{ QueryString }}', + '{{ ThingGroupProperties }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.thing_groups ( + ThingGroupName, + ParentGroupName, + QueryString, + ThingGroupProperties, + Tags, + region +) +SELECT + '{{ ThingGroupName }}', + '{{ ParentGroupName }}', + '{{ QueryString }}', + '{{ ThingGroupProperties }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: thing_group + props: + - name: ThingGroupName + value: '{{ ThingGroupName }}' + - name: ParentGroupName + value: '{{ ParentGroupName }}' + - name: QueryString + value: '{{ QueryString }}' + - name: ThingGroupProperties + value: + AttributePayload: + Attributes: {} + ThingGroupDescription: '{{ ThingGroupDescription }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.thing_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +iot:DescribeThingGroup, +iot:DeleteThingGroup, +iot:DeleteDynamicThingGroup +``` + +### List +```json +iot:ListThingGroups, +iot:ListTagsForResource +``` + +### Read +```json +iot:DescribeThingGroup, +iot:ListTagsForResource +``` + +### Update +```json +iot:ListTagsForResource, +iot:DescribeThingGroup, +iot:UpdateThingGroup, +iot:UpdateDynamicThingGroup, +iot:TagResource, +iot:UntagResource +``` diff --git a/website/docs/services/iot/thing_groups_list_only/index.md b/website/docs/services/iot/thing_groups_list_only/index.md new file mode 100644 index 0000000..af618f2 --- /dev/null +++ b/website/docs/services/iot/thing_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: thing_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - thing_groups_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists thing_groups in a region or regions, for all properties use thing_groups + +## Overview + + + + + + + +
Namething_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::ThingGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all thing_groups in a region. +```sql +SELECT +region, +thing_group_name +FROM aws.iot.thing_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the thing_groups_list_only resource, see thing_groups + diff --git a/website/docs/services/iot/thing_type_tags/index.md b/website/docs/services/iot/thing_type_tags/index.md new file mode 100644 index 0000000..88f118c --- /dev/null +++ b/website/docs/services/iot/thing_type_tags/index.md @@ -0,0 +1,85 @@ +--- +title: thing_type_tags +hide_title: false +hide_table_of_contents: false +keywords: + - thing_type_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for thing_types in a region + +## Overview + + + + + + + +
Namething_type_tags
TypeResource
DescriptionResource Type definition for AWS::IoT::ThingType
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all thing_types in a region. +```sql +SELECT +region, +id, +arn, +thing_type_name, +deprecate_thing_type, +thing_type_properties, +tag_key, +tag_value +FROM aws.iot.thing_type_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the thing_type_tags resource, see thing_types + diff --git a/website/docs/services/iot/thing_types/index.md b/website/docs/services/iot/thing_types/index.md new file mode 100644 index 0000000..52d4863 --- /dev/null +++ b/website/docs/services/iot/thing_types/index.md @@ -0,0 +1,250 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a thing_type resource or lists thing_types in a region + +## Overview + + + + + + + +
Namething_types
TypeResource
DescriptionResource Type definition for AWS::IoT::ThingType
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IoT::ThingType. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all thing_types in a region. +```sql +SELECT +region, +id, +arn, +thing_type_name, +deprecate_thing_type, +thing_type_properties, +tags +FROM aws.iot.thing_types +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual thing_type. +```sql +SELECT +region, +id, +arn, +thing_type_name, +deprecate_thing_type, +thing_type_properties, +tags +FROM aws.iot.thing_types +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new thing_type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.thing_types ( + ThingTypeName, + DeprecateThingType, + ThingTypeProperties, + Tags, + region +) +SELECT +'{{ ThingTypeName }}', + '{{ DeprecateThingType }}', + '{{ ThingTypeProperties }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.thing_types ( + ThingTypeName, + DeprecateThingType, + ThingTypeProperties, + Tags, + region +) +SELECT + '{{ ThingTypeName }}', + '{{ DeprecateThingType }}', + '{{ ThingTypeProperties }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: thing_type + props: + - name: ThingTypeName + value: '{{ ThingTypeName }}' + - name: DeprecateThingType + value: '{{ DeprecateThingType }}' + - name: ThingTypeProperties + value: + SearchableAttributes: + - '{{ SearchableAttributes[0] }}' + ThingTypeDescription: '{{ ThingTypeDescription }}' + Mqtt5Configuration: + PropagatingAttributes: + - UserPropertyKey: '{{ UserPropertyKey }}' + ThingAttribute: '{{ ThingAttribute }}' + ConnectionAttribute: '{{ ConnectionAttribute }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.thing_types +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +iot:DescribeThingType, +iot:DeleteThingType, +iot:DeprecateThingType +``` + +### List +```json +iot:ListThingTypes, +iot:ListTagsForResource +``` + +### Read +```json +iot:DescribeThingType, +iot:ListTagsForResource +``` + +### Update +```json +iot:DescribeThingType, +iot:UpdateThingType, +iot:ListTagsForResource, +iot:TagResource, +iot:UntagResource, +iot:DeprecateThingType +``` diff --git a/website/docs/services/iot/thing_types_list_only/index.md b/website/docs/services/iot/thing_types_list_only/index.md new file mode 100644 index 0000000..8b31816 --- /dev/null +++ b/website/docs/services/iot/thing_types_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: thing_types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - thing_types_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists thing_types in a region or regions, for all properties use thing_types + +## Overview + + + + + + + +
Namething_types_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::ThingType
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all thing_types in a region. +```sql +SELECT +region, +thing_type_name +FROM aws.iot.thing_types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the thing_types_list_only resource, see thing_types + diff --git a/website/docs/services/iot/things/index.md b/website/docs/services/iot/things/index.md new file mode 100644 index 0000000..239c4d1 --- /dev/null +++ b/website/docs/services/iot/things/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a thing resource or lists things in a region + +## Overview + + + + + + + +
Namethings
TypeResource
DescriptionResource Type definition for AWS::IoT::Thing
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
object
string
stringAWS region.
+ +For more information, see AWS::IoT::Thing. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all things in a region. +```sql +SELECT +region, +id, +arn, +attribute_payload, +thing_name +FROM aws.iot.things +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual thing. +```sql +SELECT +region, +id, +arn, +attribute_payload, +thing_name +FROM aws.iot.things +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new thing resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.things ( + AttributePayload, + ThingName, + region +) +SELECT +'{{ AttributePayload }}', + '{{ ThingName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.things ( + AttributePayload, + ThingName, + region +) +SELECT + '{{ AttributePayload }}', + '{{ ThingName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: thing + props: + - name: AttributePayload + value: + Attributes: {} + - name: ThingName + value: '{{ ThingName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.things +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the things resource, the following permissions are required: + +### Create +```json +iot:CreateThing, +iot:DescribeThing +``` + +### Delete +```json +iot:DeleteThing, +iot:DescribeThing +``` + +### List +```json +iot:ListThings +``` + +### Read +```json +iot:DescribeThing +``` + +### Update +```json +iot:UpdateThing, +iot:DescribeThing +``` diff --git a/website/docs/services/iot/things_list_only/index.md b/website/docs/services/iot/things_list_only/index.md new file mode 100644 index 0000000..9d4779b --- /dev/null +++ b/website/docs/services/iot/things_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: things_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - things_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists things in a region or regions, for all properties use things + +## Overview + + + + + + + +
Namethings_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::Thing
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all things in a region. +```sql +SELECT +region, +thing_name +FROM aws.iot.things_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the things_list_only resource, see things + diff --git a/website/docs/services/iot/topic_rule_destinations/index.md b/website/docs/services/iot/topic_rule_destinations/index.md new file mode 100644 index 0000000..db652fe --- /dev/null +++ b/website/docs/services/iot/topic_rule_destinations/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a topic_rule_destination resource or lists topic_rule_destinations in a region + +## Overview + + + + + + + +
Nametopic_rule_destinations
TypeResource
DescriptionResource Type definition for AWS::IoT::TopicRuleDestination
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN).
stringThe status of the TopicRuleDestination.
objectHTTP URL destination properties.
stringThe reasoning for the current status of the TopicRuleDestination.
objectVPC destination properties.
stringAWS region.
+ +For more information, see AWS::IoT::TopicRuleDestination. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all topic_rule_destinations in a region. +```sql +SELECT +region, +arn, +status, +http_url_properties, +status_reason, +vpc_properties +FROM aws.iot.topic_rule_destinations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual topic_rule_destination. +```sql +SELECT +region, +arn, +status, +http_url_properties, +status_reason, +vpc_properties +FROM aws.iot.topic_rule_destinations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new topic_rule_destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.topic_rule_destinations ( + Status, + HttpUrlProperties, + VpcProperties, + region +) +SELECT +'{{ Status }}', + '{{ HttpUrlProperties }}', + '{{ VpcProperties }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.topic_rule_destinations ( + Status, + HttpUrlProperties, + VpcProperties, + region +) +SELECT + '{{ Status }}', + '{{ HttpUrlProperties }}', + '{{ VpcProperties }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: topic_rule_destination + props: + - name: Status + value: '{{ Status }}' + - name: HttpUrlProperties + value: + ConfirmationUrl: '{{ ConfirmationUrl }}' + - name: VpcProperties + value: + SubnetIds: + - '{{ SubnetIds[0] }}' + SecurityGroups: + - '{{ SecurityGroups[0] }}' + VpcId: '{{ VpcId }}' + RoleArn: '{{ RoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.topic_rule_destinations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iot:GetTopicRuleDestination +``` + +### Update +```json +iam:PassRole, +iot:GetTopicRuleDestination, +iot:UpdateTopicRuleDestination +``` + +### Delete +```json +iot:GetTopicRuleDestination, +iot:DeleteTopicRuleDestination +``` + +### List +```json +iot:ListTopicRuleDestinations +``` diff --git a/website/docs/services/iot/topic_rule_destinations_list_only/index.md b/website/docs/services/iot/topic_rule_destinations_list_only/index.md new file mode 100644 index 0000000..2f64749 --- /dev/null +++ b/website/docs/services/iot/topic_rule_destinations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: topic_rule_destinations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - topic_rule_destinations_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists topic_rule_destinations in a region or regions, for all properties use topic_rule_destinations + +## Overview + + + + + + + +
Nametopic_rule_destinations_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::TopicRuleDestination
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN).
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all topic_rule_destinations in a region. +```sql +SELECT +region, +arn +FROM aws.iot.topic_rule_destinations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topic_rule_destinations_list_only resource, see topic_rule_destinations + diff --git a/website/docs/services/iot/topic_rule_tags/index.md b/website/docs/services/iot/topic_rule_tags/index.md new file mode 100644 index 0000000..c6d7713 --- /dev/null +++ b/website/docs/services/iot/topic_rule_tags/index.md @@ -0,0 +1,81 @@ +--- +title: topic_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - topic_rule_tags + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for topic_rules in a region + +## Overview + + + + + + + +
Nametopic_rule_tags
TypeResource
DescriptionResource Type definition for AWS::IoT::TopicRule
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all topic_rules in a region. +```sql +SELECT +region, +arn, +rule_name, +topic_rule_payload, +tag_key, +tag_value +FROM aws.iot.topic_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topic_rule_tags resource, see topic_rules + diff --git a/website/docs/services/iot/topic_rules/index.md b/website/docs/services/iot/topic_rules/index.md new file mode 100644 index 0000000..1f0cd46 --- /dev/null +++ b/website/docs/services/iot/topic_rules/index.md @@ -0,0 +1,379 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a topic_rule resource or lists topic_rules in a region + +## Overview + + + + + + + +
Nametopic_rules
TypeResource
DescriptionResource Type definition for AWS::IoT::TopicRule
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
object
array
stringAWS region.
+ +For more information, see AWS::IoT::TopicRule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all topic_rules in a region. +```sql +SELECT +region, +arn, +rule_name, +topic_rule_payload, +tags +FROM aws.iot.topic_rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual topic_rule. +```sql +SELECT +region, +arn, +rule_name, +topic_rule_payload, +tags +FROM aws.iot.topic_rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new topic_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iot.topic_rules ( + TopicRulePayload, + region +) +SELECT +'{{ TopicRulePayload }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iot.topic_rules ( + RuleName, + TopicRulePayload, + Tags, + region +) +SELECT + '{{ RuleName }}', + '{{ TopicRulePayload }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: topic_rule + props: + - name: RuleName + value: '{{ RuleName }}' + - name: TopicRulePayload + value: + RuleDisabled: '{{ RuleDisabled }}' + ErrorAction: + CloudwatchAlarm: + StateValue: '{{ StateValue }}' + AlarmName: '{{ AlarmName }}' + StateReason: '{{ StateReason }}' + RoleArn: '{{ RoleArn }}' + CloudwatchLogs: + LogGroupName: '{{ LogGroupName }}' + RoleArn: '{{ RoleArn }}' + BatchMode: '{{ BatchMode }}' + CloudwatchMetric: + MetricName: '{{ MetricName }}' + MetricValue: '{{ MetricValue }}' + MetricNamespace: '{{ MetricNamespace }}' + MetricUnit: '{{ MetricUnit }}' + RoleArn: '{{ RoleArn }}' + MetricTimestamp: '{{ MetricTimestamp }}' + DynamoDB: + TableName: '{{ TableName }}' + PayloadField: '{{ PayloadField }}' + RangeKeyField: '{{ RangeKeyField }}' + HashKeyField: '{{ HashKeyField }}' + RangeKeyValue: '{{ RangeKeyValue }}' + RangeKeyType: '{{ RangeKeyType }}' + HashKeyType: '{{ HashKeyType }}' + HashKeyValue: '{{ HashKeyValue }}' + RoleArn: '{{ RoleArn }}' + DynamoDBv2: + PutItem: + TableName: '{{ TableName }}' + RoleArn: '{{ RoleArn }}' + Elasticsearch: + Type: '{{ Type }}' + Index: '{{ Index }}' + Id: '{{ Id }}' + Endpoint: '{{ Endpoint }}' + RoleArn: '{{ RoleArn }}' + Firehose: + DeliveryStreamName: '{{ DeliveryStreamName }}' + RoleArn: '{{ RoleArn }}' + Separator: '{{ Separator }}' + BatchMode: '{{ BatchMode }}' + Http: + ConfirmationUrl: '{{ ConfirmationUrl }}' + Headers: + - Value: '{{ Value }}' + Key: '{{ Key }}' + Url: '{{ Url }}' + Auth: + Sigv4: + ServiceName: '{{ ServiceName }}' + SigningRegion: '{{ SigningRegion }}' + RoleArn: '{{ RoleArn }}' + IotAnalytics: + RoleArn: '{{ RoleArn }}' + ChannelName: '{{ ChannelName }}' + BatchMode: '{{ BatchMode }}' + IotEvents: + InputName: '{{ InputName }}' + RoleArn: '{{ RoleArn }}' + MessageId: '{{ MessageId }}' + BatchMode: '{{ BatchMode }}' + IotSiteWise: + RoleArn: '{{ RoleArn }}' + PutAssetPropertyValueEntries: + - PropertyAlias: '{{ PropertyAlias }}' + PropertyValues: + - Value: + StringValue: '{{ StringValue }}' + DoubleValue: '{{ DoubleValue }}' + BooleanValue: '{{ BooleanValue }}' + IntegerValue: '{{ IntegerValue }}' + Timestamp: + TimeInSeconds: '{{ TimeInSeconds }}' + OffsetInNanos: '{{ OffsetInNanos }}' + Quality: '{{ Quality }}' + AssetId: '{{ AssetId }}' + EntryId: '{{ EntryId }}' + PropertyId: '{{ PropertyId }}' + Kafka: + DestinationArn: '{{ DestinationArn }}' + Topic: '{{ Topic }}' + Key: '{{ Key }}' + Partition: '{{ Partition }}' + ClientProperties: {} + Headers: + - Value: '{{ Value }}' + Key: '{{ Key }}' + Kinesis: + PartitionKey: '{{ PartitionKey }}' + StreamName: '{{ StreamName }}' + RoleArn: '{{ RoleArn }}' + Lambda: + FunctionArn: '{{ FunctionArn }}' + Location: + RoleArn: '{{ RoleArn }}' + TrackerName: '{{ TrackerName }}' + DeviceId: '{{ DeviceId }}' + Latitude: '{{ Latitude }}' + Longitude: '{{ Longitude }}' + Timestamp: + Value: '{{ Value }}' + Unit: '{{ Unit }}' + OpenSearch: + Type: '{{ Type }}' + Index: '{{ Index }}' + Id: '{{ Id }}' + Endpoint: '{{ Endpoint }}' + RoleArn: '{{ RoleArn }}' + Republish: + Qos: '{{ Qos }}' + Topic: '{{ Topic }}' + RoleArn: '{{ RoleArn }}' + Headers: + PayloadFormatIndicator: '{{ PayloadFormatIndicator }}' + ContentType: '{{ ContentType }}' + ResponseTopic: '{{ ResponseTopic }}' + CorrelationData: '{{ CorrelationData }}' + MessageExpiry: '{{ MessageExpiry }}' + UserProperties: + - Key: '{{ Key }}' + Value: '{{ Value }}' + S3: + BucketName: '{{ BucketName }}' + Key: '{{ Key }}' + RoleArn: '{{ RoleArn }}' + CannedAcl: '{{ CannedAcl }}' + Sns: + TargetArn: '{{ TargetArn }}' + MessageFormat: '{{ MessageFormat }}' + RoleArn: '{{ RoleArn }}' + Sqs: + RoleArn: '{{ RoleArn }}' + UseBase64: '{{ UseBase64 }}' + QueueUrl: '{{ QueueUrl }}' + StepFunctions: + ExecutionNamePrefix: '{{ ExecutionNamePrefix }}' + StateMachineName: '{{ StateMachineName }}' + RoleArn: '{{ RoleArn }}' + Timestream: + RoleArn: '{{ RoleArn }}' + DatabaseName: '{{ DatabaseName }}' + TableName: '{{ TableName }}' + Dimensions: + - Name: '{{ Name }}' + Value: '{{ Value }}' + Timestamp: + Value: '{{ Value }}' + Unit: '{{ Unit }}' + Description: '{{ Description }}' + AwsIotSqlVersion: '{{ AwsIotSqlVersion }}' + Actions: + - null + Sql: '{{ Sql }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iot.topic_rules +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iot:ListTopicRules +``` diff --git a/website/docs/services/iot/topic_rules_list_only/index.md b/website/docs/services/iot/topic_rules_list_only/index.md new file mode 100644 index 0000000..7cfb3ee --- /dev/null +++ b/website/docs/services/iot/topic_rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: topic_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - topic_rules_list_only + - iot + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists topic_rules in a region or regions, for all properties use topic_rules + +## Overview + + + + + + + +
Nametopic_rules_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::TopicRule
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all topic_rules in a region. +```sql +SELECT +region, +rule_name +FROM aws.iot.topic_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topic_rules_list_only resource, see topic_rules + diff --git a/website/docs/services/iotanalytics/dataset_tags/index.md b/website/docs/services/iotanalytics/dataset_tags/index.md new file mode 100644 index 0000000..69fa7cd --- /dev/null +++ b/website/docs/services/iotanalytics/dataset_tags/index.md @@ -0,0 +1,91 @@ +--- +title: dataset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_tags + - iotanalytics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for datasets in a region + +## Overview + + + + + + + +
Namedataset_tags
TypeResource
DescriptionResource Type definition for AWS::IoTAnalytics::Dataset
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
string
array
array
object
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all datasets in a region. +```sql +SELECT +region, +actions, +late_data_rules, +dataset_name, +content_delivery_rules, +triggers, +versioning_configuration, +id, +retention_period, +tag_key, +tag_value +FROM aws.iotanalytics.dataset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_tags resource, see datasets + diff --git a/website/docs/services/iotanalytics/datasets/index.md b/website/docs/services/iotanalytics/datasets/index.md new file mode 100644 index 0000000..14f8e90 --- /dev/null +++ b/website/docs/services/iotanalytics/datasets/index.md @@ -0,0 +1,296 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dataset resource or lists datasets in a region + +## Overview + + + + + + + +
Namedatasets
TypeResource
DescriptionResource Type definition for AWS::IoTAnalytics::Dataset
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
string
array
array
object
string
object
array
stringAWS region.
+ +For more information, see AWS::IoTAnalytics::Dataset. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all datasets in a region. +```sql +SELECT +region, +actions, +late_data_rules, +dataset_name, +content_delivery_rules, +triggers, +versioning_configuration, +id, +retention_period, +tags +FROM aws.iotanalytics.datasets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dataset. +```sql +SELECT +region, +actions, +late_data_rules, +dataset_name, +content_delivery_rules, +triggers, +versioning_configuration, +id, +retention_period, +tags +FROM aws.iotanalytics.datasets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dataset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotanalytics.datasets ( + Actions, + region +) +SELECT +'{{ Actions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotanalytics.datasets ( + Actions, + LateDataRules, + DatasetName, + ContentDeliveryRules, + Triggers, + VersioningConfiguration, + RetentionPeriod, + Tags, + region +) +SELECT + '{{ Actions }}', + '{{ LateDataRules }}', + '{{ DatasetName }}', + '{{ ContentDeliveryRules }}', + '{{ Triggers }}', + '{{ VersioningConfiguration }}', + '{{ RetentionPeriod }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dataset + props: + - name: Actions + value: + - ActionName: '{{ ActionName }}' + ContainerAction: + Variables: + - VariableName: '{{ VariableName }}' + DatasetContentVersionValue: + DatasetName: '{{ DatasetName }}' + StringValue: '{{ StringValue }}' + DoubleValue: null + OutputFileUriValue: + FileName: '{{ FileName }}' + ExecutionRoleArn: '{{ ExecutionRoleArn }}' + Image: '{{ Image }}' + ResourceConfiguration: + VolumeSizeInGB: '{{ VolumeSizeInGB }}' + ComputeType: '{{ ComputeType }}' + QueryAction: + Filters: + - Filter: '{{ Filter }}' + Next: '{{ Next }}' + Name: '{{ Name }}' + SqlQuery: '{{ SqlQuery }}' + - name: LateDataRules + value: + - RuleConfiguration: + DeltaTimeSessionWindowConfiguration: + TimeoutInMinutes: '{{ TimeoutInMinutes }}' + RuleName: '{{ RuleName }}' + - name: DatasetName + value: '{{ DatasetName }}' + - name: ContentDeliveryRules + value: + - Destination: + IotEventsDestinationConfiguration: + InputName: '{{ InputName }}' + RoleArn: '{{ RoleArn }}' + S3DestinationConfiguration: + GlueConfiguration: + DatabaseName: '{{ DatabaseName }}' + TableName: '{{ TableName }}' + Bucket: '{{ Bucket }}' + Key: '{{ Key }}' + RoleArn: '{{ RoleArn }}' + EntryName: '{{ EntryName }}' + - name: Triggers + value: + - TriggeringDataset: + DatasetName: '{{ DatasetName }}' + Schedule: + ScheduleExpression: '{{ ScheduleExpression }}' + - name: VersioningConfiguration + value: + Unlimited: '{{ Unlimited }}' + MaxVersions: '{{ MaxVersions }}' + - name: RetentionPeriod + value: + NumberOfDays: '{{ NumberOfDays }}' + Unlimited: '{{ Unlimited }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotanalytics.datasets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the datasets resource, the following permissions are required: + +### Create +```json +iotanalytics:CreateDataset +``` + +### Read +```json +iotanalytics:DescribeDataset, +iotanalytics:ListTagsForResource +``` + +### Update +```json +iotanalytics:UpdateDataset, +iotanalytics:TagResource, +iotanalytics:UntagResource +``` + +### Delete +```json +iotanalytics:DeleteDataset +``` + +### List +```json +iotanalytics:ListDatasets +``` diff --git a/website/docs/services/iotanalytics/datasets_list_only/index.md b/website/docs/services/iotanalytics/datasets_list_only/index.md new file mode 100644 index 0000000..ab03654 --- /dev/null +++ b/website/docs/services/iotanalytics/datasets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: datasets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - datasets_list_only + - iotanalytics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists datasets in a region or regions, for all properties use datasets + +## Overview + + + + + + + +
Namedatasets_list_only
TypeResource
DescriptionResource Type definition for AWS::IoTAnalytics::Dataset
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all datasets in a region. +```sql +SELECT +region, +dataset_name +FROM aws.iotanalytics.datasets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datasets_list_only resource, see datasets + diff --git a/website/docs/services/iotanalytics/index.md b/website/docs/services/iotanalytics/index.md new file mode 100644 index 0000000..c39a488 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The iotanalytics service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/iotanalytics/pipeline_tags/index.md b/website/docs/services/iotanalytics/pipeline_tags/index.md new file mode 100644 index 0000000..827fc3f --- /dev/null +++ b/website/docs/services/iotanalytics/pipeline_tags/index.md @@ -0,0 +1,81 @@ +--- +title: pipeline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline_tags + - iotanalytics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pipelines in a region + +## Overview + + + + + + + +
Namepipeline_tags
TypeResource
DescriptionResource Type definition for AWS::IoTAnalytics::Pipeline
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pipelines in a region. +```sql +SELECT +region, +id, +pipeline_name, +pipeline_activities, +tag_key, +tag_value +FROM aws.iotanalytics.pipeline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipeline_tags resource, see pipelines + diff --git a/website/docs/services/iotanalytics/pipelines/index.md b/website/docs/services/iotanalytics/pipelines/index.md new file mode 100644 index 0000000..268319d --- /dev/null +++ b/website/docs/services/iotanalytics/pipelines/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a pipeline resource or lists pipelines in a region + +## Overview + + + + + + + +
Namepipelines
TypeResource
DescriptionResource Type definition for AWS::IoTAnalytics::Pipeline
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
array
array
stringAWS region.
+ +For more information, see AWS::IoTAnalytics::Pipeline. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all pipelines in a region. +```sql +SELECT +region, +id, +pipeline_name, +tags, +pipeline_activities +FROM aws.iotanalytics.pipelines +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual pipeline. +```sql +SELECT +region, +id, +pipeline_name, +tags, +pipeline_activities +FROM aws.iotanalytics.pipelines +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotanalytics.pipelines ( + PipelineActivities, + region +) +SELECT +'{{ PipelineActivities }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotanalytics.pipelines ( + PipelineName, + Tags, + PipelineActivities, + region +) +SELECT + '{{ PipelineName }}', + '{{ Tags }}', + '{{ PipelineActivities }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: pipeline + props: + - name: PipelineName + value: '{{ PipelineName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: PipelineActivities + value: + - SelectAttributes: + Next: '{{ Next }}' + Attributes: + - '{{ Attributes[0] }}' + Name: '{{ Name }}' + Datastore: + DatastoreName: '{{ DatastoreName }}' + Name: '{{ Name }}' + Filter: + Filter: '{{ Filter }}' + Next: '{{ Next }}' + Name: '{{ Name }}' + AddAttributes: + Next: '{{ Next }}' + Attributes: {} + Name: '{{ Name }}' + Channel: + ChannelName: '{{ ChannelName }}' + Next: '{{ Next }}' + Name: '{{ Name }}' + DeviceShadowEnrich: + Attribute: '{{ Attribute }}' + Next: '{{ Next }}' + ThingName: '{{ ThingName }}' + RoleArn: '{{ RoleArn }}' + Name: '{{ Name }}' + Math: + Attribute: '{{ Attribute }}' + Next: '{{ Next }}' + Math: '{{ Math }}' + Name: '{{ Name }}' + Lambda: + BatchSize: '{{ BatchSize }}' + Next: '{{ Next }}' + LambdaName: '{{ LambdaName }}' + Name: '{{ Name }}' + DeviceRegistryEnrich: + Attribute: '{{ Attribute }}' + Next: '{{ Next }}' + ThingName: '{{ ThingName }}' + RoleArn: '{{ RoleArn }}' + Name: '{{ Name }}' + RemoveAttributes: + Next: '{{ Next }}' + Attributes: + - '{{ Attributes[0] }}' + Name: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotanalytics.pipelines +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the pipelines resource, the following permissions are required: + +### Create +```json +iotanalytics:CreatePipeline +``` + +### Read +```json +iotanalytics:DescribePipeline, +iotanalytics:ListTagsForResource +``` + +### Update +```json +iotanalytics:UpdatePipeline, +iotanalytics:TagResource, +iotanalytics:UntagResource +``` + +### Delete +```json +iotanalytics:DeletePipeline +``` + +### List +```json +iotanalytics:ListPipelines +``` diff --git a/website/docs/services/iotanalytics/pipelines_list_only/index.md b/website/docs/services/iotanalytics/pipelines_list_only/index.md new file mode 100644 index 0000000..9d389b4 --- /dev/null +++ b/website/docs/services/iotanalytics/pipelines_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipelines in a region or regions, for all properties use pipelines + +## Overview + + + + + + + +
Namepipelines_list_only
TypeResource
DescriptionResource Type definition for AWS::IoTAnalytics::Pipeline
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipelines in a region. +```sql +SELECT +region, +pipeline_name +FROM aws.iotanalytics.pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipelines_list_only resource, see pipelines + diff --git a/website/docs/services/iotcoredeviceadvisor/index.md b/website/docs/services/iotcoredeviceadvisor/index.md new file mode 100644 index 0000000..c300051 --- /dev/null +++ b/website/docs/services/iotcoredeviceadvisor/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The iotcoredeviceadvisor service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/iotcoredeviceadvisor/suite_definition_tags/index.md b/website/docs/services/iotcoredeviceadvisor/suite_definition_tags/index.md new file mode 100644 index 0000000..a56049a --- /dev/null +++ b/website/docs/services/iotcoredeviceadvisor/suite_definition_tags/index.md @@ -0,0 +1,83 @@ +--- +title: suite_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - suite_definition_tags + - iotcoredeviceadvisor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for suite_definitions in a region + +## Overview + + + + + + + +
Namesuite_definition_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
object
stringThe unique identifier for the suite definition.
stringThe Amazon Resource name for the suite definition.
stringThe suite definition version of a test suite.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all suite_definitions in a region. +```sql +SELECT +region, +suite_definition_configuration, +suite_definition_id, +suite_definition_arn, +suite_definition_version, +tag_key, +tag_value +FROM aws.iotcoredeviceadvisor.suite_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the suite_definition_tags resource, see suite_definitions + diff --git a/website/docs/services/iotcoredeviceadvisor/suite_definitions/index.md b/website/docs/services/iotcoredeviceadvisor/suite_definitions/index.md new file mode 100644 index 0000000..90d1687 --- /dev/null +++ b/website/docs/services/iotcoredeviceadvisor/suite_definitions/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a suite_definition resource or lists suite_definitions in a region + +## Overview + + + + + + + +
Namesuite_definitions
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
object
stringThe unique identifier for the suite definition.
stringThe Amazon Resource name for the suite definition.
stringThe suite definition version of a test suite.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IoTCoreDeviceAdvisor::SuiteDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all suite_definitions in a region. +```sql +SELECT +region, +suite_definition_configuration, +suite_definition_id, +suite_definition_arn, +suite_definition_version, +tags +FROM aws.iotcoredeviceadvisor.suite_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual suite_definition. +```sql +SELECT +region, +suite_definition_configuration, +suite_definition_id, +suite_definition_arn, +suite_definition_version, +tags +FROM aws.iotcoredeviceadvisor.suite_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new suite_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotcoredeviceadvisor.suite_definitions ( + SuiteDefinitionConfiguration, + region +) +SELECT +'{{ SuiteDefinitionConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotcoredeviceadvisor.suite_definitions ( + SuiteDefinitionConfiguration, + Tags, + region +) +SELECT + '{{ SuiteDefinitionConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: suite_definition + props: + - name: SuiteDefinitionConfiguration + value: + DevicePermissionRoleArn: '{{ DevicePermissionRoleArn }}' + Devices: + - CertificateArn: '{{ CertificateArn }}' + ThingArn: '{{ ThingArn }}' + IntendedForQualification: '{{ IntendedForQualification }}' + RootGroup: '{{ RootGroup }}' + SuiteDefinitionName: '{{ SuiteDefinitionName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotcoredeviceadvisor.suite_definitions +WHERE data__Identifier = '' +AND 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:ListThingPrincipals, +iot:ListThings, +iotdeviceadvisor:CreateSuiteDefinition, +iotdeviceadvisor:TagResource, +iam:PassRole +``` + +### Read +```json +iotdeviceadvisor:GetSuiteDefinition, +iot:ListTagsForResource +``` + +### Update +```json +iot:DescribeCertificate, +iot:DescribeThing, +iot:GetPolicy, +iot:ListAttachedPolicies, +iot:ListCertificates, +iot:ListPrincipalPolicies, +iot:ListThingPrincipals, +iot:ListThings, +iotdeviceadvisor:UpdateSuiteDefinition, +iotdeviceadvisor:GetSuiteDefinition, +iotdeviceadvisor:UntagResource, +iotdeviceadvisor:TagResource, +iam:PassRole +``` + +### Delete +```json +iotdeviceadvisor:GetSuiteDefinition, +iotdeviceadvisor:DeleteSuiteDefinition +``` + +### List +```json +iotdeviceadvisor:ListSuiteDefinitions +``` diff --git a/website/docs/services/iotcoredeviceadvisor/suite_definitions_list_only/index.md b/website/docs/services/iotcoredeviceadvisor/suite_definitions_list_only/index.md new file mode 100644 index 0000000..bcd1e50 --- /dev/null +++ b/website/docs/services/iotcoredeviceadvisor/suite_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: suite_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - suite_definitions_list_only + - iotcoredeviceadvisor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists suite_definitions in a region or regions, for all properties use suite_definitions + +## Overview + + + + + + + +
Namesuite_definitions_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier for the suite definition.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all suite_definitions in a region. +```sql +SELECT +region, +suite_definition_id +FROM aws.iotcoredeviceadvisor.suite_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the suite_definitions_list_only resource, see suite_definitions + diff --git a/website/docs/services/iotevents/alarm_model_tags/index.md b/website/docs/services/iotevents/alarm_model_tags/index.md new file mode 100644 index 0000000..3e4e26f --- /dev/null +++ b/website/docs/services/iotevents/alarm_model_tags/index.md @@ -0,0 +1,91 @@ +--- +title: alarm_model_tags +hide_title: false +hide_table_of_contents: false +keywords: + - alarm_model_tags + - iotevents + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for alarm_models in a region + +## Overview + + + + + + + +
Namealarm_model_tags
TypeResource
DescriptionRepresents an alarm model to monitor an ITE input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see [Create an alarm model](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the alarm model.
stringThe description of the alarm model.
stringThe ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
stringAn input attribute used as a key to create an alarm. ITE routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm.
integerA non-negative integer that reflects the severity level of the alarm.
objectDefines when your alarm is invoked.
objectContains information about one or more alarm actions.
objectContains the configuration information of alarm state changes.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all alarm_models in a region. +```sql +SELECT +region, +alarm_model_name, +alarm_model_description, +role_arn, +key, +severity, +alarm_rule, +alarm_event_actions, +alarm_capabilities, +tag_key, +tag_value +FROM aws.iotevents.alarm_model_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alarm_model_tags resource, see alarm_models + diff --git a/website/docs/services/iotevents/alarm_models/index.md b/website/docs/services/iotevents/alarm_models/index.md new file mode 100644 index 0000000..b4cb5f4 --- /dev/null +++ b/website/docs/services/iotevents/alarm_models/index.md @@ -0,0 +1,327 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an alarm_model resource or lists alarm_models in a region + +## Overview + + + + + + + +
Namealarm_models
TypeResource
DescriptionRepresents an alarm model to monitor an ITE input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see [Create an alarm model](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the alarm model.
stringThe description of the alarm model.
stringThe ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
stringAn input attribute used as a key to create an alarm. ITE routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm.
integerA non-negative integer that reflects the severity level of the alarm.
objectDefines when your alarm is invoked.
objectContains information about one or more alarm actions.
objectContains the configuration information of alarm state changes.
arrayA list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see [Tagging your resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the *Developer Guide*.
You can create up to 50 tags for one alarm model.
stringAWS region.
+ +For more information, see AWS::IoTEvents::AlarmModel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all alarm_models in a region. +```sql +SELECT +region, +alarm_model_name, +alarm_model_description, +role_arn, +key, +severity, +alarm_rule, +alarm_event_actions, +alarm_capabilities, +tags +FROM aws.iotevents.alarm_models +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual alarm_model. +```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_models +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alarm_model resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotevents.alarm_models ( + RoleArn, + AlarmRule, + region +) +SELECT +'{{ RoleArn }}', + '{{ AlarmRule }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotevents.alarm_models ( + AlarmModelName, + AlarmModelDescription, + RoleArn, + Key, + Severity, + AlarmRule, + AlarmEventActions, + AlarmCapabilities, + Tags, + region +) +SELECT + '{{ AlarmModelName }}', + '{{ AlarmModelDescription }}', + '{{ RoleArn }}', + '{{ Key }}', + '{{ Severity }}', + '{{ AlarmRule }}', + '{{ AlarmEventActions }}', + '{{ AlarmCapabilities }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: alarm_model + props: + - name: AlarmModelName + value: '{{ AlarmModelName }}' + - name: AlarmModelDescription + value: '{{ AlarmModelDescription }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Key + value: '{{ Key }}' + - name: Severity + value: '{{ Severity }}' + - name: AlarmRule + value: + SimpleRule: + InputProperty: '{{ InputProperty }}' + ComparisonOperator: '{{ ComparisonOperator }}' + Threshold: '{{ Threshold }}' + - name: AlarmEventActions + value: + AlarmActions: + - DynamoDB: + HashKeyField: '{{ HashKeyField }}' + HashKeyType: '{{ HashKeyType }}' + HashKeyValue: '{{ HashKeyValue }}' + Operation: '{{ Operation }}' + Payload: + ContentExpression: '{{ ContentExpression }}' + Type: '{{ Type }}' + PayloadField: '{{ PayloadField }}' + RangeKeyField: '{{ RangeKeyField }}' + RangeKeyType: '{{ RangeKeyType }}' + RangeKeyValue: '{{ RangeKeyValue }}' + TableName: '{{ TableName }}' + DynamoDBv2: + Payload: null + TableName: '{{ TableName }}' + Firehose: + DeliveryStreamName: '{{ DeliveryStreamName }}' + Payload: null + Separator: '{{ Separator }}' + IotEvents: + InputName: '{{ InputName }}' + Payload: null + IotSiteWise: + AssetId: '{{ AssetId }}' + EntryId: '{{ EntryId }}' + PropertyAlias: '{{ PropertyAlias }}' + PropertyId: '{{ PropertyId }}' + PropertyValue: + Quality: '{{ Quality }}' + Timestamp: + OffsetInNanos: '{{ OffsetInNanos }}' + TimeInSeconds: '{{ TimeInSeconds }}' + Value: + BooleanValue: '{{ BooleanValue }}' + DoubleValue: '{{ DoubleValue }}' + IntegerValue: '{{ IntegerValue }}' + StringValue: '{{ StringValue }}' + IotTopicPublish: + MqttTopic: '{{ MqttTopic }}' + Payload: null + Lambda: + FunctionArn: '{{ FunctionArn }}' + Payload: null + Sns: + Payload: null + TargetArn: '{{ TargetArn }}' + Sqs: + Payload: null + QueueUrl: '{{ QueueUrl }}' + UseBase64: '{{ UseBase64 }}' + - name: AlarmCapabilities + value: + InitializationConfiguration: + DisabledOnInitialization: '{{ DisabledOnInitialization }}' + AcknowledgeFlow: + Enabled: '{{ Enabled }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotevents.alarm_models +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iotevents:ListAlarmModels +``` diff --git a/website/docs/services/iotevents/alarm_models_list_only/index.md b/website/docs/services/iotevents/alarm_models_list_only/index.md new file mode 100644 index 0000000..8fcabe0 --- /dev/null +++ b/website/docs/services/iotevents/alarm_models_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: alarm_models_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - alarm_models_list_only + - iotevents + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists alarm_models in a region or regions, for all properties use alarm_models + +## Overview + + + + + + + +
Namealarm_models_list_only
TypeResource
DescriptionRepresents an alarm model to monitor an ITE input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see [Create an alarm model](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the alarm model.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all alarm_models in a region. +```sql +SELECT +region, +alarm_model_name +FROM aws.iotevents.alarm_models_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alarm_models_list_only resource, see alarm_models + diff --git a/website/docs/services/iotevents/detector_model_tags/index.md b/website/docs/services/iotevents/detector_model_tags/index.md new file mode 100644 index 0000000..9c54611 --- /dev/null +++ b/website/docs/services/iotevents/detector_model_tags/index.md @@ -0,0 +1,87 @@ +--- +title: detector_model_tags +hide_title: false +hide_table_of_contents: false +keywords: + - detector_model_tags + - iotevents + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for detector_models in a region + +## Overview + + + + + + + +
Namedetector_model_tags
TypeResource
DescriptionThe AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) all detector instances created by the model are reset to their initial states. (The detector's state, and the values of any variables and timers are reset.)
When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.)
If you attempt to update a detector model using CFN and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset.
Also, be aware that if you attempt to update several detector models at once using CFN, some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectInformation that defines how a detector operates.
stringA brief description of the detector model.
stringThe name of the detector model.
stringInformation about the order in which events are evaluated and how actions are executed.
stringThe value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. ITE can continue to route input to its corresponding detector instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
stringThe ARN of the role that grants permission to ITE to perform its operations.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all detector_models in a region. +```sql +SELECT +region, +detector_model_definition, +detector_model_description, +detector_model_name, +evaluation_method, +key, +role_arn, +tag_key, +tag_value +FROM aws.iotevents.detector_model_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detector_model_tags resource, see detector_models + diff --git a/website/docs/services/iotevents/detector_models/index.md b/website/docs/services/iotevents/detector_models/index.md new file mode 100644 index 0000000..844461a --- /dev/null +++ b/website/docs/services/iotevents/detector_models/index.md @@ -0,0 +1,335 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a detector_model resource or lists 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](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) all detector instances created by the model are reset to their initial states. (The detector's state, and the values of any variables and timers are reset.)
When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.)
If you attempt to update a detector model using CFN and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset.
Also, be aware that if you attempt to update several detector models at once using CFN, some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectInformation that defines how a detector operates.
stringA brief description of the detector model.
stringThe name of the detector model.
stringInformation about the order in which events are evaluated and how actions are executed.
stringThe value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. ITE can continue to route input to its corresponding detector instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
stringThe ARN of the role that grants permission to ITE to perform its operations.
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
+ +For more information, see AWS::IoTEvents::DetectorModel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all detector_models in a region. +```sql +SELECT +region, +detector_model_definition, +detector_model_description, +detector_model_name, +evaluation_method, +key, +role_arn, +tags +FROM aws.iotevents.detector_models +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual detector_model. +```sql +SELECT +region, +detector_model_definition, +detector_model_description, +detector_model_name, +evaluation_method, +key, +role_arn, +tags +FROM aws.iotevents.detector_models +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new detector_model resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotevents.detector_models ( + DetectorModelDefinition, + RoleArn, + region +) +SELECT +'{{ DetectorModelDefinition }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotevents.detector_models ( + DetectorModelDefinition, + DetectorModelDescription, + DetectorModelName, + EvaluationMethod, + Key, + RoleArn, + Tags, + region +) +SELECT + '{{ DetectorModelDefinition }}', + '{{ DetectorModelDescription }}', + '{{ DetectorModelName }}', + '{{ EvaluationMethod }}', + '{{ Key }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: detector_model + props: + - name: DetectorModelDefinition + value: + InitialStateName: '{{ InitialStateName }}' + States: + - OnEnter: + Events: + - Actions: + - ClearTimer: + TimerName: '{{ TimerName }}' + DynamoDB: + HashKeyField: '{{ HashKeyField }}' + HashKeyType: '{{ HashKeyType }}' + HashKeyValue: '{{ HashKeyValue }}' + Operation: '{{ Operation }}' + Payload: + ContentExpression: '{{ ContentExpression }}' + Type: '{{ Type }}' + PayloadField: '{{ PayloadField }}' + RangeKeyField: '{{ RangeKeyField }}' + RangeKeyType: '{{ RangeKeyType }}' + RangeKeyValue: '{{ RangeKeyValue }}' + TableName: '{{ TableName }}' + DynamoDBv2: + Payload: null + TableName: '{{ TableName }}' + Firehose: + DeliveryStreamName: '{{ DeliveryStreamName }}' + Payload: null + Separator: '{{ Separator }}' + IotEvents: + InputName: '{{ InputName }}' + Payload: null + IotSiteWise: + AssetId: '{{ AssetId }}' + EntryId: '{{ EntryId }}' + PropertyAlias: '{{ PropertyAlias }}' + PropertyId: '{{ PropertyId }}' + PropertyValue: + Quality: '{{ Quality }}' + Timestamp: + OffsetInNanos: '{{ OffsetInNanos }}' + TimeInSeconds: '{{ TimeInSeconds }}' + Value: + BooleanValue: '{{ BooleanValue }}' + DoubleValue: '{{ DoubleValue }}' + IntegerValue: '{{ IntegerValue }}' + StringValue: '{{ StringValue }}' + IotTopicPublish: + MqttTopic: '{{ MqttTopic }}' + Payload: null + Lambda: + FunctionArn: '{{ FunctionArn }}' + Payload: null + ResetTimer: + TimerName: '{{ TimerName }}' + SetTimer: + DurationExpression: '{{ DurationExpression }}' + Seconds: '{{ Seconds }}' + TimerName: '{{ TimerName }}' + SetVariable: + Value: '{{ Value }}' + VariableName: '{{ VariableName }}' + Sns: + Payload: null + TargetArn: '{{ TargetArn }}' + Sqs: + Payload: null + QueueUrl: '{{ QueueUrl }}' + UseBase64: '{{ UseBase64 }}' + Condition: '{{ Condition }}' + EventName: '{{ EventName }}' + OnExit: + Events: + - null + OnInput: + Events: + - null + TransitionEvents: + - Actions: + - null + Condition: '{{ Condition }}' + EventName: '{{ EventName }}' + NextState: '{{ NextState }}' + StateName: '{{ StateName }}' + - name: DetectorModelDescription + value: '{{ DetectorModelDescription }}' + - name: DetectorModelName + value: '{{ DetectorModelName }}' + - name: EvaluationMethod + value: '{{ EvaluationMethod }}' + - name: Key + value: '{{ Key }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotevents.detector_models +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iotevents:ListDetectorModels +``` diff --git a/website/docs/services/iotevents/detector_models_list_only/index.md b/website/docs/services/iotevents/detector_models_list_only/index.md new file mode 100644 index 0000000..712b053 --- /dev/null +++ b/website/docs/services/iotevents/detector_models_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: detector_models_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - detector_models_list_only + - iotevents + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists detector_models in a region or regions, for all properties use detector_models + +## Overview + + + + + + + +
Namedetector_models_list_only
TypeResource
DescriptionThe AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) all detector instances created by the model are reset to their initial states. (The detector's state, and the values of any variables and timers are reset.)
When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.)
If you attempt to update a detector model using CFN and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset.
Also, be aware that if you attempt to update several detector models at once using CFN, some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the detector model.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all detector_models in a region. +```sql +SELECT +region, +detector_model_name +FROM aws.iotevents.detector_models_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detector_models_list_only resource, see detector_models + diff --git a/website/docs/services/iotevents/index.md b/website/docs/services/iotevents/index.md new file mode 100644 index 0000000..afdebdd --- /dev/null +++ b/website/docs/services/iotevents/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The iotevents service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/iotevents/input_tags/index.md b/website/docs/services/iotevents/input_tags/index.md new file mode 100644 index 0000000..df44e62 --- /dev/null +++ b/website/docs/services/iotevents/input_tags/index.md @@ -0,0 +1,81 @@ +--- +title: input_tags +hide_title: false +hide_table_of_contents: false +keywords: + - input_tags + - iotevents + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for inputs in a region + +## Overview + + + + + + + +
Nameinput_tags
TypeResource
DescriptionThe AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into ITE. This is done by sending messages as *inputs* to ITE. For more information, see [How to Use](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
objectThe definition of the input.
stringA brief description of the input.
stringThe name of the input.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all inputs in a region. +```sql +SELECT +region, +input_definition, +input_description, +input_name, +tag_key, +tag_value +FROM aws.iotevents.input_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the input_tags resource, see inputs + diff --git a/website/docs/services/iotevents/inputs/index.md b/website/docs/services/iotevents/inputs/index.md new file mode 100644 index 0000000..6ce3b5e --- /dev/null +++ b/website/docs/services/iotevents/inputs/index.md @@ -0,0 +1,228 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an input resource or lists 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 ITE. This is done by sending messages as *inputs* to ITE. For more information, see [How to Use](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectThe definition of the input.
stringA brief description of the input.
stringThe name of the input.
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
+ +For more information, see AWS::IoTEvents::Input. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all inputs in a region. +```sql +SELECT +region, +input_definition, +input_description, +input_name, +tags +FROM aws.iotevents.inputs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual input. +```sql +SELECT +region, +input_definition, +input_description, +input_name, +tags +FROM aws.iotevents.inputs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new input resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotevents.inputs ( + InputDefinition, + region +) +SELECT +'{{ InputDefinition }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotevents.inputs ( + InputDefinition, + InputDescription, + InputName, + Tags, + region +) +SELECT + '{{ InputDefinition }}', + '{{ InputDescription }}', + '{{ InputName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: input + props: + - name: InputDefinition + value: + Attributes: + - JsonPath: '{{ JsonPath }}' + - name: InputDescription + value: '{{ InputDescription }}' + - name: InputName + value: '{{ InputName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotevents.inputs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iotevents:DescribeInput, +iotevents:ListTagsForResource +``` + +### Update +```json +iotevents:UpdateInput, +iotevents:DescribeInput, +iotevents:ListTagsForResource, +iotevents:UntagResource, +iotevents:TagResource +``` + +### Delete +```json +iotevents:DeleteInput, +iotevents:DescribeInput +``` + +### List +```json +iotevents:ListInputs +``` diff --git a/website/docs/services/iotevents/inputs_list_only/index.md b/website/docs/services/iotevents/inputs_list_only/index.md new file mode 100644 index 0000000..1f0dcb3 --- /dev/null +++ b/website/docs/services/iotevents/inputs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: inputs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - inputs_list_only + - iotevents + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists inputs in a region or regions, for all properties use inputs + +## Overview + + + + + + + +
Nameinputs_list_only
TypeResource
DescriptionThe AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into ITE. This is done by sending messages as *inputs* to ITE. For more information, see [How to Use](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the input.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all inputs in a region. +```sql +SELECT +region, +input_name +FROM aws.iotevents.inputs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inputs_list_only resource, see inputs + diff --git a/website/docs/services/iotfleethub/application_tags/index.md b/website/docs/services/iotfleethub/application_tags/index.md new file mode 100644 index 0000000..4909555 --- /dev/null +++ b/website/docs/services/iotfleethub/application_tags/index.md @@ -0,0 +1,97 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - iotfleethub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource schema for AWS::IoTFleetHub::Application
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the application.
stringThe ARN of the application.
stringApplication Name, should be between 1 and 256 characters.
stringApplication Description, should be between 1 and 2048 characters.
stringThe URL of the application.
stringThe current state of the application.
integerWhen the Application was created
integerWhen the Application was last updated
stringThe ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax
stringThe AWS SSO application generated client ID (used with AWS SSO APIs).
stringA message indicating why Create or Delete Application failed.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_id, +application_arn, +application_name, +application_description, +application_url, +application_state, +application_creation_date, +application_last_update_date, +role_arn, +sso_client_id, +error_message, +tag_key, +tag_value +FROM aws.iotfleethub.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/iotfleethub/applications/index.md b/website/docs/services/iotfleethub/applications/index.md new file mode 100644 index 0000000..6531e52 --- /dev/null +++ b/website/docs/services/iotfleethub/applications/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionResource schema for AWS::IoTFleetHub::Application
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the application.
stringThe ARN of the application.
stringApplication Name, should be between 1 and 256 characters.
stringApplication Description, should be between 1 and 2048 characters.
stringThe URL of the application.
stringThe current state of the application.
integerWhen the Application was created
integerWhen the Application was last updated
stringThe ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax
stringThe AWS SSO application generated client ID (used with AWS SSO APIs).
stringA message indicating why Create or Delete Application failed.
arrayA list of key-value pairs that contain metadata for the application.
stringAWS region.
+ +For more information, see AWS::IoTFleetHub::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +application_id, +application_arn, +application_name, +application_description, +application_url, +application_state, +application_creation_date, +application_last_update_date, +role_arn, +sso_client_id, +error_message, +tags +FROM aws.iotfleethub.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```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.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleethub.applications ( + ApplicationName, + RoleArn, + region +) +SELECT +'{{ ApplicationName }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleethub.applications ( + ApplicationName, + ApplicationDescription, + RoleArn, + Tags, + region +) +SELECT + '{{ ApplicationName }}', + '{{ ApplicationDescription }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: ApplicationName + value: '{{ ApplicationName }}' + - name: ApplicationDescription + value: '{{ ApplicationDescription }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotfleethub.applications +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iotfleethub:DescribeApplication +``` + +### Update +```json +iotfleethub:UpdateApplication, +iotfleethub:DescribeApplication, +iotfleethub:TagResource, +iotfleethub:UntagResource +``` + +### Delete +```json +iotfleethub:DeleteApplication, +iotfleethub:DescribeApplication, +sso:DeleteManagedApplicationInstance +``` + +### List +```json +iotfleethub:ListApplications +``` diff --git a/website/docs/services/iotfleethub/applications_list_only/index.md b/website/docs/services/iotfleethub/applications_list_only/index.md new file mode 100644 index 0000000..b2044de --- /dev/null +++ b/website/docs/services/iotfleethub/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - iotfleethub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource schema for AWS::IoTFleetHub::Application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_id +FROM aws.iotfleethub.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/iotfleethub/index.md b/website/docs/services/iotfleethub/index.md new file mode 100644 index 0000000..476c7c0 --- /dev/null +++ b/website/docs/services/iotfleethub/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The iotfleethub service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/iotfleetwise/campaign_tags/index.md b/website/docs/services/iotfleetwise/campaign_tags/index.md new file mode 100644 index 0000000..44bd614 --- /dev/null +++ b/website/docs/services/iotfleetwise/campaign_tags/index.md @@ -0,0 +1,119 @@ +--- +title: campaign_tags +hide_title: false +hide_table_of_contents: false +keywords: + - campaign_tags + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for campaigns in a region + +## Overview + + + + + + + +
Namecampaign_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Campaign Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
array
array
array
string
string
string
string
string
string
number
array
string
string
string
undefined
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all campaigns in a region. +```sql +SELECT +region, +status, +action, +creation_time, +compression, +description, +priority, +signals_to_collect, +signals_to_fetch, +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, +data_partitions, +tag_key, +tag_value +FROM aws.iotfleetwise.campaign_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the campaign_tags resource, see campaigns + diff --git a/website/docs/services/iotfleetwise/campaigns/index.md b/website/docs/services/iotfleetwise/campaigns/index.md new file mode 100644 index 0000000..7ec1cae --- /dev/null +++ b/website/docs/services/iotfleetwise/campaigns/index.md @@ -0,0 +1,376 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a campaign resource or lists campaigns in a region + +## Overview + + + + + + + +
Namecampaigns
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Campaign Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
array
array
array
string
string
string
string
string
string
number
array
string
string
string
undefined
array
array
stringAWS region.
+ +For more information, see AWS::IoTFleetWise::Campaign. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all campaigns in a region. +```sql +SELECT +region, +status, +action, +creation_time, +compression, +description, +priority, +signals_to_collect, +signals_to_fetch, +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, +data_partitions, +tags +FROM aws.iotfleetwise.campaigns +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual campaign. +```sql +SELECT +region, +status, +action, +creation_time, +compression, +description, +priority, +signals_to_collect, +signals_to_fetch, +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, +data_partitions, +tags +FROM aws.iotfleetwise.campaigns +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new campaign resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.campaigns ( + Name, + SignalCatalogArn, + TargetArn, + CollectionScheme, + region +) +SELECT +'{{ Name }}', + '{{ SignalCatalogArn }}', + '{{ TargetArn }}', + '{{ CollectionScheme }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.campaigns ( + Action, + Compression, + Description, + Priority, + SignalsToCollect, + SignalsToFetch, + DataDestinationConfigs, + StartTime, + Name, + ExpiryTime, + SpoolingMode, + SignalCatalogArn, + PostTriggerCollectionDuration, + DataExtraDimensions, + DiagnosticsMode, + TargetArn, + CollectionScheme, + DataPartitions, + Tags, + region +) +SELECT + '{{ Action }}', + '{{ Compression }}', + '{{ Description }}', + '{{ Priority }}', + '{{ SignalsToCollect }}', + '{{ SignalsToFetch }}', + '{{ DataDestinationConfigs }}', + '{{ StartTime }}', + '{{ Name }}', + '{{ ExpiryTime }}', + '{{ SpoolingMode }}', + '{{ SignalCatalogArn }}', + '{{ PostTriggerCollectionDuration }}', + '{{ DataExtraDimensions }}', + '{{ DiagnosticsMode }}', + '{{ TargetArn }}', + '{{ CollectionScheme }}', + '{{ DataPartitions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: campaign + props: + - name: Action + value: '{{ Action }}' + - name: Compression + value: '{{ Compression }}' + - name: Description + value: '{{ Description }}' + - name: Priority + value: '{{ Priority }}' + - name: SignalsToCollect + value: + - MaxSampleCount: null + Name: '{{ Name }}' + MinimumSamplingIntervalMs: null + DataPartitionId: '{{ DataPartitionId }}' + - name: SignalsToFetch + value: + - FullyQualifiedName: '{{ FullyQualifiedName }}' + SignalFetchConfig: null + ConditionLanguageVersion: null + Actions: + - '{{ Actions[0] }}' + - name: DataDestinationConfigs + value: + - null + - name: StartTime + value: '{{ StartTime }}' + - name: Name + value: '{{ Name }}' + - name: ExpiryTime + value: '{{ ExpiryTime }}' + - name: SpoolingMode + value: '{{ SpoolingMode }}' + - name: SignalCatalogArn + value: '{{ SignalCatalogArn }}' + - name: PostTriggerCollectionDuration + value: null + - name: DataExtraDimensions + value: + - '{{ DataExtraDimensions[0] }}' + - name: DiagnosticsMode + value: '{{ DiagnosticsMode }}' + - name: TargetArn + value: '{{ TargetArn }}' + - name: CollectionScheme + value: null + - name: DataPartitions + value: + - Id: null + StorageOptions: + MaximumSize: + Unit: '{{ Unit }}' + Value: '{{ Value }}' + MinimumTimeToLive: + Unit: '{{ Unit }}' + Value: '{{ Value }}' + StorageLocation: '{{ StorageLocation }}' + UploadOptions: + Expression: '{{ Expression }}' + ConditionLanguageVersion: '{{ ConditionLanguageVersion }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotfleetwise.campaigns +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the campaigns resource, the following permissions are required: + +### Read +```json +iotfleetwise:GetCampaign, +iotfleetwise:ListTagsForResource +``` + +### Create +```json +iotfleetwise:CreateCampaign, +iotfleetwise:GetCampaign, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource, +iam:PassRole, +timestream:DescribeEndpoints, +timestream:DescribeTable +``` + +### Update +```json +iotfleetwise:GetCampaign, +iotfleetwise:ListTagsForResource, +iotfleetwise:UpdateCampaign, +iotfleetwise:TagResource, +iotfleetwise:UntagResource +``` + +### List +```json +iotfleetwise:ListCampaigns, +iotfleetwise:GetCampaign +``` + +### Delete +```json +iotfleetwise:DeleteCampaign, +iotfleetwise:GetCampaign +``` diff --git a/website/docs/services/iotfleetwise/campaigns_list_only/index.md b/website/docs/services/iotfleetwise/campaigns_list_only/index.md new file mode 100644 index 0000000..74b6361 --- /dev/null +++ b/website/docs/services/iotfleetwise/campaigns_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: campaigns_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - campaigns_list_only + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists campaigns in a region or regions, for all properties use campaigns + +## Overview + + + + + + + +
Namecampaigns_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Campaign Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all campaigns in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.campaigns_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the campaigns_list_only resource, see campaigns + diff --git a/website/docs/services/iotfleetwise/decoder_manifest_tags/index.md b/website/docs/services/iotfleetwise/decoder_manifest_tags/index.md new file mode 100644 index 0000000..d368571 --- /dev/null +++ b/website/docs/services/iotfleetwise/decoder_manifest_tags/index.md @@ -0,0 +1,95 @@ +--- +title: decoder_manifest_tags +hide_title: false +hide_table_of_contents: false +keywords: + - decoder_manifest_tags + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for decoder_manifests in a region + +## Overview + + + + + + + +
Namedecoder_manifest_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::DecoderManifest Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all decoder_manifests in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +model_manifest_arn, +name, +network_interfaces, +signal_decoders, +status, +default_for_unmapped_signals, +tag_key, +tag_value +FROM aws.iotfleetwise.decoder_manifest_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the decoder_manifest_tags resource, see decoder_manifests + diff --git a/website/docs/services/iotfleetwise/decoder_manifests/index.md b/website/docs/services/iotfleetwise/decoder_manifests/index.md new file mode 100644 index 0000000..e2e3735 --- /dev/null +++ b/website/docs/services/iotfleetwise/decoder_manifests/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a decoder_manifest resource or lists decoder_manifests in a region + +## Overview + + + + + + + +
Namedecoder_manifests
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::DecoderManifest Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
array
string
string
array
stringAWS region.
+ +For more information, see AWS::IoTFleetWise::DecoderManifest. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all decoder_manifests in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +model_manifest_arn, +name, +network_interfaces, +signal_decoders, +status, +default_for_unmapped_signals, +tags +FROM aws.iotfleetwise.decoder_manifests +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual decoder_manifest. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +model_manifest_arn, +name, +network_interfaces, +signal_decoders, +status, +default_for_unmapped_signals, +tags +FROM aws.iotfleetwise.decoder_manifests +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new decoder_manifest resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.decoder_manifests ( + ModelManifestArn, + Name, + region +) +SELECT +'{{ ModelManifestArn }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.decoder_manifests ( + Description, + ModelManifestArn, + Name, + NetworkInterfaces, + SignalDecoders, + Status, + DefaultForUnmappedSignals, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ ModelManifestArn }}', + '{{ Name }}', + '{{ NetworkInterfaces }}', + '{{ SignalDecoders }}', + '{{ Status }}', + '{{ DefaultForUnmappedSignals }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: decoder_manifest + props: + - name: Description + value: '{{ Description }}' + - name: ModelManifestArn + value: '{{ ModelManifestArn }}' + - name: Name + value: '{{ Name }}' + - name: NetworkInterfaces + value: + - null + - name: SignalDecoders + value: + - null + - name: Status + value: '{{ Status }}' + - name: DefaultForUnmappedSignals + value: '{{ DefaultForUnmappedSignals }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotfleetwise.decoder_manifests +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iotfleetwise:ListDecoderManifests +``` diff --git a/website/docs/services/iotfleetwise/decoder_manifests_list_only/index.md b/website/docs/services/iotfleetwise/decoder_manifests_list_only/index.md new file mode 100644 index 0000000..57cd3a3 --- /dev/null +++ b/website/docs/services/iotfleetwise/decoder_manifests_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: decoder_manifests_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - decoder_manifests_list_only + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists decoder_manifests in a region or regions, for all properties use decoder_manifests + +## Overview + + + + + + + +
Namedecoder_manifests_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::DecoderManifest Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all decoder_manifests in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.decoder_manifests_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the decoder_manifests_list_only resource, see decoder_manifests + diff --git a/website/docs/services/iotfleetwise/fleet_tags/index.md b/website/docs/services/iotfleetwise/fleet_tags/index.md new file mode 100644 index 0000000..8f57ec9 --- /dev/null +++ b/website/docs/services/iotfleetwise/fleet_tags/index.md @@ -0,0 +1,87 @@ +--- +title: fleet_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_tags + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fleets in a region + +## Overview + + + + + + + +
Namefleet_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Fleet Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fleets in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +id, +last_modification_time, +signal_catalog_arn, +tag_key, +tag_value +FROM aws.iotfleetwise.fleet_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_tags resource, see fleets + diff --git a/website/docs/services/iotfleetwise/fleets/index.md b/website/docs/services/iotfleetwise/fleets/index.md new file mode 100644 index 0000000..557e098 --- /dev/null +++ b/website/docs/services/iotfleetwise/fleets/index.md @@ -0,0 +1,238 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a fleet resource or lists fleets in a region + +## Overview + + + + + + + +
Namefleets
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Fleet Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::IoTFleetWise::Fleet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all fleets in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +id, +last_modification_time, +signal_catalog_arn, +tags +FROM aws.iotfleetwise.fleets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual fleet. +```sql +SELECT +region, +arn, +creation_time, +description, +id, +last_modification_time, +signal_catalog_arn, +tags +FROM aws.iotfleetwise.fleets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.fleets ( + Id, + SignalCatalogArn, + region +) +SELECT +'{{ Id }}', + '{{ SignalCatalogArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.fleets ( + Description, + Id, + SignalCatalogArn, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Id }}', + '{{ SignalCatalogArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: fleet + props: + - name: Description + value: '{{ Description }}' + - name: Id + value: '{{ Id }}' + - name: SignalCatalogArn + value: '{{ SignalCatalogArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotfleetwise.fleets +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iotfleetwise:GetFleet, +iotfleetwise:ListTagsForResource +``` + +### Update +```json +iotfleetwise:GetFleet, +iotfleetwise:UpdateFleet, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource, +iotfleetwise:UntagResource +``` + +### Delete +```json +iotfleetwise:GetFleet, +iotfleetwise:DeleteFleet +``` + +### List +```json +iotfleetwise:ListFleets +``` diff --git a/website/docs/services/iotfleetwise/fleets_list_only/index.md b/website/docs/services/iotfleetwise/fleets_list_only/index.md new file mode 100644 index 0000000..15719e6 --- /dev/null +++ b/website/docs/services/iotfleetwise/fleets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleets_list_only + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleets in a region or regions, for all properties use fleets + +## Overview + + + + + + + +
Namefleets_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Fleet Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleets in a region. +```sql +SELECT +region, +id +FROM aws.iotfleetwise.fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleets_list_only resource, see fleets + diff --git a/website/docs/services/iotfleetwise/index.md b/website/docs/services/iotfleetwise/index.md new file mode 100644 index 0000000..6354852 --- /dev/null +++ b/website/docs/services/iotfleetwise/index.md @@ -0,0 +1,56 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The iotfleetwise service documentation. + +:::info Service Summary + +
+
+total resources: 21
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/iotfleetwise/model_manifest_tags/index.md b/website/docs/services/iotfleetwise/model_manifest_tags/index.md new file mode 100644 index 0000000..2e15e46 --- /dev/null +++ b/website/docs/services/iotfleetwise/model_manifest_tags/index.md @@ -0,0 +1,91 @@ +--- +title: model_manifest_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_manifest_tags + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_manifests in a region + +## Overview + + + + + + + +
Namemodel_manifest_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::ModelManifest Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_manifests in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +nodes, +signal_catalog_arn, +status, +tag_key, +tag_value +FROM aws.iotfleetwise.model_manifest_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_manifest_tags resource, see model_manifests + diff --git a/website/docs/services/iotfleetwise/model_manifests/index.md b/website/docs/services/iotfleetwise/model_manifests/index.md new file mode 100644 index 0000000..a1c2f9c --- /dev/null +++ b/website/docs/services/iotfleetwise/model_manifests/index.md @@ -0,0 +1,256 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a model_manifest resource or lists model_manifests in a region + +## Overview + + + + + + + +
Namemodel_manifests
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::ModelManifest Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
string
string
array
stringAWS region.
+ +For more information, see AWS::IoTFleetWise::ModelManifest. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all model_manifests in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +nodes, +signal_catalog_arn, +status, +tags +FROM aws.iotfleetwise.model_manifests +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual model_manifest. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +nodes, +signal_catalog_arn, +status, +tags +FROM aws.iotfleetwise.model_manifests +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model_manifest resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.model_manifests ( + Name, + SignalCatalogArn, + region +) +SELECT +'{{ Name }}', + '{{ SignalCatalogArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.model_manifests ( + Description, + Name, + Nodes, + SignalCatalogArn, + Status, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ Nodes }}', + '{{ SignalCatalogArn }}', + '{{ Status }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: model_manifest + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Nodes + value: + - '{{ Nodes[0] }}' + - name: SignalCatalogArn + value: '{{ SignalCatalogArn }}' + - name: Status + value: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotfleetwise.model_manifests +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iotfleetwise:ListModelManifests +``` diff --git a/website/docs/services/iotfleetwise/model_manifests_list_only/index.md b/website/docs/services/iotfleetwise/model_manifests_list_only/index.md new file mode 100644 index 0000000..e213a6c --- /dev/null +++ b/website/docs/services/iotfleetwise/model_manifests_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: model_manifests_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_manifests_list_only + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_manifests in a region or regions, for all properties use model_manifests + +## Overview + + + + + + + +
Namemodel_manifests_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::ModelManifest Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_manifests in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.model_manifests_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_manifests_list_only resource, see model_manifests + diff --git a/website/docs/services/iotfleetwise/signal_catalog_tags/index.md b/website/docs/services/iotfleetwise/signal_catalog_tags/index.md new file mode 100644 index 0000000..4515090 --- /dev/null +++ b/website/docs/services/iotfleetwise/signal_catalog_tags/index.md @@ -0,0 +1,89 @@ +--- +title: signal_catalog_tags +hide_title: false +hide_table_of_contents: false +keywords: + - signal_catalog_tags + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for signal_catalogs in a region + +## Overview + + + + + + + +
Namesignal_catalog_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::SignalCatalog Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all signal_catalogs in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +node_counts, +nodes, +tag_key, +tag_value +FROM aws.iotfleetwise.signal_catalog_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the signal_catalog_tags resource, see signal_catalogs + diff --git a/website/docs/services/iotfleetwise/signal_catalogs/index.md b/website/docs/services/iotfleetwise/signal_catalogs/index.md new file mode 100644 index 0000000..3a30f82 --- /dev/null +++ b/website/docs/services/iotfleetwise/signal_catalogs/index.md @@ -0,0 +1,259 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a signal_catalog resource or lists signal_catalogs in a region + +## Overview + + + + + + + +
Namesignal_catalogs
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::SignalCatalog Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
array
array
stringAWS region.
+ +For more information, see AWS::IoTFleetWise::SignalCatalog. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all signal_catalogs in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +node_counts, +nodes, +tags +FROM aws.iotfleetwise.signal_catalogs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual signal_catalog. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +node_counts, +nodes, +tags +FROM aws.iotfleetwise.signal_catalogs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new signal_catalog resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.signal_catalogs ( + Description, + Name, + NodeCounts, + Nodes, + Tags, + region +) +SELECT +'{{ Description }}', + '{{ Name }}', + '{{ NodeCounts }}', + '{{ Nodes }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.signal_catalogs ( + Description, + Name, + NodeCounts, + Nodes, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ NodeCounts }}', + '{{ Nodes }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: signal_catalog + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: NodeCounts + value: + TotalNodes: null + TotalBranches: null + TotalSensors: null + TotalAttributes: null + TotalActuators: null + - name: Nodes + value: + - null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotfleetwise.signal_catalogs +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iotfleetwise:ListSignalCatalogs +``` diff --git a/website/docs/services/iotfleetwise/signal_catalogs_list_only/index.md b/website/docs/services/iotfleetwise/signal_catalogs_list_only/index.md new file mode 100644 index 0000000..ce4c777 --- /dev/null +++ b/website/docs/services/iotfleetwise/signal_catalogs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: signal_catalogs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - signal_catalogs_list_only + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists signal_catalogs in a region or regions, for all properties use signal_catalogs + +## Overview + + + + + + + +
Namesignal_catalogs_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::SignalCatalog Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all signal_catalogs in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.signal_catalogs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the signal_catalogs_list_only resource, see signal_catalogs + diff --git a/website/docs/services/iotfleetwise/state_template_tags/index.md b/website/docs/services/iotfleetwise/state_template_tags/index.md new file mode 100644 index 0000000..bb59e52 --- /dev/null +++ b/website/docs/services/iotfleetwise/state_template_tags/index.md @@ -0,0 +1,93 @@ +--- +title: state_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - state_template_tags + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for state_templates in a region + +## Overview + + + + + + + +
Namestate_template_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::StateTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all state_templates in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +signal_catalog_arn, +state_template_properties, +data_extra_dimensions, +metadata_extra_dimensions, +tag_key, +tag_value +FROM aws.iotfleetwise.state_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the state_template_tags resource, see state_templates + diff --git a/website/docs/services/iotfleetwise/state_templates/index.md b/website/docs/services/iotfleetwise/state_templates/index.md new file mode 100644 index 0000000..5c9adc3 --- /dev/null +++ b/website/docs/services/iotfleetwise/state_templates/index.md @@ -0,0 +1,263 @@ +--- +title: state_templates +hide_title: false +hide_table_of_contents: false +keywords: + - state_templates + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a state_template resource or lists state_templates in a region + +## Overview + + + + + + + +
Namestate_templates
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::StateTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
array
array
array
stringAWS region.
+ +For more information, see AWS::IoTFleetWise::StateTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all state_templates in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +signal_catalog_arn, +state_template_properties, +data_extra_dimensions, +metadata_extra_dimensions, +tags +FROM aws.iotfleetwise.state_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual state_template. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +signal_catalog_arn, +state_template_properties, +data_extra_dimensions, +metadata_extra_dimensions, +tags +FROM aws.iotfleetwise.state_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new state_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.state_templates ( + Name, + SignalCatalogArn, + StateTemplateProperties, + region +) +SELECT +'{{ Name }}', + '{{ SignalCatalogArn }}', + '{{ StateTemplateProperties }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.state_templates ( + Description, + Name, + SignalCatalogArn, + StateTemplateProperties, + DataExtraDimensions, + MetadataExtraDimensions, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ SignalCatalogArn }}', + '{{ StateTemplateProperties }}', + '{{ DataExtraDimensions }}', + '{{ MetadataExtraDimensions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: state_template + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: SignalCatalogArn + value: '{{ SignalCatalogArn }}' + - name: StateTemplateProperties + value: + - '{{ StateTemplateProperties[0] }}' + - name: DataExtraDimensions + value: + - '{{ DataExtraDimensions[0] }}' + - name: MetadataExtraDimensions + value: + - '{{ MetadataExtraDimensions[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotfleetwise.state_templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the state_templates resource, the following permissions are required: + +### Create +```json +iotfleetwise:GetStateTemplate, +iotfleetwise:CreateStateTemplate, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource +``` + +### Read +```json +iotfleetwise:GetStateTemplate, +iotfleetwise:ListTagsForResource +``` + +### Update +```json +iotfleetwise:UpdateStateTemplate, +iotfleetwise:GetStateTemplate, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource, +iotfleetwise:UntagResource +``` + +### Delete +```json +iotfleetwise:DeleteStateTemplate, +iotfleetwise:GetStateTemplate +``` + +### List +```json +iotfleetwise:ListStateTemplates +``` diff --git a/website/docs/services/iotfleetwise/state_templates_list_only/index.md b/website/docs/services/iotfleetwise/state_templates_list_only/index.md new file mode 100644 index 0000000..f3e3dd9 --- /dev/null +++ b/website/docs/services/iotfleetwise/state_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: state_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - state_templates_list_only + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists state_templates in a region or regions, for all properties use state_templates + +## Overview + + + + + + + +
Namestate_templates_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::StateTemplate Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all state_templates in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.state_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the state_templates_list_only resource, see state_templates + diff --git a/website/docs/services/iotfleetwise/vehicle_tags/index.md b/website/docs/services/iotfleetwise/vehicle_tags/index.md new file mode 100644 index 0000000..6c7e0a4 --- /dev/null +++ b/website/docs/services/iotfleetwise/vehicle_tags/index.md @@ -0,0 +1,91 @@ +--- +title: vehicle_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vehicle_tags + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vehicles in a region + +## Overview + + + + + + + +
Namevehicle_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Vehicle Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vehicles in a region. +```sql +SELECT +region, +arn, +association_behavior, +attributes, +creation_time, +decoder_manifest_arn, +name, +last_modification_time, +model_manifest_arn, +tag_key, +tag_value +FROM aws.iotfleetwise.vehicle_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vehicle_tags resource, see vehicles + diff --git a/website/docs/services/iotfleetwise/vehicles/index.md b/website/docs/services/iotfleetwise/vehicles/index.md new file mode 100644 index 0000000..d1723e5 --- /dev/null +++ b/website/docs/services/iotfleetwise/vehicles/index.md @@ -0,0 +1,256 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vehicle resource or lists vehicles in a region + +## Overview + + + + + + + +
Namevehicles
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Vehicle Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::IoTFleetWise::Vehicle. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vehicles in a region. +```sql +SELECT +region, +arn, +association_behavior, +attributes, +creation_time, +decoder_manifest_arn, +name, +last_modification_time, +model_manifest_arn, +tags +FROM aws.iotfleetwise.vehicles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vehicle. +```sql +SELECT +region, +arn, +association_behavior, +attributes, +creation_time, +decoder_manifest_arn, +name, +last_modification_time, +model_manifest_arn, +tags +FROM aws.iotfleetwise.vehicles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vehicle resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.vehicles ( + DecoderManifestArn, + Name, + ModelManifestArn, + region +) +SELECT +'{{ DecoderManifestArn }}', + '{{ Name }}', + '{{ ModelManifestArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotfleetwise.vehicles ( + AssociationBehavior, + Attributes, + DecoderManifestArn, + Name, + ModelManifestArn, + Tags, + region +) +SELECT + '{{ AssociationBehavior }}', + '{{ Attributes }}', + '{{ DecoderManifestArn }}', + '{{ Name }}', + '{{ ModelManifestArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vehicle + props: + - name: AssociationBehavior + value: '{{ AssociationBehavior }}' + - name: Attributes + value: {} + - name: DecoderManifestArn + value: '{{ DecoderManifestArn }}' + - name: Name + value: '{{ Name }}' + - name: ModelManifestArn + value: '{{ ModelManifestArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotfleetwise.vehicles +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iotfleetwise:GetVehicle, +iotfleetwise:ListTagsForResource +``` + +### Update +```json +iotfleetwise:GetVehicle, +iotfleetwise:UpdateVehicle, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource, +iotfleetwise:UntagResource +``` + +### Delete +```json +iotfleetwise:GetVehicle, +iotfleetwise:DeleteVehicle +``` + +### List +```json +iotfleetwise:ListVehicles +``` diff --git a/website/docs/services/iotfleetwise/vehicles_list_only/index.md b/website/docs/services/iotfleetwise/vehicles_list_only/index.md new file mode 100644 index 0000000..1aeef79 --- /dev/null +++ b/website/docs/services/iotfleetwise/vehicles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vehicles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vehicles_list_only + - iotfleetwise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vehicles in a region or regions, for all properties use vehicles + +## Overview + + + + + + + +
Namevehicles_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Vehicle Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vehicles in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.vehicles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vehicles_list_only resource, see vehicles + diff --git a/website/docs/services/iotsitewise/access_policies/index.md b/website/docs/services/iotsitewise/access_policies/index.md new file mode 100644 index 0000000..aa7cd50 --- /dev/null +++ b/website/docs/services/iotsitewise/access_policies/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_policy resource or lists access_policies in a region + +## Overview + + + + + + + +
Nameaccess_policies
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::AccessPolicy
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the access policy.
stringThe ARN of the access policy.
objectThe identity for this access policy. Choose either a user or a group but not both.
stringThe permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
objectThe AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.
stringAWS region.
+ +For more information, see AWS::IoTSiteWise::AccessPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_policies in a region. +```sql +SELECT +region, +access_policy_id, +access_policy_arn, +access_policy_identity, +access_policy_permission, +access_policy_resource +FROM aws.iotsitewise.access_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_policy. +```sql +SELECT +region, +access_policy_id, +access_policy_arn, +access_policy_identity, +access_policy_permission, +access_policy_resource +FROM aws.iotsitewise.access_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.access_policies ( + AccessPolicyIdentity, + AccessPolicyPermission, + AccessPolicyResource, + region +) +SELECT +'{{ AccessPolicyIdentity }}', + '{{ AccessPolicyPermission }}', + '{{ AccessPolicyResource }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.access_policies ( + AccessPolicyIdentity, + AccessPolicyPermission, + AccessPolicyResource, + region +) +SELECT + '{{ AccessPolicyIdentity }}', + '{{ AccessPolicyPermission }}', + '{{ AccessPolicyResource }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_policy + props: + - name: AccessPolicyIdentity + value: + User: + id: '{{ id }}' + IamUser: + arn: '{{ arn }}' + IamRole: + arn: '{{ arn }}' + - name: AccessPolicyPermission + value: '{{ AccessPolicyPermission }}' + - name: AccessPolicyResource + value: + Portal: + PortalAuthMode: '{{ PortalAuthMode }}' + PortalContactEmail: '{{ PortalContactEmail }}' + PortalDescription: '{{ PortalDescription }}' + PortalName: '{{ PortalName }}' + PortalType: '{{ PortalType }}' + PortalTypeConfiguration: {} + RoleArn: '{{ RoleArn }}' + NotificationSenderEmail: '{{ NotificationSenderEmail }}' + Alarms: + AlarmRoleArn: '{{ AlarmRoleArn }}' + NotificationLambdaArn: '{{ NotificationLambdaArn }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + Project: + PortalId: '{{ PortalId }}' + ProjectName: '{{ ProjectName }}' + ProjectDescription: '{{ ProjectDescription }}' + AssetIds: + - '{{ AssetIds[0] }}' + Tags: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotsitewise.access_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the access_policies resource, the following permissions are required: + +### Create +```json +iotsitewise:CreateAccessPolicy +``` + +### Read +```json +iotsitewise:DescribeAccessPolicy +``` + +### Update +```json +iotsitewise:DescribeAccessPolicy, +iotsitewise:UpdateAccessPolicy +``` + +### Delete +```json +iotsitewise:DescribeAccessPolicy, +iotsitewise:DeleteAccessPolicy +``` + +### List +```json +iotsitewise:ListAccessPolicies, +iotsitewise:ListProjects, +iotsitewise:ListPortals +``` diff --git a/website/docs/services/iotsitewise/access_policies_list_only/index.md b/website/docs/services/iotsitewise/access_policies_list_only/index.md new file mode 100644 index 0000000..3bd9879 --- /dev/null +++ b/website/docs/services/iotsitewise/access_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_policies_list_only + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_policies in a region or regions, for all properties use access_policies + +## Overview + + + + + + + +
Nameaccess_policies_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::AccessPolicy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the access policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_policies in a region. +```sql +SELECT +region, +access_policy_id +FROM aws.iotsitewise.access_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_policies_list_only resource, see access_policies + diff --git a/website/docs/services/iotsitewise/asset_model_tags/index.md b/website/docs/services/iotsitewise/asset_model_tags/index.md new file mode 100644 index 0000000..7a3ea57 --- /dev/null +++ b/website/docs/services/iotsitewise/asset_model_tags/index.md @@ -0,0 +1,93 @@ +--- +title: asset_model_tags +hide_title: false +hide_table_of_contents: false +keywords: + - asset_model_tags + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for asset_models in a region + +## Overview + + + + + + + +
Nameasset_model_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::AssetModel
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the asset model.
stringThe type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
stringThe external ID of the asset model.
stringThe ARN of the asset model, which has the following format.
stringA unique, friendly name for the asset model.
stringA description for the asset model.
arrayThe property definitions of the asset model. You can specify up to 200 properties per asset model.
arrayThe composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
arrayThe hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all asset_models in a region. +```sql +SELECT +region, +asset_model_id, +asset_model_type, +asset_model_external_id, +asset_model_arn, +asset_model_name, +asset_model_description, +asset_model_properties, +asset_model_composite_models, +asset_model_hierarchies, +tag_key, +tag_value +FROM aws.iotsitewise.asset_model_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the asset_model_tags resource, see asset_models + diff --git a/website/docs/services/iotsitewise/asset_models/index.md b/website/docs/services/iotsitewise/asset_models/index.md new file mode 100644 index 0000000..0f6e4af --- /dev/null +++ b/website/docs/services/iotsitewise/asset_models/index.md @@ -0,0 +1,329 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an asset_model resource or lists asset_models in a region + +## Overview + + + + + + + +
Nameasset_models
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::AssetModel
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the asset model.
stringThe type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
stringThe external ID of the asset model.
stringThe ARN of the asset model, which has the following format.
stringA unique, friendly name for the asset model.
stringA description for the asset model.
arrayThe property definitions of the asset model. You can specify up to 200 properties per asset model.
arrayThe composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
arrayThe hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model.
arrayA list of key-value pairs that contain metadata for the asset model.
stringAWS region.
+ +For more information, see AWS::IoTSiteWise::AssetModel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all asset_models in a region. +```sql +SELECT +region, +asset_model_id, +asset_model_type, +asset_model_external_id, +asset_model_arn, +asset_model_name, +asset_model_description, +asset_model_properties, +asset_model_composite_models, +asset_model_hierarchies, +tags +FROM aws.iotsitewise.asset_models +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual asset_model. +```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_models +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new asset_model resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.asset_models ( + AssetModelName, + region +) +SELECT +'{{ AssetModelName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.asset_models ( + AssetModelType, + AssetModelExternalId, + AssetModelName, + AssetModelDescription, + AssetModelProperties, + AssetModelCompositeModels, + AssetModelHierarchies, + Tags, + region +) +SELECT + '{{ AssetModelType }}', + '{{ AssetModelExternalId }}', + '{{ AssetModelName }}', + '{{ AssetModelDescription }}', + '{{ AssetModelProperties }}', + '{{ AssetModelCompositeModels }}', + '{{ AssetModelHierarchies }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: asset_model + props: + - name: AssetModelType + value: '{{ AssetModelType }}' + - name: AssetModelExternalId + value: '{{ AssetModelExternalId }}' + - name: AssetModelName + value: '{{ AssetModelName }}' + - name: AssetModelDescription + value: '{{ AssetModelDescription }}' + - name: AssetModelProperties + value: + - LogicalId: '{{ LogicalId }}' + Id: '{{ Id }}' + ExternalId: '{{ ExternalId }}' + Name: '{{ Name }}' + DataType: '{{ DataType }}' + DataTypeSpec: '{{ DataTypeSpec }}' + Unit: '{{ Unit }}' + Type: + TypeName: '{{ TypeName }}' + Attribute: + DefaultValue: '{{ DefaultValue }}' + Transform: + Expression: '{{ Expression }}' + Variables: + - Name: '{{ Name }}' + Value: + PropertyLogicalId: '{{ PropertyLogicalId }}' + PropertyId: '{{ PropertyId }}' + PropertyExternalId: '{{ PropertyExternalId }}' + PropertyPath: + - Name: '{{ Name }}' + HierarchyLogicalId: '{{ HierarchyLogicalId }}' + HierarchyId: '{{ HierarchyId }}' + HierarchyExternalId: '{{ HierarchyExternalId }}' + Metric: + Expression: '{{ Expression }}' + Variables: + - null + Window: + Tumbling: + Interval: '{{ Interval }}' + Offset: '{{ Offset }}' + - name: AssetModelCompositeModels + value: + - Id: '{{ Id }}' + ExternalId: '{{ ExternalId }}' + ComposedAssetModelId: '{{ ComposedAssetModelId }}' + ParentAssetModelCompositeModelExternalId: '{{ ParentAssetModelCompositeModelExternalId }}' + Path: + - '{{ Path[0] }}' + Description: '{{ Description }}' + Name: '{{ Name }}' + Type: '{{ Type }}' + CompositeModelProperties: + - null + - name: AssetModelHierarchies + value: + - Id: '{{ Id }}' + ExternalId: '{{ ExternalId }}' + LogicalId: '{{ LogicalId }}' + Name: '{{ Name }}' + ChildAssetModelId: '{{ ChildAssetModelId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotsitewise.asset_models +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iotsitewise:DescribeAssetModel, +iotsitewise:ListAssetModels, +iotsitewise:ListTagsForResource, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetModelCompositeModels +``` diff --git a/website/docs/services/iotsitewise/asset_models_list_only/index.md b/website/docs/services/iotsitewise/asset_models_list_only/index.md new file mode 100644 index 0000000..6f08466 --- /dev/null +++ b/website/docs/services/iotsitewise/asset_models_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: asset_models_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - asset_models_list_only + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists asset_models in a region or regions, for all properties use asset_models + +## Overview + + + + + + + +
Nameasset_models_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::AssetModel
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the asset model.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all asset_models in a region. +```sql +SELECT +region, +asset_model_id +FROM aws.iotsitewise.asset_models_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the asset_models_list_only resource, see asset_models + diff --git a/website/docs/services/iotsitewise/asset_tags/index.md b/website/docs/services/iotsitewise/asset_tags/index.md new file mode 100644 index 0000000..825c1ff --- /dev/null +++ b/website/docs/services/iotsitewise/asset_tags/index.md @@ -0,0 +1,91 @@ +--- +title: asset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - asset_tags + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for assets in a region + +## Overview + + + + + + + +
Nameasset_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Asset
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the asset
stringThe External ID of the asset
stringThe ID of the asset model from which to create the asset.
stringThe ARN of the asset
stringA unique, friendly name for the asset.
stringA description for the asset
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all assets in a region. +```sql +SELECT +region, +asset_id, +asset_external_id, +asset_model_id, +asset_arn, +asset_name, +asset_description, +asset_properties, +asset_hierarchies, +tag_key, +tag_value +FROM aws.iotsitewise.asset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the asset_tags resource, see assets + diff --git a/website/docs/services/iotsitewise/assets/index.md b/website/docs/services/iotsitewise/assets/index.md new file mode 100644 index 0000000..77fc52d --- /dev/null +++ b/website/docs/services/iotsitewise/assets/index.md @@ -0,0 +1,294 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an asset resource or lists assets in a region + +## Overview + + + + + + + +
Nameassets
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Asset
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the asset
stringThe External ID of the asset
stringThe ID of the asset model from which to create the asset.
stringThe ARN of the asset
stringA unique, friendly name for the asset.
stringA description for the asset
array
array
arrayA list of key-value pairs that contain metadata for the asset.
stringAWS region.
+ +For more information, see AWS::IoTSiteWise::Asset. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all assets in a region. +```sql +SELECT +region, +asset_id, +asset_external_id, +asset_model_id, +asset_arn, +asset_name, +asset_description, +asset_properties, +asset_hierarchies, +tags +FROM aws.iotsitewise.assets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual asset. +```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.assets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new asset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.assets ( + AssetModelId, + AssetName, + region +) +SELECT +'{{ AssetModelId }}', + '{{ AssetName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.assets ( + AssetExternalId, + AssetModelId, + AssetName, + AssetDescription, + AssetProperties, + AssetHierarchies, + Tags, + region +) +SELECT + '{{ AssetExternalId }}', + '{{ AssetModelId }}', + '{{ AssetName }}', + '{{ AssetDescription }}', + '{{ AssetProperties }}', + '{{ AssetHierarchies }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: asset + props: + - name: AssetExternalId + value: '{{ AssetExternalId }}' + - name: AssetModelId + value: '{{ AssetModelId }}' + - name: AssetName + value: '{{ AssetName }}' + - name: AssetDescription + value: '{{ AssetDescription }}' + - name: AssetProperties + value: + - Id: '{{ Id }}' + ExternalId: '{{ ExternalId }}' + LogicalId: '{{ LogicalId }}' + Alias: '{{ Alias }}' + NotificationState: '{{ NotificationState }}' + Unit: '{{ Unit }}' + - name: AssetHierarchies + value: + - Id: '{{ Id }}' + ExternalId: '{{ ExternalId }}' + LogicalId: '{{ LogicalId }}' + ChildAssetId: '{{ ChildAssetId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotsitewise.assets +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iotsitewise:ListAssetModels, +iotsitewise:ListAssets +``` diff --git a/website/docs/services/iotsitewise/assets_list_only/index.md b/website/docs/services/iotsitewise/assets_list_only/index.md new file mode 100644 index 0000000..226fd68 --- /dev/null +++ b/website/docs/services/iotsitewise/assets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: assets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assets_list_only + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assets in a region or regions, for all properties use assets + +## Overview + + + + + + + +
Nameassets_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Asset
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the asset
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assets in a region. +```sql +SELECT +region, +asset_id +FROM aws.iotsitewise.assets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assets_list_only resource, see assets + diff --git a/website/docs/services/iotsitewise/dashboard_tags/index.md b/website/docs/services/iotsitewise/dashboard_tags/index.md new file mode 100644 index 0000000..6c56e93 --- /dev/null +++ b/website/docs/services/iotsitewise/dashboard_tags/index.md @@ -0,0 +1,87 @@ +--- +title: dashboard_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dashboard_tags + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dashboards in a region + +## Overview + + + + + + + +
Namedashboard_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Dashboard
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the project in which to create the dashboard.
stringThe ID of the dashboard.
stringA friendly name for the dashboard.
stringA description for the dashboard.
stringThe dashboard definition specified in a JSON literal.
stringThe ARN of the dashboard.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dashboards in a region. +```sql +SELECT +region, +project_id, +dashboard_id, +dashboard_name, +dashboard_description, +dashboard_definition, +dashboard_arn, +tag_key, +tag_value +FROM aws.iotsitewise.dashboard_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboard_tags resource, see dashboards + diff --git a/website/docs/services/iotsitewise/dashboards/index.md b/website/docs/services/iotsitewise/dashboards/index.md new file mode 100644 index 0000000..d2be77b --- /dev/null +++ b/website/docs/services/iotsitewise/dashboards/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dashboard resource or lists dashboards in a region + +## Overview + + + + + + + +
Namedashboards
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Dashboard
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the project in which to create the dashboard.
stringThe ID of the dashboard.
stringA friendly name for the dashboard.
stringA description for the dashboard.
stringThe dashboard definition specified in a JSON literal.
stringThe ARN of the dashboard.
arrayA list of key-value pairs that contain metadata for the dashboard.
stringAWS region.
+ +For more information, see AWS::IoTSiteWise::Dashboard. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dashboards in a region. +```sql +SELECT +region, +project_id, +dashboard_id, +dashboard_name, +dashboard_description, +dashboard_definition, +dashboard_arn, +tags +FROM aws.iotsitewise.dashboards +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dashboard. +```sql +SELECT +region, +project_id, +dashboard_id, +dashboard_name, +dashboard_description, +dashboard_definition, +dashboard_arn, +tags +FROM aws.iotsitewise.dashboards +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dashboard resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.dashboards ( + DashboardName, + DashboardDescription, + DashboardDefinition, + region +) +SELECT +'{{ DashboardName }}', + '{{ DashboardDescription }}', + '{{ DashboardDefinition }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.dashboards ( + ProjectId, + DashboardName, + DashboardDescription, + DashboardDefinition, + Tags, + region +) +SELECT + '{{ ProjectId }}', + '{{ DashboardName }}', + '{{ DashboardDescription }}', + '{{ DashboardDefinition }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dashboard + props: + - name: ProjectId + value: '{{ ProjectId }}' + - name: DashboardName + value: '{{ DashboardName }}' + - name: DashboardDescription + value: '{{ DashboardDescription }}' + - name: DashboardDefinition + value: '{{ DashboardDefinition }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotsitewise.dashboards +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iotsitewise:ListDashboards, +iotsitewise:ListTagsForResource +``` diff --git a/website/docs/services/iotsitewise/dashboards_list_only/index.md b/website/docs/services/iotsitewise/dashboards_list_only/index.md new file mode 100644 index 0000000..a863e05 --- /dev/null +++ b/website/docs/services/iotsitewise/dashboards_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dashboards_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dashboards_list_only + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dashboards in a region or regions, for all properties use dashboards + +## Overview + + + + + + + +
Namedashboards_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Dashboard
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the dashboard.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dashboards in a region. +```sql +SELECT +region, +dashboard_id +FROM aws.iotsitewise.dashboards_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboards_list_only resource, see dashboards + diff --git a/website/docs/services/iotsitewise/gateway_tags/index.md b/website/docs/services/iotsitewise/gateway_tags/index.md new file mode 100644 index 0000000..7bc0ab2 --- /dev/null +++ b/website/docs/services/iotsitewise/gateway_tags/index.md @@ -0,0 +1,83 @@ +--- +title: gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - gateway_tags + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for gateways in a region + +## Overview + + + + + + + +
Namegateway_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Gateway
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arrayA list of gateway capability summaries that each contain a namespace and status.
stringA unique, friendly name for the gateway.
objectThe gateway's platform. You can only specify one platform in a gateway.
stringThe ID of the gateway device.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all gateways in a region. +```sql +SELECT +region, +gateway_capability_summaries, +gateway_name, +gateway_platform, +gateway_id, +tag_key, +tag_value +FROM aws.iotsitewise.gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the gateway_tags resource, see gateways + diff --git a/website/docs/services/iotsitewise/gateways/index.md b/website/docs/services/iotsitewise/gateways/index.md new file mode 100644 index 0000000..6a587f9 --- /dev/null +++ b/website/docs/services/iotsitewise/gateways/index.md @@ -0,0 +1,250 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a gateway resource or lists gateways in a region + +## Overview + + + + + + + +
Namegateways
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Gateway
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arrayA list of gateway capability summaries that each contain a namespace and status.
stringA unique, friendly name for the gateway.
objectThe gateway's platform. You can only specify one platform in a gateway.
stringThe ID of the gateway device.
arrayA list of key-value pairs that contain metadata for the gateway.
stringAWS region.
+ +For more information, see AWS::IoTSiteWise::Gateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all gateways in a region. +```sql +SELECT +region, +gateway_capability_summaries, +gateway_name, +gateway_platform, +gateway_id, +tags +FROM aws.iotsitewise.gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual gateway. +```sql +SELECT +region, +gateway_capability_summaries, +gateway_name, +gateway_platform, +gateway_id, +tags +FROM aws.iotsitewise.gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.gateways ( + GatewayName, + GatewayPlatform, + region +) +SELECT +'{{ GatewayName }}', + '{{ GatewayPlatform }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.gateways ( + GatewayCapabilitySummaries, + GatewayName, + GatewayPlatform, + Tags, + region +) +SELECT + '{{ GatewayCapabilitySummaries }}', + '{{ GatewayName }}', + '{{ GatewayPlatform }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: gateway + props: + - name: GatewayCapabilitySummaries + value: + - CapabilityNamespace: '{{ CapabilityNamespace }}' + CapabilityConfiguration: '{{ CapabilityConfiguration }}' + - name: GatewayName + value: '{{ GatewayName }}' + - name: GatewayPlatform + value: + GreengrassV2: + CoreDeviceThingName: '{{ CoreDeviceThingName }}' + Greengrass: + GroupArn: '{{ GroupArn }}' + SiemensIE: + IotCoreThingName: '{{ IotCoreThingName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotsitewise.gateways +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the gateways resource, the following permissions are required: + +### Read +```json +iotsitewise:DescribeGateway, +iotsitewise:DescribeGatewayCapabilityConfiguration, +iotsitewise:ListTagsForResource +``` + +### Create +```json +iotsitewise:CreateGateway, +iotsitewise:DescribeGateway, +iotsitewise:DescribeGatewayCapabilityConfiguration, +iotsitewise:UpdateGatewayCapabilityConfiguration, +iam:PassRole, +iam:GetRole, +greengrass:GetCoreDevice, +iotsitewise:ListTagsForResource, +iotsitewise:TagResource, +iot:DescribeThing +``` + +### Update +```json +iotsitewise:UpdateGateway, +iotsitewise:UpdateGatewayCapabilityConfiguration, +iotsitewise:TagResource, +iotsitewise:UntagResource, +iotsitewise:DescribeGateway, +iotsitewise:DescribeGatewayCapabilityConfiguration, +iotsitewise:ListTagsForResource +``` + +### List +```json +iotsitewise:ListGateways, +iotsitewise:ListTagsForResource +``` + +### Delete +```json +iotsitewise:DescribeGateway, +iotsitewise:DescribeGatewayCapabilityConfiguration, +iotsitewise:DeleteGateway +``` diff --git a/website/docs/services/iotsitewise/gateways_list_only/index.md b/website/docs/services/iotsitewise/gateways_list_only/index.md new file mode 100644 index 0000000..7b50d86 --- /dev/null +++ b/website/docs/services/iotsitewise/gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - gateways_list_only + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists gateways in a region or regions, for all properties use gateways + +## Overview + + + + + + + +
Namegateways_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Gateway
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the gateway device.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all gateways in a region. +```sql +SELECT +region, +gateway_id +FROM aws.iotsitewise.gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the gateways_list_only resource, see gateways + diff --git a/website/docs/services/iotsitewise/index.md b/website/docs/services/iotsitewise/index.md new file mode 100644 index 0000000..403cff6 --- /dev/null +++ b/website/docs/services/iotsitewise/index.md @@ -0,0 +1,55 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The iotsitewise service documentation. + +:::info Service Summary + +
+
+total resources: 20
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/iotsitewise/portal_tags/index.md b/website/docs/services/iotsitewise/portal_tags/index.md new file mode 100644 index 0000000..64374dc --- /dev/null +++ b/website/docs/services/iotsitewise/portal_tags/index.md @@ -0,0 +1,101 @@ +--- +title: portal_tags +hide_title: false +hide_table_of_contents: false +keywords: + - portal_tags + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for portals in a region + +## Overview + + + + + + + +
Nameportal_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Portal
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
stringThe ARN of the portal, which has the following format.
stringThe AWS SSO application generated client ID (used with AWS SSO APIs).
stringThe AWS administrator's contact email address.
stringA description for the portal.
stringThe ID of the portal.
stringA friendly name for the portal.
stringThe public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
stringThe type of portal
objectMap to associate detail of configuration related with a PortalType.
stringThe ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
stringThe email address that sends alarm notifications.
objectContains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all portals in a region. +```sql +SELECT +region, +portal_auth_mode, +portal_arn, +portal_client_id, +portal_contact_email, +portal_description, +portal_id, +portal_name, +portal_start_url, +portal_type, +portal_type_configuration, +role_arn, +notification_sender_email, +alarms, +tag_key, +tag_value +FROM aws.iotsitewise.portal_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the portal_tags resource, see portals + diff --git a/website/docs/services/iotsitewise/portals/index.md b/website/docs/services/iotsitewise/portals/index.md new file mode 100644 index 0000000..1407673 --- /dev/null +++ b/website/docs/services/iotsitewise/portals/index.md @@ -0,0 +1,294 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a portal resource or lists portals in a region + +## Overview + + + + + + + +
Nameportals
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Portal
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
stringThe ARN of the portal, which has the following format.
stringThe AWS SSO application generated client ID (used with AWS SSO APIs).
stringThe AWS administrator's contact email address.
stringA description for the portal.
stringThe ID of the portal.
stringA friendly name for the portal.
stringThe public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
stringThe type of portal
objectMap to associate detail of configuration related with a PortalType.
stringThe ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
stringThe email address that sends alarm notifications.
objectContains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
arrayA list of key-value pairs that contain metadata for the portal.
stringAWS region.
+ +For more information, see AWS::IoTSiteWise::Portal. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all portals in a region. +```sql +SELECT +region, +portal_auth_mode, +portal_arn, +portal_client_id, +portal_contact_email, +portal_description, +portal_id, +portal_name, +portal_start_url, +portal_type, +portal_type_configuration, +role_arn, +notification_sender_email, +alarms, +tags +FROM aws.iotsitewise.portals +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual portal. +```sql +SELECT +region, +portal_auth_mode, +portal_arn, +portal_client_id, +portal_contact_email, +portal_description, +portal_id, +portal_name, +portal_start_url, +portal_type, +portal_type_configuration, +role_arn, +notification_sender_email, +alarms, +tags +FROM aws.iotsitewise.portals +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new portal resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.portals ( + PortalContactEmail, + PortalName, + RoleArn, + region +) +SELECT +'{{ PortalContactEmail }}', + '{{ PortalName }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.portals ( + PortalAuthMode, + PortalContactEmail, + PortalDescription, + PortalName, + PortalType, + PortalTypeConfiguration, + RoleArn, + NotificationSenderEmail, + Alarms, + Tags, + region +) +SELECT + '{{ PortalAuthMode }}', + '{{ PortalContactEmail }}', + '{{ PortalDescription }}', + '{{ PortalName }}', + '{{ PortalType }}', + '{{ PortalTypeConfiguration }}', + '{{ RoleArn }}', + '{{ NotificationSenderEmail }}', + '{{ Alarms }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: portal + props: + - name: PortalAuthMode + value: '{{ PortalAuthMode }}' + - name: PortalContactEmail + value: '{{ PortalContactEmail }}' + - name: PortalDescription + value: '{{ PortalDescription }}' + - name: PortalName + value: '{{ PortalName }}' + - name: PortalType + value: '{{ PortalType }}' + - name: PortalTypeConfiguration + value: {} + - name: RoleArn + value: '{{ RoleArn }}' + - name: NotificationSenderEmail + value: '{{ NotificationSenderEmail }}' + - name: Alarms + value: + AlarmRoleArn: '{{ AlarmRoleArn }}' + NotificationLambdaArn: '{{ NotificationLambdaArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotsitewise.portals +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iotsitewise:ListPortals, +iotsitewise:ListTagsForResource +``` diff --git a/website/docs/services/iotsitewise/portals_list_only/index.md b/website/docs/services/iotsitewise/portals_list_only/index.md new file mode 100644 index 0000000..d6391b4 --- /dev/null +++ b/website/docs/services/iotsitewise/portals_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: portals_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - portals_list_only + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists portals in a region or regions, for all properties use portals + +## Overview + + + + + + + +
Nameportals_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Portal
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the portal.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all portals in a region. +```sql +SELECT +region, +portal_id +FROM aws.iotsitewise.portals_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the portals_list_only resource, see portals + diff --git a/website/docs/services/iotsitewise/project_tags/index.md b/website/docs/services/iotsitewise/project_tags/index.md new file mode 100644 index 0000000..8d31402 --- /dev/null +++ b/website/docs/services/iotsitewise/project_tags/index.md @@ -0,0 +1,87 @@ +--- +title: project_tags +hide_title: false +hide_table_of_contents: false +keywords: + - project_tags + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for projects in a region + +## Overview + + + + + + + +
Nameproject_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Project
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the portal in which to create the project.
stringThe ID of the project.
stringA friendly name for the project.
stringA description for the project.
stringThe ARN of the project.
arrayThe IDs of the assets to be associated to the project.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all projects in a region. +```sql +SELECT +region, +portal_id, +project_id, +project_name, +project_description, +project_arn, +asset_ids, +tag_key, +tag_value +FROM aws.iotsitewise.project_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the project_tags resource, see projects + diff --git a/website/docs/services/iotsitewise/projects/index.md b/website/docs/services/iotsitewise/projects/index.md new file mode 100644 index 0000000..a19463f --- /dev/null +++ b/website/docs/services/iotsitewise/projects/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a project resource or lists projects in a region + +## Overview + + + + + + + +
Nameprojects
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Project
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the portal in which to create the project.
stringThe ID of the project.
stringA friendly name for the project.
stringA description for the project.
stringThe ARN of the project.
arrayThe IDs of the assets to be associated to the project.
arrayA list of key-value pairs that contain metadata for the project.
stringAWS region.
+ +For more information, see AWS::IoTSiteWise::Project. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all projects in a region. +```sql +SELECT +region, +portal_id, +project_id, +project_name, +project_description, +project_arn, +asset_ids, +tags +FROM aws.iotsitewise.projects +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual project. +```sql +SELECT +region, +portal_id, +project_id, +project_name, +project_description, +project_arn, +asset_ids, +tags +FROM aws.iotsitewise.projects +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.projects ( + PortalId, + ProjectName, + region +) +SELECT +'{{ PortalId }}', + '{{ ProjectName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotsitewise.projects ( + PortalId, + ProjectName, + ProjectDescription, + AssetIds, + Tags, + region +) +SELECT + '{{ PortalId }}', + '{{ ProjectName }}', + '{{ ProjectDescription }}', + '{{ AssetIds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: project + props: + - name: PortalId + value: '{{ PortalId }}' + - name: ProjectName + value: '{{ ProjectName }}' + - name: ProjectDescription + value: '{{ ProjectDescription }}' + - name: AssetIds + value: + - '{{ AssetIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotsitewise.projects +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iotsitewise:ListProjects, +iotsitewise:ListTagsForResource +``` diff --git a/website/docs/services/iotsitewise/projects_list_only/index.md b/website/docs/services/iotsitewise/projects_list_only/index.md new file mode 100644 index 0000000..c8543be --- /dev/null +++ b/website/docs/services/iotsitewise/projects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - iotsitewise + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + + + +
Nameprojects_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Project
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the project.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +project_id +FROM aws.iotsitewise.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + diff --git a/website/docs/services/iottwinmaker/component_type_tags/index.md b/website/docs/services/iottwinmaker/component_type_tags/index.md new file mode 100644 index 0000000..59c8516 --- /dev/null +++ b/website/docs/services/iottwinmaker/component_type_tags/index.md @@ -0,0 +1,105 @@ +--- +title: component_type_tags +hide_title: false +hide_table_of_contents: false +keywords: + - component_type_tags + - iottwinmaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for component_types in a region + +## Overview + + + + + + + +
Namecomponent_type_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::ComponentType
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace that contains the component type.
stringThe ID of the component type.
stringThe description of the component type.
arraySpecifies the parent component type to extend.
objecta Map of functions in the component type. Each function's key must be unique to this map.
booleanA Boolean value that specifies whether an entity can have more than one component of this type.
objectAn map of the property definitions in the component type. Each property definition's key must be unique to this map.
objectAn map of the property groups in the component type. Each property group's key must be unique to this map.
objectAn map of the composite component types in the component type. Each composite component type's key must be unique to this map.
stringThe ARN of the component type.
stringThe date and time when the component type was created.
stringThe last date and time when the component type was updated.
objectThe current status of the component type.
booleanA Boolean value that specifies whether the component type is abstract.
booleanA Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all component_types in a region. +```sql +SELECT +region, +workspace_id, +component_type_id, +description, +extends_from, +functions, +is_singleton, +property_definitions, +property_groups, +composite_component_types, +arn, +creation_date_time, +update_date_time, +status, +is_abstract, +is_schema_initialized, +tag_key, +tag_value +FROM aws.iottwinmaker.component_type_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_type_tags resource, see component_types + diff --git a/website/docs/services/iottwinmaker/component_types/index.md b/website/docs/services/iottwinmaker/component_types/index.md new file mode 100644 index 0000000..371dab7 --- /dev/null +++ b/website/docs/services/iottwinmaker/component_types/index.md @@ -0,0 +1,294 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a component_type resource or lists component_types in a region + +## Overview + + + + + + + +
Namecomponent_types
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::ComponentType
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace that contains the component type.
stringThe ID of the component type.
stringThe description of the component type.
arraySpecifies the parent component type to extend.
objecta Map of functions in the component type. Each function's key must be unique to this map.
booleanA Boolean value that specifies whether an entity can have more than one component of this type.
objectAn map of the property definitions in the component type. Each property definition's key must be unique to this map.
objectAn map of the property groups in the component type. Each property group's key must be unique to this map.
objectAn map of the composite component types in the component type. Each composite component type's key must be unique to this map.
stringThe ARN of the component type.
stringThe date and time when the component type was created.
stringThe last date and time when the component type was updated.
objectThe current status of the component type.
booleanA Boolean value that specifies whether the component type is abstract.
booleanA Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
objectA map of key-value pairs to associate with a resource.
stringAWS region.
+ +For more information, see AWS::IoTTwinMaker::ComponentType. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all component_types in a region. +```sql +SELECT +region, +workspace_id, +component_type_id, +description, +extends_from, +functions, +is_singleton, +property_definitions, +property_groups, +composite_component_types, +arn, +creation_date_time, +update_date_time, +status, +is_abstract, +is_schema_initialized, +tags +FROM aws.iottwinmaker.component_types +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual component_type. +```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_types +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new component_type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iottwinmaker.component_types ( + WorkspaceId, + ComponentTypeId, + region +) +SELECT +'{{ WorkspaceId }}', + '{{ ComponentTypeId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iottwinmaker.component_types ( + WorkspaceId, + ComponentTypeId, + Description, + ExtendsFrom, + Functions, + IsSingleton, + PropertyDefinitions, + PropertyGroups, + CompositeComponentTypes, + Tags, + region +) +SELECT + '{{ WorkspaceId }}', + '{{ ComponentTypeId }}', + '{{ Description }}', + '{{ ExtendsFrom }}', + '{{ Functions }}', + '{{ IsSingleton }}', + '{{ PropertyDefinitions }}', + '{{ PropertyGroups }}', + '{{ CompositeComponentTypes }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: component_type + props: + - name: WorkspaceId + value: '{{ WorkspaceId }}' + - name: ComponentTypeId + value: '{{ ComponentTypeId }}' + - name: Description + value: '{{ Description }}' + - name: ExtendsFrom + value: + - '{{ ExtendsFrom[0] }}' + - name: Functions + value: {} + - name: IsSingleton + value: '{{ IsSingleton }}' + - name: PropertyDefinitions + value: {} + - name: PropertyGroups + value: {} + - name: CompositeComponentTypes + value: {} + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iottwinmaker.component_types +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iottwinmaker:GetComponentType, +iottwinmaker:GetWorkspace, +iottwinmaker:ListComponentTypes, +iottwinmaker:ListTagsForResource +``` diff --git a/website/docs/services/iottwinmaker/component_types_list_only/index.md b/website/docs/services/iottwinmaker/component_types_list_only/index.md new file mode 100644 index 0000000..8502317 --- /dev/null +++ b/website/docs/services/iottwinmaker/component_types_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: component_types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - component_types_list_only + - iottwinmaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists component_types in a region or regions, for all properties use component_types + +## Overview + + + + + + + +
Namecomponent_types_list_only
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::ComponentType
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace that contains the component type.
stringThe ID of the component type.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all component_types in a region. +```sql +SELECT +region, +workspace_id, +component_type_id +FROM aws.iottwinmaker.component_types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_types_list_only resource, see component_types + diff --git a/website/docs/services/iottwinmaker/entities/index.md b/website/docs/services/iottwinmaker/entities/index.md new file mode 100644 index 0000000..0e11b37 --- /dev/null +++ b/website/docs/services/iottwinmaker/entities/index.md @@ -0,0 +1,286 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an entity resource or lists entities in a region + +## Overview + + + + + + + +
Nameentities
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Entity
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the entity.
stringThe name of the entity.
objectThe current status of the entity.
booleanA Boolean value that specifies whether the entity has child entities or not.
stringThe ID of the parent entity.
stringThe ARN of the entity.
stringThe description of the entity.
stringThe date and time when the entity was created.
stringThe last date and time when the entity was updated.
objectA key-value pair to associate with a resource.
stringThe ID of the workspace.
objectA map that sets information about a component type.
objectA map that sets information about a composite component.
stringAWS region.
+ +For more information, see AWS::IoTTwinMaker::Entity. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all entities in a region. +```sql +SELECT +region, +entity_id, +entity_name, +status, +has_child_entities, +parent_entity_id, +arn, +description, +creation_date_time, +update_date_time, +tags, +workspace_id, +components, +composite_components +FROM aws.iottwinmaker.entities +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual entity. +```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.entities +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new entity resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iottwinmaker.entities ( + EntityName, + WorkspaceId, + region +) +SELECT +'{{ EntityName }}', + '{{ WorkspaceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iottwinmaker.entities ( + EntityId, + EntityName, + ParentEntityId, + Description, + Tags, + WorkspaceId, + Components, + CompositeComponents, + region +) +SELECT + '{{ EntityId }}', + '{{ EntityName }}', + '{{ ParentEntityId }}', + '{{ Description }}', + '{{ Tags }}', + '{{ WorkspaceId }}', + '{{ Components }}', + '{{ CompositeComponents }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: entity + props: + - name: EntityId + value: '{{ EntityId }}' + - name: EntityName + value: '{{ EntityName }}' + - name: ParentEntityId + value: '{{ ParentEntityId }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: {} + - name: WorkspaceId + value: '{{ WorkspaceId }}' + - name: Components + value: {} + - name: CompositeComponents + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iottwinmaker.entities +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:GetEntity, +iottwinmaker:ListEntities +``` diff --git a/website/docs/services/iottwinmaker/entities_list_only/index.md b/website/docs/services/iottwinmaker/entities_list_only/index.md new file mode 100644 index 0000000..ddf1d32 --- /dev/null +++ b/website/docs/services/iottwinmaker/entities_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: entities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - entities_list_only + - iottwinmaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists entities in a region or regions, for all properties use entities + +## Overview + + + + + + + +
Nameentities_list_only
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Entity
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the entity.
stringThe ID of the workspace.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all entities in a region. +```sql +SELECT +region, +workspace_id, +entity_id +FROM aws.iottwinmaker.entities_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the entities_list_only resource, see entities + diff --git a/website/docs/services/iottwinmaker/entity_tags/index.md b/website/docs/services/iottwinmaker/entity_tags/index.md new file mode 100644 index 0000000..8771ea4 --- /dev/null +++ b/website/docs/services/iottwinmaker/entity_tags/index.md @@ -0,0 +1,99 @@ +--- +title: entity_tags +hide_title: false +hide_table_of_contents: false +keywords: + - entity_tags + - iottwinmaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for entities in a region + +## Overview + + + + + + + +
Nameentity_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Entity
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the entity.
stringThe name of the entity.
objectThe current status of the entity.
booleanA Boolean value that specifies whether the entity has child entities or not.
stringThe ID of the parent entity.
stringThe ARN of the entity.
stringThe description of the entity.
stringThe date and time when the entity was created.
stringThe last date and time when the entity was updated.
stringThe ID of the workspace.
objectA map that sets information about a component type.
objectA map that sets information about a composite component.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all entities in a region. +```sql +SELECT +region, +entity_id, +entity_name, +status, +has_child_entities, +parent_entity_id, +arn, +description, +creation_date_time, +update_date_time, +workspace_id, +components, +composite_components, +tag_key, +tag_value +FROM aws.iottwinmaker.entity_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the entity_tags resource, see entities + diff --git a/website/docs/services/iottwinmaker/index.md b/website/docs/services/iottwinmaker/index.md new file mode 100644 index 0000000..248bd66 --- /dev/null +++ b/website/docs/services/iottwinmaker/index.md @@ -0,0 +1,50 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The iottwinmaker service documentation. + +:::info Service Summary + +
+
+total resources: 15
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/iottwinmaker/scene_tags/index.md b/website/docs/services/iottwinmaker/scene_tags/index.md new file mode 100644 index 0000000..8a301cc --- /dev/null +++ b/website/docs/services/iottwinmaker/scene_tags/index.md @@ -0,0 +1,95 @@ +--- +title: scene_tags +hide_title: false +hide_table_of_contents: false +keywords: + - scene_tags + - iottwinmaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scenes in a region + +## Overview + + + + + + + +
Namescene_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Scene
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the scene.
stringThe ARN of the scene.
stringThe description of the scene.
stringThe relative path that specifies the location of the content definition file.
stringThe date and time when the scene was created.
stringThe date and time of the current update.
stringThe ID of the scene.
arrayA list of capabilities that the scene uses to render.
objectA key-value pair of scene metadata for the scene.
objectA key-value pair of generated scene metadata for the scene.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scenes in a region. +```sql +SELECT +region, +scene_id, +arn, +description, +content_location, +creation_date_time, +update_date_time, +workspace_id, +capabilities, +scene_metadata, +generated_scene_metadata, +tag_key, +tag_value +FROM aws.iottwinmaker.scene_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scene_tags resource, see scenes + diff --git a/website/docs/services/iottwinmaker/scenes/index.md b/website/docs/services/iottwinmaker/scenes/index.md new file mode 100644 index 0000000..28a9c67 --- /dev/null +++ b/website/docs/services/iottwinmaker/scenes/index.md @@ -0,0 +1,268 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a scene resource or lists scenes in a region + +## Overview + + + + + + + +
Namescenes
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Scene
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the scene.
stringThe ARN of the scene.
stringThe description of the scene.
stringThe relative path that specifies the location of the content definition file.
stringThe date and time when the scene was created.
stringThe date and time of the current update.
objectA key-value pair to associate with a resource.
stringThe ID of the scene.
arrayA list of capabilities that the scene uses to render.
objectA key-value pair of scene metadata for the scene.
objectA key-value pair of generated scene metadata for the scene.
stringAWS region.
+ +For more information, see AWS::IoTTwinMaker::Scene. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scenes in a region. +```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.scenes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual scene. +```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.scenes +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scene resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iottwinmaker.scenes ( + SceneId, + ContentLocation, + WorkspaceId, + region +) +SELECT +'{{ SceneId }}', + '{{ ContentLocation }}', + '{{ WorkspaceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iottwinmaker.scenes ( + SceneId, + Description, + ContentLocation, + Tags, + WorkspaceId, + Capabilities, + SceneMetadata, + region +) +SELECT + '{{ SceneId }}', + '{{ Description }}', + '{{ ContentLocation }}', + '{{ Tags }}', + '{{ WorkspaceId }}', + '{{ Capabilities }}', + '{{ SceneMetadata }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: scene + props: + - name: SceneId + value: '{{ SceneId }}' + - name: Description + value: '{{ Description }}' + - name: ContentLocation + value: '{{ ContentLocation }}' + - name: Tags + value: {} + - name: WorkspaceId + value: '{{ WorkspaceId }}' + - name: Capabilities + value: + - '{{ Capabilities[0] }}' + - name: SceneMetadata + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iottwinmaker.scenes +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:ListScenes +``` diff --git a/website/docs/services/iottwinmaker/scenes_list_only/index.md b/website/docs/services/iottwinmaker/scenes_list_only/index.md new file mode 100644 index 0000000..209ab70 --- /dev/null +++ b/website/docs/services/iottwinmaker/scenes_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: scenes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scenes_list_only + - iottwinmaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scenes in a region or regions, for all properties use scenes + +## Overview + + + + + + + +
Namescenes_list_only
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Scene
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the scene.
stringThe ID of the scene.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scenes in a region. +```sql +SELECT +region, +workspace_id, +scene_id +FROM aws.iottwinmaker.scenes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scenes_list_only resource, see scenes + diff --git a/website/docs/services/iottwinmaker/sync_job_tags/index.md b/website/docs/services/iottwinmaker/sync_job_tags/index.md new file mode 100644 index 0000000..2b50e3e --- /dev/null +++ b/website/docs/services/iottwinmaker/sync_job_tags/index.md @@ -0,0 +1,89 @@ +--- +title: sync_job_tags +hide_title: false +hide_table_of_contents: false +keywords: + - sync_job_tags + - iottwinmaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sync_jobs in a region + +## Overview + + + + + + + +
Namesync_job_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::SyncJob
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace.
stringThe source of the SyncJob.
stringThe IAM Role that execute SyncJob.
stringThe date and time when the sync job was created.
stringThe date and time when the sync job was updated.
stringThe ARN of the SyncJob.
stringThe state of SyncJob.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sync_jobs in a region. +```sql +SELECT +region, +workspace_id, +sync_source, +sync_role, +creation_date_time, +update_date_time, +arn, +state, +tag_key, +tag_value +FROM aws.iottwinmaker.sync_job_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sync_job_tags resource, see sync_jobs + diff --git a/website/docs/services/iottwinmaker/sync_jobs/index.md b/website/docs/services/iottwinmaker/sync_jobs/index.md new file mode 100644 index 0000000..1ff80ae --- /dev/null +++ b/website/docs/services/iottwinmaker/sync_jobs/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a sync_job resource or lists sync_jobs in a region + +## Overview + + + + + + + +
Namesync_jobs
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::SyncJob
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace.
stringThe source of the SyncJob.
stringThe IAM Role that execute SyncJob.
stringThe date and time when the sync job was created.
stringThe date and time when the sync job was updated.
stringThe ARN of the SyncJob.
stringThe state of SyncJob.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +For more information, see AWS::IoTTwinMaker::SyncJob. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all sync_jobs in a region. +```sql +SELECT +region, +workspace_id, +sync_source, +sync_role, +creation_date_time, +update_date_time, +arn, +state, +tags +FROM aws.iottwinmaker.sync_jobs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual sync_job. +```sql +SELECT +region, +workspace_id, +sync_source, +sync_role, +creation_date_time, +update_date_time, +arn, +state, +tags +FROM aws.iottwinmaker.sync_jobs +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new sync_job resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iottwinmaker.sync_jobs ( + WorkspaceId, + SyncSource, + SyncRole, + region +) +SELECT +'{{ WorkspaceId }}', + '{{ SyncSource }}', + '{{ SyncRole }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iottwinmaker.sync_jobs ( + WorkspaceId, + SyncSource, + SyncRole, + Tags, + region +) +SELECT + '{{ WorkspaceId }}', + '{{ SyncSource }}', + '{{ SyncRole }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: sync_job + props: + - name: WorkspaceId + value: '{{ WorkspaceId }}' + - name: SyncSource + value: '{{ SyncSource }}' + - name: SyncRole + value: '{{ SyncRole }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iottwinmaker.sync_jobs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iottwinmaker:GetSyncJob, +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource +``` + +### Delete +```json +iottwinmaker:DeleteSyncJob, +iottwinmaker:GetSyncJob, +iottwinmaker:GetWorkspace +``` + +### List +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListSyncJobs, +iottwinmaker:ListTagsForResource +``` diff --git a/website/docs/services/iottwinmaker/sync_jobs_list_only/index.md b/website/docs/services/iottwinmaker/sync_jobs_list_only/index.md new file mode 100644 index 0000000..fe12e1a --- /dev/null +++ b/website/docs/services/iottwinmaker/sync_jobs_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: sync_jobs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sync_jobs_list_only + - iottwinmaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sync_jobs in a region or regions, for all properties use sync_jobs + +## Overview + + + + + + + +
Namesync_jobs_list_only
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::SyncJob
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace.
stringThe source of the SyncJob.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sync_jobs in a region. +```sql +SELECT +region, +workspace_id, +sync_source +FROM aws.iottwinmaker.sync_jobs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sync_jobs_list_only resource, see sync_jobs + diff --git a/website/docs/services/iottwinmaker/workspace_tags/index.md b/website/docs/services/iottwinmaker/workspace_tags/index.md new file mode 100644 index 0000000..1187972 --- /dev/null +++ b/website/docs/services/iottwinmaker/workspace_tags/index.md @@ -0,0 +1,89 @@ +--- +title: workspace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workspace_tags + - iottwinmaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workspaces in a region + +## Overview + + + + + + + +
Nameworkspace_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Workspace
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace.
stringThe ARN of the workspace.
stringThe description of the workspace.
stringThe ARN of the execution role associated with the workspace.
stringThe ARN of the S3 bucket where resources associated with the workspace are stored.
stringThe date and time when the workspace was created.
stringThe date and time of the current update.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workspaces in a region. +```sql +SELECT +region, +workspace_id, +arn, +description, +role, +s3_location, +creation_date_time, +update_date_time, +tag_key, +tag_value +FROM aws.iottwinmaker.workspace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspace_tags resource, see workspaces + diff --git a/website/docs/services/iottwinmaker/workspaces/index.md b/website/docs/services/iottwinmaker/workspaces/index.md new file mode 100644 index 0000000..a1598ad --- /dev/null +++ b/website/docs/services/iottwinmaker/workspaces/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a workspace resource or lists workspaces in a region + +## Overview + + + + + + + +
Nameworkspaces
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Workspace
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace.
stringThe ARN of the workspace.
stringThe description of the workspace.
stringThe ARN of the execution role associated with the workspace.
stringThe ARN of the S3 bucket where resources associated with the workspace are stored.
stringThe date and time when the workspace was created.
stringThe date and time of the current update.
objectA map of key-value pairs to associate with a resource.
stringAWS region.
+ +For more information, see AWS::IoTTwinMaker::Workspace. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all workspaces in a region. +```sql +SELECT +region, +workspace_id, +arn, +description, +role, +s3_location, +creation_date_time, +update_date_time, +tags +FROM aws.iottwinmaker.workspaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual workspace. +```sql +SELECT +region, +workspace_id, +arn, +description, +role, +s3_location, +creation_date_time, +update_date_time, +tags +FROM aws.iottwinmaker.workspaces +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workspace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iottwinmaker.workspaces ( + WorkspaceId, + Role, + S3Location, + region +) +SELECT +'{{ WorkspaceId }}', + '{{ Role }}', + '{{ S3Location }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iottwinmaker.workspaces ( + WorkspaceId, + Description, + Role, + S3Location, + Tags, + region +) +SELECT + '{{ WorkspaceId }}', + '{{ Description }}', + '{{ Role }}', + '{{ S3Location }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: workspace + props: + - name: WorkspaceId + value: '{{ WorkspaceId }}' + - name: Description + value: '{{ Description }}' + - name: Role + value: '{{ Role }}' + - name: S3Location + value: '{{ S3Location }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iottwinmaker.workspaces +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource +``` + +### Update +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:TagResource, +iottwinmaker:UntagResource, +iottwinmaker:UpdateWorkspace +``` + +### Delete +```json +iottwinmaker:DeleteWorkspace, +iottwinmaker:GetWorkspace +``` + +### List +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:ListWorkspaces +``` diff --git a/website/docs/services/iottwinmaker/workspaces_list_only/index.md b/website/docs/services/iottwinmaker/workspaces_list_only/index.md new file mode 100644 index 0000000..4cad38e --- /dev/null +++ b/website/docs/services/iottwinmaker/workspaces_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: workspaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces_list_only + - iottwinmaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workspaces in a region or regions, for all properties use workspaces + +## Overview + + + + + + + +
Nameworkspaces_list_only
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Workspace
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the workspace.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workspaces in a region. +```sql +SELECT +region, +workspace_id +FROM aws.iottwinmaker.workspaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspaces_list_only resource, see workspaces + diff --git a/website/docs/services/iotwireless/destination_tags/index.md b/website/docs/services/iotwireless/destination_tags/index.md new file mode 100644 index 0000000..2d92248 --- /dev/null +++ b/website/docs/services/iotwireless/destination_tags/index.md @@ -0,0 +1,87 @@ +--- +title: destination_tags +hide_title: false +hide_table_of_contents: false +keywords: + - destination_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for destinations in a region + +## Overview + + + + + + + +
Namedestination_tags
TypeResource
DescriptionDestination's resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique name of destination
stringDestination expression
stringMust be RuleName
stringDestination description
stringAWS role ARN that grants access
stringDestination arn. Returned after successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all destinations in a region. +```sql +SELECT +region, +name, +expression, +expression_type, +description, +role_arn, +arn, +tag_key, +tag_value +FROM aws.iotwireless.destination_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the destination_tags resource, see destinations + diff --git a/website/docs/services/iotwireless/destinations/index.md b/website/docs/services/iotwireless/destinations/index.md new file mode 100644 index 0000000..b700ee6 --- /dev/null +++ b/website/docs/services/iotwireless/destinations/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a destination resource or lists destinations in a region + +## Overview + + + + + + + +
Namedestinations
TypeResource
DescriptionDestination's resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringUnique name of destination
stringDestination expression
stringMust be RuleName
stringDestination description
arrayA list of key-value pairs that contain metadata for the destination.
stringAWS role ARN that grants access
stringDestination arn. Returned after successful create.
stringAWS region.
+ +For more information, see AWS::IoTWireless::Destination. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all destinations in a region. +```sql +SELECT +region, +name, +expression, +expression_type, +description, +tags, +role_arn, +arn +FROM aws.iotwireless.destinations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual destination. +```sql +SELECT +region, +name, +expression, +expression_type, +description, +tags, +role_arn, +arn +FROM aws.iotwireless.destinations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.destinations ( + Name, + Expression, + ExpressionType, + region +) +SELECT +'{{ Name }}', + '{{ Expression }}', + '{{ ExpressionType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.destinations ( + Name, + Expression, + ExpressionType, + Description, + Tags, + RoleArn, + region +) +SELECT + '{{ Name }}', + '{{ Expression }}', + '{{ ExpressionType }}', + '{{ Description }}', + '{{ Tags }}', + '{{ RoleArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: destination + props: + - name: Name + value: '{{ Name }}' + - name: Expression + value: '{{ Expression }}' + - name: ExpressionType + value: '{{ ExpressionType }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: RoleArn + value: '{{ RoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.destinations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the destinations resource, the following permissions are required: + +### Create +```json +iam:PassRole, +iotwireless:CreateDestination, +iotwireless:TagResource +``` + +### Read +```json +iotwireless:GetDestination, +iotwireless:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +iotwireless:GetDestination, +iotwireless:UpdateDestination, +iotwireless:UntagResource, +iotwireless:TagResource +``` + +### Delete +```json +iotwireless:DeleteDestination +``` + +### List +```json +iotwireless:ListDestinations, +iotwireless:ListTagsForResource +``` diff --git a/website/docs/services/iotwireless/destinations_list_only/index.md b/website/docs/services/iotwireless/destinations_list_only/index.md new file mode 100644 index 0000000..62daeaf --- /dev/null +++ b/website/docs/services/iotwireless/destinations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: destinations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - destinations_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists destinations in a region or regions, for all properties use destinations + +## Overview + + + + + + + +
Namedestinations_list_only
TypeResource
DescriptionDestination's resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique name of destination
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all destinations in a region. +```sql +SELECT +region, +name +FROM aws.iotwireless.destinations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the destinations_list_only resource, see destinations + diff --git a/website/docs/services/iotwireless/device_profile_tags/index.md b/website/docs/services/iotwireless/device_profile_tags/index.md new file mode 100644 index 0000000..4230e71 --- /dev/null +++ b/website/docs/services/iotwireless/device_profile_tags/index.md @@ -0,0 +1,83 @@ +--- +title: device_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - device_profile_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for device_profiles in a region + +## Overview + + + + + + + +
Namedevice_profile_tags
TypeResource
DescriptionDevice Profile's resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of service profile
objectLoRaWANDeviceProfile supports all LoRa specific attributes for service profile for CreateDeviceProfile operation
stringService profile Arn. Returned after successful create.
stringService profile Id. Returned after successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all device_profiles in a region. +```sql +SELECT +region, +name, +lo_ra_wan, +arn, +id, +tag_key, +tag_value +FROM aws.iotwireless.device_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the device_profile_tags resource, see device_profiles + diff --git a/website/docs/services/iotwireless/device_profiles/index.md b/website/docs/services/iotwireless/device_profiles/index.md new file mode 100644 index 0000000..00ca2b3 --- /dev/null +++ b/website/docs/services/iotwireless/device_profiles/index.md @@ -0,0 +1,241 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a device_profile resource or lists device_profiles in a region + +## Overview + + + + + + + +
Namedevice_profiles
TypeResource
DescriptionDevice Profile's resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of service profile
objectLoRaWANDeviceProfile supports all LoRa specific attributes for service profile for CreateDeviceProfile operation
arrayA list of key-value pairs that contain metadata for the device profile.
stringService profile Arn. Returned after successful create.
stringService profile Id. Returned after successful create.
stringAWS region.
+ +For more information, see AWS::IoTWireless::DeviceProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all device_profiles in a region. +```sql +SELECT +region, +name, +lo_ra_wan, +tags, +arn, +id +FROM aws.iotwireless.device_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual device_profile. +```sql +SELECT +region, +name, +lo_ra_wan, +tags, +arn, +id +FROM aws.iotwireless.device_profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new device_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.device_profiles ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.device_profiles ( + Name, + LoRaWAN, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ LoRaWAN }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: device_profile + props: + - name: Name + value: '{{ Name }}' + - name: LoRaWAN + value: + SupportsClassB: '{{ SupportsClassB }}' + ClassBTimeout: '{{ ClassBTimeout }}' + PingSlotPeriod: '{{ PingSlotPeriod }}' + PingSlotDr: '{{ PingSlotDr }}' + PingSlotFreq: '{{ PingSlotFreq }}' + SupportsClassC: '{{ SupportsClassC }}' + ClassCTimeout: '{{ ClassCTimeout }}' + MacVersion: '{{ MacVersion }}' + RegParamsRevision: '{{ RegParamsRevision }}' + RxDelay1: '{{ RxDelay1 }}' + RxDrOffset1: '{{ RxDrOffset1 }}' + RxFreq2: '{{ RxFreq2 }}' + RxDataRate2: '{{ RxDataRate2 }}' + FactoryPresetFreqsList: + - '{{ FactoryPresetFreqsList[0] }}' + MaxEirp: '{{ MaxEirp }}' + MaxDutyCycle: '{{ MaxDutyCycle }}' + SupportsJoin: '{{ SupportsJoin }}' + RfRegion: '{{ RfRegion }}' + Supports32BitFCnt: '{{ Supports32BitFCnt }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.device_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the device_profiles resource, the following permissions are required: + +### Create +```json +iotwireless:CreateDeviceProfile, +iotwireless:TagResource +``` + +### Update +```json +iotwireless:GetDeviceProfile, +iotwireless:TagResource, +iotwireless:UntagResource +``` + +### Read +```json +iotwireless:GetDeviceProfile, +iotwireless:ListTagsForResource +``` + +### Delete +```json +iotwireless:DeleteDeviceProfile +``` + +### List +```json +iotwireless:ListDeviceProfiles, +iotwireless:ListTagsForResource +``` diff --git a/website/docs/services/iotwireless/device_profiles_list_only/index.md b/website/docs/services/iotwireless/device_profiles_list_only/index.md new file mode 100644 index 0000000..b07946a --- /dev/null +++ b/website/docs/services/iotwireless/device_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: device_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - device_profiles_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists device_profiles in a region or regions, for all properties use device_profiles + +## Overview + + + + + + + +
Namedevice_profiles_list_only
TypeResource
DescriptionDevice Profile's resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringService profile Id. Returned after successful create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all device_profiles in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.device_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the device_profiles_list_only resource, see device_profiles + diff --git a/website/docs/services/iotwireless/fuota_task_tags/index.md b/website/docs/services/iotwireless/fuota_task_tags/index.md new file mode 100644 index 0000000..0b137ac --- /dev/null +++ b/website/docs/services/iotwireless/fuota_task_tags/index.md @@ -0,0 +1,99 @@ +--- +title: fuota_task_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fuota_task_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fuota_tasks in a region + +## Overview + + + + + + + +
Namefuota_task_tags
TypeResource
DescriptionCreate and manage FUOTA tasks.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of FUOTA task
stringFUOTA task description
objectFUOTA task LoRaWAN
stringFUOTA task firmware update image binary S3 link
stringFUOTA task firmware IAM role for reading S3
stringFUOTA task arn. Returned after successful create.
stringFUOTA task id. Returned after successful create.
stringFUOTA task status. Returned after successful read.
stringWireless device to associate. Only for update request.
stringWireless device to disassociate. Only for update request.
stringMulticast group to associate. Only for update request.
stringMulticast group to disassociate. Only for update request.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fuota_tasks in a region. +```sql +SELECT +region, +name, +description, +lo_ra_wan, +firmware_update_image, +firmware_update_role, +arn, +id, +fuota_task_status, +associate_wireless_device, +disassociate_wireless_device, +associate_multicast_group, +disassociate_multicast_group, +tag_key, +tag_value +FROM aws.iotwireless.fuota_task_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fuota_task_tags resource, see fuota_tasks + diff --git a/website/docs/services/iotwireless/fuota_tasks/index.md b/website/docs/services/iotwireless/fuota_tasks/index.md new file mode 100644 index 0000000..63c43c6 --- /dev/null +++ b/website/docs/services/iotwireless/fuota_tasks/index.md @@ -0,0 +1,289 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a fuota_task resource or lists fuota_tasks in a region + +## Overview + + + + + + + +
Namefuota_tasks
TypeResource
DescriptionCreate and manage FUOTA tasks.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of FUOTA task
stringFUOTA task description
objectFUOTA task LoRaWAN
stringFUOTA task firmware update image binary S3 link
stringFUOTA task firmware IAM role for reading S3
stringFUOTA task arn. Returned after successful create.
stringFUOTA task id. Returned after successful create.
arrayA list of key-value pairs that contain metadata for the FUOTA task.
stringFUOTA task status. Returned after successful read.
stringWireless device to associate. Only for update request.
stringWireless device to disassociate. Only for update request.
stringMulticast group to associate. Only for update request.
stringMulticast group to disassociate. Only for update request.
stringAWS region.
+ +For more information, see AWS::IoTWireless::FuotaTask. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all fuota_tasks in a region. +```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_tasks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual fuota_task. +```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_tasks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new fuota_task resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.fuota_tasks ( + LoRaWAN, + FirmwareUpdateImage, + FirmwareUpdateRole, + region +) +SELECT +'{{ LoRaWAN }}', + '{{ FirmwareUpdateImage }}', + '{{ FirmwareUpdateRole }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.fuota_tasks ( + Name, + Description, + LoRaWAN, + FirmwareUpdateImage, + FirmwareUpdateRole, + Tags, + AssociateWirelessDevice, + DisassociateWirelessDevice, + AssociateMulticastGroup, + DisassociateMulticastGroup, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ LoRaWAN }}', + '{{ FirmwareUpdateImage }}', + '{{ FirmwareUpdateRole }}', + '{{ Tags }}', + '{{ AssociateWirelessDevice }}', + '{{ DisassociateWirelessDevice }}', + '{{ AssociateMulticastGroup }}', + '{{ DisassociateMulticastGroup }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: fuota_task + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: LoRaWAN + value: + RfRegion: '{{ RfRegion }}' + DlClass: '{{ DlClass }}' + NumberOfDevicesRequested: '{{ NumberOfDevicesRequested }}' + NumberOfDevicesInGroup: '{{ NumberOfDevicesInGroup }}' + - name: FirmwareUpdateImage + value: '{{ FirmwareUpdateImage }}' + - name: FirmwareUpdateRole + value: '{{ FirmwareUpdateRole }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AssociateWirelessDevice + value: '{{ AssociateWirelessDevice }}' + - name: DisassociateWirelessDevice + value: '{{ DisassociateWirelessDevice }}' + - name: AssociateMulticastGroup + value: '{{ AssociateMulticastGroup }}' + - name: DisassociateMulticastGroup + value: '{{ DisassociateMulticastGroup }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.fuota_tasks +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the fuota_tasks resource, the following permissions are required: + +### Create +```json +iotwireless:CreateFuotaTask, +iotwireless:TagResource, +iam:GetRole, +iam:PassRole +``` + +### Read +```json +iotwireless:GetFuotaTask, +iotwireless:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +iotwireless:UpdateFuotaTask, +iotwireless:GetFuotaTask, +iotwireless:TagResource, +iotwireless:UntagResource, +iotwireless:AssociateMulticastGroupWithFuotaTask, +iotwireless:DisassociateMulticastGroupFromFuotaTask, +iotwireless:AssociateWirelessDeviceWithFuotaTask, +iotwireless:DisassociateWirelessDeviceFromFuotaTask +``` + +### Delete +```json +iotwireless:DeleteFuotaTask +``` + +### List +```json +iotwireless:ListFuotaTasks, +iotwireless:ListTagsForResource +``` diff --git a/website/docs/services/iotwireless/fuota_tasks_list_only/index.md b/website/docs/services/iotwireless/fuota_tasks_list_only/index.md new file mode 100644 index 0000000..6be82d1 --- /dev/null +++ b/website/docs/services/iotwireless/fuota_tasks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: fuota_tasks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fuota_tasks_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fuota_tasks in a region or regions, for all properties use fuota_tasks + +## Overview + + + + + + + +
Namefuota_tasks_list_only
TypeResource
DescriptionCreate and manage FUOTA tasks.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringFUOTA task id. Returned after successful create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fuota_tasks in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.fuota_tasks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fuota_tasks_list_only resource, see fuota_tasks + diff --git a/website/docs/services/iotwireless/index.md b/website/docs/services/iotwireless/index.md new file mode 100644 index 0000000..28b2f17 --- /dev/null +++ b/website/docs/services/iotwireless/index.md @@ -0,0 +1,68 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The iotwireless service documentation. + +:::info Service Summary + +
+
+total resources: 33
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/iotwireless/multicast_group_tags/index.md b/website/docs/services/iotwireless/multicast_group_tags/index.md new file mode 100644 index 0000000..5f6a018 --- /dev/null +++ b/website/docs/services/iotwireless/multicast_group_tags/index.md @@ -0,0 +1,91 @@ +--- +title: multicast_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - multicast_group_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for multicast_groups in a region + +## Overview + + + + + + + +
Namemulticast_group_tags
TypeResource
DescriptionCreate and manage Multicast groups.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of Multicast group
stringMulticast group description
objectMulticast group LoRaWAN
stringMulticast group arn. Returned after successful create.
stringMulticast group id. Returned after successful create.
stringMulticast group status. Returned after successful read.
stringWireless device to associate. Only for update request.
stringWireless device to disassociate. Only for update request.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all multicast_groups in a region. +```sql +SELECT +region, +name, +description, +lo_ra_wan, +arn, +id, +status, +associate_wireless_device, +disassociate_wireless_device, +tag_key, +tag_value +FROM aws.iotwireless.multicast_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multicast_group_tags resource, see multicast_groups + diff --git a/website/docs/services/iotwireless/multicast_groups/index.md b/website/docs/services/iotwireless/multicast_groups/index.md new file mode 100644 index 0000000..a99af02 --- /dev/null +++ b/website/docs/services/iotwireless/multicast_groups/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a multicast_group resource or lists multicast_groups in a region + +## Overview + + + + + + + +
Namemulticast_groups
TypeResource
DescriptionCreate and manage Multicast groups.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of Multicast group
stringMulticast group description
objectMulticast group LoRaWAN
stringMulticast group arn. Returned after successful create.
stringMulticast group id. Returned after successful create.
arrayA list of key-value pairs that contain metadata for the Multicast group.
stringMulticast group status. Returned after successful read.
stringWireless device to associate. Only for update request.
stringWireless device to disassociate. Only for update request.
stringAWS region.
+ +For more information, see AWS::IoTWireless::MulticastGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all multicast_groups in a region. +```sql +SELECT +region, +name, +description, +lo_ra_wan, +arn, +id, +tags, +status, +associate_wireless_device, +disassociate_wireless_device +FROM aws.iotwireless.multicast_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual multicast_group. +```sql +SELECT +region, +name, +description, +lo_ra_wan, +arn, +id, +tags, +status, +associate_wireless_device, +disassociate_wireless_device +FROM aws.iotwireless.multicast_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new multicast_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.multicast_groups ( + LoRaWAN, + region +) +SELECT +'{{ LoRaWAN }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.multicast_groups ( + Name, + Description, + LoRaWAN, + Tags, + AssociateWirelessDevice, + DisassociateWirelessDevice, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ LoRaWAN }}', + '{{ Tags }}', + '{{ AssociateWirelessDevice }}', + '{{ DisassociateWirelessDevice }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: multicast_group + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: LoRaWAN + value: + RfRegion: '{{ RfRegion }}' + DlClass: '{{ DlClass }}' + NumberOfDevicesRequested: '{{ NumberOfDevicesRequested }}' + NumberOfDevicesInGroup: '{{ NumberOfDevicesInGroup }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AssociateWirelessDevice + value: '{{ AssociateWirelessDevice }}' + - name: DisassociateWirelessDevice + value: '{{ DisassociateWirelessDevice }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.multicast_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the multicast_groups resource, the following permissions are required: + +### Create +```json +iotwireless:CreateMulticastGroup, +iotwireless:TagResource +``` + +### Read +```json +iotwireless:GetMulticastGroup, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:UpdateMulticastGroup, +iotwireless:GetMulticastGroup, +iotwireless:TagResource, +iotwireless:UntagResource, +iotwireless:AssociateWirelessDeviceWithMulticastGroup, +iotwireless:DisassociateWirelessDeviceFromMulticastGroup +``` + +### Delete +```json +iotwireless:DeleteMulticastGroup +``` + +### List +```json +iotwireless:ListMulticastGroups, +iotwireless:ListTagsForResource +``` diff --git a/website/docs/services/iotwireless/multicast_groups_list_only/index.md b/website/docs/services/iotwireless/multicast_groups_list_only/index.md new file mode 100644 index 0000000..c4bbb00 --- /dev/null +++ b/website/docs/services/iotwireless/multicast_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: multicast_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - multicast_groups_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists multicast_groups in a region or regions, for all properties use multicast_groups + +## Overview + + + + + + + +
Namemulticast_groups_list_only
TypeResource
DescriptionCreate and manage Multicast groups.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringMulticast group id. Returned after successful create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all multicast_groups in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.multicast_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multicast_groups_list_only resource, see multicast_groups + diff --git a/website/docs/services/iotwireless/network_analyzer_configuration_tags/index.md b/website/docs/services/iotwireless/network_analyzer_configuration_tags/index.md new file mode 100644 index 0000000..6ccfd33 --- /dev/null +++ b/website/docs/services/iotwireless/network_analyzer_configuration_tags/index.md @@ -0,0 +1,87 @@ +--- +title: network_analyzer_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_analyzer_configuration_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_analyzer_configurations in a region + +## Overview + + + + + + + +
Namenetwork_analyzer_configuration_tags
TypeResource
DescriptionCreate and manage NetworkAnalyzerConfiguration resource.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the network analyzer configuration
stringThe description of the new resource
objectTrace content for your wireless gateway and wireless device resources
arrayList of wireless gateway resources that have been added to the network analyzer configuration
arrayList of wireless gateway resources that have been added to the network analyzer configuration
stringArn for network analyzer configuration, Returned upon successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_analyzer_configurations in a region. +```sql +SELECT +region, +name, +description, +trace_content, +wireless_devices, +wireless_gateways, +arn, +tag_key, +tag_value +FROM aws.iotwireless.network_analyzer_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_analyzer_configuration_tags resource, see network_analyzer_configurations + diff --git a/website/docs/services/iotwireless/network_analyzer_configurations/index.md b/website/docs/services/iotwireless/network_analyzer_configurations/index.md new file mode 100644 index 0000000..4e5dc02 --- /dev/null +++ b/website/docs/services/iotwireless/network_analyzer_configurations/index.md @@ -0,0 +1,244 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network_analyzer_configuration resource or lists network_analyzer_configurations in a region + +## Overview + + + + + + + +
Namenetwork_analyzer_configurations
TypeResource
DescriptionCreate and manage NetworkAnalyzerConfiguration resource.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of the network analyzer configuration
stringThe description of the new resource
objectTrace content for your wireless gateway and wireless device resources
arrayList of wireless gateway resources that have been added to the network analyzer configuration
arrayList of wireless gateway resources that have been added to the network analyzer configuration
stringArn for network analyzer configuration, Returned upon successful create.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IoTWireless::NetworkAnalyzerConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all network_analyzer_configurations in a region. +```sql +SELECT +region, +name, +description, +trace_content, +wireless_devices, +wireless_gateways, +arn, +tags +FROM aws.iotwireless.network_analyzer_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network_analyzer_configuration. +```sql +SELECT +region, +name, +description, +trace_content, +wireless_devices, +wireless_gateways, +arn, +tags +FROM aws.iotwireless.network_analyzer_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_analyzer_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.network_analyzer_configurations ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.network_analyzer_configurations ( + Name, + Description, + TraceContent, + WirelessDevices, + WirelessGateways, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ TraceContent }}', + '{{ WirelessDevices }}', + '{{ WirelessGateways }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network_analyzer_configuration + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: TraceContent + value: + WirelessDeviceFrameInfo: '{{ WirelessDeviceFrameInfo }}' + LogLevel: '{{ LogLevel }}' + - name: WirelessDevices + value: + - '{{ WirelessDevices[0] }}' + - name: WirelessGateways + value: + - '{{ WirelessGateways[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.network_analyzer_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the network_analyzer_configurations resource, the following permissions are required: + +### Create +```json +iotwireless:CreateNetworkAnalyzerConfiguration, +iotwireless:TagResource +``` + +### Read +```json +iotwireless:GetNetworkAnalyzerConfiguration, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:UpdateNetworkAnalyzerConfiguration, +iotwireless:GetNetworkAnalyzerConfiguration, +iotwireless:TagResource, +iotwireless:UntagResource +``` + +### Delete +```json +iotwireless:DeleteNetworkAnalyzerConfiguration +``` + +### List +```json +iotwireless:ListNetworkAnalyzerConfigurations, +iotwireless:ListTagsForResource +``` diff --git a/website/docs/services/iotwireless/network_analyzer_configurations_list_only/index.md b/website/docs/services/iotwireless/network_analyzer_configurations_list_only/index.md new file mode 100644 index 0000000..cb23b32 --- /dev/null +++ b/website/docs/services/iotwireless/network_analyzer_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_analyzer_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_analyzer_configurations_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_analyzer_configurations in a region or regions, for all properties use network_analyzer_configurations + +## Overview + + + + + + + +
Namenetwork_analyzer_configurations_list_only
TypeResource
DescriptionCreate and manage NetworkAnalyzerConfiguration resource.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the network analyzer configuration
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_analyzer_configurations in a region. +```sql +SELECT +region, +name +FROM aws.iotwireless.network_analyzer_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_analyzer_configurations_list_only resource, see network_analyzer_configurations + diff --git a/website/docs/services/iotwireless/partner_account_tags/index.md b/website/docs/services/iotwireless/partner_account_tags/index.md new file mode 100644 index 0000000..0468044 --- /dev/null +++ b/website/docs/services/iotwireless/partner_account_tags/index.md @@ -0,0 +1,91 @@ +--- +title: partner_account_tags +hide_title: false +hide_table_of_contents: false +keywords: + - partner_account_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for partner_accounts in a region + +## Overview + + + + + + + +
Namepartner_account_tags
TypeResource
DescriptionCreate and manage partner account
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe Sidewalk account credentials.
stringThe partner account ID to disassociate from the AWS account
stringThe partner type
objectThe Sidewalk account credentials.
booleanWhether the partner account is linked to the AWS account.
objectThe Sidewalk account credentials.
stringThe fingerprint of the Sidewalk application server private key.
stringPartnerAccount arn. Returned after successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all partner_accounts in a region. +```sql +SELECT +region, +sidewalk, +partner_account_id, +partner_type, +sidewalk_response, +account_linked, +sidewalk_update, +fingerprint, +arn, +tag_key, +tag_value +FROM aws.iotwireless.partner_account_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the partner_account_tags resource, see partner_accounts + diff --git a/website/docs/services/iotwireless/partner_accounts/index.md b/website/docs/services/iotwireless/partner_accounts/index.md new file mode 100644 index 0000000..1f114ff --- /dev/null +++ b/website/docs/services/iotwireless/partner_accounts/index.md @@ -0,0 +1,270 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a partner_account resource or lists partner_accounts in a region + +## Overview + + + + + + + +
Namepartner_accounts
TypeResource
DescriptionCreate and manage partner account
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe Sidewalk account credentials.
stringThe partner account ID to disassociate from the AWS account
stringThe partner type
objectThe Sidewalk account credentials.
booleanWhether the partner account is linked to the AWS account.
objectThe Sidewalk account credentials.
stringThe fingerprint of the Sidewalk application server private key.
stringPartnerAccount arn. Returned after successful create.
arrayA list of key-value pairs that contain metadata for the destination.
stringAWS region.
+ +For more information, see AWS::IoTWireless::PartnerAccount. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all partner_accounts in a region. +```sql +SELECT +region, +sidewalk, +partner_account_id, +partner_type, +sidewalk_response, +account_linked, +sidewalk_update, +fingerprint, +arn, +tags +FROM aws.iotwireless.partner_accounts +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual partner_account. +```sql +SELECT +region, +sidewalk, +partner_account_id, +partner_type, +sidewalk_response, +account_linked, +sidewalk_update, +fingerprint, +arn, +tags +FROM aws.iotwireless.partner_accounts +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new partner_account resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.partner_accounts ( + Sidewalk, + PartnerAccountId, + PartnerType, + SidewalkResponse, + AccountLinked, + SidewalkUpdate, + Tags, + region +) +SELECT +'{{ Sidewalk }}', + '{{ PartnerAccountId }}', + '{{ PartnerType }}', + '{{ SidewalkResponse }}', + '{{ AccountLinked }}', + '{{ SidewalkUpdate }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.partner_accounts ( + Sidewalk, + PartnerAccountId, + PartnerType, + SidewalkResponse, + AccountLinked, + SidewalkUpdate, + Tags, + region +) +SELECT + '{{ Sidewalk }}', + '{{ PartnerAccountId }}', + '{{ PartnerType }}', + '{{ SidewalkResponse }}', + '{{ AccountLinked }}', + '{{ SidewalkUpdate }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: partner_account + props: + - name: Sidewalk + value: + AppServerPrivateKey: '{{ AppServerPrivateKey }}' + - name: PartnerAccountId + value: '{{ PartnerAccountId }}' + - name: PartnerType + value: '{{ PartnerType }}' + - name: SidewalkResponse + value: + AmazonId: '{{ AmazonId }}' + Fingerprint: '{{ Fingerprint }}' + Arn: '{{ Arn }}' + - name: AccountLinked + value: '{{ AccountLinked }}' + - name: SidewalkUpdate + value: + AppServerPrivateKey: '{{ AppServerPrivateKey }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.partner_accounts +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the partner_accounts resource, the following permissions are required: + +### Create +```json +iotwireless:AssociateAwsAccountWithPartnerAccount, +iotwireless:TagResource, +iotwireless:GetPartnerAccount +``` + +### Read +```json +iotwireless:GetPartnerAccount, +iotwireless:ListTagsForResource +``` + +### List +```json +iotwireless:ListPartnerAccounts, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:GetPartnerAccount, +iotwireless:AssociateAwsAccountWithPartnerAccount, +iotwireless:UpdatePartnerAccount, +iotwireless:ListTagsForResource, +iotwireless:TagResource, +iotwireless:UntagResource +``` + +### Delete +```json +iotwireless:DisassociateAwsAccountFromPartnerAccount +``` diff --git a/website/docs/services/iotwireless/partner_accounts_list_only/index.md b/website/docs/services/iotwireless/partner_accounts_list_only/index.md new file mode 100644 index 0000000..55adf90 --- /dev/null +++ b/website/docs/services/iotwireless/partner_accounts_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: partner_accounts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - partner_accounts_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists partner_accounts in a region or regions, for all properties use partner_accounts + +## Overview + + + + + + + +
Namepartner_accounts_list_only
TypeResource
DescriptionCreate and manage partner account
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe partner account ID to disassociate from the AWS account
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all partner_accounts in a region. +```sql +SELECT +region, +partner_account_id +FROM aws.iotwireless.partner_accounts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the partner_accounts_list_only resource, see partner_accounts + diff --git a/website/docs/services/iotwireless/service_profile_tags/index.md b/website/docs/services/iotwireless/service_profile_tags/index.md new file mode 100644 index 0000000..c101f81 --- /dev/null +++ b/website/docs/services/iotwireless/service_profile_tags/index.md @@ -0,0 +1,83 @@ +--- +title: service_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_profile_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_profiles in a region + +## Overview + + + + + + + +
Nameservice_profile_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of service profile
objectLoRaWAN supports all LoRa specific attributes for service profile for CreateServiceProfile operation
stringService profile Arn. Returned after successful create.
stringService profile Id. Returned after successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_profiles in a region. +```sql +SELECT +region, +name, +lo_ra_wan, +arn, +id, +tag_key, +tag_value +FROM aws.iotwireless.service_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_profile_tags resource, see service_profiles + diff --git a/website/docs/services/iotwireless/service_profiles/index.md b/website/docs/services/iotwireless/service_profiles/index.md new file mode 100644 index 0000000..fa48895 --- /dev/null +++ b/website/docs/services/iotwireless/service_profiles/index.md @@ -0,0 +1,240 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_profile resource or lists service_profiles in a region + +## Overview + + + + + + + +
Nameservice_profiles
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of service profile
objectLoRaWAN supports all LoRa specific attributes for service profile for CreateServiceProfile operation
arrayA list of key-value pairs that contain metadata for the service profile.
stringService profile Arn. Returned after successful create.
stringService profile Id. Returned after successful create.
stringAWS region.
+ +For more information, see AWS::IoTWireless::ServiceProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all service_profiles in a region. +```sql +SELECT +region, +name, +lo_ra_wan, +tags, +arn, +id +FROM aws.iotwireless.service_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service_profile. +```sql +SELECT +region, +name, +lo_ra_wan, +tags, +arn, +id +FROM aws.iotwireless.service_profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.service_profiles ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.service_profiles ( + Name, + LoRaWAN, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ LoRaWAN }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_profile + props: + - name: Name + value: '{{ Name }}' + - name: LoRaWAN + value: + UlRate: '{{ UlRate }}' + UlBucketSize: '{{ UlBucketSize }}' + UlRatePolicy: '{{ UlRatePolicy }}' + DlRate: '{{ DlRate }}' + DlBucketSize: '{{ DlBucketSize }}' + DlRatePolicy: '{{ DlRatePolicy }}' + AddGwMetadata: '{{ AddGwMetadata }}' + DevStatusReqFreq: '{{ DevStatusReqFreq }}' + ReportDevStatusBattery: '{{ ReportDevStatusBattery }}' + ReportDevStatusMargin: '{{ ReportDevStatusMargin }}' + DrMin: '{{ DrMin }}' + DrMax: '{{ DrMax }}' + ChannelMask: '{{ ChannelMask }}' + PrAllowed: '{{ PrAllowed }}' + HrAllowed: '{{ HrAllowed }}' + RaAllowed: '{{ RaAllowed }}' + NwkGeoLoc: '{{ NwkGeoLoc }}' + TargetPer: '{{ TargetPer }}' + MinGwDiversity: '{{ MinGwDiversity }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.service_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the service_profiles resource, the following permissions are required: + +### Create +```json +iotwireless:CreateServiceProfile, +iotwireless:TagResource +``` + +### Update +```json +iotwireless:GetServiceProfile, +iotwireless:TagResource, +iotwireless:UntagResource +``` + +### Read +```json +iotwireless:GetServiceProfile, +iotwireless:ListTagsForResource +``` + +### Delete +```json +iotwireless:DeleteServiceProfile +``` + +### List +```json +iotwireless:ListServiceProfiles, +iotwireless:ListTagsForResource +``` diff --git a/website/docs/services/iotwireless/service_profiles_list_only/index.md b/website/docs/services/iotwireless/service_profiles_list_only/index.md new file mode 100644 index 0000000..d137ed3 --- /dev/null +++ b/website/docs/services/iotwireless/service_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: service_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_profiles_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_profiles in a region or regions, for all properties use service_profiles + +## Overview + + + + + + + +
Nameservice_profiles_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringService profile Id. Returned after successful create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_profiles in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.service_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_profiles_list_only resource, see service_profiles + diff --git a/website/docs/services/iotwireless/task_definition_tags/index.md b/website/docs/services/iotwireless/task_definition_tags/index.md new file mode 100644 index 0000000..a3dfde9 --- /dev/null +++ b/website/docs/services/iotwireless/task_definition_tags/index.md @@ -0,0 +1,89 @@ +--- +title: task_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - task_definition_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for task_definitions in a region + +## Overview + + + + + + + +
Nametask_definition_tags
TypeResource
DescriptionCreates a gateway task definition.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the new resource.
booleanWhether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
objectInformation about the gateways to update.
objectThe list of task definitions.
stringThe ID of the new wireless gateway task definition
stringA filter to list only the wireless gateway task definitions that use this task definition type
stringTaskDefinition arn. Returned after successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all task_definitions in a region. +```sql +SELECT +region, +name, +auto_create_tasks, +update, +lo_ra_wan_update_gateway_task_entry, +id, +task_definition_type, +arn, +tag_key, +tag_value +FROM aws.iotwireless.task_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_definition_tags resource, see task_definitions + diff --git a/website/docs/services/iotwireless/task_definitions/index.md b/website/docs/services/iotwireless/task_definitions/index.md new file mode 100644 index 0000000..6131ffe --- /dev/null +++ b/website/docs/services/iotwireless/task_definitions/index.md @@ -0,0 +1,256 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a task_definition resource or lists task_definitions in a region + +## Overview + + + + + + + +
Nametask_definitions
TypeResource
DescriptionCreates a gateway task definition.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the new resource.
booleanWhether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
objectInformation about the gateways to update.
objectThe list of task definitions.
stringThe ID of the new wireless gateway task definition
stringA filter to list only the wireless gateway task definitions that use this task definition type
stringTaskDefinition arn. Returned after successful create.
arrayA list of key-value pairs that contain metadata for the destination.
stringAWS region.
+ +For more information, see AWS::IoTWireless::TaskDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all task_definitions in a region. +```sql +SELECT +region, +name, +auto_create_tasks, +update, +lo_ra_wan_update_gateway_task_entry, +id, +task_definition_type, +arn, +tags +FROM aws.iotwireless.task_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual task_definition. +```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_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new task_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.task_definitions ( + AutoCreateTasks, + region +) +SELECT +'{{ AutoCreateTasks }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.task_definitions ( + Name, + AutoCreateTasks, + Update, + LoRaWANUpdateGatewayTaskEntry, + TaskDefinitionType, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ AutoCreateTasks }}', + '{{ Update }}', + '{{ LoRaWANUpdateGatewayTaskEntry }}', + '{{ TaskDefinitionType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: task_definition + props: + - name: Name + value: '{{ Name }}' + - name: AutoCreateTasks + value: '{{ AutoCreateTasks }}' + - name: Update + value: + UpdateDataSource: '{{ UpdateDataSource }}' + UpdateDataRole: '{{ UpdateDataRole }}' + LoRaWAN: + UpdateSignature: '{{ UpdateSignature }}' + SigKeyCrc: '{{ SigKeyCrc }}' + CurrentVersion: + PackageVersion: '{{ PackageVersion }}' + Model: '{{ Model }}' + Station: '{{ Station }}' + UpdateVersion: null + - name: LoRaWANUpdateGatewayTaskEntry + value: + CurrentVersion: null + UpdateVersion: null + - name: TaskDefinitionType + value: '{{ TaskDefinitionType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.task_definitions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the task_definitions resource, the following permissions are required: + +### Create +```json +iotwireless:CreateWirelessGatewayTaskDefinition, +iotwireless:TagResource, +iam:GetRole, +iam:PassRole +``` + +### Update +```json +iotwireless:GetWirelessGatewayTaskDefinition, +iotwireless:TagResource, +iotwireless:UntagResource +``` + +### Read +```json +iotwireless:GetWirelessGatewayTaskDefinition, +iotwireless:ListTagsForResource +``` + +### Delete +```json +iotwireless:DeleteWirelessGatewayTaskDefinition +``` + +### List +```json +iotwireless:ListWirelessGatewayTaskDefinitions, +iotwireless:ListTagsForResource +``` diff --git a/website/docs/services/iotwireless/task_definitions_list_only/index.md b/website/docs/services/iotwireless/task_definitions_list_only/index.md new file mode 100644 index 0000000..f90e344 --- /dev/null +++ b/website/docs/services/iotwireless/task_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: task_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - task_definitions_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists task_definitions in a region or regions, for all properties use task_definitions + +## Overview + + + + + + + +
Nametask_definitions_list_only
TypeResource
DescriptionCreates a gateway task definition.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the new wireless gateway task definition
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all task_definitions in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.task_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_definitions_list_only resource, see task_definitions + diff --git a/website/docs/services/iotwireless/wireless_device_import_task_tags/index.md b/website/docs/services/iotwireless/wireless_device_import_task_tags/index.md new file mode 100644 index 0000000..cef5383 --- /dev/null +++ b/website/docs/services/iotwireless/wireless_device_import_task_tags/index.md @@ -0,0 +1,97 @@ +--- +title: wireless_device_import_task_tags +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_device_import_task_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for wireless_device_import_tasks in a region + +## Overview + + + + + + + +
Namewireless_device_import_task_tags
TypeResource
DescriptionWireless Device Import Tasks
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId for Wireless Device Import Task, Returned upon successful start.
stringArn for Wireless Device Import Task, Returned upon successful start.
stringDestination Name for import task
stringCreationDate for import task
objectsidewalk contain file for created device and role
stringStatus for import task
stringStatusReason for import task
integerInitialized Imported Devices Count
integerPending Imported Devices Count
integerOnboarded Imported Devices Count
integerFailed Imported Devices Count
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all wireless_device_import_tasks in a region. +```sql +SELECT +region, +id, +arn, +destination_name, +creation_date, +sidewalk, +status, +status_reason, +initialized_imported_devices_count, +pending_imported_devices_count, +onboarded_imported_devices_count, +failed_imported_devices_count, +tag_key, +tag_value +FROM aws.iotwireless.wireless_device_import_task_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_device_import_task_tags resource, see wireless_device_import_tasks + diff --git a/website/docs/services/iotwireless/wireless_device_import_tasks/index.md b/website/docs/services/iotwireless/wireless_device_import_tasks/index.md new file mode 100644 index 0000000..5f30c23 --- /dev/null +++ b/website/docs/services/iotwireless/wireless_device_import_tasks/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a wireless_device_import_task resource or lists wireless_device_import_tasks in a region + +## Overview + + + + + + + +
Namewireless_device_import_tasks
TypeResource
DescriptionWireless Device Import Tasks
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId for Wireless Device Import Task, Returned upon successful start.
stringArn for Wireless Device Import Task, Returned upon successful start.
stringDestination Name for import task
stringCreationDate for import task
objectsidewalk contain file for created device and role
stringStatus for import task
stringStatusReason for import task
integerInitialized Imported Devices Count
integerPending Imported Devices Count
integerOnboarded Imported Devices Count
integerFailed Imported Devices Count
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IoTWireless::WirelessDeviceImportTask. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all wireless_device_import_tasks in a region. +```sql +SELECT +region, +id, +arn, +destination_name, +creation_date, +sidewalk, +status, +status_reason, +initialized_imported_devices_count, +pending_imported_devices_count, +onboarded_imported_devices_count, +failed_imported_devices_count, +tags +FROM aws.iotwireless.wireless_device_import_tasks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual wireless_device_import_task. +```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_tasks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new wireless_device_import_task resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.wireless_device_import_tasks ( + DestinationName, + Sidewalk, + region +) +SELECT +'{{ DestinationName }}', + '{{ Sidewalk }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.wireless_device_import_tasks ( + DestinationName, + Sidewalk, + Tags, + region +) +SELECT + '{{ DestinationName }}', + '{{ Sidewalk }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: wireless_device_import_task + props: + - name: DestinationName + value: '{{ DestinationName }}' + - name: Sidewalk + value: + SidewalkManufacturingSn: '{{ SidewalkManufacturingSn }}' + DeviceCreationFile: '{{ DeviceCreationFile }}' + DeviceCreationFileList: + - '{{ DeviceCreationFileList[0] }}' + Role: '{{ Role }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.wireless_device_import_tasks +WHERE data__Identifier = '' +AND 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, +iam:PassRole +``` + +### Read +```json +iotwireless:GetWirelessDeviceImportTask, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:GetWirelessDeviceImportTask, +iotwireless:UpdateWirelessDeviceImportTask, +iotwireless:TagResource, +iotwireless:UntagResource, +iam:PassRole +``` + +### Delete +```json +iotwireless:DeleteWirelessDeviceImportTask +``` + +### List +```json +iotwireless:ListWirelessDeviceImportTasks, +iotwireless:ListTagsForResource +``` diff --git a/website/docs/services/iotwireless/wireless_device_import_tasks_list_only/index.md b/website/docs/services/iotwireless/wireless_device_import_tasks_list_only/index.md new file mode 100644 index 0000000..38214b1 --- /dev/null +++ b/website/docs/services/iotwireless/wireless_device_import_tasks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: wireless_device_import_tasks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_device_import_tasks_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists wireless_device_import_tasks in a region or regions, for all properties use wireless_device_import_tasks + +## Overview + + + + + + + +
Namewireless_device_import_tasks_list_only
TypeResource
DescriptionWireless Device Import Tasks
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId for Wireless Device Import Task, Returned upon successful start.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all wireless_device_import_tasks in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.wireless_device_import_tasks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_device_import_tasks_list_only resource, see wireless_device_import_tasks + diff --git a/website/docs/services/iotwireless/wireless_device_tags/index.md b/website/docs/services/iotwireless/wireless_device_tags/index.md new file mode 100644 index 0000000..b8ca181 --- /dev/null +++ b/website/docs/services/iotwireless/wireless_device_tags/index.md @@ -0,0 +1,97 @@ +--- +title: wireless_device_tags +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_device_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for wireless_devices in a region + +## Overview + + + + + + + +
Namewireless_device_tags
TypeResource
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringWireless device type, currently only Sidewalk and LoRa
stringWireless device name
stringWireless device description
stringWireless device destination name
objectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device.
stringWireless device arn. Returned after successful create.
stringWireless device Id. Returned after successful create.
stringThing arn. Passed into update to associate Thing with Wireless device.
stringThing Arn. If there is a Thing created, this can be returned with a Get call.
stringThe date and time when the most recent uplink was received.
stringFPort values for the GNSS, stream, and ClockSync functions of the positioning information.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all wireless_devices in a region. +```sql +SELECT +region, +type, +name, +description, +destination_name, +lo_ra_wan, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at, +positioning, +tag_key, +tag_value +FROM aws.iotwireless.wireless_device_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_device_tags resource, see wireless_devices + diff --git a/website/docs/services/iotwireless/wireless_devices/index.md b/website/docs/services/iotwireless/wireless_devices/index.md new file mode 100644 index 0000000..97107f5 --- /dev/null +++ b/website/docs/services/iotwireless/wireless_devices/index.md @@ -0,0 +1,298 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a wireless_device resource or lists wireless_devices in a region + +## Overview + + + + + + + +
Namewireless_devices
TypeResource
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringWireless device type, currently only Sidewalk and LoRa
stringWireless device name
stringWireless device description
stringWireless device destination name
objectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device.
arrayA list of key-value pairs that contain metadata for the device. Currently not supported, will not create if tags are passed.
stringWireless device arn. Returned after successful create.
stringWireless device Id. Returned after successful create.
stringThing arn. Passed into update to associate Thing with Wireless device.
stringThing Arn. If there is a Thing created, this can be returned with a Get call.
stringThe date and time when the most recent uplink was received.
stringFPort values for the GNSS, stream, and ClockSync functions of the positioning information.
stringAWS region.
+ +For more information, see AWS::IoTWireless::WirelessDevice. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all wireless_devices in a region. +```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_devices +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual wireless_device. +```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_devices +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new wireless_device resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.wireless_devices ( + Type, + DestinationName, + region +) +SELECT +'{{ Type }}', + '{{ DestinationName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.wireless_devices ( + Type, + Name, + Description, + DestinationName, + LoRaWAN, + Tags, + ThingArn, + LastUplinkReceivedAt, + Positioning, + region +) +SELECT + '{{ Type }}', + '{{ Name }}', + '{{ Description }}', + '{{ DestinationName }}', + '{{ LoRaWAN }}', + '{{ Tags }}', + '{{ ThingArn }}', + '{{ LastUplinkReceivedAt }}', + '{{ Positioning }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: wireless_device + props: + - name: Type + value: '{{ Type }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: DestinationName + value: '{{ DestinationName }}' + - name: LoRaWAN + value: + DevEui: '{{ DevEui }}' + DeviceProfileId: '{{ DeviceProfileId }}' + ServiceProfileId: '{{ ServiceProfileId }}' + OtaaV11: + AppKey: '{{ AppKey }}' + NwkKey: '{{ NwkKey }}' + JoinEui: '{{ JoinEui }}' + OtaaV10x: + AppKey: '{{ AppKey }}' + AppEui: '{{ AppEui }}' + AbpV11: + DevAddr: '{{ DevAddr }}' + SessionKeys: + FNwkSIntKey: '{{ FNwkSIntKey }}' + SNwkSIntKey: '{{ SNwkSIntKey }}' + NwkSEncKey: '{{ NwkSEncKey }}' + AppSKey: '{{ AppSKey }}' + AbpV10x: + DevAddr: '{{ DevAddr }}' + SessionKeys: + NwkSKey: '{{ NwkSKey }}' + AppSKey: '{{ AppSKey }}' + FPorts: + Applications: + - DestinationName: '{{ DestinationName }}' + FPort: '{{ FPort }}' + Type: '{{ Type }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ThingArn + value: '{{ ThingArn }}' + - name: LastUplinkReceivedAt + value: '{{ LastUplinkReceivedAt }}' + - name: Positioning + value: '{{ Positioning }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.wireless_devices +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the wireless_devices resource, the following permissions are required: + +### Create +```json +iotwireless:CreateWirelessDevice, +iotwireless:TagResource +``` + +### Read +```json +iotwireless:GetWirelessDevice, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:UpdateWirelessDevice, +iotwireless:GetWirelessDevice, +iotwireless:AssociateWirelessDeviceWithThing, +iotwireless:TagResource, +iotwireless:UntagResource +``` + +### Delete +```json +iotwireless:DeleteWirelessDevice, +iotwireless:DisassociateWirelessDeviceFromThing +``` + +### List +```json +iotwireless:ListWirelessDevices, +iotwireless:ListTagsForResource +``` diff --git a/website/docs/services/iotwireless/wireless_devices_list_only/index.md b/website/docs/services/iotwireless/wireless_devices_list_only/index.md new file mode 100644 index 0000000..e1ab2be --- /dev/null +++ b/website/docs/services/iotwireless/wireless_devices_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: wireless_devices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_devices_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists wireless_devices in a region or regions, for all properties use wireless_devices + +## Overview + + + + + + + +
Namewireless_devices_list_only
TypeResource
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringWireless device Id. Returned after successful create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all wireless_devices in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.wireless_devices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_devices_list_only resource, see wireless_devices + diff --git a/website/docs/services/iotwireless/wireless_gateway_tags/index.md b/website/docs/services/iotwireless/wireless_gateway_tags/index.md new file mode 100644 index 0000000..59f9a55 --- /dev/null +++ b/website/docs/services/iotwireless/wireless_gateway_tags/index.md @@ -0,0 +1,91 @@ +--- +title: wireless_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_gateway_tags + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for wireless_gateways in a region + +## Overview + + + + + + + +
Namewireless_gateway_tags
TypeResource
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of Wireless Gateway.
stringDescription of Wireless Gateway.
objectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway.
stringArn for Wireless Gateway. Returned upon successful create.
stringId for Wireless Gateway. Returned upon successful create.
stringThing Arn. Passed into Update to associate a Thing with the Wireless Gateway.
stringThing Name. If there is a Thing created, this can be returned with a Get call.
stringThe date and time when the most recent uplink was received.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all wireless_gateways in a region. +```sql +SELECT +region, +name, +description, +lo_ra_wan, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at, +tag_key, +tag_value +FROM aws.iotwireless.wireless_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_gateway_tags resource, see wireless_gateways + diff --git a/website/docs/services/iotwireless/wireless_gateways/index.md b/website/docs/services/iotwireless/wireless_gateways/index.md new file mode 100644 index 0000000..acdab2d --- /dev/null +++ b/website/docs/services/iotwireless/wireless_gateways/index.md @@ -0,0 +1,254 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a wireless_gateway resource or lists wireless_gateways in a region + +## Overview + + + + + + + +
Namewireless_gateways
TypeResource
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of Wireless Gateway.
stringDescription of Wireless Gateway.
arrayA list of key-value pairs that contain metadata for the gateway.
objectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway.
stringArn for Wireless Gateway. Returned upon successful create.
stringId for Wireless Gateway. Returned upon successful create.
stringThing Arn. Passed into Update to associate a Thing with the Wireless Gateway.
stringThing Name. If there is a Thing created, this can be returned with a Get call.
stringThe date and time when the most recent uplink was received.
stringAWS region.
+ +For more information, see AWS::IoTWireless::WirelessGateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all wireless_gateways in a region. +```sql +SELECT +region, +name, +description, +tags, +lo_ra_wan, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at +FROM aws.iotwireless.wireless_gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual wireless_gateway. +```sql +SELECT +region, +name, +description, +tags, +lo_ra_wan, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at +FROM aws.iotwireless.wireless_gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new wireless_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.wireless_gateways ( + LoRaWAN, + region +) +SELECT +'{{ LoRaWAN }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.iotwireless.wireless_gateways ( + Name, + Description, + Tags, + LoRaWAN, + ThingArn, + ThingName, + LastUplinkReceivedAt, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Tags }}', + '{{ LoRaWAN }}', + '{{ ThingArn }}', + '{{ ThingName }}', + '{{ LastUplinkReceivedAt }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: wireless_gateway + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: LoRaWAN + value: + GatewayEui: '{{ GatewayEui }}' + RfRegion: '{{ RfRegion }}' + - name: ThingArn + value: '{{ ThingArn }}' + - name: ThingName + value: '{{ ThingName }}' + - name: LastUplinkReceivedAt + value: '{{ LastUplinkReceivedAt }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.iotwireless.wireless_gateways +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the wireless_gateways resource, the following permissions are required: + +### Create +```json +iotwireless:CreateWirelessGateway, +iotwireless:TagResource +``` + +### Read +```json +iotwireless:GetWirelessGateway, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:GetWirelessGateway, +iotwireless:UpdateWirelessGateway, +iotwireless:AssociateWirelessGatewayWithThing, +iotwireless:TagResource, +iotwireless:UntagResource +``` + +### Delete +```json +iotwireless:DeleteWirelessGateway, +iotwireless:DisassociateWirelessGatewayFromThing +``` + +### List +```json +iotwireless:ListWirelessGateways, +iotwireless:ListTagsForResource +``` diff --git a/website/docs/services/iotwireless/wireless_gateways_list_only/index.md b/website/docs/services/iotwireless/wireless_gateways_list_only/index.md new file mode 100644 index 0000000..bfd1210 --- /dev/null +++ b/website/docs/services/iotwireless/wireless_gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: wireless_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_gateways_list_only + - iotwireless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists wireless_gateways in a region or regions, for all properties use wireless_gateways + +## Overview + + + + + + + +
Namewireless_gateways_list_only
TypeResource
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId for Wireless Gateway. Returned upon successful create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all wireless_gateways in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.wireless_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_gateways_list_only resource, see wireless_gateways + diff --git a/website/docs/services/ivs/channel_tags/index.md b/website/docs/services/ivs/channel_tags/index.md new file mode 100644 index 0000000..00831d0 --- /dev/null +++ b/website/docs/services/ivs/channel_tags/index.md @@ -0,0 +1,95 @@ +--- +title: channel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_tags + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channels in a region + +## Overview + + + + + + + +
Namechannel_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::Channel
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringChannel ARN is automatically generated on creation and assigned as the unique identifier.
stringChannel
booleanWhether the channel is authorized.
booleanWhether the channel allows insecure ingest.
stringChannel latency mode.
stringChannel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
stringChannel Playback URL.
stringChannel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
stringRecording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
stringOptional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channels in a region. +```sql +SELECT +region, +arn, +name, +authorized, +insecure_ingest, +latency_mode, +type, +playback_url, +ingest_endpoint, +recording_configuration_arn, +preset, +tag_key, +tag_value +FROM aws.ivs.channel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_tags resource, see channels + diff --git a/website/docs/services/ivs/channels/index.md b/website/docs/services/ivs/channels/index.md new file mode 100644 index 0000000..e2721cd --- /dev/null +++ b/website/docs/services/ivs/channels/index.md @@ -0,0 +1,262 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a channel resource or lists channels in a region + +## Overview + + + + + + + +
Namechannels
TypeResource
DescriptionResource Type definition for AWS::IVS::Channel
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringChannel ARN is automatically generated on creation and assigned as the unique identifier.
stringChannel
booleanWhether the channel is authorized.
booleanWhether the channel allows insecure ingest.
stringChannel latency mode.
stringChannel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
arrayA list of key-value pairs that contain metadata for the asset model.
stringChannel Playback URL.
stringChannel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
stringRecording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
stringOptional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
stringAWS region.
+ +For more information, see AWS::IVS::Channel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all channels in a region. +```sql +SELECT +region, +arn, +name, +authorized, +insecure_ingest, +latency_mode, +type, +tags, +playback_url, +ingest_endpoint, +recording_configuration_arn, +preset +FROM aws.ivs.channels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual channel. +```sql +SELECT +region, +arn, +name, +authorized, +insecure_ingest, +latency_mode, +type, +tags, +playback_url, +ingest_endpoint, +recording_configuration_arn, +preset +FROM aws.ivs.channels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.channels ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.channels ( + Name, + Authorized, + InsecureIngest, + LatencyMode, + Type, + Tags, + RecordingConfigurationArn, + Preset, + region +) +SELECT + '{{ Name }}', + '{{ Authorized }}', + '{{ InsecureIngest }}', + '{{ LatencyMode }}', + '{{ Type }}', + '{{ Tags }}', + '{{ RecordingConfigurationArn }}', + '{{ Preset }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: channel + props: + - name: Name + value: '{{ Name }}' + - name: Authorized + value: '{{ Authorized }}' + - name: InsecureIngest + value: '{{ InsecureIngest }}' + - name: LatencyMode + value: '{{ LatencyMode }}' + - name: Type + value: '{{ Type }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: RecordingConfigurationArn + value: '{{ RecordingConfigurationArn }}' + - name: Preset + value: '{{ Preset }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivs.channels +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +```json +ivs:CreateChannel, +ivs:TagResource +``` + +### Read +```json +ivs:GetChannel, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetChannel, +ivs:UpdateChannel, +ivs:TagResource, +ivs:UntagResource, +ivs:ListTagsForResource +``` + +### Delete +```json +ivs:DeleteChannel, +ivs:UntagResource +``` + +### List +```json +ivs:ListChannels, +ivs:ListTagsForResource +``` diff --git a/website/docs/services/ivs/channels_list_only/index.md b/website/docs/services/ivs/channels_list_only/index.md new file mode 100644 index 0000000..19603e1 --- /dev/null +++ b/website/docs/services/ivs/channels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channels_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channels in a region or regions, for all properties use channels + +## Overview + + + + + + + +
Namechannels_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::Channel
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringChannel ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channels in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channels_list_only resource, see channels + diff --git a/website/docs/services/ivs/encoder_configuration_tags/index.md b/website/docs/services/ivs/encoder_configuration_tags/index.md new file mode 100644 index 0000000..d52db98 --- /dev/null +++ b/website/docs/services/ivs/encoder_configuration_tags/index.md @@ -0,0 +1,81 @@ +--- +title: encoder_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - encoder_configuration_tags + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for encoder_configurations in a region + +## Overview + + + + + + + +
Nameencoder_configuration_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::EncoderConfiguration.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringEncoder configuration identifier.
objectVideo configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
stringEncoder configuration name.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all encoder_configurations in a region. +```sql +SELECT +region, +arn, +video, +name, +tag_key, +tag_value +FROM aws.ivs.encoder_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the encoder_configuration_tags resource, see encoder_configurations + diff --git a/website/docs/services/ivs/encoder_configurations/index.md b/website/docs/services/ivs/encoder_configurations/index.md new file mode 100644 index 0000000..ac1c0d0 --- /dev/null +++ b/website/docs/services/ivs/encoder_configurations/index.md @@ -0,0 +1,224 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an encoder_configuration resource or lists encoder_configurations in a region + +## Overview + + + + + + + +
Nameencoder_configurations
TypeResource
DescriptionResource Type definition for AWS::IVS::EncoderConfiguration.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringEncoder configuration identifier.
objectVideo configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
stringEncoder configuration name.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IVS::EncoderConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all encoder_configurations in a region. +```sql +SELECT +region, +arn, +video, +name, +tags +FROM aws.ivs.encoder_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual encoder_configuration. +```sql +SELECT +region, +arn, +video, +name, +tags +FROM aws.ivs.encoder_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new encoder_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.encoder_configurations ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.encoder_configurations ( + Video, + Name, + Tags, + region +) +SELECT + '{{ Video }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: encoder_configuration + props: + - name: Video + value: + Bitrate: '{{ Bitrate }}' + Framerate: null + Height: '{{ Height }}' + Width: '{{ Width }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivs.encoder_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the encoder_configurations resource, the following permissions are required: + +### Create +```json +ivs:CreateEncoderConfiguration, +ivs:TagResource +``` + +### Read +```json +ivs:GetEncoderConfiguration, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetEncoderConfiguration, +ivs:ListTagsForResource, +ivs:UntagResource, +ivs:TagResource +``` + +### Delete +```json +ivs:DeleteEncoderConfiguration, +ivs:UntagResource +``` + +### List +```json +ivs:ListEncoderConfigurations, +ivs:ListTagsForResource +``` diff --git a/website/docs/services/ivs/encoder_configurations_list_only/index.md b/website/docs/services/ivs/encoder_configurations_list_only/index.md new file mode 100644 index 0000000..2a03dde --- /dev/null +++ b/website/docs/services/ivs/encoder_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: encoder_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - encoder_configurations_list_only + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists encoder_configurations in a region or regions, for all properties use encoder_configurations + +## Overview + + + + + + + +
Nameencoder_configurations_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::EncoderConfiguration.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringEncoder configuration identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all encoder_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.encoder_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the encoder_configurations_list_only resource, see encoder_configurations + diff --git a/website/docs/services/ivs/index.md b/website/docs/services/ivs/index.md new file mode 100644 index 0000000..ac902c4 --- /dev/null +++ b/website/docs/services/ivs/index.md @@ -0,0 +1,65 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The ivs service documentation. + +:::info Service Summary + +
+
+total resources: 30
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/ivs/ingest_configuration_tags/index.md b/website/docs/services/ivs/ingest_configuration_tags/index.md new file mode 100644 index 0000000..57b70d5 --- /dev/null +++ b/website/docs/services/ivs/ingest_configuration_tags/index.md @@ -0,0 +1,93 @@ +--- +title: ingest_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ingest_configuration_tags + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ingest_configurations in a region + +## Overview + + + + + + + +
Nameingest_configuration_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::IngestConfiguration
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
stringIngestConfiguration
stringStage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
stringParticipant Id is automatically generated on creation and assigned.
stringIngest Protocol.
booleanWhether ingest configuration allows insecure ingest.
stringState of IngestConfiguration which determines whether IngestConfiguration is in use or not.
stringStream-key value.
stringUser defined indentifier for participant associated with IngestConfiguration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ingest_configurations in a region. +```sql +SELECT +region, +arn, +name, +stage_arn, +participant_id, +ingest_protocol, +insecure_ingest, +state, +stream_key, +user_id, +tag_key, +tag_value +FROM aws.ivs.ingest_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ingest_configuration_tags resource, see ingest_configurations + diff --git a/website/docs/services/ivs/ingest_configurations/index.md b/website/docs/services/ivs/ingest_configurations/index.md new file mode 100644 index 0000000..d5028cc --- /dev/null +++ b/website/docs/services/ivs/ingest_configurations/index.md @@ -0,0 +1,251 @@ +--- +title: ingest_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - ingest_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ingest_configuration resource or lists ingest_configurations in a region + +## Overview + + + + + + + +
Nameingest_configurations
TypeResource
DescriptionResource Type definition for AWS::IVS::IngestConfiguration
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
stringIngestConfiguration
stringStage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
stringParticipant Id is automatically generated on creation and assigned.
stringIngest Protocol.
booleanWhether ingest configuration allows insecure ingest.
stringState of IngestConfiguration which determines whether IngestConfiguration is in use or not.
stringStream-key value.
stringUser defined indentifier for participant associated with IngestConfiguration.
arrayA list of key-value pairs that contain metadata for the asset model.
stringAWS region.
+ +For more information, see AWS::IVS::IngestConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ingest_configurations in a region. +```sql +SELECT +region, +arn, +name, +stage_arn, +participant_id, +ingest_protocol, +insecure_ingest, +state, +stream_key, +user_id, +tags +FROM aws.ivs.ingest_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ingest_configuration. +```sql +SELECT +region, +arn, +name, +stage_arn, +participant_id, +ingest_protocol, +insecure_ingest, +state, +stream_key, +user_id, +tags +FROM aws.ivs.ingest_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ingest_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.ingest_configurations ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.ingest_configurations ( + Name, + StageArn, + IngestProtocol, + InsecureIngest, + UserId, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ StageArn }}', + '{{ IngestProtocol }}', + '{{ InsecureIngest }}', + '{{ UserId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ingest_configuration + props: + - name: Name + value: '{{ Name }}' + - name: StageArn + value: '{{ StageArn }}' + - name: IngestProtocol + value: '{{ IngestProtocol }}' + - name: InsecureIngest + value: '{{ InsecureIngest }}' + - name: UserId + value: '{{ UserId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivs.ingest_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ingest_configurations resource, the following permissions are required: + +### Create +```json +ivs:CreateIngestConfiguration, +ivs:TagResource +``` + +### Read +```json +ivs:GetIngestConfiguration, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetIngestConfiguration, +ivs:UpdateIngestConfiguration, +ivs:TagResource, +ivs:UntagResource, +ivs:ListTagsForResource +``` + +### Delete +```json +ivs:DeleteIngestConfiguration, +ivs:UntagResource +``` + +### List +```json +ivs:ListIngestConfigurations, +ivs:ListTagsForResource +``` diff --git a/website/docs/services/ivs/ingest_configurations_list_only/index.md b/website/docs/services/ivs/ingest_configurations_list_only/index.md new file mode 100644 index 0000000..c4dfd16 --- /dev/null +++ b/website/docs/services/ivs/ingest_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: ingest_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ingest_configurations_list_only + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ingest_configurations in a region or regions, for all properties use ingest_configurations + +## Overview + + + + + + + +
Nameingest_configurations_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::IngestConfiguration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringIngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ingest_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.ingest_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ingest_configurations_list_only resource, see ingest_configurations + diff --git a/website/docs/services/ivs/playback_key_pair_tags/index.md b/website/docs/services/ivs/playback_key_pair_tags/index.md new file mode 100644 index 0000000..1abc9ed --- /dev/null +++ b/website/docs/services/ivs/playback_key_pair_tags/index.md @@ -0,0 +1,83 @@ +--- +title: playback_key_pair_tags +hide_title: false +hide_table_of_contents: false +keywords: + - playback_key_pair_tags + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for playback_key_pairs in a region + +## Overview + + + + + + + +
Nameplayback_key_pair_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackKeyPair
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringAn arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
stringThe public portion of a customer-generated key pair.
stringKey-pair identifier.
stringKey-pair identifier.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all playback_key_pairs in a region. +```sql +SELECT +region, +name, +public_key_material, +fingerprint, +arn, +tag_key, +tag_value +FROM aws.ivs.playback_key_pair_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_key_pair_tags resource, see playback_key_pairs + diff --git a/website/docs/services/ivs/playback_key_pairs/index.md b/website/docs/services/ivs/playback_key_pairs/index.md new file mode 100644 index 0000000..99d78c7 --- /dev/null +++ b/website/docs/services/ivs/playback_key_pairs/index.md @@ -0,0 +1,226 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a playback_key_pair resource or lists playback_key_pairs in a region + +## Overview + + + + + + + +
Nameplayback_key_pairs
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackKeyPair
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringAn arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
stringThe public portion of a customer-generated key pair.
stringKey-pair identifier.
stringKey-pair identifier.
arrayA list of key-value pairs that contain metadata for the asset model.
stringAWS region.
+ +For more information, see AWS::IVS::PlaybackKeyPair. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all playback_key_pairs in a region. +```sql +SELECT +region, +name, +public_key_material, +fingerprint, +arn, +tags +FROM aws.ivs.playback_key_pairs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual playback_key_pair. +```sql +SELECT +region, +name, +public_key_material, +fingerprint, +arn, +tags +FROM aws.ivs.playback_key_pairs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new playback_key_pair resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.playback_key_pairs ( + Name, + PublicKeyMaterial, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ PublicKeyMaterial }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.playback_key_pairs ( + Name, + PublicKeyMaterial, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ PublicKeyMaterial }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: playback_key_pair + props: + - name: Name + value: '{{ Name }}' + - name: PublicKeyMaterial + value: '{{ PublicKeyMaterial }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivs.playback_key_pairs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the playback_key_pairs resource, the following permissions are required: + +### Create +```json +ivs:ImportPlaybackKeyPair, +ivs:TagResource +``` + +### Read +```json +ivs:GetPlaybackKeyPair +``` + +### Update +```json +ivs:GetPlaybackKeyPair, +ivs:ListTagsForResource, +ivs:UntagResource, +ivs:TagResource +``` + +### Delete +```json +ivs:DeletePlaybackKeyPair, +ivs:UntagResource +``` + +### List +```json +ivs:ListPlaybackKeyPairs, +ivs:ListTagsForResource +``` diff --git a/website/docs/services/ivs/playback_key_pairs_list_only/index.md b/website/docs/services/ivs/playback_key_pairs_list_only/index.md new file mode 100644 index 0000000..5faeeec --- /dev/null +++ b/website/docs/services/ivs/playback_key_pairs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: playback_key_pairs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - playback_key_pairs_list_only + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists playback_key_pairs in a region or regions, for all properties use playback_key_pairs + +## Overview + + + + + + + +
Nameplayback_key_pairs_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackKeyPair
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringKey-pair identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all playback_key_pairs in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.playback_key_pairs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_key_pairs_list_only resource, see playback_key_pairs + diff --git a/website/docs/services/ivs/playback_restriction_policies/index.md b/website/docs/services/ivs/playback_restriction_policies/index.md new file mode 100644 index 0000000..6204850 --- /dev/null +++ b/website/docs/services/ivs/playback_restriction_policies/index.md @@ -0,0 +1,239 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a playback_restriction_policy resource or lists playback_restriction_policies in a region + +## Overview + + + + + + + +
Nameplayback_restriction_policies
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackRestrictionPolicy.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringPlayback-restriction-policy identifier.
arrayA list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
arrayA list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
booleanWhether channel playback is constrained by origin site.
stringPlayback-restriction-policy name.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IVS::PlaybackRestrictionPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all playback_restriction_policies in a region. +```sql +SELECT +region, +arn, +allowed_countries, +allowed_origins, +enable_strict_origin_enforcement, +name, +tags +FROM aws.ivs.playback_restriction_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual playback_restriction_policy. +```sql +SELECT +region, +arn, +allowed_countries, +allowed_origins, +enable_strict_origin_enforcement, +name, +tags +FROM aws.ivs.playback_restriction_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new playback_restriction_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.playback_restriction_policies ( + AllowedCountries, + AllowedOrigins, + region +) +SELECT +'{{ AllowedCountries }}', + '{{ AllowedOrigins }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.playback_restriction_policies ( + AllowedCountries, + AllowedOrigins, + EnableStrictOriginEnforcement, + Name, + Tags, + region +) +SELECT + '{{ AllowedCountries }}', + '{{ AllowedOrigins }}', + '{{ EnableStrictOriginEnforcement }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: playback_restriction_policy + props: + - name: AllowedCountries + value: + - '{{ AllowedCountries[0] }}' + - name: AllowedOrigins + value: + - '{{ AllowedOrigins[0] }}' + - name: EnableStrictOriginEnforcement + value: '{{ EnableStrictOriginEnforcement }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivs.playback_restriction_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the playback_restriction_policies resource, the following permissions are required: + +### Create +```json +ivs:CreatePlaybackRestrictionPolicy, +ivs:TagResource +``` + +### Read +```json +ivs:GetPlaybackRestrictionPolicy, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetPlaybackRestrictionPolicy, +ivs:UpdatePlaybackRestrictionPolicy, +ivs:ListTagsForResource, +ivs:UntagResource, +ivs:TagResource +``` + +### Delete +```json +ivs:DeletePlaybackRestrictionPolicy, +ivs:UntagResource +``` + +### List +```json +ivs:ListPlaybackRestrictionPolicies, +ivs:ListTagsForResource +``` diff --git a/website/docs/services/ivs/playback_restriction_policies_list_only/index.md b/website/docs/services/ivs/playback_restriction_policies_list_only/index.md new file mode 100644 index 0000000..97ba00f --- /dev/null +++ b/website/docs/services/ivs/playback_restriction_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: playback_restriction_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - playback_restriction_policies_list_only + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists playback_restriction_policies in a region or regions, for all properties use playback_restriction_policies + +## Overview + + + + + + + +
Nameplayback_restriction_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackRestrictionPolicy.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringPlayback-restriction-policy identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all playback_restriction_policies in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.playback_restriction_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_restriction_policies_list_only resource, see playback_restriction_policies + diff --git a/website/docs/services/ivs/playback_restriction_policy_tags/index.md b/website/docs/services/ivs/playback_restriction_policy_tags/index.md new file mode 100644 index 0000000..444627f --- /dev/null +++ b/website/docs/services/ivs/playback_restriction_policy_tags/index.md @@ -0,0 +1,85 @@ +--- +title: playback_restriction_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - playback_restriction_policy_tags + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for playback_restriction_policies in a region + +## Overview + + + + + + + +
Nameplayback_restriction_policy_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackRestrictionPolicy.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringPlayback-restriction-policy identifier.
arrayA list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
arrayA list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
booleanWhether channel playback is constrained by origin site.
stringPlayback-restriction-policy name.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all playback_restriction_policies in a region. +```sql +SELECT +region, +arn, +allowed_countries, +allowed_origins, +enable_strict_origin_enforcement, +name, +tag_key, +tag_value +FROM aws.ivs.playback_restriction_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_restriction_policy_tags resource, see playback_restriction_policies + diff --git a/website/docs/services/ivs/public_key_tags/index.md b/website/docs/services/ivs/public_key_tags/index.md new file mode 100644 index 0000000..77bd8c2 --- /dev/null +++ b/website/docs/services/ivs/public_key_tags/index.md @@ -0,0 +1,83 @@ +--- +title: public_key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - public_key_tags + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for public_keys in a region + +## Overview + + + + + + + +
Namepublic_key_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::PublicKey
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of the public key to be imported. The value does not need to be unique.
stringThe public portion of a customer-generated key pair.
stringKey-pair identifier.
stringKey-pair identifier.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all public_keys in a region. +```sql +SELECT +region, +name, +public_key_material, +fingerprint, +arn, +tag_key, +tag_value +FROM aws.ivs.public_key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the public_key_tags resource, see public_keys + diff --git a/website/docs/services/ivs/public_keys/index.md b/website/docs/services/ivs/public_keys/index.md new file mode 100644 index 0000000..4c47ac5 --- /dev/null +++ b/website/docs/services/ivs/public_keys/index.md @@ -0,0 +1,226 @@ +--- +title: public_keys +hide_title: false +hide_table_of_contents: false +keywords: + - public_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a public_key resource or lists public_keys in a region + +## Overview + + + + + + + +
Namepublic_keys
TypeResource
DescriptionResource Type definition for AWS::IVS::PublicKey
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of the public key to be imported. The value does not need to be unique.
stringThe public portion of a customer-generated key pair.
stringKey-pair identifier.
stringKey-pair identifier.
arrayA list of key-value pairs that contain metadata for the asset model.
stringAWS region.
+ +For more information, see AWS::IVS::PublicKey. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all public_keys in a region. +```sql +SELECT +region, +name, +public_key_material, +fingerprint, +arn, +tags +FROM aws.ivs.public_keys +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual public_key. +```sql +SELECT +region, +name, +public_key_material, +fingerprint, +arn, +tags +FROM aws.ivs.public_keys +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new public_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.public_keys ( + Name, + PublicKeyMaterial, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ PublicKeyMaterial }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.public_keys ( + Name, + PublicKeyMaterial, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ PublicKeyMaterial }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: public_key + props: + - name: Name + value: '{{ Name }}' + - name: PublicKeyMaterial + value: '{{ PublicKeyMaterial }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivs.public_keys +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the public_keys resource, the following permissions are required: + +### Create +```json +ivs:ImportPublicKey, +ivs:TagResource +``` + +### Read +```json +ivs:GetPublicKey +``` + +### Update +```json +ivs:GetPublicKey, +ivs:ListTagsForResource, +ivs:UntagResource, +ivs:TagResource +``` + +### Delete +```json +ivs:DeletePublicKey, +ivs:UntagResource +``` + +### List +```json +ivs:ListPublicKeys, +ivs:ListTagsForResource +``` diff --git a/website/docs/services/ivs/public_keys_list_only/index.md b/website/docs/services/ivs/public_keys_list_only/index.md new file mode 100644 index 0000000..7d5b217 --- /dev/null +++ b/website/docs/services/ivs/public_keys_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: public_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - public_keys_list_only + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists public_keys in a region or regions, for all properties use public_keys + +## Overview + + + + + + + +
Namepublic_keys_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::PublicKey
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringKey-pair identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all public_keys in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.public_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the public_keys_list_only resource, see public_keys + diff --git a/website/docs/services/ivs/recording_configuration_tags/index.md b/website/docs/services/ivs/recording_configuration_tags/index.md new file mode 100644 index 0000000..b476017 --- /dev/null +++ b/website/docs/services/ivs/recording_configuration_tags/index.md @@ -0,0 +1,89 @@ +--- +title: recording_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - recording_configuration_tags + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for recording_configurations in a region + +## Overview + + + + + + + +
Namerecording_configuration_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::RecordingConfiguration
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringRecording Configuration Name.
stringRecording Configuration State.
integerRecording Reconnect Window Seconds. (0 means disabled)
objectRecording Destination Configuration.
objectRecording Thumbnail Configuration.
objectRendition Configuration describes which renditions should be recorded for a stream.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all recording_configurations in a region. +```sql +SELECT +region, +arn, +name, +state, +recording_reconnect_window_seconds, +destination_configuration, +thumbnail_configuration, +rendition_configuration, +tag_key, +tag_value +FROM aws.ivs.recording_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recording_configuration_tags resource, see recording_configurations + diff --git a/website/docs/services/ivs/recording_configurations/index.md b/website/docs/services/ivs/recording_configurations/index.md new file mode 100644 index 0000000..afc3def --- /dev/null +++ b/website/docs/services/ivs/recording_configurations/index.md @@ -0,0 +1,269 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a recording_configuration resource or lists recording_configurations in a region + +## Overview + + + + + + + +
Namerecording_configurations
TypeResource
DescriptionResource Type definition for AWS::IVS::RecordingConfiguration
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringRecording Configuration Name.
stringRecording Configuration State.
integerRecording Reconnect Window Seconds. (0 means disabled)
objectRecording Destination Configuration.
arrayA list of key-value pairs that contain metadata for the asset model.
objectRecording Thumbnail Configuration.
objectRendition Configuration describes which renditions should be recorded for a stream.
stringAWS region.
+ +For more information, see AWS::IVS::RecordingConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all recording_configurations in a region. +```sql +SELECT +region, +arn, +name, +state, +recording_reconnect_window_seconds, +destination_configuration, +tags, +thumbnail_configuration, +rendition_configuration +FROM aws.ivs.recording_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual recording_configuration. +```sql +SELECT +region, +arn, +name, +state, +recording_reconnect_window_seconds, +destination_configuration, +tags, +thumbnail_configuration, +rendition_configuration +FROM aws.ivs.recording_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new recording_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.recording_configurations ( + DestinationConfiguration, + region +) +SELECT +'{{ DestinationConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.recording_configurations ( + Name, + RecordingReconnectWindowSeconds, + DestinationConfiguration, + Tags, + ThumbnailConfiguration, + RenditionConfiguration, + region +) +SELECT + '{{ Name }}', + '{{ RecordingReconnectWindowSeconds }}', + '{{ DestinationConfiguration }}', + '{{ Tags }}', + '{{ ThumbnailConfiguration }}', + '{{ RenditionConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: recording_configuration + props: + - name: Name + value: '{{ Name }}' + - name: RecordingReconnectWindowSeconds + value: '{{ RecordingReconnectWindowSeconds }}' + - name: DestinationConfiguration + value: + S3: + BucketName: '{{ BucketName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ThumbnailConfiguration + value: + RecordingMode: '{{ RecordingMode }}' + TargetIntervalSeconds: '{{ TargetIntervalSeconds }}' + Resolution: '{{ Resolution }}' + Storage: + - '{{ Storage[0] }}' + - name: RenditionConfiguration + value: + RenditionSelection: '{{ RenditionSelection }}' + Renditions: + - '{{ Renditions[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivs.recording_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ivs:ListRecordingConfigurations, +s3:GetBucketLocation, +ivs:ListTagsForResource +``` diff --git a/website/docs/services/ivs/recording_configurations_list_only/index.md b/website/docs/services/ivs/recording_configurations_list_only/index.md new file mode 100644 index 0000000..41c29bc --- /dev/null +++ b/website/docs/services/ivs/recording_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: recording_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - recording_configurations_list_only + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists recording_configurations in a region or regions, for all properties use recording_configurations + +## Overview + + + + + + + +
Namerecording_configurations_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::RecordingConfiguration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all recording_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.recording_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recording_configurations_list_only resource, see recording_configurations + diff --git a/website/docs/services/ivs/stage_tags/index.md b/website/docs/services/ivs/stage_tags/index.md new file mode 100644 index 0000000..1b0365b --- /dev/null +++ b/website/docs/services/ivs/stage_tags/index.md @@ -0,0 +1,83 @@ +--- +title: stage_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stage_tags + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stages in a region + +## Overview + + + + + + + +
Namestage_tags
TypeResource
DescriptionResource Definition for type AWS::IVS::Stage.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringStage ARN is automatically generated on creation and assigned as the unique identifier.
stringStage name
objectConfiguration object for individual participant recording, to attach to the new stage.
stringID of the active session within the stage.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stages in a region. +```sql +SELECT +region, +arn, +name, +auto_participant_recording_configuration, +active_session_id, +tag_key, +tag_value +FROM aws.ivs.stage_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stage_tags resource, see stages + diff --git a/website/docs/services/ivs/stages/index.md b/website/docs/services/ivs/stages/index.md new file mode 100644 index 0000000..f88f920 --- /dev/null +++ b/website/docs/services/ivs/stages/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a stage resource or lists stages in a region + +## Overview + + + + + + + +
Namestages
TypeResource
DescriptionResource Definition for type AWS::IVS::Stage.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringStage ARN is automatically generated on creation and assigned as the unique identifier.
stringStage name
objectConfiguration object for individual participant recording, to attach to the new stage.
arrayAn array of key-value pairs to apply to this resource.
stringID of the active session within the stage.
stringAWS region.
+ +For more information, see AWS::IVS::Stage. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all stages in a region. +```sql +SELECT +region, +arn, +name, +auto_participant_recording_configuration, +tags, +active_session_id +FROM aws.ivs.stages +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual stage. +```sql +SELECT +region, +arn, +name, +auto_participant_recording_configuration, +tags, +active_session_id +FROM aws.ivs.stages +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stage resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.stages ( + Name, + AutoParticipantRecordingConfiguration, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ AutoParticipantRecordingConfiguration }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.stages ( + Name, + AutoParticipantRecordingConfiguration, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ AutoParticipantRecordingConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: stage + props: + - name: Name + value: '{{ Name }}' + - name: AutoParticipantRecordingConfiguration + value: + StorageConfigurationArn: '{{ StorageConfigurationArn }}' + MediaTypes: + - '{{ MediaTypes[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivs.stages +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ivs:GetStage, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetStage, +ivs:UpdateStage, +ivs:TagResource, +ivs:UntagResource, +ivs:ListTagsForResource +``` + +### Delete +```json +ivs:DeleteStage, +ivs:UntagResource +``` + +### List +```json +ivs:ListStages, +ivs:ListTagsForResource +``` diff --git a/website/docs/services/ivs/stages_list_only/index.md b/website/docs/services/ivs/stages_list_only/index.md new file mode 100644 index 0000000..a53027e --- /dev/null +++ b/website/docs/services/ivs/stages_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: stages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stages_list_only + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stages in a region or regions, for all properties use stages + +## Overview + + + + + + + +
Namestages_list_only
TypeResource
DescriptionResource Definition for type AWS::IVS::Stage.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringStage ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stages in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.stages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stages_list_only resource, see stages + diff --git a/website/docs/services/ivs/storage_configuration_tags/index.md b/website/docs/services/ivs/storage_configuration_tags/index.md new file mode 100644 index 0000000..6b43b2a --- /dev/null +++ b/website/docs/services/ivs/storage_configuration_tags/index.md @@ -0,0 +1,81 @@ +--- +title: storage_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - storage_configuration_tags + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for storage_configurations in a region + +## Overview + + + + + + + +
Namestorage_configuration_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::StorageConfiguration
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringStorage Configuration Name.
objectA complex type that describes an S3 location where recorded videos will be stored.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all storage_configurations in a region. +```sql +SELECT +region, +arn, +name, +s3, +tag_key, +tag_value +FROM aws.ivs.storage_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_configuration_tags resource, see storage_configurations + diff --git a/website/docs/services/ivs/storage_configurations/index.md b/website/docs/services/ivs/storage_configurations/index.md new file mode 100644 index 0000000..d12ab80 --- /dev/null +++ b/website/docs/services/ivs/storage_configurations/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a storage_configuration resource or lists storage_configurations in a region + +## Overview + + + + + + + +
Namestorage_configurations
TypeResource
DescriptionResource Type definition for AWS::IVS::StorageConfiguration
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringStorage Configuration Name.
objectA complex type that describes an S3 location where recorded videos will be stored.
arrayA list of key-value pairs that contain metadata for the asset model.
stringAWS region.
+ +For more information, see AWS::IVS::StorageConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all storage_configurations in a region. +```sql +SELECT +region, +arn, +name, +s3, +tags +FROM aws.ivs.storage_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual storage_configuration. +```sql +SELECT +region, +arn, +name, +s3, +tags +FROM aws.ivs.storage_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new storage_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.storage_configurations ( + S3, + region +) +SELECT +'{{ S3 }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.storage_configurations ( + Name, + S3, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ S3 }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: storage_configuration + props: + - name: Name + value: '{{ Name }}' + - name: S3 + value: + BucketName: '{{ BucketName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivs.storage_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ivs:ListStorageConfigurations, +s3:GetBucketLocation, +ivs:ListTagsForResource +``` diff --git a/website/docs/services/ivs/storage_configurations_list_only/index.md b/website/docs/services/ivs/storage_configurations_list_only/index.md new file mode 100644 index 0000000..f6c004e --- /dev/null +++ b/website/docs/services/ivs/storage_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: storage_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - storage_configurations_list_only + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists storage_configurations in a region or regions, for all properties use storage_configurations + +## Overview + + + + + + + +
Namestorage_configurations_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::StorageConfiguration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all storage_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.storage_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_configurations_list_only resource, see storage_configurations + diff --git a/website/docs/services/ivs/stream_key_tags/index.md b/website/docs/services/ivs/stream_key_tags/index.md new file mode 100644 index 0000000..a0f36bc --- /dev/null +++ b/website/docs/services/ivs/stream_key_tags/index.md @@ -0,0 +1,81 @@ +--- +title: stream_key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stream_key_tags + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stream_keys in a region + +## Overview + + + + + + + +
Namestream_key_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::StreamKey
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
stringChannel ARN for the stream.
stringStream-key value.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stream_keys in a region. +```sql +SELECT +region, +arn, +channel_arn, +value, +tag_key, +tag_value +FROM aws.ivs.stream_key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_key_tags resource, see stream_keys + diff --git a/website/docs/services/ivs/stream_keys/index.md b/website/docs/services/ivs/stream_keys/index.md new file mode 100644 index 0000000..6c8220d --- /dev/null +++ b/website/docs/services/ivs/stream_keys/index.md @@ -0,0 +1,217 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a stream_key resource or lists stream_keys in a region + +## Overview + + + + + + + +
Namestream_keys
TypeResource
DescriptionResource Type definition for AWS::IVS::StreamKey
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
stringChannel ARN for the stream.
arrayA list of key-value pairs that contain metadata for the asset model.
stringStream-key value.
stringAWS region.
+ +For more information, see AWS::IVS::StreamKey. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all stream_keys in a region. +```sql +SELECT +region, +arn, +channel_arn, +tags, +value +FROM aws.ivs.stream_keys +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual stream_key. +```sql +SELECT +region, +arn, +channel_arn, +tags, +value +FROM aws.ivs.stream_keys +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stream_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.stream_keys ( + ChannelArn, + region +) +SELECT +'{{ ChannelArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivs.stream_keys ( + ChannelArn, + Tags, + region +) +SELECT + '{{ ChannelArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: stream_key + props: + - name: ChannelArn + value: '{{ ChannelArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivs.stream_keys +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ivs:GetStreamKey, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetStreamKey, +ivs:TagResource, +ivs:UntagResource, +ivs:ListTagsForResource +``` + +### Delete +```json +ivs:DeleteStreamKey, +ivs:UntagResource +``` + +### List +```json +ivs:ListStreamKeys, +ivs:ListTagsForResource +``` diff --git a/website/docs/services/ivs/stream_keys_list_only/index.md b/website/docs/services/ivs/stream_keys_list_only/index.md new file mode 100644 index 0000000..26a720f --- /dev/null +++ b/website/docs/services/ivs/stream_keys_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: stream_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stream_keys_list_only + - ivs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stream_keys in a region or regions, for all properties use stream_keys + +## Overview + + + + + + + +
Namestream_keys_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::StreamKey
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stream_keys in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.stream_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_keys_list_only resource, see stream_keys + diff --git a/website/docs/services/ivschat/index.md b/website/docs/services/ivschat/index.md new file mode 100644 index 0000000..617bb1a --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The ivschat service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/ivschat/logging_configuration_tags/index.md b/website/docs/services/ivschat/logging_configuration_tags/index.md new file mode 100644 index 0000000..85e3702 --- /dev/null +++ b/website/docs/services/ivschat/logging_configuration_tags/index.md @@ -0,0 +1,85 @@ +--- +title: logging_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configuration_tags + - ivschat + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for logging_configurations in a region + +## Overview + + + + + + + +
Namelogging_configuration_tags
TypeResource
DescriptionResource type definition for AWS::IVSChat::LoggingConfiguration.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
stringThe system-generated ID of the logging configuration.
objectDestination configuration for IVS Chat logging.
stringThe name of the logging configuration. The value does not need to be unique.
stringThe state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all logging_configurations in a region. +```sql +SELECT +region, +arn, +id, +destination_configuration, +name, +state, +tag_key, +tag_value +FROM aws.ivschat.logging_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the logging_configuration_tags resource, see logging_configurations + diff --git a/website/docs/services/ivschat/logging_configurations/index.md b/website/docs/services/ivschat/logging_configurations/index.md new file mode 100644 index 0000000..5da2f62 --- /dev/null +++ b/website/docs/services/ivschat/logging_configurations/index.md @@ -0,0 +1,258 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a logging_configuration resource or lists logging_configurations in a region + +## Overview + + + + + + + +
Namelogging_configurations
TypeResource
DescriptionResource type definition for AWS::IVSChat::LoggingConfiguration.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
stringThe system-generated ID of the logging configuration.
objectDestination configuration for IVS Chat logging.
stringThe name of the logging configuration. The value does not need to be unique.
stringThe state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IVSChat::LoggingConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all logging_configurations in a region. +```sql +SELECT +region, +arn, +id, +destination_configuration, +name, +state, +tags +FROM aws.ivschat.logging_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual logging_configuration. +```sql +SELECT +region, +arn, +id, +destination_configuration, +name, +state, +tags +FROM aws.ivschat.logging_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new logging_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivschat.logging_configurations ( + DestinationConfiguration, + region +) +SELECT +'{{ DestinationConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivschat.logging_configurations ( + DestinationConfiguration, + Name, + Tags, + region +) +SELECT + '{{ DestinationConfiguration }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: logging_configuration + props: + - name: DestinationConfiguration + value: + CloudWatchLogs: + LogGroupName: '{{ LogGroupName }}' + Firehose: + DeliveryStreamName: '{{ DeliveryStreamName }}' + S3: + BucketName: '{{ BucketName }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivschat.logging_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ivschat:ListLoggingConfigurations, +ivschat:ListTagsForResource +``` diff --git a/website/docs/services/ivschat/logging_configurations_list_only/index.md b/website/docs/services/ivschat/logging_configurations_list_only/index.md new file mode 100644 index 0000000..49f73ab --- /dev/null +++ b/website/docs/services/ivschat/logging_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: logging_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configurations_list_only + - ivschat + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists logging_configurations in a region or regions, for all properties use logging_configurations + +## Overview + + + + + + + +
Namelogging_configurations_list_only
TypeResource
DescriptionResource type definition for AWS::IVSChat::LoggingConfiguration.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all logging_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.ivschat.logging_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the logging_configurations_list_only resource, see logging_configurations + diff --git a/website/docs/services/ivschat/room_tags/index.md b/website/docs/services/ivschat/room_tags/index.md new file mode 100644 index 0000000..2cd57fe --- /dev/null +++ b/website/docs/services/ivschat/room_tags/index.md @@ -0,0 +1,89 @@ +--- +title: room_tags +hide_title: false +hide_table_of_contents: false +keywords: + - room_tags + - ivschat + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rooms in a region + +## Overview + + + + + + + +
Nameroom_tags
TypeResource
DescriptionResource type definition for AWS::IVSChat::Room.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringRoom ARN is automatically generated on creation and assigned as the unique identifier.
stringThe system-generated ID of the room.
stringThe name of the room. The value does not need to be unique.
arrayArray of logging configuration identifiers attached to the room.
integerThe maximum number of characters in a single message.
integerThe maximum number of messages per second that can be sent to the room.
objectConfiguration information for optional review of messages.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rooms in a region. +```sql +SELECT +region, +arn, +id, +name, +logging_configuration_identifiers, +maximum_message_length, +maximum_message_rate_per_second, +message_review_handler, +tag_key, +tag_value +FROM aws.ivschat.room_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the room_tags resource, see rooms + diff --git a/website/docs/services/ivschat/rooms/index.md b/website/docs/services/ivschat/rooms/index.md new file mode 100644 index 0000000..56bb312 --- /dev/null +++ b/website/docs/services/ivschat/rooms/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a room resource or lists rooms in a region + +## Overview + + + + + + + +
Namerooms
TypeResource
DescriptionResource type definition for AWS::IVSChat::Room.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringRoom ARN is automatically generated on creation and assigned as the unique identifier.
stringThe system-generated ID of the room.
stringThe name of the room. The value does not need to be unique.
arrayArray of logging configuration identifiers attached to the room.
integerThe maximum number of characters in a single message.
integerThe maximum number of messages per second that can be sent to the room.
objectConfiguration information for optional review of messages.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::IVSChat::Room. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rooms in a region. +```sql +SELECT +region, +arn, +id, +name, +logging_configuration_identifiers, +maximum_message_length, +maximum_message_rate_per_second, +message_review_handler, +tags +FROM aws.ivschat.rooms +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual room. +```sql +SELECT +region, +arn, +id, +name, +logging_configuration_identifiers, +maximum_message_length, +maximum_message_rate_per_second, +message_review_handler, +tags +FROM aws.ivschat.rooms +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new room resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ivschat.rooms ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ivschat.rooms ( + Name, + LoggingConfigurationIdentifiers, + MaximumMessageLength, + MaximumMessageRatePerSecond, + MessageReviewHandler, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ LoggingConfigurationIdentifiers }}', + '{{ MaximumMessageLength }}', + '{{ MaximumMessageRatePerSecond }}', + '{{ MessageReviewHandler }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: room + props: + - name: Name + value: '{{ Name }}' + - name: LoggingConfigurationIdentifiers + value: + - '{{ LoggingConfigurationIdentifiers[0] }}' + - name: MaximumMessageLength + value: '{{ MaximumMessageLength }}' + - name: MaximumMessageRatePerSecond + value: '{{ MaximumMessageRatePerSecond }}' + - name: MessageReviewHandler + value: + FallbackResult: '{{ FallbackResult }}' + Uri: '{{ Uri }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ivschat.rooms +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the rooms resource, the following permissions are required: + +### Create +```json +ivschat:CreateRoom, +ivschat:TagResource +``` + +### Read +```json +ivschat:GetRoom, +ivschat:ListTagsForResource +``` + +### Update +```json +ivschat:UpdateRoom, +ivschat:TagResource, +ivschat:UntagResource, +ivschat:ListTagsForResource +``` + +### Delete +```json +ivschat:DeleteRoom, +ivschat:UntagResource +``` + +### List +```json +ivschat:ListRooms, +ivschat:ListTagsForResource +``` diff --git a/website/docs/services/ivschat/rooms_list_only/index.md b/website/docs/services/ivschat/rooms_list_only/index.md new file mode 100644 index 0000000..fd0fe09 --- /dev/null +++ b/website/docs/services/ivschat/rooms_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: rooms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rooms_list_only + - ivschat + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rooms in a region or regions, for all properties use rooms + +## Overview + + + + + + + +
Namerooms_list_only
TypeResource
DescriptionResource type definition for AWS::IVSChat::Room.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringRoom ARN is automatically generated on creation and assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rooms in a region. +```sql +SELECT +region, +arn +FROM aws.ivschat.rooms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rooms_list_only resource, see rooms + diff --git a/website/docs/services/kafkaconnect/connector_tags/index.md b/website/docs/services/kafkaconnect/connector_tags/index.md new file mode 100644 index 0000000..0361f50 --- /dev/null +++ b/website/docs/services/kafkaconnect/connector_tags/index.md @@ -0,0 +1,101 @@ +--- +title: connector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connector_tags + - kafkaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connectors in a region + +## Overview + + + + + + + +
Nameconnector_tags
TypeResource
DescriptionResource Type definition for AWS::KafkaConnect::Connector
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectInformation about the capacity allocated to the connector.
stringAmazon Resource Name for the created Connector.
objectThe configuration for the connector.
stringA summary description of the connector.
stringThe name of the connector.
objectDetails of how to connect to the Kafka cluster.
objectDetails of the client authentication used by the Kafka cluster.
objectDetails of encryption in transit to the Kafka cluster.
stringThe version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
objectDetails of what logs are delivered and where they are delivered.
arrayList of plugins to use with the connector.
stringThe Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
objectThe configuration of the workers, which are the processes that run the connector logic.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connectors in a region. +```sql +SELECT +region, +capacity, +connector_arn, +connector_configuration, +connector_description, +connector_name, +kafka_cluster, +kafka_cluster_client_authentication, +kafka_cluster_encryption_in_transit, +kafka_connect_version, +log_delivery, +plugins, +service_execution_role_arn, +worker_configuration, +tag_key, +tag_value +FROM aws.kafkaconnect.connector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connector_tags resource, see connectors + diff --git a/website/docs/services/kafkaconnect/connectors/index.md b/website/docs/services/kafkaconnect/connectors/index.md new file mode 100644 index 0000000..1f339de --- /dev/null +++ b/website/docs/services/kafkaconnect/connectors/index.md @@ -0,0 +1,383 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connector resource or lists connectors in a region + +## Overview + + + + + + + +
Nameconnectors
TypeResource
DescriptionResource Type definition for AWS::KafkaConnect::Connector
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectInformation about the capacity allocated to the connector.
stringAmazon Resource Name for the created Connector.
objectThe configuration for the connector.
stringA summary description of the connector.
stringThe name of the connector.
objectDetails of how to connect to the Kafka cluster.
objectDetails of the client authentication used by the Kafka cluster.
objectDetails of encryption in transit to the Kafka cluster.
stringThe version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
objectDetails of what logs are delivered and where they are delivered.
arrayList of plugins to use with the connector.
stringThe Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
arrayA collection of tags associated with a resource
objectThe configuration of the workers, which are the processes that run the connector logic.
stringAWS region.
+ +For more information, see AWS::KafkaConnect::Connector. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connectors in a region. +```sql +SELECT +region, +capacity, +connector_arn, +connector_configuration, +connector_description, +connector_name, +kafka_cluster, +kafka_cluster_client_authentication, +kafka_cluster_encryption_in_transit, +kafka_connect_version, +log_delivery, +plugins, +service_execution_role_arn, +tags, +worker_configuration +FROM aws.kafkaconnect.connectors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connector. +```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.connectors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kafkaconnect.connectors ( + Capacity, + ConnectorConfiguration, + ConnectorName, + KafkaCluster, + KafkaClusterClientAuthentication, + KafkaClusterEncryptionInTransit, + KafkaConnectVersion, + Plugins, + ServiceExecutionRoleArn, + region +) +SELECT +'{{ Capacity }}', + '{{ ConnectorConfiguration }}', + '{{ ConnectorName }}', + '{{ KafkaCluster }}', + '{{ KafkaClusterClientAuthentication }}', + '{{ KafkaClusterEncryptionInTransit }}', + '{{ KafkaConnectVersion }}', + '{{ Plugins }}', + '{{ ServiceExecutionRoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kafkaconnect.connectors ( + Capacity, + ConnectorConfiguration, + ConnectorDescription, + ConnectorName, + KafkaCluster, + KafkaClusterClientAuthentication, + KafkaClusterEncryptionInTransit, + KafkaConnectVersion, + LogDelivery, + Plugins, + ServiceExecutionRoleArn, + Tags, + WorkerConfiguration, + region +) +SELECT + '{{ Capacity }}', + '{{ ConnectorConfiguration }}', + '{{ ConnectorDescription }}', + '{{ ConnectorName }}', + '{{ KafkaCluster }}', + '{{ KafkaClusterClientAuthentication }}', + '{{ KafkaClusterEncryptionInTransit }}', + '{{ KafkaConnectVersion }}', + '{{ LogDelivery }}', + '{{ Plugins }}', + '{{ ServiceExecutionRoleArn }}', + '{{ Tags }}', + '{{ WorkerConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connector + props: + - name: Capacity + value: + AutoScaling: + MaxWorkerCount: '{{ MaxWorkerCount }}' + MinWorkerCount: '{{ MinWorkerCount }}' + ScaleInPolicy: + CpuUtilizationPercentage: '{{ CpuUtilizationPercentage }}' + ScaleOutPolicy: + CpuUtilizationPercentage: '{{ CpuUtilizationPercentage }}' + McuCount: '{{ McuCount }}' + ProvisionedCapacity: + McuCount: '{{ McuCount }}' + WorkerCount: '{{ WorkerCount }}' + - name: ConnectorConfiguration + value: {} + - name: ConnectorDescription + value: '{{ ConnectorDescription }}' + - name: ConnectorName + value: '{{ ConnectorName }}' + - name: KafkaCluster + value: + ApacheKafkaCluster: + BootstrapServers: '{{ BootstrapServers }}' + Vpc: + SecurityGroups: + - '{{ SecurityGroups[0] }}' + Subnets: + - '{{ Subnets[0] }}' + - name: KafkaClusterClientAuthentication + value: + AuthenticationType: '{{ AuthenticationType }}' + - name: KafkaClusterEncryptionInTransit + value: + EncryptionType: '{{ EncryptionType }}' + - name: KafkaConnectVersion + value: '{{ KafkaConnectVersion }}' + - name: LogDelivery + value: + WorkerLogDelivery: + CloudWatchLogs: + Enabled: '{{ Enabled }}' + LogGroup: '{{ LogGroup }}' + Firehose: + DeliveryStream: '{{ DeliveryStream }}' + Enabled: '{{ Enabled }}' + S3: + Bucket: '{{ Bucket }}' + Enabled: '{{ Enabled }}' + Prefix: '{{ Prefix }}' + - name: Plugins + value: + - CustomPlugin: + Name: '{{ Name }}' + Description: '{{ Description }}' + ContentType: '{{ ContentType }}' + Location: + S3Location: + BucketArn: '{{ BucketArn }}' + FileKey: '{{ FileKey }}' + ObjectVersion: '{{ ObjectVersion }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ServiceExecutionRoleArn + value: '{{ ServiceExecutionRoleArn }}' + - name: Tags + value: + - null + - name: WorkerConfiguration + value: + Name: '{{ Name }}' + Description: '{{ Description }}' + PropertiesFileContent: '{{ PropertiesFileContent }}' + Tags: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kafkaconnect.connectors +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +kafkaconnect:ListConnectors +``` diff --git a/website/docs/services/kafkaconnect/connectors_list_only/index.md b/website/docs/services/kafkaconnect/connectors_list_only/index.md new file mode 100644 index 0000000..361ac69 --- /dev/null +++ b/website/docs/services/kafkaconnect/connectors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connectors_list_only + - kafkaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connectors in a region or regions, for all properties use connectors + +## Overview + + + + + + + +
Nameconnectors_list_only
TypeResource
DescriptionResource Type definition for AWS::KafkaConnect::Connector
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name for the created Connector.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connectors in a region. +```sql +SELECT +region, +connector_arn +FROM aws.kafkaconnect.connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connectors_list_only resource, see connectors + diff --git a/website/docs/services/kafkaconnect/custom_plugin_tags/index.md b/website/docs/services/kafkaconnect/custom_plugin_tags/index.md new file mode 100644 index 0000000..bd913f0 --- /dev/null +++ b/website/docs/services/kafkaconnect/custom_plugin_tags/index.md @@ -0,0 +1,89 @@ +--- +title: custom_plugin_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_plugin_tags + - kafkaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_plugins in a region + +## Overview + + + + + + + +
Namecustom_plugin_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the custom plugin.
stringA summary description of the custom plugin.
stringThe Amazon Resource Name (ARN) of the custom plugin to use.
stringThe type of the plugin file.
objectDetails about the custom plugin file.
objectInformation about the location of a custom plugin.
integerThe revision of the custom plugin.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_plugins in a region. +```sql +SELECT +region, +name, +description, +custom_plugin_arn, +content_type, +file_description, +location, +revision, +tag_key, +tag_value +FROM aws.kafkaconnect.custom_plugin_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_plugin_tags resource, see custom_plugins + diff --git a/website/docs/services/kafkaconnect/custom_plugins/index.md b/website/docs/services/kafkaconnect/custom_plugins/index.md new file mode 100644 index 0000000..2c9bdbd --- /dev/null +++ b/website/docs/services/kafkaconnect/custom_plugins/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a custom_plugin resource or lists custom_plugins in a region + +## Overview + + + + + + + +
Namecustom_plugins
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the custom plugin.
stringA summary description of the custom plugin.
stringThe Amazon Resource Name (ARN) of the custom plugin to use.
stringThe type of the plugin file.
objectDetails about the custom plugin file.
objectInformation about the location of a custom plugin.
integerThe revision of the custom plugin.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::KafkaConnect::CustomPlugin. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all custom_plugins in a region. +```sql +SELECT +region, +name, +description, +custom_plugin_arn, +content_type, +file_description, +location, +revision, +tags +FROM aws.kafkaconnect.custom_plugins +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual custom_plugin. +```sql +SELECT +region, +name, +description, +custom_plugin_arn, +content_type, +file_description, +location, +revision, +tags +FROM aws.kafkaconnect.custom_plugins +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new custom_plugin resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kafkaconnect.custom_plugins ( + Name, + ContentType, + Location, + region +) +SELECT +'{{ Name }}', + '{{ ContentType }}', + '{{ Location }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kafkaconnect.custom_plugins ( + Name, + Description, + ContentType, + Location, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ ContentType }}', + '{{ Location }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: custom_plugin + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: ContentType + value: '{{ ContentType }}' + - name: Location + value: + S3Location: + BucketArn: '{{ BucketArn }}' + FileKey: '{{ FileKey }}' + ObjectVersion: '{{ ObjectVersion }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kafkaconnect.custom_plugins +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +kafkaconnect:DescribeCustomPlugin, +kafkaconnect:ListTagsForResource +``` + +### Update +```json +kafkaconnect:DescribeCustomPlugin, +kafkaconnect:ListTagsForResource, +kafkaconnect:TagResource, +kafkaconnect:UntagResource +``` + +### Delete +```json +kafkaconnect:DeleteCustomPlugin, +kafkaconnect:DescribeCustomPlugin +``` + +### List +```json +kafkaconnect:ListCustomPlugins +``` diff --git a/website/docs/services/kafkaconnect/custom_plugins_list_only/index.md b/website/docs/services/kafkaconnect/custom_plugins_list_only/index.md new file mode 100644 index 0000000..6ca1a42 --- /dev/null +++ b/website/docs/services/kafkaconnect/custom_plugins_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: custom_plugins_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_plugins_list_only + - kafkaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_plugins in a region or regions, for all properties use custom_plugins + +## Overview + + + + + + + +
Namecustom_plugins_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the custom plugin to use.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_plugins in a region. +```sql +SELECT +region, +custom_plugin_arn +FROM aws.kafkaconnect.custom_plugins_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_plugins_list_only resource, see custom_plugins + diff --git a/website/docs/services/kafkaconnect/index.md b/website/docs/services/kafkaconnect/index.md new file mode 100644 index 0000000..d1a8535 --- /dev/null +++ b/website/docs/services/kafkaconnect/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The kafkaconnect service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/kafkaconnect/worker_configuration_tags/index.md b/website/docs/services/kafkaconnect/worker_configuration_tags/index.md new file mode 100644 index 0000000..08cc0cc --- /dev/null +++ b/website/docs/services/kafkaconnect/worker_configuration_tags/index.md @@ -0,0 +1,85 @@ +--- +title: worker_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - worker_configuration_tags + - kafkaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for worker_configurations in a region + +## Overview + + + + + + + +
Nameworker_configuration_tags
TypeResource
DescriptionThe configuration of the workers, which are the processes that run the connector logic.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the worker configuration.
stringA summary description of the worker configuration.
stringThe Amazon Resource Name (ARN) of the custom configuration.
stringBase64 encoded contents of connect-distributed.properties file.
integerThe description of a revision of the worker configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all worker_configurations in a region. +```sql +SELECT +region, +name, +description, +worker_configuration_arn, +properties_file_content, +revision, +tag_key, +tag_value +FROM aws.kafkaconnect.worker_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the worker_configuration_tags resource, see worker_configurations + diff --git a/website/docs/services/kafkaconnect/worker_configurations/index.md b/website/docs/services/kafkaconnect/worker_configurations/index.md new file mode 100644 index 0000000..1d7908a --- /dev/null +++ b/website/docs/services/kafkaconnect/worker_configurations/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a worker_configuration resource or lists worker_configurations in a region + +## Overview + + + + + + + +
Nameworker_configurations
TypeResource
DescriptionThe configuration of the workers, which are the processes that run the connector logic.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the worker configuration.
stringA summary description of the worker configuration.
stringThe Amazon Resource Name (ARN) of the custom configuration.
stringBase64 encoded contents of connect-distributed.properties file.
integerThe description of a revision of the worker configuration.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::KafkaConnect::WorkerConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all worker_configurations in a region. +```sql +SELECT +region, +name, +description, +worker_configuration_arn, +properties_file_content, +revision, +tags +FROM aws.kafkaconnect.worker_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual worker_configuration. +```sql +SELECT +region, +name, +description, +worker_configuration_arn, +properties_file_content, +revision, +tags +FROM aws.kafkaconnect.worker_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new worker_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kafkaconnect.worker_configurations ( + Name, + PropertiesFileContent, + region +) +SELECT +'{{ Name }}', + '{{ PropertiesFileContent }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kafkaconnect.worker_configurations ( + Name, + Description, + PropertiesFileContent, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ PropertiesFileContent }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: worker_configuration + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: PropertiesFileContent + value: '{{ PropertiesFileContent }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kafkaconnect.worker_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +kafkaconnect:DescribeWorkerConfiguration, +kafkaconnect:ListTagsForResource +``` + +### Update +```json +kafkaconnect:DescribeWorkerConfiguration, +kafkaconnect:ListTagsForResource, +kafkaconnect:TagResource, +kafkaconnect:UntagResource +``` + +### Delete +```json +kafkaconnect:DescribeWorkerConfiguration, +kafkaconnect:DeleteWorkerConfiguration +``` + +### List +```json +kafkaconnect:ListWorkerConfigurations +``` diff --git a/website/docs/services/kafkaconnect/worker_configurations_list_only/index.md b/website/docs/services/kafkaconnect/worker_configurations_list_only/index.md new file mode 100644 index 0000000..9c8a6ab --- /dev/null +++ b/website/docs/services/kafkaconnect/worker_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: worker_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - worker_configurations_list_only + - kafkaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists worker_configurations in a region or regions, for all properties use worker_configurations + +## Overview + + + + + + + +
Nameworker_configurations_list_only
TypeResource
DescriptionThe configuration of the workers, which are the processes that run the connector logic.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the custom configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all worker_configurations in a region. +```sql +SELECT +region, +worker_configuration_arn +FROM aws.kafkaconnect.worker_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the worker_configurations_list_only resource, see worker_configurations + diff --git a/website/docs/services/kendra/data_source_tags/index.md b/website/docs/services/kendra/data_source_tags/index.md new file mode 100644 index 0000000..feeb992 --- /dev/null +++ b/website/docs/services/kendra/data_source_tags/index.md @@ -0,0 +1,97 @@ +--- +title: data_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_source_tags + - kendra + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_sources in a region + +## Overview + + + + + + + +
Namedata_source_tags
TypeResource
DescriptionKendra DataSource
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
string
stringName of index
stringUnique ID of Index
stringData source type
object
string
stringSchedule
stringRole Arn
object
stringThe code for a language.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_sources in a region. +```sql +SELECT +region, +id, +arn, +name, +index_id, +type, +data_source_configuration, +description, +schedule, +role_arn, +custom_document_enrichment_configuration, +language_code, +tag_key, +tag_value +FROM aws.kendra.data_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_source_tags resource, see data_sources + diff --git a/website/docs/services/kendra/data_sources/index.md b/website/docs/services/kendra/data_sources/index.md new file mode 100644 index 0000000..40e023c --- /dev/null +++ b/website/docs/services/kendra/data_sources/index.md @@ -0,0 +1,492 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_source resource or lists data_sources in a region + +## Overview + + + + + + + +
Namedata_sources
TypeResource
DescriptionKendra DataSource
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
string
stringName of index
stringUnique ID of Index
stringData source type
object
string
stringSchedule
stringRole Arn
arrayTags for labeling the data source
object
stringThe code for a language.
stringAWS region.
+ +For more information, see AWS::Kendra::DataSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_sources in a region. +```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_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_source. +```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_sources +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kendra.data_sources ( + Name, + IndexId, + Type, + region +) +SELECT +'{{ Name }}', + '{{ IndexId }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kendra.data_sources ( + Name, + IndexId, + Type, + DataSourceConfiguration, + Description, + Schedule, + RoleArn, + Tags, + CustomDocumentEnrichmentConfiguration, + LanguageCode, + region +) +SELECT + '{{ Name }}', + '{{ IndexId }}', + '{{ Type }}', + '{{ DataSourceConfiguration }}', + '{{ Description }}', + '{{ Schedule }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ CustomDocumentEnrichmentConfiguration }}', + '{{ LanguageCode }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_source + props: + - name: Name + value: '{{ Name }}' + - name: IndexId + value: '{{ IndexId }}' + - name: Type + value: '{{ Type }}' + - name: DataSourceConfiguration + value: + S3Configuration: + BucketName: '{{ BucketName }}' + InclusionPrefixes: + - '{{ InclusionPrefixes[0] }}' + InclusionPatterns: null + ExclusionPatterns: null + DocumentsMetadataConfiguration: + S3Prefix: '{{ S3Prefix }}' + AccessControlListConfiguration: + KeyPath: null + SharePointConfiguration: + SharePointVersion: '{{ SharePointVersion }}' + Urls: + - '{{ Urls[0] }}' + SecretArn: '{{ SecretArn }}' + CrawlAttachments: '{{ CrawlAttachments }}' + UseChangeLog: '{{ UseChangeLog }}' + InclusionPatterns: null + ExclusionPatterns: null + VpcConfiguration: + SubnetIds: + - '{{ SubnetIds[0] }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + FieldMappings: + - DataSourceFieldName: '{{ DataSourceFieldName }}' + DateFieldFormat: '{{ DateFieldFormat }}' + IndexFieldName: '{{ IndexFieldName }}' + DocumentTitleFieldName: null + DisableLocalGroups: '{{ DisableLocalGroups }}' + SslCertificateS3Path: + Bucket: null + Key: null + SalesforceConfiguration: + ServerUrl: null + SecretArn: null + StandardObjectConfigurations: + - Name: '{{ Name }}' + DocumentDataFieldName: null + DocumentTitleFieldName: null + FieldMappings: null + KnowledgeArticleConfiguration: + IncludedStates: + - '{{ IncludedStates[0] }}' + StandardKnowledgeArticleTypeConfiguration: + DocumentDataFieldName: null + DocumentTitleFieldName: null + FieldMappings: null + CustomKnowledgeArticleTypeConfigurations: + - Name: '{{ Name }}' + DocumentDataFieldName: null + DocumentTitleFieldName: null + FieldMappings: null + ChatterFeedConfiguration: + DocumentDataFieldName: null + DocumentTitleFieldName: null + FieldMappings: null + IncludeFilterTypes: + - '{{ IncludeFilterTypes[0] }}' + CrawlAttachments: '{{ CrawlAttachments }}' + StandardObjectAttachmentConfiguration: + DocumentTitleFieldName: null + FieldMappings: null + IncludeAttachmentFilePatterns: null + ExcludeAttachmentFilePatterns: null + OneDriveConfiguration: + TenantDomain: '{{ TenantDomain }}' + SecretArn: null + OneDriveUsers: + OneDriveUserList: + - '{{ OneDriveUserList[0] }}' + OneDriveUserS3Path: null + InclusionPatterns: null + ExclusionPatterns: null + FieldMappings: null + DisableLocalGroups: null + ServiceNowConfiguration: + HostUrl: '{{ HostUrl }}' + SecretArn: null + ServiceNowBuildVersion: '{{ ServiceNowBuildVersion }}' + AuthenticationType: '{{ AuthenticationType }}' + KnowledgeArticleConfiguration: + CrawlAttachments: '{{ CrawlAttachments }}' + IncludeAttachmentFilePatterns: null + ExcludeAttachmentFilePatterns: null + DocumentDataFieldName: null + DocumentTitleFieldName: null + FieldMappings: null + FilterQuery: '{{ FilterQuery }}' + ServiceCatalogConfiguration: + CrawlAttachments: '{{ CrawlAttachments }}' + IncludeAttachmentFilePatterns: null + ExcludeAttachmentFilePatterns: null + DocumentDataFieldName: null + DocumentTitleFieldName: null + FieldMappings: null + DatabaseConfiguration: + DatabaseEngineType: '{{ DatabaseEngineType }}' + ConnectionConfiguration: + DatabaseHost: '{{ DatabaseHost }}' + DatabasePort: '{{ DatabasePort }}' + DatabaseName: '{{ DatabaseName }}' + TableName: '{{ TableName }}' + SecretArn: null + VpcConfiguration: null + ColumnConfiguration: + DocumentIdColumnName: '{{ DocumentIdColumnName }}' + DocumentDataColumnName: null + DocumentTitleColumnName: null + FieldMappings: null + ChangeDetectingColumns: + - null + AclConfiguration: + AllowedGroupsColumnName: null + SqlConfiguration: + QueryIdentifiersEnclosingOption: '{{ QueryIdentifiersEnclosingOption }}' + ConfluenceConfiguration: + ServerUrl: null + SecretArn: null + Version: '{{ Version }}' + SpaceConfiguration: + CrawlPersonalSpaces: '{{ CrawlPersonalSpaces }}' + CrawlArchivedSpaces: '{{ CrawlArchivedSpaces }}' + IncludeSpaces: + - '{{ IncludeSpaces[0] }}' + ExcludeSpaces: null + SpaceFieldMappings: + - DataSourceFieldName: '{{ DataSourceFieldName }}' + DateFieldFormat: null + IndexFieldName: null + PageConfiguration: + PageFieldMappings: + - DataSourceFieldName: '{{ DataSourceFieldName }}' + DateFieldFormat: null + IndexFieldName: null + BlogConfiguration: + BlogFieldMappings: + - DataSourceFieldName: '{{ DataSourceFieldName }}' + DateFieldFormat: null + IndexFieldName: null + AttachmentConfiguration: + CrawlAttachments: '{{ CrawlAttachments }}' + AttachmentFieldMappings: + - DataSourceFieldName: '{{ DataSourceFieldName }}' + DateFieldFormat: null + IndexFieldName: null + VpcConfiguration: null + InclusionPatterns: null + ExclusionPatterns: null + GoogleDriveConfiguration: + SecretArn: null + InclusionPatterns: null + ExclusionPatterns: null + FieldMappings: null + ExcludeMimeTypes: + - '{{ ExcludeMimeTypes[0] }}' + ExcludeUserAccounts: + - '{{ ExcludeUserAccounts[0] }}' + ExcludeSharedDrives: + - '{{ ExcludeSharedDrives[0] }}' + WebCrawlerConfiguration: + Urls: + SeedUrlConfiguration: + SeedUrls: + - '{{ SeedUrls[0] }}' + WebCrawlerMode: '{{ WebCrawlerMode }}' + SiteMapsConfiguration: + SiteMaps: + - '{{ SiteMaps[0] }}' + CrawlDepth: '{{ CrawlDepth }}' + MaxLinksPerPage: '{{ MaxLinksPerPage }}' + MaxContentSizePerPageInMegaBytes: null + MaxUrlsPerMinuteCrawlRate: '{{ MaxUrlsPerMinuteCrawlRate }}' + UrlInclusionPatterns: null + UrlExclusionPatterns: null + ProxyConfiguration: + Host: '{{ Host }}' + Port: '{{ Port }}' + Credentials: null + AuthenticationConfiguration: + BasicAuthentication: + - Host: '{{ Host }}' + Port: '{{ Port }}' + Credentials: null + WorkDocsConfiguration: + OrganizationId: '{{ OrganizationId }}' + CrawlComments: '{{ CrawlComments }}' + UseChangeLog: '{{ UseChangeLog }}' + InclusionPatterns: null + ExclusionPatterns: null + FieldMappings: null + - name: Description + value: '{{ Description }}' + - name: Schedule + value: '{{ Schedule }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CustomDocumentEnrichmentConfiguration + value: + InlineConfigurations: + - Condition: + ConditionDocumentAttributeKey: '{{ ConditionDocumentAttributeKey }}' + Operator: '{{ Operator }}' + ConditionOnValue: + StringValue: '{{ StringValue }}' + StringListValue: + - '{{ StringListValue[0] }}' + LongValue: '{{ LongValue }}' + DateValue: '{{ DateValue }}' + Target: + TargetDocumentAttributeKey: null + TargetDocumentAttributeValueDeletion: '{{ TargetDocumentAttributeValueDeletion }}' + TargetDocumentAttributeValue: null + DocumentContentDeletion: '{{ DocumentContentDeletion }}' + PreExtractionHookConfiguration: + InvocationCondition: null + LambdaArn: '{{ LambdaArn }}' + S3Bucket: null + PostExtractionHookConfiguration: null + RoleArn: null + - name: LanguageCode + value: '{{ LanguageCode }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kendra.data_sources +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +kendra:DescribeDataSource, +kendra:ListTagsForResource +``` + +### Delete +```json +kendra:DescribeDataSource, +kendra:DeleteDataSource +``` + +### List +```json +kendra:ListDataSources +``` + +### Update +```json +kendra:DescribeDataSource, +kendra:UpdateDataSource, +kendra:ListTagsForResource, +kendra:TagResource, +kendra:UntagResource, +iam:PassRole +``` diff --git a/website/docs/services/kendra/data_sources_list_only/index.md b/website/docs/services/kendra/data_sources_list_only/index.md new file mode 100644 index 0000000..cffda87 --- /dev/null +++ b/website/docs/services/kendra/data_sources_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - kendra + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionKendra DataSource
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringUnique ID of index
stringUnique ID of Index
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +id, +index_id +FROM aws.kendra.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + diff --git a/website/docs/services/kendra/faq_tags/index.md b/website/docs/services/kendra/faq_tags/index.md new file mode 100644 index 0000000..b932310 --- /dev/null +++ b/website/docs/services/kendra/faq_tags/index.md @@ -0,0 +1,93 @@ +--- +title: faq_tags +hide_title: false +hide_table_of_contents: false +keywords: + - faq_tags + - kendra + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for faqs in a region + +## Overview + + + + + + + +
Namefaq_tags
TypeResource
DescriptionA Kendra FAQ resource
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
stringIndex ID
stringFAQ name
stringFAQ description
stringFAQ file format
objectFAQ S3 path
stringFAQ role ARN
string
stringThe code for a language.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all faqs in a region. +```sql +SELECT +region, +id, +index_id, +name, +description, +file_format, +s3_path, +role_arn, +arn, +language_code, +tag_key, +tag_value +FROM aws.kendra.faq_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the faq_tags resource, see faqs + diff --git a/website/docs/services/kendra/faqs/index.md b/website/docs/services/kendra/faqs/index.md new file mode 100644 index 0000000..c88e989 --- /dev/null +++ b/website/docs/services/kendra/faqs/index.md @@ -0,0 +1,267 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a faq resource or lists faqs in a region + +## Overview + + + + + + + +
Namefaqs
TypeResource
DescriptionA Kendra FAQ resource
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
stringIndex ID
stringFAQ name
stringFAQ description
stringFAQ file format
objectFAQ S3 path
stringFAQ role ARN
arrayTags for labeling the FAQ
string
stringThe code for a language.
stringAWS region.
+ +For more information, see AWS::Kendra::Faq. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all faqs in a region. +```sql +SELECT +region, +id, +index_id, +name, +description, +file_format, +s3_path, +role_arn, +tags, +arn, +language_code +FROM aws.kendra.faqs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual faq. +```sql +SELECT +region, +id, +index_id, +name, +description, +file_format, +s3_path, +role_arn, +tags, +arn, +language_code +FROM aws.kendra.faqs +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new faq resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kendra.faqs ( + IndexId, + Name, + S3Path, + RoleArn, + region +) +SELECT +'{{ IndexId }}', + '{{ Name }}', + '{{ S3Path }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kendra.faqs ( + IndexId, + Name, + Description, + FileFormat, + S3Path, + RoleArn, + Tags, + LanguageCode, + region +) +SELECT + '{{ IndexId }}', + '{{ Name }}', + '{{ Description }}', + '{{ FileFormat }}', + '{{ S3Path }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ LanguageCode }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: faq + props: + - name: IndexId + value: '{{ IndexId }}' + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: FileFormat + value: '{{ FileFormat }}' + - name: S3Path + value: + Bucket: '{{ Bucket }}' + Key: '{{ Key }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: LanguageCode + value: '{{ LanguageCode }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kendra.faqs +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +kendra:ListTagsForResource, +kendra:UntagResource, +kendra:TagResource +``` + +### Read +```json +kendra:DescribeFaq, +kendra:ListTagsForResource +``` + +### Delete +```json +kendra:DeleteFaq, +kendra:DescribeFaq +``` + +### List +```json +kendra:ListFaqs +``` diff --git a/website/docs/services/kendra/faqs_list_only/index.md b/website/docs/services/kendra/faqs_list_only/index.md new file mode 100644 index 0000000..81259eb --- /dev/null +++ b/website/docs/services/kendra/faqs_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: faqs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - faqs_list_only + - kendra + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists faqs in a region or regions, for all properties use faqs + +## Overview + + + + + + + +
Namefaqs_list_only
TypeResource
DescriptionA Kendra FAQ resource
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringUnique ID of index
stringIndex ID
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all faqs in a region. +```sql +SELECT +region, +id, +index_id +FROM aws.kendra.faqs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the faqs_list_only resource, see faqs + diff --git a/website/docs/services/kendra/index.md b/website/docs/services/kendra/index.md new file mode 100644 index 0000000..a0a41a7 --- /dev/null +++ b/website/docs/services/kendra/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The kendra service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/kendra/index_tags/index.md b/website/docs/services/kendra/index_tags/index.md new file mode 100644 index 0000000..e1e0521 --- /dev/null +++ b/website/docs/services/kendra/index_tags/index.md @@ -0,0 +1,97 @@ +--- +title: index_tags +hide_title: false +hide_table_of_contents: false +keywords: + - index_tags + - kendra + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for indices in a region + +## Overview + + + + + + + +
Nameindex_tags
TypeResource
DescriptionA Kendra index
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
string
stringA description for the index
objectServer side encryption configuration
stringName of index
stringRole Arn
stringEdition of index
arrayDocument metadata configurations
objectCapacity units
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all indices in a region. +```sql +SELECT +region, +id, +arn, +description, +server_side_encryption_configuration, +name, +role_arn, +edition, +document_metadata_configurations, +capacity_units, +user_context_policy, +user_token_configurations, +tag_key, +tag_value +FROM aws.kendra.index_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the index_tags resource, see indices + diff --git a/website/docs/services/kendra/indices/index.md b/website/docs/services/kendra/indices/index.md new file mode 100644 index 0000000..0a124be --- /dev/null +++ b/website/docs/services/kendra/indices/index.md @@ -0,0 +1,310 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an index resource or lists indices in a region + +## Overview + + + + + + + +
Nameindices
TypeResource
DescriptionA Kendra index
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
string
stringA description for the index
objectServer side encryption configuration
arrayTags for labeling the index
stringName of index
stringRole Arn
stringEdition of index
arrayDocument metadata configurations
objectCapacity units
string
array
stringAWS region.
+ +For more information, see AWS::Kendra::Index. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all indices in a region. +```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.indices +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual index. +```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.indices +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new index resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kendra.indices ( + Name, + RoleArn, + Edition, + region +) +SELECT +'{{ Name }}', + '{{ RoleArn }}', + '{{ Edition }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kendra.indices ( + Description, + ServerSideEncryptionConfiguration, + Tags, + Name, + RoleArn, + Edition, + DocumentMetadataConfigurations, + CapacityUnits, + UserContextPolicy, + UserTokenConfigurations, + region +) +SELECT + '{{ Description }}', + '{{ ServerSideEncryptionConfiguration }}', + '{{ Tags }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ Edition }}', + '{{ DocumentMetadataConfigurations }}', + '{{ CapacityUnits }}', + '{{ UserContextPolicy }}', + '{{ UserTokenConfigurations }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: index + props: + - name: Description + value: '{{ Description }}' + - name: ServerSideEncryptionConfiguration + value: + KmsKeyId: '{{ KmsKeyId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Edition + value: '{{ Edition }}' + - name: DocumentMetadataConfigurations + value: + - Name: '{{ Name }}' + Type: '{{ Type }}' + Relevance: + Freshness: '{{ Freshness }}' + Importance: '{{ Importance }}' + Duration: '{{ Duration }}' + RankOrder: '{{ RankOrder }}' + ValueImportanceItems: + - Key: '{{ Key }}' + Value: null + Search: + Facetable: '{{ Facetable }}' + Searchable: '{{ Searchable }}' + Displayable: '{{ Displayable }}' + Sortable: '{{ Sortable }}' + - name: CapacityUnits + value: + StorageCapacityUnits: '{{ StorageCapacityUnits }}' + QueryCapacityUnits: '{{ QueryCapacityUnits }}' + - name: UserContextPolicy + value: '{{ UserContextPolicy }}' + - name: UserTokenConfigurations + value: + - JwtTokenTypeConfiguration: + KeyLocation: '{{ KeyLocation }}' + URL: '{{ URL }}' + SecretManagerArn: null + UserNameAttributeField: '{{ UserNameAttributeField }}' + GroupAttributeField: '{{ GroupAttributeField }}' + Issuer: '{{ Issuer }}' + ClaimRegex: '{{ ClaimRegex }}' + JsonTokenTypeConfiguration: + UserNameAttributeField: null + GroupAttributeField: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kendra.indices +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +kendra:ListIndices +``` diff --git a/website/docs/services/kendra/indices_list_only/index.md b/website/docs/services/kendra/indices_list_only/index.md new file mode 100644 index 0000000..e7b6013 --- /dev/null +++ b/website/docs/services/kendra/indices_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: indices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - indices_list_only + - kendra + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists indices in a region or regions, for all properties use indices + +## Overview + + + + + + + +
Nameindices_list_only
TypeResource
DescriptionA Kendra index
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique ID of index
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all indices in a region. +```sql +SELECT +region, +id +FROM aws.kendra.indices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the indices_list_only resource, see indices + diff --git a/website/docs/services/kendraranking/execution_plan_tags/index.md b/website/docs/services/kendraranking/execution_plan_tags/index.md new file mode 100644 index 0000000..38154ad --- /dev/null +++ b/website/docs/services/kendraranking/execution_plan_tags/index.md @@ -0,0 +1,85 @@ +--- +title: execution_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - execution_plan_tags + - kendraranking + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for execution_plans in a region + +## Overview + + + + + + + +
Nameexecution_plan_tags
TypeResource
DescriptionA KendraRanking Rescore execution plan
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of rescore execution plan
string
stringA description for the execution plan
stringName of kendra ranking rescore execution plan
objectCapacity units
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all execution_plans in a region. +```sql +SELECT +region, +id, +arn, +description, +name, +capacity_units, +tag_key, +tag_value +FROM aws.kendraranking.execution_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the execution_plan_tags resource, see execution_plans + diff --git a/website/docs/services/kendraranking/execution_plans/index.md b/website/docs/services/kendraranking/execution_plans/index.md new file mode 100644 index 0000000..cd150f2 --- /dev/null +++ b/website/docs/services/kendraranking/execution_plans/index.md @@ -0,0 +1,234 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an execution_plan resource or lists execution_plans in a region + +## Overview + + + + + + + +
Nameexecution_plans
TypeResource
DescriptionA KendraRanking Rescore execution plan
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of rescore execution plan
string
stringA description for the execution plan
arrayTags for labeling the execution plan
stringName of kendra ranking rescore execution plan
objectCapacity units
stringAWS region.
+ +For more information, see AWS::KendraRanking::ExecutionPlan. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all execution_plans in a region. +```sql +SELECT +region, +id, +arn, +description, +tags, +name, +capacity_units +FROM aws.kendraranking.execution_plans +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual execution_plan. +```sql +SELECT +region, +id, +arn, +description, +tags, +name, +capacity_units +FROM aws.kendraranking.execution_plans +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new execution_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kendraranking.execution_plans ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kendraranking.execution_plans ( + Description, + Tags, + Name, + CapacityUnits, + region +) +SELECT + '{{ Description }}', + '{{ Tags }}', + '{{ Name }}', + '{{ CapacityUnits }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: execution_plan + props: + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Name + value: '{{ Name }}' + - name: CapacityUnits + value: + RescoreCapacityUnits: '{{ RescoreCapacityUnits }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kendraranking.execution_plans +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +kendra-ranking:ListRescoreExecutionPlans +``` diff --git a/website/docs/services/kendraranking/execution_plans_list_only/index.md b/website/docs/services/kendraranking/execution_plans_list_only/index.md new file mode 100644 index 0000000..03539f0 --- /dev/null +++ b/website/docs/services/kendraranking/execution_plans_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: execution_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - execution_plans_list_only + - kendraranking + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists execution_plans in a region or regions, for all properties use execution_plans + +## Overview + + + + + + + +
Nameexecution_plans_list_only
TypeResource
DescriptionA KendraRanking Rescore execution plan
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique ID of rescore execution plan
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all execution_plans in a region. +```sql +SELECT +region, +id +FROM aws.kendraranking.execution_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the execution_plans_list_only resource, see execution_plans + diff --git a/website/docs/services/kendraranking/index.md b/website/docs/services/kendraranking/index.md new file mode 100644 index 0000000..567ef23 --- /dev/null +++ b/website/docs/services/kendraranking/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The kendraranking service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/kinesis/index.md b/website/docs/services/kinesis/index.md new file mode 100644 index 0000000..5772da0 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The kinesis service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/kinesis/resource_policies/index.md b/website/docs/services/kinesis/resource_policies/index.md new file mode 100644 index 0000000..8b8f8c2 --- /dev/null +++ b/website/docs/services/kinesis/resource_policies/index.md @@ -0,0 +1,188 @@ +--- +title: resource_policies +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_policy resource or lists resource_policies in a region + +## Overview + + + + + + + +
Nameresource_policies
TypeResource
DescriptionResource Type definition for AWS::Kinesis::ResourcePolicy
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ARN of the AWS Kinesis resource to which the policy applies.
objectA 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.
stringAWS region.
+ +For more information, see AWS::Kinesis::ResourcePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual resource_policy. +```sql +SELECT +region, +resource_arn, +resource_policy +FROM aws.kinesis.resource_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kinesis.resource_policies ( + ResourceArn, + ResourcePolicy, + region +) +SELECT +'{{ ResourceArn }}', + '{{ ResourcePolicy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kinesis.resource_policies ( + ResourceArn, + ResourcePolicy, + region +) +SELECT + '{{ ResourceArn }}', + '{{ ResourcePolicy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_policy + props: + - name: ResourceArn + value: '{{ ResourceArn }}' + - name: ResourcePolicy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kinesis.resource_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +kinesis:GetResourcePolicy, +kinesis:PutResourcePolicy +``` + +### Read +```json +kinesis:GetResourcePolicy +``` + +### Update +```json +kinesis:PutResourcePolicy, +kinesis:GetResourcePolicy +``` + +### Delete +```json +kinesis:DeleteResourcePolicy, +kinesis:GetResourcePolicy +``` diff --git a/website/docs/services/kinesis/stream_tags/index.md b/website/docs/services/kinesis/stream_tags/index.md new file mode 100644 index 0000000..e17403f --- /dev/null +++ b/website/docs/services/kinesis/stream_tags/index.md @@ -0,0 +1,87 @@ +--- +title: stream_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stream_tags + - kinesis + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for streams in a region + +## Overview + + + + + + + +
Namestream_tags
TypeResource
DescriptionResource Type definition for AWS::Kinesis::Stream
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectThe mode in which the stream is running.
objectWhen specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
stringThe Amazon resource name (ARN) of the Kinesis stream
integerThe number of hours for the data records that are stored in shards to remain accessible.
stringThe name of the Kinesis stream.
integerThe number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all streams in a region. +```sql +SELECT +region, +stream_mode_details, +stream_encryption, +arn, +retention_period_hours, +name, +shard_count, +tag_key, +tag_value +FROM aws.kinesis.stream_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_tags resource, see streams + diff --git a/website/docs/services/kinesis/streams/index.md b/website/docs/services/kinesis/streams/index.md new file mode 100644 index 0000000..8ac81a0 --- /dev/null +++ b/website/docs/services/kinesis/streams/index.md @@ -0,0 +1,267 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a stream resource or lists streams in a region + +## Overview + + + + + + + +
Namestreams
TypeResource
DescriptionResource Type definition for AWS::Kinesis::Stream
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThe mode in which the stream is running.
objectWhen specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
stringThe Amazon resource name (ARN) of the Kinesis stream
integerThe number of hours for the data records that are stored in shards to remain accessible.
arrayAn arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
stringThe name of the Kinesis stream.
integerThe number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
stringAWS region.
+ +For more information, see AWS::Kinesis::Stream. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all streams in a region. +```sql +SELECT +region, +stream_mode_details, +stream_encryption, +arn, +retention_period_hours, +tags, +name, +shard_count +FROM aws.kinesis.streams +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual stream. +```sql +SELECT +region, +stream_mode_details, +stream_encryption, +arn, +retention_period_hours, +tags, +name, +shard_count +FROM aws.kinesis.streams +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kinesis.streams ( + StreamModeDetails, + StreamEncryption, + RetentionPeriodHours, + Tags, + Name, + ShardCount, + region +) +SELECT +'{{ StreamModeDetails }}', + '{{ StreamEncryption }}', + '{{ RetentionPeriodHours }}', + '{{ Tags }}', + '{{ Name }}', + '{{ ShardCount }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kinesis.streams ( + StreamModeDetails, + StreamEncryption, + RetentionPeriodHours, + Tags, + Name, + ShardCount, + region +) +SELECT + '{{ StreamModeDetails }}', + '{{ StreamEncryption }}', + '{{ RetentionPeriodHours }}', + '{{ Tags }}', + '{{ Name }}', + '{{ ShardCount }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: stream + props: + - name: StreamModeDetails + value: + StreamMode: '{{ StreamMode }}' + - name: StreamEncryption + value: + EncryptionType: '{{ EncryptionType }}' + KeyId: '{{ KeyId }}' + - name: RetentionPeriodHours + value: '{{ RetentionPeriodHours }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Name + value: '{{ Name }}' + - name: ShardCount + value: '{{ ShardCount }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kinesis.streams +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the streams resource, the following permissions are required: + +### Read +```json +kinesis:DescribeStreamSummary, +kinesis:ListTagsForStream +``` + +### Create +```json +kinesis:EnableEnhancedMonitoring, +kinesis:DescribeStreamSummary, +kinesis:CreateStream, +kinesis:IncreaseStreamRetentionPeriod, +kinesis:StartStreamEncryption, +kinesis:AddTagsToStream, +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 +``` + +### List +```json +kinesis:ListStreams +``` + +### Delete +```json +kinesis:DescribeStreamSummary, +kinesis:DeleteStream, +kinesis:RemoveTagsFromStream +``` diff --git a/website/docs/services/kinesis/streams_list_only/index.md b/website/docs/services/kinesis/streams_list_only/index.md new file mode 100644 index 0000000..b4d0c30 --- /dev/null +++ b/website/docs/services/kinesis/streams_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - streams_list_only + - kinesis + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists streams in a region or regions, for all properties use streams + +## Overview + + + + + + + +
Namestreams_list_only
TypeResource
DescriptionResource Type definition for AWS::Kinesis::Stream
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Kinesis stream.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all streams in a region. +```sql +SELECT +region, +name +FROM aws.kinesis.streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the streams_list_only resource, see streams + diff --git a/website/docs/services/kinesisanalyticsv2/application_tags/index.md b/website/docs/services/kinesisanalyticsv2/application_tags/index.md new file mode 100644 index 0000000..d1d2915 --- /dev/null +++ b/website/docs/services/kinesisanalyticsv2/application_tags/index.md @@ -0,0 +1,91 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - kinesisanalyticsv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionCreates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html).
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
objectUse this parameter to configure the application.
stringThe description of the application.
stringTo create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.
stringThe name of the application.
stringThe runtime environment for the application.
stringSpecifies the IAM role that the application uses to access external resources.
objectSpecifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only.
objectUsed to configure start of maintenance window.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_configuration, +application_description, +application_mode, +application_name, +runtime_environment, +service_execution_role, +run_configuration, +application_maintenance_configuration, +tag_key, +tag_value +FROM aws.kinesisanalyticsv2.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/kinesisanalyticsv2/applications/index.md b/website/docs/services/kinesisanalyticsv2/applications/index.md new file mode 100644 index 0000000..515d058 --- /dev/null +++ b/website/docs/services/kinesisanalyticsv2/applications/index.md @@ -0,0 +1,353 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists 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).
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectUse this parameter to configure the application.
stringThe description of the application.
stringTo create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.
stringThe name of the application.
stringThe runtime environment for the application.
stringSpecifies the IAM role that the application uses to access external resources.
objectSpecifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only.
objectUsed to configure start of maintenance window.
arrayA list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
stringAWS region.
+ +For more information, see AWS::KinesisAnalyticsV2::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +application_configuration, +application_description, +application_mode, +application_name, +runtime_environment, +service_execution_role, +run_configuration, +application_maintenance_configuration, +tags +FROM aws.kinesisanalyticsv2.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```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.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kinesisanalyticsv2.applications ( + RuntimeEnvironment, + ServiceExecutionRole, + region +) +SELECT +'{{ RuntimeEnvironment }}', + '{{ ServiceExecutionRole }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kinesisanalyticsv2.applications ( + ApplicationConfiguration, + ApplicationDescription, + ApplicationMode, + ApplicationName, + RuntimeEnvironment, + ServiceExecutionRole, + RunConfiguration, + ApplicationMaintenanceConfiguration, + Tags, + region +) +SELECT + '{{ ApplicationConfiguration }}', + '{{ ApplicationDescription }}', + '{{ ApplicationMode }}', + '{{ ApplicationName }}', + '{{ RuntimeEnvironment }}', + '{{ ServiceExecutionRole }}', + '{{ RunConfiguration }}', + '{{ ApplicationMaintenanceConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: ApplicationConfiguration + value: + ApplicationCodeConfiguration: + CodeContent: + ZipFileContent: '{{ ZipFileContent }}' + S3ContentLocation: + BucketARN: '{{ BucketARN }}' + FileKey: '{{ FileKey }}' + ObjectVersion: '{{ ObjectVersion }}' + TextContent: '{{ TextContent }}' + CodeContentType: '{{ CodeContentType }}' + ApplicationSnapshotConfiguration: + SnapshotsEnabled: '{{ SnapshotsEnabled }}' + ApplicationSystemRollbackConfiguration: + RollbackEnabled: '{{ RollbackEnabled }}' + EnvironmentProperties: + PropertyGroups: + - PropertyGroupId: '{{ PropertyGroupId }}' + PropertyMap: {} + FlinkApplicationConfiguration: + CheckpointConfiguration: + ConfigurationType: '{{ ConfigurationType }}' + CheckpointingEnabled: '{{ CheckpointingEnabled }}' + CheckpointInterval: '{{ CheckpointInterval }}' + MinPauseBetweenCheckpoints: '{{ MinPauseBetweenCheckpoints }}' + MonitoringConfiguration: + ConfigurationType: '{{ ConfigurationType }}' + MetricsLevel: '{{ MetricsLevel }}' + LogLevel: '{{ LogLevel }}' + ParallelismConfiguration: + ConfigurationType: '{{ ConfigurationType }}' + ParallelismPerKPU: '{{ ParallelismPerKPU }}' + Parallelism: '{{ Parallelism }}' + AutoScalingEnabled: '{{ AutoScalingEnabled }}' + SqlApplicationConfiguration: + Inputs: + - NamePrefix: '{{ NamePrefix }}' + InputSchema: + RecordEncoding: '{{ RecordEncoding }}' + RecordColumns: + - Mapping: '{{ Mapping }}' + Name: '{{ Name }}' + SqlType: '{{ SqlType }}' + RecordFormat: + RecordFormatType: '{{ RecordFormatType }}' + MappingParameters: + CSVMappingParameters: + RecordColumnDelimiter: '{{ RecordColumnDelimiter }}' + RecordRowDelimiter: '{{ RecordRowDelimiter }}' + JSONMappingParameters: + RecordRowPath: '{{ RecordRowPath }}' + KinesisStreamsInput: + ResourceARN: null + KinesisFirehoseInput: + ResourceARN: null + InputProcessingConfiguration: + InputLambdaProcessor: + ResourceARN: null + InputParallelism: + Count: '{{ Count }}' + ZeppelinApplicationConfiguration: + CatalogConfiguration: + GlueDataCatalogConfiguration: + DatabaseARN: null + MonitoringConfiguration: + LogLevel: '{{ LogLevel }}' + DeployAsApplicationConfiguration: + S3ContentLocation: + BucketARN: null + BasePath: '{{ BasePath }}' + CustomArtifactsConfiguration: + - ArtifactType: '{{ ArtifactType }}' + MavenReference: + ArtifactId: '{{ ArtifactId }}' + GroupId: '{{ GroupId }}' + Version: '{{ Version }}' + S3ContentLocation: null + VpcConfigurations: + - SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: ApplicationDescription + value: '{{ ApplicationDescription }}' + - name: ApplicationMode + value: '{{ ApplicationMode }}' + - name: ApplicationName + value: '{{ ApplicationName }}' + - name: RuntimeEnvironment + value: '{{ RuntimeEnvironment }}' + - name: ServiceExecutionRole + value: null + - name: RunConfiguration + value: + ApplicationRestoreConfiguration: + ApplicationRestoreType: '{{ ApplicationRestoreType }}' + SnapshotName: '{{ SnapshotName }}' + FlinkRunConfiguration: + AllowNonRestoredState: '{{ AllowNonRestoredState }}' + - name: ApplicationMaintenanceConfiguration + value: + ApplicationMaintenanceWindowStartTime: '{{ ApplicationMaintenanceWindowStartTime }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kinesisanalyticsv2.applications +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +kinesisanalytics:ListApplications +``` diff --git a/website/docs/services/kinesisanalyticsv2/applications_list_only/index.md b/website/docs/services/kinesisanalyticsv2/applications_list_only/index.md new file mode 100644 index 0000000..a3df5ee --- /dev/null +++ b/website/docs/services/kinesisanalyticsv2/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - kinesisanalyticsv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionCreates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_name +FROM aws.kinesisanalyticsv2.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/kinesisanalyticsv2/index.md b/website/docs/services/kinesisanalyticsv2/index.md new file mode 100644 index 0000000..6aed4cf --- /dev/null +++ b/website/docs/services/kinesisanalyticsv2/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The kinesisanalyticsv2 service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/kinesisfirehose/delivery_stream_tags/index.md b/website/docs/services/kinesisfirehose/delivery_stream_tags/index.md new file mode 100644 index 0000000..1f55ab9 --- /dev/null +++ b/website/docs/services/kinesisfirehose/delivery_stream_tags/index.md @@ -0,0 +1,109 @@ +--- +title: delivery_stream_tags +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_stream_tags + - kinesisfirehose + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for delivery_streams in a region + +## Overview + + + + + + + +
Namedelivery_stream_tags
TypeResource
DescriptionResource Type definition for AWS::KinesisFirehose::DeliveryStream
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
object
object
object
object
object
object
object
object
object
object
object
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all delivery_streams in a region. +```sql +SELECT +region, +arn, +delivery_stream_encryption_configuration_input, +delivery_stream_name, +delivery_stream_type, +elasticsearch_destination_configuration, +amazonopensearchservice_destination_configuration, +amazon_open_search_serverless_destination_configuration, +extended_s3_destination_configuration, +database_source_configuration, +kinesis_stream_source_configuration, +msk_source_configuration, +redshift_destination_configuration, +s3_destination_configuration, +splunk_destination_configuration, +http_endpoint_destination_configuration, +snowflake_destination_configuration, +iceberg_destination_configuration, +tag_key, +tag_value +FROM aws.kinesisfirehose.delivery_stream_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_stream_tags resource, see delivery_streams + diff --git a/website/docs/services/kinesisfirehose/delivery_streams/index.md b/website/docs/services/kinesisfirehose/delivery_streams/index.md new file mode 100644 index 0000000..54afa5f --- /dev/null +++ b/website/docs/services/kinesisfirehose/delivery_streams/index.md @@ -0,0 +1,621 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a delivery_stream resource or lists delivery_streams in a region + +## Overview + + + + + + + +
Namedelivery_streams
TypeResource
DescriptionResource Type definition for AWS::KinesisFirehose::DeliveryStream
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
object
object
object
object
object
object
object
object
object
object
object
object
object
array
stringAWS region.
+ +For more information, see AWS::KinesisFirehose::DeliveryStream. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all delivery_streams in a region. +```sql +SELECT +region, +arn, +delivery_stream_encryption_configuration_input, +delivery_stream_name, +delivery_stream_type, +elasticsearch_destination_configuration, +amazonopensearchservice_destination_configuration, +amazon_open_search_serverless_destination_configuration, +extended_s3_destination_configuration, +database_source_configuration, +kinesis_stream_source_configuration, +msk_source_configuration, +redshift_destination_configuration, +s3_destination_configuration, +splunk_destination_configuration, +http_endpoint_destination_configuration, +snowflake_destination_configuration, +iceberg_destination_configuration, +tags +FROM aws.kinesisfirehose.delivery_streams +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual delivery_stream. +```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, +database_source_configuration, +kinesis_stream_source_configuration, +msk_source_configuration, +redshift_destination_configuration, +s3_destination_configuration, +splunk_destination_configuration, +http_endpoint_destination_configuration, +snowflake_destination_configuration, +iceberg_destination_configuration, +tags +FROM aws.kinesisfirehose.delivery_streams +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new delivery_stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kinesisfirehose.delivery_streams ( + DeliveryStreamEncryptionConfigurationInput, + DeliveryStreamName, + DeliveryStreamType, + ElasticsearchDestinationConfiguration, + AmazonopensearchserviceDestinationConfiguration, + AmazonOpenSearchServerlessDestinationConfiguration, + ExtendedS3DestinationConfiguration, + DatabaseSourceConfiguration, + KinesisStreamSourceConfiguration, + MSKSourceConfiguration, + RedshiftDestinationConfiguration, + S3DestinationConfiguration, + SplunkDestinationConfiguration, + HttpEndpointDestinationConfiguration, + SnowflakeDestinationConfiguration, + IcebergDestinationConfiguration, + Tags, + region +) +SELECT +'{{ DeliveryStreamEncryptionConfigurationInput }}', + '{{ DeliveryStreamName }}', + '{{ DeliveryStreamType }}', + '{{ ElasticsearchDestinationConfiguration }}', + '{{ AmazonopensearchserviceDestinationConfiguration }}', + '{{ AmazonOpenSearchServerlessDestinationConfiguration }}', + '{{ ExtendedS3DestinationConfiguration }}', + '{{ DatabaseSourceConfiguration }}', + '{{ KinesisStreamSourceConfiguration }}', + '{{ MSKSourceConfiguration }}', + '{{ RedshiftDestinationConfiguration }}', + '{{ S3DestinationConfiguration }}', + '{{ SplunkDestinationConfiguration }}', + '{{ HttpEndpointDestinationConfiguration }}', + '{{ SnowflakeDestinationConfiguration }}', + '{{ IcebergDestinationConfiguration }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kinesisfirehose.delivery_streams ( + DeliveryStreamEncryptionConfigurationInput, + DeliveryStreamName, + DeliveryStreamType, + ElasticsearchDestinationConfiguration, + AmazonopensearchserviceDestinationConfiguration, + AmazonOpenSearchServerlessDestinationConfiguration, + ExtendedS3DestinationConfiguration, + DatabaseSourceConfiguration, + KinesisStreamSourceConfiguration, + MSKSourceConfiguration, + RedshiftDestinationConfiguration, + S3DestinationConfiguration, + SplunkDestinationConfiguration, + HttpEndpointDestinationConfiguration, + SnowflakeDestinationConfiguration, + IcebergDestinationConfiguration, + Tags, + region +) +SELECT + '{{ DeliveryStreamEncryptionConfigurationInput }}', + '{{ DeliveryStreamName }}', + '{{ DeliveryStreamType }}', + '{{ ElasticsearchDestinationConfiguration }}', + '{{ AmazonopensearchserviceDestinationConfiguration }}', + '{{ AmazonOpenSearchServerlessDestinationConfiguration }}', + '{{ ExtendedS3DestinationConfiguration }}', + '{{ DatabaseSourceConfiguration }}', + '{{ KinesisStreamSourceConfiguration }}', + '{{ MSKSourceConfiguration }}', + '{{ RedshiftDestinationConfiguration }}', + '{{ S3DestinationConfiguration }}', + '{{ SplunkDestinationConfiguration }}', + '{{ HttpEndpointDestinationConfiguration }}', + '{{ SnowflakeDestinationConfiguration }}', + '{{ IcebergDestinationConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: delivery_stream + props: + - name: DeliveryStreamEncryptionConfigurationInput + value: + KeyARN: '{{ KeyARN }}' + KeyType: '{{ KeyType }}' + - name: DeliveryStreamName + value: '{{ DeliveryStreamName }}' + - name: DeliveryStreamType + value: '{{ DeliveryStreamType }}' + - name: ElasticsearchDestinationConfiguration + value: + BufferingHints: + IntervalInSeconds: '{{ IntervalInSeconds }}' + SizeInMBs: '{{ SizeInMBs }}' + CloudWatchLoggingOptions: + Enabled: '{{ Enabled }}' + LogGroupName: '{{ LogGroupName }}' + LogStreamName: '{{ LogStreamName }}' + DomainARN: '{{ DomainARN }}' + IndexName: '{{ IndexName }}' + IndexRotationPeriod: '{{ IndexRotationPeriod }}' + ProcessingConfiguration: + Enabled: '{{ Enabled }}' + Processors: + - Parameters: + - ParameterName: '{{ ParameterName }}' + ParameterValue: '{{ ParameterValue }}' + Type: '{{ Type }}' + RetryOptions: + DurationInSeconds: '{{ DurationInSeconds }}' + RoleARN: '{{ RoleARN }}' + S3BackupMode: '{{ S3BackupMode }}' + S3Configuration: + BucketARN: '{{ BucketARN }}' + BufferingHints: + IntervalInSeconds: '{{ IntervalInSeconds }}' + SizeInMBs: '{{ SizeInMBs }}' + CloudWatchLoggingOptions: null + CompressionFormat: '{{ CompressionFormat }}' + EncryptionConfiguration: + KMSEncryptionConfig: + AWSKMSKeyARN: '{{ AWSKMSKeyARN }}' + NoEncryptionConfig: '{{ NoEncryptionConfig }}' + ErrorOutputPrefix: '{{ ErrorOutputPrefix }}' + Prefix: '{{ Prefix }}' + RoleARN: '{{ RoleARN }}' + ClusterEndpoint: '{{ ClusterEndpoint }}' + TypeName: '{{ TypeName }}' + VpcConfiguration: + RoleARN: '{{ RoleARN }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + DocumentIdOptions: + DefaultDocumentIdFormat: '{{ DefaultDocumentIdFormat }}' + - name: AmazonopensearchserviceDestinationConfiguration + value: + BufferingHints: + IntervalInSeconds: '{{ IntervalInSeconds }}' + SizeInMBs: '{{ SizeInMBs }}' + CloudWatchLoggingOptions: null + DomainARN: '{{ DomainARN }}' + IndexName: '{{ IndexName }}' + IndexRotationPeriod: '{{ IndexRotationPeriod }}' + ProcessingConfiguration: null + RetryOptions: + DurationInSeconds: '{{ DurationInSeconds }}' + RoleARN: '{{ RoleARN }}' + S3BackupMode: '{{ S3BackupMode }}' + S3Configuration: null + ClusterEndpoint: '{{ ClusterEndpoint }}' + TypeName: '{{ TypeName }}' + VpcConfiguration: null + DocumentIdOptions: null + - name: AmazonOpenSearchServerlessDestinationConfiguration + value: + BufferingHints: + IntervalInSeconds: '{{ IntervalInSeconds }}' + SizeInMBs: '{{ SizeInMBs }}' + CloudWatchLoggingOptions: null + IndexName: '{{ IndexName }}' + ProcessingConfiguration: null + RetryOptions: + DurationInSeconds: '{{ DurationInSeconds }}' + RoleARN: '{{ RoleARN }}' + S3BackupMode: '{{ S3BackupMode }}' + S3Configuration: null + CollectionEndpoint: '{{ CollectionEndpoint }}' + VpcConfiguration: null + - name: ExtendedS3DestinationConfiguration + value: + BucketARN: '{{ BucketARN }}' + BufferingHints: null + CloudWatchLoggingOptions: null + CompressionFormat: '{{ CompressionFormat }}' + CustomTimeZone: '{{ CustomTimeZone }}' + DataFormatConversionConfiguration: + Enabled: '{{ Enabled }}' + InputFormatConfiguration: + Deserializer: + HiveJsonSerDe: + TimestampFormats: + - '{{ TimestampFormats[0] }}' + OpenXJsonSerDe: + CaseInsensitive: '{{ CaseInsensitive }}' + ColumnToJsonKeyMappings: {} + ConvertDotsInJsonKeysToUnderscores: '{{ ConvertDotsInJsonKeysToUnderscores }}' + OutputFormatConfiguration: + Serializer: + OrcSerDe: + BlockSizeBytes: '{{ BlockSizeBytes }}' + BloomFilterColumns: + - '{{ BloomFilterColumns[0] }}' + BloomFilterFalsePositiveProbability: null + Compression: '{{ Compression }}' + DictionaryKeyThreshold: null + EnablePadding: '{{ EnablePadding }}' + FormatVersion: '{{ FormatVersion }}' + PaddingTolerance: null + RowIndexStride: '{{ RowIndexStride }}' + StripeSizeBytes: '{{ StripeSizeBytes }}' + ParquetSerDe: + BlockSizeBytes: '{{ BlockSizeBytes }}' + Compression: '{{ Compression }}' + EnableDictionaryCompression: '{{ EnableDictionaryCompression }}' + MaxPaddingBytes: '{{ MaxPaddingBytes }}' + PageSizeBytes: '{{ PageSizeBytes }}' + WriterVersion: '{{ WriterVersion }}' + SchemaConfiguration: + CatalogId: '{{ CatalogId }}' + DatabaseName: '{{ DatabaseName }}' + Region: '{{ Region }}' + RoleARN: '{{ RoleARN }}' + TableName: '{{ TableName }}' + VersionId: '{{ VersionId }}' + DynamicPartitioningConfiguration: + Enabled: '{{ Enabled }}' + RetryOptions: + DurationInSeconds: '{{ DurationInSeconds }}' + EncryptionConfiguration: null + ErrorOutputPrefix: '{{ ErrorOutputPrefix }}' + FileExtension: '{{ FileExtension }}' + Prefix: '{{ Prefix }}' + ProcessingConfiguration: null + RoleARN: '{{ RoleARN }}' + S3BackupConfiguration: null + S3BackupMode: '{{ S3BackupMode }}' + - name: DatabaseSourceConfiguration + value: + Type: '{{ Type }}' + Endpoint: '{{ Endpoint }}' + Port: '{{ Port }}' + SSLMode: '{{ SSLMode }}' + Databases: + Include: + - '{{ Include[0] }}' + Exclude: + - null + Tables: + Include: + - '{{ Include[0] }}' + Exclude: + - null + Columns: + Include: + - '{{ Include[0] }}' + Exclude: + - null + SurrogateKeys: + - '{{ SurrogateKeys[0] }}' + SnapshotWatermarkTable: null + DatabaseSourceAuthenticationConfiguration: + SecretsManagerConfiguration: + Enabled: '{{ Enabled }}' + RoleARN: '{{ RoleARN }}' + SecretARN: '{{ SecretARN }}' + DatabaseSourceVPCConfiguration: + VpcEndpointServiceName: '{{ VpcEndpointServiceName }}' + Digest: '{{ Digest }}' + PublicCertificate: '{{ PublicCertificate }}' + - name: KinesisStreamSourceConfiguration + value: + KinesisStreamARN: '{{ KinesisStreamARN }}' + RoleARN: '{{ RoleARN }}' + - name: MSKSourceConfiguration + value: + MSKClusterARN: '{{ MSKClusterARN }}' + TopicName: '{{ TopicName }}' + ReadFromTimestamp: '{{ ReadFromTimestamp }}' + AuthenticationConfiguration: + RoleARN: '{{ RoleARN }}' + Connectivity: '{{ Connectivity }}' + - name: RedshiftDestinationConfiguration + value: + CloudWatchLoggingOptions: null + ClusterJDBCURL: '{{ ClusterJDBCURL }}' + CopyCommand: + CopyOptions: '{{ CopyOptions }}' + DataTableColumns: '{{ DataTableColumns }}' + DataTableName: '{{ DataTableName }}' + Password: '{{ Password }}' + ProcessingConfiguration: null + RetryOptions: + DurationInSeconds: '{{ DurationInSeconds }}' + RoleARN: '{{ RoleARN }}' + S3BackupConfiguration: null + S3BackupMode: '{{ S3BackupMode }}' + S3Configuration: null + SecretsManagerConfiguration: null + Username: '{{ Username }}' + - name: S3DestinationConfiguration + value: null + - name: SplunkDestinationConfiguration + value: + CloudWatchLoggingOptions: null + HECAcknowledgmentTimeoutInSeconds: '{{ HECAcknowledgmentTimeoutInSeconds }}' + HECEndpoint: '{{ HECEndpoint }}' + HECEndpointType: '{{ HECEndpointType }}' + HECToken: '{{ HECToken }}' + ProcessingConfiguration: null + RetryOptions: + DurationInSeconds: '{{ DurationInSeconds }}' + S3BackupMode: '{{ S3BackupMode }}' + S3Configuration: null + SecretsManagerConfiguration: null + BufferingHints: + IntervalInSeconds: '{{ IntervalInSeconds }}' + SizeInMBs: '{{ SizeInMBs }}' + - name: HttpEndpointDestinationConfiguration + value: + RoleARN: '{{ RoleARN }}' + EndpointConfiguration: + Url: '{{ Url }}' + AccessKey: '{{ AccessKey }}' + Name: '{{ Name }}' + RequestConfiguration: + ContentEncoding: '{{ ContentEncoding }}' + CommonAttributes: + - AttributeName: '{{ AttributeName }}' + AttributeValue: '{{ AttributeValue }}' + BufferingHints: null + CloudWatchLoggingOptions: null + ProcessingConfiguration: null + RetryOptions: null + S3BackupMode: '{{ S3BackupMode }}' + S3Configuration: null + SecretsManagerConfiguration: null + - name: SnowflakeDestinationConfiguration + value: + AccountUrl: '{{ AccountUrl }}' + PrivateKey: '{{ PrivateKey }}' + KeyPassphrase: '{{ KeyPassphrase }}' + User: '{{ User }}' + Database: '{{ Database }}' + Schema: '{{ Schema }}' + Table: '{{ Table }}' + SnowflakeRoleConfiguration: + Enabled: '{{ Enabled }}' + SnowflakeRole: '{{ SnowflakeRole }}' + DataLoadingOption: '{{ DataLoadingOption }}' + MetaDataColumnName: '{{ MetaDataColumnName }}' + ContentColumnName: '{{ ContentColumnName }}' + SnowflakeVpcConfiguration: + PrivateLinkVpceId: '{{ PrivateLinkVpceId }}' + CloudWatchLoggingOptions: null + ProcessingConfiguration: null + RoleARN: '{{ RoleARN }}' + RetryOptions: + DurationInSeconds: '{{ DurationInSeconds }}' + S3BackupMode: '{{ S3BackupMode }}' + S3Configuration: null + SecretsManagerConfiguration: null + BufferingHints: + IntervalInSeconds: '{{ IntervalInSeconds }}' + SizeInMBs: '{{ SizeInMBs }}' + - name: IcebergDestinationConfiguration + value: + DestinationTableConfigurationList: + - DestinationTableName: '{{ DestinationTableName }}' + DestinationDatabaseName: '{{ DestinationDatabaseName }}' + S3ErrorOutputPrefix: '{{ S3ErrorOutputPrefix }}' + UniqueKeys: + - '{{ UniqueKeys[0] }}' + ProcessingConfiguration: null + CloudWatchLoggingOptions: null + CatalogConfiguration: + CatalogArn: '{{ CatalogArn }}' + RoleARN: '{{ RoleARN }}' + RetryOptions: null + s3BackupMode: '{{ s3BackupMode }}' + BufferingHints: null + S3Configuration: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kinesisfirehose.delivery_streams +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +firehose:ListDeliveryStreams +``` diff --git a/website/docs/services/kinesisfirehose/delivery_streams_list_only/index.md b/website/docs/services/kinesisfirehose/delivery_streams_list_only/index.md new file mode 100644 index 0000000..a723a81 --- /dev/null +++ b/website/docs/services/kinesisfirehose/delivery_streams_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: delivery_streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_streams_list_only + - kinesisfirehose + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists delivery_streams in a region or regions, for all properties use delivery_streams + +## Overview + + + + + + + +
Namedelivery_streams_list_only
TypeResource
DescriptionResource Type definition for AWS::KinesisFirehose::DeliveryStream
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all delivery_streams in a region. +```sql +SELECT +region, +delivery_stream_name +FROM aws.kinesisfirehose.delivery_streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_streams_list_only resource, see delivery_streams + diff --git a/website/docs/services/kinesisfirehose/index.md b/website/docs/services/kinesisfirehose/index.md new file mode 100644 index 0000000..931ad31 --- /dev/null +++ b/website/docs/services/kinesisfirehose/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The kinesisfirehose service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/kinesisvideo/index.md b/website/docs/services/kinesisvideo/index.md new file mode 100644 index 0000000..b84523d --- /dev/null +++ b/website/docs/services/kinesisvideo/index.md @@ -0,0 +1,37 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The kinesisvideo service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/kinesisvideo/signaling_channels/index.md b/website/docs/services/kinesisvideo/signaling_channels/index.md new file mode 100644 index 0000000..734f34a --- /dev/null +++ b/website/docs/services/kinesisvideo/signaling_channels/index.md @@ -0,0 +1,202 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a signaling_channel resource or lists signaling_channels in a region + +## Overview + + + + + + + +
Namesignaling_channels
TypeResource
DescriptionResource Type Definition for AWS::KinesisVideo::SignalingChannel
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel.
stringThe name of the Kinesis Video Signaling Channel.
stringThe type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.
integerThe period of time a signaling channel retains undelivered messages before they are discarded.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::KinesisVideo::SignalingChannel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual signaling_channel. +```sql +SELECT +region, +arn, +name, +type, +message_ttl_seconds, +tags +FROM aws.kinesisvideo.signaling_channels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new signaling_channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kinesisvideo.signaling_channels ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kinesisvideo.signaling_channels ( + Name, + Type, + MessageTtlSeconds, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Type }}', + '{{ MessageTtlSeconds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: signaling_channel + props: + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: MessageTtlSeconds + value: '{{ MessageTtlSeconds }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kinesisvideo.signaling_channels +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the signaling_channels resource, the following permissions are required: + +### Create +```json +kinesisvideo:CreateSignalingChannel, +kinesisvideo:DescribeSignalingChannel +``` + +### Read +```json +kinesisvideo:DescribeSignalingChannel +``` + +### Update +```json +kinesisvideo:UpdateSignalingChannel, +kinesisvideo:DescribeSignalingChannel +``` + +### Delete +```json +kinesisvideo:DeleteSignalingChannel, +kinesisvideo:DescribeSignalingChannel +``` diff --git a/website/docs/services/kinesisvideo/streams/index.md b/website/docs/services/kinesisvideo/streams/index.md new file mode 100644 index 0000000..9937239 --- /dev/null +++ b/website/docs/services/kinesisvideo/streams/index.md @@ -0,0 +1,215 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a stream resource or lists streams in a region + +## Overview + + + + + + + +
Namestreams
TypeResource
DescriptionResource Type Definition for AWS::KinesisVideo::Stream
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Kinesis Video stream.
stringThe name of the Kinesis Video stream.
integerThe number of hours till which Kinesis Video will retain the data in the stream
stringThe name of the device that is writing to the stream.
stringAWS KMS key ID that Kinesis Video Streams uses to encrypt stream data.
stringThe media type of the stream. Consumers of the stream can use this information when processing the stream.
arrayAn array of key-value pairs associated with the Kinesis Video Stream.
stringAWS region.
+ +For more information, see AWS::KinesisVideo::Stream. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual stream. +```sql +SELECT +region, +arn, +name, +data_retention_in_hours, +device_name, +kms_key_id, +media_type, +tags +FROM aws.kinesisvideo.streams +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kinesisvideo.streams ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kinesisvideo.streams ( + Name, + DataRetentionInHours, + DeviceName, + KmsKeyId, + MediaType, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ DataRetentionInHours }}', + '{{ DeviceName }}', + '{{ KmsKeyId }}', + '{{ MediaType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: stream + props: + - name: Name + value: '{{ Name }}' + - name: DataRetentionInHours + value: '{{ DataRetentionInHours }}' + - name: DeviceName + value: '{{ DeviceName }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: MediaType + value: '{{ MediaType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kinesisvideo.streams +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the streams resource, the following permissions are required: + +### Create +```json +kinesisvideo:DescribeStream, +kinesisvideo:CreateStream +``` + +### Read +```json +kinesisvideo:DescribeStream +``` + +### Update +```json +kinesisvideo:DescribeStream, +kinesisvideo:UpdateStream, +kinesisvideo:UpdateDataRetention +``` + +### Delete +```json +kinesisvideo:DescribeStream, +kinesisvideo:DeleteStream +``` diff --git a/website/docs/services/kms/aliases/index.md b/website/docs/services/kms/aliases/index.md new file mode 100644 index 0000000..86f0bdc --- /dev/null +++ b/website/docs/services/kms/aliases/index.md @@ -0,0 +1,203 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an alias resource or lists 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).
Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.
Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS-Regions. For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *Developer Guide*.
When specifying an alias, observe the following rules.
+ Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key.
+ The alias and its associated KMS key must be in the same AWS-account and Region.
+ The alias name must be unique in the AWS-account and Region. However, you can create aliases with the same name in different AWS-Regions. For example, you can have an alias/projectKey in multiple Regions, each of which is associated with a KMS key in its Region.
+ Each alias name must begin with alias/ followed by a name, such as alias/exampleKey. The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with alias/aws/. That alias name prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).

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

To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html).
stringSpecifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.
If you change the value of the AliasName property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).
The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
stringAWS region.
+ +For more information, see AWS::KMS::Alias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all aliases in a region. +```sql +SELECT +region, +target_key_id, +alias_name +FROM aws.kms.aliases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual alias. +```sql +SELECT +region, +target_key_id, +alias_name +FROM aws.kms.aliases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kms.aliases ( + TargetKeyId, + AliasName, + region +) +SELECT +'{{ TargetKeyId }}', + '{{ AliasName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kms.aliases ( + TargetKeyId, + AliasName, + region +) +SELECT + '{{ TargetKeyId }}', + '{{ AliasName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: alias + props: + - name: TargetKeyId + value: '{{ TargetKeyId }}' + - name: AliasName + value: '{{ AliasName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kms.aliases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the aliases resource, the following permissions are required: + +### Read +```json +kms:ListAliases +``` + +### Create +```json +kms:CreateAlias +``` + +### Update +```json +kms:UpdateAlias +``` + +### List +```json +kms:ListAliases +``` + +### Delete +```json +kms:DeleteAlias +``` diff --git a/website/docs/services/kms/aliases_list_only/index.md b/website/docs/services/kms/aliases_list_only/index.md new file mode 100644 index 0000000..e6dac97 --- /dev/null +++ b/website/docs/services/kms/aliases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - aliases_list_only + - kms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists aliases in a region or regions, for all properties use aliases + +## Overview + + + + + + + +
Namealiases_list_only
TypeResource
DescriptionThe AWS::KMS::Alias resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).
Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.
Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS-Regions. For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *Developer Guide*.
When specifying an alias, observe the following rules.
+ Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key.
+ The alias and its associated KMS key must be in the same AWS-account and Region.
+ The alias name must be unique in the AWS-account and Region. However, you can create aliases with the same name in different AWS-Regions. For example, you can have an alias/projectKey in multiple Regions, each of which is associated with a KMS key in its Region.
+ Each alias name must begin with alias/ followed by a name, such as alias/exampleKey. The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with alias/aws/. That alias name prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).

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

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

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

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

+ Asymmetric RSA key pairs (encryption and decryption *or* signing and verification)
+ RSA_2048
+ RSA_3072
+ RSA_4096

+ Asymmetric NIST-recommended elliptic curve key pairs (signing and verification *or* deriving shared secrets)
+ ECC_NIST_P256 (secp256r1)
+ ECC_NIST_P384 (secp384r1)
+ ECC_NIST_P521 (secp521r1)

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

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

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

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

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

+ Asymmetric RSA key pairs (encryption and decryption *or* signing and verification)
+ RSA_2048
+ RSA_3072
+ RSA_4096

+ Asymmetric NIST-recommended elliptic curve key pairs (signing and verification *or* deriving shared secrets)
+ ECC_NIST_P256 (secp256r1)
+ ECC_NIST_P384 (secp384r1)
+ ECC_NIST_P521 (secp521r1)

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

+ SM2 key pairs (encryption and decryption *or* signing and verification *or* deriving shared secrets)
+ SM2 (China Regions only)
booleanCreates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the MultiRegion value after the KMS key is created.
For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **.
If you change the value of the MultiRegion property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.
For a multi-Region key, set to this property to true. For a single-Region key, omit this property or set it to false. The default value is false.
*Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.
You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.
integerSpecifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The PendingWindowInDays property determines the length of waiting period. During the waiting period, the key state of KMS key is Pending Deletion or Pending Replica Deletion, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key.
KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to PendingReplicaDeletion so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to PendingDeletion and the waiting period specified by PendingWindowInDays begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*.
You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.
For information about the Pending Deletion and Pending Replica Deletion key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*.
arrayAssigns one or more tags to the replica key.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.
For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
string
string
booleanSkips ("bypasses") the key policy lockout safety check. The default value is false.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key.
integerSpecifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days.
The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.
You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the RotationPeriodInDays parameter.
For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.
stringAWS region.
+ +For more information, see AWS::KMS::Key. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all keys in a region. +```sql +SELECT +region, +description, +enabled, +enable_key_rotation, +key_policy, +key_usage, +origin, +key_spec, +multi_region, +pending_window_in_days, +tags, +arn, +key_id, +bypass_policy_lockout_safety_check, +rotation_period_in_days +FROM aws.kms.keys +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual key. +```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.keys +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kms.keys ( + Description, + Enabled, + EnableKeyRotation, + KeyPolicy, + KeyUsage, + Origin, + KeySpec, + MultiRegion, + PendingWindowInDays, + Tags, + BypassPolicyLockoutSafetyCheck, + RotationPeriodInDays, + region +) +SELECT +'{{ Description }}', + '{{ Enabled }}', + '{{ EnableKeyRotation }}', + '{{ KeyPolicy }}', + '{{ KeyUsage }}', + '{{ Origin }}', + '{{ KeySpec }}', + '{{ MultiRegion }}', + '{{ PendingWindowInDays }}', + '{{ Tags }}', + '{{ BypassPolicyLockoutSafetyCheck }}', + '{{ RotationPeriodInDays }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kms.keys ( + Description, + Enabled, + EnableKeyRotation, + KeyPolicy, + KeyUsage, + Origin, + KeySpec, + MultiRegion, + PendingWindowInDays, + Tags, + BypassPolicyLockoutSafetyCheck, + RotationPeriodInDays, + region +) +SELECT + '{{ Description }}', + '{{ Enabled }}', + '{{ EnableKeyRotation }}', + '{{ KeyPolicy }}', + '{{ KeyUsage }}', + '{{ Origin }}', + '{{ KeySpec }}', + '{{ MultiRegion }}', + '{{ PendingWindowInDays }}', + '{{ Tags }}', + '{{ BypassPolicyLockoutSafetyCheck }}', + '{{ RotationPeriodInDays }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: key + props: + - name: Description + value: '{{ Description }}' + - name: Enabled + value: '{{ Enabled }}' + - name: EnableKeyRotation + value: '{{ EnableKeyRotation }}' + - name: KeyPolicy + value: {} + - name: KeyUsage + value: '{{ KeyUsage }}' + - name: Origin + value: '{{ Origin }}' + - name: KeySpec + value: '{{ KeySpec }}' + - name: MultiRegion + value: '{{ MultiRegion }}' + - name: PendingWindowInDays + value: '{{ PendingWindowInDays }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: BypassPolicyLockoutSafetyCheck + value: '{{ BypassPolicyLockoutSafetyCheck }}' + - name: RotationPeriodInDays + value: '{{ RotationPeriodInDays }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kms.keys +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +kms:ListKeys, +kms:DescribeKey +``` diff --git a/website/docs/services/kms/keys_list_only/index.md b/website/docs/services/kms/keys_list_only/index.md new file mode 100644 index 0000000..d90fdae --- /dev/null +++ b/website/docs/services/kms/keys_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - keys_list_only + - kms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists keys in a region or regions, for all properties use keys + +## Overview + + + + + + + +
Namekeys_list_only
TypeResource
DescriptionThe AWS::KMS::Key resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use AWS::KMS::Key to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the AWS::KMS::ReplicaKey resource.
If you change the value of the KeySpec, KeyUsage, Origin, or MultiRegion properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values.
KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*.
You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric KeySpec value and a KeyUsage value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*.
You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC KeySpec value and a KeyUsage value of GENERATE_VERIFY_MAC. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*.
You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the MultiRegion property to true. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.
You cannot use the AWS::KMS::Key resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).
*Regions*
KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the AWS::KMS::Key resource to create and manage all KMS key types that are supported in a Region.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all keys in a region. +```sql +SELECT +region, +key_id +FROM aws.kms.keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the keys_list_only resource, see keys + diff --git a/website/docs/services/kms/replica_key_tags/index.md b/website/docs/services/kms/replica_key_tags/index.md new file mode 100644 index 0000000..4f9c366 --- /dev/null +++ b/website/docs/services/kms/replica_key_tags/index.md @@ -0,0 +1,89 @@ +--- +title: replica_key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - replica_key_tags + - kms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for replica_keys in a region + +## Overview + + + + + + + +
Namereplica_key_tags
TypeResource
DescriptionThe AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
integerSpecifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
objectThe key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
stringIdentifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
booleanSpecifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all replica_keys in a region. +```sql +SELECT +region, +description, +pending_window_in_days, +key_policy, +primary_key_arn, +enabled, +key_id, +arn, +tag_key, +tag_value +FROM aws.kms.replica_key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replica_key_tags resource, see replica_keys + diff --git a/website/docs/services/kms/replica_keys/index.md b/website/docs/services/kms/replica_keys/index.md new file mode 100644 index 0000000..45c7211 --- /dev/null +++ b/website/docs/services/kms/replica_keys/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a replica_key resource or lists 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).
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringA description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
integerSpecifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
objectThe key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
stringIdentifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
booleanSpecifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::KMS::ReplicaKey. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all replica_keys in a region. +```sql +SELECT +region, +description, +pending_window_in_days, +key_policy, +primary_key_arn, +enabled, +key_id, +arn, +tags +FROM aws.kms.replica_keys +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual replica_key. +```sql +SELECT +region, +description, +pending_window_in_days, +key_policy, +primary_key_arn, +enabled, +key_id, +arn, +tags +FROM aws.kms.replica_keys +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new replica_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.kms.replica_keys ( + KeyPolicy, + PrimaryKeyArn, + region +) +SELECT +'{{ KeyPolicy }}', + '{{ PrimaryKeyArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.kms.replica_keys ( + Description, + PendingWindowInDays, + KeyPolicy, + PrimaryKeyArn, + Enabled, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ PendingWindowInDays }}', + '{{ KeyPolicy }}', + '{{ PrimaryKeyArn }}', + '{{ Enabled }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: replica_key + props: + - name: Description + value: '{{ Description }}' + - name: PendingWindowInDays + value: '{{ PendingWindowInDays }}' + - name: KeyPolicy + value: {} + - name: PrimaryKeyArn + value: '{{ PrimaryKeyArn }}' + - name: Enabled + value: '{{ Enabled }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.kms.replica_keys +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the replica_keys resource, the following permissions are required: + +### Read +```json +kms:DescribeKey, +kms:GetKeyPolicy, +kms:ListResourceTags +``` + +### Create +```json +kms:ReplicateKey, +kms:CreateKey, +kms:DescribeKey, +kms:DisableKey, +kms:TagResource +``` + +### Update +```json +kms:DescribeKey, +kms:DisableKey, +kms:EnableKey, +kms:PutKeyPolicy, +kms:TagResource, +kms:UntagResource, +kms:UpdateKeyDescription +``` + +### List +```json +kms:ListKeys, +kms:DescribeKey +``` + +### Delete +```json +kms:DescribeKey, +kms:ScheduleKeyDeletion +``` diff --git a/website/docs/services/kms/replica_keys_list_only/index.md b/website/docs/services/kms/replica_keys_list_only/index.md new file mode 100644 index 0000000..fd3f210 --- /dev/null +++ b/website/docs/services/kms/replica_keys_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: replica_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - replica_keys_list_only + - kms + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists replica_keys in a region or regions, for all properties use replica_keys + +## Overview + + + + + + + +
Namereplica_keys_list_only
TypeResource
DescriptionThe AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all replica_keys in a region. +```sql +SELECT +region, +key_id +FROM aws.kms.replica_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replica_keys_list_only resource, see replica_keys + diff --git a/website/docs/services/lakeformation/data_cells_filters/index.md b/website/docs/services/lakeformation/data_cells_filters/index.md new file mode 100644 index 0000000..8adb867 --- /dev/null +++ b/website/docs/services/lakeformation/data_cells_filters/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_cells_filter resource or lists data_cells_filters in a region + +## Overview + + + + + + + +
Namedata_cells_filters
TypeResource
DescriptionA resource schema representing a Lake Formation Data Cells Filter.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Catalog Id of the Table on which to create a Data Cells Filter.
stringThe name of the Database that the Table resides in.
stringThe name of the Table to create a Data Cells Filter for.
stringThe desired name of the Data Cells Filter.
objectAn object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required
arrayA list of columns to be included in this Data Cells Filter.
objectAn object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
stringAWS region.
+ +For more information, see AWS::LakeFormation::DataCellsFilter. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_cells_filters in a region. +```sql +SELECT +region, +table_catalog_id, +database_name, +table_name, +name, +row_filter, +column_names, +column_wildcard +FROM aws.lakeformation.data_cells_filters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_cells_filter. +```sql +SELECT +region, +table_catalog_id, +database_name, +table_name, +name, +row_filter, +column_names, +column_wildcard +FROM aws.lakeformation.data_cells_filters +WHERE region = 'us-east-1' AND data__Identifier = '|||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_cells_filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lakeformation.data_cells_filters ( + TableCatalogId, + DatabaseName, + TableName, + Name, + region +) +SELECT +'{{ TableCatalogId }}', + '{{ DatabaseName }}', + '{{ TableName }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lakeformation.data_cells_filters ( + TableCatalogId, + DatabaseName, + TableName, + Name, + RowFilter, + ColumnNames, + ColumnWildcard, + region +) +SELECT + '{{ TableCatalogId }}', + '{{ DatabaseName }}', + '{{ TableName }}', + '{{ Name }}', + '{{ RowFilter }}', + '{{ ColumnNames }}', + '{{ ColumnWildcard }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_cells_filter + props: + - name: TableCatalogId + value: '{{ TableCatalogId }}' + - name: DatabaseName + value: '{{ DatabaseName }}' + - name: TableName + value: null + - name: Name + value: null + - name: RowFilter + value: + FilterExpression: '{{ FilterExpression }}' + AllRowsWildcard: {} + - name: ColumnNames + value: + - null + - name: ColumnWildcard + value: + ExcludedColumnNames: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lakeformation.data_cells_filters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the data_cells_filters resource, the following permissions are required: + +### Create +```json +lakeformation:CreateDataCellsFilter, +glue:GetTable +``` + +### Delete +```json +lakeformation:DeleteDataCellsFilter +``` + +### Read +```json +lakeformation:ListDataCellsFilter +``` + +### List +```json +lakeformation:ListDataCellsFilter +``` diff --git a/website/docs/services/lakeformation/data_cells_filters_list_only/index.md b/website/docs/services/lakeformation/data_cells_filters_list_only/index.md new file mode 100644 index 0000000..e9c666b --- /dev/null +++ b/website/docs/services/lakeformation/data_cells_filters_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: data_cells_filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_cells_filters_list_only + - lakeformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_cells_filters in a region or regions, for all properties use data_cells_filters + +## Overview + + + + + + + +
Namedata_cells_filters_list_only
TypeResource
DescriptionA resource schema representing a Lake Formation Data Cells Filter.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Catalog Id of the Table on which to create a Data Cells Filter.
stringThe name of the Database that the Table resides in.
stringThe name of the Table to create a Data Cells Filter for.
stringThe desired name of the Data Cells Filter.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_cells_filters in a region. +```sql +SELECT +region, +table_catalog_id, +database_name, +table_name, +name +FROM aws.lakeformation.data_cells_filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_cells_filters_list_only resource, see data_cells_filters + diff --git a/website/docs/services/lakeformation/index.md b/website/docs/services/lakeformation/index.md new file mode 100644 index 0000000..740c890 --- /dev/null +++ b/website/docs/services/lakeformation/index.md @@ -0,0 +1,41 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The lakeformation service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/lakeformation/principal_permissions/index.md b/website/docs/services/lakeformation/principal_permissions/index.md new file mode 100644 index 0000000..6fa7376 --- /dev/null +++ b/website/docs/services/lakeformation/principal_permissions/index.md @@ -0,0 +1,226 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a principal_permission resource or lists principal_permissions in a region + +## 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.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe 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.
objectThe principal to be granted a permission.
objectThe resource to be granted or revoked permissions.
arrayThe permissions granted or revoked.
arrayIndicates the ability to grant permissions (as a subset of permissions granted).
string
string
stringAWS region.
+ +For more information, see AWS::LakeFormation::PrincipalPermissions. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual principal_permission. +```sql +SELECT +region, +catalog, +principal, +resource, +permissions, +permissions_with_grant_option, +principal_identifier, +resource_identifier +FROM aws.lakeformation.principal_permissions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new principal_permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lakeformation.principal_permissions ( + Principal, + Resource, + Permissions, + PermissionsWithGrantOption, + region +) +SELECT +'{{ Principal }}', + '{{ Resource }}', + '{{ Permissions }}', + '{{ PermissionsWithGrantOption }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lakeformation.principal_permissions ( + Catalog, + Principal, + Resource, + Permissions, + PermissionsWithGrantOption, + region +) +SELECT + '{{ Catalog }}', + '{{ Principal }}', + '{{ Resource }}', + '{{ Permissions }}', + '{{ PermissionsWithGrantOption }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: principal_permission + props: + - name: Catalog + value: '{{ Catalog }}' + - name: Principal + value: + DataLakePrincipalIdentifier: '{{ DataLakePrincipalIdentifier }}' + - name: Resource + value: + Catalog: {} + Database: + CatalogId: null + Name: '{{ Name }}' + Table: + CatalogId: null + DatabaseName: null + Name: null + TableWildcard: {} + TableWithColumns: + CatalogId: null + DatabaseName: null + Name: null + ColumnNames: + - null + - name: Permissions + value: + - '{{ Permissions[0] }}' + - name: PermissionsWithGrantOption + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lakeformation.principal_permissions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the principal_permissions resource, the following permissions are required: + +### Create +```json +lakeformation:GrantPermissions, +lakeformation:ListPermissions, +glue:GetTable, +glue:GetDatabase +``` + +### Read +```json +lakeformation:ListPermissions, +glue:GetTable, +glue:GetDatabase +``` + +### Delete +```json +lakeformation:RevokePermissions, +lakeformation:ListPermissions, +glue:GetTable, +glue:GetDatabase +``` diff --git a/website/docs/services/lakeformation/tag_associations/index.md b/website/docs/services/lakeformation/tag_associations/index.md new file mode 100644 index 0000000..65a2e8e --- /dev/null +++ b/website/docs/services/lakeformation/tag_associations/index.md @@ -0,0 +1,204 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a tag_association resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectResource to tag with the Lake Formation Tags
arrayList of Lake Formation Tags to associate with the Lake Formation Resource
stringUnique string identifying the resource. Used as primary identifier, which ideally should be a string
stringUnique string identifying the resource's tags. Used as primary identifier, which ideally should be a string
stringAWS region.
+ +For more information, see AWS::LakeFormation::TagAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual tag_association. +```sql +SELECT +region, +resource, +lf_tags, +resource_identifier, +tags_identifier +FROM aws.lakeformation.tag_associations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tag_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lakeformation.tag_associations ( + Resource, + LFTags, + region +) +SELECT +'{{ Resource }}', + '{{ LFTags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lakeformation.tag_associations ( + Resource, + LFTags, + region +) +SELECT + '{{ Resource }}', + '{{ LFTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: tag_association + props: + - name: Resource + value: + Catalog: {} + Database: + CatalogId: '{{ CatalogId }}' + Name: '{{ Name }}' + Table: + CatalogId: null + DatabaseName: null + Name: null + TableWildcard: {} + TableWithColumns: + CatalogId: null + DatabaseName: null + Name: null + ColumnNames: + - null + - name: LFTags + value: + - CatalogId: null + TagKey: '{{ TagKey }}' + TagValues: + - '{{ TagValues[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lakeformation.tag_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lakeformation:GetResourceLFTags, +glue:GetDatabase, +glue:GetTable +``` + +### Delete +```json +lakeformation:RemoveLFTagsFromResource, +glue:GetDatabase, +glue:GetTable +``` diff --git a/website/docs/services/lakeformation/tags/index.md b/website/docs/services/lakeformation/tags/index.md new file mode 100644 index 0000000..fed8c01 --- /dev/null +++ b/website/docs/services/lakeformation/tags/index.md @@ -0,0 +1,211 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a tag resource or lists tags in a region + +## Overview + + + + + + + +
Nametags
TypeResource
DescriptionA resource schema representing a Lake Formation Tag.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
stringThe key-name for the LF-tag.
arrayA list of possible values an attribute can take.
stringAWS region.
+ +For more information, see AWS::LakeFormation::Tag. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all tags in a region. +```sql +SELECT +region, +catalog_id, +tag_key, +tag_values +FROM aws.lakeformation.tags +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual tag. +```sql +SELECT +region, +catalog_id, +tag_key, +tag_values +FROM aws.lakeformation.tags +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tag resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lakeformation.tags ( + TagKey, + TagValues, + region +) +SELECT +'{{ TagKey }}', + '{{ TagValues }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lakeformation.tags ( + CatalogId, + TagKey, + TagValues, + region +) +SELECT + '{{ CatalogId }}', + '{{ TagKey }}', + '{{ TagValues }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: tag + props: + - name: CatalogId + value: '{{ CatalogId }}' + - name: TagKey + value: '{{ TagKey }}' + - name: TagValues + value: + - '{{ TagValues[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lakeformation.tags +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the tags resource, the following permissions are required: + +### Create +```json +lakeformation:CreateLFTag +``` + +### Read +```json +lakeformation:GetLFTag +``` + +### Update +```json +lakeformation:UpdateLFTag +``` + +### Delete +```json +lakeformation:DeleteLFTag +``` + +### List +```json +lakeformation:ListLFTags +``` diff --git a/website/docs/services/lakeformation/tags_list_only/index.md b/website/docs/services/lakeformation/tags_list_only/index.md new file mode 100644 index 0000000..8b0aa1e --- /dev/null +++ b/website/docs/services/lakeformation/tags_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: tags_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tags_list_only + - lakeformation + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tags in a region or regions, for all properties use tags + +## Overview + + + + + + + +
Nametags_list_only
TypeResource
DescriptionA resource schema representing a Lake Formation Tag.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe key-name for the LF-tag.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tags in a region. +```sql +SELECT +region, +tag_key +FROM aws.lakeformation.tags_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tags_list_only resource, see tags + diff --git a/website/docs/services/lambda/aliases/index.md b/website/docs/services/lambda/aliases/index.md new file mode 100644 index 0000000..f808ffe --- /dev/null +++ b/website/docs/services/lambda/aliases/index.md @@ -0,0 +1,253 @@ +--- +title: aliases +hide_title: false +hide_table_of_contents: false +keywords: + - aliases + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an alias resource or lists aliases in a region + +## Overview + + + + + + + +
Namealiases
TypeResource
DescriptionResource Type definition for AWS::Lambda::Alias
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Lambda function.
stringLambda Alias ARN generated by the service.
objectSpecifies a provisioned concurrency configuration for a function's alias.
stringA description of the alias.
stringThe function version that the alias invokes.
objectThe routing configuration of the alias.
stringThe name of the alias.
stringAWS region.
+ +For more information, see AWS::Lambda::Alias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all aliases in a region. +```sql +SELECT +region, +function_name, +alias_arn, +provisioned_concurrency_config, +description, +function_version, +routing_config, +name +FROM aws.lambda.aliases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual alias. +```sql +SELECT +region, +function_name, +alias_arn, +provisioned_concurrency_config, +description, +function_version, +routing_config, +name +FROM aws.lambda.aliases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.aliases ( + FunctionName, + FunctionVersion, + Name, + region +) +SELECT +'{{ FunctionName }}', + '{{ FunctionVersion }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.aliases ( + FunctionName, + ProvisionedConcurrencyConfig, + Description, + FunctionVersion, + RoutingConfig, + Name, + region +) +SELECT + '{{ FunctionName }}', + '{{ ProvisionedConcurrencyConfig }}', + '{{ Description }}', + '{{ FunctionVersion }}', + '{{ RoutingConfig }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: alias + props: + - name: FunctionName + value: '{{ FunctionName }}' + - name: ProvisionedConcurrencyConfig + value: + ProvisionedConcurrentExecutions: '{{ ProvisionedConcurrentExecutions }}' + - name: Description + value: '{{ Description }}' + - name: FunctionVersion + value: '{{ FunctionVersion }}' + - name: RoutingConfig + value: + AdditionalVersionWeights: + - FunctionWeight: null + FunctionVersion: '{{ FunctionVersion }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lambda.aliases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the aliases resource, the following permissions are required: + +### Create +```json +lambda:CreateAlias, +lambda:PutProvisionedConcurrencyConfig, +lambda:GetProvisionedConcurrencyConfig +``` + +### Read +```json +lambda:GetAlias, +lambda:GetProvisionedConcurrencyConfig +``` + +### Delete +```json +lambda:DeleteAlias, +lambda:GetAlias +``` + +### List +```json +lambda:ListAliases +``` + +### Update +```json +lambda:UpdateAlias, +lambda:GetAlias, +lambda:PutProvisionedConcurrencyConfig, +lambda:DeleteProvisionedConcurrencyConfig, +lambda:GetProvisionedConcurrencyConfig, +codedeploy:CreateDeployment, +codedeploy:GetDeployment, +codedeploy:GetDeploymentGroup, +codedeploy:GetDeploymentConfig, +codedeploy:StopDeployment +``` diff --git a/website/docs/services/lambda/aliases_list_only/index.md b/website/docs/services/lambda/aliases_list_only/index.md new file mode 100644 index 0000000..2229131 --- /dev/null +++ b/website/docs/services/lambda/aliases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - aliases_list_only + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists aliases in a region or regions, for all properties use aliases + +## Overview + + + + + + + +
Namealiases_list_only
TypeResource
DescriptionResource Type definition for AWS::Lambda::Alias
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringLambda Alias ARN generated by the service.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all aliases in a region. +```sql +SELECT +region, +alias_arn +FROM aws.lambda.aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the aliases_list_only resource, see aliases + diff --git a/website/docs/services/lambda/code_signing_config_tags/index.md b/website/docs/services/lambda/code_signing_config_tags/index.md new file mode 100644 index 0000000..b6e14e2 --- /dev/null +++ b/website/docs/services/lambda/code_signing_config_tags/index.md @@ -0,0 +1,85 @@ +--- +title: code_signing_config_tags +hide_title: false +hide_table_of_contents: false +keywords: + - code_signing_config_tags + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for code_signing_configs in a region + +## Overview + + + + + + + +
Namecode_signing_config_tags
TypeResource
DescriptionResource Type definition for AWS::Lambda::CodeSigningConfig.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA description of the CodeSigningConfig
objectWhen the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list
objectPolicies to control how to act if a signature is invalid
stringA unique identifier for CodeSigningConfig resource
stringA unique Arn for CodeSigningConfig resource
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all code_signing_configs in a region. +```sql +SELECT +region, +description, +allowed_publishers, +code_signing_policies, +code_signing_config_id, +code_signing_config_arn, +tag_key, +tag_value +FROM aws.lambda.code_signing_config_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the code_signing_config_tags resource, see code_signing_configs + diff --git a/website/docs/services/lambda/code_signing_configs/index.md b/website/docs/services/lambda/code_signing_configs/index.md new file mode 100644 index 0000000..94ffa5d --- /dev/null +++ b/website/docs/services/lambda/code_signing_configs/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a code_signing_config resource or lists code_signing_configs in a region + +## Overview + + + + + + + +
Namecode_signing_configs
TypeResource
DescriptionResource Type definition for AWS::Lambda::CodeSigningConfig.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA description of the CodeSigningConfig
objectWhen the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list
objectPolicies to control how to act if a signature is invalid
stringA unique identifier for CodeSigningConfig resource
stringA unique Arn for CodeSigningConfig resource
arrayA list of tags to apply to CodeSigningConfig resource
stringAWS region.
+ +For more information, see AWS::Lambda::CodeSigningConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all code_signing_configs in a region. +```sql +SELECT +region, +description, +allowed_publishers, +code_signing_policies, +code_signing_config_id, +code_signing_config_arn, +tags +FROM aws.lambda.code_signing_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual code_signing_config. +```sql +SELECT +region, +description, +allowed_publishers, +code_signing_policies, +code_signing_config_id, +code_signing_config_arn, +tags +FROM aws.lambda.code_signing_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new code_signing_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.code_signing_configs ( + AllowedPublishers, + region +) +SELECT +'{{ AllowedPublishers }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.code_signing_configs ( + Description, + AllowedPublishers, + CodeSigningPolicies, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ AllowedPublishers }}', + '{{ CodeSigningPolicies }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: code_signing_config + props: + - name: Description + value: '{{ Description }}' + - name: AllowedPublishers + value: + SigningProfileVersionArns: + - '{{ SigningProfileVersionArns[0] }}' + - name: CodeSigningPolicies + value: + UntrustedArtifactOnDeployment: '{{ UntrustedArtifactOnDeployment }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lambda.code_signing_configs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the code_signing_configs resource, the following permissions are required: + +### Create +```json +lambda:CreateCodeSigningConfig, +lambda:TagResource +``` + +### Read +```json +lambda:GetCodeSigningConfig, +lambda:ListTags +``` + +### Update +```json +lambda:UpdateCodeSigningConfig, +lambda:ListTags, +lambda:TagResource, +lambda:UntagResource +``` + +### Delete +```json +lambda:DeleteCodeSigningConfig +``` + +### List +```json +lambda:ListCodeSigningConfigs +``` diff --git a/website/docs/services/lambda/code_signing_configs_list_only/index.md b/website/docs/services/lambda/code_signing_configs_list_only/index.md new file mode 100644 index 0000000..d5567df --- /dev/null +++ b/website/docs/services/lambda/code_signing_configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: code_signing_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - code_signing_configs_list_only + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists code_signing_configs in a region or regions, for all properties use code_signing_configs + +## Overview + + + + + + + +
Namecode_signing_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::Lambda::CodeSigningConfig.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique Arn for CodeSigningConfig resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all code_signing_configs in a region. +```sql +SELECT +region, +code_signing_config_arn +FROM aws.lambda.code_signing_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the code_signing_configs_list_only resource, see code_signing_configs + diff --git a/website/docs/services/lambda/event_invoke_configs/index.md b/website/docs/services/lambda/event_invoke_configs/index.md new file mode 100644 index 0000000..fd00678 --- /dev/null +++ b/website/docs/services/lambda/event_invoke_configs/index.md @@ -0,0 +1,226 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_invoke_config resource or lists 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.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
objectA configuration object that specifies the destination of an event after Lambda processes it.
stringThe name of the Lambda function.
integerThe maximum age of a request that Lambda sends to a function for processing.
integerThe maximum number of times to retry when the function returns an error.
stringThe identifier of a version or alias.
stringAWS region.
+ +For more information, see AWS::Lambda::EventInvokeConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_invoke_configs in a region. +```sql +SELECT +region, +destination_config, +function_name, +maximum_event_age_in_seconds, +maximum_retry_attempts, +qualifier +FROM aws.lambda.event_invoke_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_invoke_config. +```sql +SELECT +region, +destination_config, +function_name, +maximum_event_age_in_seconds, +maximum_retry_attempts, +qualifier +FROM aws.lambda.event_invoke_configs +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_invoke_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.event_invoke_configs ( + FunctionName, + Qualifier, + region +) +SELECT +'{{ FunctionName }}', + '{{ Qualifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.event_invoke_configs ( + DestinationConfig, + FunctionName, + MaximumEventAgeInSeconds, + MaximumRetryAttempts, + Qualifier, + region +) +SELECT + '{{ DestinationConfig }}', + '{{ FunctionName }}', + '{{ MaximumEventAgeInSeconds }}', + '{{ MaximumRetryAttempts }}', + '{{ Qualifier }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_invoke_config + props: + - name: DestinationConfig + value: + OnFailure: + Destination: '{{ Destination }}' + - name: FunctionName + value: '{{ FunctionName }}' + - name: MaximumEventAgeInSeconds + value: '{{ MaximumEventAgeInSeconds }}' + - name: MaximumRetryAttempts + value: '{{ MaximumRetryAttempts }}' + - name: Qualifier + value: '{{ Qualifier }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lambda.event_invoke_configs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the event_invoke_configs resource, the following permissions are required: + +### Create +```json +lambda:PutFunctionEventInvokeConfig +``` + +### Read +```json +lambda:GetFunctionEventInvokeConfig +``` + +### Update +```json +lambda:UpdateFunctionEventInvokeConfig +``` + +### Delete +```json +lambda:DeleteFunctionEventInvokeConfig +``` + +### List +```json +lambda:ListFunctionEventInvokeConfigs +``` diff --git a/website/docs/services/lambda/event_invoke_configs_list_only/index.md b/website/docs/services/lambda/event_invoke_configs_list_only/index.md new file mode 100644 index 0000000..62c7121 --- /dev/null +++ b/website/docs/services/lambda/event_invoke_configs_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: event_invoke_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_invoke_configs_list_only + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_invoke_configs in a region or regions, for all properties use event_invoke_configs + +## Overview + + + + + + + +
Nameevent_invoke_configs_list_only
TypeResource
DescriptionThe AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the Lambda function.
stringThe identifier of a version or alias.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_invoke_configs in a region. +```sql +SELECT +region, +function_name, +qualifier +FROM aws.lambda.event_invoke_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_invoke_configs_list_only resource, see event_invoke_configs + diff --git a/website/docs/services/lambda/event_source_mapping_tags/index.md b/website/docs/services/lambda/event_source_mapping_tags/index.md new file mode 100644 index 0000000..068aba2 --- /dev/null +++ b/website/docs/services/lambda/event_source_mapping_tags/index.md @@ -0,0 +1,131 @@ +--- +title: event_source_mapping_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_source_mapping_tags + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_source_mappings in a region + +## Overview + + + + + + + +
Nameevent_source_mapping_tags
TypeResource
DescriptionThe AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.
For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.
+ [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping)
+ [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping)
+ [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource)
+ [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping)
+ [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)
+ [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)
+ [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html)
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integerThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
+ *Amazon Kinesis* – Default 100. Max 10,000.
+ *Amazon DynamoDB Streams* – Default 100. Max 10,000.
+ *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
+ *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.
+ *Self-managed Apache Kafka* – Default 100. Max 10,000.
+ *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.
+ *DocumentDB* – Default 100. Max 10,000.
boolean(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
object(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
booleanWhen true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
stringThe Amazon Resource Name (ARN) of the event source.
+ *Amazon Kinesis* – The ARN of the data stream or a stream consumer.
+ *Amazon DynamoDB Streams* – The ARN of the stream.
+ *Amazon Simple Queue Service* – The ARN of the queue.
+ *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)).
+ *Amazon MQ* – The ARN of the broker.
+ *Amazon DocumentDB* – The ARN of the DocumentDB change stream.
string
objectAn object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html).
stringThe ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's [filter criteria](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics).
stringThe name or ARN of the Lambda function.
**Name formats**
+ *Function name* – MyFunction.
+ *Function ARN* – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
+ *Version or Alias ARN* – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
+ *Partial ARN* – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
integerThe maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
*Default (, , event sources)*: 0
*Default (, Kafka, , event sources)*: 500 ms
*Related setting:* For SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
integer(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
integer(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
integer(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
stringThe position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.
+ *LATEST* - Read only new records.
+ *TRIM_HORIZON* - Process all available records.
+ *AT_TIMESTAMP* - Specify a time from which to start reading records.
numberWith StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds. StartingPositionTimestamp cannot be in the future.
arrayThe name of the Kafka topic.
array(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
arrayAn array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
integer(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
array(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
Valid Values: ReportBatchItemFailures
objectThe self-managed Apache Kafka cluster for your event source.
objectSpecific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
objectSpecific configuration settings for a self-managed Apache Kafka event source.
object(Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency).
objectSpecific configuration settings for a DocumentDB event source.
object(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see [provisioned mode](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-provisioned-mode).
objectThe metrics configuration for your event source. For more information, see [Event source mapping metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics).
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_source_mappings in a region. +```sql +SELECT +region, +id, +batch_size, +bisect_batch_on_function_error, +destination_config, +enabled, +event_source_arn, +event_source_mapping_arn, +filter_criteria, +kms_key_arn, +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, +provisioned_poller_config, +metrics_config, +tag_key, +tag_value +FROM aws.lambda.event_source_mapping_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_source_mapping_tags resource, see event_source_mappings + diff --git a/website/docs/services/lambda/event_source_mappings/index.md b/website/docs/services/lambda/event_source_mappings/index.md new file mode 100644 index 0000000..4428dc4 --- /dev/null +++ b/website/docs/services/lambda/event_source_mappings/index.md @@ -0,0 +1,422 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_source_mapping resource or lists 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.
For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.
+ [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping)
+ [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping)
+ [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource)
+ [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping)
+ [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)
+ [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)
+ [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html)
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integerThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
+ *Amazon Kinesis* – Default 100. Max 10,000.
+ *Amazon DynamoDB Streams* – Default 100. Max 10,000.
+ *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
+ *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.
+ *Self-managed Apache Kafka* – Default 100. Max 10,000.
+ *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.
+ *DocumentDB* – Default 100. Max 10,000.
boolean(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
object(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
booleanWhen true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
stringThe Amazon Resource Name (ARN) of the event source.
+ *Amazon Kinesis* – The ARN of the data stream or a stream consumer.
+ *Amazon DynamoDB Streams* – The ARN of the stream.
+ *Amazon Simple Queue Service* – The ARN of the queue.
+ *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)).
+ *Amazon MQ* – The ARN of the broker.
+ *Amazon DocumentDB* – The ARN of the DocumentDB change stream.
string
objectAn object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html).
stringThe ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's [filter criteria](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics).
stringThe name or ARN of the Lambda function.
**Name formats**
+ *Function name* – MyFunction.
+ *Function ARN* – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
+ *Version or Alias ARN* – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
+ *Partial ARN* – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
integerThe maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
*Default (, , event sources)*: 0
*Default (, Kafka, , event sources)*: 500 ms
*Related setting:* For SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
integer(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
integer(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
integer(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
stringThe position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.
+ *LATEST* - Read only new records.
+ *TRIM_HORIZON* - Process all available records.
+ *AT_TIMESTAMP* - Specify a time from which to start reading records.
numberWith StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds. StartingPositionTimestamp cannot be in the future.
arrayA list of tags to add to the event source mapping.
You must have the lambda:TagResource, lambda:UntagResource, and lambda:ListTags permissions for your [principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
arrayThe name of the Kafka topic.
array(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
arrayAn array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
integer(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
array(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
Valid Values: ReportBatchItemFailures
objectThe self-managed Apache Kafka cluster for your event source.
objectSpecific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
objectSpecific configuration settings for a self-managed Apache Kafka event source.
object(Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency).
objectSpecific configuration settings for a DocumentDB event source.
object(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see [provisioned mode](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-provisioned-mode).
objectThe metrics configuration for your event source. For more information, see [Event source mapping metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics).
stringAWS region.
+ +For more information, see AWS::Lambda::EventSourceMapping. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_source_mappings in a region. +```sql +SELECT +region, +id, +batch_size, +bisect_batch_on_function_error, +destination_config, +enabled, +event_source_arn, +event_source_mapping_arn, +filter_criteria, +kms_key_arn, +function_name, +maximum_batching_window_in_seconds, +maximum_record_age_in_seconds, +maximum_retry_attempts, +parallelization_factor, +starting_position, +starting_position_timestamp, +tags, +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, +provisioned_poller_config, +metrics_config +FROM aws.lambda.event_source_mappings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_source_mapping. +```sql +SELECT +region, +id, +batch_size, +bisect_batch_on_function_error, +destination_config, +enabled, +event_source_arn, +event_source_mapping_arn, +filter_criteria, +kms_key_arn, +function_name, +maximum_batching_window_in_seconds, +maximum_record_age_in_seconds, +maximum_retry_attempts, +parallelization_factor, +starting_position, +starting_position_timestamp, +tags, +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, +provisioned_poller_config, +metrics_config +FROM aws.lambda.event_source_mappings +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_source_mapping resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.event_source_mappings ( + FunctionName, + region +) +SELECT +'{{ FunctionName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.event_source_mappings ( + BatchSize, + BisectBatchOnFunctionError, + DestinationConfig, + Enabled, + EventSourceArn, + FilterCriteria, + KmsKeyArn, + FunctionName, + MaximumBatchingWindowInSeconds, + MaximumRecordAgeInSeconds, + MaximumRetryAttempts, + ParallelizationFactor, + StartingPosition, + StartingPositionTimestamp, + Tags, + Topics, + Queues, + SourceAccessConfigurations, + TumblingWindowInSeconds, + FunctionResponseTypes, + SelfManagedEventSource, + AmazonManagedKafkaEventSourceConfig, + SelfManagedKafkaEventSourceConfig, + ScalingConfig, + DocumentDBEventSourceConfig, + ProvisionedPollerConfig, + MetricsConfig, + region +) +SELECT + '{{ BatchSize }}', + '{{ BisectBatchOnFunctionError }}', + '{{ DestinationConfig }}', + '{{ Enabled }}', + '{{ EventSourceArn }}', + '{{ FilterCriteria }}', + '{{ KmsKeyArn }}', + '{{ FunctionName }}', + '{{ MaximumBatchingWindowInSeconds }}', + '{{ MaximumRecordAgeInSeconds }}', + '{{ MaximumRetryAttempts }}', + '{{ ParallelizationFactor }}', + '{{ StartingPosition }}', + '{{ StartingPositionTimestamp }}', + '{{ Tags }}', + '{{ Topics }}', + '{{ Queues }}', + '{{ SourceAccessConfigurations }}', + '{{ TumblingWindowInSeconds }}', + '{{ FunctionResponseTypes }}', + '{{ SelfManagedEventSource }}', + '{{ AmazonManagedKafkaEventSourceConfig }}', + '{{ SelfManagedKafkaEventSourceConfig }}', + '{{ ScalingConfig }}', + '{{ DocumentDBEventSourceConfig }}', + '{{ ProvisionedPollerConfig }}', + '{{ MetricsConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_source_mapping + props: + - name: BatchSize + value: '{{ BatchSize }}' + - name: BisectBatchOnFunctionError + value: '{{ BisectBatchOnFunctionError }}' + - name: DestinationConfig + value: + OnFailure: + Destination: '{{ Destination }}' + - name: Enabled + value: '{{ Enabled }}' + - name: EventSourceArn + value: '{{ EventSourceArn }}' + - name: FilterCriteria + value: + Filters: + - Pattern: '{{ Pattern }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: FunctionName + value: '{{ FunctionName }}' + - name: MaximumBatchingWindowInSeconds + value: '{{ MaximumBatchingWindowInSeconds }}' + - name: MaximumRecordAgeInSeconds + value: '{{ MaximumRecordAgeInSeconds }}' + - name: MaximumRetryAttempts + value: '{{ MaximumRetryAttempts }}' + - name: ParallelizationFactor + value: '{{ ParallelizationFactor }}' + - name: StartingPosition + value: '{{ StartingPosition }}' + - name: StartingPositionTimestamp + value: null + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Topics + value: + - '{{ Topics[0] }}' + - name: Queues + value: + - '{{ Queues[0] }}' + - name: SourceAccessConfigurations + value: + - Type: '{{ Type }}' + URI: '{{ URI }}' + - name: TumblingWindowInSeconds + value: '{{ TumblingWindowInSeconds }}' + - name: FunctionResponseTypes + value: + - '{{ FunctionResponseTypes[0] }}' + - name: SelfManagedEventSource + value: + Endpoints: + KafkaBootstrapServers: + - '{{ KafkaBootstrapServers[0] }}' + - name: AmazonManagedKafkaEventSourceConfig + value: + ConsumerGroupId: '{{ ConsumerGroupId }}' + - name: SelfManagedKafkaEventSourceConfig + value: + ConsumerGroupId: null + - name: ScalingConfig + value: + MaximumConcurrency: '{{ MaximumConcurrency }}' + - name: DocumentDBEventSourceConfig + value: + DatabaseName: '{{ DatabaseName }}' + CollectionName: '{{ CollectionName }}' + FullDocument: '{{ FullDocument }}' + - name: ProvisionedPollerConfig + value: + MinimumPollers: '{{ MinimumPollers }}' + MaximumPollers: '{{ MaximumPollers }}' + - name: MetricsConfig + value: + Metrics: + - '{{ Metrics[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lambda.event_source_mappings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the event_source_mappings resource, the following permissions are required: + +### Create +```json +lambda:CreateEventSourceMapping, +lambda:GetEventSourceMapping, +lambda:TagResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +lambda:DeleteEventSourceMapping, +lambda:GetEventSourceMapping, +kms:Decrypt +``` + +### List +```json +lambda:ListEventSourceMappings +``` + +### Read +```json +lambda:GetEventSourceMapping, +lambda:ListTags, +kms:Decrypt +``` + +### Update +```json +lambda:UpdateEventSourceMapping, +lambda:GetEventSourceMapping, +lambda:ListTags, +lambda:TagResource, +lambda:UntagResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` diff --git a/website/docs/services/lambda/event_source_mappings_list_only/index.md b/website/docs/services/lambda/event_source_mappings_list_only/index.md new file mode 100644 index 0000000..a7e562f --- /dev/null +++ b/website/docs/services/lambda/event_source_mappings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: event_source_mappings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_source_mappings_list_only + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_source_mappings in a region or regions, for all properties use event_source_mappings + +## Overview + + + + + + + +
Nameevent_source_mappings_list_only
TypeResource
DescriptionThe AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.
For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.
+ [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping)
+ [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping)
+ [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource)
+ [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping)
+ [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)
+ [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)
+ [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html)
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_source_mappings in a region. +```sql +SELECT +region, +id +FROM aws.lambda.event_source_mappings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_source_mappings_list_only resource, see event_source_mappings + diff --git a/website/docs/services/lambda/function_tags/index.md b/website/docs/services/lambda/function_tags/index.md new file mode 100644 index 0000000..f2a1aa3 --- /dev/null +++ b/website/docs/services/lambda/function_tags/index.md @@ -0,0 +1,129 @@ +--- +title: function_tags +hide_title: false +hide_table_of_contents: false +keywords: + - function_tags + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for functions in a region + +## Overview + + + + + + + +
Namefunction_tags
TypeResource
DescriptionThe AWS::Lambda::Function resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
You set the package type to Image if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For these functions, include the URI of the container image in the ECR registry in the [ImageUri property of the Code property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri). You do not need to specify the handler and runtime properties.
You set the package type to Zip if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For these functions, specify the S3 location of your .zip file in the Code property. Alternatively, for Node.js and Python functions, you can define your function inline in the [ZipFile property of the Code property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile). In both cases, you must also specify the handler and runtime properties.
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.
When you update a AWS::Lambda::Function resource, CFNshort calls the [UpdateFunctionConfiguration](https://docs.aws.amazon.com/lambda/latest/api/API_UpdateFunctionConfiguration.html) and [UpdateFunctionCode](https://docs.aws.amazon.com/lambda/latest/api/API_UpdateFunctionCode.html) LAM APIs under the hood. Because these calls happen sequentially, and invocations can happen between these calls, your function may encounter errors in the time between the calls. For example, if you remove an environment variable, and the code that references that environment variable in the same CFNshort update, you may see invocation errors related to a missing environment variable. To work around this, you can invoke your function against a version or alias by default, rather than the $LATEST version.
Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a AWS::Lambda::Version or a AWS::Lambda::Alias.
For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description of the function.
objectSet Mode to Active to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html).
objectFor network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).
objectSets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).
integerThe number of simultaneous executions to reserve for the function.
objectThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
arrayConnection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.
For more information about using the DependsOn attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).
stringThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringThe identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see [Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels).
For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported).
stringThe ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, LAM also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, LAM 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 ECRlong (ECR). If you don't provide a customer managed key, LAM uses a default service key.
stringThe type of deployment package. Set to Image for container image and set Zip for .zip file archive.
stringTo enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
arrayA list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.
objectConfiguration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).
integerThe amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
objectA dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq).
integerThe amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).
stringThe name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).
objectThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
objectThe code for the function. You can define your function code in multiple ways:
+ For .zip deployment packages, you can specify the S3 location of the .zip file in the S3Bucket, S3Key, and S3ObjectVersion properties.
+ For .zip deployment packages, you can alternatively define the function code inline in the ZipFile property. This method works only for Node.js and Python functions.
+ For container images, specify the URI of your container image in the ECR registry in the ImageUri property.
stringThe Amazon Resource Name (ARN) of the function's execution role.
objectThe function's Amazon CloudWatch Logs configuration settings.
stringThe status of your function's recursive loop detection configuration.
When this value is set to Allowand Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.
When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
objectEnvironment variables that are accessible from function code during execution.
string
objectThe size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
arrayThe instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all functions in a region. +```sql +SELECT +region, +description, +tracing_config, +vpc_config, +runtime_management_config, +reserved_concurrent_executions, +snap_start, +file_system_configs, +function_name, +runtime, +kms_key_arn, +package_type, +code_signing_config_arn, +layers, +image_config, +memory_size, +dead_letter_config, +timeout, +handler, +snap_start_response, +code, +role, +logging_config, +recursive_loop, +environment, +arn, +ephemeral_storage, +architectures, +tag_key, +tag_value +FROM aws.lambda.function_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the function_tags resource, see functions + diff --git a/website/docs/services/lambda/functions/index.md b/website/docs/services/lambda/functions/index.md new file mode 100644 index 0000000..2c8b873 --- /dev/null +++ b/website/docs/services/lambda/functions/index.md @@ -0,0 +1,460 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a function resource or lists 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.
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 these functions, include the URI of the container image in the ECR registry in the [ImageUri property of the Code property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri). You do not need to specify the handler and runtime properties.
You set the package type to Zip if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For these functions, specify the S3 location of your .zip file in the Code property. Alternatively, for Node.js and Python functions, you can define your function inline in the [ZipFile property of the Code property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile). In both cases, you must also specify the handler and runtime properties.
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.
When you update a AWS::Lambda::Function resource, CFNshort calls the [UpdateFunctionConfiguration](https://docs.aws.amazon.com/lambda/latest/api/API_UpdateFunctionConfiguration.html) and [UpdateFunctionCode](https://docs.aws.amazon.com/lambda/latest/api/API_UpdateFunctionCode.html) LAM APIs under the hood. Because these calls happen sequentially, and invocations can happen between these calls, your function may encounter errors in the time between the calls. For example, if you remove an environment variable, and the code that references that environment variable in the same CFNshort update, you may see invocation errors related to a missing environment variable. To work around this, you can invoke your function against a version or alias by default, rather than the $LATEST version.
Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a AWS::Lambda::Version or a AWS::Lambda::Alias.
For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description of the function.
objectSet Mode to Active to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html).
objectFor network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).
objectSets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).
integerThe number of simultaneous executions to reserve for the function.
objectThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
arrayConnection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.
For more information about using the DependsOn attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).
stringThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringThe identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see [Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels).
For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported).
stringThe ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, LAM also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, LAM 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 ECRlong (ECR). If you don't provide a customer managed key, LAM uses a default service key.
stringThe type of deployment package. Set to Image for container image and set Zip for .zip file archive.
stringTo enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
arrayA list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.
arrayA list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
You must have the lambda:TagResource, lambda:UntagResource, and lambda:ListTags permissions for your [principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
objectConfiguration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).
integerThe amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
objectA dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq).
integerThe amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).
stringThe name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).
objectThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
objectThe code for the function. You can define your function code in multiple ways:
+ For .zip deployment packages, you can specify the S3 location of the .zip file in the S3Bucket, S3Key, and S3ObjectVersion properties.
+ For .zip deployment packages, you can alternatively define the function code inline in the ZipFile property. This method works only for Node.js and Python functions.
+ For container images, specify the URI of your container image in the ECR registry in the ImageUri property.
stringThe Amazon Resource Name (ARN) of the function's execution role.
objectThe function's Amazon CloudWatch Logs configuration settings.
stringThe status of your function's recursive loop detection configuration.
When this value is set to Allowand Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.
When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
objectEnvironment variables that are accessible from function code during execution.
string
objectThe size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
arrayThe instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
stringAWS region.
+ +For more information, see AWS::Lambda::Function. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all functions in a region. +```sql +SELECT +region, +description, +tracing_config, +vpc_config, +runtime_management_config, +reserved_concurrent_executions, +snap_start, +file_system_configs, +function_name, +runtime, +kms_key_arn, +package_type, +code_signing_config_arn, +layers, +tags, +image_config, +memory_size, +dead_letter_config, +timeout, +handler, +snap_start_response, +code, +role, +logging_config, +recursive_loop, +environment, +arn, +ephemeral_storage, +architectures +FROM aws.lambda.functions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual function. +```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, +recursive_loop, +environment, +arn, +ephemeral_storage, +architectures +FROM aws.lambda.functions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new function resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.functions ( + Code, + Role, + region +) +SELECT +'{{ Code }}', + '{{ Role }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.functions ( + Description, + TracingConfig, + VpcConfig, + RuntimeManagementConfig, + ReservedConcurrentExecutions, + SnapStart, + FileSystemConfigs, + FunctionName, + Runtime, + KmsKeyArn, + PackageType, + CodeSigningConfigArn, + Layers, + Tags, + ImageConfig, + MemorySize, + DeadLetterConfig, + Timeout, + Handler, + Code, + Role, + LoggingConfig, + RecursiveLoop, + Environment, + EphemeralStorage, + Architectures, + region +) +SELECT + '{{ Description }}', + '{{ TracingConfig }}', + '{{ VpcConfig }}', + '{{ RuntimeManagementConfig }}', + '{{ ReservedConcurrentExecutions }}', + '{{ SnapStart }}', + '{{ FileSystemConfigs }}', + '{{ FunctionName }}', + '{{ Runtime }}', + '{{ KmsKeyArn }}', + '{{ PackageType }}', + '{{ CodeSigningConfigArn }}', + '{{ Layers }}', + '{{ Tags }}', + '{{ ImageConfig }}', + '{{ MemorySize }}', + '{{ DeadLetterConfig }}', + '{{ Timeout }}', + '{{ Handler }}', + '{{ Code }}', + '{{ Role }}', + '{{ LoggingConfig }}', + '{{ RecursiveLoop }}', + '{{ Environment }}', + '{{ EphemeralStorage }}', + '{{ Architectures }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: function + props: + - name: Description + value: '{{ Description }}' + - name: TracingConfig + value: + Mode: '{{ Mode }}' + - name: VpcConfig + value: + Ipv6AllowedForDualStack: '{{ Ipv6AllowedForDualStack }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: RuntimeManagementConfig + value: + UpdateRuntimeOn: '{{ UpdateRuntimeOn }}' + RuntimeVersionArn: '{{ RuntimeVersionArn }}' + - name: ReservedConcurrentExecutions + value: '{{ ReservedConcurrentExecutions }}' + - name: SnapStart + value: + ApplyOn: '{{ ApplyOn }}' + - name: FileSystemConfigs + value: + - Arn: '{{ Arn }}' + LocalMountPath: '{{ LocalMountPath }}' + - name: FunctionName + value: '{{ FunctionName }}' + - name: Runtime + value: '{{ Runtime }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: PackageType + value: '{{ PackageType }}' + - name: CodeSigningConfigArn + value: '{{ CodeSigningConfigArn }}' + - name: Layers + value: + - '{{ Layers[0] }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: ImageConfig + value: + WorkingDirectory: '{{ WorkingDirectory }}' + Command: + - '{{ Command[0] }}' + EntryPoint: + - '{{ EntryPoint[0] }}' + - name: MemorySize + value: '{{ MemorySize }}' + - name: DeadLetterConfig + value: + TargetArn: '{{ TargetArn }}' + - name: Timeout + value: '{{ Timeout }}' + - name: Handler + value: '{{ Handler }}' + - name: Code + value: + SourceKMSKeyArn: '{{ SourceKMSKeyArn }}' + S3ObjectVersion: '{{ S3ObjectVersion }}' + S3Bucket: '{{ S3Bucket }}' + ZipFile: '{{ ZipFile }}' + S3Key: '{{ S3Key }}' + ImageUri: '{{ ImageUri }}' + - name: Role + value: '{{ Role }}' + - name: LoggingConfig + value: + LogFormat: '{{ LogFormat }}' + ApplicationLogLevel: '{{ ApplicationLogLevel }}' + LogGroup: '{{ LogGroup }}' + SystemLogLevel: '{{ SystemLogLevel }}' + - name: RecursiveLoop + value: '{{ RecursiveLoop }}' + - name: Environment + value: + Variables: {} + - name: EphemeralStorage + value: + Size: '{{ Size }}' + - name: Architectures + value: + - '{{ Architectures[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lambda.functions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the functions resource, the following permissions are required: + +### Read +```json +lambda:GetFunction, +lambda:GetFunctionCodeSigningConfig, +lambda:GetFunctionRecursionConfig +``` + +### 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:PutFunctionRecursionConfig, +lambda:GetFunctionRecursionConfig +``` + +### 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:PutFunctionRecursionConfig, +lambda:GetFunctionRecursionConfig +``` + +### List +```json +lambda:ListFunctions +``` + +### Delete +```json +lambda:DeleteFunction, +lambda:GetFunction, +ec2:DescribeNetworkInterfaces +``` diff --git a/website/docs/services/lambda/functions_list_only/index.md b/website/docs/services/lambda/functions_list_only/index.md new file mode 100644 index 0000000..bb9f109 --- /dev/null +++ b/website/docs/services/lambda/functions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: functions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - functions_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists functions in a region or regions, for all properties use functions + +## Overview + + + + + + + +
Namefunctions_list_only
TypeResource
DescriptionThe AWS::Lambda::Function resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
You set the package type to Image if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For these functions, include the URI of the container image in the ECR registry in the [ImageUri property of the Code property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri). You do not need to specify the handler and runtime properties.
You set the package type to Zip if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For these functions, specify the S3 location of your .zip file in the Code property. Alternatively, for Node.js and Python functions, you can define your function inline in the [ZipFile property of the Code property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile). In both cases, you must also specify the handler and runtime properties.
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.
When you update a AWS::Lambda::Function resource, CFNshort calls the [UpdateFunctionConfiguration](https://docs.aws.amazon.com/lambda/latest/api/API_UpdateFunctionConfiguration.html) and [UpdateFunctionCode](https://docs.aws.amazon.com/lambda/latest/api/API_UpdateFunctionCode.html) LAM APIs under the hood. Because these calls happen sequentially, and invocations can happen between these calls, your function may encounter errors in the time between the calls. For example, if you remove an environment variable, and the code that references that environment variable in the same CFNshort update, you may see invocation errors related to a missing environment variable. To work around this, you can invoke your function against a version or alias by default, rather than the $LATEST version.
Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a AWS::Lambda::Version or a AWS::Lambda::Alias.
For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all functions in a region. +```sql +SELECT +region, +function_name +FROM aws.lambda.functions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the functions_list_only resource, see functions + diff --git a/website/docs/services/lambda/index.md b/website/docs/services/lambda/index.md new file mode 100644 index 0000000..9880d93 --- /dev/null +++ b/website/docs/services/lambda/index.md @@ -0,0 +1,58 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The lambda service documentation. + +:::info Service Summary + +
+
+total resources: 23
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/lambda/layer_version_permissions/index.md b/website/docs/services/lambda/layer_version_permissions/index.md new file mode 100644 index 0000000..a6d892a --- /dev/null +++ b/website/docs/services/lambda/layer_version_permissions/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a layer_version_permission resource or lists layer_version_permissions in a region + +## Overview + + + + + + + +
Namelayer_version_permissions
TypeResource
DescriptionSchema for Lambda LayerVersionPermission
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringID generated by service
stringThe API action that grants access to the layer.
stringThe name or Amazon Resource Name (ARN) of the layer.
stringWith the principal set to *, grant permission to all accounts in the specified organization.
stringAn account ID, or * to grant layer usage permission to all accounts in an organization, or all AWS accounts (if organizationId is not specified).
stringAWS region.
+ +For more information, see AWS::Lambda::LayerVersionPermission. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all layer_version_permissions in a region. +```sql +SELECT +region, +id, +action, +layer_version_arn, +organization_id, +principal +FROM aws.lambda.layer_version_permissions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual layer_version_permission. +```sql +SELECT +region, +id, +action, +layer_version_arn, +organization_id, +principal +FROM aws.lambda.layer_version_permissions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new layer_version_permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.layer_version_permissions ( + Action, + LayerVersionArn, + Principal, + region +) +SELECT +'{{ Action }}', + '{{ LayerVersionArn }}', + '{{ Principal }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.layer_version_permissions ( + Action, + LayerVersionArn, + OrganizationId, + Principal, + region +) +SELECT + '{{ Action }}', + '{{ LayerVersionArn }}', + '{{ OrganizationId }}', + '{{ Principal }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: layer_version_permission + props: + - name: Action + value: '{{ Action }}' + - name: LayerVersionArn + value: '{{ LayerVersionArn }}' + - name: OrganizationId + value: '{{ OrganizationId }}' + - name: Principal + value: '{{ Principal }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lambda.layer_version_permissions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the layer_version_permissions resource, the following permissions are required: + +### Create +```json +lambda:AddLayerVersionPermission +``` + +### Read +```json +lambda:GetLayerVersionPolicy +``` + +### Delete +```json +lambda:GetLayerVersionPolicy, +lambda:RemoveLayerVersionPermission +``` + +### List +```json +lambda:GetLayerVersionPolicy +``` diff --git a/website/docs/services/lambda/layer_version_permissions_list_only/index.md b/website/docs/services/lambda/layer_version_permissions_list_only/index.md new file mode 100644 index 0000000..073e74c --- /dev/null +++ b/website/docs/services/lambda/layer_version_permissions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: layer_version_permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - layer_version_permissions_list_only + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists layer_version_permissions in a region or regions, for all properties use layer_version_permissions + +## Overview + + + + + + + +
Namelayer_version_permissions_list_only
TypeResource
DescriptionSchema for Lambda LayerVersionPermission
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringID generated by service
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all layer_version_permissions in a region. +```sql +SELECT +region, +id +FROM aws.lambda.layer_version_permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the layer_version_permissions_list_only resource, see layer_version_permissions + diff --git a/website/docs/services/lambda/layer_versions/index.md b/website/docs/services/lambda/layer_versions/index.md new file mode 100644 index 0000000..f54d1bc --- /dev/null +++ b/website/docs/services/lambda/layer_versions/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a layer_version resource or lists layer_versions in a region + +## Overview + + + + + + + +
Namelayer_versions
TypeResource
DescriptionResource Type definition for AWS::Lambda::LayerVersion
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arrayA list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
stringThe layer's software license.
stringThe description of the version.
stringThe name or Amazon Resource Name (ARN) of the layer.
objectThe function layer archive.
string
arrayA list of compatible instruction set architectures.
stringAWS region.
+ +For more information, see AWS::Lambda::LayerVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all layer_versions in a region. +```sql +SELECT +region, +compatible_runtimes, +license_info, +description, +layer_name, +content, +layer_version_arn, +compatible_architectures +FROM aws.lambda.layer_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual layer_version. +```sql +SELECT +region, +compatible_runtimes, +license_info, +description, +layer_name, +content, +layer_version_arn, +compatible_architectures +FROM aws.lambda.layer_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new layer_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.layer_versions ( + Content, + region +) +SELECT +'{{ Content }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.layer_versions ( + CompatibleRuntimes, + LicenseInfo, + Description, + LayerName, + Content, + CompatibleArchitectures, + region +) +SELECT + '{{ CompatibleRuntimes }}', + '{{ LicenseInfo }}', + '{{ Description }}', + '{{ LayerName }}', + '{{ Content }}', + '{{ CompatibleArchitectures }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: layer_version + props: + - name: CompatibleRuntimes + value: + - '{{ CompatibleRuntimes[0] }}' + - name: LicenseInfo + value: '{{ LicenseInfo }}' + - name: Description + value: '{{ Description }}' + - name: LayerName + value: '{{ LayerName }}' + - name: Content + value: + S3ObjectVersion: '{{ S3ObjectVersion }}' + S3Bucket: '{{ S3Bucket }}' + S3Key: '{{ S3Key }}' + - name: CompatibleArchitectures + value: + - '{{ CompatibleArchitectures[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lambda.layer_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lambda:GetLayerVersion +``` + +### Delete +```json +lambda:GetLayerVersion, +lambda:DeleteLayerVersion +``` + +### List +```json +lambda:ListLayerVersions +``` diff --git a/website/docs/services/lambda/layer_versions_list_only/index.md b/website/docs/services/lambda/layer_versions_list_only/index.md new file mode 100644 index 0000000..f581477 --- /dev/null +++ b/website/docs/services/lambda/layer_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: layer_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - layer_versions_list_only + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists layer_versions in a region or regions, for all properties use layer_versions + +## Overview + + + + + + + +
Namelayer_versions_list_only
TypeResource
DescriptionResource Type definition for AWS::Lambda::LayerVersion
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all layer_versions in a region. +```sql +SELECT +region, +layer_version_arn +FROM aws.lambda.layer_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the layer_versions_list_only resource, see layer_versions + diff --git a/website/docs/services/lambda/permissions/index.md b/website/docs/services/lambda/permissions/index.md new file mode 100644 index 0000000..0092521 --- /dev/null +++ b/website/docs/services/lambda/permissions/index.md @@ -0,0 +1,240 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a permission resource or lists 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.
To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in AOlong, specify the organization ID as the PrincipalOrgID. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
If your function has a function URL, you can specify the FunctionUrlAuthType parameter. This adds a condition to your permission that only applies when your function URL's AuthType matches the specified FunctionUrlAuthType. For more information about the AuthType parameter, see [Security and auth model for function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).
This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html).
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name or ARN of the Lambda function, version, or alias.
**Name formats**
+ *Function name* – my-function (name-only), my-function:v1 (with alias).
+ *Function ARN* – arn:aws:lambda:us-west-2:123456789012:function:my-function.
+ *Partial ARN* – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
stringThe action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.
stringFor Alexa Smart Home functions, a token that the invoker must supply.
stringThe 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).
stringFor AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
Note that Lambda configures the comparison using the StringLike operator.
stringFor AWS-service, the ID of the AWS-account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
stringThe identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.
string
stringThe AWS-service, AWS-account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
stringAWS region.
+ +For more information, see AWS::Lambda::Permission. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all permissions in a region. +```sql +SELECT +region, +function_name, +action, +event_source_token, +function_url_auth_type, +source_arn, +source_account, +principal_org_id, +id, +principal +FROM aws.lambda.permissions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual permission. +```sql +SELECT +region, +function_name, +action, +event_source_token, +function_url_auth_type, +source_arn, +source_account, +principal_org_id, +id, +principal +FROM aws.lambda.permissions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.permissions ( + FunctionName, + Action, + Principal, + region +) +SELECT +'{{ FunctionName }}', + '{{ Action }}', + '{{ Principal }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.permissions ( + FunctionName, + Action, + EventSourceToken, + FunctionUrlAuthType, + SourceArn, + SourceAccount, + PrincipalOrgID, + Principal, + region +) +SELECT + '{{ FunctionName }}', + '{{ Action }}', + '{{ EventSourceToken }}', + '{{ FunctionUrlAuthType }}', + '{{ SourceArn }}', + '{{ SourceAccount }}', + '{{ PrincipalOrgID }}', + '{{ Principal }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: permission + props: + - name: FunctionName + value: '{{ FunctionName }}' + - name: Action + value: '{{ Action }}' + - name: EventSourceToken + value: '{{ EventSourceToken }}' + - name: FunctionUrlAuthType + value: '{{ FunctionUrlAuthType }}' + - name: SourceArn + value: '{{ SourceArn }}' + - name: SourceAccount + value: '{{ SourceAccount }}' + - name: PrincipalOrgID + value: '{{ PrincipalOrgID }}' + - name: Principal + value: '{{ Principal }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lambda.permissions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the permissions resource, the following permissions are required: + +### Read +```json +lambda:GetPolicy +``` + +### Create +```json +lambda:AddPermission +``` + +### List +```json +lambda:GetPolicy +``` + +### Delete +```json +lambda:RemovePermission +``` diff --git a/website/docs/services/lambda/permissions_list_only/index.md b/website/docs/services/lambda/permissions_list_only/index.md new file mode 100644 index 0000000..47974df --- /dev/null +++ b/website/docs/services/lambda/permissions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - permissions_list_only + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists permissions in a region or regions, for all properties use permissions + +## Overview + + + + + + + +
Namepermissions_list_only
TypeResource
DescriptionThe AWS::Lambda::Permission resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in AOlong, specify the organization ID as the PrincipalOrgID. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
If your function has a function URL, you can specify the FunctionUrlAuthType parameter. This adds a condition to your permission that only applies when your function URL's AuthType matches the specified FunctionUrlAuthType. For more information about the AuthType parameter, see [Security and auth model for function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).
This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html).
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name or ARN of the Lambda function, version, or alias.
**Name formats**
+ *Function name* – my-function (name-only), my-function:v1 (with alias).
+ *Function ARN* – arn:aws:lambda:us-west-2:123456789012:function:my-function.
+ *Partial ARN* – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all permissions in a region. +```sql +SELECT +region, +function_name, +id +FROM aws.lambda.permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permissions_list_only resource, see permissions + diff --git a/website/docs/services/lambda/urls/index.md b/website/docs/services/lambda/urls/index.md new file mode 100644 index 0000000..d1d8e1f --- /dev/null +++ b/website/docs/services/lambda/urls/index.md @@ -0,0 +1,240 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an url resource or lists urls in a region + +## Overview + + + + + + + +
Nameurls
TypeResource
DescriptionResource Type definition for AWS::Lambda::Url
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the function associated with the Function URL.
stringThe alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
stringCan be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
stringThe invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.
stringThe full Amazon Resource Name (ARN) of the function associated with the Function URL.
stringThe generated url for this resource.
object
stringAWS region.
+ +For more information, see AWS::Lambda::Url. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all urls in a region. +```sql +SELECT +region, +target_function_arn, +qualifier, +auth_type, +invoke_mode, +function_arn, +function_url, +cors +FROM aws.lambda.urls +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual url. +```sql +SELECT +region, +target_function_arn, +qualifier, +auth_type, +invoke_mode, +function_arn, +function_url, +cors +FROM aws.lambda.urls +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new url resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.urls ( + TargetFunctionArn, + AuthType, + region +) +SELECT +'{{ TargetFunctionArn }}', + '{{ AuthType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.urls ( + TargetFunctionArn, + Qualifier, + AuthType, + InvokeMode, + Cors, + region +) +SELECT + '{{ TargetFunctionArn }}', + '{{ Qualifier }}', + '{{ AuthType }}', + '{{ InvokeMode }}', + '{{ Cors }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: url + props: + - name: TargetFunctionArn + value: '{{ TargetFunctionArn }}' + - name: Qualifier + value: '{{ Qualifier }}' + - name: AuthType + value: '{{ AuthType }}' + - name: InvokeMode + value: '{{ InvokeMode }}' + - name: Cors + value: + AllowCredentials: '{{ AllowCredentials }}' + AllowHeaders: + - '{{ AllowHeaders[0] }}' + AllowMethods: + - '{{ AllowMethods[0] }}' + AllowOrigins: + - '{{ AllowOrigins[0] }}' + ExposeHeaders: + - '{{ ExposeHeaders[0] }}' + MaxAge: '{{ MaxAge }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lambda.urls +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the urls resource, the following permissions are required: + +### Create +```json +lambda:CreateFunctionUrlConfig +``` + +### Read +```json +lambda:GetFunctionUrlConfig +``` + +### Update +```json +lambda:UpdateFunctionUrlConfig +``` + +### List +```json +lambda:ListFunctionUrlConfigs +``` + +### Delete +```json +lambda:DeleteFunctionUrlConfig +``` diff --git a/website/docs/services/lambda/urls_list_only/index.md b/website/docs/services/lambda/urls_list_only/index.md new file mode 100644 index 0000000..3b2e367 --- /dev/null +++ b/website/docs/services/lambda/urls_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: urls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - urls_list_only + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists urls in a region or regions, for all properties use urls + +## Overview + + + + + + + +
Nameurls_list_only
TypeResource
DescriptionResource Type definition for AWS::Lambda::Url
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe full Amazon Resource Name (ARN) of the function associated with the Function URL.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all urls in a region. +```sql +SELECT +region, +function_arn +FROM aws.lambda.urls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the urls_list_only resource, see urls + diff --git a/website/docs/services/lambda/versions/index.md b/website/docs/services/lambda/versions/index.md new file mode 100644 index 0000000..4abbd7e --- /dev/null +++ b/website/docs/services/lambda/versions/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a version resource or lists versions in a region + +## Overview + + + + + + + +
Nameversions
TypeResource
DescriptionResource Type definition for AWS::Lambda::Version
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the version.
stringThe version number.
stringOnly publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property.
stringA description for the version to override the description in the function configuration. Updates are not supported for this property.
stringThe name of the Lambda function.
objectSpecifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property.
objectSpecifies the runtime management configuration of a function. Displays runtimeVersionArn only for Manual.
stringAWS region.
+ +For more information, see AWS::Lambda::Version. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all versions in a region. +```sql +SELECT +region, +function_arn, +version, +code_sha256, +description, +function_name, +provisioned_concurrency_config, +runtime_policy +FROM aws.lambda.versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual version. +```sql +SELECT +region, +function_arn, +version, +code_sha256, +description, +function_name, +provisioned_concurrency_config, +runtime_policy +FROM aws.lambda.versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.versions ( + FunctionName, + region +) +SELECT +'{{ FunctionName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lambda.versions ( + CodeSha256, + Description, + FunctionName, + ProvisionedConcurrencyConfig, + RuntimePolicy, + region +) +SELECT + '{{ CodeSha256 }}', + '{{ Description }}', + '{{ FunctionName }}', + '{{ ProvisionedConcurrencyConfig }}', + '{{ RuntimePolicy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: version + props: + - name: CodeSha256 + value: '{{ CodeSha256 }}' + - name: Description + value: '{{ Description }}' + - name: FunctionName + value: '{{ FunctionName }}' + - name: ProvisionedConcurrencyConfig + value: + ProvisionedConcurrentExecutions: '{{ ProvisionedConcurrentExecutions }}' + - name: RuntimePolicy + value: + RuntimeVersionArn: '{{ RuntimeVersionArn }}' + UpdateRuntimeOn: '{{ UpdateRuntimeOn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lambda.versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lambda:GetFunctionConfiguration, +lambda:GetProvisionedConcurrencyConfig, +lambda:GetRuntimeManagementConfig +``` + +### Delete +```json +lambda:GetFunctionConfiguration, +lambda:DeleteFunction +``` + +### List +```json +lambda:ListVersionsByFunction +``` diff --git a/website/docs/services/lambda/versions_list_only/index.md b/website/docs/services/lambda/versions_list_only/index.md new file mode 100644 index 0000000..81c383d --- /dev/null +++ b/website/docs/services/lambda/versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - versions_list_only + - lambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists versions in a region or regions, for all properties use versions + +## Overview + + + + + + + +
Nameversions_list_only
TypeResource
DescriptionResource Type definition for AWS::Lambda::Version
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all versions in a region. +```sql +SELECT +region, +function_arn +FROM aws.lambda.versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the versions_list_only resource, see versions + diff --git a/website/docs/services/launchwizard/deployment_tags/index.md b/website/docs/services/launchwizard/deployment_tags/index.md new file mode 100644 index 0000000..e13d21a --- /dev/null +++ b/website/docs/services/launchwizard/deployment_tags/index.md @@ -0,0 +1,95 @@ +--- +title: deployment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_tags + - launchwizard + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for deployments in a region + +## Overview + + + + + + + +
Namedeployment_tags
TypeResource
DescriptionDefinition of AWS::LaunchWizard::Deployment Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringARN of the LaunchWizard deployment
stringTimestamp of LaunchWizard deployment creation
stringTimestamp of LaunchWizard deployment deletion
stringDeployment ID of the LaunchWizard deployment
stringWorkload deployment pattern name
stringName of LaunchWizard deployment
stringResource Group Name created for LaunchWizard deployment
objectLaunchWizard deployment specifications
stringStatus of LaunchWizard deployment
stringWorkload Name for LaunchWizard deployment
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all deployments in a region. +```sql +SELECT +region, +arn, +created_at, +deleted_at, +deployment_id, +deployment_pattern_name, +name, +resource_group, +specifications, +status, +workload_name, +tag_key, +tag_value +FROM aws.launchwizard.deployment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployment_tags resource, see deployments + diff --git a/website/docs/services/launchwizard/deployments/index.md b/website/docs/services/launchwizard/deployments/index.md new file mode 100644 index 0000000..446c0c9 --- /dev/null +++ b/website/docs/services/launchwizard/deployments/index.md @@ -0,0 +1,316 @@ +--- +title: deployments +hide_title: false +hide_table_of_contents: false +keywords: + - deployments + - launchwizard + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a deployment resource or lists deployments in a region + +## Overview + + + + + + + +
Namedeployments
TypeResource
DescriptionDefinition of AWS::LaunchWizard::Deployment Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringARN of the LaunchWizard deployment
stringTimestamp of LaunchWizard deployment creation
stringTimestamp of LaunchWizard deployment deletion
stringDeployment ID of the LaunchWizard deployment
stringWorkload deployment pattern name
stringName of LaunchWizard deployment
stringResource Group Name created for LaunchWizard deployment
objectLaunchWizard deployment specifications
stringStatus of LaunchWizard deployment
arrayTags for LaunchWizard deployment
stringWorkload Name for LaunchWizard deployment
stringAWS region.
+ +For more information, see AWS::LaunchWizard::Deployment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all deployments in a region. +```sql +SELECT +region, +arn, +created_at, +deleted_at, +deployment_id, +deployment_pattern_name, +name, +resource_group, +specifications, +status, +tags, +workload_name +FROM aws.launchwizard.deployments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual deployment. +```sql +SELECT +region, +arn, +created_at, +deleted_at, +deployment_id, +deployment_pattern_name, +name, +resource_group, +specifications, +status, +tags, +workload_name +FROM aws.launchwizard.deployments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new deployment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.launchwizard.deployments ( + DeploymentPatternName, + Name, + Specifications, + WorkloadName, + region +) +SELECT +'{{ DeploymentPatternName }}', + '{{ Name }}', + '{{ Specifications }}', + '{{ WorkloadName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.launchwizard.deployments ( + DeploymentPatternName, + Name, + Specifications, + Tags, + WorkloadName, + region +) +SELECT + '{{ DeploymentPatternName }}', + '{{ Name }}', + '{{ Specifications }}', + '{{ Tags }}', + '{{ WorkloadName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: deployment + props: + - name: DeploymentPatternName + value: '{{ DeploymentPatternName }}' + - name: Name + value: '{{ Name }}' + - name: Specifications + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: WorkloadName + value: '{{ WorkloadName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.launchwizard.deployments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Create +```json +launchwizard:CreateDeployment, +launchwizard:GetDeployment, +launchwizard:ListDeploymentEvents, +launchwizard:ListTagsForResource, +launchwizard:TagResource, +ssm:GetParameter, +ssm:PutParameter, +ssm:DescribeParameters, +ssm:AddTagsToResource, +ssm:DeleteParameter, +secretsmanager:DescribeSecret, +secretsmanager:PutSecretValue, +secretsmanager:CreateSecret, +secretsmanager:TagResource, +secretsmanager:UpdateSecret, +resource-groups:CreateGroup, +resource-groups:DeleteGroup, +cloudformation:DeleteStack, +cloudformation:DescribeStackResources, +cloudformation:DescribeStackResource, +cloudformation:DescribeStacks, +cloudformation:DescribeStackEvents, +cloudformation:CreateStack, +cloudformation:TagResource, +s3:PutObject, +s3:GetObject, +s3:CreateBucket, +sns:ListSubscriptionsByTopic, +sns:Publish, +sns:ListSubscriptions, +sns:ListTopics, +sns:CreateTopic, +sns:Subscribe, +sns:Unsubscribe, +sqs:TagQueue, +sqs:GetQueueUrl, +sqs:AddPermission, +sqs:ListQueues, +sqs:GetQueueAttributes, +sqs:ListQueueTags, +sqs:CreateQueue, +sqs:SetQueueAttributes +``` + +### Read +```json +launchwizard:GetDeployment, +launchwizard:ListDeploymentEvents, +launchwizard:ListTagsForResource +``` + +### Delete +```json +launchwizard:GetDeployment, +launchwizard:DeleteDeployment, +launchwizard:UntagResource, +ssm:DeleteParameter, +secretsmanager:DeleteSecret, +resource-groups:DeleteGroup, +cloudformation:DeleteStack, +cloudformation:DescribeStacks, +ssm:GetParameter, +sns:ListSubscriptionsByTopic, +sns:Publish, +sns:ListSubscriptions, +sns:ListTopics, +sns:CreateTopic, +sns:DeleteTopic, +sns:Subscribe, +sns:Unsubscribe, +sqs:GetQueueUrl, +sqs:ListQueues, +sqs:DeleteQueue, +sqs:GetQueueAttributes, +sqs:ListQueueTags +``` + +### Update +```json +launchwizard:GetDeployment, +launchwizard:ListTagsForResource, +launchwizard:TagResource, +launchwizard:UntagResource +``` + +### List +```json +launchwizard:ListDeployments, +launchwizard:ListTagsForResource +``` diff --git a/website/docs/services/launchwizard/deployments_list_only/index.md b/website/docs/services/launchwizard/deployments_list_only/index.md new file mode 100644 index 0000000..512c10b --- /dev/null +++ b/website/docs/services/launchwizard/deployments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: deployments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_list_only + - launchwizard + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployments in a region or regions, for all properties use deployments + +## Overview + + + + + + + +
Namedeployments_list_only
TypeResource
DescriptionDefinition of AWS::LaunchWizard::Deployment Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringARN of the LaunchWizard deployment
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployments in a region. +```sql +SELECT +region, +arn +FROM aws.launchwizard.deployments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployments_list_only resource, see deployments + diff --git a/website/docs/services/launchwizard/index.md b/website/docs/services/launchwizard/index.md new file mode 100644 index 0000000..807b383 --- /dev/null +++ b/website/docs/services/launchwizard/index.md @@ -0,0 +1,38 @@ +--- +title: launchwizard +hide_title: false +hide_table_of_contents: false +keywords: + - launchwizard + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The launchwizard service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/lex/bot_aliases/index.md b/website/docs/services/lex/bot_aliases/index.md new file mode 100644 index 0000000..2e12989 --- /dev/null +++ b/website/docs/services/lex/bot_aliases/index.md @@ -0,0 +1,288 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bot_alias resource or lists 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
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of resource
stringUnique ID of resource
string
string
arrayA list of bot alias locale settings to add to the bot alias.
stringA unique identifier for a resource.
objectA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.
objectContains information about code hooks that Amazon Lex calls during a conversation.
stringA description of the version. Use the description to help identify the version in lists.
objectDetermines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
arrayA list of tags to add to the bot alias.
stringAWS region.
+ +For more information, see AWS::Lex::BotAlias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all bot_aliases in a region. +```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_aliases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual bot_alias. +```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_aliases +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bot_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lex.bot_aliases ( + BotId, + BotAliasName, + region +) +SELECT +'{{ BotId }}', + '{{ BotAliasName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lex.bot_aliases ( + BotId, + BotAliasLocaleSettings, + BotAliasName, + BotVersion, + ConversationLogSettings, + Description, + SentimentAnalysisSettings, + BotAliasTags, + region +) +SELECT + '{{ BotId }}', + '{{ BotAliasLocaleSettings }}', + '{{ BotAliasName }}', + '{{ BotVersion }}', + '{{ ConversationLogSettings }}', + '{{ Description }}', + '{{ SentimentAnalysisSettings }}', + '{{ BotAliasTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bot_alias + props: + - name: BotId + value: '{{ BotId }}' + - name: BotAliasLocaleSettings + value: + - LocaleId: '{{ LocaleId }}' + BotAliasLocaleSetting: + CodeHookSpecification: + LambdaCodeHook: + CodeHookInterfaceVersion: '{{ CodeHookInterfaceVersion }}' + LambdaArn: '{{ LambdaArn }}' + Enabled: '{{ Enabled }}' + - name: BotAliasName + value: '{{ BotAliasName }}' + - name: BotVersion + value: + BotId: null + Description: '{{ Description }}' + BotVersionLocaleSpecification: + - LocaleId: '{{ LocaleId }}' + BotVersionLocaleDetails: + SourceBotVersion: null + - name: ConversationLogSettings + value: + AudioLogSettings: + - Destination: + S3Bucket: + S3BucketArn: '{{ S3BucketArn }}' + LogPrefix: '{{ LogPrefix }}' + KmsKeyArn: '{{ KmsKeyArn }}' + Enabled: '{{ Enabled }}' + TextLogSettings: + - Destination: + CloudWatch: + CloudWatchLogGroupArn: '{{ CloudWatchLogGroupArn }}' + LogPrefix: '{{ LogPrefix }}' + Enabled: '{{ Enabled }}' + - name: Description + value: null + - name: SentimentAnalysisSettings + value: + DetectSentiment: '{{ DetectSentiment }}' + - name: BotAliasTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lex.bot_aliases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the bot_aliases resource, the following permissions are required: + +### Create +```json +lex:CreateBotAlias, +lex:DescribeBot +``` + +### Update +```json +lex:UpdateBotAlias, +lex:DescribeBotAlias, +lex:ListTagsForResource, +lex:TagResource, +lex:UntagResource +``` + +### Read +```json +lex:DescribeBotAlias +``` + +### Delete +```json +lex:DeleteBotAlias +``` + +### List +```json +lex:ListBotAliases +``` diff --git a/website/docs/services/lex/bot_aliases_list_only/index.md b/website/docs/services/lex/bot_aliases_list_only/index.md new file mode 100644 index 0000000..31ff2be --- /dev/null +++ b/website/docs/services/lex/bot_aliases_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: bot_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bot_aliases_list_only + - lex + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bot_aliases in a region or regions, for all properties use bot_aliases + +## Overview + + + + + + + +
Namebot_aliases_list_only
TypeResource
DescriptionA Bot Alias enables you to change the version of a bot without updating applications that use the bot
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringUnique ID of resource
stringUnique ID of resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bot_aliases in a region. +```sql +SELECT +region, +bot_alias_id, +bot_id +FROM aws.lex.bot_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bot_aliases_list_only resource, see bot_aliases + diff --git a/website/docs/services/lex/bot_versions/index.md b/website/docs/services/lex/bot_versions/index.md new file mode 100644 index 0000000..a72cab3 --- /dev/null +++ b/website/docs/services/lex/bot_versions/index.md @@ -0,0 +1,214 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bot_version resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringUnique ID of resource
objectA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.
stringA description of the version. Use the description to help identify the version in lists.
arraySpecifies the locales that Amazon Lex adds to this version. You can choose the Draft version or any other previously published version for each locale.
stringAWS region.
+ +For more information, see AWS::Lex::BotVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all bot_versions in a region. +```sql +SELECT +region, +bot_id, +bot_version, +description, +bot_version_locale_specification +FROM aws.lex.bot_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual bot_version. +```sql +SELECT +region, +bot_id, +bot_version, +description, +bot_version_locale_specification +FROM aws.lex.bot_versions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bot_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lex.bot_versions ( + BotId, + BotVersionLocaleSpecification, + region +) +SELECT +'{{ BotId }}', + '{{ BotVersionLocaleSpecification }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lex.bot_versions ( + BotId, + Description, + BotVersionLocaleSpecification, + region +) +SELECT + '{{ BotId }}', + '{{ Description }}', + '{{ BotVersionLocaleSpecification }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bot_version + props: + - name: BotId + value: '{{ BotId }}' + - name: Description + value: '{{ Description }}' + - name: BotVersionLocaleSpecification + value: + - LocaleId: '{{ LocaleId }}' + BotVersionLocaleDetails: + SourceBotVersion: + BotId: null + Description: null + BotVersionLocaleSpecification: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lex.bot_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lex:DescribeBotVersion +``` + +### Delete +```json +lex:DeleteBotVersion, +lex:DescribeBotVersion +``` + +### List +```json +lex:ListBotVersions +``` diff --git a/website/docs/services/lex/bot_versions_list_only/index.md b/website/docs/services/lex/bot_versions_list_only/index.md new file mode 100644 index 0000000..261b2ac --- /dev/null +++ b/website/docs/services/lex/bot_versions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: bot_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bot_versions_list_only + - lex + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bot_versions in a region or regions, for all properties use bot_versions + +## Overview + + + + + + + +
Namebot_versions_list_only
TypeResource
DescriptionA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringUnique ID of resource
objectA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bot_versions in a region. +```sql +SELECT +region, +bot_id, +bot_version +FROM aws.lex.bot_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bot_versions_list_only resource, see bot_versions + diff --git a/website/docs/services/lex/bots/index.md b/website/docs/services/lex/bots/index.md new file mode 100644 index 0000000..74912fd --- /dev/null +++ b/website/docs/services/lex/bots/index.md @@ -0,0 +1,596 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bot resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of resource
string
stringA unique identifier for a resource.
stringA description of the version. Use the description to help identify the version in lists.
stringThe Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
objectData privacy setting of the Bot.
integerIdleSessionTTLInSeconds of the resource
arrayList of bot locales
objectS3 location of bot definitions zip file, if it's not defined inline in CloudFormation.
arrayA list of tags to add to the bot, which can only be added at bot creation.
arrayA list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation.
booleanSpecifies whether to build the bot locales after bot creation completes.
objectConfiguring the test bot alias settings for a given bot
objectParameter used to create a replication of the source bot in the secondary region.
stringAWS region.
+ +For more information, see AWS::Lex::Bot. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all bots in a region. +```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, +replication +FROM aws.lex.bots +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual bot. +```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, +replication +FROM aws.lex.bots +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bot resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lex.bots ( + Name, + RoleArn, + DataPrivacy, + IdleSessionTTLInSeconds, + region +) +SELECT +'{{ Name }}', + '{{ RoleArn }}', + '{{ DataPrivacy }}', + '{{ IdleSessionTTLInSeconds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lex.bots ( + Name, + Description, + RoleArn, + DataPrivacy, + IdleSessionTTLInSeconds, + BotLocales, + BotFileS3Location, + BotTags, + TestBotAliasTags, + AutoBuildBotLocales, + TestBotAliasSettings, + Replication, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ RoleArn }}', + '{{ DataPrivacy }}', + '{{ IdleSessionTTLInSeconds }}', + '{{ BotLocales }}', + '{{ BotFileS3Location }}', + '{{ BotTags }}', + '{{ TestBotAliasTags }}', + '{{ AutoBuildBotLocales }}', + '{{ TestBotAliasSettings }}', + '{{ Replication }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bot + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: DataPrivacy + value: + ChildDirected: '{{ ChildDirected }}' + - name: IdleSessionTTLInSeconds + value: '{{ IdleSessionTTLInSeconds }}' + - name: BotLocales + value: + - LocaleId: '{{ LocaleId }}' + Description: null + VoiceSettings: + VoiceId: '{{ VoiceId }}' + Engine: '{{ Engine }}' + NluConfidenceThreshold: null + Intents: + - Name: null + Description: null + ParentIntentSignature: '{{ ParentIntentSignature }}' + SampleUtterances: + - Utterance: '{{ Utterance }}' + DialogCodeHook: + Enabled: '{{ Enabled }}' + FulfillmentCodeHook: + FulfillmentUpdatesSpecification: + StartResponse: + MessageGroups: + - Message: + PlainTextMessage: + Value: '{{ Value }}' + CustomPayload: + Value: '{{ Value }}' + SSMLMessage: + Value: '{{ Value }}' + ImageResponseCard: + Title: '{{ Title }}' + Subtitle: null + ImageUrl: '{{ ImageUrl }}' + Buttons: + - Text: '{{ Text }}' + Value: '{{ Value }}' + Variations: + - null + DelayInSeconds: '{{ DelayInSeconds }}' + AllowInterrupt: '{{ AllowInterrupt }}' + UpdateResponse: + MessageGroups: null + FrequencyInSeconds: '{{ FrequencyInSeconds }}' + AllowInterrupt: '{{ AllowInterrupt }}' + TimeoutInSeconds: '{{ TimeoutInSeconds }}' + Active: '{{ Active }}' + PostFulfillmentStatusSpecification: + SuccessResponse: + MessageGroupsList: null + AllowInterrupt: '{{ AllowInterrupt }}' + SuccessNextStep: + DialogAction: + Type: '{{ Type }}' + SlotToElicit: null + SuppressNextMessage: '{{ SuppressNextMessage }}' + Intent: + Name: null + Slots: + - SlotName: null + SlotValueOverride: + Shape: '{{ Shape }}' + Value: + InterpretedValue: '{{ InterpretedValue }}' + Values: + - null + SessionAttributes: + - Key: '{{ Key }}' + Value: '{{ Value }}' + SuccessConditional: + IsActive: '{{ IsActive }}' + ConditionalBranches: + - Name: null + Condition: + ExpressionString: '{{ ExpressionString }}' + NextStep: null + Response: null + DefaultBranch: + NextStep: null + Response: null + FailureResponse: null + FailureNextStep: null + FailureConditional: null + TimeoutResponse: null + TimeoutNextStep: null + TimeoutConditional: null + Enabled: '{{ Enabled }}' + IsActive: '{{ IsActive }}' + IntentConfirmationSetting: + PromptSpecification: + MessageGroupsList: null + MaxRetries: '{{ MaxRetries }}' + AllowInterrupt: '{{ AllowInterrupt }}' + MessageSelectionStrategy: '{{ MessageSelectionStrategy }}' + PromptAttemptsSpecification: {} + IsActive: '{{ IsActive }}' + ConfirmationResponse: null + ConfirmationNextStep: null + ConfirmationConditional: null + DeclinationResponse: null + DeclinationNextStep: null + DeclinationConditional: null + FailureResponse: null + FailureNextStep: null + FailureConditional: null + CodeHook: + EnableCodeHookInvocation: '{{ EnableCodeHookInvocation }}' + IsActive: '{{ IsActive }}' + InvocationLabel: null + PostCodeHookSpecification: + SuccessResponse: null + SuccessNextStep: null + SuccessConditional: null + FailureResponse: null + FailureNextStep: null + FailureConditional: null + TimeoutResponse: null + TimeoutNextStep: null + TimeoutConditional: null + ElicitationCodeHook: + EnableCodeHookInvocation: '{{ EnableCodeHookInvocation }}' + InvocationLabel: null + IntentClosingSetting: + ClosingResponse: null + IsActive: '{{ IsActive }}' + Conditional: null + NextStep: null + InitialResponseSetting: + InitialResponse: null + NextStep: null + Conditional: null + CodeHook: null + InputContexts: + - Name: null + OutputContexts: + - Name: null + TimeToLiveInSeconds: '{{ TimeToLiveInSeconds }}' + TurnsToLive: '{{ TurnsToLive }}' + KendraConfiguration: + KendraIndex: '{{ KendraIndex }}' + QueryFilterStringEnabled: '{{ QueryFilterStringEnabled }}' + QueryFilterString: '{{ QueryFilterString }}' + SlotPriorities: + - Priority: '{{ Priority }}' + SlotName: null + Slots: + - Name: null + Description: null + SlotTypeName: '{{ SlotTypeName }}' + ValueElicitationSetting: + DefaultValueSpecification: + DefaultValueList: + - DefaultValue: '{{ DefaultValue }}' + SlotConstraint: '{{ SlotConstraint }}' + PromptSpecification: null + SampleUtterances: null + WaitAndContinueSpecification: + WaitingResponse: null + ContinueResponse: null + StillWaitingResponse: + MessageGroupsList: null + FrequencyInSeconds: '{{ FrequencyInSeconds }}' + TimeoutInSeconds: '{{ TimeoutInSeconds }}' + AllowInterrupt: '{{ AllowInterrupt }}' + IsActive: '{{ IsActive }}' + SlotCaptureSetting: + CaptureResponse: null + CaptureNextStep: null + CaptureConditional: null + FailureResponse: null + FailureNextStep: null + FailureConditional: null + CodeHook: null + ElicitationCodeHook: null + ObfuscationSetting: + ObfuscationSettingType: '{{ ObfuscationSettingType }}' + MultipleValuesSetting: + AllowMultipleValues: '{{ AllowMultipleValues }}' + SlotTypes: + - Name: null + Description: null + ParentSlotTypeSignature: '{{ ParentSlotTypeSignature }}' + SlotTypeValues: + - SampleValue: + Value: '{{ Value }}' + Synonyms: + - null + ValueSelectionSetting: + ResolutionStrategy: '{{ ResolutionStrategy }}' + RegexFilter: + Pattern: '{{ Pattern }}' + AdvancedRecognitionSetting: + AudioRecognitionStrategy: '{{ AudioRecognitionStrategy }}' + ExternalSourceSetting: + GrammarSlotTypeSetting: + Source: + S3BucketName: '{{ S3BucketName }}' + S3ObjectKey: '{{ S3ObjectKey }}' + KmsKeyArn: '{{ KmsKeyArn }}' + CustomVocabulary: + CustomVocabularyItems: + - Phrase: '{{ Phrase }}' + Weight: '{{ Weight }}' + DisplayAs: '{{ DisplayAs }}' + - name: BotFileS3Location + value: + S3Bucket: null + S3ObjectKey: null + S3ObjectVersion: '{{ S3ObjectVersion }}' + - name: BotTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TestBotAliasTags + value: + - null + - name: AutoBuildBotLocales + value: '{{ AutoBuildBotLocales }}' + - name: TestBotAliasSettings + value: + BotAliasLocaleSettings: + - LocaleId: '{{ LocaleId }}' + BotAliasLocaleSetting: + CodeHookSpecification: + LambdaCodeHook: + CodeHookInterfaceVersion: '{{ CodeHookInterfaceVersion }}' + LambdaArn: '{{ LambdaArn }}' + Enabled: '{{ Enabled }}' + ConversationLogSettings: + AudioLogSettings: + - Destination: + S3Bucket: + S3BucketArn: '{{ S3BucketArn }}' + LogPrefix: '{{ LogPrefix }}' + KmsKeyArn: '{{ KmsKeyArn }}' + Enabled: '{{ Enabled }}' + TextLogSettings: + - Destination: + CloudWatch: + CloudWatchLogGroupArn: '{{ CloudWatchLogGroupArn }}' + LogPrefix: '{{ LogPrefix }}' + Enabled: '{{ Enabled }}' + Description: null + SentimentAnalysisSettings: + DetectSentiment: '{{ DetectSentiment }}' + - name: Replication + value: + ReplicaRegions: + - '{{ ReplicaRegions[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lex.bots +WHERE data__Identifier = '' +AND 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, +iam:CreateServiceLinkedRole, +iam:GetRole, +lex:CreateBotReplica, +lex:DescribeBotReplica, +lex:DeleteBotReplica +``` + +### Read +```json +lex:DescribeBot, +lex:ListTagsForResource, +lex:DescribeBotReplica +``` + +### 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, +lex:CreateBotReplica, +lex:DescribeBotReplica, +lex:DeleteBotReplica +``` + +### Delete +```json +lex:DeleteBot, +lex:DescribeBot, +lex:DeleteBotLocale, +lex:DeleteIntent, +lex:DeleteSlotType, +lex:DeleteSlot, +lex:DeleteBotVersion, +lex:DeleteBotChannel, +lex:DeleteBotAlias, +lex:DeleteCustomVocabulary, +lex:DeleteBotReplica +``` + +### List +```json +lex:ListBots, +lex:ListBotReplicas +``` diff --git a/website/docs/services/lex/bots_list_only/index.md b/website/docs/services/lex/bots_list_only/index.md new file mode 100644 index 0000000..09cf472 --- /dev/null +++ b/website/docs/services/lex/bots_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: bots_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bots_list_only + - lex + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bots in a region or regions, for all properties use bots + +## Overview + + + + + + + +
Namebots_list_only
TypeResource
DescriptionAmazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique ID of resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bots in a region. +```sql +SELECT +region, +id +FROM aws.lex.bots_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bots_list_only resource, see bots + diff --git a/website/docs/services/lex/index.md b/website/docs/services/lex/index.md new file mode 100644 index 0000000..e4c7a14 --- /dev/null +++ b/website/docs/services/lex/index.md @@ -0,0 +1,43 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The lex service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/lex/resource_policies/index.md b/website/docs/services/lex/resource_policies/index.md new file mode 100644 index 0000000..6500480 --- /dev/null +++ b/website/docs/services/lex/resource_policies/index.md @@ -0,0 +1,212 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_policy resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
stringThe current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
objectA resource policy to add to the resource. The policy is a JSON structure following the IAM syntax that contains one or more statements that define the policy.
stringThe Physical ID of the resource policy.
stringAWS region.
+ +For more information, see AWS::Lex::ResourcePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_policies in a region. +```sql +SELECT +region, +resource_arn, +revision_id, +policy, +id +FROM aws.lex.resource_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_policy. +```sql +SELECT +region, +resource_arn, +revision_id, +policy, +id +FROM aws.lex.resource_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lex.resource_policies ( + ResourceArn, + Policy, + region +) +SELECT +'{{ ResourceArn }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lex.resource_policies ( + ResourceArn, + Policy, + region +) +SELECT + '{{ ResourceArn }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_policy + props: + - name: ResourceArn + value: '{{ ResourceArn }}' + - name: Policy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lex.resource_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +lex:CreateResourcePolicy, +lex:DescribeResourcePolicy +``` + +### Read +```json +lex:DescribeResourcePolicy +``` + +### Update +```json +lex:UpdateResourcePolicy, +lex:DescribeResourcePolicy +``` + +### Delete +```json +lex:DeleteResourcePolicy, +lex:DescribeResourcePolicy +``` + +### List +```json +lex:DescribeResourcePolicy +``` diff --git a/website/docs/services/lex/resource_policies_list_only/index.md b/website/docs/services/lex/resource_policies_list_only/index.md new file mode 100644 index 0000000..a31b638 --- /dev/null +++ b/website/docs/services/lex/resource_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - lex + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionA resource policy with specified policy statements that attaches to a Lex bot or bot alias.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Physical ID of the resource policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +id +FROM aws.lex.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + diff --git a/website/docs/services/licensemanager/grants/index.md b/website/docs/services/licensemanager/grants/index.md new file mode 100644 index 0000000..b343523 --- /dev/null +++ b/website/docs/services/licensemanager/grants/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a grant resource or lists grants in a region + +## Overview + + + + + + + +
Namegrants
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringArn of the grant.
stringName for the created Grant.
stringLicense Arn for the grant.
stringHome region for the created grant.
stringThe version of the grant.
array
array
string
stringAWS region.
+ +For more information, see AWS::LicenseManager::Grant. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all grants in a region. +```sql +SELECT +region, +grant_arn, +grant_name, +license_arn, +home_region, +version, +allowed_operations, +principals, +status +FROM aws.licensemanager.grants +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual grant. +```sql +SELECT +region, +grant_arn, +grant_name, +license_arn, +home_region, +version, +allowed_operations, +principals, +status +FROM aws.licensemanager.grants +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new grant resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.licensemanager.grants ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.licensemanager.grants ( + GrantName, + LicenseArn, + HomeRegion, + AllowedOperations, + Principals, + Status, + region +) +SELECT + '{{ GrantName }}', + '{{ LicenseArn }}', + '{{ HomeRegion }}', + '{{ AllowedOperations }}', + '{{ Principals }}', + '{{ Status }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: grant + props: + - name: GrantName + value: '{{ GrantName }}' + - name: LicenseArn + value: '{{ LicenseArn }}' + - name: HomeRegion + value: '{{ HomeRegion }}' + - name: AllowedOperations + value: + - '{{ AllowedOperations[0] }}' + - name: Principals + value: + - null + - name: Status + value: '{{ Status }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.licensemanager.grants +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the grants resource, the following permissions are required: + +### Create +```json +license-manager:CreateGrant +``` + +### Read +```json +license-manager:GetGrant +``` + +### Update +```json +license-manager:CreateGrantVersion +``` + +### Delete +```json +license-manager:DeleteGrant +``` + +### List +```json +license-manager:ListDistributedGrants +``` diff --git a/website/docs/services/licensemanager/grants_list_only/index.md b/website/docs/services/licensemanager/grants_list_only/index.md new file mode 100644 index 0000000..bbae7a8 --- /dev/null +++ b/website/docs/services/licensemanager/grants_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: grants_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - grants_list_only + - licensemanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists grants in a region or regions, for all properties use grants + +## Overview + + + + + + + +
Namegrants_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringArn of the grant.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all grants in a region. +```sql +SELECT +region, +grant_arn +FROM aws.licensemanager.grants_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the grants_list_only resource, see grants + diff --git a/website/docs/services/licensemanager/index.md b/website/docs/services/licensemanager/index.md new file mode 100644 index 0000000..08ee519 --- /dev/null +++ b/website/docs/services/licensemanager/index.md @@ -0,0 +1,39 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The licensemanager service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/licensemanager/licenses/index.md b/website/docs/services/licensemanager/licenses/index.md new file mode 100644 index 0000000..14ec924 --- /dev/null +++ b/website/docs/services/licensemanager/licenses/index.md @@ -0,0 +1,300 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a license resource or lists licenses in a region + +## Overview + + + + + + + +
Namelicenses
TypeResource
DescriptionResource Type definition for AWS::LicenseManager::License
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringProductSKU of the license.
object
stringName for the created license.
stringProduct name for the created license.
stringHome region for the created license.
object
array
stringBeneficiary of the license.
object
array
stringAmazon Resource Name is a unique name for each resource.
string
stringThe version of the license.
stringAWS region.
+ +For more information, see AWS::LicenseManager::License. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all licenses in a region. +```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.licenses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual license. +```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.licenses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new license resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.licensemanager.licenses ( + Issuer, + LicenseName, + ProductName, + HomeRegion, + Validity, + Entitlements, + ConsumptionConfiguration, + region +) +SELECT +'{{ Issuer }}', + '{{ LicenseName }}', + '{{ ProductName }}', + '{{ HomeRegion }}', + '{{ Validity }}', + '{{ Entitlements }}', + '{{ ConsumptionConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.licensemanager.licenses ( + ProductSKU, + Issuer, + LicenseName, + ProductName, + HomeRegion, + Validity, + Entitlements, + Beneficiary, + ConsumptionConfiguration, + LicenseMetadata, + Status, + region +) +SELECT + '{{ ProductSKU }}', + '{{ Issuer }}', + '{{ LicenseName }}', + '{{ ProductName }}', + '{{ HomeRegion }}', + '{{ Validity }}', + '{{ Entitlements }}', + '{{ Beneficiary }}', + '{{ ConsumptionConfiguration }}', + '{{ LicenseMetadata }}', + '{{ Status }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: license + props: + - name: ProductSKU + value: '{{ ProductSKU }}' + - name: Issuer + value: + Name: '{{ Name }}' + SignKey: '{{ SignKey }}' + - name: LicenseName + value: '{{ LicenseName }}' + - name: ProductName + value: '{{ ProductName }}' + - name: HomeRegion + value: '{{ HomeRegion }}' + - name: Validity + value: + Begin: '{{ Begin }}' + End: '{{ End }}' + - name: Entitlements + value: + - Name: '{{ Name }}' + Value: '{{ Value }}' + MaxCount: '{{ MaxCount }}' + Overage: '{{ Overage }}' + Unit: '{{ Unit }}' + AllowCheckIn: '{{ AllowCheckIn }}' + - name: Beneficiary + value: '{{ Beneficiary }}' + - name: ConsumptionConfiguration + value: + RenewType: '{{ RenewType }}' + ProvisionalConfiguration: + MaxTimeToLiveInMinutes: '{{ MaxTimeToLiveInMinutes }}' + BorrowConfiguration: + MaxTimeToLiveInMinutes: '{{ MaxTimeToLiveInMinutes }}' + AllowEarlyCheckIn: '{{ AllowEarlyCheckIn }}' + - name: LicenseMetadata + value: + - Name: '{{ Name }}' + Value: '{{ Value }}' + - name: Status + value: '{{ Status }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.licensemanager.licenses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the licenses resource, the following permissions are required: + +### Create +```json +license-manager:CreateLicense +``` + +### Read +```json +license-manager:GetLicense +``` + +### Update +```json +license-manager:CreateLicenseVersion +``` + +### Delete +```json +license-manager:DeleteLicense +``` + +### List +```json +license-manager:ListLicenses +``` diff --git a/website/docs/services/licensemanager/licenses_list_only/index.md b/website/docs/services/licensemanager/licenses_list_only/index.md new file mode 100644 index 0000000..6f46aba --- /dev/null +++ b/website/docs/services/licensemanager/licenses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: licenses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - licenses_list_only + - licensemanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists licenses in a region or regions, for all properties use licenses + +## Overview + + + + + + + +
Namelicenses_list_only
TypeResource
DescriptionResource Type definition for AWS::LicenseManager::License
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name is a unique name for each resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all licenses in a region. +```sql +SELECT +region, +license_arn +FROM aws.licensemanager.licenses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the licenses_list_only resource, see licenses + diff --git a/website/docs/services/lightsail/alarms/index.md b/website/docs/services/lightsail/alarms/index.md new file mode 100644 index 0000000..750bae9 --- /dev/null +++ b/website/docs/services/lightsail/alarms/index.md @@ -0,0 +1,285 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an alarm resource or lists alarms in a region + +## Overview + + + + + + + +
Namealarms
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Alarm
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
stringThe name of the Lightsail resource that the alarm monitors.
stringThe name of the metric to associate with the alarm.
stringThe arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
arrayThe contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
string
integerThe number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
integerThe number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
booleanIndicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
arrayThe alarm states that trigger a notification.
numberThe value against which the specified statistic is compared.
stringSets how this alarm will handle missing data points.
stringThe current state of the alarm.
stringAWS region.
+ +For more information, see AWS::Lightsail::Alarm. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all alarms in a region. +```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.alarms +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual alarm. +```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.alarms +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alarm resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.alarms ( + AlarmName, + MonitoredResourceName, + MetricName, + ComparisonOperator, + EvaluationPeriods, + Threshold, + region +) +SELECT +'{{ AlarmName }}', + '{{ MonitoredResourceName }}', + '{{ MetricName }}', + '{{ ComparisonOperator }}', + '{{ EvaluationPeriods }}', + '{{ Threshold }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.alarms ( + AlarmName, + MonitoredResourceName, + MetricName, + ComparisonOperator, + ContactProtocols, + DatapointsToAlarm, + EvaluationPeriods, + NotificationEnabled, + NotificationTriggers, + Threshold, + TreatMissingData, + region +) +SELECT + '{{ AlarmName }}', + '{{ MonitoredResourceName }}', + '{{ MetricName }}', + '{{ ComparisonOperator }}', + '{{ ContactProtocols }}', + '{{ DatapointsToAlarm }}', + '{{ EvaluationPeriods }}', + '{{ NotificationEnabled }}', + '{{ NotificationTriggers }}', + '{{ Threshold }}', + '{{ TreatMissingData }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: alarm + props: + - name: AlarmName + value: '{{ AlarmName }}' + - name: MonitoredResourceName + value: '{{ MonitoredResourceName }}' + - name: MetricName + value: '{{ MetricName }}' + - name: ComparisonOperator + value: '{{ ComparisonOperator }}' + - name: ContactProtocols + value: + - '{{ ContactProtocols[0] }}' + - name: DatapointsToAlarm + value: '{{ DatapointsToAlarm }}' + - name: EvaluationPeriods + value: '{{ EvaluationPeriods }}' + - name: NotificationEnabled + value: '{{ NotificationEnabled }}' + - name: NotificationTriggers + value: + - '{{ NotificationTriggers[0] }}' + - name: Threshold + value: null + - name: TreatMissingData + value: '{{ TreatMissingData }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lightsail.alarms +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the alarms resource, the following permissions are required: + +### Create +```json +lightsail:PutAlarm, +lightsail:GetAlarms +``` + +### Read +```json +lightsail:GetAlarms +``` + +### Update +```json +lightsail:PutAlarm, +lightsail:GetAlarms +``` + +### Delete +```json +lightsail:DeleteAlarm, +lightsail:GetAlarms +``` + +### List +```json +lightsail:GetAlarms +``` diff --git a/website/docs/services/lightsail/alarms_list_only/index.md b/website/docs/services/lightsail/alarms_list_only/index.md new file mode 100644 index 0000000..5dcb8da --- /dev/null +++ b/website/docs/services/lightsail/alarms_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: alarms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - alarms_list_only + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists alarms in a region or regions, for all properties use alarms + +## Overview + + + + + + + +
Namealarms_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Alarm
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all alarms in a region. +```sql +SELECT +region, +alarm_name +FROM aws.lightsail.alarms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alarms_list_only resource, see alarms + diff --git a/website/docs/services/lightsail/bucket_tags/index.md b/website/docs/services/lightsail/bucket_tags/index.md new file mode 100644 index 0000000..b5a6627 --- /dev/null +++ b/website/docs/services/lightsail/bucket_tags/index.md @@ -0,0 +1,93 @@ +--- +title: bucket_tags +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_tags + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for buckets in a region + +## Overview + + + + + + + +
Namebucket_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Bucket
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the bucket.
stringThe ID of the bundle to use for the bucket.
string
booleanSpecifies whether to enable or disable versioning of objects in the bucket.
objectAn object that sets the public accessibility of objects in the specified bucket.
arrayThe names of the Lightsail resources for which to set bucket access.
arrayAn array of strings to specify the AWS account IDs that can access the bucket.
stringThe URL of the bucket.
booleanIndicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all buckets in a region. +```sql +SELECT +region, +bucket_name, +bundle_id, +bucket_arn, +object_versioning, +access_rules, +resources_receiving_access, +read_only_access_accounts, +url, +able_to_update_bundle, +tag_key, +tag_value +FROM aws.lightsail.bucket_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bucket_tags resource, see buckets + diff --git a/website/docs/services/lightsail/buckets/index.md b/website/docs/services/lightsail/buckets/index.md new file mode 100644 index 0000000..890c22f --- /dev/null +++ b/website/docs/services/lightsail/buckets/index.md @@ -0,0 +1,267 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bucket resource or lists buckets in a region + +## Overview + + + + + + + +
Namebuckets
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Bucket
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the bucket.
stringThe ID of the bundle to use for the bucket.
string
booleanSpecifies whether to enable or disable versioning of objects in the bucket.
objectAn object that sets the public accessibility of objects in the specified bucket.
arrayThe names of the Lightsail resources for which to set bucket access.
arrayAn array of strings to specify the AWS account IDs that can access the bucket.
arrayAn array of key-value pairs to apply to this resource.
stringThe URL of the bucket.
booleanIndicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
stringAWS region.
+ +For more information, see AWS::Lightsail::Bucket. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all buckets in a region. +```sql +SELECT +region, +bucket_name, +bundle_id, +bucket_arn, +object_versioning, +access_rules, +resources_receiving_access, +read_only_access_accounts, +tags, +url, +able_to_update_bundle +FROM aws.lightsail.buckets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual bucket. +```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.buckets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bucket resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.buckets ( + BucketName, + BundleId, + region +) +SELECT +'{{ BucketName }}', + '{{ BundleId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.buckets ( + BucketName, + BundleId, + ObjectVersioning, + AccessRules, + ResourcesReceivingAccess, + ReadOnlyAccessAccounts, + Tags, + region +) +SELECT + '{{ BucketName }}', + '{{ BundleId }}', + '{{ ObjectVersioning }}', + '{{ AccessRules }}', + '{{ ResourcesReceivingAccess }}', + '{{ ReadOnlyAccessAccounts }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bucket + props: + - name: BucketName + value: '{{ BucketName }}' + - name: BundleId + value: '{{ BundleId }}' + - name: ObjectVersioning + value: '{{ ObjectVersioning }}' + - name: AccessRules + value: + GetObject: '{{ GetObject }}' + AllowPublicOverrides: '{{ AllowPublicOverrides }}' + - name: ResourcesReceivingAccess + value: + - '{{ ResourcesReceivingAccess[0] }}' + - name: ReadOnlyAccessAccounts + value: + - '{{ ReadOnlyAccessAccounts[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lightsail.buckets +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lightsail:GetBuckets +``` + +### Delete +```json +lightsail:DeleteBucket, +lightsail:GetBuckets +``` + +### List +```json +lightsail:GetBuckets +``` + +### Update +```json +lightsail:GetBuckets, +lightsail:GetInstance, +lightsail:UpdateBucket, +lightsail:UpdateBucketBundle, +lightsail:SetResourceAccessForBucket, +lightsail:TagResource, +lightsail:UntagResource +``` diff --git a/website/docs/services/lightsail/buckets_list_only/index.md b/website/docs/services/lightsail/buckets_list_only/index.md new file mode 100644 index 0000000..0515082 --- /dev/null +++ b/website/docs/services/lightsail/buckets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: buckets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - buckets_list_only + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists buckets in a region or regions, for all properties use buckets + +## Overview + + + + + + + +
Namebuckets_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Bucket
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name for the bucket.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all buckets in a region. +```sql +SELECT +region, +bucket_name +FROM aws.lightsail.buckets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the buckets_list_only resource, see buckets + diff --git a/website/docs/services/lightsail/certificate_tags/index.md b/website/docs/services/lightsail/certificate_tags/index.md new file mode 100644 index 0000000..64e5863 --- /dev/null +++ b/website/docs/services/lightsail/certificate_tags/index.md @@ -0,0 +1,85 @@ +--- +title: certificate_tags +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_tags + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for certificates in a region + +## Overview + + + + + + + +
Namecertificate_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Certificate.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the certificate.
stringThe domain name (e.g., example.com ) for the certificate.
arrayAn array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
string
stringThe validation status of the certificate.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all certificates in a region. +```sql +SELECT +region, +certificate_name, +domain_name, +subject_alternative_names, +certificate_arn, +status, +tag_key, +tag_value +FROM aws.lightsail.certificate_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_tags resource, see certificates + diff --git a/website/docs/services/lightsail/certificates/index.md b/website/docs/services/lightsail/certificates/index.md new file mode 100644 index 0000000..a1c0b01 --- /dev/null +++ b/website/docs/services/lightsail/certificates/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a certificate resource or lists certificates in a region + +## Overview + + + + + + + +
Namecertificates
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Certificate.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the certificate.
stringThe domain name (e.g., example.com ) for the certificate.
arrayAn array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
string
stringThe validation status of the certificate.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Lightsail::Certificate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all certificates in a region. +```sql +SELECT +region, +certificate_name, +domain_name, +subject_alternative_names, +certificate_arn, +status, +tags +FROM aws.lightsail.certificates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual certificate. +```sql +SELECT +region, +certificate_name, +domain_name, +subject_alternative_names, +certificate_arn, +status, +tags +FROM aws.lightsail.certificates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.certificates ( + CertificateName, + DomainName, + region +) +SELECT +'{{ CertificateName }}', + '{{ DomainName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.certificates ( + CertificateName, + DomainName, + SubjectAlternativeNames, + Tags, + region +) +SELECT + '{{ CertificateName }}', + '{{ DomainName }}', + '{{ SubjectAlternativeNames }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: certificate + props: + - name: CertificateName + value: '{{ CertificateName }}' + - name: DomainName + value: '{{ DomainName }}' + - name: SubjectAlternativeNames + value: + - '{{ SubjectAlternativeNames[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lightsail.certificates +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lightsail:GetCertificates +``` + +### Update +```json +lightsail:GetCertificates, +lightsail:TagResource, +lightsail:UntagResource +``` + +### Delete +```json +lightsail:DeleteCertificate, +lightsail:GetCertificates +``` + +### List +```json +lightsail:GetCertificates +``` diff --git a/website/docs/services/lightsail/certificates_list_only/index.md b/website/docs/services/lightsail/certificates_list_only/index.md new file mode 100644 index 0000000..4843333 --- /dev/null +++ b/website/docs/services/lightsail/certificates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - certificates_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists certificates in a region or regions, for all properties use certificates + +## Overview + + + + + + + +
Namecertificates_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Certificate.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name for the certificate.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all certificates in a region. +```sql +SELECT +region, +certificate_name +FROM aws.lightsail.certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificates_list_only resource, see certificates + diff --git a/website/docs/services/lightsail/container_tags/index.md b/website/docs/services/lightsail/container_tags/index.md new file mode 100644 index 0000000..c9a2615 --- /dev/null +++ b/website/docs/services/lightsail/container_tags/index.md @@ -0,0 +1,95 @@ +--- +title: container_tags +hide_title: false +hide_table_of_contents: false +keywords: + - container_tags + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for containers in a region + +## Overview + + + + + + + +
Namecontainer_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Container
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the container service.
stringThe power specification for the container service.
string
integerThe scale specification for the container service.
arrayThe public domain names to use with the container service, such as example.com and www.example.com.
objectDescribes a container deployment configuration of an Amazon Lightsail container service.
booleanA Boolean value to indicate whether the container service is disabled.
objectA Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
stringThe publicly accessible URL of the container service.
stringThe principal ARN of the container service.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all containers in a region. +```sql +SELECT +region, +service_name, +power, +container_arn, +scale, +public_domain_names, +container_service_deployment, +is_disabled, +private_registry_access, +url, +principal_arn, +tag_key, +tag_value +FROM aws.lightsail.container_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_tags resource, see containers + diff --git a/website/docs/services/lightsail/containers/index.md b/website/docs/services/lightsail/containers/index.md new file mode 100644 index 0000000..8da66c8 --- /dev/null +++ b/website/docs/services/lightsail/containers/index.md @@ -0,0 +1,295 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a container resource or lists containers in a region + +## Overview + + + + + + + +
Namecontainers
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Container
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the container service.
stringThe power specification for the container service.
string
integerThe scale specification for the container service.
arrayThe public domain names to use with the container service, such as example.com and www.example.com.
objectDescribes a container deployment configuration of an Amazon Lightsail container service.
booleanA Boolean value to indicate whether the container service is disabled.
objectA Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
stringThe publicly accessible URL of the container service.
stringThe principal ARN of the container service.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Lightsail::Container. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all containers in a region. +```sql +SELECT +region, +service_name, +power, +container_arn, +scale, +public_domain_names, +container_service_deployment, +is_disabled, +private_registry_access, +url, +principal_arn, +tags +FROM aws.lightsail.containers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual container. +```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.containers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new container resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.containers ( + ServiceName, + Power, + Scale, + region +) +SELECT +'{{ ServiceName }}', + '{{ Power }}', + '{{ Scale }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.containers ( + ServiceName, + Power, + Scale, + PublicDomainNames, + ContainerServiceDeployment, + IsDisabled, + PrivateRegistryAccess, + Tags, + region +) +SELECT + '{{ ServiceName }}', + '{{ Power }}', + '{{ Scale }}', + '{{ PublicDomainNames }}', + '{{ ContainerServiceDeployment }}', + '{{ IsDisabled }}', + '{{ PrivateRegistryAccess }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: container + props: + - name: ServiceName + value: '{{ ServiceName }}' + - name: Power + value: '{{ Power }}' + - name: Scale + value: '{{ Scale }}' + - name: PublicDomainNames + value: + - CertificateName: '{{ CertificateName }}' + DomainNames: + - '{{ DomainNames[0] }}' + - name: ContainerServiceDeployment + value: + Containers: + - ServiceName: '{{ ServiceName }}' + Power: '{{ Power }}' + Scale: '{{ Scale }}' + PublicDomainNames: + - null + ContainerServiceDeployment: null + IsDisabled: '{{ IsDisabled }}' + PrivateRegistryAccess: + EcrImagePullerRole: + IsActive: '{{ IsActive }}' + PrincipalArn: '{{ PrincipalArn }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + PublicEndpoint: + ContainerName: '{{ ContainerName }}' + ContainerPort: '{{ ContainerPort }}' + HealthCheckConfig: + HealthyThreshold: '{{ HealthyThreshold }}' + IntervalSeconds: '{{ IntervalSeconds }}' + Path: '{{ Path }}' + SuccessCodes: '{{ SuccessCodes }}' + TimeoutSeconds: '{{ TimeoutSeconds }}' + UnhealthyThreshold: '{{ UnhealthyThreshold }}' + - name: IsDisabled + value: '{{ IsDisabled }}' + - name: PrivateRegistryAccess + value: null + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lightsail.containers +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lightsail:GetContainerServices +``` + +### Delete +```json +lightsail:DeleteContainerService, +lightsail:GetContainerServices +``` + +### List +```json +lightsail:GetContainerServices +``` + +### Update +```json +lightsail:CreateContainerServiceDeployment, +lightsail:GetContainerServices, +lightsail:TagResource, +lightsail:UntagResource, +lightsail:UpdateContainerService +``` diff --git a/website/docs/services/lightsail/containers_list_only/index.md b/website/docs/services/lightsail/containers_list_only/index.md new file mode 100644 index 0000000..5720fc2 --- /dev/null +++ b/website/docs/services/lightsail/containers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: containers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - containers_list_only + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists containers in a region or regions, for all properties use containers + +## Overview + + + + + + + +
Namecontainers_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Container
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name for the container service.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all containers in a region. +```sql +SELECT +region, +service_name +FROM aws.lightsail.containers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the containers_list_only resource, see containers + diff --git a/website/docs/services/lightsail/database_tags/index.md b/website/docs/services/lightsail/database_tags/index.md new file mode 100644 index 0000000..39652e8 --- /dev/null +++ b/website/docs/services/lightsail/database_tags/index.md @@ -0,0 +1,105 @@ +--- +title: database_tags +hide_title: false +hide_table_of_contents: false +keywords: + - database_tags + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for databases in a region + +## Overview + + + + + + + +
Namedatabase_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Database
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name to use for your new Lightsail database resource.
string
stringThe Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
stringThe blueprint ID for your new database. A blueprint describes the major engine version of a database.
stringThe bundle ID for your new database. A bundle describes the performance specifications for your database.
stringThe name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource.
stringThe name for the master user.
stringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
stringThe daily time range during which automated backups are created for your new database if automated backups are enabled.
stringThe weekly time range during which system maintenance can occur on your new database.
booleanSpecifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
stringIndicates the certificate that needs to be associated with the database.
booleanWhen true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
booleanWhen true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password.
arrayUpdate one or more parameters of the relational database.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all databases in a region. +```sql +SELECT +region, +relational_database_name, +database_arn, +availability_zone, +relational_database_blueprint_id, +relational_database_bundle_id, +master_database_name, +master_username, +master_user_password, +preferred_backup_window, +preferred_maintenance_window, +publicly_accessible, +ca_certificate_identifier, +backup_retention, +rotate_master_user_password, +relational_database_parameters, +tag_key, +tag_value +FROM aws.lightsail.database_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the database_tags resource, see databases + diff --git a/website/docs/services/lightsail/databases/index.md b/website/docs/services/lightsail/databases/index.md new file mode 100644 index 0000000..2c67f40 --- /dev/null +++ b/website/docs/services/lightsail/databases/index.md @@ -0,0 +1,328 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a database resource or lists databases in a region + +## Overview + + + + + + + +
Namedatabases
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Database
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name to use for your new Lightsail database resource.
string
stringThe Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
stringThe blueprint ID for your new database. A blueprint describes the major engine version of a database.
stringThe bundle ID for your new database. A bundle describes the performance specifications for your database.
stringThe name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource.
stringThe name for the master user.
stringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
stringThe daily time range during which automated backups are created for your new database if automated backups are enabled.
stringThe weekly time range during which system maintenance can occur on your new database.
booleanSpecifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
stringIndicates the certificate that needs to be associated with the database.
booleanWhen true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
booleanWhen true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password.
arrayUpdate one or more parameters of the relational database.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Lightsail::Database. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all databases in a region. +```sql +SELECT +region, +relational_database_name, +database_arn, +availability_zone, +relational_database_blueprint_id, +relational_database_bundle_id, +master_database_name, +master_username, +master_user_password, +preferred_backup_window, +preferred_maintenance_window, +publicly_accessible, +ca_certificate_identifier, +backup_retention, +rotate_master_user_password, +relational_database_parameters, +tags +FROM aws.lightsail.databases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual database. +```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.databases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new database resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.databases ( + RelationalDatabaseName, + RelationalDatabaseBlueprintId, + RelationalDatabaseBundleId, + MasterDatabaseName, + MasterUsername, + region +) +SELECT +'{{ RelationalDatabaseName }}', + '{{ RelationalDatabaseBlueprintId }}', + '{{ RelationalDatabaseBundleId }}', + '{{ MasterDatabaseName }}', + '{{ MasterUsername }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.databases ( + RelationalDatabaseName, + AvailabilityZone, + RelationalDatabaseBlueprintId, + RelationalDatabaseBundleId, + MasterDatabaseName, + MasterUsername, + MasterUserPassword, + PreferredBackupWindow, + PreferredMaintenanceWindow, + PubliclyAccessible, + CaCertificateIdentifier, + BackupRetention, + RotateMasterUserPassword, + RelationalDatabaseParameters, + Tags, + region +) +SELECT + '{{ RelationalDatabaseName }}', + '{{ AvailabilityZone }}', + '{{ RelationalDatabaseBlueprintId }}', + '{{ RelationalDatabaseBundleId }}', + '{{ MasterDatabaseName }}', + '{{ MasterUsername }}', + '{{ MasterUserPassword }}', + '{{ PreferredBackupWindow }}', + '{{ PreferredMaintenanceWindow }}', + '{{ PubliclyAccessible }}', + '{{ CaCertificateIdentifier }}', + '{{ BackupRetention }}', + '{{ RotateMasterUserPassword }}', + '{{ RelationalDatabaseParameters }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: database + props: + - name: RelationalDatabaseName + value: '{{ RelationalDatabaseName }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: RelationalDatabaseBlueprintId + value: '{{ RelationalDatabaseBlueprintId }}' + - name: RelationalDatabaseBundleId + value: '{{ RelationalDatabaseBundleId }}' + - name: MasterDatabaseName + value: '{{ MasterDatabaseName }}' + - name: MasterUsername + value: '{{ MasterUsername }}' + - name: MasterUserPassword + value: '{{ MasterUserPassword }}' + - name: PreferredBackupWindow + value: '{{ PreferredBackupWindow }}' + - name: PreferredMaintenanceWindow + value: '{{ PreferredMaintenanceWindow }}' + - name: PubliclyAccessible + value: '{{ PubliclyAccessible }}' + - name: CaCertificateIdentifier + value: '{{ CaCertificateIdentifier }}' + - name: BackupRetention + value: '{{ BackupRetention }}' + - name: RotateMasterUserPassword + value: '{{ RotateMasterUserPassword }}' + - name: RelationalDatabaseParameters + value: + - AllowedValues: '{{ AllowedValues }}' + ApplyMethod: '{{ ApplyMethod }}' + ApplyType: '{{ ApplyType }}' + DataType: '{{ DataType }}' + Description: '{{ Description }}' + IsModifiable: '{{ IsModifiable }}' + ParameterName: '{{ ParameterName }}' + ParameterValue: '{{ ParameterValue }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lightsail.databases +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +lightsail:GetRelationalDatabases +``` diff --git a/website/docs/services/lightsail/databases_list_only/index.md b/website/docs/services/lightsail/databases_list_only/index.md new file mode 100644 index 0000000..0434d86 --- /dev/null +++ b/website/docs/services/lightsail/databases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: databases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - databases_list_only + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists databases in a region or regions, for all properties use databases + +## Overview + + + + + + + +
Namedatabases_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Database
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name to use for your new Lightsail database resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all databases in a region. +```sql +SELECT +region, +relational_database_name +FROM aws.lightsail.databases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the databases_list_only resource, see databases + diff --git a/website/docs/services/lightsail/distribution_tags/index.md b/website/docs/services/lightsail/distribution_tags/index.md new file mode 100644 index 0000000..f5e5903 --- /dev/null +++ b/website/docs/services/lightsail/distribution_tags/index.md @@ -0,0 +1,99 @@ +--- +title: distribution_tags +hide_title: false +hide_table_of_contents: false +keywords: + - distribution_tags + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for distributions in a region + +## Overview + + + + + + + +
Namedistribution_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Distribution
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the distribution.
string
stringThe bundle ID to use for the distribution.
stringThe IP address type for the distribution.
arrayAn array of objects that describe the per-path cache behavior for the distribution.
objectAn object that describes the cache behavior settings for the distribution.
objectAn object that describes the default cache behavior for the distribution.
objectAn object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.
stringThe status of the distribution.
booleanIndicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
booleanIndicates whether the distribution is enabled.
stringThe certificate attached to the Distribution.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all distributions in a region. +```sql +SELECT +region, +distribution_name, +distribution_arn, +bundle_id, +ip_address_type, +cache_behaviors, +cache_behavior_settings, +default_cache_behavior, +origin, +status, +able_to_update_bundle, +is_enabled, +certificate_name, +tag_key, +tag_value +FROM aws.lightsail.distribution_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the distribution_tags resource, see distributions + diff --git a/website/docs/services/lightsail/distributions/index.md b/website/docs/services/lightsail/distributions/index.md new file mode 100644 index 0000000..2da0838 --- /dev/null +++ b/website/docs/services/lightsail/distributions/index.md @@ -0,0 +1,315 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a distribution resource or lists distributions in a region + +## Overview + + + + + + + +
Namedistributions
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Distribution
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the distribution.
string
stringThe bundle ID to use for the distribution.
stringThe IP address type for the distribution.
arrayAn array of objects that describe the per-path cache behavior for the distribution.
objectAn object that describes the cache behavior settings for the distribution.
objectAn object that describes the default cache behavior for the distribution.
objectAn object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.
stringThe status of the distribution.
booleanIndicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
booleanIndicates whether the distribution is enabled.
stringThe certificate attached to the Distribution.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Lightsail::Distribution. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all distributions in a region. +```sql +SELECT +region, +distribution_name, +distribution_arn, +bundle_id, +ip_address_type, +cache_behaviors, +cache_behavior_settings, +default_cache_behavior, +origin, +status, +able_to_update_bundle, +is_enabled, +certificate_name, +tags +FROM aws.lightsail.distributions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual distribution. +```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.distributions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new distribution resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.distributions ( + DistributionName, + BundleId, + DefaultCacheBehavior, + Origin, + region +) +SELECT +'{{ DistributionName }}', + '{{ BundleId }}', + '{{ DefaultCacheBehavior }}', + '{{ Origin }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.distributions ( + DistributionName, + BundleId, + IpAddressType, + CacheBehaviors, + CacheBehaviorSettings, + DefaultCacheBehavior, + Origin, + IsEnabled, + CertificateName, + Tags, + region +) +SELECT + '{{ DistributionName }}', + '{{ BundleId }}', + '{{ IpAddressType }}', + '{{ CacheBehaviors }}', + '{{ CacheBehaviorSettings }}', + '{{ DefaultCacheBehavior }}', + '{{ Origin }}', + '{{ IsEnabled }}', + '{{ CertificateName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: distribution + props: + - name: DistributionName + value: '{{ DistributionName }}' + - name: BundleId + value: '{{ BundleId }}' + - name: IpAddressType + value: '{{ IpAddressType }}' + - name: CacheBehaviors + value: + - Behavior: '{{ Behavior }}' + Path: '{{ Path }}' + - name: CacheBehaviorSettings + value: + AllowedHTTPMethods: '{{ AllowedHTTPMethods }}' + CachedHTTPMethods: '{{ CachedHTTPMethods }}' + DefaultTTL: '{{ DefaultTTL }}' + MaximumTTL: '{{ MaximumTTL }}' + MinimumTTL: '{{ MinimumTTL }}' + ForwardedCookies: + CookiesAllowList: + - '{{ CookiesAllowList[0] }}' + Option: '{{ Option }}' + ForwardedHeaders: + HeadersAllowList: + - '{{ HeadersAllowList[0] }}' + Option: '{{ Option }}' + ForwardedQueryStrings: + QueryStringsAllowList: + - '{{ QueryStringsAllowList[0] }}' + Option: '{{ Option }}' + - name: DefaultCacheBehavior + value: + Behavior: '{{ Behavior }}' + - name: Origin + value: + Name: '{{ Name }}' + ProtocolPolicy: '{{ ProtocolPolicy }}' + RegionName: '{{ RegionName }}' + - name: IsEnabled + value: '{{ IsEnabled }}' + - name: CertificateName + value: '{{ CertificateName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lightsail.distributions +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +lightsail:GetDistributions +``` diff --git a/website/docs/services/lightsail/distributions_list_only/index.md b/website/docs/services/lightsail/distributions_list_only/index.md new file mode 100644 index 0000000..7ddbb10 --- /dev/null +++ b/website/docs/services/lightsail/distributions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: distributions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - distributions_list_only + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists distributions in a region or regions, for all properties use distributions + +## Overview + + + + + + + +
Namedistributions_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Distribution
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name for the distribution.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all distributions in a region. +```sql +SELECT +region, +distribution_name +FROM aws.lightsail.distributions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the distributions_list_only resource, see distributions + diff --git a/website/docs/services/lightsail/index.md b/website/docs/services/lightsail/index.md new file mode 100644 index 0000000..b47c0a2 --- /dev/null +++ b/website/docs/services/lightsail/index.md @@ -0,0 +1,62 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The lightsail service documentation. + +:::info Service Summary + +
+
+total resources: 27
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/lightsail/instance_tags/index.md b/website/docs/services/lightsail/instance_tags/index.md new file mode 100644 index 0000000..0701fd8 --- /dev/null +++ b/website/docs/services/lightsail/instance_tags/index.md @@ -0,0 +1,115 @@ +--- +title: instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_tags + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instances in a region + +## Overview + + + + + + + +
Nameinstance_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Instance
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSupport code to help identify any issues
stringResource type of Lightsail instance.
booleanIs the IP Address of the Instance is the static IP
stringPrivate IP Address of the Instance
stringPublic IP Address of the Instance
arrayIPv6 addresses of the instance
objectLocation of a resource.
objectHardware of the Instance.
objectCurrent State of the Instance.
objectNetworking of the Instance.
stringUsername of the Lightsail instance.
stringSSH Key Name of the Lightsail instance.
stringThe names to use for your new Lightsail instance.
stringThe Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
stringThe bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
stringThe ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
arrayAn array of objects representing the add-ons to enable for the new instance.
stringA launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
stringThe name of your key pair.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instances in a region. +```sql +SELECT +region, +support_code, +resource_type, +is_static_ip, +private_ip_address, +public_ip_address, +ipv6_addresses, +location, +hardware, +state, +networking, +user_name, +ssh_key_name, +instance_name, +availability_zone, +bundle_id, +blueprint_id, +add_ons, +user_data, +key_pair_name, +instance_arn, +tag_key, +tag_value +FROM aws.lightsail.instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_tags resource, see instances + diff --git a/website/docs/services/lightsail/instances/index.md b/website/docs/services/lightsail/instances/index.md new file mode 100644 index 0000000..0b9a845 --- /dev/null +++ b/website/docs/services/lightsail/instances/index.md @@ -0,0 +1,366 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an instance resource or lists instances in a region + +## Overview + + + + + + + +
Nameinstances
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Instance
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSupport code to help identify any issues
stringResource type of Lightsail instance.
booleanIs the IP Address of the Instance is the static IP
stringPrivate IP Address of the Instance
stringPublic IP Address of the Instance
arrayIPv6 addresses of the instance
objectLocation of a resource.
objectHardware of the Instance.
objectCurrent State of the Instance.
objectNetworking of the Instance.
stringUsername of the Lightsail instance.
stringSSH Key Name of the Lightsail instance.
stringThe names to use for your new Lightsail instance.
stringThe Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
stringThe bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
stringThe ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
arrayAn array of objects representing the add-ons to enable for the new instance.
stringA launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
stringThe name of your key pair.
arrayAn array of key-value pairs to apply to this resource.
string
stringAWS region.
+ +For more information, see AWS::Lightsail::Instance. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all instances in a region. +```sql +SELECT +region, +support_code, +resource_type, +is_static_ip, +private_ip_address, +public_ip_address, +ipv6_addresses, +location, +hardware, +state, +networking, +user_name, +ssh_key_name, +instance_name, +availability_zone, +bundle_id, +blueprint_id, +add_ons, +user_data, +key_pair_name, +tags, +instance_arn +FROM aws.lightsail.instances +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual instance. +```sql +SELECT +region, +support_code, +resource_type, +is_static_ip, +private_ip_address, +public_ip_address, +ipv6_addresses, +location, +hardware, +state, +networking, +user_name, +ssh_key_name, +instance_name, +availability_zone, +bundle_id, +blueprint_id, +add_ons, +user_data, +key_pair_name, +tags, +instance_arn +FROM aws.lightsail.instances +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.instances ( + InstanceName, + BundleId, + BlueprintId, + region +) +SELECT +'{{ InstanceName }}', + '{{ BundleId }}', + '{{ BlueprintId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.instances ( + Location, + Hardware, + State, + Networking, + InstanceName, + AvailabilityZone, + BundleId, + BlueprintId, + AddOns, + UserData, + KeyPairName, + Tags, + region +) +SELECT + '{{ Location }}', + '{{ Hardware }}', + '{{ State }}', + '{{ Networking }}', + '{{ InstanceName }}', + '{{ AvailabilityZone }}', + '{{ BundleId }}', + '{{ BlueprintId }}', + '{{ AddOns }}', + '{{ UserData }}', + '{{ KeyPairName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: instance + props: + - name: Location + value: + AvailabilityZone: '{{ AvailabilityZone }}' + RegionName: '{{ RegionName }}' + - name: Hardware + value: + CpuCount: '{{ CpuCount }}' + RamSizeInGb: '{{ RamSizeInGb }}' + Disks: + - DiskName: '{{ DiskName }}' + SizeInGb: '{{ SizeInGb }}' + IsSystemDisk: '{{ IsSystemDisk }}' + IOPS: '{{ IOPS }}' + Path: '{{ Path }}' + AttachedTo: '{{ AttachedTo }}' + AttachmentState: '{{ AttachmentState }}' + - name: State + value: + Code: '{{ Code }}' + Name: '{{ Name }}' + - name: Networking + value: + Ports: + - FromPort: '{{ FromPort }}' + ToPort: '{{ ToPort }}' + Protocol: '{{ Protocol }}' + AccessFrom: '{{ AccessFrom }}' + AccessType: '{{ AccessType }}' + CommonName: '{{ CommonName }}' + AccessDirection: '{{ AccessDirection }}' + Ipv6Cidrs: + - '{{ Ipv6Cidrs[0] }}' + CidrListAliases: + - '{{ CidrListAliases[0] }}' + Cidrs: + - '{{ Cidrs[0] }}' + MonthlyTransfer: + GbPerMonthAllocated: '{{ GbPerMonthAllocated }}' + - name: InstanceName + value: '{{ InstanceName }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: BundleId + value: '{{ BundleId }}' + - name: BlueprintId + value: '{{ BlueprintId }}' + - name: AddOns + value: + - AddOnType: '{{ AddOnType }}' + Status: '{{ Status }}' + AutoSnapshotAddOnRequest: + SnapshotTimeOfDay: '{{ SnapshotTimeOfDay }}' + - name: UserData + value: '{{ UserData }}' + - name: KeyPairName + value: '{{ KeyPairName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lightsail.instances +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lightsail:GetInstances, +lightsail:GetInstance +``` + +### Delete +```json +lightsail:GetInstances, +lightsail:GetInstance, +lightsail:DeleteInstance +``` + +### List +```json +lightsail:GetInstances +``` + +### 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/website/docs/services/lightsail/instances_list_only/index.md b/website/docs/services/lightsail/instances_list_only/index.md new file mode 100644 index 0000000..f4a5bb8 --- /dev/null +++ b/website/docs/services/lightsail/instances_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instances_list_only + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instances in a region or regions, for all properties use instances + +## Overview + + + + + + + +
Nameinstances_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Instance
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe names to use for your new Lightsail instance.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instances in a region. +```sql +SELECT +region, +instance_name +FROM aws.lightsail.instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instances_list_only resource, see instances + diff --git a/website/docs/services/lightsail/load_balancer_tags/index.md b/website/docs/services/lightsail/load_balancer_tags/index.md new file mode 100644 index 0000000..0bb347f --- /dev/null +++ b/website/docs/services/lightsail/load_balancer_tags/index.md @@ -0,0 +1,93 @@ +--- +title: load_balancer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancer_tags + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for load_balancers in a region + +## Overview + + + + + + + +
Nameload_balancer_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::LoadBalancer
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of your load balancer.
string
integerThe instance port where you're creating your load balancer.
stringThe IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
arrayThe names of the instances attached to the load balancer.
stringThe path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/").
booleanConfiguration option to enable session stickiness.
stringConfiguration option to adjust session stickiness cookie duration parameter.
stringThe name of the TLS policy to apply to the load balancer.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all load_balancers in a region. +```sql +SELECT +region, +load_balancer_name, +load_balancer_arn, +instance_port, +ip_address_type, +attached_instances, +health_check_path, +session_stickiness_enabled, +session_stickiness_lb_cookie_duration_seconds, +tls_policy_name, +tag_key, +tag_value +FROM aws.lightsail.load_balancer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the load_balancer_tags resource, see load_balancers + diff --git a/website/docs/services/lightsail/load_balancer_tls_certificates/index.md b/website/docs/services/lightsail/load_balancer_tls_certificates/index.md new file mode 100644 index 0000000..b1fdbb2 --- /dev/null +++ b/website/docs/services/lightsail/load_balancer_tls_certificates/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a load_balancer_tls_certificate resource or lists load_balancer_tls_certificates in a region + +## Overview + + + + + + + +
Nameload_balancer_tls_certificates
TypeResource
DescriptionResource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of your load balancer.
stringThe SSL/TLS certificate name.
stringThe domain name (e.g., example.com ) for your SSL/TLS certificate.
arrayAn array of strings listing alternative domains and subdomains for your SSL/TLS certificate.
string
booleanWhen true, the SSL/TLS certificate is attached to the Lightsail load balancer.
booleanA Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
stringThe validation status of the SSL/TLS certificate.
stringAWS region.
+ +For more information, see AWS::Lightsail::LoadBalancerTlsCertificate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all load_balancer_tls_certificates in a region. +```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_certificates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual load_balancer_tls_certificate. +```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_certificates +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new load_balancer_tls_certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.load_balancer_tls_certificates ( + LoadBalancerName, + CertificateName, + CertificateDomainName, + region +) +SELECT +'{{ LoadBalancerName }}', + '{{ CertificateName }}', + '{{ CertificateDomainName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.load_balancer_tls_certificates ( + LoadBalancerName, + CertificateName, + CertificateDomainName, + CertificateAlternativeNames, + IsAttached, + HttpsRedirectionEnabled, + region +) +SELECT + '{{ LoadBalancerName }}', + '{{ CertificateName }}', + '{{ CertificateDomainName }}', + '{{ CertificateAlternativeNames }}', + '{{ IsAttached }}', + '{{ HttpsRedirectionEnabled }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: load_balancer_tls_certificate + props: + - name: LoadBalancerName + value: '{{ LoadBalancerName }}' + - name: CertificateName + value: '{{ CertificateName }}' + - name: CertificateDomainName + value: '{{ CertificateDomainName }}' + - name: CertificateAlternativeNames + value: + - '{{ CertificateAlternativeNames[0] }}' + - name: IsAttached + value: '{{ IsAttached }}' + - name: HttpsRedirectionEnabled + value: '{{ HttpsRedirectionEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lightsail.load_balancer_tls_certificates +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lightsail:GetLoadBalancerTlsCertificates, +lightsail:GetLoadBalancer +``` + +### Update +```json +lightsail:AttachLoadBalancerTlsCertificate, +lightsail:GetLoadBalancerTlsCertificates, +lightsail:GetLoadBalancer, +lightsail:UpdateLoadBalancerAttribute +``` + +### Delete +```json +lightsail:DeleteLoadBalancerTlsCertificate, +lightsail:GetLoadBalancerTlsCertificates, +lightsail:GetLoadBalancer +``` + +### List +```json +lightsail:GetLoadBalancerTlsCertificates, +lightsail:GetLoadBalancer +``` diff --git a/website/docs/services/lightsail/load_balancer_tls_certificates_list_only/index.md b/website/docs/services/lightsail/load_balancer_tls_certificates_list_only/index.md new file mode 100644 index 0000000..b72af78 --- /dev/null +++ b/website/docs/services/lightsail/load_balancer_tls_certificates_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: load_balancer_tls_certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancer_tls_certificates_list_only + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists load_balancer_tls_certificates in a region or regions, for all properties use load_balancer_tls_certificates + +## Overview + + + + + + + +
Nameload_balancer_tls_certificates_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of your load balancer.
stringThe SSL/TLS certificate name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all load_balancer_tls_certificates in a region. +```sql +SELECT +region, +certificate_name, +load_balancer_name +FROM aws.lightsail.load_balancer_tls_certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the load_balancer_tls_certificates_list_only resource, see load_balancer_tls_certificates + diff --git a/website/docs/services/lightsail/load_balancers/index.md b/website/docs/services/lightsail/load_balancers/index.md new file mode 100644 index 0000000..ede7451 --- /dev/null +++ b/website/docs/services/lightsail/load_balancers/index.md @@ -0,0 +1,276 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a load_balancer resource or lists load_balancers in a region + +## Overview + + + + + + + +
Nameload_balancers
TypeResource
DescriptionResource Type definition for AWS::Lightsail::LoadBalancer
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of your load balancer.
string
integerThe instance port where you're creating your load balancer.
stringThe IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
arrayThe names of the instances attached to the load balancer.
stringThe path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/").
booleanConfiguration option to enable session stickiness.
stringConfiguration option to adjust session stickiness cookie duration parameter.
stringThe name of the TLS policy to apply to the load balancer.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Lightsail::LoadBalancer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all load_balancers in a region. +```sql +SELECT +region, +load_balancer_name, +load_balancer_arn, +instance_port, +ip_address_type, +attached_instances, +health_check_path, +session_stickiness_enabled, +session_stickiness_lb_cookie_duration_seconds, +tls_policy_name, +tags +FROM aws.lightsail.load_balancers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual load_balancer. +```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_balancers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new load_balancer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.load_balancers ( + LoadBalancerName, + InstancePort, + region +) +SELECT +'{{ LoadBalancerName }}', + '{{ InstancePort }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.load_balancers ( + LoadBalancerName, + InstancePort, + IpAddressType, + AttachedInstances, + HealthCheckPath, + SessionStickinessEnabled, + SessionStickinessLBCookieDurationSeconds, + TlsPolicyName, + Tags, + region +) +SELECT + '{{ LoadBalancerName }}', + '{{ InstancePort }}', + '{{ IpAddressType }}', + '{{ AttachedInstances }}', + '{{ HealthCheckPath }}', + '{{ SessionStickinessEnabled }}', + '{{ SessionStickinessLBCookieDurationSeconds }}', + '{{ TlsPolicyName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: load_balancer + props: + - name: LoadBalancerName + value: '{{ LoadBalancerName }}' + - name: InstancePort + value: '{{ InstancePort }}' + - name: IpAddressType + value: '{{ IpAddressType }}' + - name: AttachedInstances + value: + - '{{ AttachedInstances[0] }}' + - name: HealthCheckPath + value: '{{ HealthCheckPath }}' + - name: SessionStickinessEnabled + value: '{{ SessionStickinessEnabled }}' + - name: SessionStickinessLBCookieDurationSeconds + value: '{{ SessionStickinessLBCookieDurationSeconds }}' + - name: TlsPolicyName + value: '{{ TlsPolicyName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lightsail.load_balancers +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +lightsail:GetLoadBalancers +``` diff --git a/website/docs/services/lightsail/load_balancers_list_only/index.md b/website/docs/services/lightsail/load_balancers_list_only/index.md new file mode 100644 index 0000000..ce4c381 --- /dev/null +++ b/website/docs/services/lightsail/load_balancers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: load_balancers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancers_list_only + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists load_balancers in a region or regions, for all properties use load_balancers + +## Overview + + + + + + + +
Nameload_balancers_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::LoadBalancer
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of your load balancer.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all load_balancers in a region. +```sql +SELECT +region, +load_balancer_name +FROM aws.lightsail.load_balancers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the load_balancers_list_only resource, see load_balancers + diff --git a/website/docs/services/lightsail/static_ips/index.md b/website/docs/services/lightsail/static_ips/index.md new file mode 100644 index 0000000..1d36291 --- /dev/null +++ b/website/docs/services/lightsail/static_ips/index.md @@ -0,0 +1,222 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a static_ip resource or lists static_ips in a region + +## Overview + + + + + + + +
Namestatic_ips
TypeResource
DescriptionResource Type definition for AWS::Lightsail::StaticIp
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the static IP address.
stringThe instance where the static IP is attached.
booleanA Boolean value indicating whether the static IP is attached.
stringThe static IP address.
string
stringAWS region.
+ +For more information, see AWS::Lightsail::StaticIp. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all static_ips in a region. +```sql +SELECT +region, +static_ip_name, +attached_to, +is_attached, +ip_address, +static_ip_arn +FROM aws.lightsail.static_ips +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual static_ip. +```sql +SELECT +region, +static_ip_name, +attached_to, +is_attached, +ip_address, +static_ip_arn +FROM aws.lightsail.static_ips +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new static_ip resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.static_ips ( + StaticIpName, + region +) +SELECT +'{{ StaticIpName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lightsail.static_ips ( + StaticIpName, + AttachedTo, + region +) +SELECT + '{{ StaticIpName }}', + '{{ AttachedTo }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: static_ip + props: + - name: StaticIpName + value: '{{ StaticIpName }}' + - name: AttachedTo + value: '{{ AttachedTo }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lightsail.static_ips +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +lightsail:GetStaticIps +``` diff --git a/website/docs/services/lightsail/static_ips_list_only/index.md b/website/docs/services/lightsail/static_ips_list_only/index.md new file mode 100644 index 0000000..67cf0f9 --- /dev/null +++ b/website/docs/services/lightsail/static_ips_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: static_ips_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - static_ips_list_only + - lightsail + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists static_ips in a region or regions, for all properties use static_ips + +## Overview + + + + + + + +
Namestatic_ips_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::StaticIp
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the static IP address.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all static_ips in a region. +```sql +SELECT +region, +static_ip_name +FROM aws.lightsail.static_ips_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the static_ips_list_only resource, see static_ips + diff --git a/website/docs/services/location/api_key_tags/index.md b/website/docs/services/location/api_key_tags/index.md new file mode 100644 index 0000000..53f2d75 --- /dev/null +++ b/website/docs/services/location/api_key_tags/index.md @@ -0,0 +1,97 @@ +--- +title: api_key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - api_key_tags + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for api_keys in a region + +## Overview + + + + + + + +
Nameapi_key_tags
TypeResource
DescriptionDefinition of AWS::Location::APIKey Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
boolean
string
string
boolean
object
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
boolean
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all api_keys in a region. +```sql +SELECT +region, +create_time, +description, +expire_time, +force_update, +key_arn, +key_name, +no_expiry, +restrictions, +update_time, +force_delete, +arn, +tag_key, +tag_value +FROM aws.location.api_key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_key_tags resource, see api_keys + diff --git a/website/docs/services/location/api_keys/index.md b/website/docs/services/location/api_keys/index.md new file mode 100644 index 0000000..a22a7d2 --- /dev/null +++ b/website/docs/services/location/api_keys/index.md @@ -0,0 +1,321 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an api_key resource or lists api_keys in a region + +## Overview + + + + + + + +
Nameapi_keys
TypeResource
DescriptionDefinition of AWS::Location::APIKey Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
boolean
string
string
boolean
object
arrayAn array of key-value pairs to apply to this resource.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
boolean
string
stringAWS region.
+ +For more information, see AWS::Location::APIKey. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all api_keys in a region. +```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_keys +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual api_key. +```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_keys +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new api_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.location.api_keys ( + KeyName, + Restrictions, + region +) +SELECT +'{{ KeyName }}', + '{{ Restrictions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.location.api_keys ( + Description, + ExpireTime, + ForceUpdate, + KeyName, + NoExpiry, + Restrictions, + Tags, + ForceDelete, + region +) +SELECT + '{{ Description }}', + '{{ ExpireTime }}', + '{{ ForceUpdate }}', + '{{ KeyName }}', + '{{ NoExpiry }}', + '{{ Restrictions }}', + '{{ Tags }}', + '{{ ForceDelete }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: api_key + props: + - name: Description + value: '{{ Description }}' + - name: ExpireTime + value: '{{ ExpireTime }}' + - name: ForceUpdate + value: '{{ ForceUpdate }}' + - name: KeyName + value: '{{ KeyName }}' + - name: NoExpiry + value: '{{ NoExpiry }}' + - name: Restrictions + value: + AllowActions: + - '{{ AllowActions[0] }}' + AllowResources: + - '{{ AllowResources[0] }}' + AllowReferers: + - '{{ AllowReferers[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ForceDelete + value: '{{ ForceDelete }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.location.api_keys +WHERE data__Identifier = '' +AND 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, +geo-maps:GetTile, +geo-maps:GetStaticMap, +geo-places:Autocomplete, +geo-places:Geocode, +geo-places:GetPlace, +geo-places:ReverseGeocode, +geo-places:SearchNearby, +geo-places:SearchText, +geo-places:Suggest, +geo-routes:CalculateIsolines, +geo-routes:CalculateRouteMatrix, +geo-routes:CalculateRoutes, +geo-routes:OptimizeWaypoints, +geo-routes:SnapToRoads +``` + +### 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-maps:GetTile, +geo-maps:GetStaticMap, +geo-places:Autocomplete, +geo-places:Geocode, +geo-places:GetPlace, +geo-places:ReverseGeocode, +geo-places:SearchNearby, +geo-places:SearchText, +geo-places:Suggest, +geo-routes:CalculateIsolines, +geo-routes:CalculateRouteMatrix, +geo-routes:CalculateRoutes, +geo-routes:OptimizeWaypoints, +geo-routes:SnapToRoads, +geo:UpdateKey +``` + +### Delete +```json +geo:DeleteKey, +geo:DescribeKey +``` + +### List +```json +geo:ListKeys +``` diff --git a/website/docs/services/location/api_keys_list_only/index.md b/website/docs/services/location/api_keys_list_only/index.md new file mode 100644 index 0000000..964530a --- /dev/null +++ b/website/docs/services/location/api_keys_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: api_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - api_keys_list_only + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists api_keys in a region or regions, for all properties use api_keys + +## Overview + + + + + + + +
Nameapi_keys_list_only
TypeResource
DescriptionDefinition of AWS::Location::APIKey Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all api_keys in a region. +```sql +SELECT +region, +key_name +FROM aws.location.api_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_keys_list_only resource, see api_keys + diff --git a/website/docs/services/location/geofence_collection_tags/index.md b/website/docs/services/location/geofence_collection_tags/index.md new file mode 100644 index 0000000..6bfe633 --- /dev/null +++ b/website/docs/services/location/geofence_collection_tags/index.md @@ -0,0 +1,93 @@ +--- +title: geofence_collection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - geofence_collection_tags + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for geofence_collections in a region + +## Overview + + + + + + + +
Namegeofence_collection_tags
TypeResource
DescriptionDefinition of AWS::Location::GeofenceCollection Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
stringThis shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all geofence_collections in a region. +```sql +SELECT +region, +collection_arn, +collection_name, +create_time, +description, +kms_key_id, +pricing_plan, +pricing_plan_data_source, +update_time, +arn, +tag_key, +tag_value +FROM aws.location.geofence_collection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the geofence_collection_tags resource, see geofence_collections + diff --git a/website/docs/services/location/geofence_collections/index.md b/website/docs/services/location/geofence_collections/index.md new file mode 100644 index 0000000..d38f117 --- /dev/null +++ b/website/docs/services/location/geofence_collections/index.md @@ -0,0 +1,256 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a geofence_collection resource or lists geofence_collections in a region + +## Overview + + + + + + + +
Namegeofence_collections
TypeResource
DescriptionDefinition of AWS::Location::GeofenceCollection Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
stringThis shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
arrayAn array of key-value pairs to apply to this resource.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringAWS region.
+ +For more information, see AWS::Location::GeofenceCollection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all geofence_collections in a region. +```sql +SELECT +region, +collection_arn, +collection_name, +create_time, +description, +kms_key_id, +pricing_plan, +pricing_plan_data_source, +tags, +update_time, +arn +FROM aws.location.geofence_collections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual geofence_collection. +```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_collections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new geofence_collection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.location.geofence_collections ( + CollectionName, + region +) +SELECT +'{{ CollectionName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.location.geofence_collections ( + CollectionName, + Description, + KmsKeyId, + PricingPlan, + PricingPlanDataSource, + Tags, + region +) +SELECT + '{{ CollectionName }}', + '{{ Description }}', + '{{ KmsKeyId }}', + '{{ PricingPlan }}', + '{{ PricingPlanDataSource }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: geofence_collection + props: + - name: CollectionName + value: '{{ CollectionName }}' + - name: Description + value: '{{ Description }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: PricingPlan + value: '{{ PricingPlan }}' + - name: PricingPlanDataSource + value: '{{ PricingPlanDataSource }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.location.geofence_collections +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +geo:ListGeofenceCollections +``` diff --git a/website/docs/services/location/geofence_collections_list_only/index.md b/website/docs/services/location/geofence_collections_list_only/index.md new file mode 100644 index 0000000..db6f76f --- /dev/null +++ b/website/docs/services/location/geofence_collections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: geofence_collections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - geofence_collections_list_only + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists geofence_collections in a region or regions, for all properties use geofence_collections + +## Overview + + + + + + + +
Namegeofence_collections_list_only
TypeResource
DescriptionDefinition of AWS::Location::GeofenceCollection Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all geofence_collections in a region. +```sql +SELECT +region, +collection_name +FROM aws.location.geofence_collections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the geofence_collections_list_only resource, see geofence_collections + diff --git a/website/docs/services/location/index.md b/website/docs/services/location/index.md new file mode 100644 index 0000000..a296440 --- /dev/null +++ b/website/docs/services/location/index.md @@ -0,0 +1,55 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The location service documentation. + +:::info Service Summary + +
+
+total resources: 20
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/location/map_tags/index.md b/website/docs/services/location/map_tags/index.md new file mode 100644 index 0000000..658f49e --- /dev/null +++ b/website/docs/services/location/map_tags/index.md @@ -0,0 +1,91 @@ +--- +title: map_tags +hide_title: false +hide_table_of_contents: false +keywords: + - map_tags + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for maps in a region + +## Overview + + + + + + + +
Namemap_tags
TypeResource
DescriptionDefinition of AWS::Location::Map Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
object
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all maps in a region. +```sql +SELECT +region, +configuration, +create_time, +description, +map_arn, +map_name, +pricing_plan, +update_time, +arn, +tag_key, +tag_value +FROM aws.location.map_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the map_tags resource, see maps + diff --git a/website/docs/services/location/maps/index.md b/website/docs/services/location/maps/index.md new file mode 100644 index 0000000..d8ac5c0 --- /dev/null +++ b/website/docs/services/location/maps/index.md @@ -0,0 +1,250 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a map resource or lists maps in a region + +## Overview + + + + + + + +
Namemaps
TypeResource
DescriptionDefinition of AWS::Location::Map Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
object
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringAWS region.
+ +For more information, see AWS::Location::Map. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all maps in a region. +```sql +SELECT +region, +configuration, +create_time, +description, +map_arn, +map_name, +pricing_plan, +tags, +update_time, +arn +FROM aws.location.maps +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual map. +```sql +SELECT +region, +configuration, +create_time, +description, +map_arn, +map_name, +pricing_plan, +tags, +update_time, +arn +FROM aws.location.maps +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new map resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.location.maps ( + Configuration, + MapName, + region +) +SELECT +'{{ Configuration }}', + '{{ MapName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.location.maps ( + Configuration, + Description, + MapName, + PricingPlan, + Tags, + region +) +SELECT + '{{ Configuration }}', + '{{ Description }}', + '{{ MapName }}', + '{{ PricingPlan }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: map + props: + - name: Configuration + value: + Style: '{{ Style }}' + PoliticalView: '{{ PoliticalView }}' + CustomLayers: + - '{{ CustomLayers[0] }}' + - name: Description + value: '{{ Description }}' + - name: MapName + value: '{{ MapName }}' + - name: PricingPlan + value: '{{ PricingPlan }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.location.maps +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +geo:DescribeMap +``` + +### Update +```json +geo:CreateMap, +geo:DescribeMap, +geo:TagResource, +geo:UntagResource, +geo:UpdateMap +``` + +### Delete +```json +geo:DeleteMap, +geo:DescribeMap +``` + +### List +```json +geo:ListMaps +``` diff --git a/website/docs/services/location/maps_list_only/index.md b/website/docs/services/location/maps_list_only/index.md new file mode 100644 index 0000000..f705adf --- /dev/null +++ b/website/docs/services/location/maps_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: maps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - maps_list_only + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists maps in a region or regions, for all properties use maps + +## Overview + + + + + + + +
Namemaps_list_only
TypeResource
DescriptionDefinition of AWS::Location::Map Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all maps in a region. +```sql +SELECT +region, +map_name +FROM aws.location.maps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the maps_list_only resource, see maps + diff --git a/website/docs/services/location/place_index_tags/index.md b/website/docs/services/location/place_index_tags/index.md new file mode 100644 index 0000000..b17f05e --- /dev/null +++ b/website/docs/services/location/place_index_tags/index.md @@ -0,0 +1,93 @@ +--- +title: place_index_tags +hide_title: false +hide_table_of_contents: false +keywords: + - place_index_tags + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for place_indices in a region + +## Overview + + + + + + + +
Nameplace_index_tags
TypeResource
DescriptionDefinition of AWS::Location::PlaceIndex Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
object
string
string
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all place_indices in a region. +```sql +SELECT +region, +create_time, +data_source, +data_source_configuration, +description, +index_arn, +index_name, +pricing_plan, +update_time, +arn, +tag_key, +tag_value +FROM aws.location.place_index_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the place_index_tags resource, see place_indices + diff --git a/website/docs/services/location/place_indices/index.md b/website/docs/services/location/place_indices/index.md new file mode 100644 index 0000000..4a01cef --- /dev/null +++ b/website/docs/services/location/place_indices/index.md @@ -0,0 +1,254 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a place_index resource or lists place_indices in a region + +## Overview + + + + + + + +
Nameplace_indices
TypeResource
DescriptionDefinition of AWS::Location::PlaceIndex Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
object
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringAWS region.
+ +For more information, see AWS::Location::PlaceIndex. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all place_indices in a region. +```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_indices +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual place_index. +```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_indices +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new place_index resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.location.place_indices ( + DataSource, + IndexName, + region +) +SELECT +'{{ DataSource }}', + '{{ IndexName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.location.place_indices ( + DataSource, + DataSourceConfiguration, + Description, + IndexName, + PricingPlan, + Tags, + region +) +SELECT + '{{ DataSource }}', + '{{ DataSourceConfiguration }}', + '{{ Description }}', + '{{ IndexName }}', + '{{ PricingPlan }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: place_index + props: + - name: DataSource + value: '{{ DataSource }}' + - name: DataSourceConfiguration + value: + IntendedUse: '{{ IntendedUse }}' + - name: Description + value: '{{ Description }}' + - name: IndexName + value: '{{ IndexName }}' + - name: PricingPlan + value: '{{ PricingPlan }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.location.place_indices +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +geo:DescribePlaceIndex +``` + +### Update +```json +geo:CreatePlaceIndex, +geo:DescribePlaceIndex, +geo:TagResource, +geo:UntagResource, +geo:UpdatePlaceIndex +``` + +### Delete +```json +geo:DeletePlaceIndex, +geo:DescribePlaceIndex +``` + +### List +```json +geo:ListPlaceIndexes +``` diff --git a/website/docs/services/location/place_indices_list_only/index.md b/website/docs/services/location/place_indices_list_only/index.md new file mode 100644 index 0000000..062d5f5 --- /dev/null +++ b/website/docs/services/location/place_indices_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: place_indices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - place_indices_list_only + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists place_indices in a region or regions, for all properties use place_indices + +## Overview + + + + + + + +
Nameplace_indices_list_only
TypeResource
DescriptionDefinition of AWS::Location::PlaceIndex Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all place_indices in a region. +```sql +SELECT +region, +index_name +FROM aws.location.place_indices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the place_indices_list_only resource, see place_indices + diff --git a/website/docs/services/location/route_calculator_tags/index.md b/website/docs/services/location/route_calculator_tags/index.md new file mode 100644 index 0000000..52b16b7 --- /dev/null +++ b/website/docs/services/location/route_calculator_tags/index.md @@ -0,0 +1,91 @@ +--- +title: route_calculator_tags +hide_title: false +hide_table_of_contents: false +keywords: + - route_calculator_tags + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for route_calculators in a region + +## Overview + + + + + + + +
Nameroute_calculator_tags
TypeResource
DescriptionDefinition of AWS::Location::RouteCalculator Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all route_calculators in a region. +```sql +SELECT +region, +calculator_arn, +calculator_name, +create_time, +data_source, +description, +pricing_plan, +update_time, +arn, +tag_key, +tag_value +FROM aws.location.route_calculator_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_calculator_tags resource, see route_calculators + diff --git a/website/docs/services/location/route_calculators/index.md b/website/docs/services/location/route_calculators/index.md new file mode 100644 index 0000000..cb4bacb --- /dev/null +++ b/website/docs/services/location/route_calculators/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a route_calculator resource or lists route_calculators in a region + +## Overview + + + + + + + +
Nameroute_calculators
TypeResource
DescriptionDefinition of AWS::Location::RouteCalculator Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringAWS region.
+ +For more information, see AWS::Location::RouteCalculator. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all route_calculators in a region. +```sql +SELECT +region, +calculator_arn, +calculator_name, +create_time, +data_source, +description, +pricing_plan, +tags, +update_time, +arn +FROM aws.location.route_calculators +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual route_calculator. +```sql +SELECT +region, +calculator_arn, +calculator_name, +create_time, +data_source, +description, +pricing_plan, +tags, +update_time, +arn +FROM aws.location.route_calculators +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new route_calculator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.location.route_calculators ( + CalculatorName, + DataSource, + region +) +SELECT +'{{ CalculatorName }}', + '{{ DataSource }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.location.route_calculators ( + CalculatorName, + DataSource, + Description, + PricingPlan, + Tags, + region +) +SELECT + '{{ CalculatorName }}', + '{{ DataSource }}', + '{{ Description }}', + '{{ PricingPlan }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: route_calculator + props: + - name: CalculatorName + value: '{{ CalculatorName }}' + - name: DataSource + value: '{{ DataSource }}' + - name: Description + value: '{{ Description }}' + - name: PricingPlan + value: '{{ PricingPlan }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.location.route_calculators +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +geo:DescribeRouteCalculator +``` + +### Update +```json +geo:CreateRouteCalculator, +geo:DescribeRouteCalculator, +geo:TagResource, +geo:UntagResource, +geo:UpdateRouteCalculator +``` + +### Delete +```json +geo:DeleteRouteCalculator, +geo:DescribeRouteCalculator +``` + +### List +```json +geo:ListRouteCalculators +``` diff --git a/website/docs/services/location/route_calculators_list_only/index.md b/website/docs/services/location/route_calculators_list_only/index.md new file mode 100644 index 0000000..05c87c1 --- /dev/null +++ b/website/docs/services/location/route_calculators_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: route_calculators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - route_calculators_list_only + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists route_calculators in a region or regions, for all properties use route_calculators + +## Overview + + + + + + + +
Nameroute_calculators_list_only
TypeResource
DescriptionDefinition of AWS::Location::RouteCalculator Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all route_calculators in a region. +```sql +SELECT +region, +calculator_name +FROM aws.location.route_calculators_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_calculators_list_only resource, see route_calculators + diff --git a/website/docs/services/location/tracker_consumers/index.md b/website/docs/services/location/tracker_consumers/index.md new file mode 100644 index 0000000..e9a41c9 --- /dev/null +++ b/website/docs/services/location/tracker_consumers/index.md @@ -0,0 +1,195 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a tracker_consumer resource or lists tracker_consumers in a region + +## Overview + + + + + + + +
Nametracker_consumers
TypeResource
DescriptionDefinition of AWS::Location::TrackerConsumer Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +For more information, see AWS::Location::TrackerConsumer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all tracker_consumers in a region. +```sql +SELECT +region, +consumer_arn, +tracker_name +FROM aws.location.tracker_consumers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual tracker_consumer. +```sql +SELECT +region, +consumer_arn, +tracker_name +FROM aws.location.tracker_consumers +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tracker_consumer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.location.tracker_consumers ( + ConsumerArn, + TrackerName, + region +) +SELECT +'{{ ConsumerArn }}', + '{{ TrackerName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.location.tracker_consumers ( + ConsumerArn, + TrackerName, + region +) +SELECT + '{{ ConsumerArn }}', + '{{ TrackerName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: tracker_consumer + props: + - name: ConsumerArn + value: '{{ ConsumerArn }}' + - name: TrackerName + value: '{{ TrackerName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.location.tracker_consumers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the tracker_consumers resource, the following permissions are required: + +### Create +```json +geo:AssociateTrackerConsumer, +geo:ListTrackerConsumers +``` + +### Delete +```json +geo:DisassociateTrackerConsumer, +geo:ListTrackerConsumers +``` + +### List +```json +geo:ListTrackerConsumers +``` + +### Read +```json +geo:ListTrackerConsumers +``` diff --git a/website/docs/services/location/tracker_consumers_list_only/index.md b/website/docs/services/location/tracker_consumers_list_only/index.md new file mode 100644 index 0000000..6c06460 --- /dev/null +++ b/website/docs/services/location/tracker_consumers_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: tracker_consumers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tracker_consumers_list_only + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tracker_consumers in a region or regions, for all properties use tracker_consumers + +## Overview + + + + + + + +
Nametracker_consumers_list_only
TypeResource
DescriptionDefinition of AWS::Location::TrackerConsumer Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tracker_consumers in a region. +```sql +SELECT +region, +tracker_name, +consumer_arn +FROM aws.location.tracker_consumers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tracker_consumers_list_only resource, see tracker_consumers + diff --git a/website/docs/services/location/tracker_tags/index.md b/website/docs/services/location/tracker_tags/index.md new file mode 100644 index 0000000..22352a9 --- /dev/null +++ b/website/docs/services/location/tracker_tags/index.md @@ -0,0 +1,99 @@ +--- +title: tracker_tags +hide_title: false +hide_table_of_contents: false +keywords: + - tracker_tags + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for trackers in a region + +## Overview + + + + + + + +
Nametracker_tags
TypeResource
DescriptionDefinition of AWS::Location::Tracker Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
boolean
boolean
string
string
string
stringThis shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all trackers in a region. +```sql +SELECT +region, +create_time, +description, +event_bridge_enabled, +kms_key_enable_geospatial_queries, +kms_key_id, +position_filtering, +pricing_plan, +pricing_plan_data_source, +tracker_arn, +tracker_name, +update_time, +arn, +tag_key, +tag_value +FROM aws.location.tracker_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tracker_tags resource, see trackers + diff --git a/website/docs/services/location/trackers/index.md b/website/docs/services/location/trackers/index.md new file mode 100644 index 0000000..2cfb96f --- /dev/null +++ b/website/docs/services/location/trackers/index.md @@ -0,0 +1,277 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a tracker resource or lists trackers in a region + +## Overview + + + + + + + +
Nametrackers
TypeResource
DescriptionDefinition of AWS::Location::Tracker Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
boolean
boolean
string
string
string
stringThis shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
arrayAn array of key-value pairs to apply to this resource.
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringAWS region.
+ +For more information, see AWS::Location::Tracker. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all trackers in a region. +```sql +SELECT +region, +create_time, +description, +event_bridge_enabled, +kms_key_enable_geospatial_queries, +kms_key_id, +position_filtering, +pricing_plan, +pricing_plan_data_source, +tags, +tracker_arn, +tracker_name, +update_time, +arn +FROM aws.location.trackers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual tracker. +```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.trackers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tracker resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.location.trackers ( + TrackerName, + region +) +SELECT +'{{ TrackerName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.location.trackers ( + Description, + EventBridgeEnabled, + KmsKeyEnableGeospatialQueries, + KmsKeyId, + PositionFiltering, + PricingPlan, + PricingPlanDataSource, + Tags, + TrackerName, + region +) +SELECT + '{{ Description }}', + '{{ EventBridgeEnabled }}', + '{{ KmsKeyEnableGeospatialQueries }}', + '{{ KmsKeyId }}', + '{{ PositionFiltering }}', + '{{ PricingPlan }}', + '{{ PricingPlanDataSource }}', + '{{ Tags }}', + '{{ TrackerName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: tracker + props: + - name: Description + value: '{{ Description }}' + - name: EventBridgeEnabled + value: '{{ EventBridgeEnabled }}' + - name: KmsKeyEnableGeospatialQueries + value: '{{ KmsKeyEnableGeospatialQueries }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: PositionFiltering + value: '{{ PositionFiltering }}' + - name: PricingPlan + value: '{{ PricingPlan }}' + - name: PricingPlanDataSource + value: '{{ PricingPlanDataSource }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TrackerName + value: '{{ TrackerName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.location.trackers +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +geo:ListTrackers +``` diff --git a/website/docs/services/location/trackers_list_only/index.md b/website/docs/services/location/trackers_list_only/index.md new file mode 100644 index 0000000..8d10e3d --- /dev/null +++ b/website/docs/services/location/trackers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: trackers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trackers_list_only + - location + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trackers in a region or regions, for all properties use trackers + +## Overview + + + + + + + +
Nametrackers_list_only
TypeResource
DescriptionDefinition of AWS::Location::Tracker Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trackers in a region. +```sql +SELECT +region, +tracker_name +FROM aws.location.trackers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trackers_list_only resource, see trackers + diff --git a/website/docs/services/logs/account_policies/index.md b/website/docs/services/logs/account_policies/index.md new file mode 100644 index 0000000..7cafe89 --- /dev/null +++ b/website/docs/services/logs/account_policies/index.md @@ -0,0 +1,261 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an account_policy resource or lists account_policies in a region + +## Overview + + + + + + + +
Nameaccount_policies
TypeResource
DescriptionThe AWS::Logs::AccountPolicy resource specifies a CloudWatch Logs AccountPolicy.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringUser account id
stringThe name of the account policy
stringThe body of the policy document you want to use for this topic.
You can only add one policy per PolicyType.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30720
stringType of the policy.
stringScope for policy application
stringLog group selection criteria to apply policy only to a subset of log groups. SelectionCriteria string can be up to 25KB and cloudwatchlogs determines the length of selectionCriteria by using its UTF-8 bytes
stringAWS region.
+ +For more information, see AWS::Logs::AccountPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all account_policies in a region. +```sql +SELECT +region, +account_id, +policy_name, +policy_document, +policy_type, +scope, +selection_criteria +FROM aws.logs.account_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual account_policy. +```sql +SELECT +region, +account_id, +policy_name, +policy_document, +policy_type, +scope, +selection_criteria +FROM aws.logs.account_policies +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new account_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.account_policies ( + PolicyName, + PolicyDocument, + PolicyType, + region +) +SELECT +'{{ PolicyName }}', + '{{ PolicyDocument }}', + '{{ PolicyType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.account_policies ( + PolicyName, + PolicyDocument, + PolicyType, + Scope, + SelectionCriteria, + region +) +SELECT + '{{ PolicyName }}', + '{{ PolicyDocument }}', + '{{ PolicyType }}', + '{{ Scope }}', + '{{ SelectionCriteria }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: account_policy + props: + - name: PolicyName + value: '{{ PolicyName }}' + - name: PolicyDocument + value: '{{ PolicyDocument }}' + - name: PolicyType + value: '{{ PolicyType }}' + - name: Scope + value: '{{ Scope }}' + - name: SelectionCriteria + value: '{{ SelectionCriteria }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.account_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the account_policies resource, the following permissions are required: + +### Create +```json +logs:PutAccountPolicy, +logs:PutIndexPolicy, +logs:PutDataProtectionPolicy, +logs:DescribeAccountPolicies, +logs:CreateLogDelivery, +s3:REST.PUT.OBJECT, +firehose:TagDeliveryStream, +logs:PutSubscriptionFilter, +logs:DeleteSubscriptionFilter, +logs:PutTransformer, +iam:PassRole +``` + +### Read +```json +logs:DescribeAccountPolicies, +logs:GetTransformer +``` + +### Update +```json +logs:PutAccountPolicy, +logs:PutIndexPolicy, +logs:PutDataProtectionPolicy, +logs:DescribeAccountPolicies, +logs:DeleteAccountPolicy, +logs:DeleteIndexPolicy, +logs:DeleteDataProtectionPolicy, +logs:CreateLogDelivery, +logs:PutSubscriptionFilter, +logs:DeleteSubscriptionFilter, +logs:PutTransformer, +logs:DeleteTransformer, +s3:REST.PUT.OBJECT, +firehose:TagDeliveryStream, +iam:PassRole +``` + +### Delete +```json +logs:DeleteAccountPolicy, +logs:DeleteIndexPolicy, +logs:DeleteDataProtectionPolicy, +logs:DescribeAccountPolicies, +logs:DeleteSubscriptionFilter, +logs:DeleteTransformer, +iam:PassRole +``` + +### List +```json +logs:DescribeAccountPolicies, +logs:GetTransformer +``` diff --git a/website/docs/services/logs/account_policies_list_only/index.md b/website/docs/services/logs/account_policies_list_only/index.md new file mode 100644 index 0000000..ab1f7ca --- /dev/null +++ b/website/docs/services/logs/account_policies_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: account_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - account_policies_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists account_policies in a region or regions, for all properties use account_policies + +## Overview + + + + + + + +
Nameaccount_policies_list_only
TypeResource
DescriptionThe AWS::Logs::AccountPolicy resource specifies a CloudWatch Logs AccountPolicy.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringUser account id
stringThe name of the account policy
stringType of the policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all account_policies in a region. +```sql +SELECT +region, +account_id, +policy_type, +policy_name +FROM aws.logs.account_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the account_policies_list_only resource, see account_policies + diff --git a/website/docs/services/logs/deliveries/index.md b/website/docs/services/logs/deliveries/index.md new file mode 100644 index 0000000..3981f8d --- /dev/null +++ b/website/docs/services/logs/deliveries/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a delivery resource or lists deliveries in a region + +## Overview + + + + + + + +
Namedeliveries
TypeResource
DescriptionThis structure contains information about one delivery in your account.
A delivery is a connection between a logical delivery source and a logical delivery destination.
For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique ID that identifies this delivery in your account.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery.
stringThe name of the delivery source that is associated with this delivery.
stringThe ARN of the delivery destination that is associated with this delivery.
stringDisplays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
arrayThe tags that have been assigned to this delivery.
arrayThe list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.
stringThe field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
stringThis string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.
booleanThis parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
stringAWS region.
+ +For more information, see AWS::Logs::Delivery. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all deliveries in a region. +```sql +SELECT +region, +delivery_id, +arn, +delivery_source_name, +delivery_destination_arn, +delivery_destination_type, +tags, +record_fields, +field_delimiter, +s3_suffix_path, +s3_enable_hive_compatible_path +FROM aws.logs.deliveries +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual delivery. +```sql +SELECT +region, +delivery_id, +arn, +delivery_source_name, +delivery_destination_arn, +delivery_destination_type, +tags, +record_fields, +field_delimiter, +s3_suffix_path, +s3_enable_hive_compatible_path +FROM aws.logs.deliveries +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new delivery resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.deliveries ( + DeliverySourceName, + DeliveryDestinationArn, + region +) +SELECT +'{{ DeliverySourceName }}', + '{{ DeliveryDestinationArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.deliveries ( + DeliverySourceName, + DeliveryDestinationArn, + Tags, + RecordFields, + FieldDelimiter, + S3SuffixPath, + S3EnableHiveCompatiblePath, + region +) +SELECT + '{{ DeliverySourceName }}', + '{{ DeliveryDestinationArn }}', + '{{ Tags }}', + '{{ RecordFields }}', + '{{ FieldDelimiter }}', + '{{ S3SuffixPath }}', + '{{ S3EnableHiveCompatiblePath }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: delivery + props: + - name: DeliverySourceName + value: '{{ DeliverySourceName }}' + - name: DeliveryDestinationArn + value: '{{ DeliveryDestinationArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: RecordFields + value: + - '{{ RecordFields[0] }}' + - name: FieldDelimiter + value: '{{ FieldDelimiter }}' + - name: S3SuffixPath + value: '{{ S3SuffixPath }}' + - name: S3EnableHiveCompatiblePath + value: '{{ S3EnableHiveCompatiblePath }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.deliveries +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +logs:GetDelivery, +logs:ListTagsForResource +``` + +### Update +```json +logs:GetDelivery, +logs:ListTagsForResource, +logs:TagResource, +logs:UntagResource +``` + +### Delete +```json +logs:DeleteDelivery, +logs:ListTagsForResource, +logs:UntagResource +``` + +### List +```json +logs:DescribeDeliveries, +logs:ListTagsForResource +``` diff --git a/website/docs/services/logs/deliveries_list_only/index.md b/website/docs/services/logs/deliveries_list_only/index.md new file mode 100644 index 0000000..ec04f81 --- /dev/null +++ b/website/docs/services/logs/deliveries_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: deliveries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deliveries_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deliveries in a region or regions, for all properties use deliveries + +## Overview + + + + + + + +
Namedeliveries_list_only
TypeResource
DescriptionThis structure contains information about one delivery in your account.
A delivery is a connection between a logical delivery source and a logical delivery destination.
For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique ID that identifies this delivery in your account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deliveries in a region. +```sql +SELECT +region, +delivery_id +FROM aws.logs.deliveries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deliveries_list_only resource, see deliveries + diff --git a/website/docs/services/logs/delivery_destination_tags/index.md b/website/docs/services/logs/delivery_destination_tags/index.md new file mode 100644 index 0000000..9617e8b --- /dev/null +++ b/website/docs/services/logs/delivery_destination_tags/index.md @@ -0,0 +1,87 @@ +--- +title: delivery_destination_tags +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_destination_tags + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for delivery_destinations in a region + +## Overview + + + + + + + +
Namedelivery_destination_tags
TypeResource
DescriptionThis structure contains information about one delivery destination in your account.
A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of this delivery destination.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
stringThe ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
stringDisplays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
objectIAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.
The policy must be in JSON string format.
Length Constraints: Maximum length of 51200
stringThe format of the logs that are sent to this delivery destination.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all delivery_destinations in a region. +```sql +SELECT +region, +name, +arn, +destination_resource_arn, +delivery_destination_type, +delivery_destination_policy, +output_format, +tag_key, +tag_value +FROM aws.logs.delivery_destination_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_destination_tags resource, see delivery_destinations + diff --git a/website/docs/services/logs/delivery_destinations/index.md b/website/docs/services/logs/delivery_destinations/index.md new file mode 100644 index 0000000..e973b08 --- /dev/null +++ b/website/docs/services/logs/delivery_destinations/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a delivery_destination resource or lists delivery_destinations in a region + +## Overview + + + + + + + +
Namedelivery_destinations
TypeResource
DescriptionThis structure contains information about one delivery destination in your account.
A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of this delivery destination.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
stringThe ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
arrayThe tags that have been assigned to this delivery destination.
stringDisplays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
objectIAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.
The policy must be in JSON string format.
Length Constraints: Maximum length of 51200
stringThe format of the logs that are sent to this delivery destination.
stringAWS region.
+ +For more information, see AWS::Logs::DeliveryDestination. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all delivery_destinations in a region. +```sql +SELECT +region, +name, +arn, +destination_resource_arn, +tags, +delivery_destination_type, +delivery_destination_policy, +output_format +FROM aws.logs.delivery_destinations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual delivery_destination. +```sql +SELECT +region, +name, +arn, +destination_resource_arn, +tags, +delivery_destination_type, +delivery_destination_policy, +output_format +FROM aws.logs.delivery_destinations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new delivery_destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.delivery_destinations ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.delivery_destinations ( + Name, + DestinationResourceArn, + Tags, + DeliveryDestinationPolicy, + OutputFormat, + region +) +SELECT + '{{ Name }}', + '{{ DestinationResourceArn }}', + '{{ Tags }}', + '{{ DeliveryDestinationPolicy }}', + '{{ OutputFormat }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: delivery_destination + props: + - name: Name + value: '{{ Name }}' + - name: DestinationResourceArn + value: '{{ DestinationResourceArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: DeliveryDestinationPolicy + value: {} + - name: OutputFormat + value: '{{ OutputFormat }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.delivery_destinations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +logs:DescribeDeliveryDestinations, +logs:GetDeliveryDestinationPolicy +``` diff --git a/website/docs/services/logs/delivery_destinations_list_only/index.md b/website/docs/services/logs/delivery_destinations_list_only/index.md new file mode 100644 index 0000000..f9a0277 --- /dev/null +++ b/website/docs/services/logs/delivery_destinations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: delivery_destinations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_destinations_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists delivery_destinations in a region or regions, for all properties use delivery_destinations + +## Overview + + + + + + + +
Namedelivery_destinations_list_only
TypeResource
DescriptionThis structure contains information about one delivery destination in your account.
A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of this delivery destination.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all delivery_destinations in a region. +```sql +SELECT +region, +name +FROM aws.logs.delivery_destinations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_destinations_list_only resource, see delivery_destinations + diff --git a/website/docs/services/logs/delivery_source_tags/index.md b/website/docs/services/logs/delivery_source_tags/index.md new file mode 100644 index 0000000..55c7ce4 --- /dev/null +++ b/website/docs/services/logs/delivery_source_tags/index.md @@ -0,0 +1,87 @@ +--- +title: delivery_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_source_tags + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for delivery_sources in a region + +## Overview + + + + + + + +
Namedelivery_source_tags
TypeResource
DescriptionA delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the Log source.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery source.
arrayThis array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.
stringThe ARN of the resource that will be sending the logs.
stringThe AWS service that is sending logs.
stringThe type of logs being delivered. Only mandatory when the resourceArn could match more than one. In such a case, the error message will contain all the possible options.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all delivery_sources in a region. +```sql +SELECT +region, +name, +arn, +resource_arns, +resource_arn, +service, +log_type, +tag_key, +tag_value +FROM aws.logs.delivery_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_source_tags resource, see delivery_sources + diff --git a/website/docs/services/logs/delivery_sources/index.md b/website/docs/services/logs/delivery_sources/index.md new file mode 100644 index 0000000..dc6dbf7 --- /dev/null +++ b/website/docs/services/logs/delivery_sources/index.md @@ -0,0 +1,238 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a delivery_source resource or lists delivery_sources in a region + +## Overview + + + + + + + +
Namedelivery_sources
TypeResource
DescriptionA delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the Log source.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery source.
arrayThis array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.
stringThe ARN of the resource that will be sending the logs.
stringThe AWS service that is sending logs.
stringThe type of logs being delivered. Only mandatory when the resourceArn could match more than one. In such a case, the error message will contain all the possible options.
arrayThe tags that have been assigned to this delivery source.
stringAWS region.
+ +For more information, see AWS::Logs::DeliverySource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all delivery_sources in a region. +```sql +SELECT +region, +name, +arn, +resource_arns, +resource_arn, +service, +log_type, +tags +FROM aws.logs.delivery_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual delivery_source. +```sql +SELECT +region, +name, +arn, +resource_arns, +resource_arn, +service, +log_type, +tags +FROM aws.logs.delivery_sources +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new delivery_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.delivery_sources ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.delivery_sources ( + Name, + ResourceArn, + LogType, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ ResourceArn }}', + '{{ LogType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: delivery_source + props: + - name: Name + value: '{{ Name }}' + - name: ResourceArn + value: '{{ ResourceArn }}' + - name: LogType + value: '{{ LogType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.delivery_sources +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +logs:GetDeliverySource, +logs:ListTagsForResource +``` + +### Update +```json +logs:PutDeliverySource, +logs:GetDeliverySource, +logs:ListTagsForResource, +logs:TagResource, +logs:UntagResource +``` + +### Delete +```json +logs:DeleteDeliverySource +``` + +### List +```json +logs:DescribeDeliverySources +``` diff --git a/website/docs/services/logs/delivery_sources_list_only/index.md b/website/docs/services/logs/delivery_sources_list_only/index.md new file mode 100644 index 0000000..e364fab --- /dev/null +++ b/website/docs/services/logs/delivery_sources_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: delivery_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_sources_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists delivery_sources in a region or regions, for all properties use delivery_sources + +## Overview + + + + + + + +
Namedelivery_sources_list_only
TypeResource
DescriptionA delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique name of the Log source.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all delivery_sources in a region. +```sql +SELECT +region, +name +FROM aws.logs.delivery_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_sources_list_only resource, see delivery_sources + diff --git a/website/docs/services/logs/delivery_tags/index.md b/website/docs/services/logs/delivery_tags/index.md new file mode 100644 index 0000000..fbd2902 --- /dev/null +++ b/website/docs/services/logs/delivery_tags/index.md @@ -0,0 +1,93 @@ +--- +title: delivery_tags +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_tags + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for deliveries in a region + +## Overview + + + + + + + +
Namedelivery_tags
TypeResource
DescriptionThis structure contains information about one delivery in your account.
A delivery is a connection between a logical delivery source and a logical delivery destination.
For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique ID that identifies this delivery in your account.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery.
stringThe name of the delivery source that is associated with this delivery.
stringThe ARN of the delivery destination that is associated with this delivery.
stringDisplays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
arrayThe list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.
stringThe field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
stringThis string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.
booleanThis parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all deliveries in a region. +```sql +SELECT +region, +delivery_id, +arn, +delivery_source_name, +delivery_destination_arn, +delivery_destination_type, +record_fields, +field_delimiter, +s3_suffix_path, +s3_enable_hive_compatible_path, +tag_key, +tag_value +FROM aws.logs.delivery_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_tags resource, see deliveries + diff --git a/website/docs/services/logs/destinations/index.md b/website/docs/services/logs/destinations/index.md new file mode 100644 index 0000000..1809689 --- /dev/null +++ b/website/docs/services/logs/destinations/index.md @@ -0,0 +1,228 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a destination resource or lists 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.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the destination resource
stringAn IAM policy document that governs which AWS accounts can create subscription filters against this destination.
stringThe ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource
stringThe ARN of the physical target where the log events are delivered (for example, a Kinesis stream)
stringAWS region.
+ +For more information, see AWS::Logs::Destination. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all destinations in a region. +```sql +SELECT +region, +arn, +destination_name, +destination_policy, +role_arn, +target_arn +FROM aws.logs.destinations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual destination. +```sql +SELECT +region, +arn, +destination_name, +destination_policy, +role_arn, +target_arn +FROM aws.logs.destinations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.destinations ( + DestinationName, + RoleArn, + TargetArn, + region +) +SELECT +'{{ DestinationName }}', + '{{ RoleArn }}', + '{{ TargetArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.destinations ( + DestinationName, + DestinationPolicy, + RoleArn, + TargetArn, + region +) +SELECT + '{{ DestinationName }}', + '{{ DestinationPolicy }}', + '{{ RoleArn }}', + '{{ TargetArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: destination + props: + - name: DestinationName + value: '{{ DestinationName }}' + - name: DestinationPolicy + value: '{{ DestinationPolicy }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: TargetArn + value: '{{ TargetArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.destinations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +logs:DescribeDestinations +``` + +### Update +```json +logs:PutDestination, +logs:PutDestinationPolicy, +logs:DescribeDestinations, +iam:PassRole +``` + +### Delete +```json +logs:DeleteDestination +``` + +### List +```json +logs:DescribeDestinations +``` diff --git a/website/docs/services/logs/destinations_list_only/index.md b/website/docs/services/logs/destinations_list_only/index.md new file mode 100644 index 0000000..eb2e039 --- /dev/null +++ b/website/docs/services/logs/destinations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: destinations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - destinations_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists destinations in a region or regions, for all properties use destinations + +## Overview + + + + + + + +
Namedestinations_list_only
TypeResource
DescriptionThe AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the destination resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all destinations in a region. +```sql +SELECT +region, +destination_name +FROM aws.logs.destinations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the destinations_list_only resource, see destinations + diff --git a/website/docs/services/logs/index.md b/website/docs/services/logs/index.md new file mode 100644 index 0000000..1eb2dca --- /dev/null +++ b/website/docs/services/logs/index.md @@ -0,0 +1,64 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The logs service documentation. + +:::info Service Summary + +
+
+total resources: 29
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/logs/integrations/index.md b/website/docs/services/logs/integrations/index.md new file mode 100644 index 0000000..b9b29f5 --- /dev/null +++ b/website/docs/services/logs/integrations/index.md @@ -0,0 +1,251 @@ +--- +title: integrations +hide_title: false +hide_table_of_contents: false +keywords: + - integrations + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an integration resource or lists integrations in a region + +## Overview + + + + + + + +
Nameintegrations
TypeResource
DescriptionResource Schema for Logs Integration Resource
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringUser provided identifier for integration, unique to the user account.
stringThe type of the Integration.
objectOpenSearchResourceConfig for the given Integration
stringStatus of creation for the Integration and its resources
stringAWS region.
+ +For more information, see AWS::Logs::Integration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all integrations in a region. +```sql +SELECT +region, +integration_name, +integration_type, +resource_config, +integration_status +FROM aws.logs.integrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual integration. +```sql +SELECT +region, +integration_name, +integration_type, +resource_config, +integration_status +FROM aws.logs.integrations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.integrations ( + IntegrationName, + IntegrationType, + ResourceConfig, + region +) +SELECT +'{{ IntegrationName }}', + '{{ IntegrationType }}', + '{{ ResourceConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.integrations ( + IntegrationName, + IntegrationType, + ResourceConfig, + region +) +SELECT + '{{ IntegrationName }}', + '{{ IntegrationType }}', + '{{ ResourceConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: integration + props: + - name: IntegrationName + value: '{{ IntegrationName }}' + - name: IntegrationType + value: '{{ IntegrationType }}' + - name: ResourceConfig + value: + OpenSearchResourceConfig: + KmsKeyArn: '{{ KmsKeyArn }}' + DataSourceRoleArn: null + DashboardViewerPrincipals: + - null + ApplicationARN: null + RetentionDays: '{{ RetentionDays }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.integrations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the integrations resource, the following permissions are required: + +### Create +```json +logs:PutIntegration, +logs:GetIntegration, +aoss:CreateCollection, +aoss:CreateSecurityPolicy, +aoss:CreateAccessPolicy, +aoss:CreateLifeCyclePolicy, +aoss:BatchGetCollection, +aoss:DeleteCollection, +aoss:DeleteSecurityPolicy, +aoss:DeleteAccessPolicy, +aoss:DeleteLifeCyclePolicy, +aoss:GetAccessPolicy, +aoss:GetSecurityPolicy, +aoss:BatchGetLifecyclePolicy, +aoss:TagResource, +aoss:APIAccessAll, +opensearch:AddDirectQueryDataSource, +opensearch:DeleteDirectQueryDataSource, +opensearch:GetDirectQueryDataSource, +opensearch:CreateApplication, +opensearch:GetApplication, +opensearch:UpdateApplication, +opensearch:DeleteApplication, +opensearch:ApplicationAccessAll, +opensearch:DashboardsAccessAll, +opensearch:StartDirectQuery, +opensearch:GetDirectQuery, +iam:PassRole, +iam:CreateServiceLinkedRole, +iam:AttachRolePolicy, +iam:AttachUserPolicy, +es:AddDirectQueryDataSource, +es:CreateApplication, +es:UpdateApplication, +es:GetApplication, +es:DeleteApplication, +es:DeleteDirectQueryDataSource, +es:GetDirectQueryDataSource, +es:AddTags, +es:ListApplications +``` + +### Read +```json +logs:GetIntegration +``` + +### Delete +```json +logs:DeleteIntegration +``` + +### List +```json +logs:ListIntegrations +``` diff --git a/website/docs/services/logs/integrations_list_only/index.md b/website/docs/services/logs/integrations_list_only/index.md new file mode 100644 index 0000000..6b70f4d --- /dev/null +++ b/website/docs/services/logs/integrations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integrations_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integrations in a region or regions, for all properties use integrations + +## Overview + + + + + + + +
Nameintegrations_list_only
TypeResource
DescriptionResource Schema for Logs Integration Resource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUser provided identifier for integration, unique to the user account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integrations in a region. +```sql +SELECT +region, +integration_name +FROM aws.logs.integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integrations_list_only resource, see integrations + diff --git a/website/docs/services/logs/log_anomaly_detectors/index.md b/website/docs/services/logs/log_anomaly_detectors/index.md new file mode 100644 index 0000000..f0f8d79 --- /dev/null +++ b/website/docs/services/logs/log_anomaly_detectors/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a log_anomaly_detector resource or lists log_anomaly_detectors in a region + +## Overview + + + + + + + +
Namelog_anomaly_detectors
TypeResource
DescriptionThe AWS::Logs::LogAnomalyDetector resource specifies a CloudWatch Logs LogAnomalyDetector.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAccount ID for owner of detector
stringThe Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
stringName of detector
arrayList of Arns for the given log group
stringHow often log group is evaluated
string
stringCurrent status of detector.
number
numberWhen detector was created.
numberWhen detector was lsat modified.
stringARN of LogAnomalyDetector
stringAWS region.
+ +For more information, see AWS::Logs::LogAnomalyDetector. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all log_anomaly_detectors in a region. +```sql +SELECT +region, +account_id, +kms_key_id, +detector_name, +log_group_arn_list, +evaluation_frequency, +filter_pattern, +anomaly_detector_status, +anomaly_visibility_time, +creation_time_stamp, +last_modified_time_stamp, +anomaly_detector_arn +FROM aws.logs.log_anomaly_detectors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual log_anomaly_detector. +```sql +SELECT +region, +account_id, +kms_key_id, +detector_name, +log_group_arn_list, +evaluation_frequency, +filter_pattern, +anomaly_detector_status, +anomaly_visibility_time, +creation_time_stamp, +last_modified_time_stamp, +anomaly_detector_arn +FROM aws.logs.log_anomaly_detectors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new log_anomaly_detector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.log_anomaly_detectors ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.log_anomaly_detectors ( + AccountId, + KmsKeyId, + DetectorName, + LogGroupArnList, + EvaluationFrequency, + FilterPattern, + AnomalyVisibilityTime, + region +) +SELECT + '{{ AccountId }}', + '{{ KmsKeyId }}', + '{{ DetectorName }}', + '{{ LogGroupArnList }}', + '{{ EvaluationFrequency }}', + '{{ FilterPattern }}', + '{{ AnomalyVisibilityTime }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: log_anomaly_detector + props: + - name: AccountId + value: '{{ AccountId }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: DetectorName + value: '{{ DetectorName }}' + - name: LogGroupArnList + value: + - '{{ LogGroupArnList[0] }}' + - name: EvaluationFrequency + value: '{{ EvaluationFrequency }}' + - name: FilterPattern + value: '{{ FilterPattern }}' + - name: AnomalyVisibilityTime + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.log_anomaly_detectors +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the log_anomaly_detectors resource, the following permissions are required: + +### Create +```json +logs:CreateLogAnomalyDetector +``` + +### Read +```json +logs:GetLogAnomalyDetector +``` + +### Update +```json +logs:UpdateLogAnomalyDetector +``` + +### Delete +```json +logs:DeleteLogAnomalyDetector +``` + +### List +```json +logs:ListLogAnomalyDetectors +``` diff --git a/website/docs/services/logs/log_anomaly_detectors_list_only/index.md b/website/docs/services/logs/log_anomaly_detectors_list_only/index.md new file mode 100644 index 0000000..77bee16 --- /dev/null +++ b/website/docs/services/logs/log_anomaly_detectors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: log_anomaly_detectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - log_anomaly_detectors_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists log_anomaly_detectors in a region or regions, for all properties use log_anomaly_detectors + +## Overview + + + + + + + +
Namelog_anomaly_detectors_list_only
TypeResource
DescriptionThe AWS::Logs::LogAnomalyDetector resource specifies a CloudWatch Logs LogAnomalyDetector.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringARN of LogAnomalyDetector
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all log_anomaly_detectors in a region. +```sql +SELECT +region, +anomaly_detector_arn +FROM aws.logs.log_anomaly_detectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the log_anomaly_detectors_list_only resource, see log_anomaly_detectors + diff --git a/website/docs/services/logs/log_streams/index.md b/website/docs/services/logs/log_streams/index.md new file mode 100644 index 0000000..6904f57 --- /dev/null +++ b/website/docs/services/logs/log_streams/index.md @@ -0,0 +1,192 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a log_stream resource or lists log_streams in a region + +## Overview + + + + + + + +
Namelog_streams
TypeResource
DescriptionResource Type definition for AWS::Logs::LogStream
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the log stream. The name must be unique wihtin the log group.
stringThe name of the log group where the log stream is created.
stringAWS region.
+ +For more information, see AWS::Logs::LogStream. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all log_streams in a region. +```sql +SELECT +region, +log_stream_name, +log_group_name +FROM aws.logs.log_streams +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual log_stream. +```sql +SELECT +region, +log_stream_name, +log_group_name +FROM aws.logs.log_streams +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new log_stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.log_streams ( + LogGroupName, + region +) +SELECT +'{{ LogGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.log_streams ( + LogStreamName, + LogGroupName, + region +) +SELECT + '{{ LogStreamName }}', + '{{ LogGroupName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: log_stream + props: + - name: LogStreamName + value: '{{ LogStreamName }}' + - name: LogGroupName + value: '{{ LogGroupName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.log_streams +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the log_streams resource, the following permissions are required: + +### Read +```json +logs:DescribeLogStreams +``` + +### Create +```json +logs:CreateLogStream, +logs:DescribeLogStreams +``` + +### List +```json +logs:DescribeLogStreams +``` + +### Delete +```json +logs:DeleteLogStream +``` diff --git a/website/docs/services/logs/log_streams_list_only/index.md b/website/docs/services/logs/log_streams_list_only/index.md new file mode 100644 index 0000000..137ef48 --- /dev/null +++ b/website/docs/services/logs/log_streams_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: log_streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - log_streams_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists log_streams in a region or regions, for all properties use log_streams + +## Overview + + + + + + + +
Namelog_streams_list_only
TypeResource
DescriptionResource Type definition for AWS::Logs::LogStream
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the log stream. The name must be unique wihtin the log group.
stringThe name of the log group where the log stream is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all log_streams in a region. +```sql +SELECT +region, +log_group_name, +log_stream_name +FROM aws.logs.log_streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the log_streams_list_only resource, see log_streams + diff --git a/website/docs/services/logs/metric_filters/index.md b/website/docs/services/logs/metric_filters/index.md new file mode 100644 index 0000000..267b385 --- /dev/null +++ b/website/docs/services/logs/metric_filters/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a metric_filter resource or lists 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.
The maximum number of metric filters that can be associated with a log group is 100.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arrayThe metric transformations.
stringA filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
stringThe name of an existing log group that you want to associate with this metric filter.
booleanThis parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html).
If this value is true, the metric filter is applied on the transformed version of the log events instead of the original ingested log events.
stringThe name of the metric filter.
stringAWS region.
+ +For more information, see AWS::Logs::MetricFilter. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all metric_filters in a region. +```sql +SELECT +region, +metric_transformations, +filter_pattern, +log_group_name, +apply_on_transformed_logs, +filter_name +FROM aws.logs.metric_filters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual metric_filter. +```sql +SELECT +region, +metric_transformations, +filter_pattern, +log_group_name, +apply_on_transformed_logs, +filter_name +FROM aws.logs.metric_filters +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new metric_filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.metric_filters ( + MetricTransformations, + FilterPattern, + LogGroupName, + region +) +SELECT +'{{ MetricTransformations }}', + '{{ FilterPattern }}', + '{{ LogGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.metric_filters ( + MetricTransformations, + FilterPattern, + LogGroupName, + ApplyOnTransformedLogs, + FilterName, + region +) +SELECT + '{{ MetricTransformations }}', + '{{ FilterPattern }}', + '{{ LogGroupName }}', + '{{ ApplyOnTransformedLogs }}', + '{{ FilterName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: metric_filter + props: + - name: MetricTransformations + value: + - DefaultValue: null + MetricName: '{{ MetricName }}' + MetricValue: '{{ MetricValue }}' + MetricNamespace: '{{ MetricNamespace }}' + Dimensions: + - Value: '{{ Value }}' + Key: '{{ Key }}' + Unit: '{{ Unit }}' + - name: FilterPattern + value: '{{ FilterPattern }}' + - name: LogGroupName + value: '{{ LogGroupName }}' + - name: ApplyOnTransformedLogs + value: '{{ ApplyOnTransformedLogs }}' + - name: FilterName + value: '{{ FilterName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.metric_filters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the metric_filters resource, the following permissions are required: + +### Read +```json +logs:DescribeMetricFilters +``` + +### Create +```json +logs:PutMetricFilter, +logs:DescribeMetricFilters +``` + +### Update +```json +logs:PutMetricFilter, +logs:DescribeMetricFilters +``` + +### List +```json +logs:DescribeMetricFilters +``` + +### Delete +```json +logs:DeleteMetricFilter +``` diff --git a/website/docs/services/logs/metric_filters_list_only/index.md b/website/docs/services/logs/metric_filters_list_only/index.md new file mode 100644 index 0000000..7617e49 --- /dev/null +++ b/website/docs/services/logs/metric_filters_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: metric_filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - metric_filters_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists metric_filters in a region or regions, for all properties use metric_filters + +## Overview + + + + + + + +
Namemetric_filters_list_only
TypeResource
DescriptionThe AWS::Logs::MetricFilter resource specifies a metric filter that describes how CWL extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.
The maximum number of metric filters that can be associated with a log group is 100.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of an existing log group that you want to associate with this metric filter.
stringThe name of the metric filter.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all metric_filters in a region. +```sql +SELECT +region, +log_group_name, +filter_name +FROM aws.logs.metric_filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the metric_filters_list_only resource, see metric_filters + diff --git a/website/docs/services/logs/query_definitions/index.md b/website/docs/services/logs/query_definitions/index.md new file mode 100644 index 0000000..3c25136 --- /dev/null +++ b/website/docs/services/logs/query_definitions/index.md @@ -0,0 +1,221 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a query_definition resource or lists query_definitions in a region + +## Overview + + + + + + + +
Namequery_definitions
TypeResource
DescriptionThe resource schema for AWSLogs QueryDefinition
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringA name for the saved query definition
stringThe query string to use for this definition
arrayOptionally define specific log groups as part of your query definition
stringUnique identifier of a query definition
stringQuery language of the query string. Possible values are CWLI, SQL, PPL, with CWLI being the default.
stringAWS region.
+ +For more information, see AWS::Logs::QueryDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all query_definitions in a region. +```sql +SELECT +region, +name, +query_string, +log_group_names, +query_definition_id, +query_language +FROM aws.logs.query_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual query_definition. +```sql +SELECT +region, +name, +query_string, +log_group_names, +query_definition_id, +query_language +FROM aws.logs.query_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new query_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.query_definitions ( + Name, + QueryString, + region +) +SELECT +'{{ Name }}', + '{{ QueryString }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.query_definitions ( + Name, + QueryString, + LogGroupNames, + QueryLanguage, + region +) +SELECT + '{{ Name }}', + '{{ QueryString }}', + '{{ LogGroupNames }}', + '{{ QueryLanguage }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: query_definition + props: + - name: Name + value: '{{ Name }}' + - name: QueryString + value: '{{ QueryString }}' + - name: LogGroupNames + value: + - '{{ LogGroupNames[0] }}' + - name: QueryLanguage + value: '{{ QueryLanguage }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.query_definitions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the query_definitions resource, the following permissions are required: + +### Create +```json +logs:PutQueryDefinition +``` + +### Read +```json +logs:DescribeQueryDefinitions +``` + +### Update +```json +logs:PutQueryDefinition +``` + +### Delete +```json +logs:DeleteQueryDefinition +``` + +### List +```json +logs:DescribeQueryDefinitions +``` diff --git a/website/docs/services/logs/query_definitions_list_only/index.md b/website/docs/services/logs/query_definitions_list_only/index.md new file mode 100644 index 0000000..30424f1 --- /dev/null +++ b/website/docs/services/logs/query_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: query_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - query_definitions_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists query_definitions in a region or regions, for all properties use query_definitions + +## Overview + + + + + + + +
Namequery_definitions_list_only
TypeResource
DescriptionThe resource schema for AWSLogs QueryDefinition
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique identifier of a query definition
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all query_definitions in a region. +```sql +SELECT +region, +query_definition_id +FROM aws.logs.query_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the query_definitions_list_only resource, see query_definitions + diff --git a/website/docs/services/logs/resource_policies/index.md b/website/docs/services/logs/resource_policies/index.md new file mode 100644 index 0000000..fc52a74 --- /dev/null +++ b/website/docs/services/logs/resource_policies/index.md @@ -0,0 +1,206 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_policy resource or lists resource_policies in a region + +## Overview + + + + + + + +
Nameresource_policies
TypeResource
DescriptionThe resource schema for AWSLogs ResourcePolicy
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA name for resource policy
stringThe policy document
stringAWS region.
+ +For more information, see AWS::Logs::ResourcePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_policies in a region. +```sql +SELECT +region, +policy_name, +policy_document +FROM aws.logs.resource_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_policy. +```sql +SELECT +region, +policy_name, +policy_document +FROM aws.logs.resource_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.resource_policies ( + PolicyName, + PolicyDocument, + region +) +SELECT +'{{ PolicyName }}', + '{{ PolicyDocument }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.resource_policies ( + PolicyName, + PolicyDocument, + region +) +SELECT + '{{ PolicyName }}', + '{{ PolicyDocument }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_policy + props: + - name: PolicyName + value: '{{ PolicyName }}' + - name: PolicyDocument + value: '{{ PolicyDocument }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.resource_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +logs:PutResourcePolicy, +logs:DescribeResourcePolicies +``` + +### Read +```json +logs:DescribeResourcePolicies +``` + +### Update +```json +logs:PutResourcePolicy, +logs:DescribeResourcePolicies, +logs:DeleteResourcePolicy +``` + +### Delete +```json +logs:DeleteResourcePolicy +``` + +### List +```json +logs:DescribeResourcePolicies +``` diff --git a/website/docs/services/logs/resource_policies_list_only/index.md b/website/docs/services/logs/resource_policies_list_only/index.md new file mode 100644 index 0000000..2090ac1 --- /dev/null +++ b/website/docs/services/logs/resource_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionThe resource schema for AWSLogs ResourcePolicy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for resource policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +policy_name +FROM aws.logs.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + diff --git a/website/docs/services/logs/subscription_filters/index.md b/website/docs/services/logs/subscription_filters/index.md new file mode 100644 index 0000000..160a2f8 --- /dev/null +++ b/website/docs/services/logs/subscription_filters/index.md @@ -0,0 +1,244 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a subscription_filter resource or lists 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:
+ An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
+ A logical destination that belongs to a different account, for cross-account delivery.
+ An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
+ An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.

There can be as many as two subscription filters associated with a log group.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the subscription filter.
stringThe Amazon Resource Name (ARN) of the destination.
stringThe filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
stringThe log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
stringThe ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.
stringThe method used to distribute log data to the destination, which can be either random or grouped by log stream.
booleanThis parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html).
If this value is true, the subscription filter is applied on the transformed version of the log events instead of the original ingested log events.
stringAWS region.
+ +For more information, see AWS::Logs::SubscriptionFilter. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all subscription_filters in a region. +```sql +SELECT +region, +filter_name, +destination_arn, +filter_pattern, +log_group_name, +role_arn, +distribution, +apply_on_transformed_logs +FROM aws.logs.subscription_filters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual subscription_filter. +```sql +SELECT +region, +filter_name, +destination_arn, +filter_pattern, +log_group_name, +role_arn, +distribution, +apply_on_transformed_logs +FROM aws.logs.subscription_filters +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new subscription_filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.subscription_filters ( + DestinationArn, + FilterPattern, + LogGroupName, + region +) +SELECT +'{{ DestinationArn }}', + '{{ FilterPattern }}', + '{{ LogGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.subscription_filters ( + FilterName, + DestinationArn, + FilterPattern, + LogGroupName, + RoleArn, + Distribution, + ApplyOnTransformedLogs, + region +) +SELECT + '{{ FilterName }}', + '{{ DestinationArn }}', + '{{ FilterPattern }}', + '{{ LogGroupName }}', + '{{ RoleArn }}', + '{{ Distribution }}', + '{{ ApplyOnTransformedLogs }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: subscription_filter + props: + - name: FilterName + value: '{{ FilterName }}' + - name: DestinationArn + value: '{{ DestinationArn }}' + - name: FilterPattern + value: '{{ FilterPattern }}' + - name: LogGroupName + value: '{{ LogGroupName }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Distribution + value: '{{ Distribution }}' + - name: ApplyOnTransformedLogs + value: '{{ ApplyOnTransformedLogs }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.subscription_filters +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +logs:DescribeSubscriptionFilters +``` + +### Update +```json +iam:PassRole, +logs:PutSubscriptionFilter, +logs:DescribeSubscriptionFilters +``` + +### Delete +```json +logs:DeleteSubscriptionFilter +``` + +### List +```json +logs:DescribeSubscriptionFilters +``` diff --git a/website/docs/services/logs/subscription_filters_list_only/index.md b/website/docs/services/logs/subscription_filters_list_only/index.md new file mode 100644 index 0000000..0875a36 --- /dev/null +++ b/website/docs/services/logs/subscription_filters_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: subscription_filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subscription_filters_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subscription_filters in a region or regions, for all properties use subscription_filters + +## Overview + + + + + + + +
Namesubscription_filters_list_only
TypeResource
DescriptionThe AWS::Logs::SubscriptionFilter resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:
+ An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
+ A logical destination that belongs to a different account, for cross-account delivery.
+ An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
+ An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.

There can be as many as two subscription filters associated with a log group.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the subscription filter.
stringThe 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.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subscription_filters in a region. +```sql +SELECT +region, +filter_name, +log_group_name +FROM aws.logs.subscription_filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subscription_filters_list_only resource, see subscription_filters + diff --git a/website/docs/services/logs/transformers/index.md b/website/docs/services/logs/transformers/index.md new file mode 100644 index 0000000..c7355e9 --- /dev/null +++ b/website/docs/services/logs/transformers/index.md @@ -0,0 +1,297 @@ +--- +title: transformers +hide_title: false +hide_table_of_contents: false +keywords: + - transformers + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transformer resource or lists transformers in a region + +## Overview + + + + + + + +
Nametransformers
TypeResource
DescriptionSpecifies a transformer on the log group to transform logs into consistent structured and information rich format.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringExisting log group that you want to associate with this transformer.
arrayList of processors in a transformer
stringAWS region.
+ +For more information, see AWS::Logs::Transformer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transformers in a region. +```sql +SELECT +region, +log_group_identifier, +transformer_config +FROM aws.logs.transformers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transformer. +```sql +SELECT +region, +log_group_identifier, +transformer_config +FROM aws.logs.transformers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transformer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.logs.transformers ( + LogGroupIdentifier, + TransformerConfig, + region +) +SELECT +'{{ LogGroupIdentifier }}', + '{{ TransformerConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.logs.transformers ( + LogGroupIdentifier, + TransformerConfig, + region +) +SELECT + '{{ LogGroupIdentifier }}', + '{{ TransformerConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transformer + props: + - name: LogGroupIdentifier + value: '{{ LogGroupIdentifier }}' + - name: TransformerConfig + value: + - ParseCloudfront: + Source: '{{ Source }}' + ParseVPC: + Source: null + ParseWAF: + Source: null + ParseJSON: + Source: '{{ Source }}' + Destination: '{{ Destination }}' + ParseRoute53: + Source: null + ParsePostgres: + Source: null + ParseKeyValue: + Source: null + Destination: null + FieldDelimiter: '{{ FieldDelimiter }}' + KeyValueDelimiter: '{{ KeyValueDelimiter }}' + KeyPrefix: null + NonMatchValue: null + OverwriteIfExists: '{{ OverwriteIfExists }}' + CopyValue: + Entries: + - Source: null + Target: null + OverwriteIfExists: '{{ OverwriteIfExists }}' + Csv: + QuoteCharacter: '{{ QuoteCharacter }}' + Delimiter: '{{ Delimiter }}' + Source: '{{ Source }}' + Columns: + - null + DateTimeConverter: + Source: null + Target: null + TargetFormat: '{{ TargetFormat }}' + MatchPatterns: + - null + SourceTimezone: '{{ SourceTimezone }}' + TargetTimezone: '{{ TargetTimezone }}' + Locale: '{{ Locale }}' + DeleteKeys: + WithKeys: + - '{{ WithKeys[0] }}' + Grok: + Source: null + Match: '{{ Match }}' + ListToMap: + Source: null + Key: null + ValueKey: null + Target: null + Flatten: '{{ Flatten }}' + FlattenedElement: '{{ FlattenedElement }}' + AddKeys: + Entries: + - Key: null + Value: '{{ Value }}' + OverwriteIfExists: '{{ OverwriteIfExists }}' + MoveKeys: + Entries: + - Source: null + Target: null + OverwriteIfExists: '{{ OverwriteIfExists }}' + RenameKeys: + Entries: + - Key: null + RenameTo: null + OverwriteIfExists: '{{ OverwriteIfExists }}' + LowerCaseString: + WithKeys: + - null + SplitString: + Entries: + - Source: null + Delimiter: '{{ Delimiter }}' + SubstituteString: + Entries: + - Source: null + From: null + To: null + TrimString: + WithKeys: + - null + UpperCaseString: + WithKeys: + - null + TypeConverter: + Entries: + - Key: null + Type: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.logs.transformers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the transformers resource, the following permissions are required: + +### Create +```json +logs:PutTransformer, +logs:GetTransformer +``` + +### Read +```json +logs:GetTransformer +``` + +### Update +```json +logs:GetTransformer, +logs:PutTransformer +``` + +### Delete +```json +logs:DeleteTransformer +``` + +### List +```json +logs:DescribeLogGroups, +logs:GetTransformer +``` diff --git a/website/docs/services/logs/transformers_list_only/index.md b/website/docs/services/logs/transformers_list_only/index.md new file mode 100644 index 0000000..2843c18 --- /dev/null +++ b/website/docs/services/logs/transformers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transformers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transformers_list_only + - logs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transformers in a region or regions, for all properties use transformers + +## Overview + + + + + + + +
Nametransformers_list_only
TypeResource
DescriptionSpecifies a transformer on the log group to transform logs into consistent structured and information rich format.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringExisting log group that you want to associate with this transformer.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transformers in a region. +```sql +SELECT +region, +log_group_identifier +FROM aws.logs.transformers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transformers_list_only resource, see transformers + diff --git a/website/docs/services/lookoutequipment/index.md b/website/docs/services/lookoutequipment/index.md new file mode 100644 index 0000000..72ef42d --- /dev/null +++ b/website/docs/services/lookoutequipment/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The lookoutequipment service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/lookoutequipment/inference_scheduler_tags/index.md b/website/docs/services/lookoutequipment/inference_scheduler_tags/index.md new file mode 100644 index 0000000..fb64434 --- /dev/null +++ b/website/docs/services/lookoutequipment/inference_scheduler_tags/index.md @@ -0,0 +1,93 @@ +--- +title: inference_scheduler_tags +hide_title: false +hide_table_of_contents: false +keywords: + - inference_scheduler_tags + - lookoutequipment + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for inference_schedulers in a region + +## Overview + + + + + + + +
Nameinference_scheduler_tags
TypeResource
DescriptionResource schema for LookoutEquipment InferenceScheduler.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerA period of time (in minutes) by which inference on the data is delayed after the data starts.
objectSpecifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
objectSpecifies configuration information for the output results for the inference scheduler, including the S3 location for the output.
stringHow often data is uploaded to the source S3 bucket for the input data.
stringThe name of the inference scheduler being created.
stringThe name of the previously trained ML model being used to create the inference scheduler.
stringThe Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
stringProvides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.
stringThe Amazon Resource Name (ARN) of the inference scheduler being created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all inference_schedulers in a region. +```sql +SELECT +region, +data_delay_offset_in_minutes, +data_input_configuration, +data_output_configuration, +data_upload_frequency, +inference_scheduler_name, +model_name, +role_arn, +server_side_kms_key_id, +inference_scheduler_arn, +tag_key, +tag_value +FROM aws.lookoutequipment.inference_scheduler_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_scheduler_tags resource, see inference_schedulers + diff --git a/website/docs/services/lookoutequipment/inference_schedulers/index.md b/website/docs/services/lookoutequipment/inference_schedulers/index.md new file mode 100644 index 0000000..8a37007 --- /dev/null +++ b/website/docs/services/lookoutequipment/inference_schedulers/index.md @@ -0,0 +1,281 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an inference_scheduler resource or lists inference_schedulers in a region + +## Overview + + + + + + + +
Nameinference_schedulers
TypeResource
DescriptionResource schema for LookoutEquipment InferenceScheduler.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
integerA period of time (in minutes) by which inference on the data is delayed after the data starts.
objectSpecifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
objectSpecifies configuration information for the output results for the inference scheduler, including the S3 location for the output.
stringHow often data is uploaded to the source S3 bucket for the input data.
stringThe name of the inference scheduler being created.
stringThe name of the previously trained ML model being used to create the inference scheduler.
stringThe Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
stringProvides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.
arrayAny tags associated with the inference scheduler.
stringThe Amazon Resource Name (ARN) of the inference scheduler being created.
stringAWS region.
+ +For more information, see AWS::LookoutEquipment::InferenceScheduler. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all inference_schedulers in a region. +```sql +SELECT +region, +data_delay_offset_in_minutes, +data_input_configuration, +data_output_configuration, +data_upload_frequency, +inference_scheduler_name, +model_name, +role_arn, +server_side_kms_key_id, +tags, +inference_scheduler_arn +FROM aws.lookoutequipment.inference_schedulers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual inference_scheduler. +```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_schedulers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new inference_scheduler resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lookoutequipment.inference_schedulers ( + DataInputConfiguration, + DataOutputConfiguration, + DataUploadFrequency, + ModelName, + RoleArn, + region +) +SELECT +'{{ DataInputConfiguration }}', + '{{ DataOutputConfiguration }}', + '{{ DataUploadFrequency }}', + '{{ ModelName }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lookoutequipment.inference_schedulers ( + DataDelayOffsetInMinutes, + DataInputConfiguration, + DataOutputConfiguration, + DataUploadFrequency, + InferenceSchedulerName, + ModelName, + RoleArn, + ServerSideKmsKeyId, + Tags, + region +) +SELECT + '{{ DataDelayOffsetInMinutes }}', + '{{ DataInputConfiguration }}', + '{{ DataOutputConfiguration }}', + '{{ DataUploadFrequency }}', + '{{ InferenceSchedulerName }}', + '{{ ModelName }}', + '{{ RoleArn }}', + '{{ ServerSideKmsKeyId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: inference_scheduler + props: + - name: DataDelayOffsetInMinutes + value: '{{ DataDelayOffsetInMinutes }}' + - name: DataInputConfiguration + value: + InputTimeZoneOffset: '{{ InputTimeZoneOffset }}' + InferenceInputNameConfiguration: + ComponentTimestampDelimiter: '{{ ComponentTimestampDelimiter }}' + TimestampFormat: '{{ TimestampFormat }}' + S3InputConfiguration: + Bucket: '{{ Bucket }}' + Prefix: '{{ Prefix }}' + - name: DataOutputConfiguration + value: + KmsKeyId: '{{ KmsKeyId }}' + S3OutputConfiguration: + Bucket: null + Prefix: null + - name: DataUploadFrequency + value: '{{ DataUploadFrequency }}' + - name: InferenceSchedulerName + value: '{{ InferenceSchedulerName }}' + - name: ModelName + value: '{{ ModelName }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: ServerSideKmsKeyId + value: '{{ ServerSideKmsKeyId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lookoutequipment.inference_schedulers +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lookoutequipment:DescribeInferenceScheduler +``` + +### Delete +```json +lookoutequipment:DeleteInferenceScheduler, +lookoutequipment:StopInferenceScheduler, +lookoutequipment:DescribeInferenceScheduler +``` + +### Update +```json +lookoutequipment:UpdateInferenceScheduler, +lookoutequipment:DescribeInferenceScheduler, +lookoutequipment:StopInferenceScheduler, +lookoutequipment:StartInferenceScheduler +``` + +### List +```json +lookoutequipment:ListInferenceSchedulers +``` diff --git a/website/docs/services/lookoutequipment/inference_schedulers_list_only/index.md b/website/docs/services/lookoutequipment/inference_schedulers_list_only/index.md new file mode 100644 index 0000000..2b03422 --- /dev/null +++ b/website/docs/services/lookoutequipment/inference_schedulers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: inference_schedulers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - inference_schedulers_list_only + - lookoutequipment + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists inference_schedulers in a region or regions, for all properties use inference_schedulers + +## Overview + + + + + + + +
Nameinference_schedulers_list_only
TypeResource
DescriptionResource schema for LookoutEquipment InferenceScheduler.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the inference scheduler being created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all inference_schedulers in a region. +```sql +SELECT +region, +inference_scheduler_name +FROM aws.lookoutequipment.inference_schedulers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_schedulers_list_only resource, see inference_schedulers + diff --git a/website/docs/services/lookoutmetrics/alerts/index.md b/website/docs/services/lookoutmetrics/alerts/index.md new file mode 100644 index 0000000..868a77a --- /dev/null +++ b/website/docs/services/lookoutmetrics/alerts/index.md @@ -0,0 +1,226 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an alert resource or lists alerts in a region + +## Overview + + + + + + + +
Namealerts
TypeResource
DescriptionResource Type definition for AWS::LookoutMetrics::Alert
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the alert. If not provided, a name is generated automatically.
stringARN assigned to the alert.
stringA description for the alert.
stringThe Amazon resource name (ARN) of the Anomaly Detector to alert.
integerA number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.
objectThe action to be taken by the alert when an anomaly is detected.
stringAWS region.
+ +For more information, see AWS::LookoutMetrics::Alert. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all alerts in a region. +```sql +SELECT +region, +alert_name, +arn, +alert_description, +anomaly_detector_arn, +alert_sensitivity_threshold, +action +FROM aws.lookoutmetrics.alerts +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual alert. +```sql +SELECT +region, +alert_name, +arn, +alert_description, +anomaly_detector_arn, +alert_sensitivity_threshold, +action +FROM aws.lookoutmetrics.alerts +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alert resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lookoutmetrics.alerts ( + AnomalyDetectorArn, + AlertSensitivityThreshold, + Action, + region +) +SELECT +'{{ AnomalyDetectorArn }}', + '{{ AlertSensitivityThreshold }}', + '{{ Action }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lookoutmetrics.alerts ( + AlertName, + AlertDescription, + AnomalyDetectorArn, + AlertSensitivityThreshold, + Action, + region +) +SELECT + '{{ AlertName }}', + '{{ AlertDescription }}', + '{{ AnomalyDetectorArn }}', + '{{ AlertSensitivityThreshold }}', + '{{ Action }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: alert + props: + - name: AlertName + value: '{{ AlertName }}' + - name: AlertDescription + value: '{{ AlertDescription }}' + - name: AnomalyDetectorArn + value: '{{ AnomalyDetectorArn }}' + - name: AlertSensitivityThreshold + value: '{{ AlertSensitivityThreshold }}' + - name: Action + value: + SNSConfiguration: + RoleArn: '{{ RoleArn }}' + SnsTopicArn: null + LambdaConfiguration: + RoleArn: null + LambdaArn: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lookoutmetrics.alerts +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the alerts resource, the following permissions are required: + +### Create +```json +lookoutmetrics:CreateAlert, +iam:PassRole +``` + +### Read +```json +lookoutmetrics:DescribeAlert +``` + +### Delete +```json +lookoutmetrics:DeleteAlert +``` + +### List +```json +lookoutmetrics:ListAlerts +``` diff --git a/website/docs/services/lookoutmetrics/alerts_list_only/index.md b/website/docs/services/lookoutmetrics/alerts_list_only/index.md new file mode 100644 index 0000000..d115506 --- /dev/null +++ b/website/docs/services/lookoutmetrics/alerts_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: alerts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - alerts_list_only + - lookoutmetrics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists alerts in a region or regions, for all properties use alerts + +## Overview + + + + + + + +
Namealerts_list_only
TypeResource
DescriptionResource Type definition for AWS::LookoutMetrics::Alert
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringARN assigned to the alert.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all alerts in a region. +```sql +SELECT +region, +arn +FROM aws.lookoutmetrics.alerts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alerts_list_only resource, see alerts + diff --git a/website/docs/services/lookoutmetrics/anomaly_detectors/index.md b/website/docs/services/lookoutmetrics/anomaly_detectors/index.md new file mode 100644 index 0000000..470c2a6 --- /dev/null +++ b/website/docs/services/lookoutmetrics/anomaly_detectors/index.md @@ -0,0 +1,295 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an anomaly_detector resource or lists anomaly_detectors in a region + +## Overview + + + + + + + +
Nameanomaly_detectors
TypeResource
DescriptionAn Amazon Lookout for Metrics Detector
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringName for the Amazon Lookout for Metrics Anomaly Detector
stringA description for the AnomalyDetector.
objectConfiguration options for the AnomalyDetector
arrayList of metric sets for anomaly detection
stringKMS key used to encrypt the AnomalyDetector data
stringAWS region.
+ +For more information, see AWS::LookoutMetrics::AnomalyDetector. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all anomaly_detectors in a region. +```sql +SELECT +region, +arn, +anomaly_detector_name, +anomaly_detector_description, +anomaly_detector_config, +metric_set_list, +kms_key_arn +FROM aws.lookoutmetrics.anomaly_detectors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual anomaly_detector. +```sql +SELECT +region, +arn, +anomaly_detector_name, +anomaly_detector_description, +anomaly_detector_config, +metric_set_list, +kms_key_arn +FROM aws.lookoutmetrics.anomaly_detectors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new anomaly_detector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lookoutmetrics.anomaly_detectors ( + AnomalyDetectorConfig, + MetricSetList, + region +) +SELECT +'{{ AnomalyDetectorConfig }}', + '{{ MetricSetList }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lookoutmetrics.anomaly_detectors ( + AnomalyDetectorName, + AnomalyDetectorDescription, + AnomalyDetectorConfig, + MetricSetList, + KmsKeyArn, + region +) +SELECT + '{{ AnomalyDetectorName }}', + '{{ AnomalyDetectorDescription }}', + '{{ AnomalyDetectorConfig }}', + '{{ MetricSetList }}', + '{{ KmsKeyArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: anomaly_detector + props: + - name: AnomalyDetectorName + value: '{{ AnomalyDetectorName }}' + - name: AnomalyDetectorDescription + value: '{{ AnomalyDetectorDescription }}' + - name: AnomalyDetectorConfig + value: + AnomalyDetectorFrequency: '{{ AnomalyDetectorFrequency }}' + - name: MetricSetList + value: + - MetricSetName: '{{ MetricSetName }}' + MetricSetDescription: '{{ MetricSetDescription }}' + MetricSource: + S3SourceConfig: + RoleArn: '{{ RoleArn }}' + TemplatedPathList: + - '{{ TemplatedPathList[0] }}' + HistoricalDataPathList: + - '{{ HistoricalDataPathList[0] }}' + FileFormatDescriptor: + CsvFormatDescriptor: + FileCompression: '{{ FileCompression }}' + Charset: '{{ Charset }}' + Delimiter: '{{ Delimiter }}' + HeaderList: + - '{{ HeaderList[0] }}' + QuoteSymbol: '{{ QuoteSymbol }}' + ContainsHeader: '{{ ContainsHeader }}' + JsonFormatDescriptor: + FileCompression: '{{ FileCompression }}' + Charset: null + RDSSourceConfig: + DBInstanceIdentifier: '{{ DBInstanceIdentifier }}' + DatabaseHost: '{{ DatabaseHost }}' + DatabasePort: '{{ DatabasePort }}' + SecretManagerArn: '{{ SecretManagerArn }}' + DatabaseName: '{{ DatabaseName }}' + TableName: '{{ TableName }}' + RoleArn: null + VpcConfiguration: + SubnetIdList: + - '{{ SubnetIdList[0] }}' + SecurityGroupIdList: + - '{{ SecurityGroupIdList[0] }}' + RedshiftSourceConfig: + ClusterIdentifier: '{{ ClusterIdentifier }}' + DatabaseHost: null + DatabasePort: null + SecretManagerArn: null + DatabaseName: '{{ DatabaseName }}' + TableName: null + RoleArn: null + VpcConfiguration: null + CloudwatchConfig: + RoleArn: null + AppFlowConfig: + RoleArn: null + FlowName: '{{ FlowName }}' + MetricList: + - MetricName: null + AggregationFunction: '{{ AggregationFunction }}' + Namespace: '{{ Namespace }}' + Offset: '{{ Offset }}' + TimestampColumn: + ColumnName: null + ColumnFormat: '{{ ColumnFormat }}' + DimensionList: + - null + MetricSetFrequency: '{{ MetricSetFrequency }}' + Timezone: '{{ Timezone }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lookoutmetrics.anomaly_detectors +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +lookoutmetrics:DescribeAnomalyDetector, +lookoutmetrics:DescribeMetricSet, +lookoutmetrics:ListMetricSets +``` + +### Update +```json +lookoutmetrics:UpdateAnomalyDetector, +lookoutmetrics:UpdateMetricSet +``` + +### Delete +```json +lookoutmetrics:DescribeAnomalyDetector, +lookoutmetrics:DeleteAnomalyDetector +``` + +### List +```json +lookoutmetrics:ListAnomalyDetectors +``` diff --git a/website/docs/services/lookoutmetrics/anomaly_detectors_list_only/index.md b/website/docs/services/lookoutmetrics/anomaly_detectors_list_only/index.md new file mode 100644 index 0000000..82f21d3 --- /dev/null +++ b/website/docs/services/lookoutmetrics/anomaly_detectors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: anomaly_detectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_detectors_list_only + - lookoutmetrics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists anomaly_detectors in a region or regions, for all properties use anomaly_detectors + +## Overview + + + + + + + +
Nameanomaly_detectors_list_only
TypeResource
DescriptionAn Amazon Lookout for Metrics Detector
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all anomaly_detectors in a region. +```sql +SELECT +region, +arn +FROM aws.lookoutmetrics.anomaly_detectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the anomaly_detectors_list_only resource, see anomaly_detectors + diff --git a/website/docs/services/lookoutmetrics/index.md b/website/docs/services/lookoutmetrics/index.md new file mode 100644 index 0000000..0938c80 --- /dev/null +++ b/website/docs/services/lookoutmetrics/index.md @@ -0,0 +1,39 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The lookoutmetrics service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/lookoutvision/index.md b/website/docs/services/lookoutvision/index.md new file mode 100644 index 0000000..061fb44 --- /dev/null +++ b/website/docs/services/lookoutvision/index.md @@ -0,0 +1,37 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The lookoutvision service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/lookoutvision/projects/index.md b/website/docs/services/lookoutvision/projects/index.md new file mode 100644 index 0000000..2048418 --- /dev/null +++ b/website/docs/services/lookoutvision/projects/index.md @@ -0,0 +1,187 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a project resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe name of the Amazon Lookout for Vision project
stringAWS region.
+ +For more information, see AWS::LookoutVision::Project. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all projects in a region. +```sql +SELECT +region, +arn, +project_name +FROM aws.lookoutvision.projects +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual project. +```sql +SELECT +region, +arn, +project_name +FROM aws.lookoutvision.projects +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.lookoutvision.projects ( + ProjectName, + region +) +SELECT +'{{ ProjectName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.lookoutvision.projects ( + ProjectName, + region +) +SELECT + '{{ ProjectName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: project + props: + - name: ProjectName + value: '{{ ProjectName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.lookoutvision.projects +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +```json +lookoutvision:CreateProject +``` + +### Read +```json +lookoutvision:DescribeProject +``` + +### Delete +```json +lookoutvision:DeleteProject +``` + +### List +```json +lookoutvision:ListProjects +``` diff --git a/website/docs/services/lookoutvision/projects_list_only/index.md b/website/docs/services/lookoutvision/projects_list_only/index.md new file mode 100644 index 0000000..b2687fe --- /dev/null +++ b/website/docs/services/lookoutvision/projects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + + + +
Nameprojects_list_only
TypeResource
DescriptionThe AWS::LookoutVision::Project type creates an Amazon Lookout for Vision project. A project is a grouping of the resources needed to create and manage a Lookout for Vision model.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Amazon Lookout for Vision project
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +project_name +FROM aws.lookoutvision.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + diff --git a/website/docs/services/m2/application_tags/index.md b/website/docs/services/m2/application_tags/index.md new file mode 100644 index 0000000..25ec77c --- /dev/null +++ b/website/docs/services/m2/application_tags/index.md @@ -0,0 +1,91 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - m2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionRepresents an application that runs on an AWS Mainframe Modernization Environment
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
stringThe target platform for the environment.
stringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_arn, +application_id, +definition, +description, +engine_type, +kms_key_id, +name, +role_arn, +tag_key, +tag_value +FROM aws.m2.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/m2/applications/index.md b/website/docs/services/m2/applications/index.md new file mode 100644 index 0000000..81af86a --- /dev/null +++ b/website/docs/services/m2/applications/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionRepresents an application that runs on an AWS Mainframe Modernization Environment
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
stringThe target platform for the environment.
stringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources.
string
string
objectDefines tags associated to an environment.
stringAWS region.
+ +For more information, see AWS::M2::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +application_arn, +application_id, +definition, +description, +engine_type, +kms_key_id, +name, +role_arn, +tags +FROM aws.m2.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +application_arn, +application_id, +definition, +description, +engine_type, +kms_key_id, +name, +role_arn, +tags +FROM aws.m2.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.m2.applications ( + EngineType, + Name, + region +) +SELECT +'{{ EngineType }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.m2.applications ( + Definition, + Description, + EngineType, + KmsKeyId, + Name, + RoleArn, + Tags, + region +) +SELECT + '{{ Definition }}', + '{{ Description }}', + '{{ EngineType }}', + '{{ KmsKeyId }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: Definition + value: null + - name: Description + value: '{{ Description }}' + - name: EngineType + value: '{{ EngineType }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.m2.applications +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +m2:ListApplications +``` diff --git a/website/docs/services/m2/applications_list_only/index.md b/website/docs/services/m2/applications_list_only/index.md new file mode 100644 index 0000000..2fbb39a --- /dev/null +++ b/website/docs/services/m2/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - m2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionRepresents an application that runs on an AWS Mainframe Modernization Environment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_arn +FROM aws.m2.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/m2/deployments/index.md b/website/docs/services/m2/deployments/index.md new file mode 100644 index 0000000..c39bb21 --- /dev/null +++ b/website/docs/services/m2/deployments/index.md @@ -0,0 +1,256 @@ +--- +title: deployments +hide_title: false +hide_table_of_contents: false +keywords: + - deployments + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a deployment resource or lists deployments in a region + +## Overview + + + + + + + +
Namedeployments
TypeResource
DescriptionRepresents a deployment resource of an AWS Mainframe Modernization (M2) application to a specified environment
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe environment ID.
stringThe application ID.
integerThe version number of the application to deploy
stringThe deployment ID.
stringThe status of the deployment.
stringAWS region.
+ +For more information, see AWS::M2::Deployment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all deployments in a region. +```sql +SELECT +region, +environment_id, +application_id, +application_version, +deployment_id, +status +FROM aws.m2.deployments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual deployment. +```sql +SELECT +region, +environment_id, +application_id, +application_version, +deployment_id, +status +FROM aws.m2.deployments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new deployment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.m2.deployments ( + EnvironmentId, + ApplicationId, + ApplicationVersion, + region +) +SELECT +'{{ EnvironmentId }}', + '{{ ApplicationId }}', + '{{ ApplicationVersion }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.m2.deployments ( + EnvironmentId, + ApplicationId, + ApplicationVersion, + region +) +SELECT + '{{ EnvironmentId }}', + '{{ ApplicationId }}', + '{{ ApplicationVersion }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: deployment + props: + - name: EnvironmentId + value: '{{ EnvironmentId }}' + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: ApplicationVersion + value: '{{ ApplicationVersion }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.m2.deployments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Create +```json +m2:CreateDeployment, +m2:ListDeployments, +m2:GetDeployment, +iam:PassRole, +ec2:DescribeNetworkInterfaces, +elasticloadbalancing:CreateListener, +elasticloadbalancing:CreateLoadBalancer, +elasticloadbalancing:CreateTargetGroup, +elasticloadbalancing:AddTags, +elasticloadbalancing:RegisterTargets, +logs:DescribeResourcePolicies, +logs:DescribeLogGroups, +logs:CreateLogDelivery, +logs:GetLogDelivery, +logs:UpdateLogDelivery, +logs:DeleteLogDelivery, +logs:ListLogDeliveries, +logs:CreateLogGroup, +logs:PutResourcePolicy +``` + +### Read +```json +m2:ListDeployments, +m2:GetDeployment +``` + +### Update +```json +m2:CreateDeployment, +m2:ListDeployments, +m2:GetDeployment, +elasticloadbalancing:CreateListener, +elasticloadbalancing:CreateLoadBalancer, +elasticloadbalancing:CreateTargetGroup, +elasticloadbalancing:DeleteListener, +elasticloadbalancing:DeleteTargetGroup, +elasticloadbalancing:DeregisterTargets, +elasticloadbalancing:DeleteLoadBalancer, +elasticloadbalancing:AddTags, +elasticloadbalancing:RegisterTargets, +ec2:DescribeNetworkInterfaces +``` + +### Delete +```json +elasticloadbalancing:DeleteListener, +elasticloadbalancing:DeleteTargetGroup, +elasticloadbalancing:DeregisterTargets, +elasticloadbalancing:DeleteLoadBalancer, +logs:DeleteLogDelivery, +m2:ListDeployments, +m2:GetDeployment, +m2:DeleteApplicationFromEnvironment +``` + +### List +```json +m2:ListDeployments +``` diff --git a/website/docs/services/m2/deployments_list_only/index.md b/website/docs/services/m2/deployments_list_only/index.md new file mode 100644 index 0000000..60225d6 --- /dev/null +++ b/website/docs/services/m2/deployments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: deployments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployments in a region or regions, for all properties use deployments + +## Overview + + + + + + + +
Namedeployments_list_only
TypeResource
DescriptionRepresents a deployment resource of an AWS Mainframe Modernization (M2) application to a specified environment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe application ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployments in a region. +```sql +SELECT +region, +application_id +FROM aws.m2.deployments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployments_list_only resource, see deployments + diff --git a/website/docs/services/m2/environment_tags/index.md b/website/docs/services/m2/environment_tags/index.md new file mode 100644 index 0000000..888208c --- /dev/null +++ b/website/docs/services/m2/environment_tags/index.md @@ -0,0 +1,105 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - m2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + + + +
Nameenvironment_tags
TypeResource
DescriptionRepresents a runtime environment that can run migrated mainframe applications.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the environment.
stringThe target platform for the environment.
stringThe version of the runtime engine for the environment.
stringThe Amazon Resource Name (ARN) of the runtime environment.
stringThe unique identifier of the environment.
objectDefines the details of a high availability configuration.
stringThe type of instance underlying the environment.
stringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.
stringThe name of the environment.
string
stringConfigures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
booleanSpecifies whether the environment is publicly accessible.
arrayThe list of security groups for the VPC associated with this environment.
arrayThe storage configurations defined for the runtime environment.
arrayThe unique identifiers of the subnets assigned to this runtime environment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +description, +engine_type, +engine_version, +environment_arn, +environment_id, +high_availability_config, +instance_type, +kms_key_id, +name, +network_type, +preferred_maintenance_window, +publicly_accessible, +security_group_ids, +storage_configurations, +subnet_ids, +tag_key, +tag_value +FROM aws.m2.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + diff --git a/website/docs/services/m2/environments/index.md b/website/docs/services/m2/environments/index.md new file mode 100644 index 0000000..30b0533 --- /dev/null +++ b/website/docs/services/m2/environments/index.md @@ -0,0 +1,326 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment resource or lists environments in a region + +## Overview + + + + + + + +
Nameenvironments
TypeResource
DescriptionRepresents a runtime environment that can run migrated mainframe applications.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the environment.
stringThe target platform for the environment.
stringThe version of the runtime engine for the environment.
stringThe Amazon Resource Name (ARN) of the runtime environment.
stringThe unique identifier of the environment.
objectDefines the details of a high availability configuration.
stringThe type of instance underlying the environment.
stringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.
stringThe name of the environment.
string
stringConfigures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
booleanSpecifies whether the environment is publicly accessible.
arrayThe list of security groups for the VPC associated with this environment.
arrayThe storage configurations defined for the runtime environment.
arrayThe unique identifiers of the subnets assigned to this runtime environment.
objectTags associated to this environment.
stringAWS region.
+ +For more information, see AWS::M2::Environment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environments in a region. +```sql +SELECT +region, +description, +engine_type, +engine_version, +environment_arn, +environment_id, +high_availability_config, +instance_type, +kms_key_id, +name, +network_type, +preferred_maintenance_window, +publicly_accessible, +security_group_ids, +storage_configurations, +subnet_ids, +tags +FROM aws.m2.environments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment. +```sql +SELECT +region, +description, +engine_type, +engine_version, +environment_arn, +environment_id, +high_availability_config, +instance_type, +kms_key_id, +name, +network_type, +preferred_maintenance_window, +publicly_accessible, +security_group_ids, +storage_configurations, +subnet_ids, +tags +FROM aws.m2.environments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.m2.environments ( + EngineType, + InstanceType, + Name, + region +) +SELECT +'{{ EngineType }}', + '{{ InstanceType }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.m2.environments ( + Description, + EngineType, + EngineVersion, + HighAvailabilityConfig, + InstanceType, + KmsKeyId, + Name, + NetworkType, + PreferredMaintenanceWindow, + PubliclyAccessible, + SecurityGroupIds, + StorageConfigurations, + SubnetIds, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ EngineType }}', + '{{ EngineVersion }}', + '{{ HighAvailabilityConfig }}', + '{{ InstanceType }}', + '{{ KmsKeyId }}', + '{{ Name }}', + '{{ NetworkType }}', + '{{ PreferredMaintenanceWindow }}', + '{{ PubliclyAccessible }}', + '{{ SecurityGroupIds }}', + '{{ StorageConfigurations }}', + '{{ SubnetIds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment + props: + - name: Description + value: '{{ Description }}' + - name: EngineType + value: '{{ EngineType }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: HighAvailabilityConfig + value: + DesiredCapacity: '{{ DesiredCapacity }}' + - name: InstanceType + value: '{{ InstanceType }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: Name + value: '{{ Name }}' + - name: NetworkType + value: '{{ NetworkType }}' + - name: PreferredMaintenanceWindow + value: '{{ PreferredMaintenanceWindow }}' + - name: PubliclyAccessible + value: '{{ PubliclyAccessible }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: StorageConfigurations + value: + - {} + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.m2.environments +WHERE data__Identifier = '' +AND 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:DeleteLoadBalancer, +elasticloadbalancing:AddTags, +fsx:DescribeFileSystems, +iam:CreateServiceLinkedRole, +kms:DescribeKey, +kms:CreateGrant, +m2:CreateEnvironment, +m2:GetEnvironment, +m2:ListTagsForResource, +m2:TagResource +``` + +### Read +```json +m2:ListTagsForResource, +m2:GetEnvironment +``` + +### Update +```json +m2:TagResource, +m2:UntagResource, +m2:ListTagsForResource, +m2:GetEnvironment, +m2:UpdateEnvironment, +kms:DescribeKey +``` + +### Delete +```json +elasticloadbalancing:DeleteLoadBalancer, +m2:DeleteEnvironment, +m2:GetEnvironment +``` + +### List +```json +m2:ListEnvironments +``` diff --git a/website/docs/services/m2/environments_list_only/index.md b/website/docs/services/m2/environments_list_only/index.md new file mode 100644 index 0000000..07440cc --- /dev/null +++ b/website/docs/services/m2/environments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionRepresents a runtime environment that can run migrated mainframe applications.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the runtime environment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +environment_arn +FROM aws.m2.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + diff --git a/website/docs/services/m2/index.md b/website/docs/services/m2/index.md new file mode 100644 index 0000000..58c3ad7 --- /dev/null +++ b/website/docs/services/m2/index.md @@ -0,0 +1,43 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The m2 service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/macie/allow_list_tags/index.md b/website/docs/services/macie/allow_list_tags/index.md new file mode 100644 index 0000000..da65140 --- /dev/null +++ b/website/docs/services/macie/allow_list_tags/index.md @@ -0,0 +1,87 @@ +--- +title: allow_list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - allow_list_tags + - macie + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for allow_lists in a region + +## Overview + + + + + + + +
Nameallow_list_tags
TypeResource
DescriptionMacie AllowList resource schema
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringName of AllowList.
stringDescription of AllowList.
objectAllowList criteria.
stringAllowList ID.
stringAllowList ARN.
stringAllowList status.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all allow_lists in a region. +```sql +SELECT +region, +name, +description, +criteria, +id, +arn, +status, +tag_key, +tag_value +FROM aws.macie.allow_list_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the allow_list_tags resource, see allow_lists + diff --git a/website/docs/services/macie/allow_lists/index.md b/website/docs/services/macie/allow_lists/index.md new file mode 100644 index 0000000..cf75709 --- /dev/null +++ b/website/docs/services/macie/allow_lists/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an allow_list resource or lists allow_lists in a region + +## Overview + + + + + + + +
Nameallow_lists
TypeResource
DescriptionMacie AllowList resource schema
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of AllowList.
stringDescription of AllowList.
objectAllowList criteria.
stringAllowList ID.
stringAllowList ARN.
stringAllowList status.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::Macie::AllowList. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all allow_lists in a region. +```sql +SELECT +region, +name, +description, +criteria, +id, +arn, +status, +tags +FROM aws.macie.allow_lists +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual allow_list. +```sql +SELECT +region, +name, +description, +criteria, +id, +arn, +status, +tags +FROM aws.macie.allow_lists +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new allow_list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.macie.allow_lists ( + Name, + Criteria, + region +) +SELECT +'{{ Name }}', + '{{ Criteria }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.macie.allow_lists ( + Name, + Description, + Criteria, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Criteria }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: allow_list + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Criteria + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.macie.allow_lists +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +macie2:GetAllowList +``` + +### Update +```json +macie2:UpdateAllowList, +macie2:GetAllowList, +macie2:TagResource, +macie2:UntagResource +``` + +### Delete +```json +macie2:DeleteAllowList +``` + +### List +```json +macie2:ListAllowLists +``` diff --git a/website/docs/services/macie/allow_lists_list_only/index.md b/website/docs/services/macie/allow_lists_list_only/index.md new file mode 100644 index 0000000..c507e1d --- /dev/null +++ b/website/docs/services/macie/allow_lists_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: allow_lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - allow_lists_list_only + - macie + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists allow_lists in a region or regions, for all properties use allow_lists + +## Overview + + + + + + + +
Nameallow_lists_list_only
TypeResource
DescriptionMacie AllowList resource schema
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAllowList ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all allow_lists in a region. +```sql +SELECT +region, +id +FROM aws.macie.allow_lists_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the allow_lists_list_only resource, see allow_lists + diff --git a/website/docs/services/macie/custom_data_identifier_tags/index.md b/website/docs/services/macie/custom_data_identifier_tags/index.md new file mode 100644 index 0000000..3929e23 --- /dev/null +++ b/website/docs/services/macie/custom_data_identifier_tags/index.md @@ -0,0 +1,91 @@ +--- +title: custom_data_identifier_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_data_identifier_tags + - macie + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_data_identifiers in a region + +## Overview + + + + + + + +
Namecustom_data_identifier_tags
TypeResource
DescriptionMacie CustomDataIdentifier resource schema
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of custom data identifier.
stringDescription of custom data identifier.
stringRegular expression for custom data identifier.
integerMaximum match distance.
arrayKeywords to be matched against.
arrayWords to be ignored.
stringCustom data identifier ID.
stringCustom data identifier ARN.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_data_identifiers in a region. +```sql +SELECT +region, +name, +description, +regex, +maximum_match_distance, +keywords, +ignore_words, +id, +arn, +tag_key, +tag_value +FROM aws.macie.custom_data_identifier_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_data_identifier_tags resource, see custom_data_identifiers + diff --git a/website/docs/services/macie/custom_data_identifiers/index.md b/website/docs/services/macie/custom_data_identifiers/index.md new file mode 100644 index 0000000..0020779 --- /dev/null +++ b/website/docs/services/macie/custom_data_identifiers/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a custom_data_identifier resource or lists custom_data_identifiers in a region + +## Overview + + + + + + + +
Namecustom_data_identifiers
TypeResource
DescriptionMacie CustomDataIdentifier resource schema
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of custom data identifier.
stringDescription of custom data identifier.
stringRegular expression for custom data identifier.
integerMaximum match distance.
arrayKeywords to be matched against.
arrayWords to be ignored.
stringCustom data identifier ID.
stringCustom data identifier ARN.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::Macie::CustomDataIdentifier. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all custom_data_identifiers in a region. +```sql +SELECT +region, +name, +description, +regex, +maximum_match_distance, +keywords, +ignore_words, +id, +arn, +tags +FROM aws.macie.custom_data_identifiers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual custom_data_identifier. +```sql +SELECT +region, +name, +description, +regex, +maximum_match_distance, +keywords, +ignore_words, +id, +arn, +tags +FROM aws.macie.custom_data_identifiers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new custom_data_identifier resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.macie.custom_data_identifiers ( + Name, + Regex, + region +) +SELECT +'{{ Name }}', + '{{ Regex }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.macie.custom_data_identifiers ( + Name, + Description, + Regex, + MaximumMatchDistance, + Keywords, + IgnoreWords, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Regex }}', + '{{ MaximumMatchDistance }}', + '{{ Keywords }}', + '{{ IgnoreWords }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: custom_data_identifier + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Regex + value: '{{ Regex }}' + - name: MaximumMatchDistance + value: '{{ MaximumMatchDistance }}' + - name: Keywords + value: + - '{{ Keywords[0] }}' + - name: IgnoreWords + value: + - '{{ IgnoreWords[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.macie.custom_data_identifiers +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +macie2:GetCustomDataIdentifier +``` + +### Delete +```json +macie2:DeleteCustomDataIdentifier +``` + +### List +```json +macie2:ListCustomDataIdentifiers +``` + +### Update +```json +macie2:TagResource, +macie2:UntagResource, +macie2:GetCustomDataIdentifier +``` diff --git a/website/docs/services/macie/custom_data_identifiers_list_only/index.md b/website/docs/services/macie/custom_data_identifiers_list_only/index.md new file mode 100644 index 0000000..4cfcd96 --- /dev/null +++ b/website/docs/services/macie/custom_data_identifiers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: custom_data_identifiers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_data_identifiers_list_only + - macie + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_data_identifiers in a region or regions, for all properties use custom_data_identifiers + +## Overview + + + + + + + +
Namecustom_data_identifiers_list_only
TypeResource
DescriptionMacie CustomDataIdentifier resource schema
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringCustom data identifier ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_data_identifiers in a region. +```sql +SELECT +region, +id +FROM aws.macie.custom_data_identifiers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_data_identifiers_list_only resource, see custom_data_identifiers + diff --git a/website/docs/services/macie/findings_filter_tags/index.md b/website/docs/services/macie/findings_filter_tags/index.md new file mode 100644 index 0000000..208b149 --- /dev/null +++ b/website/docs/services/macie/findings_filter_tags/index.md @@ -0,0 +1,89 @@ +--- +title: findings_filter_tags +hide_title: false +hide_table_of_contents: false +keywords: + - findings_filter_tags + - macie + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for findings_filters in a region + +## Overview + + + + + + + +
Namefindings_filter_tags
TypeResource
DescriptionMacie FindingsFilter resource schema.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringFindings filter name
stringFindings filter description
objectFindings filter criteria.
stringFindings filter action.
integerFindings filter position.
stringFindings filter ID.
stringFindings filter ARN.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all findings_filters in a region. +```sql +SELECT +region, +name, +description, +finding_criteria, +action, +position, +id, +arn, +tag_key, +tag_value +FROM aws.macie.findings_filter_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the findings_filter_tags resource, see findings_filters + diff --git a/website/docs/services/macie/findings_filters/index.md b/website/docs/services/macie/findings_filters/index.md new file mode 100644 index 0000000..51d40f8 --- /dev/null +++ b/website/docs/services/macie/findings_filters/index.md @@ -0,0 +1,245 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a findings_filter resource or lists findings_filters in a region + +## Overview + + + + + + + +
Namefindings_filters
TypeResource
DescriptionMacie FindingsFilter resource schema.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringFindings filter name
stringFindings filter description
objectFindings filter criteria.
stringFindings filter action.
integerFindings filter position.
stringFindings filter ID.
stringFindings filter ARN.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::Macie::FindingsFilter. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all findings_filters in a region. +```sql +SELECT +region, +name, +description, +finding_criteria, +action, +position, +id, +arn, +tags +FROM aws.macie.findings_filters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual findings_filter. +```sql +SELECT +region, +name, +description, +finding_criteria, +action, +position, +id, +arn, +tags +FROM aws.macie.findings_filters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new findings_filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.macie.findings_filters ( + Name, + FindingCriteria, + region +) +SELECT +'{{ Name }}', + '{{ FindingCriteria }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.macie.findings_filters ( + Name, + Description, + FindingCriteria, + Action, + Position, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ FindingCriteria }}', + '{{ Action }}', + '{{ Position }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: findings_filter + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: FindingCriteria + value: + Criterion: {} + - name: Action + value: '{{ Action }}' + - name: Position + value: '{{ Position }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.macie.findings_filters +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +macie2:GetFindingsFilter +``` + +### Update +```json +macie2:GetFindingsFilter, +macie2:UpdateFindingsFilter, +macie2:TagResource, +macie2:UntagResource +``` + +### Delete +```json +macie2:DeleteFindingsFilter +``` + +### List +```json +macie2:ListFindingsFilters +``` diff --git a/website/docs/services/macie/findings_filters_list_only/index.md b/website/docs/services/macie/findings_filters_list_only/index.md new file mode 100644 index 0000000..1407356 --- /dev/null +++ b/website/docs/services/macie/findings_filters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: findings_filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - findings_filters_list_only + - macie + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists findings_filters in a region or regions, for all properties use findings_filters + +## Overview + + + + + + + +
Namefindings_filters_list_only
TypeResource
DescriptionMacie FindingsFilter resource schema.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringFindings filter ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all findings_filters in a region. +```sql +SELECT +region, +id +FROM aws.macie.findings_filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the findings_filters_list_only resource, see findings_filters + diff --git a/website/docs/services/macie/index.md b/website/docs/services/macie/index.md new file mode 100644 index 0000000..3c4a778 --- /dev/null +++ b/website/docs/services/macie/index.md @@ -0,0 +1,46 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The macie service documentation. + +:::info Service Summary + +
+
+total resources: 11
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/macie/sessions/index.md b/website/docs/services/macie/sessions/index.md new file mode 100644 index 0000000..d4e2799 --- /dev/null +++ b/website/docs/services/macie/sessions/index.md @@ -0,0 +1,211 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a session resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringAWS account ID of customer
stringA enumeration value that specifies the status of the Macie Session.
stringA enumeration value that specifies how frequently finding updates are published.
stringService role used by Macie
stringAWS region.
+ +For more information, see AWS::Macie::Session. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all sessions in a region. +```sql +SELECT +region, +aws_account_id, +status, +finding_publishing_frequency, +service_role +FROM aws.macie.sessions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual session. +```sql +SELECT +region, +aws_account_id, +status, +finding_publishing_frequency, +service_role +FROM aws.macie.sessions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new session resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.macie.sessions ( + Status, + FindingPublishingFrequency, + region +) +SELECT +'{{ Status }}', + '{{ FindingPublishingFrequency }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.macie.sessions ( + Status, + FindingPublishingFrequency, + region +) +SELECT + '{{ Status }}', + '{{ FindingPublishingFrequency }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: session + props: + - name: Status + value: '{{ Status }}' + - name: FindingPublishingFrequency + value: '{{ FindingPublishingFrequency }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.macie.sessions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the sessions resource, the following permissions are required: + +### Create +```json +macie2:GetMacieSession, +macie2:EnableMacie +``` + +### Read +```json +macie2:GetMacieSession +``` + +### List +```json +macie2:GetMacieSession +``` + +### Update +```json +macie2:GetMacieSession, +macie2:UpdateMacieSession +``` + +### Delete +```json +macie2:DisableMacie +``` diff --git a/website/docs/services/macie/sessions_list_only/index.md b/website/docs/services/macie/sessions_list_only/index.md new file mode 100644 index 0000000..238bdd9 --- /dev/null +++ b/website/docs/services/macie/sessions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: sessions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sessions_list_only + - macie + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sessions in a region or regions, for all properties use sessions + +## Overview + + + + + + + +
Namesessions_list_only
TypeResource
DescriptionThe AWS::Macie::Session resource specifies a new Amazon Macie session. A session is an object that represents the Amazon Macie service. A session is required for Amazon Macie to become operational.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAWS account ID of customer
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sessions in a region. +```sql +SELECT +region, +aws_account_id +FROM aws.macie.sessions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sessions_list_only resource, see sessions + diff --git a/website/docs/services/managedblockchain/accessor_tags/index.md b/website/docs/services/managedblockchain/accessor_tags/index.md new file mode 100644 index 0000000..f1cad08 --- /dev/null +++ b/website/docs/services/managedblockchain/accessor_tags/index.md @@ -0,0 +1,89 @@ +--- +title: accessor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - accessor_tags + - managedblockchain + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for accessors in a region + +## Overview + + + + + + + +
Nameaccessor_tags
TypeResource
DescriptionDefinition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all accessors in a region. +```sql +SELECT +region, +arn, +billing_token, +creation_date, +id, +status, +accessor_type, +network_type, +tag_key, +tag_value +FROM aws.managedblockchain.accessor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the accessor_tags resource, see accessors + diff --git a/website/docs/services/managedblockchain/accessors/index.md b/website/docs/services/managedblockchain/accessors/index.md new file mode 100644 index 0000000..f88399e --- /dev/null +++ b/website/docs/services/managedblockchain/accessors/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an accessor resource or lists accessors in a region + +## Overview + + + + + + + +
Nameaccessors
TypeResource
DescriptionDefinition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::ManagedBlockchain::Accessor. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all accessors in a region. +```sql +SELECT +region, +arn, +billing_token, +creation_date, +id, +status, +accessor_type, +network_type, +tags +FROM aws.managedblockchain.accessors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual accessor. +```sql +SELECT +region, +arn, +billing_token, +creation_date, +id, +status, +accessor_type, +network_type, +tags +FROM aws.managedblockchain.accessors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new accessor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.managedblockchain.accessors ( + AccessorType, + region +) +SELECT +'{{ AccessorType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.managedblockchain.accessors ( + AccessorType, + NetworkType, + Tags, + region +) +SELECT + '{{ AccessorType }}', + '{{ NetworkType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: accessor + props: + - name: AccessorType + value: '{{ AccessorType }}' + - name: NetworkType + value: '{{ NetworkType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.managedblockchain.accessors +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the accessors resource, the following permissions are required: + +### Create +```json +managedblockchain:CreateAccessor, +managedblockchain:TagResource, +managedblockchain:GetAccessor +``` + +### Read +```json +managedblockchain:GetAccessor +``` + +### Update +```json +managedblockchain:GetAccessor, +managedblockchain:CreateAccessor, +managedblockchain:TagResource, +managedblockchain:UntagResource +``` + +### Delete +```json +managedblockchain:DeleteAccessor +``` + +### List +```json +managedblockchain:ListAccessors +``` diff --git a/website/docs/services/managedblockchain/accessors_list_only/index.md b/website/docs/services/managedblockchain/accessors_list_only/index.md new file mode 100644 index 0000000..c0cf6c1 --- /dev/null +++ b/website/docs/services/managedblockchain/accessors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: accessors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - accessors_list_only + - managedblockchain + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists accessors in a region or regions, for all properties use accessors + +## Overview + + + + + + + +
Nameaccessors_list_only
TypeResource
DescriptionDefinition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all accessors in a region. +```sql +SELECT +region, +id +FROM aws.managedblockchain.accessors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the accessors_list_only resource, see accessors + diff --git a/website/docs/services/managedblockchain/index.md b/website/docs/services/managedblockchain/index.md new file mode 100644 index 0000000..5d68a8f --- /dev/null +++ b/website/docs/services/managedblockchain/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The managedblockchain service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/mediaconnect/bridge_outputs/index.md b/website/docs/services/mediaconnect/bridge_outputs/index.md new file mode 100644 index 0000000..491b644 --- /dev/null +++ b/website/docs/services/mediaconnect/bridge_outputs/index.md @@ -0,0 +1,200 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bridge_output resource or lists bridge_outputs in a region + +## Overview + + + + + + + +
Namebridge_outputs
TypeResource
DescriptionResource schema for AWS::MediaConnect::BridgeOutput
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Number (ARN) of the bridge.
objectThe output of the bridge.
stringThe network output name.
stringAWS region.
+ +For more information, see AWS::MediaConnect::BridgeOutput. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual bridge_output. +```sql +SELECT +region, +bridge_arn, +network_output, +name +FROM aws.mediaconnect.bridge_outputs +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bridge_output resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.bridge_outputs ( + BridgeArn, + NetworkOutput, + Name, + region +) +SELECT +'{{ BridgeArn }}', + '{{ NetworkOutput }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.bridge_outputs ( + BridgeArn, + NetworkOutput, + Name, + region +) +SELECT + '{{ BridgeArn }}', + '{{ NetworkOutput }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bridge_output + props: + - name: BridgeArn + value: '{{ BridgeArn }}' + - name: NetworkOutput + value: + Protocol: '{{ Protocol }}' + IpAddress: '{{ IpAddress }}' + Port: '{{ Port }}' + NetworkName: '{{ NetworkName }}' + Ttl: '{{ Ttl }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediaconnect.bridge_outputs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the bridge_outputs resource, the following permissions are required: + +### Create +```json +mediaconnect:AddBridgeOutputs, +mediaconnect:DescribeBridge +``` + +### Read +```json +mediaconnect:DescribeBridge +``` + +### Update +```json +mediaconnect:DescribeBridge, +mediaconnect:UpdateBridgeOutput +``` + +### Delete +```json +mediaconnect:RemoveBridgeOutput +``` diff --git a/website/docs/services/mediaconnect/bridge_sources/index.md b/website/docs/services/mediaconnect/bridge_sources/index.md new file mode 100644 index 0000000..67521c9 --- /dev/null +++ b/website/docs/services/mediaconnect/bridge_sources/index.md @@ -0,0 +1,208 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bridge_source resource or lists bridge_sources in a region + +## Overview + + + + + + + +
Namebridge_sources
TypeResource
DescriptionResource schema for AWS::MediaConnect::BridgeSource
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the source.
stringThe Amazon Resource Number (ARN) of the bridge.
objectThe source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
objectThe source of the bridge. A network source originates at your premises.
stringAWS region.
+ +For more information, see AWS::MediaConnect::BridgeSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual bridge_source. +```sql +SELECT +region, +name, +bridge_arn, +flow_source, +network_source +FROM aws.mediaconnect.bridge_sources +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bridge_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.bridge_sources ( + Name, + BridgeArn, + region +) +SELECT +'{{ Name }}', + '{{ BridgeArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.bridge_sources ( + Name, + BridgeArn, + FlowSource, + NetworkSource, + region +) +SELECT + '{{ Name }}', + '{{ BridgeArn }}', + '{{ FlowSource }}', + '{{ NetworkSource }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bridge_source + props: + - name: Name + value: '{{ Name }}' + - name: BridgeArn + value: '{{ BridgeArn }}' + - name: FlowSource + value: + FlowArn: '{{ FlowArn }}' + FlowVpcInterfaceAttachment: + VpcInterfaceName: '{{ VpcInterfaceName }}' + - name: NetworkSource + value: + Protocol: '{{ Protocol }}' + MulticastIp: '{{ MulticastIp }}' + MulticastSourceSettings: + MulticastSourceIp: '{{ MulticastSourceIp }}' + Port: '{{ Port }}' + NetworkName: '{{ NetworkName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediaconnect.bridge_sources +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the bridge_sources resource, the following permissions are required: + +### Create +```json +mediaconnect:AddBridgeSources, +mediaconnect:DescribeBridge +``` + +### Read +```json +mediaconnect:DescribeBridge +``` + +### Update +```json +mediaconnect:DescribeBridge, +mediaconnect:UpdateBridgeSource +``` + +### Delete +```json +mediaconnect:RemoveBridgeSource +``` diff --git a/website/docs/services/mediaconnect/bridges/index.md b/website/docs/services/mediaconnect/bridges/index.md new file mode 100644 index 0000000..75fa266 --- /dev/null +++ b/website/docs/services/mediaconnect/bridges/index.md @@ -0,0 +1,278 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bridge resource or lists bridges in a region + +## Overview + + + + + + + +
Namebridges
TypeResource
DescriptionResource schema for AWS::MediaConnect::Bridge
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the bridge.
stringThe Amazon Resource Number (ARN) of the bridge.
stringThe placement Amazon Resource Number (ARN) of the bridge.
string
objectThe settings for source failover
arrayThe outputs on this bridge.
arrayThe sources on this bridge.
object
object
stringAWS region.
+ +For more information, see AWS::MediaConnect::Bridge. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all bridges in a region. +```sql +SELECT +region, +name, +bridge_arn, +placement_arn, +bridge_state, +source_failover_config, +outputs, +sources, +ingress_gateway_bridge, +egress_gateway_bridge +FROM aws.mediaconnect.bridges +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual bridge. +```sql +SELECT +region, +name, +bridge_arn, +placement_arn, +bridge_state, +source_failover_config, +outputs, +sources, +ingress_gateway_bridge, +egress_gateway_bridge +FROM aws.mediaconnect.bridges +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bridge resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.bridges ( + Name, + PlacementArn, + Sources, + region +) +SELECT +'{{ Name }}', + '{{ PlacementArn }}', + '{{ Sources }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.bridges ( + Name, + PlacementArn, + SourceFailoverConfig, + Outputs, + Sources, + IngressGatewayBridge, + EgressGatewayBridge, + region +) +SELECT + '{{ Name }}', + '{{ PlacementArn }}', + '{{ SourceFailoverConfig }}', + '{{ Outputs }}', + '{{ Sources }}', + '{{ IngressGatewayBridge }}', + '{{ EgressGatewayBridge }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bridge + props: + - name: Name + value: '{{ Name }}' + - name: PlacementArn + value: '{{ PlacementArn }}' + - name: SourceFailoverConfig + value: + State: '{{ State }}' + RecoveryWindow: '{{ RecoveryWindow }}' + FailoverMode: '{{ FailoverMode }}' + SourcePriority: + PrimarySource: '{{ PrimarySource }}' + - name: Outputs + value: + - BridgeArn: '{{ BridgeArn }}' + NetworkOutput: + Protocol: '{{ Protocol }}' + IpAddress: '{{ IpAddress }}' + Port: '{{ Port }}' + NetworkName: '{{ NetworkName }}' + Ttl: '{{ Ttl }}' + Name: '{{ Name }}' + - name: Sources + value: + - Name: '{{ Name }}' + BridgeArn: '{{ BridgeArn }}' + FlowSource: + FlowArn: '{{ FlowArn }}' + FlowVpcInterfaceAttachment: + VpcInterfaceName: '{{ VpcInterfaceName }}' + NetworkSource: + Protocol: '{{ Protocol }}' + MulticastIp: '{{ MulticastIp }}' + MulticastSourceSettings: + MulticastSourceIp: '{{ MulticastSourceIp }}' + Port: '{{ Port }}' + NetworkName: '{{ NetworkName }}' + - name: IngressGatewayBridge + value: + MaxBitrate: '{{ MaxBitrate }}' + MaxOutputs: '{{ MaxOutputs }}' + - name: EgressGatewayBridge + value: + MaxBitrate: '{{ MaxBitrate }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediaconnect.bridges +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the bridges resource, the following permissions are required: + +### Create +```json +mediaconnect:CreateBridge, +mediaconnect:DescribeBridge +``` + +### Read +```json +mediaconnect:DescribeBridge +``` + +### Update +```json +mediaconnect:DescribeBridge, +mediaconnect:UpdateBridge +``` + +### Delete +```json +mediaconnect:DescribeBridge, +mediaconnect:DeleteBridge +``` + +### List +```json +mediaconnect:ListBridges +``` diff --git a/website/docs/services/mediaconnect/bridges_list_only/index.md b/website/docs/services/mediaconnect/bridges_list_only/index.md new file mode 100644 index 0000000..ce39895 --- /dev/null +++ b/website/docs/services/mediaconnect/bridges_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: bridges_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bridges_list_only + - mediaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bridges in a region or regions, for all properties use bridges + +## Overview + + + + + + + +
Namebridges_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::Bridge
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Number (ARN) of the bridge.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bridges in a region. +```sql +SELECT +region, +bridge_arn +FROM aws.mediaconnect.bridges_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bridges_list_only resource, see bridges + diff --git a/website/docs/services/mediaconnect/flow_entitlements/index.md b/website/docs/services/mediaconnect/flow_entitlements/index.md new file mode 100644 index 0000000..a1e6d0f --- /dev/null +++ b/website/docs/services/mediaconnect/flow_entitlements/index.md @@ -0,0 +1,258 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flow_entitlement resource or lists flow_entitlements in a region + +## Overview + + + + + + + +
Nameflow_entitlements
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowEntitlement
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the flow.
stringThe ARN of the entitlement.
integerPercentage from 0-100 of the data transfer cost to be billed to the subscriber.
stringA description of the entitlement.
objectThe type of encryption that will be used on the output that is associated with this entitlement.
stringAn indication of whether the entitlement is enabled.
stringThe name of the entitlement.
arrayThe AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
stringAWS region.
+ +For more information, see AWS::MediaConnect::FlowEntitlement. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flow_entitlements in a region. +```sql +SELECT +region, +flow_arn, +entitlement_arn, +data_transfer_subscriber_fee_percent, +description, +encryption, +entitlement_status, +name, +subscribers +FROM aws.mediaconnect.flow_entitlements +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flow_entitlement. +```sql +SELECT +region, +flow_arn, +entitlement_arn, +data_transfer_subscriber_fee_percent, +description, +encryption, +entitlement_status, +name, +subscribers +FROM aws.mediaconnect.flow_entitlements +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flow_entitlement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.flow_entitlements ( + FlowArn, + Description, + Name, + Subscribers, + region +) +SELECT +'{{ FlowArn }}', + '{{ Description }}', + '{{ Name }}', + '{{ Subscribers }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.flow_entitlements ( + FlowArn, + DataTransferSubscriberFeePercent, + Description, + Encryption, + EntitlementStatus, + Name, + Subscribers, + region +) +SELECT + '{{ FlowArn }}', + '{{ DataTransferSubscriberFeePercent }}', + '{{ Description }}', + '{{ Encryption }}', + '{{ EntitlementStatus }}', + '{{ Name }}', + '{{ Subscribers }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flow_entitlement + props: + - name: FlowArn + value: '{{ FlowArn }}' + - name: DataTransferSubscriberFeePercent + value: '{{ DataTransferSubscriberFeePercent }}' + - name: Description + value: '{{ Description }}' + - name: Encryption + value: + Algorithm: '{{ Algorithm }}' + ConstantInitializationVector: '{{ ConstantInitializationVector }}' + DeviceId: '{{ DeviceId }}' + KeyType: '{{ KeyType }}' + Region: '{{ Region }}' + ResourceId: '{{ ResourceId }}' + RoleArn: '{{ RoleArn }}' + SecretArn: '{{ SecretArn }}' + Url: '{{ Url }}' + - name: EntitlementStatus + value: '{{ EntitlementStatus }}' + - name: Name + value: '{{ Name }}' + - name: Subscribers + value: + - '{{ Subscribers[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediaconnect.flow_entitlements +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the flow_entitlements resource, the following permissions are required: + +### Create +```json +iam:PassRole, +mediaconnect:GrantFlowEntitlements +``` + +### Read +```json +mediaconnect:DescribeFlow +``` + +### Update +```json +mediaconnect:DescribeFlow, +mediaconnect:UpdateFlowEntitlement +``` + +### Delete +```json +mediaconnect:DescribeFlow, +mediaconnect:RevokeFlowEntitlement +``` + +### List +```json +mediaconnect:DescribeFlow +``` diff --git a/website/docs/services/mediaconnect/flow_entitlements_list_only/index.md b/website/docs/services/mediaconnect/flow_entitlements_list_only/index.md new file mode 100644 index 0000000..62b888c --- /dev/null +++ b/website/docs/services/mediaconnect/flow_entitlements_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: flow_entitlements_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_entitlements_list_only + - mediaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_entitlements in a region or regions, for all properties use flow_entitlements + +## Overview + + + + + + + +
Nameflow_entitlements_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowEntitlement
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the entitlement.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_entitlements in a region. +```sql +SELECT +region, +entitlement_arn +FROM aws.mediaconnect.flow_entitlements_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_entitlements_list_only resource, see flow_entitlements + diff --git a/website/docs/services/mediaconnect/flow_outputs/index.md b/website/docs/services/mediaconnect/flow_outputs/index.md new file mode 100644 index 0000000..a3e623d --- /dev/null +++ b/website/docs/services/mediaconnect/flow_outputs/index.md @@ -0,0 +1,328 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flow_output resource or lists flow_outputs in a region + +## Overview + + + + + + + +
Nameflow_outputs
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowOutput
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
stringThe ARN of the output.
arrayThe range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
objectThe type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
stringA description of the output.
stringThe address where you want to send the output.
integerThe maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
integerThe minimum latency in milliseconds.
stringThe name of the output. This value must be unique within the current flow.
integerThe port to use when content is distributed to this output.
stringThe protocol that is used by the source or output.
stringThe remote ID for the Zixi-pull stream.
integerThe smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
stringThe stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
objectThe name of the VPC interface attachment to use for this output.
arrayThe definition for each media stream that is associated with the output.
stringAn indication of whether the output should transmit data or not.
stringAWS region.
+ +For more information, see AWS::MediaConnect::FlowOutput. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flow_outputs in a region. +```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, +media_stream_output_configurations, +output_status +FROM aws.mediaconnect.flow_outputs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flow_output. +```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, +media_stream_output_configurations, +output_status +FROM aws.mediaconnect.flow_outputs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flow_output resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.flow_outputs ( + FlowArn, + Protocol, + region +) +SELECT +'{{ FlowArn }}', + '{{ Protocol }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.flow_outputs ( + FlowArn, + CidrAllowList, + Encryption, + Description, + Destination, + MaxLatency, + MinLatency, + Name, + Port, + Protocol, + RemoteId, + SmoothingLatency, + StreamId, + VpcInterfaceAttachment, + MediaStreamOutputConfigurations, + OutputStatus, + region +) +SELECT + '{{ FlowArn }}', + '{{ CidrAllowList }}', + '{{ Encryption }}', + '{{ Description }}', + '{{ Destination }}', + '{{ MaxLatency }}', + '{{ MinLatency }}', + '{{ Name }}', + '{{ Port }}', + '{{ Protocol }}', + '{{ RemoteId }}', + '{{ SmoothingLatency }}', + '{{ StreamId }}', + '{{ VpcInterfaceAttachment }}', + '{{ MediaStreamOutputConfigurations }}', + '{{ OutputStatus }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flow_output + props: + - name: FlowArn + value: '{{ FlowArn }}' + - name: CidrAllowList + value: + - '{{ CidrAllowList[0] }}' + - name: Encryption + value: + Algorithm: '{{ Algorithm }}' + ConstantInitializationVector: '{{ ConstantInitializationVector }}' + DeviceId: '{{ DeviceId }}' + KeyType: '{{ KeyType }}' + Region: '{{ Region }}' + ResourceId: '{{ ResourceId }}' + RoleArn: '{{ RoleArn }}' + SecretArn: '{{ SecretArn }}' + Url: '{{ Url }}' + - name: Description + value: '{{ Description }}' + - name: Destination + value: '{{ Destination }}' + - name: MaxLatency + value: '{{ MaxLatency }}' + - name: MinLatency + value: '{{ MinLatency }}' + - name: Name + value: '{{ Name }}' + - name: Port + value: '{{ Port }}' + - name: Protocol + value: '{{ Protocol }}' + - name: RemoteId + value: '{{ RemoteId }}' + - name: SmoothingLatency + value: '{{ SmoothingLatency }}' + - name: StreamId + value: '{{ StreamId }}' + - name: VpcInterfaceAttachment + value: + VpcInterfaceName: '{{ VpcInterfaceName }}' + - name: MediaStreamOutputConfigurations + value: + - EncodingName: '{{ EncodingName }}' + DestinationConfigurations: + - DestinationIp: '{{ DestinationIp }}' + DestinationPort: '{{ DestinationPort }}' + Interface: + Name: '{{ Name }}' + MediaStreamName: '{{ MediaStreamName }}' + EncodingParameters: + CompressionFactor: null + EncoderProfile: '{{ EncoderProfile }}' + - name: OutputStatus + value: '{{ OutputStatus }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediaconnect.flow_outputs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the flow_outputs resource, the following permissions are required: + +### Create +```json +iam:PassRole, +mediaconnect:AddFlowOutputs +``` + +### Read +```json +mediaconnect:DescribeFlow +``` + +### Update +```json +mediaconnect:DescribeFlow, +mediaconnect:UpdateFlowOutput +``` + +### Delete +```json +mediaconnect:DescribeFlow, +mediaconnect:RemoveFlowOutput +``` + +### List +```json +mediaconnect:DescribeFlow +``` diff --git a/website/docs/services/mediaconnect/flow_outputs_list_only/index.md b/website/docs/services/mediaconnect/flow_outputs_list_only/index.md new file mode 100644 index 0000000..5ec5c01 --- /dev/null +++ b/website/docs/services/mediaconnect/flow_outputs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: flow_outputs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_outputs_list_only + - mediaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_outputs in a region or regions, for all properties use flow_outputs + +## Overview + + + + + + + +
Nameflow_outputs_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowOutput
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the output.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_outputs in a region. +```sql +SELECT +region, +output_arn +FROM aws.mediaconnect.flow_outputs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_outputs_list_only resource, see flow_outputs + diff --git a/website/docs/services/mediaconnect/flow_sources/index.md b/website/docs/services/mediaconnect/flow_sources/index.md new file mode 100644 index 0000000..54d1734 --- /dev/null +++ b/website/docs/services/mediaconnect/flow_sources/index.md @@ -0,0 +1,341 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flow_source resource or lists flow_sources in a region + +## Overview + + + + + + + +
Nameflow_sources
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowSource
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the flow.
stringThe ARN of the source.
objectThe type of encryption that is used on the content ingested from this source.
stringA description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
stringThe ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
objectThe source configuration for cloud flows receiving a stream from a bridge.
stringThe IP address that the flow will be listening on for incoming content.
integerThe port that the flow will be listening on for incoming content.
integerThe smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
integerThe maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
integerThe minimum latency in milliseconds.
stringThe name of the source.
stringThe protocol that is used by the source.
stringThe IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
integerThe port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
stringThe stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
stringThe port that the flow will be listening on for incoming content.(ReadOnly)
stringSource IP or domain name for SRT-caller protocol.
integerSource port for SRT-caller protocol.
stringThe name of the VPC Interface this Source is configured with.
stringThe range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
stringAWS region.
+ +For more information, see AWS::MediaConnect::FlowSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flow_sources in a region. +```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_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flow_source. +```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_sources +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flow_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.flow_sources ( + Description, + Name, + region +) +SELECT +'{{ Description }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.flow_sources ( + FlowArn, + Decryption, + Description, + EntitlementArn, + GatewayBridgeSource, + IngestPort, + MaxBitrate, + MaxLatency, + MinLatency, + Name, + Protocol, + SenderIpAddress, + SenderControlPort, + StreamId, + SourceListenerAddress, + SourceListenerPort, + VpcInterfaceName, + WhitelistCidr, + region +) +SELECT + '{{ FlowArn }}', + '{{ Decryption }}', + '{{ Description }}', + '{{ EntitlementArn }}', + '{{ GatewayBridgeSource }}', + '{{ IngestPort }}', + '{{ MaxBitrate }}', + '{{ MaxLatency }}', + '{{ MinLatency }}', + '{{ Name }}', + '{{ Protocol }}', + '{{ SenderIpAddress }}', + '{{ SenderControlPort }}', + '{{ StreamId }}', + '{{ SourceListenerAddress }}', + '{{ SourceListenerPort }}', + '{{ VpcInterfaceName }}', + '{{ WhitelistCidr }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flow_source + props: + - name: FlowArn + value: '{{ FlowArn }}' + - name: Decryption + value: + Algorithm: '{{ Algorithm }}' + ConstantInitializationVector: '{{ ConstantInitializationVector }}' + DeviceId: '{{ DeviceId }}' + KeyType: '{{ KeyType }}' + Region: '{{ Region }}' + ResourceId: '{{ ResourceId }}' + RoleArn: '{{ RoleArn }}' + SecretArn: '{{ SecretArn }}' + Url: '{{ Url }}' + - name: Description + value: '{{ Description }}' + - name: EntitlementArn + value: '{{ EntitlementArn }}' + - name: GatewayBridgeSource + value: + BridgeArn: '{{ BridgeArn }}' + VpcInterfaceAttachment: + VpcInterfaceName: '{{ VpcInterfaceName }}' + - name: IngestPort + value: '{{ IngestPort }}' + - name: MaxBitrate + value: '{{ MaxBitrate }}' + - name: MaxLatency + value: '{{ MaxLatency }}' + - name: MinLatency + value: '{{ MinLatency }}' + - name: Name + value: '{{ Name }}' + - name: Protocol + value: '{{ Protocol }}' + - name: SenderIpAddress + value: '{{ SenderIpAddress }}' + - name: SenderControlPort + value: '{{ SenderControlPort }}' + - name: StreamId + value: '{{ StreamId }}' + - name: SourceListenerAddress + value: '{{ SourceListenerAddress }}' + - name: SourceListenerPort + value: '{{ SourceListenerPort }}' + - name: VpcInterfaceName + value: '{{ VpcInterfaceName }}' + - name: WhitelistCidr + value: '{{ WhitelistCidr }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediaconnect.flow_sources +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediaconnect:DescribeFlow +``` + +### Update +```json +mediaconnect:DescribeFlow, +mediaconnect:UpdateFlowSource +``` + +### Delete +```json +mediaconnect:DescribeFlow, +mediaconnect:RemoveFlowSource +``` + +### List +```json +mediaconnect:DescribeFlow +``` diff --git a/website/docs/services/mediaconnect/flow_sources_list_only/index.md b/website/docs/services/mediaconnect/flow_sources_list_only/index.md new file mode 100644 index 0000000..5fcf06f --- /dev/null +++ b/website/docs/services/mediaconnect/flow_sources_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: flow_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_sources_list_only + - mediaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_sources in a region or regions, for all properties use flow_sources + +## Overview + + + + + + + +
Nameflow_sources_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowSource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the source.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_sources in a region. +```sql +SELECT +region, +source_arn +FROM aws.mediaconnect.flow_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_sources_list_only resource, see flow_sources + diff --git a/website/docs/services/mediaconnect/flow_vpc_interfaces/index.md b/website/docs/services/mediaconnect/flow_vpc_interfaces/index.md new file mode 100644 index 0000000..af5647b --- /dev/null +++ b/website/docs/services/mediaconnect/flow_vpc_interfaces/index.md @@ -0,0 +1,239 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flow_vpc_interface resource or lists flow_vpc_interfaces in a region + +## Overview + + + + + + + +
Nameflow_vpc_interfaces
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowVpcInterface
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
stringImmutable and has to be a unique against other VpcInterfaces in this Flow.
stringRole Arn MediaConnect can assume to create ENIs in customer's account.
arraySecurity Group IDs to be used on ENI.
stringSubnet must be in the AZ of the Flow
arrayIDs of the network interfaces created in customer's account by MediaConnect.
stringAWS region.
+ +For more information, see AWS::MediaConnect::FlowVpcInterface. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flow_vpc_interfaces in a region. +```sql +SELECT +region, +flow_arn, +name, +role_arn, +security_group_ids, +subnet_id, +network_interface_ids +FROM aws.mediaconnect.flow_vpc_interfaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flow_vpc_interface. +```sql +SELECT +region, +flow_arn, +name, +role_arn, +security_group_ids, +subnet_id, +network_interface_ids +FROM aws.mediaconnect.flow_vpc_interfaces +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flow_vpc_interface resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.flow_vpc_interfaces ( + FlowArn, + Name, + RoleArn, + SecurityGroupIds, + SubnetId, + region +) +SELECT +'{{ FlowArn }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ SecurityGroupIds }}', + '{{ SubnetId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.flow_vpc_interfaces ( + FlowArn, + Name, + RoleArn, + SecurityGroupIds, + SubnetId, + region +) +SELECT + '{{ FlowArn }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ SecurityGroupIds }}', + '{{ SubnetId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flow_vpc_interface + props: + - name: FlowArn + value: '{{ FlowArn }}' + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: SubnetId + value: '{{ SubnetId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediaconnect.flow_vpc_interfaces +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediaconnect:DescribeFlow +``` + +### Update +```json +mediaconnect:DescribeFlow, +mediaconnect:AddFlowVpcInterfaces, +mediaconnect:RemoveFlowVpcInterface +``` + +### Delete +```json +mediaconnect:DescribeFlow, +mediaconnect:RemoveFlowVpcInterface +``` + +### List +```json +mediaconnect:DescribeFlow +``` diff --git a/website/docs/services/mediaconnect/flow_vpc_interfaces_list_only/index.md b/website/docs/services/mediaconnect/flow_vpc_interfaces_list_only/index.md new file mode 100644 index 0000000..3ccf133 --- /dev/null +++ b/website/docs/services/mediaconnect/flow_vpc_interfaces_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: flow_vpc_interfaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_vpc_interfaces_list_only + - mediaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_vpc_interfaces in a region or regions, for all properties use flow_vpc_interfaces + +## Overview + + + + + + + +
Nameflow_vpc_interfaces_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowVpcInterface
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
stringImmutable and has to be a unique against other VpcInterfaces in this Flow.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_vpc_interfaces in a region. +```sql +SELECT +region, +flow_arn, +name +FROM aws.mediaconnect.flow_vpc_interfaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_vpc_interfaces_list_only resource, see flow_vpc_interfaces + diff --git a/website/docs/services/mediaconnect/flows/index.md b/website/docs/services/mediaconnect/flows/index.md new file mode 100644 index 0000000..ba3ce3c --- /dev/null +++ b/website/docs/services/mediaconnect/flows/index.md @@ -0,0 +1,336 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a flow resource or lists flows in a region + +## Overview + + + + + + + +
Nameflows
TypeResource
DescriptionResource schema for AWS::MediaConnect::Flow
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
stringThe IP address from which video will be sent to output destinations.
stringThe name of the flow.
stringThe Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
stringThe Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)
objectThe source of the flow.
objectThe source failover config of the flow.
arrayThe VPC interfaces that you added to this flow.
arrayThe media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow.
objectThe maintenance settings you want to use for the flow.
objectThe source monitoring config of the flow.
stringAWS region.
+ +For more information, see AWS::MediaConnect::Flow. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all flows in a region. +```sql +SELECT +region, +flow_arn, +egress_ip, +name, +availability_zone, +flow_availability_zone, +source, +source_failover_config, +vpc_interfaces, +media_streams, +maintenance, +source_monitoring_config +FROM aws.mediaconnect.flows +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual flow. +```sql +SELECT +region, +flow_arn, +egress_ip, +name, +availability_zone, +flow_availability_zone, +source, +source_failover_config, +vpc_interfaces, +media_streams, +maintenance, +source_monitoring_config +FROM aws.mediaconnect.flows +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new flow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.flows ( + Name, + Source, + region +) +SELECT +'{{ Name }}', + '{{ Source }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.flows ( + Name, + AvailabilityZone, + Source, + SourceFailoverConfig, + VpcInterfaces, + MediaStreams, + Maintenance, + SourceMonitoringConfig, + region +) +SELECT + '{{ Name }}', + '{{ AvailabilityZone }}', + '{{ Source }}', + '{{ SourceFailoverConfig }}', + '{{ VpcInterfaces }}', + '{{ MediaStreams }}', + '{{ Maintenance }}', + '{{ SourceMonitoringConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: flow + props: + - name: Name + value: '{{ Name }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: Source + value: + SourceArn: '{{ SourceArn }}' + Decryption: + Algorithm: '{{ Algorithm }}' + ConstantInitializationVector: '{{ ConstantInitializationVector }}' + DeviceId: '{{ DeviceId }}' + KeyType: '{{ KeyType }}' + Region: '{{ Region }}' + ResourceId: '{{ ResourceId }}' + RoleArn: '{{ RoleArn }}' + SecretArn: '{{ SecretArn }}' + Url: '{{ Url }}' + Description: '{{ Description }}' + EntitlementArn: '{{ EntitlementArn }}' + GatewayBridgeSource: + BridgeArn: '{{ BridgeArn }}' + VpcInterfaceAttachment: + VpcInterfaceName: '{{ VpcInterfaceName }}' + IngestIp: '{{ IngestIp }}' + IngestPort: '{{ IngestPort }}' + MaxBitrate: '{{ MaxBitrate }}' + MaxLatency: '{{ MaxLatency }}' + MinLatency: '{{ MinLatency }}' + Name: '{{ Name }}' + Protocol: '{{ Protocol }}' + SenderIpAddress: '{{ SenderIpAddress }}' + SenderControlPort: '{{ SenderControlPort }}' + StreamId: '{{ StreamId }}' + SourceIngestPort: '{{ SourceIngestPort }}' + SourceListenerAddress: '{{ SourceListenerAddress }}' + SourceListenerPort: '{{ SourceListenerPort }}' + VpcInterfaceName: '{{ VpcInterfaceName }}' + WhitelistCidr: '{{ WhitelistCidr }}' + MaxSyncBuffer: '{{ MaxSyncBuffer }}' + MediaStreamSourceConfigurations: + - EncodingName: '{{ EncodingName }}' + InputConfigurations: + - InputPort: '{{ InputPort }}' + Interface: + Name: '{{ Name }}' + MediaStreamName: '{{ MediaStreamName }}' + - name: SourceFailoverConfig + value: + State: '{{ State }}' + RecoveryWindow: '{{ RecoveryWindow }}' + FailoverMode: '{{ FailoverMode }}' + SourcePriority: + PrimarySource: '{{ PrimarySource }}' + - name: VpcInterfaces + value: + - Name: '{{ Name }}' + NetworkInterfaceType: '{{ NetworkInterfaceType }}' + RoleArn: '{{ RoleArn }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetId: '{{ SubnetId }}' + NetworkInterfaceIds: + - '{{ NetworkInterfaceIds[0] }}' + - name: MediaStreams + value: + - MediaStreamId: '{{ MediaStreamId }}' + MediaStreamType: '{{ MediaStreamType }}' + VideoFormat: '{{ VideoFormat }}' + MediaStreamName: '{{ MediaStreamName }}' + Description: '{{ Description }}' + Attributes: + Fmtp: + ExactFramerate: '{{ ExactFramerate }}' + Colorimetry: '{{ Colorimetry }}' + ScanMode: '{{ ScanMode }}' + Tcs: '{{ Tcs }}' + Range: '{{ Range }}' + Par: '{{ Par }}' + ChannelOrder: '{{ ChannelOrder }}' + Lang: '{{ Lang }}' + ClockRate: '{{ ClockRate }}' + Fmt: '{{ Fmt }}' + - name: Maintenance + value: + MaintenanceDay: '{{ MaintenanceDay }}' + MaintenanceStartHour: '{{ MaintenanceStartHour }}' + - name: SourceMonitoringConfig + value: + ThumbnailState: '{{ ThumbnailState }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediaconnect.flows +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the flows resource, the following permissions are required: + +### Create +```json +mediaconnect:CreateFlow, +iam:PassRole +``` + +### Read +```json +mediaconnect:DescribeFlow +``` + +### Update +```json +mediaconnect:DescribeFlow, +mediaconnect:UpdateFlow, +mediaconnect:UpdateFlowSource, +mediaconnect:UpdateFlowMediaStream, +mediaconnect:AddFlowMediaStreams, +mediaconnect:RemoveFlowMediaStream, +mediaconnect:AddFlowVpcInterfaces, +mediaconnect:RemoveFlowVpcInterface +``` + +### Delete +```json +mediaconnect:DescribeFlow, +mediaconnect:DeleteFlow +``` + +### List +```json +mediaconnect:ListFlows +``` diff --git a/website/docs/services/mediaconnect/flows_list_only/index.md b/website/docs/services/mediaconnect/flows_list_only/index.md new file mode 100644 index 0000000..7b01f23 --- /dev/null +++ b/website/docs/services/mediaconnect/flows_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: flows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flows_list_only + - mediaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flows in a region or regions, for all properties use flows + +## Overview + + + + + + + +
Nameflows_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::Flow
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flows in a region. +```sql +SELECT +region, +flow_arn +FROM aws.mediaconnect.flows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flows_list_only resource, see flows + diff --git a/website/docs/services/mediaconnect/gateways/index.md b/website/docs/services/mediaconnect/gateways/index.md new file mode 100644 index 0000000..11a35e4 --- /dev/null +++ b/website/docs/services/mediaconnect/gateways/index.md @@ -0,0 +1,215 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a gateway resource or lists gateways in a region + +## Overview + + + + + + + +
Namegateways
TypeResource
DescriptionResource schema for AWS::MediaConnect::Gateway
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the gateway. This name can not be modified after the gateway is created.
stringThe Amazon Resource Name (ARN) of the gateway.
stringThe current status of the gateway.
arrayThe range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
arrayThe list of networks in the gateway.
stringAWS region.
+ +For more information, see AWS::MediaConnect::Gateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all gateways in a region. +```sql +SELECT +region, +name, +gateway_arn, +gateway_state, +egress_cidr_blocks, +networks +FROM aws.mediaconnect.gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual gateway. +```sql +SELECT +region, +name, +gateway_arn, +gateway_state, +egress_cidr_blocks, +networks +FROM aws.mediaconnect.gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.gateways ( + Name, + EgressCidrBlocks, + Networks, + region +) +SELECT +'{{ Name }}', + '{{ EgressCidrBlocks }}', + '{{ Networks }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediaconnect.gateways ( + Name, + EgressCidrBlocks, + Networks, + region +) +SELECT + '{{ Name }}', + '{{ EgressCidrBlocks }}', + '{{ Networks }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: gateway + props: + - name: Name + value: '{{ Name }}' + - name: EgressCidrBlocks + value: + - '{{ EgressCidrBlocks[0] }}' + - name: Networks + value: + - Name: '{{ Name }}' + CidrBlock: '{{ CidrBlock }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediaconnect.gateways +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the gateways resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +mediaconnect:CreateGateway, +mediaconnect:DescribeGateway +``` + +### Read +```json +mediaconnect:DescribeGateway +``` + +### Delete +```json +iam:CreateServiceLinkedRole, +mediaconnect:DescribeGateway, +mediaconnect:DeleteGateway +``` + +### List +```json +mediaconnect:ListGateways +``` diff --git a/website/docs/services/mediaconnect/gateways_list_only/index.md b/website/docs/services/mediaconnect/gateways_list_only/index.md new file mode 100644 index 0000000..174763d --- /dev/null +++ b/website/docs/services/mediaconnect/gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - gateways_list_only + - mediaconnect + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists gateways in a region or regions, for all properties use gateways + +## Overview + + + + + + + +
Namegateways_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::Gateway
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all gateways in a region. +```sql +SELECT +region, +gateway_arn +FROM aws.mediaconnect.gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the gateways_list_only resource, see gateways + diff --git a/website/docs/services/mediaconnect/index.md b/website/docs/services/mediaconnect/index.md new file mode 100644 index 0000000..4da68d4 --- /dev/null +++ b/website/docs/services/mediaconnect/index.md @@ -0,0 +1,51 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The mediaconnect service documentation. + +:::info Service Summary + +
+
+total resources: 16
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/medialive/channel_placement_group_tags/index.md b/website/docs/services/medialive/channel_placement_group_tags/index.md new file mode 100644 index 0000000..78ad99c --- /dev/null +++ b/website/docs/services/medialive/channel_placement_group_tags/index.md @@ -0,0 +1,89 @@ +--- +title: channel_placement_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_placement_group_tags + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channel_placement_groups in a region + +## Overview + + + + + + + +
Namechannel_placement_group_tags
TypeResource
DescriptionDefinition of AWS::MediaLive::ChannelPlacementGroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the channel placement group.
arrayList of channel IDs added to the channel placement group.
stringThe ID of the cluster the node is on.
stringUnique internal identifier.
stringThe name of the channel placement group.
arrayList of nodes added to the channel placement group
stringThe current state of the ChannelPlacementGroupState
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channel_placement_groups in a region. +```sql +SELECT +region, +arn, +channels, +cluster_id, +id, +name, +nodes, +state, +tag_key, +tag_value +FROM aws.medialive.channel_placement_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_placement_group_tags resource, see channel_placement_groups + diff --git a/website/docs/services/medialive/channel_placement_groups/index.md b/website/docs/services/medialive/channel_placement_groups/index.md new file mode 100644 index 0000000..6799284 --- /dev/null +++ b/website/docs/services/medialive/channel_placement_groups/index.md @@ -0,0 +1,245 @@ +--- +title: channel_placement_groups +hide_title: false +hide_table_of_contents: false +keywords: + - channel_placement_groups + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a channel_placement_group resource or lists channel_placement_groups in a region + +## Overview + + + + + + + +
Namechannel_placement_groups
TypeResource
DescriptionDefinition of AWS::MediaLive::ChannelPlacementGroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the channel placement group.
arrayList of channel IDs added to the channel placement group.
stringThe ID of the cluster the node is on.
stringUnique internal identifier.
stringThe name of the channel placement group.
arrayList of nodes added to the channel placement group
stringThe current state of the ChannelPlacementGroupState
arrayA collection of key-value pairs.
stringAWS region.
+ +For more information, see AWS::MediaLive::ChannelPlacementGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all channel_placement_groups in a region. +```sql +SELECT +region, +arn, +channels, +cluster_id, +id, +name, +nodes, +state, +tags +FROM aws.medialive.channel_placement_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual channel_placement_group. +```sql +SELECT +region, +arn, +channels, +cluster_id, +id, +name, +nodes, +state, +tags +FROM aws.medialive.channel_placement_groups +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new channel_placement_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.channel_placement_groups ( + ClusterId, + Name, + Nodes, + Tags, + region +) +SELECT +'{{ ClusterId }}', + '{{ Name }}', + '{{ Nodes }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.channel_placement_groups ( + ClusterId, + Name, + Nodes, + Tags, + region +) +SELECT + '{{ ClusterId }}', + '{{ Name }}', + '{{ Nodes }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: channel_placement_group + props: + - name: ClusterId + value: '{{ ClusterId }}' + - name: Name + value: '{{ Name }}' + - name: Nodes + value: + - '{{ Nodes[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.channel_placement_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the channel_placement_groups resource, the following permissions are required: + +### Create +```json +medialive:CreateChannelPlacementGroup, +medialive:DescribeChannelPlacementGroup, +medialive:CreateTags, +medialive:ListTagsForResource +``` + +### Read +```json +medialive:DescribeChannelPlacementGroup, +medialive:ListTagsForResource +``` + +### Update +```json +medialive:UpdateChannelPlacementGroup, +medialive:DescribeChannelPlacementGroup, +medialive:CreateTags, +medialive:DeleteTags, +medialive:ListTagsForResource +``` + +### Delete +```json +medialive:DeleteChannelPlacementGroup, +medialive:DescribeChannelPlacementGroup +``` + +### List +```json +medialive:ListChannelPlacementGroups +``` diff --git a/website/docs/services/medialive/channel_placement_groups_list_only/index.md b/website/docs/services/medialive/channel_placement_groups_list_only/index.md new file mode 100644 index 0000000..c7a7c6a --- /dev/null +++ b/website/docs/services/medialive/channel_placement_groups_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: channel_placement_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channel_placement_groups_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channel_placement_groups in a region or regions, for all properties use channel_placement_groups + +## Overview + + + + + + + +
Namechannel_placement_groups_list_only
TypeResource
DescriptionDefinition of AWS::MediaLive::ChannelPlacementGroup Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the cluster the node is on.
stringUnique internal identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channel_placement_groups in a region. +```sql +SELECT +region, +id, +cluster_id +FROM aws.medialive.channel_placement_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_placement_groups_list_only resource, see channel_placement_groups + diff --git a/website/docs/services/medialive/cloud_watch_alarm_template_group_tags/index.md b/website/docs/services/medialive/cloud_watch_alarm_template_group_tags/index.md new file mode 100644 index 0000000..2e30b6d --- /dev/null +++ b/website/docs/services/medialive/cloud_watch_alarm_template_group_tags/index.md @@ -0,0 +1,89 @@ +--- +title: cloud_watch_alarm_template_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_watch_alarm_template_group_tags + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cloud_watch_alarm_template_groups in a region + +## Overview + + + + + + + +
Namecloud_watch_alarm_template_group_tags
TypeResource
DescriptionDefinition of AWS::MediaLive::CloudWatchAlarmTemplateGroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringA cloudwatch alarm template group's ARN (Amazon Resource Name)
string
stringA resource's optional description.
stringA cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`
string
string
stringA resource's name. Names must be unique within the scope of a resource type in a specific region.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cloud_watch_alarm_template_groups in a region. +```sql +SELECT +region, +arn, +created_at, +description, +id, +identifier, +modified_at, +name, +tag_key, +tag_value +FROM aws.medialive.cloud_watch_alarm_template_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cloud_watch_alarm_template_group_tags resource, see cloud_watch_alarm_template_groups + diff --git a/website/docs/services/medialive/cloud_watch_alarm_template_groups/index.md b/website/docs/services/medialive/cloud_watch_alarm_template_groups/index.md new file mode 100644 index 0000000..a77f9f3 --- /dev/null +++ b/website/docs/services/medialive/cloud_watch_alarm_template_groups/index.md @@ -0,0 +1,228 @@ +--- +title: cloud_watch_alarm_template_groups +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_watch_alarm_template_groups + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cloud_watch_alarm_template_group resource or lists cloud_watch_alarm_template_groups in a region + +## Overview + + + + + + + +
Namecloud_watch_alarm_template_groups
TypeResource
DescriptionDefinition of AWS::MediaLive::CloudWatchAlarmTemplateGroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringA cloudwatch alarm template group's ARN (Amazon Resource Name)
string
stringA resource's optional description.
stringA cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`
string
string
stringA resource's name. Names must be unique within the scope of a resource type in a specific region.
objectRepresents the tags associated with a resource.
stringAWS region.
+ +For more information, see AWS::MediaLive::CloudWatchAlarmTemplateGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cloud_watch_alarm_template_groups in a region. +```sql +SELECT +region, +arn, +created_at, +description, +id, +identifier, +modified_at, +name, +tags +FROM aws.medialive.cloud_watch_alarm_template_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cloud_watch_alarm_template_group. +```sql +SELECT +region, +arn, +created_at, +description, +id, +identifier, +modified_at, +name, +tags +FROM aws.medialive.cloud_watch_alarm_template_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cloud_watch_alarm_template_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.cloud_watch_alarm_template_groups ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.cloud_watch_alarm_template_groups ( + Description, + Name, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cloud_watch_alarm_template_group + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.cloud_watch_alarm_template_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the cloud_watch_alarm_template_groups resource, the following permissions are required: + +### Create +```json +medialive:CreateCloudWatchAlarmTemplateGroup, +medialive:GetCloudWatchAlarmTemplateGroup, +medialive:CreateTags +``` + +### Read +```json +medialive:GetCloudWatchAlarmTemplateGroup +``` + +### Update +```json +medialive:UpdateCloudWatchAlarmTemplateGroup, +medialive:GetCloudWatchAlarmTemplateGroup, +medialive:CreateTags, +medialive:DeleteTags +``` + +### Delete +```json +medialive:DeleteCloudWatchAlarmTemplateGroup +``` + +### List +```json +medialive:ListCloudWatchAlarmTemplateGroups +``` diff --git a/website/docs/services/medialive/cloud_watch_alarm_template_groups_list_only/index.md b/website/docs/services/medialive/cloud_watch_alarm_template_groups_list_only/index.md new file mode 100644 index 0000000..132e904 --- /dev/null +++ b/website/docs/services/medialive/cloud_watch_alarm_template_groups_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: cloud_watch_alarm_template_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_watch_alarm_template_groups_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cloud_watch_alarm_template_groups in a region or regions, for all properties use cloud_watch_alarm_template_groups + +## Overview + + + + + + + +
Namecloud_watch_alarm_template_groups_list_only
TypeResource
DescriptionDefinition of AWS::MediaLive::CloudWatchAlarmTemplateGroup Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cloud_watch_alarm_template_groups in a region. +```sql +SELECT +region, +identifier +FROM aws.medialive.cloud_watch_alarm_template_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cloud_watch_alarm_template_groups_list_only resource, see cloud_watch_alarm_template_groups + diff --git a/website/docs/services/medialive/cloud_watch_alarm_template_tags/index.md b/website/docs/services/medialive/cloud_watch_alarm_template_tags/index.md new file mode 100644 index 0000000..c2ddfc7 --- /dev/null +++ b/website/docs/services/medialive/cloud_watch_alarm_template_tags/index.md @@ -0,0 +1,111 @@ +--- +title: cloud_watch_alarm_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_watch_alarm_template_tags + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cloud_watch_alarm_templates in a region + +## Overview + + + + + + + +
Namecloud_watch_alarm_template_tags
TypeResource
DescriptionDefinition of AWS::MediaLive::CloudWatchAlarmTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA cloudwatch alarm template's ARN (Amazon Resource Name)
stringThe comparison operator used to compare the specified statistic and the threshold.
string
numberThe number of datapoints within the evaluation period that must be breaching to trigger the alarm.
stringA resource's optional description.
numberThe number of periods over which data is compared to the specified threshold.
stringA cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`
stringA cloudwatch alarm template group's identifier. Can be either be its id or current name.
stringA cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`
string
stringThe name of the metric associated with the alarm. Must be compatible with targetResourceType.
string
stringA resource's name. Names must be unique within the scope of a resource type in a specific region.
numberThe period, in seconds, over which the specified statistic is applied.
stringThe statistic to apply to the alarm's metric data.
stringThe resource type this template should dynamically generate cloudwatch metric alarms for.
numberThe threshold value to compare with the specified statistic.
stringSpecifies how missing data points are treated when evaluating the alarm's condition.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cloud_watch_alarm_templates in a region. +```sql +SELECT +region, +arn, +comparison_operator, +created_at, +datapoints_to_alarm, +description, +evaluation_periods, +group_id, +group_identifier, +id, +identifier, +metric_name, +modified_at, +name, +period, +statistic, +target_resource_type, +threshold, +treat_missing_data, +tag_key, +tag_value +FROM aws.medialive.cloud_watch_alarm_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cloud_watch_alarm_template_tags resource, see cloud_watch_alarm_templates + diff --git a/website/docs/services/medialive/cloud_watch_alarm_templates/index.md b/website/docs/services/medialive/cloud_watch_alarm_templates/index.md new file mode 100644 index 0000000..f08ccc4 --- /dev/null +++ b/website/docs/services/medialive/cloud_watch_alarm_templates/index.md @@ -0,0 +1,319 @@ +--- +title: cloud_watch_alarm_templates +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_watch_alarm_templates + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cloud_watch_alarm_template resource or lists cloud_watch_alarm_templates in a region + +## Overview + + + + + + + +
Namecloud_watch_alarm_templates
TypeResource
DescriptionDefinition of AWS::MediaLive::CloudWatchAlarmTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA cloudwatch alarm template's ARN (Amazon Resource Name)
stringThe comparison operator used to compare the specified statistic and the threshold.
string
numberThe number of datapoints within the evaluation period that must be breaching to trigger the alarm.
stringA resource's optional description.
numberThe number of periods over which data is compared to the specified threshold.
stringA cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`
stringA cloudwatch alarm template group's identifier. Can be either be its id or current name.
stringA cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`
string
stringThe name of the metric associated with the alarm. Must be compatible with targetResourceType.
string
stringA resource's name. Names must be unique within the scope of a resource type in a specific region.
numberThe period, in seconds, over which the specified statistic is applied.
stringThe statistic to apply to the alarm's metric data.
objectRepresents the tags associated with a resource.
stringThe resource type this template should dynamically generate cloudwatch metric alarms for.
numberThe threshold value to compare with the specified statistic.
stringSpecifies how missing data points are treated when evaluating the alarm's condition.
stringAWS region.
+ +For more information, see AWS::MediaLive::CloudWatchAlarmTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cloud_watch_alarm_templates in a region. +```sql +SELECT +region, +arn, +comparison_operator, +created_at, +datapoints_to_alarm, +description, +evaluation_periods, +group_id, +group_identifier, +id, +identifier, +metric_name, +modified_at, +name, +period, +statistic, +tags, +target_resource_type, +threshold, +treat_missing_data +FROM aws.medialive.cloud_watch_alarm_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cloud_watch_alarm_template. +```sql +SELECT +region, +arn, +comparison_operator, +created_at, +datapoints_to_alarm, +description, +evaluation_periods, +group_id, +group_identifier, +id, +identifier, +metric_name, +modified_at, +name, +period, +statistic, +tags, +target_resource_type, +threshold, +treat_missing_data +FROM aws.medialive.cloud_watch_alarm_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cloud_watch_alarm_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.cloud_watch_alarm_templates ( + ComparisonOperator, + EvaluationPeriods, + GroupIdentifier, + MetricName, + Name, + Period, + Statistic, + TargetResourceType, + Threshold, + TreatMissingData, + region +) +SELECT +'{{ ComparisonOperator }}', + '{{ EvaluationPeriods }}', + '{{ GroupIdentifier }}', + '{{ MetricName }}', + '{{ Name }}', + '{{ Period }}', + '{{ Statistic }}', + '{{ TargetResourceType }}', + '{{ Threshold }}', + '{{ TreatMissingData }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.cloud_watch_alarm_templates ( + ComparisonOperator, + DatapointsToAlarm, + Description, + EvaluationPeriods, + GroupIdentifier, + MetricName, + Name, + Period, + Statistic, + Tags, + TargetResourceType, + Threshold, + TreatMissingData, + region +) +SELECT + '{{ ComparisonOperator }}', + '{{ DatapointsToAlarm }}', + '{{ Description }}', + '{{ EvaluationPeriods }}', + '{{ GroupIdentifier }}', + '{{ MetricName }}', + '{{ Name }}', + '{{ Period }}', + '{{ Statistic }}', + '{{ Tags }}', + '{{ TargetResourceType }}', + '{{ Threshold }}', + '{{ TreatMissingData }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cloud_watch_alarm_template + props: + - name: ComparisonOperator + value: '{{ ComparisonOperator }}' + - name: DatapointsToAlarm + value: null + - name: Description + value: '{{ Description }}' + - name: EvaluationPeriods + value: null + - name: GroupIdentifier + value: '{{ GroupIdentifier }}' + - name: MetricName + value: '{{ MetricName }}' + - name: Name + value: '{{ Name }}' + - name: Period + value: null + - name: Statistic + value: '{{ Statistic }}' + - name: Tags + value: {} + - name: TargetResourceType + value: '{{ TargetResourceType }}' + - name: Threshold + value: null + - name: TreatMissingData + value: '{{ TreatMissingData }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.cloud_watch_alarm_templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the cloud_watch_alarm_templates resource, the following permissions are required: + +### Create +```json +medialive:CreateCloudWatchAlarmTemplate, +medialive:GetCloudWatchAlarmTemplate, +medialive:CreateTags +``` + +### Read +```json +medialive:GetCloudWatchAlarmTemplate +``` + +### Update +```json +medialive:UpdateCloudWatchAlarmTemplate, +medialive:GetCloudWatchAlarmTemplate, +medialive:CreateTags, +medialive:DeleteTags +``` + +### Delete +```json +medialive:DeleteCloudWatchAlarmTemplate +``` + +### List +```json +medialive:ListCloudWatchAlarmTemplates +``` diff --git a/website/docs/services/medialive/cloud_watch_alarm_templates_list_only/index.md b/website/docs/services/medialive/cloud_watch_alarm_templates_list_only/index.md new file mode 100644 index 0000000..c2b4eef --- /dev/null +++ b/website/docs/services/medialive/cloud_watch_alarm_templates_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: cloud_watch_alarm_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_watch_alarm_templates_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cloud_watch_alarm_templates in a region or regions, for all properties use cloud_watch_alarm_templates + +## Overview + + + + + + + +
Namecloud_watch_alarm_templates_list_only
TypeResource
DescriptionDefinition of AWS::MediaLive::CloudWatchAlarmTemplate Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cloud_watch_alarm_templates in a region. +```sql +SELECT +region, +identifier +FROM aws.medialive.cloud_watch_alarm_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cloud_watch_alarm_templates_list_only resource, see cloud_watch_alarm_templates + diff --git a/website/docs/services/medialive/cluster_tags/index.md b/website/docs/services/medialive/cluster_tags/index.md new file mode 100644 index 0000000..9ca531a --- /dev/null +++ b/website/docs/services/medialive/cluster_tags/index.md @@ -0,0 +1,91 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + + + +
Namecluster_tags
TypeResource
DescriptionDefinition of AWS::MediaLive::Cluster Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Cluster.
arrayThe MediaLive Channels that are currently running on Nodes in this Cluster.
stringThe hardware type for the cluster.
stringThe unique ID of the Cluster.
stringThe IAM role your nodes will use.
stringThe user-specified name of the Cluster to be created.
objectOn premises settings which will have the interface network mappings and default Output logical interface
stringThe current state of the Cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +arn, +channel_ids, +cluster_type, +id, +instance_role_arn, +name, +network_settings, +state, +tag_key, +tag_value +FROM aws.medialive.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + diff --git a/website/docs/services/medialive/clusters/index.md b/website/docs/services/medialive/clusters/index.md new file mode 100644 index 0000000..fb8b159 --- /dev/null +++ b/website/docs/services/medialive/clusters/index.md @@ -0,0 +1,263 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - clusters + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster resource or lists clusters in a region + +## Overview + + + + + + + +
Nameclusters
TypeResource
DescriptionDefinition of AWS::MediaLive::Cluster Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Cluster.
arrayThe MediaLive Channels that are currently running on Nodes in this Cluster.
stringThe hardware type for the cluster.
stringThe unique ID of the Cluster.
stringThe IAM role your nodes will use.
stringThe user-specified name of the Cluster to be created.
objectOn premises settings which will have the interface network mappings and default Output logical interface
stringThe current state of the Cluster.
arrayA collection of key-value pairs.
stringAWS region.
+ +For more information, see AWS::MediaLive::Cluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all clusters in a region. +```sql +SELECT +region, +arn, +channel_ids, +cluster_type, +id, +instance_role_arn, +name, +network_settings, +state, +tags +FROM aws.medialive.clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster. +```sql +SELECT +region, +arn, +channel_ids, +cluster_type, +id, +instance_role_arn, +name, +network_settings, +state, +tags +FROM aws.medialive.clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.clusters ( + ClusterType, + InstanceRoleArn, + Name, + NetworkSettings, + Tags, + region +) +SELECT +'{{ ClusterType }}', + '{{ InstanceRoleArn }}', + '{{ Name }}', + '{{ NetworkSettings }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.clusters ( + ClusterType, + InstanceRoleArn, + Name, + NetworkSettings, + Tags, + region +) +SELECT + '{{ ClusterType }}', + '{{ InstanceRoleArn }}', + '{{ Name }}', + '{{ NetworkSettings }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster + props: + - name: ClusterType + value: '{{ ClusterType }}' + - name: InstanceRoleArn + value: '{{ InstanceRoleArn }}' + - name: Name + value: '{{ Name }}' + - name: NetworkSettings + value: + DefaultRoute: '{{ DefaultRoute }}' + InterfaceMappings: + - LogicalInterfaceName: '{{ LogicalInterfaceName }}' + NetworkId: '{{ NetworkId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.clusters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +```json +medialive:CreateCluster, +medialive:DescribeCluster, +medialive:CreateTags, +ecs:CreateCluster, +ecs:RegisterTaskDefinition, +ecs:TagResource, +ecs:CreateService, +iam:PassRole, +medialive:ListTagsForResource +``` + +### Read +```json +medialive:DescribeCluster, +medialive:ListTagsForResource +``` + +### Update +```json +medialive:UpdateCluster, +medialive:DescribeCluster, +medialive:CreateTags, +medialive:DeleteTags, +medialive:ListTagsForResource +``` + +### Delete +```json +medialive:DeleteCluster, +medialive:DescribeCluster, +ecs:DeleteService +``` + +### List +```json +medialive:ListClusters +``` diff --git a/website/docs/services/medialive/clusters_list_only/index.md b/website/docs/services/medialive/clusters_list_only/index.md new file mode 100644 index 0000000..00a6db3 --- /dev/null +++ b/website/docs/services/medialive/clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + + + +
Nameclusters_list_only
TypeResource
DescriptionDefinition of AWS::MediaLive::Cluster Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique ID of the Cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +id +FROM aws.medialive.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + diff --git a/website/docs/services/medialive/event_bridge_rule_template_group_tags/index.md b/website/docs/services/medialive/event_bridge_rule_template_group_tags/index.md new file mode 100644 index 0000000..e66773b --- /dev/null +++ b/website/docs/services/medialive/event_bridge_rule_template_group_tags/index.md @@ -0,0 +1,89 @@ +--- +title: event_bridge_rule_template_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_bridge_rule_template_group_tags + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_bridge_rule_template_groups in a region + +## Overview + + + + + + + +
Nameevent_bridge_rule_template_group_tags
TypeResource
DescriptionDefinition of AWS::MediaLive::EventBridgeRuleTemplateGroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringAn eventbridge rule template group's ARN (Amazon Resource Name)
string
stringA resource's optional description.
stringAn eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`
string
string
stringA resource's name. Names must be unique within the scope of a resource type in a specific region.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_bridge_rule_template_groups in a region. +```sql +SELECT +region, +arn, +created_at, +description, +id, +identifier, +modified_at, +name, +tag_key, +tag_value +FROM aws.medialive.event_bridge_rule_template_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_bridge_rule_template_group_tags resource, see event_bridge_rule_template_groups + diff --git a/website/docs/services/medialive/event_bridge_rule_template_groups/index.md b/website/docs/services/medialive/event_bridge_rule_template_groups/index.md new file mode 100644 index 0000000..74f26b5 --- /dev/null +++ b/website/docs/services/medialive/event_bridge_rule_template_groups/index.md @@ -0,0 +1,228 @@ +--- +title: event_bridge_rule_template_groups +hide_title: false +hide_table_of_contents: false +keywords: + - event_bridge_rule_template_groups + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_bridge_rule_template_group resource or lists event_bridge_rule_template_groups in a region + +## Overview + + + + + + + +
Nameevent_bridge_rule_template_groups
TypeResource
DescriptionDefinition of AWS::MediaLive::EventBridgeRuleTemplateGroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringAn eventbridge rule template group's ARN (Amazon Resource Name)
string
stringA resource's optional description.
stringAn eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`
string
string
stringA resource's name. Names must be unique within the scope of a resource type in a specific region.
objectRepresents the tags associated with a resource.
stringAWS region.
+ +For more information, see AWS::MediaLive::EventBridgeRuleTemplateGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_bridge_rule_template_groups in a region. +```sql +SELECT +region, +arn, +created_at, +description, +id, +identifier, +modified_at, +name, +tags +FROM aws.medialive.event_bridge_rule_template_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_bridge_rule_template_group. +```sql +SELECT +region, +arn, +created_at, +description, +id, +identifier, +modified_at, +name, +tags +FROM aws.medialive.event_bridge_rule_template_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_bridge_rule_template_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.event_bridge_rule_template_groups ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.event_bridge_rule_template_groups ( + Description, + Name, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_bridge_rule_template_group + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.event_bridge_rule_template_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the event_bridge_rule_template_groups resource, the following permissions are required: + +### Create +```json +medialive:CreateEventBridgeRuleTemplateGroup, +medialive:GetEventBridgeRuleTemplateGroup, +medialive:CreateTags +``` + +### Read +```json +medialive:GetEventBridgeRuleTemplateGroup +``` + +### Update +```json +medialive:UpdateEventBridgeRuleTemplateGroup, +medialive:GetEventBridgeRuleTemplateGroup, +medialive:CreateTags, +medialive:DeleteTags +``` + +### Delete +```json +medialive:DeleteEventBridgeRuleTemplateGroup +``` + +### List +```json +medialive:ListEventBridgeRuleTemplateGroups +``` diff --git a/website/docs/services/medialive/event_bridge_rule_template_groups_list_only/index.md b/website/docs/services/medialive/event_bridge_rule_template_groups_list_only/index.md new file mode 100644 index 0000000..e93a3d5 --- /dev/null +++ b/website/docs/services/medialive/event_bridge_rule_template_groups_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: event_bridge_rule_template_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_bridge_rule_template_groups_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_bridge_rule_template_groups in a region or regions, for all properties use event_bridge_rule_template_groups + +## Overview + + + + + + + +
Nameevent_bridge_rule_template_groups_list_only
TypeResource
DescriptionDefinition of AWS::MediaLive::EventBridgeRuleTemplateGroup Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringAn eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_bridge_rule_template_groups in a region. +```sql +SELECT +region, +identifier +FROM aws.medialive.event_bridge_rule_template_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_bridge_rule_template_groups_list_only resource, see event_bridge_rule_template_groups + diff --git a/website/docs/services/medialive/event_bridge_rule_template_tags/index.md b/website/docs/services/medialive/event_bridge_rule_template_tags/index.md new file mode 100644 index 0000000..3603b1d --- /dev/null +++ b/website/docs/services/medialive/event_bridge_rule_template_tags/index.md @@ -0,0 +1,97 @@ +--- +title: event_bridge_rule_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_bridge_rule_template_tags + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_bridge_rule_templates in a region + +## Overview + + + + + + + +
Nameevent_bridge_rule_template_tags
TypeResource
DescriptionDefinition of AWS::MediaLive::EventBridgeRuleTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAn eventbridge rule template's ARN (Amazon Resource Name)
stringPlaceholder documentation for __timestampIso8601
stringA resource's optional description.
arrayPlaceholder documentation for __listOfEventBridgeRuleTemplateTarget
stringThe type of event to match with the rule.
stringAn eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`
stringAn eventbridge rule template group's identifier. Can be either be its id or current name.
stringAn eventbridge rule template's id. AWS provided templates have ids that start with `aws-`
stringPlaceholder documentation for __string
stringPlaceholder documentation for __timestampIso8601
stringA resource's name. Names must be unique within the scope of a resource type in a specific region.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_bridge_rule_templates in a region. +```sql +SELECT +region, +arn, +created_at, +description, +event_targets, +event_type, +group_id, +group_identifier, +id, +identifier, +modified_at, +name, +tag_key, +tag_value +FROM aws.medialive.event_bridge_rule_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_bridge_rule_template_tags resource, see event_bridge_rule_templates + diff --git a/website/docs/services/medialive/event_bridge_rule_templates/index.md b/website/docs/services/medialive/event_bridge_rule_templates/index.md new file mode 100644 index 0000000..9e01bf4 --- /dev/null +++ b/website/docs/services/medialive/event_bridge_rule_templates/index.md @@ -0,0 +1,257 @@ +--- +title: event_bridge_rule_templates +hide_title: false +hide_table_of_contents: false +keywords: + - event_bridge_rule_templates + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_bridge_rule_template resource or lists event_bridge_rule_templates in a region + +## Overview + + + + + + + +
Nameevent_bridge_rule_templates
TypeResource
DescriptionDefinition of AWS::MediaLive::EventBridgeRuleTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAn eventbridge rule template's ARN (Amazon Resource Name)
stringPlaceholder documentation for __timestampIso8601
stringA resource's optional description.
arrayPlaceholder documentation for __listOfEventBridgeRuleTemplateTarget
stringThe type of event to match with the rule.
stringAn eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-`
stringAn eventbridge rule template group's identifier. Can be either be its id or current name.
stringAn eventbridge rule template's id. AWS provided templates have ids that start with `aws-`
stringPlaceholder documentation for __string
stringPlaceholder documentation for __timestampIso8601
stringA resource's name. Names must be unique within the scope of a resource type in a specific region.
objectRepresents the tags associated with a resource.
stringAWS region.
+ +For more information, see AWS::MediaLive::EventBridgeRuleTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_bridge_rule_templates in a region. +```sql +SELECT +region, +arn, +created_at, +description, +event_targets, +event_type, +group_id, +group_identifier, +id, +identifier, +modified_at, +name, +tags +FROM aws.medialive.event_bridge_rule_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_bridge_rule_template. +```sql +SELECT +region, +arn, +created_at, +description, +event_targets, +event_type, +group_id, +group_identifier, +id, +identifier, +modified_at, +name, +tags +FROM aws.medialive.event_bridge_rule_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_bridge_rule_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.event_bridge_rule_templates ( + EventType, + GroupIdentifier, + Name, + region +) +SELECT +'{{ EventType }}', + '{{ GroupIdentifier }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.event_bridge_rule_templates ( + Description, + EventTargets, + EventType, + GroupIdentifier, + Name, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ EventTargets }}', + '{{ EventType }}', + '{{ GroupIdentifier }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_bridge_rule_template + props: + - name: Description + value: '{{ Description }}' + - name: EventTargets + value: + - Arn: '{{ Arn }}' + - name: EventType + value: '{{ EventType }}' + - name: GroupIdentifier + value: '{{ GroupIdentifier }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.event_bridge_rule_templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the event_bridge_rule_templates resource, the following permissions are required: + +### Create +```json +medialive:CreateEventBridgeRuleTemplate, +medialive:GetEventBridgeRuleTemplate, +medialive:CreateTags +``` + +### Read +```json +medialive:GetEventBridgeRuleTemplate +``` + +### Update +```json +medialive:UpdateEventBridgeRuleTemplate, +medialive:GetEventBridgeRuleTemplate, +medialive:CreateTags, +medialive:DeleteTags +``` + +### Delete +```json +medialive:DeleteEventBridgeRuleTemplate +``` + +### List +```json +medialive:ListEventBridgeRuleTemplates +``` diff --git a/website/docs/services/medialive/event_bridge_rule_templates_list_only/index.md b/website/docs/services/medialive/event_bridge_rule_templates_list_only/index.md new file mode 100644 index 0000000..feb3a06 --- /dev/null +++ b/website/docs/services/medialive/event_bridge_rule_templates_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: event_bridge_rule_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_bridge_rule_templates_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_bridge_rule_templates in a region or regions, for all properties use event_bridge_rule_templates + +## Overview + + + + + + + +
Nameevent_bridge_rule_templates_list_only
TypeResource
DescriptionDefinition of AWS::MediaLive::EventBridgeRuleTemplate Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringAn eventbridge rule template's id. AWS provided templates have ids that start with `aws-`
stringPlaceholder documentation for __string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_bridge_rule_templates in a region. +```sql +SELECT +region, +identifier +FROM aws.medialive.event_bridge_rule_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_bridge_rule_templates_list_only resource, see event_bridge_rule_templates + diff --git a/website/docs/services/medialive/index.md b/website/docs/services/medialive/index.md new file mode 100644 index 0000000..e3492e3 --- /dev/null +++ b/website/docs/services/medialive/index.md @@ -0,0 +1,67 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The medialive service documentation. + +:::info Service Summary + +
+
+total resources: 32
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/medialive/multiplex_tags/index.md b/website/docs/services/medialive/multiplex_tags/index.md new file mode 100644 index 0000000..402e9f5 --- /dev/null +++ b/website/docs/services/medialive/multiplex_tags/index.md @@ -0,0 +1,93 @@ +--- +title: multiplex_tags +hide_title: false +hide_table_of_contents: false +keywords: + - multiplex_tags + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for multiplexes in a region + +## Overview + + + + + + + +
Namemultiplex_tags
TypeResource
DescriptionResource schema for AWS::MediaLive::Multiplex
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique arn of the multiplex.
arrayA list of availability zones for the multiplex.
arrayA list of the multiplex output destinations.
stringThe unique id of the multiplex.
objectConfiguration for a multiplex event.
stringName of multiplex.
integerThe number of currently healthy pipelines.
integerThe number of programs in the multiplex.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all multiplexes in a region. +```sql +SELECT +region, +arn, +availability_zones, +destinations, +id, +multiplex_settings, +name, +pipelines_running_count, +program_count, +state, +tag_key, +tag_value +FROM aws.medialive.multiplex_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multiplex_tags resource, see multiplexes + diff --git a/website/docs/services/medialive/multiplexes/index.md b/website/docs/services/medialive/multiplexes/index.md new file mode 100644 index 0000000..c0ff756 --- /dev/null +++ b/website/docs/services/medialive/multiplexes/index.md @@ -0,0 +1,255 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a multiplex resource or lists multiplexes in a region + +## Overview + + + + + + + +
Namemultiplexes
TypeResource
DescriptionResource schema for AWS::MediaLive::Multiplex
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique arn of the multiplex.
arrayA list of availability zones for the multiplex.
arrayA list of the multiplex output destinations.
stringThe unique id of the multiplex.
objectConfiguration for a multiplex event.
stringName of multiplex.
integerThe number of currently healthy pipelines.
integerThe number of programs in the multiplex.
string
arrayA collection of key-value pairs.
stringAWS region.
+ +For more information, see AWS::MediaLive::Multiplex. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all multiplexes in a region. +```sql +SELECT +region, +arn, +availability_zones, +destinations, +id, +multiplex_settings, +name, +pipelines_running_count, +program_count, +state, +tags +FROM aws.medialive.multiplexes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual multiplex. +```sql +SELECT +region, +arn, +availability_zones, +destinations, +id, +multiplex_settings, +name, +pipelines_running_count, +program_count, +state, +tags +FROM aws.medialive.multiplexes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new multiplex resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.multiplexes ( + AvailabilityZones, + MultiplexSettings, + Name, + region +) +SELECT +'{{ AvailabilityZones }}', + '{{ MultiplexSettings }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.multiplexes ( + AvailabilityZones, + Destinations, + MultiplexSettings, + Name, + Tags, + region +) +SELECT + '{{ AvailabilityZones }}', + '{{ Destinations }}', + '{{ MultiplexSettings }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: multiplex + props: + - name: AvailabilityZones + value: + - '{{ AvailabilityZones[0] }}' + - name: Destinations + value: + - MultiplexMediaConnectOutputDestinationSettings: null + - name: MultiplexSettings + value: + MaximumVideoBufferDelayMilliseconds: '{{ MaximumVideoBufferDelayMilliseconds }}' + TransportStreamBitrate: '{{ TransportStreamBitrate }}' + TransportStreamId: '{{ TransportStreamId }}' + TransportStreamReservedBitrate: '{{ TransportStreamReservedBitrate }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.multiplexes +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the multiplexes resource, the following permissions are required: + +### Create +```json +medialive:CreateMultiplex, +medialive:DescribeMultiplex, +medialive:CreateTags +``` + +### Read +```json +medialive:DescribeMultiplex +``` + +### Update +```json +medialive:UpdateMultiplex, +medialive:DescribeMultiplex, +medialive:CreateTags, +medialive:DeleteTags +``` + +### Delete +```json +medialive:DeleteMultiplex, +medialive:DescribeMultiplex +``` + +### List +```json +medialive:ListMultiplexes +``` diff --git a/website/docs/services/medialive/multiplexes_list_only/index.md b/website/docs/services/medialive/multiplexes_list_only/index.md new file mode 100644 index 0000000..788ce79 --- /dev/null +++ b/website/docs/services/medialive/multiplexes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: multiplexes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - multiplexes_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists multiplexes in a region or regions, for all properties use multiplexes + +## Overview + + + + + + + +
Namemultiplexes_list_only
TypeResource
DescriptionResource schema for AWS::MediaLive::Multiplex
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique id of the multiplex.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all multiplexes in a region. +```sql +SELECT +region, +id +FROM aws.medialive.multiplexes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multiplexes_list_only resource, see multiplexes + diff --git a/website/docs/services/medialive/multiplexprograms/index.md b/website/docs/services/medialive/multiplexprograms/index.md new file mode 100644 index 0000000..2a11875 --- /dev/null +++ b/website/docs/services/medialive/multiplexprograms/index.md @@ -0,0 +1,270 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a multiplexprogram resource or lists multiplexprograms in a region + +## Overview + + + + + + + +
Namemultiplexprograms
TypeResource
DescriptionResource schema for AWS::MediaLive::Multiplexprogram
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe MediaLive channel associated with the program.
stringThe ID of the multiplex that the program belongs to.
objectThe settings for this multiplex program.
stringThe settings for this multiplex program.
objectThe packet identifier map for this multiplex program.
arrayContains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.
stringThe name of the multiplex program.
stringAWS region.
+ +For more information, see AWS::MediaLive::Multiplexprogram. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all multiplexprograms in a region. +```sql +SELECT +region, +channel_id, +multiplex_id, +multiplex_program_settings, +preferred_channel_pipeline, +packet_identifiers_map, +pipeline_details, +program_name +FROM aws.medialive.multiplexprograms +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual multiplexprogram. +```sql +SELECT +region, +channel_id, +multiplex_id, +multiplex_program_settings, +preferred_channel_pipeline, +packet_identifiers_map, +pipeline_details, +program_name +FROM aws.medialive.multiplexprograms +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new multiplexprogram resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.multiplexprograms ( + MultiplexId, + MultiplexProgramSettings, + PreferredChannelPipeline, + PacketIdentifiersMap, + PipelineDetails, + ProgramName, + region +) +SELECT +'{{ MultiplexId }}', + '{{ MultiplexProgramSettings }}', + '{{ PreferredChannelPipeline }}', + '{{ PacketIdentifiersMap }}', + '{{ PipelineDetails }}', + '{{ ProgramName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.multiplexprograms ( + MultiplexId, + MultiplexProgramSettings, + PreferredChannelPipeline, + PacketIdentifiersMap, + PipelineDetails, + ProgramName, + region +) +SELECT + '{{ MultiplexId }}', + '{{ MultiplexProgramSettings }}', + '{{ PreferredChannelPipeline }}', + '{{ PacketIdentifiersMap }}', + '{{ PipelineDetails }}', + '{{ ProgramName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: multiplexprogram + props: + - name: MultiplexId + value: '{{ MultiplexId }}' + - name: MultiplexProgramSettings + value: + PreferredChannelPipeline: '{{ PreferredChannelPipeline }}' + ProgramNumber: '{{ ProgramNumber }}' + ServiceDescriptor: + ProviderName: '{{ ProviderName }}' + ServiceName: '{{ ServiceName }}' + VideoSettings: {} + - name: PreferredChannelPipeline + value: null + - name: PacketIdentifiersMap + value: + AudioPids: + - '{{ AudioPids[0] }}' + DvbSubPids: + - '{{ DvbSubPids[0] }}' + DvbTeletextPid: '{{ DvbTeletextPid }}' + EtvPlatformPid: '{{ EtvPlatformPid }}' + EtvSignalPid: '{{ EtvSignalPid }}' + KlvDataPids: + - '{{ KlvDataPids[0] }}' + PcrPid: '{{ PcrPid }}' + PmtPid: '{{ PmtPid }}' + PrivateMetadataPid: '{{ PrivateMetadataPid }}' + Scte27Pids: + - '{{ Scte27Pids[0] }}' + Scte35Pid: '{{ Scte35Pid }}' + TimedMetadataPid: '{{ TimedMetadataPid }}' + VideoPid: '{{ VideoPid }}' + - name: PipelineDetails + value: + - ActiveChannelPipeline: '{{ ActiveChannelPipeline }}' + PipelineId: '{{ PipelineId }}' + - name: ProgramName + value: '{{ ProgramName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.multiplexprograms +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the multiplexprograms resource, the following permissions are required: + +### Create +```json +medialive:CreateMultiplexProgram, +medialive:DescribeMultiplexProgram +``` + +### Read +```json +medialive:DescribeMultiplexProgram +``` + +### Update +```json +medialive:UpdateMultiplexProgram, +medialive:DescribeMultiplexProgram +``` + +### Delete +```json +medialive:DeleteMultiplexProgram, +medialive:DescribeMultiplexProgram +``` + +### List +```json +medialive:ListMultiplexPrograms +``` diff --git a/website/docs/services/medialive/multiplexprograms_list_only/index.md b/website/docs/services/medialive/multiplexprograms_list_only/index.md new file mode 100644 index 0000000..17e4267 --- /dev/null +++ b/website/docs/services/medialive/multiplexprograms_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: multiplexprograms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - multiplexprograms_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists multiplexprograms in a region or regions, for all properties use multiplexprograms + +## Overview + + + + + + + +
Namemultiplexprograms_list_only
TypeResource
DescriptionResource schema for AWS::MediaLive::Multiplexprogram
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the multiplex that the program belongs to.
stringThe name of the multiplex program.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all multiplexprograms in a region. +```sql +SELECT +region, +program_name, +multiplex_id +FROM aws.medialive.multiplexprograms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multiplexprograms_list_only resource, see multiplexprograms + diff --git a/website/docs/services/medialive/network_tags/index.md b/website/docs/services/medialive/network_tags/index.md new file mode 100644 index 0000000..03677d4 --- /dev/null +++ b/website/docs/services/medialive/network_tags/index.md @@ -0,0 +1,89 @@ +--- +title: network_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_tags + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for networks in a region + +## Overview + + + + + + + +
Namenetwork_tags
TypeResource
DescriptionResource schema for AWS::MediaLive::Network.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Network.
array
stringThe unique ID of the Network.
arrayThe list of IP address cidr pools for the network
stringThe user-specified name of the Network to be created.
arrayThe routes for the network
stringThe current state of the Network.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all networks in a region. +```sql +SELECT +region, +arn, +associated_cluster_ids, +id, +ip_pools, +name, +routes, +state, +tag_key, +tag_value +FROM aws.medialive.network_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_tags resource, see networks + diff --git a/website/docs/services/medialive/networks/index.md b/website/docs/services/medialive/networks/index.md new file mode 100644 index 0000000..15dc5ac --- /dev/null +++ b/website/docs/services/medialive/networks/index.md @@ -0,0 +1,243 @@ +--- +title: networks +hide_title: false +hide_table_of_contents: false +keywords: + - networks + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network resource or lists networks in a region + +## Overview + + + + + + + +
Namenetworks
TypeResource
DescriptionResource schema for AWS::MediaLive::Network.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Network.
array
stringThe unique ID of the Network.
arrayThe list of IP address cidr pools for the network
stringThe user-specified name of the Network to be created.
arrayThe routes for the network
stringThe current state of the Network.
arrayA collection of key-value pairs.
stringAWS region.
+ +For more information, see AWS::MediaLive::Network. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all networks in a region. +```sql +SELECT +region, +arn, +associated_cluster_ids, +id, +ip_pools, +name, +routes, +state, +tags +FROM aws.medialive.networks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network. +```sql +SELECT +region, +arn, +associated_cluster_ids, +id, +ip_pools, +name, +routes, +state, +tags +FROM aws.medialive.networks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.networks ( + IpPools, + Name, + region +) +SELECT +'{{ IpPools }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.networks ( + IpPools, + Name, + Routes, + Tags, + region +) +SELECT + '{{ IpPools }}', + '{{ Name }}', + '{{ Routes }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network + props: + - name: IpPools + value: + - Cidr: '{{ Cidr }}' + - name: Name + value: '{{ Name }}' + - name: Routes + value: + - Cidr: '{{ Cidr }}' + Gateway: '{{ Gateway }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.networks +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the networks resource, the following permissions are required: + +### Create +```json +medialive:CreateNetwork, +medialive:CreateTags, +medialive:DescribeNetwork, +medialive:ListTagsForResource +``` + +### Read +```json +medialive:DescribeNetwork, +medialive:ListTagsForResource +``` + +### Update +```json +medialive:UpdateNetwork, +medialive:CreateTags, +medialive:DeleteTags, +medialive:DescribeNetwork, +medialive:ListTagsForResource +``` + +### Delete +```json +medialive:DeleteNetwork, +medialive:DescribeNetwork +``` + +### List +```json +medialive:ListNetworks +``` diff --git a/website/docs/services/medialive/networks_list_only/index.md b/website/docs/services/medialive/networks_list_only/index.md new file mode 100644 index 0000000..0fd7ee5 --- /dev/null +++ b/website/docs/services/medialive/networks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: networks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - networks_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists networks in a region or regions, for all properties use networks + +## Overview + + + + + + + +
Namenetworks_list_only
TypeResource
DescriptionResource schema for AWS::MediaLive::Network.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique ID of the Network.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all networks in a region. +```sql +SELECT +region, +id +FROM aws.medialive.networks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the networks_list_only resource, see networks + diff --git a/website/docs/services/medialive/sdi_source_tags/index.md b/website/docs/services/medialive/sdi_source_tags/index.md new file mode 100644 index 0000000..7456660 --- /dev/null +++ b/website/docs/services/medialive/sdi_source_tags/index.md @@ -0,0 +1,89 @@ +--- +title: sdi_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - sdi_source_tags + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sdi_sources in a region + +## Overview + + + + + + + +
Namesdi_source_tags
TypeResource
DescriptionDefinition of AWS::MediaLive::SdiSource Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique arn of the SdiSource.
stringThe unique identifier of the SdiSource.
stringThe current state of the SdiSource.
stringThe name of the SdiSource.
stringThe current state of the SdiSource.
stringThe interface mode of the SdiSource.
arrayThe list of inputs currently using this SDI source.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sdi_sources in a region. +```sql +SELECT +region, +arn, +id, +mode, +name, +state, +type, +inputs, +tag_key, +tag_value +FROM aws.medialive.sdi_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sdi_source_tags resource, see sdi_sources + diff --git a/website/docs/services/medialive/sdi_sources/index.md b/website/docs/services/medialive/sdi_sources/index.md new file mode 100644 index 0000000..5e0f3ec --- /dev/null +++ b/website/docs/services/medialive/sdi_sources/index.md @@ -0,0 +1,240 @@ +--- +title: sdi_sources +hide_title: false +hide_table_of_contents: false +keywords: + - sdi_sources + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a sdi_source resource or lists sdi_sources in a region + +## Overview + + + + + + + +
Namesdi_sources
TypeResource
DescriptionDefinition of AWS::MediaLive::SdiSource Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique arn of the SdiSource.
stringThe unique identifier of the SdiSource.
stringThe current state of the SdiSource.
stringThe name of the SdiSource.
stringThe current state of the SdiSource.
stringThe interface mode of the SdiSource.
arrayThe list of inputs currently using this SDI source.
arrayA collection of key-value pairs.
stringAWS region.
+ +For more information, see AWS::MediaLive::SdiSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all sdi_sources in a region. +```sql +SELECT +region, +arn, +id, +mode, +name, +state, +type, +inputs, +tags +FROM aws.medialive.sdi_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual sdi_source. +```sql +SELECT +region, +arn, +id, +mode, +name, +state, +type, +inputs, +tags +FROM aws.medialive.sdi_sources +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new sdi_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.sdi_sources ( + Name, + Type, + region +) +SELECT +'{{ Name }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.sdi_sources ( + Mode, + Name, + Type, + Tags, + region +) +SELECT + '{{ Mode }}', + '{{ Name }}', + '{{ Type }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: sdi_source + props: + - name: Mode + value: '{{ Mode }}' + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.sdi_sources +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the sdi_sources resource, the following permissions are required: + +### Create +```json +medialive:CreateSdiSource, +medialive:CreateTags, +medialive:DescribeSdiSource, +medialive:ListTagsForResource +``` + +### Read +```json +medialive:DescribeSdiSource, +medialive:ListTagsForResource +``` + +### Update +```json +medialive:UpdateSdiSource, +medialive:DescribeSdiSource, +medialive:CreateTags, +medialive:DeleteTags, +medialive:ListTagsForResource +``` + +### Delete +```json +medialive:DeleteSdiSource, +medialive:DescribeSdiSource +``` + +### List +```json +medialive:ListSdiSources +``` diff --git a/website/docs/services/medialive/sdi_sources_list_only/index.md b/website/docs/services/medialive/sdi_sources_list_only/index.md new file mode 100644 index 0000000..f0c6358 --- /dev/null +++ b/website/docs/services/medialive/sdi_sources_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: sdi_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sdi_sources_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sdi_sources in a region or regions, for all properties use sdi_sources + +## Overview + + + + + + + +
Namesdi_sources_list_only
TypeResource
DescriptionDefinition of AWS::MediaLive::SdiSource Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier of the SdiSource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sdi_sources in a region. +```sql +SELECT +region, +id +FROM aws.medialive.sdi_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sdi_sources_list_only resource, see sdi_sources + diff --git a/website/docs/services/medialive/signal_map_tags/index.md b/website/docs/services/medialive/signal_map_tags/index.md new file mode 100644 index 0000000..b705660 --- /dev/null +++ b/website/docs/services/medialive/signal_map_tags/index.md @@ -0,0 +1,117 @@ +--- +title: signal_map_tags +hide_title: false +hide_table_of_contents: false +keywords: + - signal_map_tags + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for signal_maps in a region + +## Overview + + + + + + + +
Namesignal_map_tags
TypeResource
DescriptionDefinition of AWS::MediaLive::SignalMap Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA signal map's ARN (Amazon Resource Name)
array
array
string
stringA resource's optional description.
stringA top-level supported AWS resource ARN to discovery a signal map from.
stringError message associated with a failed creation or failed update attempt of a signal map.
array
array
objectA map representing an incomplete AWS media workflow as a graph.
booleanIf true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.
stringA signal map's id.
string
string
objectRepresents the latest successful monitor deployment of a signal map.
objectA map representing an AWS media workflow as a graph.
string
booleanIf true, there are pending monitor changes for this signal map that can be deployed.
objectRepresents the latest monitor deployment of a signal map.
stringA resource's name. Names must be unique within the scope of a resource type in a specific region.
stringA signal map's current status which is dependent on its lifecycle actions or associated jobs.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all signal_maps in a region. +```sql +SELECT +region, +arn, +cloud_watch_alarm_template_group_identifiers, +cloud_watch_alarm_template_group_ids, +created_at, +description, +discovery_entry_point_arn, +error_message, +event_bridge_rule_template_group_identifiers, +event_bridge_rule_template_group_ids, +failed_media_resource_map, +force_rediscovery, +id, +identifier, +last_discovered_at, +last_successful_monitor_deployment, +media_resource_map, +modified_at, +monitor_changes_pending_deployment, +monitor_deployment, +name, +status, +tag_key, +tag_value +FROM aws.medialive.signal_map_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the signal_map_tags resource, see signal_maps + diff --git a/website/docs/services/medialive/signal_maps/index.md b/website/docs/services/medialive/signal_maps/index.md new file mode 100644 index 0000000..e66be6b --- /dev/null +++ b/website/docs/services/medialive/signal_maps/index.md @@ -0,0 +1,360 @@ +--- +title: signal_maps +hide_title: false +hide_table_of_contents: false +keywords: + - signal_maps + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a signal_map resource or lists signal_maps in a region + +## Overview + + + + + + + +
Namesignal_maps
TypeResource
DescriptionDefinition of AWS::MediaLive::SignalMap Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA signal map's ARN (Amazon Resource Name)
array
array
string
stringA resource's optional description.
stringA top-level supported AWS resource ARN to discovery a signal map from.
stringError message associated with a failed creation or failed update attempt of a signal map.
array
array
objectA map representing an incomplete AWS media workflow as a graph.
booleanIf true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.
stringA signal map's id.
string
string
objectRepresents the latest successful monitor deployment of a signal map.
objectA map representing an AWS media workflow as a graph.
string
booleanIf true, there are pending monitor changes for this signal map that can be deployed.
objectRepresents the latest monitor deployment of a signal map.
stringA resource's name. Names must be unique within the scope of a resource type in a specific region.
stringA signal map's current status which is dependent on its lifecycle actions or associated jobs.
objectRepresents the tags associated with a resource.
stringAWS region.
+ +For more information, see AWS::MediaLive::SignalMap. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all signal_maps in a region. +```sql +SELECT +region, +arn, +cloud_watch_alarm_template_group_identifiers, +cloud_watch_alarm_template_group_ids, +created_at, +description, +discovery_entry_point_arn, +error_message, +event_bridge_rule_template_group_identifiers, +event_bridge_rule_template_group_ids, +failed_media_resource_map, +force_rediscovery, +id, +identifier, +last_discovered_at, +last_successful_monitor_deployment, +media_resource_map, +modified_at, +monitor_changes_pending_deployment, +monitor_deployment, +name, +status, +tags +FROM aws.medialive.signal_maps +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual signal_map. +```sql +SELECT +region, +arn, +cloud_watch_alarm_template_group_identifiers, +cloud_watch_alarm_template_group_ids, +created_at, +description, +discovery_entry_point_arn, +error_message, +event_bridge_rule_template_group_identifiers, +event_bridge_rule_template_group_ids, +failed_media_resource_map, +force_rediscovery, +id, +identifier, +last_discovered_at, +last_successful_monitor_deployment, +media_resource_map, +modified_at, +monitor_changes_pending_deployment, +monitor_deployment, +name, +status, +tags +FROM aws.medialive.signal_maps +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new signal_map resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.signal_maps ( + DiscoveryEntryPointArn, + Name, + region +) +SELECT +'{{ DiscoveryEntryPointArn }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.medialive.signal_maps ( + CloudWatchAlarmTemplateGroupIdentifiers, + Description, + DiscoveryEntryPointArn, + EventBridgeRuleTemplateGroupIdentifiers, + ForceRediscovery, + Name, + Tags, + region +) +SELECT + '{{ CloudWatchAlarmTemplateGroupIdentifiers }}', + '{{ Description }}', + '{{ DiscoveryEntryPointArn }}', + '{{ EventBridgeRuleTemplateGroupIdentifiers }}', + '{{ ForceRediscovery }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: signal_map + props: + - name: CloudWatchAlarmTemplateGroupIdentifiers + value: + - '{{ CloudWatchAlarmTemplateGroupIdentifiers[0] }}' + - name: Description + value: '{{ Description }}' + - name: DiscoveryEntryPointArn + value: '{{ DiscoveryEntryPointArn }}' + - name: EventBridgeRuleTemplateGroupIdentifiers + value: + - '{{ EventBridgeRuleTemplateGroupIdentifiers[0] }}' + - name: ForceRediscovery + value: '{{ ForceRediscovery }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.medialive.signal_maps +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the signal_maps resource, the following permissions are required: + +### Create +```json +medialive:CreateSignalMap, +medialive:GetSignalMap, +medialive:CreateTags, +medialive:DescribeChannel, +medialive:DescribeInput, +medialive:DescribeInputDevice, +medialive:DescribeInputSecurityGroup, +medialive:DescribeMultiplex, +medialive:DescribeMultiplexProgram, +medialive:ListChannels, +medialive:ListInputDevices, +medialive:ListInputSecurityGroups, +medialive:ListInputs, +medialive:ListMultiplexPrograms, +medialive:ListMultiplexes, +medialive:ListOfferings, +medialive:ListReservations, +medialive:ListTagsForResource, +cloudfront:ListDistributions, +cloudfront:GetDistribution, +ec2:DescribeNetworkInterfaces, +mediaconnect:ListEntitlements, +mediaconnect:ListFlows, +mediaconnect:ListOfferings, +mediaconnect:ListReservations, +mediaconnect:DescribeFlow, +mediapackage:ListChannels, +mediapackage:ListOriginEndpoints, +mediapackage:DescribeChannel, +mediapackage:DescribeOriginEndpoint, +mediapackagev2:ListChannelGroups, +mediapackagev2:ListChannels, +mediapackagev2:ListOriginEndpoints, +mediapackagev2:GetChannelGroup, +mediapackagev2:GetChannel, +mediapackagev2:GetOriginEndpoint, +tag:GetResources +``` + +### Read +```json +medialive:GetSignalMap, +tag:GetResources +``` + +### Update +```json +medialive:StartUpdateSignalMap, +medialive:GetSignalMap, +medialive:CreateTags, +medialive:DeleteTags, +medialive:DescribeChannel, +medialive:DescribeInput, +medialive:DescribeInputDevice, +medialive:DescribeInputSecurityGroup, +medialive:DescribeMultiplex, +medialive:DescribeMultiplexProgram, +medialive:ListChannels, +medialive:ListInputDevices, +medialive:ListInputSecurityGroups, +medialive:ListInputs, +medialive:ListMultiplexPrograms, +medialive:ListMultiplexes, +medialive:ListOfferings, +medialive:ListReservations, +medialive:ListTagsForResource, +cloudfront:ListDistributions, +cloudfront:GetDistribution, +ec2:DescribeNetworkInterfaces, +mediaconnect:ListEntitlements, +mediaconnect:ListFlows, +mediaconnect:ListOfferings, +mediaconnect:ListReservations, +mediaconnect:DescribeFlow, +mediapackage:ListChannels, +mediapackage:ListOriginEndpoints, +mediapackage:DescribeChannel, +mediapackage:DescribeOriginEndpoint, +mediapackagev2:ListChannelGroups, +mediapackagev2:ListChannels, +mediapackagev2:ListOriginEndpoints, +mediapackagev2:GetChannelGroup, +mediapackagev2:GetChannel, +mediapackagev2:GetOriginEndpoint, +tag:GetResources +``` + +### Delete +```json +medialive:GetSignalMap, +medialive:DeleteSignalMap +``` + +### List +```json +medialive:ListSignalMaps +``` diff --git a/website/docs/services/medialive/signal_maps_list_only/index.md b/website/docs/services/medialive/signal_maps_list_only/index.md new file mode 100644 index 0000000..ce809d2 --- /dev/null +++ b/website/docs/services/medialive/signal_maps_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: signal_maps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - signal_maps_list_only + - medialive + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists signal_maps in a region or regions, for all properties use signal_maps + +## Overview + + + + + + + +
Namesignal_maps_list_only
TypeResource
DescriptionDefinition of AWS::MediaLive::SignalMap Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA signal map's id.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all signal_maps in a region. +```sql +SELECT +region, +identifier +FROM aws.medialive.signal_maps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the signal_maps_list_only resource, see signal_maps + diff --git a/website/docs/services/mediapackage/asset_tags/index.md b/website/docs/services/mediapackage/asset_tags/index.md new file mode 100644 index 0000000..fa1358d --- /dev/null +++ b/website/docs/services/mediapackage/asset_tags/index.md @@ -0,0 +1,91 @@ +--- +title: asset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - asset_tags + - mediapackage + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for assets in a region + +## Overview + + + + + + + +
Nameasset_tags
TypeResource
DescriptionResource schema for AWS::MediaPackage::Asset
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Asset.
stringThe time the Asset was initially submitted for Ingest.
arrayThe list of egress endpoints available for the Asset.
stringThe unique identifier for the Asset.
stringThe ID of the PackagingGroup for the Asset.
stringThe resource ID to include in SPEKE key requests.
stringARN of the source object in S3.
stringThe IAM role_arn used to access the source S3 bucket.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all assets in a region. +```sql +SELECT +region, +arn, +created_at, +egress_endpoints, +id, +packaging_group_id, +resource_id, +source_arn, +source_role_arn, +tag_key, +tag_value +FROM aws.mediapackage.asset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the asset_tags resource, see assets + diff --git a/website/docs/services/mediapackage/assets/index.md b/website/docs/services/mediapackage/assets/index.md new file mode 100644 index 0000000..5ebabfd --- /dev/null +++ b/website/docs/services/mediapackage/assets/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an asset resource or lists assets in a region + +## Overview + + + + + + + +
Nameassets
TypeResource
DescriptionResource schema for AWS::MediaPackage::Asset
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Asset.
stringThe time the Asset was initially submitted for Ingest.
arrayThe list of egress endpoints available for the Asset.
stringThe unique identifier for the Asset.
stringThe ID of the PackagingGroup for the Asset.
stringThe resource ID to include in SPEKE key requests.
stringARN of the source object in S3.
stringThe IAM role_arn used to access the source S3 bucket.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::MediaPackage::Asset. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all assets in a region. +```sql +SELECT +region, +arn, +created_at, +egress_endpoints, +id, +packaging_group_id, +resource_id, +source_arn, +source_role_arn, +tags +FROM aws.mediapackage.assets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual asset. +```sql +SELECT +region, +arn, +created_at, +egress_endpoints, +id, +packaging_group_id, +resource_id, +source_arn, +source_role_arn, +tags +FROM aws.mediapackage.assets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new asset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackage.assets ( + Id, + PackagingGroupId, + SourceArn, + SourceRoleArn, + region +) +SELECT +'{{ Id }}', + '{{ PackagingGroupId }}', + '{{ SourceArn }}', + '{{ SourceRoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackage.assets ( + EgressEndpoints, + Id, + PackagingGroupId, + ResourceId, + SourceArn, + SourceRoleArn, + Tags, + region +) +SELECT + '{{ EgressEndpoints }}', + '{{ Id }}', + '{{ PackagingGroupId }}', + '{{ ResourceId }}', + '{{ SourceArn }}', + '{{ SourceRoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: asset + props: + - name: EgressEndpoints + value: + - PackagingConfigurationId: '{{ PackagingConfigurationId }}' + Url: '{{ Url }}' + - name: Id + value: '{{ Id }}' + - name: PackagingGroupId + value: '{{ PackagingGroupId }}' + - name: ResourceId + value: '{{ ResourceId }}' + - name: SourceArn + value: '{{ SourceArn }}' + - name: SourceRoleArn + value: '{{ SourceRoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediapackage.assets +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediapackage-vod:DescribeAsset +``` + +### Delete +```json +mediapackage-vod:DescribeAsset, +mediapackage-vod:DeleteAsset +``` + +### List +```json +mediapackage-vod:ListAssets, +mediapackage-vod:DescribePackagingGroup +``` diff --git a/website/docs/services/mediapackage/assets_list_only/index.md b/website/docs/services/mediapackage/assets_list_only/index.md new file mode 100644 index 0000000..b2a5770 --- /dev/null +++ b/website/docs/services/mediapackage/assets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: assets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assets_list_only + - mediapackage + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assets in a region or regions, for all properties use assets + +## Overview + + + + + + + +
Nameassets_list_only
TypeResource
DescriptionResource schema for AWS::MediaPackage::Asset
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier for the Asset.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assets in a region. +```sql +SELECT +region, +id +FROM aws.mediapackage.assets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assets_list_only resource, see assets + diff --git a/website/docs/services/mediapackage/channel_tags/index.md b/website/docs/services/mediapackage/channel_tags/index.md new file mode 100644 index 0000000..00e41ca --- /dev/null +++ b/website/docs/services/mediapackage/channel_tags/index.md @@ -0,0 +1,87 @@ +--- +title: channel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_tags + - mediapackage + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channels in a region + +## Overview + + + + + + + +
Namechannel_tags
TypeResource
DescriptionResource schema for AWS::MediaPackage::Channel
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) assigned to the Channel.
stringThe ID of the Channel.
stringA short text description of the Channel.
objectAn HTTP Live Streaming (HLS) ingest resource configuration.
objectThe configuration parameters for egress access logging.
objectThe configuration parameters for egress access logging.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channels in a region. +```sql +SELECT +region, +arn, +id, +description, +hls_ingest, +egress_access_logs, +ingress_access_logs, +tag_key, +tag_value +FROM aws.mediapackage.channel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_tags resource, see channels + diff --git a/website/docs/services/mediapackage/channels/index.md b/website/docs/services/mediapackage/channels/index.md new file mode 100644 index 0000000..f15bc85 --- /dev/null +++ b/website/docs/services/mediapackage/channels/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a channel resource or lists channels in a region + +## Overview + + + + + + + +
Namechannels
TypeResource
DescriptionResource schema for AWS::MediaPackage::Channel
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) assigned to the Channel.
stringThe ID of the Channel.
stringA short text description of the Channel.
objectAn HTTP Live Streaming (HLS) ingest resource configuration.
arrayA collection of tags associated with a resource
objectThe configuration parameters for egress access logging.
objectThe configuration parameters for egress access logging.
stringAWS region.
+ +For more information, see AWS::MediaPackage::Channel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all channels in a region. +```sql +SELECT +region, +arn, +id, +description, +hls_ingest, +tags, +egress_access_logs, +ingress_access_logs +FROM aws.mediapackage.channels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual channel. +```sql +SELECT +region, +arn, +id, +description, +hls_ingest, +tags, +egress_access_logs, +ingress_access_logs +FROM aws.mediapackage.channels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackage.channels ( + Id, + region +) +SELECT +'{{ Id }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackage.channels ( + Id, + Description, + HlsIngest, + Tags, + EgressAccessLogs, + IngressAccessLogs, + region +) +SELECT + '{{ Id }}', + '{{ Description }}', + '{{ HlsIngest }}', + '{{ Tags }}', + '{{ EgressAccessLogs }}', + '{{ IngressAccessLogs }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: channel + props: + - name: Id + value: '{{ Id }}' + - name: Description + value: '{{ Description }}' + - name: HlsIngest + value: + ingestEndpoints: + - Id: '{{ Id }}' + Username: '{{ Username }}' + Password: '{{ Password }}' + Url: '{{ Url }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: EgressAccessLogs + value: + LogGroupName: '{{ LogGroupName }}' + - name: IngressAccessLogs + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediapackage.channels +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediapackage:DescribeChannel +``` + +### Update +```json +mediapackage:UpdateChannel, +mediapackage:ConfigureLogs, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +mediapackage:DeleteChannel +``` + +### List +```json +mediapackage:ListChannels +``` diff --git a/website/docs/services/mediapackage/channels_list_only/index.md b/website/docs/services/mediapackage/channels_list_only/index.md new file mode 100644 index 0000000..7586393 --- /dev/null +++ b/website/docs/services/mediapackage/channels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channels_list_only + - mediapackage + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channels in a region or regions, for all properties use channels + +## Overview + + + + + + + +
Namechannels_list_only
TypeResource
DescriptionResource schema for AWS::MediaPackage::Channel
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the Channel.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channels in a region. +```sql +SELECT +region, +id +FROM aws.mediapackage.channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channels_list_only resource, see channels + diff --git a/website/docs/services/mediapackage/index.md b/website/docs/services/mediapackage/index.md new file mode 100644 index 0000000..3c10a62 --- /dev/null +++ b/website/docs/services/mediapackage/index.md @@ -0,0 +1,50 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The mediapackage service documentation. + +:::info Service Summary + +
+
+total resources: 15
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/mediapackage/origin_endpoint_tags/index.md b/website/docs/services/mediapackage/origin_endpoint_tags/index.md new file mode 100644 index 0000000..ca724bc --- /dev/null +++ b/website/docs/services/mediapackage/origin_endpoint_tags/index.md @@ -0,0 +1,105 @@ +--- +title: origin_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoint_tags + - mediapackage + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for origin_endpoints in a region + +## Overview + + + + + + + +
Nameorigin_endpoint_tags
TypeResource
DescriptionResource schema for AWS::MediaPackage::OriginEndpoint
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) assigned to the OriginEndpoint.
stringThe URL of the packaged OriginEndpoint for consumption.
stringThe ID of the OriginEndpoint.
stringThe ID of the Channel the OriginEndpoint is associated with.
stringA short text description of the OriginEndpoint.
arrayA list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
integerMaximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
integerAmount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
stringA short string appended to the end of the OriginEndpoint URL.
stringControl whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
object
objectAn HTTP Live Streaming (HLS) packaging configuration.
objectA Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
objectA Microsoft Smooth Streaming (MSS) PackagingConfiguration.
objectA CMAF packaging configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all origin_endpoints in a region. +```sql +SELECT +region, +arn, +url, +id, +channel_id, +description, +whitelist, +startover_window_seconds, +time_delay_seconds, +manifest_name, +origination, +authorization, +hls_package, +dash_package, +mss_package, +cmaf_package, +tag_key, +tag_value +FROM aws.mediapackage.origin_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the origin_endpoint_tags resource, see origin_endpoints + diff --git a/website/docs/services/mediapackage/origin_endpoints/index.md b/website/docs/services/mediapackage/origin_endpoints/index.md new file mode 100644 index 0000000..92b5561 --- /dev/null +++ b/website/docs/services/mediapackage/origin_endpoints/index.md @@ -0,0 +1,359 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an origin_endpoint resource or lists origin_endpoints in a region + +## Overview + + + + + + + +
Nameorigin_endpoints
TypeResource
DescriptionResource schema for AWS::MediaPackage::OriginEndpoint
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) assigned to the OriginEndpoint.
stringThe URL of the packaged OriginEndpoint for consumption.
stringThe ID of the OriginEndpoint.
stringThe ID of the Channel the OriginEndpoint is associated with.
stringA short text description of the OriginEndpoint.
arrayA list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
integerMaximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
integerAmount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
stringA short string appended to the end of the OriginEndpoint URL.
stringControl whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
object
objectAn HTTP Live Streaming (HLS) packaging configuration.
objectA Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
objectA Microsoft Smooth Streaming (MSS) PackagingConfiguration.
objectA CMAF packaging configuration.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::MediaPackage::OriginEndpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all origin_endpoints in a region. +```sql +SELECT +region, +arn, +url, +id, +channel_id, +description, +whitelist, +startover_window_seconds, +time_delay_seconds, +manifest_name, +origination, +authorization, +hls_package, +dash_package, +mss_package, +cmaf_package, +tags +FROM aws.mediapackage.origin_endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual origin_endpoint. +```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_endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new origin_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackage.origin_endpoints ( + Id, + ChannelId, + region +) +SELECT +'{{ Id }}', + '{{ ChannelId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackage.origin_endpoints ( + Id, + ChannelId, + Description, + Whitelist, + StartoverWindowSeconds, + TimeDelaySeconds, + ManifestName, + Origination, + Authorization, + HlsPackage, + DashPackage, + MssPackage, + CmafPackage, + Tags, + region +) +SELECT + '{{ Id }}', + '{{ ChannelId }}', + '{{ Description }}', + '{{ Whitelist }}', + '{{ StartoverWindowSeconds }}', + '{{ TimeDelaySeconds }}', + '{{ ManifestName }}', + '{{ Origination }}', + '{{ Authorization }}', + '{{ HlsPackage }}', + '{{ DashPackage }}', + '{{ MssPackage }}', + '{{ CmafPackage }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: origin_endpoint + props: + - name: Id + value: '{{ Id }}' + - name: ChannelId + value: '{{ ChannelId }}' + - name: Description + value: '{{ Description }}' + - name: Whitelist + value: + - '{{ Whitelist[0] }}' + - name: StartoverWindowSeconds + value: '{{ StartoverWindowSeconds }}' + - name: TimeDelaySeconds + value: '{{ TimeDelaySeconds }}' + - name: ManifestName + value: '{{ ManifestName }}' + - name: Origination + value: '{{ Origination }}' + - name: Authorization + value: + CdnIdentifierSecret: '{{ CdnIdentifierSecret }}' + SecretsRoleArn: '{{ SecretsRoleArn }}' + - name: HlsPackage + value: + Encryption: + ConstantInitializationVector: '{{ ConstantInitializationVector }}' + EncryptionMethod: '{{ EncryptionMethod }}' + SpekeKeyProvider: + EncryptionContractConfiguration: + PresetSpeke20Audio: '{{ PresetSpeke20Audio }}' + PresetSpeke20Video: '{{ PresetSpeke20Video }}' + RoleArn: '{{ RoleArn }}' + SystemIds: + - '{{ SystemIds[0] }}' + Url: '{{ Url }}' + HlsManifests: + - AdMarkers: '{{ AdMarkers }}' + IncludeIframeOnlyStream: '{{ IncludeIframeOnlyStream }}' + ManifestName: '{{ ManifestName }}' + ProgramDateTimeIntervalSeconds: '{{ ProgramDateTimeIntervalSeconds }}' + RepeatExtXKey: '{{ RepeatExtXKey }}' + StreamSelection: + MaxVideoBitsPerSecond: '{{ MaxVideoBitsPerSecond }}' + MinVideoBitsPerSecond: '{{ MinVideoBitsPerSecond }}' + StreamOrder: '{{ StreamOrder }}' + IncludeDvbSubtitles: '{{ IncludeDvbSubtitles }}' + SegmentDurationSeconds: '{{ SegmentDurationSeconds }}' + UseAudioRenditionGroup: '{{ UseAudioRenditionGroup }}' + - name: DashPackage + value: + DashManifests: + - ManifestLayout: '{{ ManifestLayout }}' + ManifestName: null + MinBufferTimeSeconds: '{{ MinBufferTimeSeconds }}' + Profile: '{{ Profile }}' + ScteMarkersSource: '{{ ScteMarkersSource }}' + StreamSelection: null + Encryption: + SpekeKeyProvider: null + PeriodTriggers: + - '{{ PeriodTriggers[0] }}' + SegmentDurationSeconds: null + SegmentTemplateFormat: '{{ SegmentTemplateFormat }}' + IncludeEncoderConfigurationInSegments: '{{ IncludeEncoderConfigurationInSegments }}' + IncludeIframeOnlyStream: '{{ IncludeIframeOnlyStream }}' + - name: MssPackage + value: + Encryption: + SpekeKeyProvider: null + MssManifests: + - ManifestName: null + StreamSelection: null + SegmentDurationSeconds: null + - name: CmafPackage + value: + Encryption: + SpekeKeyProvider: null + HlsManifests: + - null + SegmentDurationSeconds: null + IncludeEncoderConfigurationInSegments: '{{ IncludeEncoderConfigurationInSegments }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediapackage.origin_endpoints +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediapackage:DescribeOriginEndpoint +``` + +### Update +```json +mediapackage:UpdateOriginEndpoint, +mediapackage:TagResource, +mediapackage:ListTagsForResource, +mediapackage:UntagResource, +mediapackage:DescribeOriginEndpoint, +iam:PassRole +``` + +### Delete +```json +mediapackage:DeleteOriginEndpoint +``` + +### List +```json +mediapackage:ListOriginEndpoints +``` diff --git a/website/docs/services/mediapackage/origin_endpoints_list_only/index.md b/website/docs/services/mediapackage/origin_endpoints_list_only/index.md new file mode 100644 index 0000000..532509c --- /dev/null +++ b/website/docs/services/mediapackage/origin_endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: origin_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoints_list_only + - mediapackage + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists origin_endpoints in a region or regions, for all properties use origin_endpoints + +## Overview + + + + + + + +
Nameorigin_endpoints_list_only
TypeResource
DescriptionResource schema for AWS::MediaPackage::OriginEndpoint
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the OriginEndpoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all origin_endpoints in a region. +```sql +SELECT +region, +id +FROM aws.mediapackage.origin_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the origin_endpoints_list_only resource, see origin_endpoints + diff --git a/website/docs/services/mediapackage/packaging_configuration_tags/index.md b/website/docs/services/mediapackage/packaging_configuration_tags/index.md new file mode 100644 index 0000000..4060596 --- /dev/null +++ b/website/docs/services/mediapackage/packaging_configuration_tags/index.md @@ -0,0 +1,89 @@ +--- +title: packaging_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_configuration_tags + - mediapackage + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for packaging_configurations in a region + +## Overview + + + + + + + +
Namepackaging_configuration_tags
TypeResource
DescriptionResource schema for AWS::MediaPackage::PackagingConfiguration
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the PackagingConfiguration.
stringThe ID of a PackagingGroup.
stringThe ARN of the PackagingConfiguration.
objectA CMAF packaging configuration.
objectA Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
objectAn HTTP Live Streaming (HLS) packaging configuration.
objectA Microsoft Smooth Streaming (MSS) PackagingConfiguration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all packaging_configurations in a region. +```sql +SELECT +region, +id, +packaging_group_id, +arn, +cmaf_package, +dash_package, +hls_package, +mss_package, +tag_key, +tag_value +FROM aws.mediapackage.packaging_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the packaging_configuration_tags resource, see packaging_configurations + diff --git a/website/docs/services/mediapackage/packaging_configurations/index.md b/website/docs/services/mediapackage/packaging_configurations/index.md new file mode 100644 index 0000000..eefd8d4 --- /dev/null +++ b/website/docs/services/mediapackage/packaging_configurations/index.md @@ -0,0 +1,289 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a packaging_configuration resource or lists packaging_configurations in a region + +## Overview + + + + + + + +
Namepackaging_configurations
TypeResource
DescriptionResource schema for AWS::MediaPackage::PackagingConfiguration
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the PackagingConfiguration.
stringThe ID of a PackagingGroup.
stringThe ARN of the PackagingConfiguration.
objectA CMAF packaging configuration.
objectA Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
objectAn HTTP Live Streaming (HLS) packaging configuration.
objectA Microsoft Smooth Streaming (MSS) PackagingConfiguration.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::MediaPackage::PackagingConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all packaging_configurations in a region. +```sql +SELECT +region, +id, +packaging_group_id, +arn, +cmaf_package, +dash_package, +hls_package, +mss_package, +tags +FROM aws.mediapackage.packaging_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual packaging_configuration. +```sql +SELECT +region, +id, +packaging_group_id, +arn, +cmaf_package, +dash_package, +hls_package, +mss_package, +tags +FROM aws.mediapackage.packaging_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new packaging_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackage.packaging_configurations ( + Id, + PackagingGroupId, + region +) +SELECT +'{{ Id }}', + '{{ PackagingGroupId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackage.packaging_configurations ( + Id, + PackagingGroupId, + CmafPackage, + DashPackage, + HlsPackage, + MssPackage, + Tags, + region +) +SELECT + '{{ Id }}', + '{{ PackagingGroupId }}', + '{{ CmafPackage }}', + '{{ DashPackage }}', + '{{ HlsPackage }}', + '{{ MssPackage }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: packaging_configuration + props: + - name: Id + value: '{{ Id }}' + - name: PackagingGroupId + value: '{{ PackagingGroupId }}' + - name: CmafPackage + value: + Encryption: + SpekeKeyProvider: + EncryptionContractConfiguration: + PresetSpeke20Audio: '{{ PresetSpeke20Audio }}' + PresetSpeke20Video: '{{ PresetSpeke20Video }}' + RoleArn: '{{ RoleArn }}' + SystemIds: + - '{{ SystemIds[0] }}' + Url: '{{ Url }}' + HlsManifests: + - AdMarkers: '{{ AdMarkers }}' + IncludeIframeOnlyStream: '{{ IncludeIframeOnlyStream }}' + ManifestName: '{{ ManifestName }}' + ProgramDateTimeIntervalSeconds: '{{ ProgramDateTimeIntervalSeconds }}' + RepeatExtXKey: '{{ RepeatExtXKey }}' + StreamSelection: + MaxVideoBitsPerSecond: '{{ MaxVideoBitsPerSecond }}' + MinVideoBitsPerSecond: '{{ MinVideoBitsPerSecond }}' + StreamOrder: '{{ StreamOrder }}' + SegmentDurationSeconds: '{{ SegmentDurationSeconds }}' + IncludeEncoderConfigurationInSegments: '{{ IncludeEncoderConfigurationInSegments }}' + - name: DashPackage + value: + DashManifests: + - ManifestLayout: '{{ ManifestLayout }}' + ManifestName: null + MinBufferTimeSeconds: '{{ MinBufferTimeSeconds }}' + Profile: '{{ Profile }}' + ScteMarkersSource: '{{ ScteMarkersSource }}' + StreamSelection: null + Encryption: + SpekeKeyProvider: null + PeriodTriggers: + - '{{ PeriodTriggers[0] }}' + SegmentDurationSeconds: null + SegmentTemplateFormat: '{{ SegmentTemplateFormat }}' + IncludeEncoderConfigurationInSegments: '{{ IncludeEncoderConfigurationInSegments }}' + IncludeIframeOnlyStream: '{{ IncludeIframeOnlyStream }}' + - name: HlsPackage + value: + Encryption: + ConstantInitializationVector: '{{ ConstantInitializationVector }}' + EncryptionMethod: '{{ EncryptionMethod }}' + SpekeKeyProvider: null + HlsManifests: + - null + IncludeDvbSubtitles: '{{ IncludeDvbSubtitles }}' + SegmentDurationSeconds: null + UseAudioRenditionGroup: '{{ UseAudioRenditionGroup }}' + - name: MssPackage + value: + Encryption: + SpekeKeyProvider: null + MssManifests: + - ManifestName: null + StreamSelection: null + SegmentDurationSeconds: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediapackage.packaging_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediapackage-vod:DescribePackagingConfiguration +``` + +### Delete +```json +mediapackage-vod:DescribePackagingConfiguration, +mediapackage-vod:DeletePackagingConfiguration +``` + +### List +```json +mediapackage-vod:ListPackagingConfigurations, +mediapackage-vod:DescribePackagingGroup +``` diff --git a/website/docs/services/mediapackage/packaging_configurations_list_only/index.md b/website/docs/services/mediapackage/packaging_configurations_list_only/index.md new file mode 100644 index 0000000..41e77ee --- /dev/null +++ b/website/docs/services/mediapackage/packaging_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: packaging_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_configurations_list_only + - mediapackage + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists packaging_configurations in a region or regions, for all properties use packaging_configurations + +## Overview + + + + + + + +
Namepackaging_configurations_list_only
TypeResource
DescriptionResource schema for AWS::MediaPackage::PackagingConfiguration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the PackagingConfiguration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all packaging_configurations in a region. +```sql +SELECT +region, +id +FROM aws.mediapackage.packaging_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the packaging_configurations_list_only resource, see packaging_configurations + diff --git a/website/docs/services/mediapackage/packaging_group_tags/index.md b/website/docs/services/mediapackage/packaging_group_tags/index.md new file mode 100644 index 0000000..8bde89c --- /dev/null +++ b/website/docs/services/mediapackage/packaging_group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: packaging_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_group_tags + - mediapackage + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for packaging_groups in a region + +## Overview + + + + + + + +
Namepackaging_group_tags
TypeResource
DescriptionResource schema for AWS::MediaPackage::PackagingGroup
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the PackagingGroup.
stringThe ARN of the PackagingGroup.
stringThe fully qualified domain name for Assets in the PackagingGroup.
objectCDN Authorization
objectThe configuration parameters for egress access logging.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all packaging_groups in a region. +```sql +SELECT +region, +id, +arn, +domain_name, +authorization, +egress_access_logs, +tag_key, +tag_value +FROM aws.mediapackage.packaging_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the packaging_group_tags resource, see packaging_groups + diff --git a/website/docs/services/mediapackage/packaging_groups/index.md b/website/docs/services/mediapackage/packaging_groups/index.md new file mode 100644 index 0000000..de2489e --- /dev/null +++ b/website/docs/services/mediapackage/packaging_groups/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a packaging_group resource or lists packaging_groups in a region + +## Overview + + + + + + + +
Namepackaging_groups
TypeResource
DescriptionResource schema for AWS::MediaPackage::PackagingGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the PackagingGroup.
stringThe ARN of the PackagingGroup.
stringThe fully qualified domain name for Assets in the PackagingGroup.
objectCDN Authorization
arrayA collection of tags associated with a resource
objectThe configuration parameters for egress access logging.
stringAWS region.
+ +For more information, see AWS::MediaPackage::PackagingGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all packaging_groups in a region. +```sql +SELECT +region, +id, +arn, +domain_name, +authorization, +tags, +egress_access_logs +FROM aws.mediapackage.packaging_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual packaging_group. +```sql +SELECT +region, +id, +arn, +domain_name, +authorization, +tags, +egress_access_logs +FROM aws.mediapackage.packaging_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new packaging_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackage.packaging_groups ( + Id, + region +) +SELECT +'{{ Id }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackage.packaging_groups ( + Id, + Authorization, + Tags, + EgressAccessLogs, + region +) +SELECT + '{{ Id }}', + '{{ Authorization }}', + '{{ Tags }}', + '{{ EgressAccessLogs }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: packaging_group + props: + - name: Id + value: '{{ Id }}' + - name: Authorization + value: + CdnIdentifierSecret: '{{ CdnIdentifierSecret }}' + SecretsRoleArn: '{{ SecretsRoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: EgressAccessLogs + value: + LogGroupName: '{{ LogGroupName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediapackage.packaging_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediapackage-vod:DescribePackagingGroup +``` + +### Update +```json +mediapackage-vod:DescribePackagingGroup, +mediapackage-vod:UpdatePackagingGroup, +mediapackage-vod:ConfigureLogs, +mediapackage-vod:TagResource, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### List +```json +mediapackage-vod:ListPackagingGroups +``` + +### Delete +```json +mediapackage-vod:DescribePackagingGroup, +mediapackage-vod:DeletePackagingGroup +``` diff --git a/website/docs/services/mediapackage/packaging_groups_list_only/index.md b/website/docs/services/mediapackage/packaging_groups_list_only/index.md new file mode 100644 index 0000000..91ecd1a --- /dev/null +++ b/website/docs/services/mediapackage/packaging_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: packaging_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_groups_list_only + - mediapackage + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists packaging_groups in a region or regions, for all properties use packaging_groups + +## Overview + + + + + + + +
Namepackaging_groups_list_only
TypeResource
DescriptionResource schema for AWS::MediaPackage::PackagingGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the PackagingGroup.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all packaging_groups in a region. +```sql +SELECT +region, +id +FROM aws.mediapackage.packaging_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the packaging_groups_list_only resource, see packaging_groups + diff --git a/website/docs/services/mediapackagev2/channel_group_tags/index.md b/website/docs/services/mediapackagev2/channel_group_tags/index.md new file mode 100644 index 0000000..88c993c --- /dev/null +++ b/website/docs/services/mediapackagev2/channel_group_tags/index.md @@ -0,0 +1,87 @@ +--- +title: channel_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_group_tags + - mediapackagev2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channel_groups in a region + +## Overview + + + + + + + +
Namechannel_group_tags
TypeResource
Description

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

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

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

string
string

The date and time the channel group was created.

string

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

string

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

string

The date and time the channel group was modified.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channel_groups in a region. +```sql +SELECT +region, +arn, +channel_group_name, +created_at, +description, +egress_domain, +modified_at, +tag_key, +tag_value +FROM aws.mediapackagev2.channel_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_group_tags resource, see channel_groups + diff --git a/website/docs/services/mediapackagev2/channel_groups/index.md b/website/docs/services/mediapackagev2/channel_groups/index.md new file mode 100644 index 0000000..bac8269 --- /dev/null +++ b/website/docs/services/mediapackagev2/channel_groups/index.md @@ -0,0 +1,227 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a channel_group resource or lists channel_groups in a region + +## Overview + + + + + + + +
Namechannel_groups
TypeResource
Description

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

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

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

string
string

The date and time the channel group was created.

string

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

string

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

string

The date and time the channel group was modified.

array
stringAWS region.
+ +For more information, see AWS::MediaPackageV2::ChannelGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all channel_groups in a region. +```sql +SELECT +region, +arn, +channel_group_name, +created_at, +description, +egress_domain, +modified_at, +tags +FROM aws.mediapackagev2.channel_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual channel_group. +```sql +SELECT +region, +arn, +channel_group_name, +created_at, +description, +egress_domain, +modified_at, +tags +FROM aws.mediapackagev2.channel_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new channel_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackagev2.channel_groups ( + ChannelGroupName, + region +) +SELECT +'{{ ChannelGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackagev2.channel_groups ( + ChannelGroupName, + Description, + Tags, + region +) +SELECT + '{{ ChannelGroupName }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: channel_group + props: + - name: ChannelGroupName + value: '{{ ChannelGroupName }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediapackagev2.channel_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the channel_groups resource, the following permissions are required: + +### Create +```json +mediapackagev2:TagResource, +mediapackagev2:CreateChannelGroup +``` + +### Read +```json +mediapackagev2:GetChannelGroup +``` + +### Update +```json +mediapackagev2:TagResource, +mediapackagev2:UntagResource, +mediapackagev2:ListTagsForResource, +mediapackagev2:UpdateChannelGroup +``` + +### Delete +```json +mediapackagev2:GetChannelGroup, +mediapackagev2:DeleteChannelGroup +``` + +### List +```json +mediapackagev2:ListChannelGroups +``` diff --git a/website/docs/services/mediapackagev2/channel_groups_list_only/index.md b/website/docs/services/mediapackagev2/channel_groups_list_only/index.md new file mode 100644 index 0000000..079ca75 --- /dev/null +++ b/website/docs/services/mediapackagev2/channel_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: channel_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channel_groups_list_only + - mediapackagev2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channel_groups in a region or regions, for all properties use channel_groups + +## Overview + + + + + + + +
Namechannel_groups_list_only
TypeResource
Description

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

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

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

stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channel_groups in a region. +```sql +SELECT +region, +arn +FROM aws.mediapackagev2.channel_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_groups_list_only resource, see channel_groups + diff --git a/website/docs/services/mediapackagev2/channel_policies/index.md b/website/docs/services/mediapackagev2/channel_policies/index.md new file mode 100644 index 0000000..e8779aa --- /dev/null +++ b/website/docs/services/mediapackagev2/channel_policies/index.md @@ -0,0 +1,196 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a channel_policy resource or lists channel_policies in a region + +## Overview + + + + + + + +
Namechannel_policies
TypeResource
Description

Represents a resource-based policy that allows or denies access to a channel.

Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
object
stringAWS region.
+ +For more information, see AWS::MediaPackageV2::ChannelPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual channel_policy. +```sql +SELECT +region, +channel_group_name, +channel_name, +policy +FROM aws.mediapackagev2.channel_policies +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new channel_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackagev2.channel_policies ( + ChannelGroupName, + ChannelName, + Policy, + region +) +SELECT +'{{ ChannelGroupName }}', + '{{ ChannelName }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackagev2.channel_policies ( + ChannelGroupName, + ChannelName, + Policy, + region +) +SELECT + '{{ ChannelGroupName }}', + '{{ ChannelName }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: channel_policy + props: + - name: ChannelGroupName + value: '{{ ChannelGroupName }}' + - name: ChannelName + value: '{{ ChannelName }}' + - name: Policy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediapackagev2.channel_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the channel_policies resource, the following permissions are required: + +### Create +```json +mediapackagev2:GetChannelPolicy, +mediapackagev2:PutChannelPolicy +``` + +### Read +```json +mediapackagev2:GetChannelPolicy +``` + +### Update +```json +mediapackagev2:GetChannelPolicy, +mediapackagev2:PutChannelPolicy +``` + +### Delete +```json +mediapackagev2:GetChannelPolicy, +mediapackagev2:DeleteChannelPolicy +``` diff --git a/website/docs/services/mediapackagev2/channel_tags/index.md b/website/docs/services/mediapackagev2/channel_tags/index.md new file mode 100644 index 0000000..3bfa8cf --- /dev/null +++ b/website/docs/services/mediapackagev2/channel_tags/index.md @@ -0,0 +1,93 @@ +--- +title: channel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_tags + - mediapackagev2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channels in a region + +## Overview + + + + + + + +
Namechannel_tags
TypeResource
Description

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

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

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

string
string
string

The date and time the channel was created.

string

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

array

The list of ingest endpoints.

string
string

The date and time the channel was modified.

array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channels in a region. +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +created_at, +description, +ingest_endpoints, +input_type, +modified_at, +ingest_endpoint_urls, +tag_key, +tag_value +FROM aws.mediapackagev2.channel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_tags resource, see channels + diff --git a/website/docs/services/mediapackagev2/channels/index.md b/website/docs/services/mediapackagev2/channels/index.md new file mode 100644 index 0000000..ccce4db --- /dev/null +++ b/website/docs/services/mediapackagev2/channels/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a channel resource or lists channels in a region + +## Overview + + + + + + + +
Namechannels
TypeResource
Description

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

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

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

string
string
string

The date and time the channel was created.

string

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

array

The list of ingest endpoints.

string
string

The date and time the channel was modified.

array
array
stringAWS region.
+ +For more information, see AWS::MediaPackageV2::Channel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all channels in a region. +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +created_at, +description, +ingest_endpoints, +input_type, +modified_at, +ingest_endpoint_urls, +tags +FROM aws.mediapackagev2.channels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual channel. +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +created_at, +description, +ingest_endpoints, +input_type, +modified_at, +ingest_endpoint_urls, +tags +FROM aws.mediapackagev2.channels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackagev2.channels ( + ChannelGroupName, + ChannelName, + region +) +SELECT +'{{ ChannelGroupName }}', + '{{ ChannelName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackagev2.channels ( + ChannelGroupName, + ChannelName, + Description, + InputType, + Tags, + region +) +SELECT + '{{ ChannelGroupName }}', + '{{ ChannelName }}', + '{{ Description }}', + '{{ InputType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: channel + props: + - name: ChannelGroupName + value: '{{ ChannelGroupName }}' + - name: ChannelName + value: '{{ ChannelName }}' + - name: Description + value: '{{ Description }}' + - name: InputType + value: '{{ InputType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediapackagev2.channels +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +```json +mediapackagev2:TagResource, +mediapackagev2:CreateChannel +``` + +### Read +```json +mediapackagev2:GetChannel +``` + +### Update +```json +mediapackagev2:TagResource, +mediapackagev2:UntagResource, +mediapackagev2:ListTagsForResource, +mediapackagev2:UpdateChannel +``` + +### Delete +```json +mediapackagev2:GetChannel, +mediapackagev2:DeleteChannel +``` + +### List +```json +mediapackagev2:ListChannels +``` diff --git a/website/docs/services/mediapackagev2/channels_list_only/index.md b/website/docs/services/mediapackagev2/channels_list_only/index.md new file mode 100644 index 0000000..fb76158 --- /dev/null +++ b/website/docs/services/mediapackagev2/channels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channels_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channels in a region or regions, for all properties use channels + +## Overview + + + + + + + +
Namechannels_list_only
TypeResource
Description

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

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

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

stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channels in a region. +```sql +SELECT +region, +arn +FROM aws.mediapackagev2.channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channels_list_only resource, see channels + diff --git a/website/docs/services/mediapackagev2/index.md b/website/docs/services/mediapackagev2/index.md new file mode 100644 index 0000000..c900649 --- /dev/null +++ b/website/docs/services/mediapackagev2/index.md @@ -0,0 +1,46 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The mediapackagev2 service documentation. + +:::info Service Summary + +
+
+total resources: 11
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/mediapackagev2/origin_endpoint_policies/index.md b/website/docs/services/mediapackagev2/origin_endpoint_policies/index.md new file mode 100644 index 0000000..7e92382 --- /dev/null +++ b/website/docs/services/mediapackagev2/origin_endpoint_policies/index.md @@ -0,0 +1,204 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an origin_endpoint_policy resource or lists origin_endpoint_policies in a region + +## Overview + + + + + + + +
Nameorigin_endpoint_policies
TypeResource
Description

Represents a resource policy that allows or denies access to an origin endpoint.

Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
object
stringAWS region.
+ +For more information, see AWS::MediaPackageV2::OriginEndpointPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual origin_endpoint_policy. +```sql +SELECT +region, +channel_group_name, +channel_name, +origin_endpoint_name, +policy +FROM aws.mediapackagev2.origin_endpoint_policies +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new origin_endpoint_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackagev2.origin_endpoint_policies ( + ChannelGroupName, + ChannelName, + OriginEndpointName, + Policy, + region +) +SELECT +'{{ ChannelGroupName }}', + '{{ ChannelName }}', + '{{ OriginEndpointName }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackagev2.origin_endpoint_policies ( + ChannelGroupName, + ChannelName, + OriginEndpointName, + Policy, + region +) +SELECT + '{{ ChannelGroupName }}', + '{{ ChannelName }}', + '{{ OriginEndpointName }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: origin_endpoint_policy + props: + - name: ChannelGroupName + value: '{{ ChannelGroupName }}' + - name: ChannelName + value: '{{ ChannelName }}' + - name: OriginEndpointName + value: '{{ OriginEndpointName }}' + - name: Policy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediapackagev2.origin_endpoint_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the origin_endpoint_policies resource, the following permissions are required: + +### Create +```json +mediapackagev2:GetOriginEndpointPolicy, +mediapackagev2:PutOriginEndpointPolicy +``` + +### Read +```json +mediapackagev2:GetOriginEndpointPolicy +``` + +### Update +```json +mediapackagev2:GetOriginEndpointPolicy, +mediapackagev2:PutOriginEndpointPolicy +``` + +### Delete +```json +mediapackagev2:GetOriginEndpointPolicy, +mediapackagev2:DeleteOriginEndpointPolicy +``` diff --git a/website/docs/services/mediapackagev2/origin_endpoint_tags/index.md b/website/docs/services/mediapackagev2/origin_endpoint_tags/index.md new file mode 100644 index 0000000..5f5a6ae --- /dev/null +++ b/website/docs/services/mediapackagev2/origin_endpoint_tags/index.md @@ -0,0 +1,109 @@ +--- +title: origin_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoint_tags + - mediapackagev2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for origin_endpoints in a region + +## Overview + + + + + + + +
Nameorigin_endpoint_tags
TypeResource
Description

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

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

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

string
string
string
string

The date and time the origin endpoint was created.

array

A DASH manifest configuration.

string

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

object

The failover settings for the endpoint.

array

An HTTP live streaming (HLS) manifest configuration.

array

A low-latency HLS manifest configuration.

string

The date and time the origin endpoint was modified.

string
object

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

integer

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

array
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all origin_endpoints in a region. +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +container_type, +created_at, +dash_manifests, +description, +force_endpoint_error_configuration, +hls_manifests, +low_latency_hls_manifests, +modified_at, +origin_endpoint_name, +segment, +startover_window_seconds, +dash_manifest_urls, +hls_manifest_urls, +low_latency_hls_manifest_urls, +tag_key, +tag_value +FROM aws.mediapackagev2.origin_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the origin_endpoint_tags resource, see origin_endpoints + diff --git a/website/docs/services/mediapackagev2/origin_endpoints/index.md b/website/docs/services/mediapackagev2/origin_endpoints/index.md new file mode 100644 index 0000000..36f0bd7 --- /dev/null +++ b/website/docs/services/mediapackagev2/origin_endpoints/index.md @@ -0,0 +1,368 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an origin_endpoint resource or lists origin_endpoints in a region + +## Overview + + + + + + + +
Nameorigin_endpoints
TypeResource
Description

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

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

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

string
string
string
string

The date and time the origin endpoint was created.

array

A DASH manifest configuration.

string

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

object

The failover settings for the endpoint.

array

An HTTP live streaming (HLS) manifest configuration.

array

A low-latency HLS manifest configuration.

string

The date and time the origin endpoint was modified.

string
object

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

integer

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

array
array
array
array
stringAWS region.
+ +For more information, see AWS::MediaPackageV2::OriginEndpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all origin_endpoints in a region. +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +container_type, +created_at, +dash_manifests, +description, +force_endpoint_error_configuration, +hls_manifests, +low_latency_hls_manifests, +modified_at, +origin_endpoint_name, +segment, +startover_window_seconds, +dash_manifest_urls, +hls_manifest_urls, +low_latency_hls_manifest_urls, +tags +FROM aws.mediapackagev2.origin_endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual origin_endpoint. +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +container_type, +created_at, +dash_manifests, +description, +force_endpoint_error_configuration, +hls_manifests, +low_latency_hls_manifests, +modified_at, +origin_endpoint_name, +segment, +startover_window_seconds, +dash_manifest_urls, +hls_manifest_urls, +low_latency_hls_manifest_urls, +tags +FROM aws.mediapackagev2.origin_endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new origin_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackagev2.origin_endpoints ( + ChannelGroupName, + ChannelName, + ContainerType, + OriginEndpointName, + region +) +SELECT +'{{ ChannelGroupName }}', + '{{ ChannelName }}', + '{{ ContainerType }}', + '{{ OriginEndpointName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediapackagev2.origin_endpoints ( + ChannelGroupName, + ChannelName, + ContainerType, + DashManifests, + Description, + ForceEndpointErrorConfiguration, + HlsManifests, + LowLatencyHlsManifests, + OriginEndpointName, + Segment, + StartoverWindowSeconds, + Tags, + region +) +SELECT + '{{ ChannelGroupName }}', + '{{ ChannelName }}', + '{{ ContainerType }}', + '{{ DashManifests }}', + '{{ Description }}', + '{{ ForceEndpointErrorConfiguration }}', + '{{ HlsManifests }}', + '{{ LowLatencyHlsManifests }}', + '{{ OriginEndpointName }}', + '{{ Segment }}', + '{{ StartoverWindowSeconds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: origin_endpoint + props: + - name: ChannelGroupName + value: '{{ ChannelGroupName }}' + - name: ChannelName + value: '{{ ChannelName }}' + - name: ContainerType + value: '{{ ContainerType }}' + - name: DashManifests + value: + - ManifestName: '{{ ManifestName }}' + ManifestWindowSeconds: '{{ ManifestWindowSeconds }}' + FilterConfiguration: + ManifestFilter: '{{ ManifestFilter }}' + Start: '{{ Start }}' + End: '{{ End }}' + TimeDelaySeconds: '{{ TimeDelaySeconds }}' + ClipStartTime: '{{ ClipStartTime }}' + MinUpdatePeriodSeconds: '{{ MinUpdatePeriodSeconds }}' + MinBufferTimeSeconds: '{{ MinBufferTimeSeconds }}' + SuggestedPresentationDelaySeconds: '{{ SuggestedPresentationDelaySeconds }}' + SegmentTemplateFormat: '{{ SegmentTemplateFormat }}' + PeriodTriggers: + - '{{ PeriodTriggers[0] }}' + ScteDash: + AdMarkerDash: '{{ AdMarkerDash }}' + DrmSignaling: '{{ DrmSignaling }}' + UtcTiming: + TimingMode: '{{ TimingMode }}' + TimingSource: '{{ TimingSource }}' + - name: Description + value: '{{ Description }}' + - name: ForceEndpointErrorConfiguration + value: + EndpointErrorConditions: + - '{{ EndpointErrorConditions[0] }}' + - name: HlsManifests + value: + - ManifestName: '{{ ManifestName }}' + Url: '{{ Url }}' + ChildManifestName: '{{ ChildManifestName }}' + ManifestWindowSeconds: '{{ ManifestWindowSeconds }}' + ProgramDateTimeIntervalSeconds: '{{ ProgramDateTimeIntervalSeconds }}' + ScteHls: + AdMarkerHls: '{{ AdMarkerHls }}' + FilterConfiguration: null + StartTag: + TimeOffset: null + Precise: '{{ Precise }}' + - name: LowLatencyHlsManifests + value: + - ManifestName: '{{ ManifestName }}' + Url: '{{ Url }}' + ChildManifestName: '{{ ChildManifestName }}' + ManifestWindowSeconds: '{{ ManifestWindowSeconds }}' + ProgramDateTimeIntervalSeconds: '{{ ProgramDateTimeIntervalSeconds }}' + ScteHls: null + FilterConfiguration: null + StartTag: null + - name: OriginEndpointName + value: '{{ OriginEndpointName }}' + - name: Segment + value: + SegmentDurationSeconds: '{{ SegmentDurationSeconds }}' + SegmentName: '{{ SegmentName }}' + TsUseAudioRenditionGroup: '{{ TsUseAudioRenditionGroup }}' + IncludeIframeOnlyStreams: '{{ IncludeIframeOnlyStreams }}' + TsIncludeDvbSubtitles: '{{ TsIncludeDvbSubtitles }}' + Scte: + ScteFilter: + - '{{ ScteFilter[0] }}' + Encryption: + ConstantInitializationVector: '{{ ConstantInitializationVector }}' + EncryptionMethod: + TsEncryptionMethod: '{{ TsEncryptionMethod }}' + CmafEncryptionMethod: '{{ CmafEncryptionMethod }}' + KeyRotationIntervalSeconds: '{{ KeyRotationIntervalSeconds }}' + SpekeKeyProvider: + EncryptionContractConfiguration: + PresetSpeke20Audio: '{{ PresetSpeke20Audio }}' + PresetSpeke20Video: '{{ PresetSpeke20Video }}' + ResourceId: '{{ ResourceId }}' + DrmSystems: + - '{{ DrmSystems[0] }}' + RoleArn: '{{ RoleArn }}' + Url: '{{ Url }}' + - name: StartoverWindowSeconds + value: '{{ StartoverWindowSeconds }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediapackagev2.origin_endpoints +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediapackagev2:GetOriginEndpoint +``` + +### Update +```json +mediapackagev2:TagResource, +mediapackagev2:UntagResource, +mediapackagev2:ListTagsForResource, +mediapackagev2:UpdateOriginEndpoint, +iam:PassRole +``` + +### Delete +```json +mediapackagev2:GetOriginEndpoint, +mediapackagev2:DeleteOriginEndpoint +``` + +### List +```json +mediapackagev2:ListOriginEndpoints +``` diff --git a/website/docs/services/mediapackagev2/origin_endpoints_list_only/index.md b/website/docs/services/mediapackagev2/origin_endpoints_list_only/index.md new file mode 100644 index 0000000..d3684e2 --- /dev/null +++ b/website/docs/services/mediapackagev2/origin_endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: origin_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoints_list_only + - mediapackagev2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists origin_endpoints in a region or regions, for all properties use origin_endpoints + +## Overview + + + + + + + +
Nameorigin_endpoints_list_only
TypeResource
Description

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

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

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

stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all origin_endpoints in a region. +```sql +SELECT +region, +arn +FROM aws.mediapackagev2.origin_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the origin_endpoints_list_only resource, see origin_endpoints + diff --git a/website/docs/services/mediatailor/channel_policies/index.md b/website/docs/services/mediatailor/channel_policies/index.md new file mode 100644 index 0000000..218fac3 --- /dev/null +++ b/website/docs/services/mediatailor/channel_policies/index.md @@ -0,0 +1,188 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a channel_policy resource or lists channel_policies in a region + +## Overview + + + + + + + +
Namechannel_policies
TypeResource
DescriptionDefinition of AWS::MediaTailor::ChannelPolicy Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
object

The IAM policy for the channel. IAM policies are used to control access to your channel.

stringAWS region.
+ +For more information, see AWS::MediaTailor::ChannelPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual channel_policy. +```sql +SELECT +region, +channel_name, +policy +FROM aws.mediatailor.channel_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new channel_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.channel_policies ( + ChannelName, + Policy, + region +) +SELECT +'{{ ChannelName }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.channel_policies ( + ChannelName, + Policy, + region +) +SELECT + '{{ ChannelName }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: channel_policy + props: + - name: ChannelName + value: '{{ ChannelName }}' + - name: Policy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediatailor.channel_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the channel_policies resource, the following permissions are required: + +### Create +```json +mediatailor:PutChannelPolicy, +mediatailor:GetChannelPolicy +``` + +### Read +```json +mediatailor:GetChannelPolicy +``` + +### Update +```json +mediatailor:PutChannelPolicy, +mediatailor:GetChannelPolicy +``` + +### Delete +```json +mediatailor:DeleteChannelPolicy, +mediatailor:GetChannelPolicy +``` diff --git a/website/docs/services/mediatailor/channel_tags/index.md b/website/docs/services/mediatailor/channel_tags/index.md new file mode 100644 index 0000000..7369f72 --- /dev/null +++ b/website/docs/services/mediatailor/channel_tags/index.md @@ -0,0 +1,93 @@ +--- +title: channel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_tags + - mediatailor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channels in a region + +## Overview + + + + + + + +
Namechannel_tags
TypeResource
DescriptionDefinition of AWS::MediaTailor::Channel Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The ARN of the channel.

array

The list of audiences defined in channel.

string
object

Slate VOD source configuration.

object

The log configuration for the channel.

array

The channel's output properties.

string
string
object

The configuration for time-shifted viewing.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channels in a region. +```sql +SELECT +region, +arn, +audiences, +channel_name, +filler_slate, +log_configuration, +outputs, +playback_mode, +tier, +time_shift_configuration, +tag_key, +tag_value +FROM aws.mediatailor.channel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_tags resource, see channels + diff --git a/website/docs/services/mediatailor/channels/index.md b/website/docs/services/mediatailor/channels/index.md new file mode 100644 index 0000000..b7af6cb --- /dev/null +++ b/website/docs/services/mediatailor/channels/index.md @@ -0,0 +1,286 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a channel resource or lists channels in a region + +## Overview + + + + + + + +
Namechannels
TypeResource
DescriptionDefinition of AWS::MediaTailor::Channel Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The ARN of the channel.

array

The list of audiences defined in channel.

string
object

Slate VOD source configuration.

object

The log configuration for the channel.

array

The channel's output properties.

string
arrayThe tags to assign to the channel.
string
object

The configuration for time-shifted viewing.

stringAWS region.
+ +For more information, see AWS::MediaTailor::Channel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all channels in a region. +```sql +SELECT +region, +arn, +audiences, +channel_name, +filler_slate, +log_configuration, +outputs, +playback_mode, +tags, +tier, +time_shift_configuration +FROM aws.mediatailor.channels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual channel. +```sql +SELECT +region, +arn, +audiences, +channel_name, +filler_slate, +log_configuration, +outputs, +playback_mode, +tags, +tier, +time_shift_configuration +FROM aws.mediatailor.channels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.channels ( + ChannelName, + Outputs, + PlaybackMode, + region +) +SELECT +'{{ ChannelName }}', + '{{ Outputs }}', + '{{ PlaybackMode }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.channels ( + Audiences, + ChannelName, + FillerSlate, + LogConfiguration, + Outputs, + PlaybackMode, + Tags, + Tier, + TimeShiftConfiguration, + region +) +SELECT + '{{ Audiences }}', + '{{ ChannelName }}', + '{{ FillerSlate }}', + '{{ LogConfiguration }}', + '{{ Outputs }}', + '{{ PlaybackMode }}', + '{{ Tags }}', + '{{ Tier }}', + '{{ TimeShiftConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: channel + props: + - name: Audiences + value: + - '{{ Audiences[0] }}' + - name: ChannelName + value: '{{ ChannelName }}' + - name: FillerSlate + value: + SourceLocationName: '{{ SourceLocationName }}' + VodSourceName: '{{ VodSourceName }}' + - name: LogConfiguration + value: + LogTypes: + - '{{ LogTypes[0] }}' + - name: Outputs + value: + - DashPlaylistSettings: + ManifestWindowSeconds: null + MinBufferTimeSeconds: null + MinUpdatePeriodSeconds: null + SuggestedPresentationDelaySeconds: null + HlsPlaylistSettings: + ManifestWindowSeconds: null + AdMarkupType: + - '{{ AdMarkupType[0] }}' + ManifestName: '{{ ManifestName }}' + SourceGroup: '{{ SourceGroup }}' + - name: PlaybackMode + value: '{{ PlaybackMode }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Tier + value: '{{ Tier }}' + - name: TimeShiftConfiguration + value: + MaxTimeDelaySeconds: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediatailor.channels +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediatailor:DescribeChannel +``` + +### Update +```json +mediatailor:UpdateChannel, +mediatailor:TagResource, +mediatailor:UntagResource, +iam:CreateServiceLinkedRole, +mediatailor:ConfigureLogsForChannel, +mediatailor:DescribeChannel +``` + +### Delete +```json +mediatailor:DeleteChannel, +mediatailor:DescribeChannel +``` + +### List +```json +mediatailor:ListChannels +``` diff --git a/website/docs/services/mediatailor/channels_list_only/index.md b/website/docs/services/mediatailor/channels_list_only/index.md new file mode 100644 index 0000000..3551872 --- /dev/null +++ b/website/docs/services/mediatailor/channels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channels_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channels in a region or regions, for all properties use channels + +## Overview + + + + + + + +
Namechannels_list_only
TypeResource
DescriptionDefinition of AWS::MediaTailor::Channel Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channels in a region. +```sql +SELECT +region, +channel_name +FROM aws.mediatailor.channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channels_list_only resource, see channels + diff --git a/website/docs/services/mediatailor/index.md b/website/docs/services/mediatailor/index.md new file mode 100644 index 0000000..c1b8b06 --- /dev/null +++ b/website/docs/services/mediatailor/index.md @@ -0,0 +1,51 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The mediatailor service documentation. + +:::info Service Summary + +
+
+total resources: 16
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/mediatailor/live_source_tags/index.md b/website/docs/services/mediatailor/live_source_tags/index.md new file mode 100644 index 0000000..f15f48c --- /dev/null +++ b/website/docs/services/mediatailor/live_source_tags/index.md @@ -0,0 +1,83 @@ +--- +title: live_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - live_source_tags + - mediatailor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for live_sources in a region + +## Overview + + + + + + + +
Namelive_source_tags
TypeResource
DescriptionDefinition of AWS::MediaTailor::LiveSource Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string

The ARN of the live source.

array

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

string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all live_sources in a region. +```sql +SELECT +region, +arn, +http_package_configurations, +live_source_name, +source_location_name, +tag_key, +tag_value +FROM aws.mediatailor.live_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the live_source_tags resource, see live_sources + diff --git a/website/docs/services/mediatailor/live_sources/index.md b/website/docs/services/mediatailor/live_sources/index.md new file mode 100644 index 0000000..848b8b9 --- /dev/null +++ b/website/docs/services/mediatailor/live_sources/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a live_source resource or lists live_sources in a region + +## Overview + + + + + + + +
Namelive_sources
TypeResource
DescriptionDefinition of AWS::MediaTailor::LiveSource Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string

The ARN of the live source.

array

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

string
string
arrayThe tags to assign to the live source.
stringAWS region.
+ +For more information, see AWS::MediaTailor::LiveSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all live_sources in a region. +```sql +SELECT +region, +arn, +http_package_configurations, +live_source_name, +source_location_name, +tags +FROM aws.mediatailor.live_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual live_source. +```sql +SELECT +region, +arn, +http_package_configurations, +live_source_name, +source_location_name, +tags +FROM aws.mediatailor.live_sources +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new live_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.live_sources ( + HttpPackageConfigurations, + LiveSourceName, + SourceLocationName, + region +) +SELECT +'{{ HttpPackageConfigurations }}', + '{{ LiveSourceName }}', + '{{ SourceLocationName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.live_sources ( + HttpPackageConfigurations, + LiveSourceName, + SourceLocationName, + Tags, + region +) +SELECT + '{{ HttpPackageConfigurations }}', + '{{ LiveSourceName }}', + '{{ SourceLocationName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: live_source + props: + - name: HttpPackageConfigurations + value: + - Path: '{{ Path }}' + SourceGroup: '{{ SourceGroup }}' + Type: '{{ Type }}' + - name: LiveSourceName + value: '{{ LiveSourceName }}' + - name: SourceLocationName + value: '{{ SourceLocationName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediatailor.live_sources +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediatailor:DescribeLiveSource +``` + +### Update +```json +mediatailor:UpdateLiveSource, +mediatailor:DescribeLiveSource, +mediatailor:TagResource, +mediatailor:UntagResource +``` + +### Delete +```json +mediatailor:DeleteLiveSource, +mediatailor:DescribeLiveSource +``` + +### List +```json +mediatailor:ListLiveSources +``` diff --git a/website/docs/services/mediatailor/live_sources_list_only/index.md b/website/docs/services/mediatailor/live_sources_list_only/index.md new file mode 100644 index 0000000..158b236 --- /dev/null +++ b/website/docs/services/mediatailor/live_sources_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: live_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - live_sources_list_only + - mediatailor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists live_sources in a region or regions, for all properties use live_sources + +## Overview + + + + + + + +
Namelive_sources_list_only
TypeResource
DescriptionDefinition of AWS::MediaTailor::LiveSource Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all live_sources in a region. +```sql +SELECT +region, +live_source_name, +source_location_name +FROM aws.mediatailor.live_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the live_sources_list_only resource, see live_sources + diff --git a/website/docs/services/mediatailor/playback_configuration_tags/index.md b/website/docs/services/mediatailor/playback_configuration_tags/index.md new file mode 100644 index 0000000..c1928e8 --- /dev/null +++ b/website/docs/services/mediatailor/playback_configuration_tags/index.md @@ -0,0 +1,109 @@ +--- +title: playback_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - playback_configuration_tags + - mediatailor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for playback_configurations in a region + +## Overview + + + + + + + +
Nameplayback_configuration_tags
TypeResource
DescriptionResource schema for AWS::MediaTailor::PlaybackConfiguration
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
objectThe configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
objectThe configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).
objectThe configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
undefinedThe player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
objectThe configuration for DASH content.
objectThe configuration for pre-roll ad insertion.
objectThe configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
stringThe identifier for the playback configuration.
integerDefines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
stringThe URL that the player uses to initialize a session that uses client-side reporting.
objectThe configuration for HLS content.
stringThe Amazon Resource Name (ARN) for the playback configuration.
stringThe URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.
stringThe URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
stringThe name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
stringThe URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all playback_configurations in a region. +```sql +SELECT +region, +ad_decision_server_url, +avail_suppression, +bumper, +cdn_configuration, +configuration_aliases, +dash_configuration, +live_pre_roll_configuration, +manifest_processing_rules, +name, +personalization_threshold_seconds, +session_initialization_endpoint_prefix, +hls_configuration, +playback_configuration_arn, +playback_endpoint_prefix, +slate_ad_url, +transcode_profile_name, +video_content_source_url, +tag_key, +tag_value +FROM aws.mediatailor.playback_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_configuration_tags resource, see playback_configurations + diff --git a/website/docs/services/mediatailor/playback_configurations/index.md b/website/docs/services/mediatailor/playback_configurations/index.md new file mode 100644 index 0000000..e8e8b6c --- /dev/null +++ b/website/docs/services/mediatailor/playback_configurations/index.md @@ -0,0 +1,330 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a playback_configuration resource or lists playback_configurations in a region + +## Overview + + + + + + + +
Nameplayback_configurations
TypeResource
DescriptionResource schema for AWS::MediaTailor::PlaybackConfiguration
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
objectThe configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
objectThe configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).
objectThe configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
undefinedThe player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
objectThe configuration for DASH content.
objectThe configuration for pre-roll ad insertion.
objectThe configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
stringThe identifier for the playback configuration.
integerDefines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
stringThe URL that the player uses to initialize a session that uses client-side reporting.
objectThe configuration for HLS content.
stringThe Amazon Resource Name (ARN) for the playback configuration.
stringThe URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.
stringThe URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
arrayThe tags to assign to the playback configuration.
stringThe name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
stringThe URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
stringAWS region.
+ +For more information, see AWS::MediaTailor::PlaybackConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all playback_configurations in a region. +```sql +SELECT +region, +ad_decision_server_url, +avail_suppression, +bumper, +cdn_configuration, +configuration_aliases, +dash_configuration, +live_pre_roll_configuration, +manifest_processing_rules, +name, +personalization_threshold_seconds, +session_initialization_endpoint_prefix, +hls_configuration, +playback_configuration_arn, +playback_endpoint_prefix, +slate_ad_url, +tags, +transcode_profile_name, +video_content_source_url +FROM aws.mediatailor.playback_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual playback_configuration. +```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_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new playback_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.playback_configurations ( + AdDecisionServerUrl, + Name, + VideoContentSourceUrl, + region +) +SELECT +'{{ AdDecisionServerUrl }}', + '{{ Name }}', + '{{ VideoContentSourceUrl }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.playback_configurations ( + AdDecisionServerUrl, + AvailSuppression, + Bumper, + CdnConfiguration, + ConfigurationAliases, + DashConfiguration, + LivePreRollConfiguration, + ManifestProcessingRules, + Name, + PersonalizationThresholdSeconds, + HlsConfiguration, + SlateAdUrl, + Tags, + TranscodeProfileName, + VideoContentSourceUrl, + region +) +SELECT + '{{ AdDecisionServerUrl }}', + '{{ AvailSuppression }}', + '{{ Bumper }}', + '{{ CdnConfiguration }}', + '{{ ConfigurationAliases }}', + '{{ DashConfiguration }}', + '{{ LivePreRollConfiguration }}', + '{{ ManifestProcessingRules }}', + '{{ Name }}', + '{{ PersonalizationThresholdSeconds }}', + '{{ HlsConfiguration }}', + '{{ SlateAdUrl }}', + '{{ Tags }}', + '{{ TranscodeProfileName }}', + '{{ VideoContentSourceUrl }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: playback_configuration + props: + - name: AdDecisionServerUrl + value: '{{ AdDecisionServerUrl }}' + - name: AvailSuppression + value: + Mode: '{{ Mode }}' + Value: '{{ Value }}' + FillPolicy: '{{ FillPolicy }}' + - name: Bumper + value: + StartUrl: '{{ StartUrl }}' + EndUrl: '{{ EndUrl }}' + - name: CdnConfiguration + value: + AdSegmentUrlPrefix: '{{ AdSegmentUrlPrefix }}' + ContentSegmentUrlPrefix: '{{ ContentSegmentUrlPrefix }}' + - name: ConfigurationAliases + value: null + - name: DashConfiguration + value: + MpdLocation: '{{ MpdLocation }}' + OriginManifestType: '{{ OriginManifestType }}' + ManifestEndpointPrefix: '{{ ManifestEndpointPrefix }}' + - name: LivePreRollConfiguration + value: + AdDecisionServerUrl: '{{ AdDecisionServerUrl }}' + MaxDurationSeconds: '{{ MaxDurationSeconds }}' + - name: ManifestProcessingRules + value: + AdMarkerPassthrough: + Enabled: '{{ Enabled }}' + - name: Name + value: '{{ Name }}' + - name: PersonalizationThresholdSeconds + value: '{{ PersonalizationThresholdSeconds }}' + - name: HlsConfiguration + value: + ManifestEndpointPrefix: '{{ ManifestEndpointPrefix }}' + - name: SlateAdUrl + value: '{{ SlateAdUrl }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TranscodeProfileName + value: '{{ TranscodeProfileName }}' + - name: VideoContentSourceUrl + value: '{{ VideoContentSourceUrl }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediatailor.playback_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediatailor:GetPlaybackConfiguration +``` + +### Update +```json +mediatailor:PutPlaybackConfiguration, +mediatailor:ConfigureLogsForPlaybackConfiguration, +iam:CreateServiceLinkedRole, +mediatailor:UntagResource, +mediatailor:TagResource +``` + +### Delete +```json +mediatailor:DeletePlaybackConfiguration +``` + +### List +```json +mediatailor:ListPlaybackConfigurations +``` diff --git a/website/docs/services/mediatailor/playback_configurations_list_only/index.md b/website/docs/services/mediatailor/playback_configurations_list_only/index.md new file mode 100644 index 0000000..b7fd332 --- /dev/null +++ b/website/docs/services/mediatailor/playback_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: playback_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - playback_configurations_list_only + - mediatailor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists playback_configurations in a region or regions, for all properties use playback_configurations + +## Overview + + + + + + + +
Nameplayback_configurations_list_only
TypeResource
DescriptionResource schema for AWS::MediaTailor::PlaybackConfiguration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier for the playback configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all playback_configurations in a region. +```sql +SELECT +region, +name +FROM aws.mediatailor.playback_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_configurations_list_only resource, see playback_configurations + diff --git a/website/docs/services/mediatailor/source_location_tags/index.md b/website/docs/services/mediatailor/source_location_tags/index.md new file mode 100644 index 0000000..691a4d1 --- /dev/null +++ b/website/docs/services/mediatailor/source_location_tags/index.md @@ -0,0 +1,87 @@ +--- +title: source_location_tags +hide_title: false +hide_table_of_contents: false +keywords: + - source_location_tags + - mediatailor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for source_locations in a region + +## Overview + + + + + + + +
Namesource_location_tags
TypeResource
DescriptionDefinition of AWS::MediaTailor::SourceLocation Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
object

Access configuration parameters.

string

The ARN of the source location.

object

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

object

The HTTP configuration for the source location.

array

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

string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all source_locations in a region. +```sql +SELECT +region, +access_configuration, +arn, +default_segment_delivery_configuration, +http_configuration, +segment_delivery_configurations, +source_location_name, +tag_key, +tag_value +FROM aws.mediatailor.source_location_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the source_location_tags resource, see source_locations + diff --git a/website/docs/services/mediatailor/source_locations/index.md b/website/docs/services/mediatailor/source_locations/index.md new file mode 100644 index 0000000..8ceef9a --- /dev/null +++ b/website/docs/services/mediatailor/source_locations/index.md @@ -0,0 +1,257 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a source_location resource or lists source_locations in a region + +## Overview + + + + + + + +
Namesource_locations
TypeResource
DescriptionDefinition of AWS::MediaTailor::SourceLocation Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
object

Access configuration parameters.

string

The ARN of the source location.

object

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

object

The HTTP configuration for the source location.

array

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

string
arrayThe tags to assign to the source location.
stringAWS region.
+ +For more information, see AWS::MediaTailor::SourceLocation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all source_locations in a region. +```sql +SELECT +region, +access_configuration, +arn, +default_segment_delivery_configuration, +http_configuration, +segment_delivery_configurations, +source_location_name, +tags +FROM aws.mediatailor.source_locations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual source_location. +```sql +SELECT +region, +access_configuration, +arn, +default_segment_delivery_configuration, +http_configuration, +segment_delivery_configurations, +source_location_name, +tags +FROM aws.mediatailor.source_locations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new source_location resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.source_locations ( + HttpConfiguration, + SourceLocationName, + region +) +SELECT +'{{ HttpConfiguration }}', + '{{ SourceLocationName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.source_locations ( + AccessConfiguration, + DefaultSegmentDeliveryConfiguration, + HttpConfiguration, + SegmentDeliveryConfigurations, + SourceLocationName, + Tags, + region +) +SELECT + '{{ AccessConfiguration }}', + '{{ DefaultSegmentDeliveryConfiguration }}', + '{{ HttpConfiguration }}', + '{{ SegmentDeliveryConfigurations }}', + '{{ SourceLocationName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: source_location + props: + - name: AccessConfiguration + value: + AccessType: '{{ AccessType }}' + SecretsManagerAccessTokenConfiguration: + HeaderName: '{{ HeaderName }}' + SecretArn: '{{ SecretArn }}' + SecretStringKey: '{{ SecretStringKey }}' + - name: DefaultSegmentDeliveryConfiguration + value: + BaseUrl: '{{ BaseUrl }}' + - name: HttpConfiguration + value: + BaseUrl: '{{ BaseUrl }}' + - name: SegmentDeliveryConfigurations + value: + - BaseUrl: '{{ BaseUrl }}' + Name: '{{ Name }}' + - name: SourceLocationName + value: '{{ SourceLocationName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediatailor.source_locations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +mediatailor:ListSourceLocations +``` diff --git a/website/docs/services/mediatailor/source_locations_list_only/index.md b/website/docs/services/mediatailor/source_locations_list_only/index.md new file mode 100644 index 0000000..5ac42d2 --- /dev/null +++ b/website/docs/services/mediatailor/source_locations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: source_locations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - source_locations_list_only + - mediatailor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists source_locations in a region or regions, for all properties use source_locations + +## Overview + + + + + + + +
Namesource_locations_list_only
TypeResource
DescriptionDefinition of AWS::MediaTailor::SourceLocation Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all source_locations in a region. +```sql +SELECT +region, +source_location_name +FROM aws.mediatailor.source_locations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the source_locations_list_only resource, see source_locations + diff --git a/website/docs/services/mediatailor/vod_source_tags/index.md b/website/docs/services/mediatailor/vod_source_tags/index.md new file mode 100644 index 0000000..3721b5b --- /dev/null +++ b/website/docs/services/mediatailor/vod_source_tags/index.md @@ -0,0 +1,83 @@ +--- +title: vod_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vod_source_tags + - mediatailor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vod_sources in a region + +## Overview + + + + + + + +
Namevod_source_tags
TypeResource
DescriptionDefinition of AWS::MediaTailor::VodSource Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string

The ARN of the VOD source.

array

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

string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vod_sources in a region. +```sql +SELECT +region, +arn, +http_package_configurations, +source_location_name, +vod_source_name, +tag_key, +tag_value +FROM aws.mediatailor.vod_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vod_source_tags resource, see vod_sources + diff --git a/website/docs/services/mediatailor/vod_sources/index.md b/website/docs/services/mediatailor/vod_sources/index.md new file mode 100644 index 0000000..8b486bf --- /dev/null +++ b/website/docs/services/mediatailor/vod_sources/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vod_source resource or lists vod_sources in a region + +## Overview + + + + + + + +
Namevod_sources
TypeResource
DescriptionDefinition of AWS::MediaTailor::VodSource Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string

The ARN of the VOD source.

array

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

string
arrayThe tags to assign to the VOD source.
string
stringAWS region.
+ +For more information, see AWS::MediaTailor::VodSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vod_sources in a region. +```sql +SELECT +region, +arn, +http_package_configurations, +source_location_name, +tags, +vod_source_name +FROM aws.mediatailor.vod_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vod_source. +```sql +SELECT +region, +arn, +http_package_configurations, +source_location_name, +tags, +vod_source_name +FROM aws.mediatailor.vod_sources +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vod_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.vod_sources ( + HttpPackageConfigurations, + SourceLocationName, + VodSourceName, + region +) +SELECT +'{{ HttpPackageConfigurations }}', + '{{ SourceLocationName }}', + '{{ VodSourceName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mediatailor.vod_sources ( + HttpPackageConfigurations, + SourceLocationName, + Tags, + VodSourceName, + region +) +SELECT + '{{ HttpPackageConfigurations }}', + '{{ SourceLocationName }}', + '{{ Tags }}', + '{{ VodSourceName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vod_source + props: + - name: HttpPackageConfigurations + value: + - Path: '{{ Path }}' + SourceGroup: '{{ SourceGroup }}' + Type: '{{ Type }}' + - name: SourceLocationName + value: '{{ SourceLocationName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VodSourceName + value: '{{ VodSourceName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mediatailor.vod_sources +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +mediatailor:DescribeVodSource +``` + +### Update +```json +mediatailor:DescribeVodSource, +mediatailor:TagResource, +mediatailor:UntagResource, +mediatailor:UpdateVodSource +``` + +### Delete +```json +mediatailor:DeleteVodSource, +mediatailor:DescribeVodSource +``` + +### List +```json +mediatailor:ListVodSources +``` diff --git a/website/docs/services/mediatailor/vod_sources_list_only/index.md b/website/docs/services/mediatailor/vod_sources_list_only/index.md new file mode 100644 index 0000000..cf70618 --- /dev/null +++ b/website/docs/services/mediatailor/vod_sources_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: vod_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vod_sources_list_only + - mediatailor + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vod_sources in a region or regions, for all properties use vod_sources + +## Overview + + + + + + + +
Namevod_sources_list_only
TypeResource
DescriptionDefinition of AWS::MediaTailor::VodSource Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vod_sources in a region. +```sql +SELECT +region, +source_location_name, +vod_source_name +FROM aws.mediatailor.vod_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vod_sources_list_only resource, see vod_sources + diff --git a/website/docs/services/memorydb/acl_tags/index.md b/website/docs/services/memorydb/acl_tags/index.md new file mode 100644 index 0000000..bc3cbf3 --- /dev/null +++ b/website/docs/services/memorydb/acl_tags/index.md @@ -0,0 +1,83 @@ +--- +title: acl_tags +hide_title: false +hide_table_of_contents: false +keywords: + - acl_tags + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for acls in a region + +## Overview + + + + + + + +
Nameacl_tags
TypeResource
DescriptionResource Type definition for AWS::MemoryDB::ACL
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringIndicates acl status. Can be "creating", "active", "modifying", "deleting".
stringThe name of the acl.
arrayList of users associated to this acl.
stringThe Amazon Resource Name (ARN) of the acl.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all acls in a region. +```sql +SELECT +region, +status, +acl_name, +user_names, +arn, +tag_key, +tag_value +FROM aws.memorydb.acl_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the acl_tags resource, see acls + diff --git a/website/docs/services/memorydb/acls/index.md b/website/docs/services/memorydb/acls/index.md new file mode 100644 index 0000000..7010586 --- /dev/null +++ b/website/docs/services/memorydb/acls/index.md @@ -0,0 +1,228 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an acl resource or lists acls in a region + +## Overview + + + + + + + +
Nameacls
TypeResource
DescriptionResource Type definition for AWS::MemoryDB::ACL
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringIndicates acl status. Can be "creating", "active", "modifying", "deleting".
stringThe name of the acl.
arrayList of users associated to this acl.
stringThe Amazon Resource Name (ARN) of the acl.
arrayAn array of key-value pairs to apply to this cluster.
stringAWS region.
+ +For more information, see AWS::MemoryDB::ACL. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all acls in a region. +```sql +SELECT +region, +status, +acl_name, +user_names, +arn, +tags +FROM aws.memorydb.acls +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual acl. +```sql +SELECT +region, +status, +acl_name, +user_names, +arn, +tags +FROM aws.memorydb.acls +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new acl resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.acls ( + ACLName, + region +) +SELECT +'{{ ACLName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.acls ( + ACLName, + UserNames, + Tags, + region +) +SELECT + '{{ ACLName }}', + '{{ UserNames }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: acl + props: + - name: ACLName + value: '{{ ACLName }}' + - name: UserNames + value: + - '{{ UserNames[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.memorydb.acls +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +memorydb:DescribeACLs, +memorydb:ListTags +``` diff --git a/website/docs/services/memorydb/acls_list_only/index.md b/website/docs/services/memorydb/acls_list_only/index.md new file mode 100644 index 0000000..286acd3 --- /dev/null +++ b/website/docs/services/memorydb/acls_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: acls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - acls_list_only + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists acls in a region or regions, for all properties use acls + +## Overview + + + + + + + +
Nameacls_list_only
TypeResource
DescriptionResource Type definition for AWS::MemoryDB::ACL
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the acl.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all acls in a region. +```sql +SELECT +region, +acl_name +FROM aws.memorydb.acls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the acls_list_only resource, see acls + diff --git a/website/docs/services/memorydb/cluster_tags/index.md b/website/docs/services/memorydb/cluster_tags/index.md new file mode 100644 index 0000000..600f724 --- /dev/null +++ b/website/docs/services/memorydb/cluster_tags/index.md @@ -0,0 +1,133 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + + + +
Namecluster_tags
TypeResource
DescriptionThe AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
stringAn optional description of the cluster.
stringThe name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
stringThe status of the cluster. For example, Available, Updating, Creating.
stringThe compute and memory capacity of the nodes in the cluster.
integerThe number of shards the cluster will contain.
integerThe number of replicas to apply to each shard. The limit is 5.
stringThe name of the subnet group to be used for the cluster.
arrayOne or more Amazon VPC security groups associated with this cluster.
stringSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
stringThe name of the parameter group associated with the cluster.
stringThe status of the parameter group used by the cluster.
integerThe port number on which each member of the cluster accepts connections.
integerThe number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
stringThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
stringThe name of the Access Control List to associate with the cluster.
stringThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
stringThe status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
booleanA flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
objectEnables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.
stringThe ID of the KMS key used to encrypt the cluster.
arrayA list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
stringThe name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
stringThe user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
stringThe Amazon Resource Name (ARN) of the cluster.
stringThe engine type used by the cluster.
stringThe Redis engine version used by the cluster.
objectThe cluster endpoint.
booleanA flag that enables automatic minor version upgrade when set to true.
You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +cluster_name, +description, +multi_region_cluster_name, +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, +engine_version, +cluster_endpoint, +auto_minor_version_upgrade, +tag_key, +tag_value +FROM aws.memorydb.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + diff --git a/website/docs/services/memorydb/clusters/index.md b/website/docs/services/memorydb/clusters/index.md new file mode 100644 index 0000000..f1d0b3c --- /dev/null +++ b/website/docs/services/memorydb/clusters/index.md @@ -0,0 +1,406 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster resource or lists clusters in a region + +## Overview + + + + + + + +
Nameclusters
TypeResource
DescriptionThe AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
stringAn optional description of the cluster.
stringThe name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
stringThe status of the cluster. For example, Available, Updating, Creating.
stringThe compute and memory capacity of the nodes in the cluster.
integerThe number of shards the cluster will contain.
integerThe number of replicas to apply to each shard. The limit is 5.
stringThe name of the subnet group to be used for the cluster.
arrayOne or more Amazon VPC security groups associated with this cluster.
stringSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
stringThe name of the parameter group associated with the cluster.
stringThe status of the parameter group used by the cluster.
integerThe port number on which each member of the cluster accepts connections.
integerThe number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
stringThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
stringThe name of the Access Control List to associate with the cluster.
stringThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
stringThe status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
booleanA flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
objectEnables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.
stringThe ID of the KMS key used to encrypt the cluster.
arrayA list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
stringThe name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
stringThe user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
stringThe Amazon Resource Name (ARN) of the cluster.
stringThe engine type used by the cluster.
stringThe Redis engine version used by the cluster.
objectThe cluster endpoint.
booleanA flag that enables automatic minor version upgrade when set to true.
You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.
arrayAn array of key-value pairs to apply to this cluster.
stringAWS region.
+ +For more information, see AWS::MemoryDB::Cluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all clusters in a region. +```sql +SELECT +region, +cluster_name, +description, +multi_region_cluster_name, +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, +engine_version, +cluster_endpoint, +auto_minor_version_upgrade, +tags +FROM aws.memorydb.clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster. +```sql +SELECT +region, +cluster_name, +description, +multi_region_cluster_name, +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, +engine_version, +cluster_endpoint, +auto_minor_version_upgrade, +tags +FROM aws.memorydb.clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.clusters ( + ClusterName, + NodeType, + ACLName, + region +) +SELECT +'{{ ClusterName }}', + '{{ NodeType }}', + '{{ ACLName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.clusters ( + ClusterName, + Description, + MultiRegionClusterName, + NodeType, + NumShards, + NumReplicasPerShard, + SubnetGroupName, + SecurityGroupIds, + MaintenanceWindow, + ParameterGroupName, + Port, + SnapshotRetentionLimit, + SnapshotWindow, + ACLName, + SnsTopicArn, + SnsTopicStatus, + TLSEnabled, + DataTiering, + KmsKeyId, + SnapshotArns, + SnapshotName, + FinalSnapshotName, + Engine, + EngineVersion, + ClusterEndpoint, + AutoMinorVersionUpgrade, + Tags, + region +) +SELECT + '{{ ClusterName }}', + '{{ Description }}', + '{{ MultiRegionClusterName }}', + '{{ NodeType }}', + '{{ NumShards }}', + '{{ NumReplicasPerShard }}', + '{{ SubnetGroupName }}', + '{{ SecurityGroupIds }}', + '{{ MaintenanceWindow }}', + '{{ ParameterGroupName }}', + '{{ Port }}', + '{{ SnapshotRetentionLimit }}', + '{{ SnapshotWindow }}', + '{{ ACLName }}', + '{{ SnsTopicArn }}', + '{{ SnsTopicStatus }}', + '{{ TLSEnabled }}', + '{{ DataTiering }}', + '{{ KmsKeyId }}', + '{{ SnapshotArns }}', + '{{ SnapshotName }}', + '{{ FinalSnapshotName }}', + '{{ Engine }}', + '{{ EngineVersion }}', + '{{ ClusterEndpoint }}', + '{{ AutoMinorVersionUpgrade }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster + props: + - name: ClusterName + value: '{{ ClusterName }}' + - name: Description + value: '{{ Description }}' + - name: MultiRegionClusterName + value: '{{ MultiRegionClusterName }}' + - name: NodeType + value: '{{ NodeType }}' + - name: NumShards + value: '{{ NumShards }}' + - name: NumReplicasPerShard + value: '{{ NumReplicasPerShard }}' + - name: SubnetGroupName + value: '{{ SubnetGroupName }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: MaintenanceWindow + value: '{{ MaintenanceWindow }}' + - name: ParameterGroupName + value: '{{ ParameterGroupName }}' + - name: Port + value: '{{ Port }}' + - name: SnapshotRetentionLimit + value: '{{ SnapshotRetentionLimit }}' + - name: SnapshotWindow + value: '{{ SnapshotWindow }}' + - name: ACLName + value: '{{ ACLName }}' + - name: SnsTopicArn + value: '{{ SnsTopicArn }}' + - name: SnsTopicStatus + value: '{{ SnsTopicStatus }}' + - name: TLSEnabled + value: '{{ TLSEnabled }}' + - name: DataTiering + value: '{{ DataTiering }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: SnapshotArns + value: + - '{{ SnapshotArns[0] }}' + - name: SnapshotName + value: '{{ SnapshotName }}' + - name: FinalSnapshotName + value: '{{ FinalSnapshotName }}' + - name: Engine + value: '{{ Engine }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: ClusterEndpoint + value: + Address: '{{ Address }}' + Port: '{{ Port }}' + - name: AutoMinorVersionUpgrade + value: '{{ AutoMinorVersionUpgrade }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.memorydb.clusters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +```json +kms:DescribeKey, +kms:CreateGrant, +memorydb:CreateCluster, +memorydb:DescribeClusters, +memorydb:TagResource, +memorydb:ListTags +``` + +### Read +```json +memorydb:DescribeClusters, +memorydb:ListTags +``` + +### Update +```json +memorydb:UpdateCluster, +memorydb:DescribeClusters, +memorydb:ListTags, +memorydb:TagResource, +memorydb:UntagResource +``` + +### Delete +```json +memorydb:DeleteCluster, +memorydb:DescribeClusters +``` + +### List +```json +memorydb:DescribeClusters +``` diff --git a/website/docs/services/memorydb/clusters_list_only/index.md b/website/docs/services/memorydb/clusters_list_only/index.md new file mode 100644 index 0000000..ae47350 --- /dev/null +++ b/website/docs/services/memorydb/clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + + + +
Nameclusters_list_only
TypeResource
DescriptionThe AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +cluster_name +FROM aws.memorydb.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + diff --git a/website/docs/services/memorydb/index.md b/website/docs/services/memorydb/index.md new file mode 100644 index 0000000..8066ad3 --- /dev/null +++ b/website/docs/services/memorydb/index.md @@ -0,0 +1,53 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The memorydb service documentation. + +:::info Service Summary + +
+
+total resources: 18
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/memorydb/multi_region_cluster_tags/index.md b/website/docs/services/memorydb/multi_region_cluster_tags/index.md new file mode 100644 index 0000000..8985701 --- /dev/null +++ b/website/docs/services/memorydb/multi_region_cluster_tags/index.md @@ -0,0 +1,99 @@ +--- +title: multi_region_cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - multi_region_cluster_tags + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for multi_region_clusters in a region + +## Overview + + + + + + + +
Namemulti_region_cluster_tags
TypeResource
DescriptionThe AWS::MemoryDB::Multi Region Cluster resource creates an Amazon MemoryDB Multi Region Cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
stringDescription of the multi region cluster.
stringThe name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
stringThe status of the multi region cluster. For example, Available, Updating, Creating.
stringThe compute and memory capacity of the nodes in the multi region cluster.
integerThe number of shards the multi region cluster will contain.
stringThe name of the parameter group associated with the multi region cluster.
booleanA flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
stringThe Amazon Resource Name (ARN) of the multi region cluster.
stringThe engine type used by the multi region cluster.
stringThe Redis engine version used by the multi region cluster.
stringAn enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all multi_region_clusters in a region. +```sql +SELECT +region, +multi_region_cluster_name_suffix, +description, +multi_region_cluster_name, +status, +node_type, +num_shards, +multi_region_parameter_group_name, +tls_enabled, +arn, +engine, +engine_version, +update_strategy, +tag_key, +tag_value +FROM aws.memorydb.multi_region_cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multi_region_cluster_tags resource, see multi_region_clusters + diff --git a/website/docs/services/memorydb/multi_region_clusters/index.md b/website/docs/services/memorydb/multi_region_clusters/index.md new file mode 100644 index 0000000..8e98d69 --- /dev/null +++ b/website/docs/services/memorydb/multi_region_clusters/index.md @@ -0,0 +1,277 @@ +--- +title: multi_region_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - multi_region_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a multi_region_cluster resource or lists multi_region_clusters in a region + +## Overview + + + + + + + +
Namemulti_region_clusters
TypeResource
DescriptionThe AWS::MemoryDB::Multi Region Cluster resource creates an Amazon MemoryDB Multi Region Cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
stringDescription of the multi region cluster.
stringThe name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
stringThe status of the multi region cluster. For example, Available, Updating, Creating.
stringThe compute and memory capacity of the nodes in the multi region cluster.
integerThe number of shards the multi region cluster will contain.
stringThe name of the parameter group associated with the multi region cluster.
booleanA flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
stringThe Amazon Resource Name (ARN) of the multi region cluster.
stringThe engine type used by the multi region cluster.
stringThe Redis engine version used by the multi region cluster.
arrayAn array of key-value pairs to apply to this multi region cluster.
stringAn enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
stringAWS region.
+ +For more information, see AWS::MemoryDB::MultiRegionCluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all multi_region_clusters in a region. +```sql +SELECT +region, +multi_region_cluster_name_suffix, +description, +multi_region_cluster_name, +status, +node_type, +num_shards, +multi_region_parameter_group_name, +tls_enabled, +arn, +engine, +engine_version, +tags, +update_strategy +FROM aws.memorydb.multi_region_clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual multi_region_cluster. +```sql +SELECT +region, +multi_region_cluster_name_suffix, +description, +multi_region_cluster_name, +status, +node_type, +num_shards, +multi_region_parameter_group_name, +tls_enabled, +arn, +engine, +engine_version, +tags, +update_strategy +FROM aws.memorydb.multi_region_clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new multi_region_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.multi_region_clusters ( + NodeType, + region +) +SELECT +'{{ NodeType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.multi_region_clusters ( + MultiRegionClusterNameSuffix, + Description, + NodeType, + NumShards, + MultiRegionParameterGroupName, + TLSEnabled, + Engine, + EngineVersion, + Tags, + UpdateStrategy, + region +) +SELECT + '{{ MultiRegionClusterNameSuffix }}', + '{{ Description }}', + '{{ NodeType }}', + '{{ NumShards }}', + '{{ MultiRegionParameterGroupName }}', + '{{ TLSEnabled }}', + '{{ Engine }}', + '{{ EngineVersion }}', + '{{ Tags }}', + '{{ UpdateStrategy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: multi_region_cluster + props: + - name: MultiRegionClusterNameSuffix + value: '{{ MultiRegionClusterNameSuffix }}' + - name: Description + value: '{{ Description }}' + - name: NodeType + value: '{{ NodeType }}' + - name: NumShards + value: '{{ NumShards }}' + - name: MultiRegionParameterGroupName + value: '{{ MultiRegionParameterGroupName }}' + - name: TLSEnabled + value: '{{ TLSEnabled }}' + - name: Engine + value: '{{ Engine }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: UpdateStrategy + value: '{{ UpdateStrategy }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.memorydb.multi_region_clusters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the multi_region_clusters resource, the following permissions are required: + +### Create +```json +memorydb:CreateMultiRegionCluster, +memorydb:DescribeMultiRegionClusters, +memorydb:TagResource, +memorydb:ListTags +``` + +### Read +```json +memorydb:DescribeMultiRegionClusters, +memorydb:ListTags +``` + +### Update +```json +memorydb:UpdateMultiRegionCluster, +memorydb:DescribeMultiRegionClusters, +memorydb:ListTags, +memorydb:TagResource, +memorydb:UntagResource +``` + +### Delete +```json +memorydb:DeleteMultiRegionCluster, +memorydb:DescribeMultiRegionClusters +``` + +### List +```json +memorydb:DescribeMultiRegionClusters +``` diff --git a/website/docs/services/memorydb/multi_region_clusters_list_only/index.md b/website/docs/services/memorydb/multi_region_clusters_list_only/index.md new file mode 100644 index 0000000..ac79cd4 --- /dev/null +++ b/website/docs/services/memorydb/multi_region_clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: multi_region_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - multi_region_clusters_list_only + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists multi_region_clusters in a region or regions, for all properties use multi_region_clusters + +## Overview + + + + + + + +
Namemulti_region_clusters_list_only
TypeResource
DescriptionThe AWS::MemoryDB::Multi Region Cluster resource creates an Amazon MemoryDB Multi Region Cluster.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all multi_region_clusters in a region. +```sql +SELECT +region, +multi_region_cluster_name +FROM aws.memorydb.multi_region_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multi_region_clusters_list_only resource, see multi_region_clusters + diff --git a/website/docs/services/memorydb/parameter_group_tags/index.md b/website/docs/services/memorydb/parameter_group_tags/index.md new file mode 100644 index 0000000..2d52a8f --- /dev/null +++ b/website/docs/services/memorydb/parameter_group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: parameter_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_group_tags + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for parameter_groups in a region + +## Overview + + + + + + + +
Nameparameter_group_tags
TypeResource
DescriptionThe AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the parameter group.
stringThe name of the parameter group family that this parameter group is compatible with.
stringA description of the parameter group.
objectAn map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional.
stringThe Amazon Resource Name (ARN) of the parameter group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all parameter_groups in a region. +```sql +SELECT +region, +parameter_group_name, +family, +description, +parameters, +arn, +tag_key, +tag_value +FROM aws.memorydb.parameter_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameter_group_tags resource, see parameter_groups + diff --git a/website/docs/services/memorydb/parameter_groups/index.md b/website/docs/services/memorydb/parameter_groups/index.md new file mode 100644 index 0000000..de58f63 --- /dev/null +++ b/website/docs/services/memorydb/parameter_groups/index.md @@ -0,0 +1,239 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a parameter_group resource or lists parameter_groups in a region + +## Overview + + + + + + + +
Nameparameter_groups
TypeResource
DescriptionThe AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the parameter group.
stringThe name of the parameter group family that this parameter group is compatible with.
stringA description of the parameter group.
arrayAn array of key-value pairs to apply to this parameter group.
objectAn map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional.
stringThe Amazon Resource Name (ARN) of the parameter group.
stringAWS region.
+ +For more information, see AWS::MemoryDB::ParameterGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all parameter_groups in a region. +```sql +SELECT +region, +parameter_group_name, +family, +description, +tags, +parameters, +arn +FROM aws.memorydb.parameter_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual parameter_group. +```sql +SELECT +region, +parameter_group_name, +family, +description, +tags, +parameters, +arn +FROM aws.memorydb.parameter_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new parameter_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.parameter_groups ( + ParameterGroupName, + Family, + region +) +SELECT +'{{ ParameterGroupName }}', + '{{ Family }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.parameter_groups ( + ParameterGroupName, + Family, + Description, + Tags, + Parameters, + region +) +SELECT + '{{ ParameterGroupName }}', + '{{ Family }}', + '{{ Description }}', + '{{ Tags }}', + '{{ Parameters }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: parameter_group + props: + - name: ParameterGroupName + value: '{{ ParameterGroupName }}' + - name: Family + value: '{{ Family }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Parameters + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.memorydb.parameter_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +memorydb:DescribeParameterGroups +``` diff --git a/website/docs/services/memorydb/parameter_groups_list_only/index.md b/website/docs/services/memorydb/parameter_groups_list_only/index.md new file mode 100644 index 0000000..8b4059d --- /dev/null +++ b/website/docs/services/memorydb/parameter_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: parameter_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_groups_list_only + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists parameter_groups in a region or regions, for all properties use parameter_groups + +## Overview + + + + + + + +
Nameparameter_groups_list_only
TypeResource
DescriptionThe AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the parameter group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all parameter_groups in a region. +```sql +SELECT +region, +parameter_group_name +FROM aws.memorydb.parameter_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameter_groups_list_only resource, see parameter_groups + diff --git a/website/docs/services/memorydb/subnet_group_tags/index.md b/website/docs/services/memorydb/subnet_group_tags/index.md new file mode 100644 index 0000000..4d5120b --- /dev/null +++ b/website/docs/services/memorydb/subnet_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: subnet_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_group_tags + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for subnet_groups in a region + +## Overview + + + + + + + +
Namesubnet_group_tags
TypeResource
DescriptionThe AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
stringAn optional description of the subnet group.
arrayA list of VPC subnet IDs for the subnet group.
stringThe Amazon Resource Name (ARN) of the subnet group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all subnet_groups in a region. +```sql +SELECT +region, +subnet_group_name, +description, +subnet_ids, +arn, +tag_key, +tag_value +FROM aws.memorydb.subnet_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_group_tags resource, see subnet_groups + diff --git a/website/docs/services/memorydb/subnet_groups/index.md b/website/docs/services/memorydb/subnet_groups/index.md new file mode 100644 index 0000000..9eca3a3 --- /dev/null +++ b/website/docs/services/memorydb/subnet_groups/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a subnet_group resource or lists subnet_groups in a region + +## Overview + + + + + + + +
Namesubnet_groups
TypeResource
DescriptionThe AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
stringAn optional description of the subnet group.
arrayA list of VPC subnet IDs for the subnet group.
arrayAn array of key-value pairs to apply to this subnet group.
stringThe Amazon Resource Name (ARN) of the subnet group.
stringAWS region.
+ +For more information, see AWS::MemoryDB::SubnetGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all subnet_groups in a region. +```sql +SELECT +region, +subnet_group_name, +description, +subnet_ids, +tags, +arn +FROM aws.memorydb.subnet_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual subnet_group. +```sql +SELECT +region, +subnet_group_name, +description, +subnet_ids, +tags, +arn +FROM aws.memorydb.subnet_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new subnet_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.subnet_groups ( + SubnetGroupName, + SubnetIds, + region +) +SELECT +'{{ SubnetGroupName }}', + '{{ SubnetIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.subnet_groups ( + SubnetGroupName, + Description, + SubnetIds, + Tags, + region +) +SELECT + '{{ SubnetGroupName }}', + '{{ Description }}', + '{{ SubnetIds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: subnet_group + props: + - name: SubnetGroupName + value: '{{ SubnetGroupName }}' + - name: Description + value: '{{ Description }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.memorydb.subnet_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +memorydb:DescribeSubnetGroups, +memorydb:ListTags +``` + +### Update +```json +memorydb:UpdateSubnetGroup, +memorydb:DescribeSubnetGroups, +memorydb:ListTags, +memorydb:TagResource, +memorydb:UntagResource +``` + +### Delete +```json +memorydb:DeleteSubnetGroup, +memorydb:DescribeSubnetGroups +``` + +### List +```json +memorydb:DescribeSubnetGroups +``` diff --git a/website/docs/services/memorydb/subnet_groups_list_only/index.md b/website/docs/services/memorydb/subnet_groups_list_only/index.md new file mode 100644 index 0000000..d2c7dad --- /dev/null +++ b/website/docs/services/memorydb/subnet_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: subnet_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_groups_list_only + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnet_groups in a region or regions, for all properties use subnet_groups + +## Overview + + + + + + + +
Namesubnet_groups_list_only
TypeResource
DescriptionThe AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnet_groups in a region. +```sql +SELECT +region, +subnet_group_name +FROM aws.memorydb.subnet_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_groups_list_only resource, see subnet_groups + diff --git a/website/docs/services/memorydb/user_tags/index.md b/website/docs/services/memorydb/user_tags/index.md new file mode 100644 index 0000000..49cc8d5 --- /dev/null +++ b/website/docs/services/memorydb/user_tags/index.md @@ -0,0 +1,85 @@ +--- +title: user_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_tags + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for users in a region + +## Overview + + + + + + + +
Nameuser_tags
TypeResource
DescriptionResource Type definition for AWS::MemoryDB::User
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringIndicates the user status. Can be "active", "modifying" or "deleting".
stringThe name of the user.
stringAccess permissions string used for this user account.
object
stringThe Amazon Resource Name (ARN) of the user account.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all users in a region. +```sql +SELECT +region, +status, +user_name, +access_string, +authentication_mode, +arn, +tag_key, +tag_value +FROM aws.memorydb.user_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_tags resource, see users + diff --git a/website/docs/services/memorydb/users/index.md b/website/docs/services/memorydb/users/index.md new file mode 100644 index 0000000..8bfbfea --- /dev/null +++ b/website/docs/services/memorydb/users/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a user resource or lists users in a region + +## Overview + + + + + + + +
Nameusers
TypeResource
DescriptionResource Type definition for AWS::MemoryDB::User
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringIndicates the user status. Can be "active", "modifying" or "deleting".
stringThe name of the user.
stringAccess permissions string used for this user account.
object
stringThe Amazon Resource Name (ARN) of the user account.
arrayAn array of key-value pairs to apply to this user.
stringAWS region.
+ +For more information, see AWS::MemoryDB::User. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all users in a region. +```sql +SELECT +region, +status, +user_name, +access_string, +authentication_mode, +arn, +tags +FROM aws.memorydb.users +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user. +```sql +SELECT +region, +status, +user_name, +access_string, +authentication_mode, +arn, +tags +FROM aws.memorydb.users +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.users ( + UserName, + region +) +SELECT +'{{ UserName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.memorydb.users ( + UserName, + AccessString, + AuthenticationMode, + Tags, + region +) +SELECT + '{{ UserName }}', + '{{ AccessString }}', + '{{ AuthenticationMode }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user + props: + - name: UserName + value: '{{ UserName }}' + - name: AccessString + value: '{{ AccessString }}' + - name: AuthenticationMode + value: + Type: '{{ Type }}' + Passwords: + - '{{ Passwords[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.memorydb.users +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +memorydb:DescribeUsers, +memorydb:ListTags +``` + +### Update +```json +memorydb:UpdateUser, +memorydb:DescribeUsers, +memorydb:ListTags, +memorydb:TagResource, +memorydb:UntagResource +``` + +### Delete +```json +memorydb:DeleteUser, +memorydb:DescribeUsers +``` + +### List +```json +memorydb:DescribeUsers, +memorydb:ListTags +``` diff --git a/website/docs/services/memorydb/users_list_only/index.md b/website/docs/services/memorydb/users_list_only/index.md new file mode 100644 index 0000000..427f2bb --- /dev/null +++ b/website/docs/services/memorydb/users_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - users_list_only + - memorydb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists users in a region or regions, for all properties use users + +## Overview + + + + + + + +
Nameusers_list_only
TypeResource
DescriptionResource Type definition for AWS::MemoryDB::User
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the user.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all users in a region. +```sql +SELECT +region, +user_name +FROM aws.memorydb.users_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the users_list_only resource, see users + diff --git a/website/docs/services/msk/batch_scram_secrets/index.md b/website/docs/services/msk/batch_scram_secrets/index.md new file mode 100644 index 0000000..e259aaa --- /dev/null +++ b/website/docs/services/msk/batch_scram_secrets/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a batch_scram_secret resource or lists batch_scram_secrets in a region + +## Overview + + + + + + + +
Namebatch_scram_secrets
TypeResource
DescriptionResource Type definition for AWS::MSK::BatchScramSecret
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
array
stringAWS region.
+ +For more information, see AWS::MSK::BatchScramSecret. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all batch_scram_secrets in a region. +```sql +SELECT +region, +cluster_arn, +secret_arn_list +FROM aws.msk.batch_scram_secrets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual batch_scram_secret. +```sql +SELECT +region, +cluster_arn, +secret_arn_list +FROM aws.msk.batch_scram_secrets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new batch_scram_secret resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.msk.batch_scram_secrets ( + ClusterArn, + region +) +SELECT +'{{ ClusterArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.msk.batch_scram_secrets ( + ClusterArn, + SecretArnList, + region +) +SELECT + '{{ ClusterArn }}', + '{{ SecretArnList }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: batch_scram_secret + props: + - name: ClusterArn + value: '{{ ClusterArn }}' + - name: SecretArnList + value: + - '{{ SecretArnList[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.msk.batch_scram_secrets +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +kafka:BatchDisassociateScramSecret, +kafka:ListScramSecrets, +kms:CreateGrant, +kms:DescribeKey +``` + +### List +```json +kafka:ListScramSecrets, +kms:CreateGrant, +kms:DescribeKey, +secretsmanager:GetSecretValue +``` + +### 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/website/docs/services/msk/batch_scram_secrets_list_only/index.md b/website/docs/services/msk/batch_scram_secrets_list_only/index.md new file mode 100644 index 0000000..950e0a8 --- /dev/null +++ b/website/docs/services/msk/batch_scram_secrets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: batch_scram_secrets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - batch_scram_secrets_list_only + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists batch_scram_secrets in a region or regions, for all properties use batch_scram_secrets + +## Overview + + + + + + + +
Namebatch_scram_secrets_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::BatchScramSecret
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all batch_scram_secrets in a region. +```sql +SELECT +region, +cluster_arn +FROM aws.msk.batch_scram_secrets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the batch_scram_secrets_list_only resource, see batch_scram_secrets + diff --git a/website/docs/services/msk/cluster_policies/index.md b/website/docs/services/msk/cluster_policies/index.md new file mode 100644 index 0000000..1339090 --- /dev/null +++ b/website/docs/services/msk/cluster_policies/index.md @@ -0,0 +1,209 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster_policy resource or lists cluster_policies in a region + +## Overview + + + + + + + +
Namecluster_policies
TypeResource
DescriptionResource Type definition for AWS::MSK::ClusterPolicy
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectA policy document containing permissions to add to the specified cluster.
stringThe arn of the cluster for the resource policy.
stringThe current version of the policy attached to the specified cluster
stringAWS region.
+ +For more information, see AWS::MSK::ClusterPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cluster_policies in a region. +```sql +SELECT +region, +policy, +cluster_arn, +current_version +FROM aws.msk.cluster_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster_policy. +```sql +SELECT +region, +policy, +cluster_arn, +current_version +FROM aws.msk.cluster_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.msk.cluster_policies ( + Policy, + ClusterArn, + region +) +SELECT +'{{ Policy }}', + '{{ ClusterArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.msk.cluster_policies ( + Policy, + ClusterArn, + region +) +SELECT + '{{ Policy }}', + '{{ ClusterArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster_policy + props: + - name: Policy + value: {} + - name: ClusterArn + value: '{{ ClusterArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.msk.cluster_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the cluster_policies resource, the following permissions are required: + +### Create +```json +kafka:PutClusterPolicy, +kafka:GetClusterPolicy +``` + +### Read +```json +kafka:GetClusterPolicy +``` + +### List +```json +kafka:GetClusterPolicy +``` + +### Update +```json +kafka:PutClusterPolicy, +kafka:GetClusterPolicy +``` + +### Delete +```json +kafka:DeleteClusterPolicy, +kafka:GetClusterPolicy +``` diff --git a/website/docs/services/msk/cluster_policies_list_only/index.md b/website/docs/services/msk/cluster_policies_list_only/index.md new file mode 100644 index 0000000..a2885c9 --- /dev/null +++ b/website/docs/services/msk/cluster_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cluster_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_policies_list_only + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cluster_policies in a region or regions, for all properties use cluster_policies + +## Overview + + + + + + + +
Namecluster_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::ClusterPolicy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe arn of the cluster for the resource policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cluster_policies in a region. +```sql +SELECT +region, +cluster_arn +FROM aws.msk.cluster_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_policies_list_only resource, see cluster_policies + diff --git a/website/docs/services/msk/cluster_tags/index.md b/website/docs/services/msk/cluster_tags/index.md new file mode 100644 index 0000000..5224536 --- /dev/null +++ b/website/docs/services/msk/cluster_tags/index.md @@ -0,0 +1,101 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + + + +
Namecluster_tags
TypeResource
DescriptionResource Type definition for AWS::MSK::Cluster
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
integer
object
object
string
string
stringThe current version of the MSK cluster
object
object
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +broker_node_group_info, +enhanced_monitoring, +kafka_version, +number_of_broker_nodes, +encryption_info, +open_monitoring, +cluster_name, +arn, +current_version, +client_authentication, +logging_info, +configuration_info, +storage_mode, +tag_key, +tag_value +FROM aws.msk.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + diff --git a/website/docs/services/msk/clusters/index.md b/website/docs/services/msk/clusters/index.md new file mode 100644 index 0000000..7dc33f2 --- /dev/null +++ b/website/docs/services/msk/clusters/index.md @@ -0,0 +1,391 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster resource or lists clusters in a region + +## Overview + + + + + + + +
Nameclusters
TypeResource
DescriptionResource Type definition for AWS::MSK::Cluster
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
integer
object
object
string
string
stringThe current version of the MSK cluster
object
object
objectA key-value pair to associate with a resource.
object
string
stringAWS region.
+ +For more information, see AWS::MSK::Cluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all clusters in a region. +```sql +SELECT +region, +broker_node_group_info, +enhanced_monitoring, +kafka_version, +number_of_broker_nodes, +encryption_info, +open_monitoring, +cluster_name, +arn, +current_version, +client_authentication, +logging_info, +tags, +configuration_info, +storage_mode +FROM aws.msk.clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster. +```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.clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.msk.clusters ( + BrokerNodeGroupInfo, + KafkaVersion, + NumberOfBrokerNodes, + ClusterName, + region +) +SELECT +'{{ BrokerNodeGroupInfo }}', + '{{ KafkaVersion }}', + '{{ NumberOfBrokerNodes }}', + '{{ ClusterName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.msk.clusters ( + BrokerNodeGroupInfo, + EnhancedMonitoring, + KafkaVersion, + NumberOfBrokerNodes, + EncryptionInfo, + OpenMonitoring, + ClusterName, + CurrentVersion, + ClientAuthentication, + LoggingInfo, + Tags, + ConfigurationInfo, + StorageMode, + region +) +SELECT + '{{ BrokerNodeGroupInfo }}', + '{{ EnhancedMonitoring }}', + '{{ KafkaVersion }}', + '{{ NumberOfBrokerNodes }}', + '{{ EncryptionInfo }}', + '{{ OpenMonitoring }}', + '{{ ClusterName }}', + '{{ CurrentVersion }}', + '{{ ClientAuthentication }}', + '{{ LoggingInfo }}', + '{{ Tags }}', + '{{ ConfigurationInfo }}', + '{{ StorageMode }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster + props: + - name: BrokerNodeGroupInfo + value: + StorageInfo: + EBSStorageInfo: + VolumeSize: '{{ VolumeSize }}' + ProvisionedThroughput: + Enabled: '{{ Enabled }}' + VolumeThroughput: '{{ VolumeThroughput }}' + ConnectivityInfo: + PublicAccess: + Type: '{{ Type }}' + VpcConnectivity: + ClientAuthentication: + Tls: + Enabled: '{{ Enabled }}' + Sasl: + Scram: + Enabled: '{{ Enabled }}' + Iam: + Enabled: '{{ Enabled }}' + SecurityGroups: + - '{{ SecurityGroups[0] }}' + BrokerAZDistribution: '{{ BrokerAZDistribution }}' + ClientSubnets: + - '{{ ClientSubnets[0] }}' + InstanceType: '{{ InstanceType }}' + - name: EnhancedMonitoring + value: '{{ EnhancedMonitoring }}' + - name: KafkaVersion + value: '{{ KafkaVersion }}' + - name: NumberOfBrokerNodes + value: '{{ NumberOfBrokerNodes }}' + - name: EncryptionInfo + value: + EncryptionAtRest: + DataVolumeKMSKeyId: '{{ DataVolumeKMSKeyId }}' + EncryptionInTransit: + InCluster: '{{ InCluster }}' + ClientBroker: '{{ ClientBroker }}' + - name: OpenMonitoring + value: + Prometheus: + JmxExporter: + EnabledInBroker: '{{ EnabledInBroker }}' + NodeExporter: + EnabledInBroker: '{{ EnabledInBroker }}' + - name: ClusterName + value: '{{ ClusterName }}' + - name: CurrentVersion + value: '{{ CurrentVersion }}' + - name: ClientAuthentication + value: + Sasl: + Iam: + Enabled: '{{ Enabled }}' + - name: LoggingInfo + value: + BrokerLogs: + S3: + Enabled: '{{ Enabled }}' + Prefix: '{{ Prefix }}' + Bucket: '{{ Bucket }}' + CloudWatchLogs: + LogGroup: '{{ LogGroup }}' + Enabled: '{{ Enabled }}' + Firehose: + Enabled: '{{ Enabled }}' + DeliveryStream: '{{ DeliveryStream }}' + - name: Tags + value: {} + - name: ConfigurationInfo + value: + Revision: '{{ Revision }}' + Arn: '{{ Arn }}' + - name: StorageMode + value: '{{ StorageMode }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.msk.clusters +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +kafka:ListClusters +``` + +### Read +```json +kafka:DescribeCluster +``` diff --git a/website/docs/services/msk/clusters_list_only/index.md b/website/docs/services/msk/clusters_list_only/index.md new file mode 100644 index 0000000..91ed114 --- /dev/null +++ b/website/docs/services/msk/clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + + + +
Nameclusters_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::Cluster
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +arn +FROM aws.msk.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + diff --git a/website/docs/services/msk/configurations/index.md b/website/docs/services/msk/configurations/index.md new file mode 100644 index 0000000..dafad66 --- /dev/null +++ b/website/docs/services/msk/configurations/index.md @@ -0,0 +1,234 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configuration resource or lists configurations in a region + +## Overview + + + + + + + +
Nameconfigurations
TypeResource
DescriptionResource Type definition for AWS::MSK::Configuration
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
object
stringAWS region.
+ +For more information, see AWS::MSK::Configuration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configurations in a region. +```sql +SELECT +region, +name, +description, +server_properties, +kafka_versions_list, +arn, +latest_revision +FROM aws.msk.configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual configuration. +```sql +SELECT +region, +name, +description, +server_properties, +kafka_versions_list, +arn, +latest_revision +FROM aws.msk.configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.msk.configurations ( + Name, + ServerProperties, + region +) +SELECT +'{{ Name }}', + '{{ ServerProperties }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.msk.configurations ( + Name, + Description, + ServerProperties, + KafkaVersionsList, + LatestRevision, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ ServerProperties }}', + '{{ KafkaVersionsList }}', + '{{ LatestRevision }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configuration + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: ServerProperties + value: '{{ ServerProperties }}' + - name: KafkaVersionsList + value: + - '{{ KafkaVersionsList[0] }}' + - name: LatestRevision + value: + CreationTime: '{{ CreationTime }}' + Description: '{{ Description }}' + Revision: '{{ Revision }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.msk.configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the configurations resource, the following permissions are required: + +### Create +```json +kafka:CreateConfiguration, +Kafka:DescribeConfiguration +``` + +### Delete +```json +kafka:DeleteConfiguration, +kafka:DescribeConfiguration +``` + +### List +```json +kafka:ListConfigurations +``` + +### Read +```json +kafka:DescribeConfiguration +``` + +### Update +```json +kafka:UpdateConfiguration, +kafka:DescribeConfiguration +``` diff --git a/website/docs/services/msk/configurations_list_only/index.md b/website/docs/services/msk/configurations_list_only/index.md new file mode 100644 index 0000000..5a6eb0a --- /dev/null +++ b/website/docs/services/msk/configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configurations_list_only + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configurations in a region or regions, for all properties use configurations + +## Overview + + + + + + + +
Nameconfigurations_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::Configuration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configurations in a region. +```sql +SELECT +region, +arn +FROM aws.msk.configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configurations_list_only resource, see configurations + diff --git a/website/docs/services/msk/index.md b/website/docs/services/msk/index.md new file mode 100644 index 0000000..87f4249 --- /dev/null +++ b/website/docs/services/msk/index.md @@ -0,0 +1,53 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The msk service documentation. + +:::info Service Summary + +
+
+total resources: 18
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/msk/replicator_tags/index.md b/website/docs/services/msk/replicator_tags/index.md new file mode 100644 index 0000000..d08ef4a --- /dev/null +++ b/website/docs/services/msk/replicator_tags/index.md @@ -0,0 +1,89 @@ +--- +title: replicator_tags +hide_title: false +hide_table_of_contents: false +keywords: + - replicator_tags + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for replicators in a region + +## Overview + + + + + + + +
Namereplicator_tags
TypeResource
DescriptionResource Type definition for AWS::MSK::Replicator
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name for the created replicator.
stringThe name of the replicator.
stringThe current version of the MSK replicator.
stringA summary description of the replicator.
arraySpecifies a list of Kafka clusters which are targets of the replicator.
arrayA list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
stringThe Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all replicators in a region. +```sql +SELECT +region, +replicator_arn, +replicator_name, +current_version, +description, +kafka_clusters, +replication_info_list, +service_execution_role_arn, +tag_key, +tag_value +FROM aws.msk.replicator_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replicator_tags resource, see replicators + diff --git a/website/docs/services/msk/replicators/index.md b/website/docs/services/msk/replicators/index.md new file mode 100644 index 0000000..d439e9d --- /dev/null +++ b/website/docs/services/msk/replicators/index.md @@ -0,0 +1,296 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a replicator resource or lists replicators in a region + +## Overview + + + + + + + +
Namereplicators
TypeResource
DescriptionResource Type definition for AWS::MSK::Replicator
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name for the created replicator.
stringThe name of the replicator.
stringThe current version of the MSK replicator.
stringA summary description of the replicator.
arraySpecifies a list of Kafka clusters which are targets of the replicator.
arrayA list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
stringThe Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::MSK::Replicator. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all replicators in a region. +```sql +SELECT +region, +replicator_arn, +replicator_name, +current_version, +description, +kafka_clusters, +replication_info_list, +service_execution_role_arn, +tags +FROM aws.msk.replicators +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual replicator. +```sql +SELECT +region, +replicator_arn, +replicator_name, +current_version, +description, +kafka_clusters, +replication_info_list, +service_execution_role_arn, +tags +FROM aws.msk.replicators +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new replicator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.msk.replicators ( + ReplicatorName, + KafkaClusters, + ReplicationInfoList, + ServiceExecutionRoleArn, + region +) +SELECT +'{{ ReplicatorName }}', + '{{ KafkaClusters }}', + '{{ ReplicationInfoList }}', + '{{ ServiceExecutionRoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.msk.replicators ( + ReplicatorName, + CurrentVersion, + Description, + KafkaClusters, + ReplicationInfoList, + ServiceExecutionRoleArn, + Tags, + region +) +SELECT + '{{ ReplicatorName }}', + '{{ CurrentVersion }}', + '{{ Description }}', + '{{ KafkaClusters }}', + '{{ ReplicationInfoList }}', + '{{ ServiceExecutionRoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: replicator + props: + - name: ReplicatorName + value: '{{ ReplicatorName }}' + - name: CurrentVersion + value: '{{ CurrentVersion }}' + - name: Description + value: '{{ Description }}' + - name: KafkaClusters + value: + - AmazonMskCluster: + MskClusterArn: '{{ MskClusterArn }}' + VpcConfig: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: ReplicationInfoList + value: + - SourceKafkaClusterArn: '{{ SourceKafkaClusterArn }}' + TargetKafkaClusterArn: '{{ TargetKafkaClusterArn }}' + TargetCompressionType: '{{ TargetCompressionType }}' + TopicReplication: + TopicsToReplicate: + - '{{ TopicsToReplicate[0] }}' + TopicsToExclude: + - '{{ TopicsToExclude[0] }}' + CopyTopicConfigurations: '{{ CopyTopicConfigurations }}' + CopyAccessControlListsForTopics: '{{ CopyAccessControlListsForTopics }}' + DetectAndCopyNewTopics: '{{ DetectAndCopyNewTopics }}' + StartingPosition: + Type: '{{ Type }}' + TopicNameConfiguration: + Type: '{{ Type }}' + ConsumerGroupReplication: + ConsumerGroupsToReplicate: + - '{{ ConsumerGroupsToReplicate[0] }}' + ConsumerGroupsToExclude: + - '{{ ConsumerGroupsToExclude[0] }}' + SynchroniseConsumerGroupOffsets: '{{ SynchroniseConsumerGroupOffsets }}' + DetectAndCopyNewConsumerGroups: '{{ DetectAndCopyNewConsumerGroups }}' + - name: ServiceExecutionRoleArn + value: '{{ ServiceExecutionRoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.msk.replicators +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +kafka:ListReplicators +``` diff --git a/website/docs/services/msk/replicators_list_only/index.md b/website/docs/services/msk/replicators_list_only/index.md new file mode 100644 index 0000000..5b43721 --- /dev/null +++ b/website/docs/services/msk/replicators_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: replicators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - replicators_list_only + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists replicators in a region or regions, for all properties use replicators + +## Overview + + + + + + + +
Namereplicators_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::Replicator
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name for the created replicator.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all replicators in a region. +```sql +SELECT +region, +replicator_arn +FROM aws.msk.replicators_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replicators_list_only resource, see replicators + diff --git a/website/docs/services/msk/serverless_cluster_tags/index.md b/website/docs/services/msk/serverless_cluster_tags/index.md new file mode 100644 index 0000000..0bdf1b4 --- /dev/null +++ b/website/docs/services/msk/serverless_cluster_tags/index.md @@ -0,0 +1,83 @@ +--- +title: serverless_cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_cluster_tags + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for serverless_clusters in a region + +## Overview + + + + + + + +
Nameserverless_cluster_tags
TypeResource
DescriptionResource Type definition for AWS::MSK::ServerlessCluster
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
array
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all serverless_clusters in a region. +```sql +SELECT +region, +arn, +cluster_name, +vpc_configs, +client_authentication, +tag_key, +tag_value +FROM aws.msk.serverless_cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the serverless_cluster_tags resource, see serverless_clusters + diff --git a/website/docs/services/msk/serverless_clusters/index.md b/website/docs/services/msk/serverless_clusters/index.md new file mode 100644 index 0000000..6850267 --- /dev/null +++ b/website/docs/services/msk/serverless_clusters/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a serverless_cluster resource or lists serverless_clusters in a region + +## Overview + + + + + + + +
Nameserverless_clusters
TypeResource
DescriptionResource Type definition for AWS::MSK::ServerlessCluster
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
array
object
objectA key-value pair to associate with a resource.
stringAWS region.
+ +For more information, see AWS::MSK::ServerlessCluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all serverless_clusters in a region. +```sql +SELECT +region, +arn, +cluster_name, +vpc_configs, +client_authentication, +tags +FROM aws.msk.serverless_clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual serverless_cluster. +```sql +SELECT +region, +arn, +cluster_name, +vpc_configs, +client_authentication, +tags +FROM aws.msk.serverless_clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new serverless_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.msk.serverless_clusters ( + ClusterName, + VpcConfigs, + ClientAuthentication, + region +) +SELECT +'{{ ClusterName }}', + '{{ VpcConfigs }}', + '{{ ClientAuthentication }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.msk.serverless_clusters ( + ClusterName, + VpcConfigs, + ClientAuthentication, + Tags, + region +) +SELECT + '{{ ClusterName }}', + '{{ VpcConfigs }}', + '{{ ClientAuthentication }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: serverless_cluster + props: + - name: ClusterName + value: '{{ ClusterName }}' + - name: VpcConfigs + value: + - SecurityGroups: + - '{{ SecurityGroups[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: ClientAuthentication + value: + Sasl: + Iam: + Enabled: '{{ Enabled }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.msk.serverless_clusters +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +kafka:DescribeClusterV2 +``` + +### Delete +```json +kafka:DeleteCluster, +kafka:DescribeClusterV2, +ec2:DeleteVpcEndpoints +``` + +### List +```json +kafka:ListClustersV2 +``` diff --git a/website/docs/services/msk/serverless_clusters_list_only/index.md b/website/docs/services/msk/serverless_clusters_list_only/index.md new file mode 100644 index 0000000..c7b4263 --- /dev/null +++ b/website/docs/services/msk/serverless_clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: serverless_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_clusters_list_only + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists serverless_clusters in a region or regions, for all properties use serverless_clusters + +## Overview + + + + + + + +
Nameserverless_clusters_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::ServerlessCluster
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all serverless_clusters in a region. +```sql +SELECT +region, +arn +FROM aws.msk.serverless_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the serverless_clusters_list_only resource, see serverless_clusters + diff --git a/website/docs/services/msk/vpc_connection_tags/index.md b/website/docs/services/msk/vpc_connection_tags/index.md new file mode 100644 index 0000000..1203058 --- /dev/null +++ b/website/docs/services/msk/vpc_connection_tags/index.md @@ -0,0 +1,87 @@ +--- +title: vpc_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connection_tags + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_connections in a region + +## Overview + + + + + + + +
Namevpc_connection_tags
TypeResource
DescriptionResource Type definition for AWS::MSK::VpcConnection
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe type of private link authentication
array
stringThe Amazon Resource Name (ARN) of the target cluster
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_connections in a region. +```sql +SELECT +region, +arn, +authentication, +client_subnets, +target_cluster_arn, +security_groups, +vpc_id, +tag_key, +tag_value +FROM aws.msk.vpc_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connection_tags resource, see vpc_connections + diff --git a/website/docs/services/msk/vpc_connections/index.md b/website/docs/services/msk/vpc_connections/index.md new file mode 100644 index 0000000..daba842 --- /dev/null +++ b/website/docs/services/msk/vpc_connections/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_connection resource or lists vpc_connections in a region + +## Overview + + + + + + + +
Namevpc_connections
TypeResource
DescriptionResource Type definition for AWS::MSK::VpcConnection
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe type of private link authentication
array
stringThe Amazon Resource Name (ARN) of the target cluster
array
objectA key-value pair to associate with a resource.
string
stringAWS region.
+ +For more information, see AWS::MSK::VpcConnection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_connections in a region. +```sql +SELECT +region, +arn, +authentication, +client_subnets, +target_cluster_arn, +security_groups, +tags, +vpc_id +FROM aws.msk.vpc_connections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_connection. +```sql +SELECT +region, +arn, +authentication, +client_subnets, +target_cluster_arn, +security_groups, +tags, +vpc_id +FROM aws.msk.vpc_connections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.msk.vpc_connections ( + Authentication, + ClientSubnets, + TargetClusterArn, + SecurityGroups, + VpcId, + region +) +SELECT +'{{ Authentication }}', + '{{ ClientSubnets }}', + '{{ TargetClusterArn }}', + '{{ SecurityGroups }}', + '{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.msk.vpc_connections ( + Authentication, + ClientSubnets, + TargetClusterArn, + SecurityGroups, + Tags, + VpcId, + region +) +SELECT + '{{ Authentication }}', + '{{ ClientSubnets }}', + '{{ TargetClusterArn }}', + '{{ SecurityGroups }}', + '{{ Tags }}', + '{{ VpcId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_connection + props: + - name: Authentication + value: '{{ Authentication }}' + - name: ClientSubnets + value: + - '{{ ClientSubnets[0] }}' + - name: TargetClusterArn + value: '{{ TargetClusterArn }}' + - name: SecurityGroups + value: + - '{{ SecurityGroups[0] }}' + - name: Tags + value: {} + - name: VpcId + value: '{{ VpcId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.msk.vpc_connections +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +kafka:ListVpcConnections, +kms:CreateGrant, +kms:DescribeKey +``` diff --git a/website/docs/services/msk/vpc_connections_list_only/index.md b/website/docs/services/msk/vpc_connections_list_only/index.md new file mode 100644 index 0000000..dfbaf0e --- /dev/null +++ b/website/docs/services/msk/vpc_connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connections_list_only + - msk + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_connections in a region or regions, for all properties use vpc_connections + +## Overview + + + + + + + +
Namevpc_connections_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::VpcConnection
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_connections in a region. +```sql +SELECT +region, +arn +FROM aws.msk.vpc_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connections_list_only resource, see vpc_connections + diff --git a/website/docs/services/mwaa/environment_tags/index.md b/website/docs/services/mwaa/environment_tags/index.md new file mode 100644 index 0000000..de793fd --- /dev/null +++ b/website/docs/services/mwaa/environment_tags/index.md @@ -0,0 +1,133 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - mwaa + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + + + +
Nameenvironment_tags
TypeResource
DescriptionResource schema for AWS::MWAA::Environment
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringCustomer-defined identifier for the environment, unique per customer region.
stringARN for the MWAA environment.
stringUrl endpoint for the environment's Airflow UI.
stringIAM role to be used by tasks.
stringThe identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for MWAA data encryption.
You can specify the CMK using any of the following:
Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
stringVersion of airflow to deploy to the environment.
stringARN for the AWS S3 bucket to use as the source of DAGs and plugins for the environment.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
objectKey/value pairs representing Airflow configuration variables.
Keys are prefixed by their section:
[core]
dags_folder={AIRFLOW_HOME}/dags
Would be represented as
"core.dags_folder": "{AIRFLOW_HOME}/dags"
stringTemplated configuration for airflow processes and backing infrastructure.
integerMaximum worker compute units.
integerMinimum worker compute units.
integerMaximum webserver compute units.
integerMinimum webserver compute units.
integerScheduler compute units.
objectConfigures the network resources of the environment.
objectLogging configuration for the environment.
stringStart time for the weekly maintenance window.
stringChoice for mode of webserver access including over public internet or via private VPC endpoint.
stringDefines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
stringThe celery executor queue associated with the environment.
stringThe database VPC endpoint service name.
stringThe webserver VPC endpoint service name, applicable if private webserver access mode selected.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +name, +arn, +webserver_url, +execution_role_arn, +kms_key, +airflow_version, +source_bucket_arn, +dag_s3_path, +plugins_s3_path, +plugins_s3_object_version, +requirements_s3_path, +requirements_s3_object_version, +startup_script_s3_path, +startup_script_s3_object_version, +airflow_configuration_options, +environment_class, +max_workers, +min_workers, +max_webservers, +min_webservers, +schedulers, +network_configuration, +logging_configuration, +weekly_maintenance_window_start, +webserver_access_mode, +endpoint_management, +celery_executor_queue, +database_vpc_endpoint_service, +webserver_vpc_endpoint_service, +tag_key, +tag_value +FROM aws.mwaa.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + diff --git a/website/docs/services/mwaa/environments/index.md b/website/docs/services/mwaa/environments/index.md new file mode 100644 index 0000000..0b83566 --- /dev/null +++ b/website/docs/services/mwaa/environments/index.md @@ -0,0 +1,391 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment resource or lists environments in a region + +## Overview + + + + + + + +
Nameenvironments
TypeResource
DescriptionResource schema for AWS::MWAA::Environment
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringCustomer-defined identifier for the environment, unique per customer region.
stringARN for the MWAA environment.
stringUrl endpoint for the environment's Airflow UI.
stringIAM role to be used by tasks.
stringThe identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for MWAA data encryption.
You can specify the CMK using any of the following:
Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
stringVersion of airflow to deploy to the environment.
stringARN for the AWS S3 bucket to use as the source of DAGs and plugins for the environment.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
objectKey/value pairs representing Airflow configuration variables.
Keys are prefixed by their section:
[core]
dags_folder={AIRFLOW_HOME}/dags
Would be represented as
"core.dags_folder": "{AIRFLOW_HOME}/dags"
stringTemplated configuration for airflow processes and backing infrastructure.
integerMaximum worker compute units.
integerMinimum worker compute units.
integerMaximum webserver compute units.
integerMinimum webserver compute units.
integerScheduler compute units.
objectConfigures the network resources of the environment.
objectLogging configuration for the environment.
stringStart time for the weekly maintenance window.
objectA map of tags for the environment.
stringChoice for mode of webserver access including over public internet or via private VPC endpoint.
stringDefines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
stringThe celery executor queue associated with the environment.
stringThe database VPC endpoint service name.
stringThe webserver VPC endpoint service name, applicable if private webserver access mode selected.
stringAWS region.
+ +For more information, see AWS::MWAA::Environment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environments in a region. +```sql +SELECT +region, +name, +arn, +webserver_url, +execution_role_arn, +kms_key, +airflow_version, +source_bucket_arn, +dag_s3_path, +plugins_s3_path, +plugins_s3_object_version, +requirements_s3_path, +requirements_s3_object_version, +startup_script_s3_path, +startup_script_s3_object_version, +airflow_configuration_options, +environment_class, +max_workers, +min_workers, +max_webservers, +min_webservers, +schedulers, +network_configuration, +logging_configuration, +weekly_maintenance_window_start, +tags, +webserver_access_mode, +endpoint_management, +celery_executor_queue, +database_vpc_endpoint_service, +webserver_vpc_endpoint_service +FROM aws.mwaa.environments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment. +```sql +SELECT +region, +name, +arn, +webserver_url, +execution_role_arn, +kms_key, +airflow_version, +source_bucket_arn, +dag_s3_path, +plugins_s3_path, +plugins_s3_object_version, +requirements_s3_path, +requirements_s3_object_version, +startup_script_s3_path, +startup_script_s3_object_version, +airflow_configuration_options, +environment_class, +max_workers, +min_workers, +max_webservers, +min_webservers, +schedulers, +network_configuration, +logging_configuration, +weekly_maintenance_window_start, +tags, +webserver_access_mode, +endpoint_management, +celery_executor_queue, +database_vpc_endpoint_service, +webserver_vpc_endpoint_service +FROM aws.mwaa.environments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.mwaa.environments ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.mwaa.environments ( + Name, + ExecutionRoleArn, + KmsKey, + AirflowVersion, + SourceBucketArn, + DagS3Path, + PluginsS3Path, + PluginsS3ObjectVersion, + RequirementsS3Path, + RequirementsS3ObjectVersion, + StartupScriptS3Path, + StartupScriptS3ObjectVersion, + AirflowConfigurationOptions, + EnvironmentClass, + MaxWorkers, + MinWorkers, + MaxWebservers, + MinWebservers, + Schedulers, + NetworkConfiguration, + LoggingConfiguration, + WeeklyMaintenanceWindowStart, + Tags, + WebserverAccessMode, + EndpointManagement, + region +) +SELECT + '{{ Name }}', + '{{ ExecutionRoleArn }}', + '{{ KmsKey }}', + '{{ AirflowVersion }}', + '{{ SourceBucketArn }}', + '{{ DagS3Path }}', + '{{ PluginsS3Path }}', + '{{ PluginsS3ObjectVersion }}', + '{{ RequirementsS3Path }}', + '{{ RequirementsS3ObjectVersion }}', + '{{ StartupScriptS3Path }}', + '{{ StartupScriptS3ObjectVersion }}', + '{{ AirflowConfigurationOptions }}', + '{{ EnvironmentClass }}', + '{{ MaxWorkers }}', + '{{ MinWorkers }}', + '{{ MaxWebservers }}', + '{{ MinWebservers }}', + '{{ Schedulers }}', + '{{ NetworkConfiguration }}', + '{{ LoggingConfiguration }}', + '{{ WeeklyMaintenanceWindowStart }}', + '{{ Tags }}', + '{{ WebserverAccessMode }}', + '{{ EndpointManagement }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment + props: + - name: Name + value: '{{ Name }}' + - name: ExecutionRoleArn + value: '{{ ExecutionRoleArn }}' + - name: KmsKey + value: '{{ KmsKey }}' + - name: AirflowVersion + value: '{{ AirflowVersion }}' + - name: SourceBucketArn + value: '{{ SourceBucketArn }}' + - name: DagS3Path + value: '{{ DagS3Path }}' + - name: PluginsS3Path + value: null + - name: PluginsS3ObjectVersion + value: '{{ PluginsS3ObjectVersion }}' + - name: RequirementsS3Path + value: null + - name: RequirementsS3ObjectVersion + value: null + - name: StartupScriptS3Path + value: null + - name: StartupScriptS3ObjectVersion + value: null + - name: AirflowConfigurationOptions + value: {} + - name: EnvironmentClass + value: '{{ EnvironmentClass }}' + - name: MaxWorkers + value: '{{ MaxWorkers }}' + - name: MinWorkers + value: '{{ MinWorkers }}' + - name: MaxWebservers + value: '{{ MaxWebservers }}' + - name: MinWebservers + value: '{{ MinWebservers }}' + - name: Schedulers + value: '{{ Schedulers }}' + - name: NetworkConfiguration + value: + SubnetIds: + - '{{ SubnetIds[0] }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + - name: LoggingConfiguration + value: + DagProcessingLogs: + Enabled: '{{ Enabled }}' + LogLevel: '{{ LogLevel }}' + CloudWatchLogGroupArn: '{{ CloudWatchLogGroupArn }}' + SchedulerLogs: null + WebserverLogs: null + WorkerLogs: null + TaskLogs: null + - name: WeeklyMaintenanceWindowStart + value: '{{ WeeklyMaintenanceWindowStart }}' + - name: Tags + value: {} + - name: WebserverAccessMode + value: '{{ WebserverAccessMode }}' + - name: EndpointManagement + value: '{{ EndpointManagement }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.mwaa.environments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +```json +airflow:CreateEnvironment +``` + +### Read +```json +airflow:GetEnvironment +``` + +### Update +```json +airflow:UpdateEnvironment, +airflow:TagResource, +airflow:UntagResource +``` + +### Delete +```json +airflow:DeleteEnvironment +``` + +### List +```json +airflow:ListEnvironments +``` diff --git a/website/docs/services/mwaa/environments_list_only/index.md b/website/docs/services/mwaa/environments_list_only/index.md new file mode 100644 index 0000000..7e996f8 --- /dev/null +++ b/website/docs/services/mwaa/environments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionResource schema for AWS::MWAA::Environment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringCustomer-defined identifier for the environment, unique per customer region.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +name +FROM aws.mwaa.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + diff --git a/website/docs/services/mwaa/index.md b/website/docs/services/mwaa/index.md new file mode 100644 index 0000000..7e38554 --- /dev/null +++ b/website/docs/services/mwaa/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The mwaa service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/neptune/db_cluster_tags/index.md b/website/docs/services/neptune/db_cluster_tags/index.md new file mode 100644 index 0000000..8eb5ac2 --- /dev/null +++ b/website/docs/services/neptune/db_cluster_tags/index.md @@ -0,0 +1,131 @@ +--- +title: db_cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster_tags + - neptune + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_clusters in a region + +## Overview + + + + + + + +
Namedb_cluster_tags
TypeResource
DescriptionThe AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
stringThe reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
stringThe resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
arrayProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
arrayProvides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
integerSpecifies the number of days for which automatic DB snapshots are retained.
booleanA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
stringThe DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
stringProvides the name of the DB cluster parameter group.
stringThe name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
integerThe port number on which the DB instances in the DB cluster accept connections.
If not specified, the default port used is `8182`.
Note: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities.
stringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
booleanIndicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
arraySpecifies a list of log types that are enabled for export to CloudWatch Logs.
stringIndicates the database engine version.
booleanTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
stringThe Amazon Resource Name (ARN) of the AWS KMS 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 KMS key is used. If you specify this property, you must set the StorageEncrypted property to true.
stringThe port number on which the DB cluster accepts connections. For example: `8182`.
stringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
stringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
objectContains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
stringSpecifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
booleanIndicates whether the DB cluster is encrypted.
If you specify the KmsKeyId property, then you must enable encryption and set this property to true.
If you enable the StorageEncrypted property but don't specify KmsKeyId property, then the default KMS key is used. If you specify KmsKeyId property, then that KMS Key is used to encrypt the database instances in the DB cluster.
If you specify the SourceDBClusterIdentifier property and don't specify this property or disable it. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the KmsKeyId property from the source cluster is used.
If you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used.
booleanCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
arrayProvides a list of VPC security groups that the DB cluster belongs to.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_clusters in a region. +```sql +SELECT +region, +endpoint, +read_endpoint, +cluster_resource_id, +associated_roles, +availability_zones, +backup_retention_period, +copy_tags_to_snapshot, +db_cluster_identifier, +db_cluster_parameter_group_name, +db_instance_parameter_group_name, +db_port, +db_subnet_group_name, +deletion_protection, +enable_cloudwatch_logs_exports, +engine_version, +iam_auth_enabled, +kms_key_id, +port, +preferred_backup_window, +preferred_maintenance_window, +restore_to_time, +restore_type, +serverless_scaling_configuration, +snapshot_identifier, +source_db_cluster_identifier, +storage_encrypted, +use_latest_restorable_time, +vpc_security_group_ids, +tag_key, +tag_value +FROM aws.neptune.db_cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_cluster_tags resource, see db_clusters + diff --git a/website/docs/services/neptune/db_clusters/index.md b/website/docs/services/neptune/db_clusters/index.md new file mode 100644 index 0000000..022bd64 --- /dev/null +++ b/website/docs/services/neptune/db_clusters/index.md @@ -0,0 +1,472 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a db_cluster resource or lists db_clusters in a region + +## Overview + + + + + + + +
Namedb_clusters
TypeResource
DescriptionThe AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
stringThe reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
stringThe resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
arrayProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
arrayProvides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
integerSpecifies the number of days for which automatic DB snapshots are retained.
booleanA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
stringThe DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
stringProvides the name of the DB cluster parameter group.
stringThe name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
integerThe port number on which the DB instances in the DB cluster accept connections.
If not specified, the default port used is `8182`.
Note: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities.
stringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
booleanIndicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
arraySpecifies a list of log types that are enabled for export to CloudWatch Logs.
stringIndicates the database engine version.
booleanTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
stringThe Amazon Resource Name (ARN) of the AWS KMS 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 KMS key is used. If you specify this property, you must set the StorageEncrypted property to true.
stringThe port number on which the DB cluster accepts connections. For example: `8182`.
stringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
stringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
objectContains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
stringSpecifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
booleanIndicates whether the DB cluster is encrypted.
If you specify the KmsKeyId property, then you must enable encryption and set this property to true.
If you enable the StorageEncrypted property but don't specify KmsKeyId property, then the default KMS key is used. If you specify KmsKeyId property, then that KMS Key is used to encrypt the database instances in the DB cluster.
If you specify the SourceDBClusterIdentifier property and don't specify this property or disable it. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the KmsKeyId property from the source cluster is used.
If you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used.
arrayThe tags assigned to this cluster.
booleanCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
arrayProvides a list of VPC security groups that the DB cluster belongs to.
stringAWS region.
+ +For more information, see AWS::Neptune::DBCluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all db_clusters in a region. +```sql +SELECT +region, +endpoint, +read_endpoint, +cluster_resource_id, +associated_roles, +availability_zones, +backup_retention_period, +copy_tags_to_snapshot, +db_cluster_identifier, +db_cluster_parameter_group_name, +db_instance_parameter_group_name, +db_port, +db_subnet_group_name, +deletion_protection, +enable_cloudwatch_logs_exports, +engine_version, +iam_auth_enabled, +kms_key_id, +port, +preferred_backup_window, +preferred_maintenance_window, +restore_to_time, +restore_type, +serverless_scaling_configuration, +snapshot_identifier, +source_db_cluster_identifier, +storage_encrypted, +tags, +use_latest_restorable_time, +vpc_security_group_ids +FROM aws.neptune.db_clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual db_cluster. +```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_clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new db_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.neptune.db_clusters ( + AssociatedRoles, + AvailabilityZones, + BackupRetentionPeriod, + CopyTagsToSnapshot, + DBClusterIdentifier, + DBClusterParameterGroupName, + DBInstanceParameterGroupName, + DBPort, + DBSubnetGroupName, + DeletionProtection, + EnableCloudwatchLogsExports, + EngineVersion, + IamAuthEnabled, + KmsKeyId, + PreferredBackupWindow, + PreferredMaintenanceWindow, + RestoreToTime, + RestoreType, + ServerlessScalingConfiguration, + SnapshotIdentifier, + SourceDBClusterIdentifier, + StorageEncrypted, + Tags, + UseLatestRestorableTime, + VpcSecurityGroupIds, + region +) +SELECT +'{{ AssociatedRoles }}', + '{{ AvailabilityZones }}', + '{{ BackupRetentionPeriod }}', + '{{ CopyTagsToSnapshot }}', + '{{ DBClusterIdentifier }}', + '{{ DBClusterParameterGroupName }}', + '{{ DBInstanceParameterGroupName }}', + '{{ DBPort }}', + '{{ DBSubnetGroupName }}', + '{{ DeletionProtection }}', + '{{ EnableCloudwatchLogsExports }}', + '{{ EngineVersion }}', + '{{ IamAuthEnabled }}', + '{{ KmsKeyId }}', + '{{ PreferredBackupWindow }}', + '{{ PreferredMaintenanceWindow }}', + '{{ RestoreToTime }}', + '{{ RestoreType }}', + '{{ ServerlessScalingConfiguration }}', + '{{ SnapshotIdentifier }}', + '{{ SourceDBClusterIdentifier }}', + '{{ StorageEncrypted }}', + '{{ Tags }}', + '{{ UseLatestRestorableTime }}', + '{{ VpcSecurityGroupIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.neptune.db_clusters ( + AssociatedRoles, + AvailabilityZones, + BackupRetentionPeriod, + CopyTagsToSnapshot, + DBClusterIdentifier, + DBClusterParameterGroupName, + DBInstanceParameterGroupName, + DBPort, + DBSubnetGroupName, + DeletionProtection, + EnableCloudwatchLogsExports, + EngineVersion, + IamAuthEnabled, + KmsKeyId, + PreferredBackupWindow, + PreferredMaintenanceWindow, + RestoreToTime, + RestoreType, + ServerlessScalingConfiguration, + SnapshotIdentifier, + SourceDBClusterIdentifier, + StorageEncrypted, + Tags, + UseLatestRestorableTime, + VpcSecurityGroupIds, + region +) +SELECT + '{{ AssociatedRoles }}', + '{{ AvailabilityZones }}', + '{{ BackupRetentionPeriod }}', + '{{ CopyTagsToSnapshot }}', + '{{ DBClusterIdentifier }}', + '{{ DBClusterParameterGroupName }}', + '{{ DBInstanceParameterGroupName }}', + '{{ DBPort }}', + '{{ DBSubnetGroupName }}', + '{{ DeletionProtection }}', + '{{ EnableCloudwatchLogsExports }}', + '{{ EngineVersion }}', + '{{ IamAuthEnabled }}', + '{{ KmsKeyId }}', + '{{ PreferredBackupWindow }}', + '{{ PreferredMaintenanceWindow }}', + '{{ RestoreToTime }}', + '{{ RestoreType }}', + '{{ ServerlessScalingConfiguration }}', + '{{ SnapshotIdentifier }}', + '{{ SourceDBClusterIdentifier }}', + '{{ StorageEncrypted }}', + '{{ Tags }}', + '{{ UseLatestRestorableTime }}', + '{{ VpcSecurityGroupIds }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: db_cluster + props: + - name: AssociatedRoles + value: + - FeatureName: '{{ FeatureName }}' + RoleArn: '{{ RoleArn }}' + - name: AvailabilityZones + value: + - '{{ AvailabilityZones[0] }}' + - name: BackupRetentionPeriod + value: '{{ BackupRetentionPeriod }}' + - name: CopyTagsToSnapshot + value: '{{ CopyTagsToSnapshot }}' + - name: DBClusterIdentifier + value: '{{ DBClusterIdentifier }}' + - name: DBClusterParameterGroupName + value: '{{ DBClusterParameterGroupName }}' + - name: DBInstanceParameterGroupName + value: '{{ DBInstanceParameterGroupName }}' + - name: DBPort + value: '{{ DBPort }}' + - name: DBSubnetGroupName + value: '{{ DBSubnetGroupName }}' + - name: DeletionProtection + value: '{{ DeletionProtection }}' + - name: EnableCloudwatchLogsExports + value: + - '{{ EnableCloudwatchLogsExports[0] }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: IamAuthEnabled + value: '{{ IamAuthEnabled }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: PreferredBackupWindow + value: '{{ PreferredBackupWindow }}' + - name: PreferredMaintenanceWindow + value: '{{ PreferredMaintenanceWindow }}' + - name: RestoreToTime + value: '{{ RestoreToTime }}' + - name: RestoreType + value: '{{ RestoreType }}' + - name: ServerlessScalingConfiguration + value: + MinCapacity: null + MaxCapacity: null + - name: SnapshotIdentifier + value: '{{ SnapshotIdentifier }}' + - name: SourceDBClusterIdentifier + value: '{{ SourceDBClusterIdentifier }}' + - name: StorageEncrypted + value: '{{ StorageEncrypted }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: UseLatestRestorableTime + value: '{{ UseLatestRestorableTime }}' + - name: VpcSecurityGroupIds + value: + - '{{ VpcSecurityGroupIds[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.neptune.db_clusters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the db_clusters resource, the following permissions are required: + +### Create +```json +iam:PassRole, +iam:CreateServiceLinkedRole, +rds:AddRoleToDBCluster, +rds:AddTagsToResource, +rds:CreateDBCluster, +rds:CreateDBInstance, +rds:DescribeDBClusters, +rds:ListTagsForResource, +rds:ModifyDBCluster, +rds:RestoreDBClusterFromSnapshot, +rds:RestoreDBClusterToPointInTime, +kms:CreateGrant, +kms:DescribeKey +``` + +### Read +```json +rds:DescribeDBClusters, +rds:ListTagsForResource, +kms:CreateGrant, +kms:DescribeKey +``` + +### 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:CreateGrant, +kms:DescribeKey +``` + +### Delete +```json +rds:DeleteDBCluster, +rds:DeleteDBInstance, +rds:DescribeDBClusters, +rds:DescribeGlobalClusters, +rds:ListTagsForResource, +rds:RemoveFromGlobalCluster, +rds:CreateDBClusterSnapshot, +kms:CreateGrant, +kms:DescribeKey +``` + +### List +```json +rds:DescribeDBClusters, +rds:ListTagsForResource, +kms:CreateGrant, +kms:DescribeKey +``` diff --git a/website/docs/services/neptune/db_clusters_list_only/index.md b/website/docs/services/neptune/db_clusters_list_only/index.md new file mode 100644 index 0000000..7b4f998 --- /dev/null +++ b/website/docs/services/neptune/db_clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: db_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_clusters_list_only + - neptune + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_clusters in a region or regions, for all properties use db_clusters + +## Overview + + + + + + + +
Namedb_clusters_list_only
TypeResource
DescriptionThe AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe 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.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_clusters in a region. +```sql +SELECT +region, +db_cluster_identifier +FROM aws.neptune.db_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_clusters_list_only resource, see db_clusters + diff --git a/website/docs/services/neptune/index.md b/website/docs/services/neptune/index.md new file mode 100644 index 0000000..615b6d1 --- /dev/null +++ b/website/docs/services/neptune/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The neptune service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/neptunegraph/graph_tags/index.md b/website/docs/services/neptunegraph/graph_tags/index.md new file mode 100644 index 0000000..fb13fd7 --- /dev/null +++ b/website/docs/services/neptunegraph/graph_tags/index.md @@ -0,0 +1,93 @@ +--- +title: graph_tags +hide_title: false +hide_table_of_contents: false +keywords: + - graph_tags + - neptunegraph + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for graphs in a region + +## Overview + + + + + + + +
Namegraph_tags
TypeResource
DescriptionThe AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanValue that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
_Default_: If not specified, the default value is true.
stringContains a user-supplied name for the Graph.
If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.
_Important_: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
integerMemory for the Graph.
booleanSpecifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.
When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.
When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.
_Default_: If not specified, the default value is false.
integerSpecifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.
Replica Count should always be less than or equal to 2.
_Default_: If not specified, the default value is 1.
objectVector Search Configuration
stringThe connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`
stringGraph resource ARN
stringThe auto-generated id assigned by the service.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all graphs in a region. +```sql +SELECT +region, +deletion_protection, +graph_name, +provisioned_memory, +public_connectivity, +replica_count, +vector_search_configuration, +endpoint, +graph_arn, +graph_id, +tag_key, +tag_value +FROM aws.neptunegraph.graph_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the graph_tags resource, see graphs + diff --git a/website/docs/services/neptunegraph/graphs/index.md b/website/docs/services/neptunegraph/graphs/index.md new file mode 100644 index 0000000..764aba4 --- /dev/null +++ b/website/docs/services/neptunegraph/graphs/index.md @@ -0,0 +1,276 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a graph resource or lists graphs in a region + +## Overview + + + + + + + +
Namegraphs
TypeResource
DescriptionThe AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanValue that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
_Default_: If not specified, the default value is true.
stringContains a user-supplied name for the Graph.
If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.
_Important_: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
integerMemory for the Graph.
booleanSpecifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.
When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.
When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.
_Default_: If not specified, the default value is false.
integerSpecifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.
Replica Count should always be less than or equal to 2.
_Default_: If not specified, the default value is 1.
arrayThe tags associated with this graph.
objectVector Search Configuration
stringThe connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`
stringGraph resource ARN
stringThe auto-generated id assigned by the service.
stringAWS region.
+ +For more information, see AWS::NeptuneGraph::Graph. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all graphs in a region. +```sql +SELECT +region, +deletion_protection, +graph_name, +provisioned_memory, +public_connectivity, +replica_count, +tags, +vector_search_configuration, +endpoint, +graph_arn, +graph_id +FROM aws.neptunegraph.graphs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual graph. +```sql +SELECT +region, +deletion_protection, +graph_name, +provisioned_memory, +public_connectivity, +replica_count, +tags, +vector_search_configuration, +endpoint, +graph_arn, +graph_id +FROM aws.neptunegraph.graphs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new graph resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.neptunegraph.graphs ( + ProvisionedMemory, + region +) +SELECT +'{{ ProvisionedMemory }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.neptunegraph.graphs ( + DeletionProtection, + GraphName, + ProvisionedMemory, + PublicConnectivity, + ReplicaCount, + Tags, + VectorSearchConfiguration, + region +) +SELECT + '{{ DeletionProtection }}', + '{{ GraphName }}', + '{{ ProvisionedMemory }}', + '{{ PublicConnectivity }}', + '{{ ReplicaCount }}', + '{{ Tags }}', + '{{ VectorSearchConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: graph + props: + - name: DeletionProtection + value: '{{ DeletionProtection }}' + - name: GraphName + value: '{{ GraphName }}' + - name: ProvisionedMemory + value: '{{ ProvisionedMemory }}' + - name: PublicConnectivity + value: '{{ PublicConnectivity }}' + - name: ReplicaCount + value: '{{ ReplicaCount }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VectorSearchConfiguration + value: + VectorSearchDimension: '{{ VectorSearchDimension }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.neptunegraph.graphs +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +neptune-graph:GetGraph, +neptune-graph:ListGraphs, +kms:DescribeKey, +kms:CreateGrant, +kms:Decrypt +``` diff --git a/website/docs/services/neptunegraph/graphs_list_only/index.md b/website/docs/services/neptunegraph/graphs_list_only/index.md new file mode 100644 index 0000000..9ee2f56 --- /dev/null +++ b/website/docs/services/neptunegraph/graphs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: graphs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - graphs_list_only + - neptunegraph + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists graphs in a region or regions, for all properties use graphs + +## Overview + + + + + + + +
Namegraphs_list_only
TypeResource
DescriptionThe AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe auto-generated id assigned by the service.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all graphs in a region. +```sql +SELECT +region, +graph_id +FROM aws.neptunegraph.graphs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the graphs_list_only resource, see graphs + diff --git a/website/docs/services/neptunegraph/index.md b/website/docs/services/neptunegraph/index.md new file mode 100644 index 0000000..c1dc0bc --- /dev/null +++ b/website/docs/services/neptunegraph/index.md @@ -0,0 +1,40 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The neptunegraph service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/neptunegraph/private_graph_endpoints/index.md b/website/docs/services/neptunegraph/private_graph_endpoints/index.md new file mode 100644 index 0000000..f6407b1 --- /dev/null +++ b/website/docs/services/neptunegraph/private_graph_endpoints/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a private_graph_endpoint resource or lists private_graph_endpoints in a region + +## Overview + + + + + + + +
Nameprivate_graph_endpoints
TypeResource
DescriptionThe AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe auto-generated Graph Id assigned by the service.
arrayThe security group Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
arrayThe subnet Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
stringThe VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
stringPrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.
For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`
stringVPC endpoint that provides a private connection between the Graph and specified VPC.
stringAWS region.
+ +For more information, see AWS::NeptuneGraph::PrivateGraphEndpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all private_graph_endpoints in a region. +```sql +SELECT +region, +graph_identifier, +security_group_ids, +subnet_ids, +vpc_id, +private_graph_endpoint_identifier, +vpc_endpoint_id +FROM aws.neptunegraph.private_graph_endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual private_graph_endpoint. +```sql +SELECT +region, +graph_identifier, +security_group_ids, +subnet_ids, +vpc_id, +private_graph_endpoint_identifier, +vpc_endpoint_id +FROM aws.neptunegraph.private_graph_endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new private_graph_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.neptunegraph.private_graph_endpoints ( + GraphIdentifier, + VpcId, + region +) +SELECT +'{{ GraphIdentifier }}', + '{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.neptunegraph.private_graph_endpoints ( + GraphIdentifier, + SecurityGroupIds, + SubnetIds, + VpcId, + region +) +SELECT + '{{ GraphIdentifier }}', + '{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ VpcId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: private_graph_endpoint + props: + - name: GraphIdentifier + value: '{{ GraphIdentifier }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: VpcId + value: '{{ VpcId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.neptunegraph.private_graph_endpoints +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +neptune-graph:GetPrivateGraphEndpoint, +neptune-graph:ListPrivateGraphEndpoints +``` diff --git a/website/docs/services/neptunegraph/private_graph_endpoints_list_only/index.md b/website/docs/services/neptunegraph/private_graph_endpoints_list_only/index.md new file mode 100644 index 0000000..71cc548 --- /dev/null +++ b/website/docs/services/neptunegraph/private_graph_endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: private_graph_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - private_graph_endpoints_list_only + - neptunegraph + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists private_graph_endpoints in a region or regions, for all properties use private_graph_endpoints + +## Overview + + + + + + + +
Nameprivate_graph_endpoints_list_only
TypeResource
DescriptionThe AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringPrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.
For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all private_graph_endpoints in a region. +```sql +SELECT +region, +private_graph_endpoint_identifier +FROM aws.neptunegraph.private_graph_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the private_graph_endpoints_list_only resource, see private_graph_endpoints + diff --git a/website/docs/services/networkfirewall/firewall_policies/index.md b/website/docs/services/networkfirewall/firewall_policies/index.md new file mode 100644 index 0000000..f17418a --- /dev/null +++ b/website/docs/services/networkfirewall/firewall_policies/index.md @@ -0,0 +1,242 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a firewall_policy resource or lists firewall_policies in a region + +## Overview + + + + + + + +
Namefirewall_policies
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::FirewallPolicy
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::FirewallPolicy
string
string
array
stringAWS region.
+ +For more information, see AWS::NetworkFirewall::FirewallPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all firewall_policies in a region. +```sql +SELECT +region, +firewall_policy_name, +firewall_policy_arn, +firewall_policy, +firewall_policy_id, +description, +tags +FROM aws.networkfirewall.firewall_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual firewall_policy. +```sql +SELECT +region, +firewall_policy_name, +firewall_policy_arn, +firewall_policy, +firewall_policy_id, +description, +tags +FROM aws.networkfirewall.firewall_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new firewall_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkfirewall.firewall_policies ( + FirewallPolicyName, + FirewallPolicy, + region +) +SELECT +'{{ FirewallPolicyName }}', + '{{ FirewallPolicy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkfirewall.firewall_policies ( + FirewallPolicyName, + FirewallPolicy, + Description, + Tags, + region +) +SELECT + '{{ FirewallPolicyName }}', + '{{ FirewallPolicy }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: firewall_policy + props: + - name: FirewallPolicyName + value: '{{ FirewallPolicyName }}' + - name: FirewallPolicy + value: + FirewallPolicyName: '{{ FirewallPolicyName }}' + FirewallPolicy: null + Description: '{{ Description }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkfirewall.firewall_policies +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +network-firewall:ListFirewallPolicies +``` diff --git a/website/docs/services/networkfirewall/firewall_policies_list_only/index.md b/website/docs/services/networkfirewall/firewall_policies_list_only/index.md new file mode 100644 index 0000000..e576225 --- /dev/null +++ b/website/docs/services/networkfirewall/firewall_policies_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: firewall_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_policies_list_only + - networkfirewall + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists firewall_policies in a region or regions, for all properties use firewall_policies + +## Overview + + + + + + + +
Namefirewall_policies_list_only
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::FirewallPolicy
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::FirewallPolicy
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all firewall_policies in a region. +```sql +SELECT +region, +firewall_policy_arn +FROM aws.networkfirewall.firewall_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_policies_list_only resource, see firewall_policies + diff --git a/website/docs/services/networkfirewall/firewall_policy_tags/index.md b/website/docs/services/networkfirewall/firewall_policy_tags/index.md new file mode 100644 index 0000000..4512555 --- /dev/null +++ b/website/docs/services/networkfirewall/firewall_policy_tags/index.md @@ -0,0 +1,85 @@ +--- +title: firewall_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_policy_tags + - networkfirewall + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for firewall_policies in a region + +## Overview + + + + + + + +
Namefirewall_policy_tags
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::FirewallPolicy
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::FirewallPolicy
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all firewall_policies in a region. +```sql +SELECT +region, +firewall_policy_name, +firewall_policy_arn, +firewall_policy, +firewall_policy_id, +description, +tag_key, +tag_value +FROM aws.networkfirewall.firewall_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_policy_tags resource, see firewall_policies + diff --git a/website/docs/services/networkfirewall/firewall_tags/index.md b/website/docs/services/networkfirewall/firewall_tags/index.md new file mode 100644 index 0000000..9231eb2 --- /dev/null +++ b/website/docs/services/networkfirewall/firewall_tags/index.md @@ -0,0 +1,97 @@ +--- +title: firewall_tags +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_tags + - networkfirewall + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for firewalls in a region + +## Overview + + + + + + + +
Namefirewall_tags
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::Firewall
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
string
stringA resource ARN.
string
array
boolean
boolean
boolean
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all firewalls in a region. +```sql +SELECT +region, +firewall_name, +firewall_arn, +firewall_id, +firewall_policy_arn, +vpc_id, +subnet_mappings, +delete_protection, +subnet_change_protection, +firewall_policy_change_protection, +description, +endpoint_ids, +tag_key, +tag_value +FROM aws.networkfirewall.firewall_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_tags resource, see firewalls + diff --git a/website/docs/services/networkfirewall/firewalls/index.md b/website/docs/services/networkfirewall/firewalls/index.md new file mode 100644 index 0000000..0285054 --- /dev/null +++ b/website/docs/services/networkfirewall/firewalls/index.md @@ -0,0 +1,298 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a firewall resource or lists firewalls in a region + +## Overview + + + + + + + +
Namefirewalls
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::Firewall
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
string
stringA resource ARN.
string
array
boolean
boolean
boolean
string
array
array
stringAWS region.
+ +For more information, see AWS::NetworkFirewall::Firewall. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all firewalls in a region. +```sql +SELECT +region, +firewall_name, +firewall_arn, +firewall_id, +firewall_policy_arn, +vpc_id, +subnet_mappings, +delete_protection, +subnet_change_protection, +firewall_policy_change_protection, +description, +endpoint_ids, +tags +FROM aws.networkfirewall.firewalls +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual firewall. +```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.firewalls +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new firewall resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkfirewall.firewalls ( + FirewallName, + FirewallPolicyArn, + VpcId, + SubnetMappings, + region +) +SELECT +'{{ FirewallName }}', + '{{ FirewallPolicyArn }}', + '{{ VpcId }}', + '{{ SubnetMappings }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkfirewall.firewalls ( + FirewallName, + FirewallPolicyArn, + VpcId, + SubnetMappings, + DeleteProtection, + SubnetChangeProtection, + FirewallPolicyChangeProtection, + Description, + Tags, + region +) +SELECT + '{{ FirewallName }}', + '{{ FirewallPolicyArn }}', + '{{ VpcId }}', + '{{ SubnetMappings }}', + '{{ DeleteProtection }}', + '{{ SubnetChangeProtection }}', + '{{ FirewallPolicyChangeProtection }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: firewall + props: + - name: FirewallName + value: '{{ FirewallName }}' + - name: FirewallPolicyArn + value: '{{ FirewallPolicyArn }}' + - name: VpcId + value: '{{ VpcId }}' + - name: SubnetMappings + value: + - SubnetId: '{{ SubnetId }}' + IPAddressType: '{{ IPAddressType }}' + - name: DeleteProtection + value: '{{ DeleteProtection }}' + - name: SubnetChangeProtection + value: '{{ SubnetChangeProtection }}' + - name: FirewallPolicyChangeProtection + value: '{{ FirewallPolicyChangeProtection }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkfirewall.firewalls +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +network-firewall:DescribeFirewall, +network-firewall:ListTagsForResource +``` + +### 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 +``` + +### List +```json +network-firewall:ListFirewalls +``` diff --git a/website/docs/services/networkfirewall/firewalls_list_only/index.md b/website/docs/services/networkfirewall/firewalls_list_only/index.md new file mode 100644 index 0000000..21d3b54 --- /dev/null +++ b/website/docs/services/networkfirewall/firewalls_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: firewalls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - firewalls_list_only + - networkfirewall + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists firewalls in a region or regions, for all properties use firewalls + +## Overview + + + + + + + +
Namefirewalls_list_only
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::Firewall
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA resource ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all firewalls in a region. +```sql +SELECT +region, +firewall_arn +FROM aws.networkfirewall.firewalls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewalls_list_only resource, see firewalls + diff --git a/website/docs/services/networkfirewall/index.md b/website/docs/services/networkfirewall/index.md new file mode 100644 index 0000000..7db035e --- /dev/null +++ b/website/docs/services/networkfirewall/index.md @@ -0,0 +1,48 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The networkfirewall service documentation. + +:::info Service Summary + +
+
+total resources: 13
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/networkfirewall/logging_configurations/index.md b/website/docs/services/networkfirewall/logging_configurations/index.md new file mode 100644 index 0000000..d6986a3 --- /dev/null +++ b/website/docs/services/networkfirewall/logging_configurations/index.md @@ -0,0 +1,224 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a logging_configuration resource or lists logging_configurations in a region + +## Overview + + + + + + + +
Namelogging_configurations
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::LoggingConfiguration
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::LoggingConfiguration
stringAWS region.
+ +For more information, see AWS::NetworkFirewall::LoggingConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual logging_configuration. +```sql +SELECT +region, +firewall_name, +firewall_arn, +logging_configuration +FROM aws.networkfirewall.logging_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new logging_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkfirewall.logging_configurations ( + FirewallArn, + LoggingConfiguration, + region +) +SELECT +'{{ FirewallArn }}', + '{{ LoggingConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkfirewall.logging_configurations ( + FirewallName, + FirewallArn, + LoggingConfiguration, + region +) +SELECT + '{{ FirewallName }}', + '{{ FirewallArn }}', + '{{ LoggingConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: logging_configuration + props: + - name: FirewallName + value: '{{ FirewallName }}' + - name: FirewallArn + value: '{{ FirewallArn }}' + - name: LoggingConfiguration + value: + FirewallName: '{{ FirewallName }}' + FirewallArn: null + LoggingConfiguration: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkfirewall.logging_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/networkfirewall/rule_group_tags/index.md b/website/docs/services/networkfirewall/rule_group_tags/index.md new file mode 100644 index 0000000..78679df --- /dev/null +++ b/website/docs/services/networkfirewall/rule_group_tags/index.md @@ -0,0 +1,89 @@ +--- +title: rule_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rule_group_tags + - networkfirewall + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rule_groups in a region + +## Overview + + + + + + + +
Namerule_group_tags
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::RuleGroup
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
string
objectResource type definition for AWS::NetworkFirewall::RuleGroup
string
integer
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rule_groups in a region. +```sql +SELECT +region, +rule_group_name, +rule_group_arn, +rule_group_id, +rule_group, +type, +capacity, +description, +tag_key, +tag_value +FROM aws.networkfirewall.rule_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_group_tags resource, see rule_groups + diff --git a/website/docs/services/networkfirewall/rule_groups/index.md b/website/docs/services/networkfirewall/rule_groups/index.md new file mode 100644 index 0000000..24c84cc --- /dev/null +++ b/website/docs/services/networkfirewall/rule_groups/index.md @@ -0,0 +1,261 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a rule_group resource or lists rule_groups in a region + +## Overview + + + + + + + +
Namerule_groups
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::RuleGroup
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
string
objectResource type definition for AWS::NetworkFirewall::RuleGroup
string
integer
string
array
stringAWS region.
+ +For more information, see AWS::NetworkFirewall::RuleGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rule_groups in a region. +```sql +SELECT +region, +rule_group_name, +rule_group_arn, +rule_group_id, +rule_group, +type, +capacity, +description, +tags +FROM aws.networkfirewall.rule_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual rule_group. +```sql +SELECT +region, +rule_group_name, +rule_group_arn, +rule_group_id, +rule_group, +type, +capacity, +description, +tags +FROM aws.networkfirewall.rule_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rule_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkfirewall.rule_groups ( + RuleGroupName, + Type, + Capacity, + region +) +SELECT +'{{ RuleGroupName }}', + '{{ Type }}', + '{{ Capacity }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkfirewall.rule_groups ( + RuleGroupName, + RuleGroup, + Type, + Capacity, + Description, + Tags, + region +) +SELECT + '{{ RuleGroupName }}', + '{{ RuleGroup }}', + '{{ Type }}', + '{{ Capacity }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: rule_group + props: + - name: RuleGroupName + value: '{{ RuleGroupName }}' + - name: RuleGroup + value: + RuleGroupName: '{{ RuleGroupName }}' + RuleGroup: null + Type: '{{ Type }}' + Capacity: '{{ Capacity }}' + Description: '{{ Description }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + - name: Capacity + value: '{{ Capacity }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkfirewall.rule_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +network-firewall:ListRuleGroups +``` diff --git a/website/docs/services/networkfirewall/rule_groups_list_only/index.md b/website/docs/services/networkfirewall/rule_groups_list_only/index.md new file mode 100644 index 0000000..7088563 --- /dev/null +++ b/website/docs/services/networkfirewall/rule_groups_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: rule_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups_list_only + - networkfirewall + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rule_groups in a region or regions, for all properties use rule_groups + +## Overview + + + + + + + +
Namerule_groups_list_only
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::RuleGroup
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::RuleGroup
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rule_groups in a region. +```sql +SELECT +region, +rule_group_arn +FROM aws.networkfirewall.rule_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_groups_list_only resource, see rule_groups + diff --git a/website/docs/services/networkfirewall/tls_inspection_configuration_tags/index.md b/website/docs/services/networkfirewall/tls_inspection_configuration_tags/index.md new file mode 100644 index 0000000..9c2b1b5 --- /dev/null +++ b/website/docs/services/networkfirewall/tls_inspection_configuration_tags/index.md @@ -0,0 +1,85 @@ +--- +title: tls_inspection_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - tls_inspection_configuration_tags + - networkfirewall + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for tls_inspection_configurations in a region + +## Overview + + + + + + + +
Nametls_inspection_configuration_tags
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all tls_inspection_configurations in a region. +```sql +SELECT +region, +tls_inspection_configuration_name, +tls_inspection_configuration_arn, +tls_inspection_configuration, +tls_inspection_configuration_id, +description, +tag_key, +tag_value +FROM aws.networkfirewall.tls_inspection_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tls_inspection_configuration_tags resource, see tls_inspection_configurations + diff --git a/website/docs/services/networkfirewall/tls_inspection_configurations/index.md b/website/docs/services/networkfirewall/tls_inspection_configurations/index.md new file mode 100644 index 0000000..8fc1607 --- /dev/null +++ b/website/docs/services/networkfirewall/tls_inspection_configurations/index.md @@ -0,0 +1,239 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a tls_inspection_configuration resource or lists tls_inspection_configurations in a region + +## Overview + + + + + + + +
Nametls_inspection_configurations
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
string
string
array
stringAWS region.
+ +For more information, see AWS::NetworkFirewall::TLSInspectionConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all tls_inspection_configurations in a region. +```sql +SELECT +region, +tls_inspection_configuration_name, +tls_inspection_configuration_arn, +tls_inspection_configuration, +tls_inspection_configuration_id, +description, +tags +FROM aws.networkfirewall.tls_inspection_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual tls_inspection_configuration. +```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_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tls_inspection_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkfirewall.tls_inspection_configurations ( + TLSInspectionConfigurationName, + TLSInspectionConfiguration, + region +) +SELECT +'{{ TLSInspectionConfigurationName }}', + '{{ TLSInspectionConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkfirewall.tls_inspection_configurations ( + TLSInspectionConfigurationName, + TLSInspectionConfiguration, + Description, + Tags, + region +) +SELECT + '{{ TLSInspectionConfigurationName }}', + '{{ TLSInspectionConfiguration }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: tls_inspection_configuration + props: + - name: TLSInspectionConfigurationName + value: '{{ TLSInspectionConfigurationName }}' + - name: TLSInspectionConfiguration + value: + TLSInspectionConfigurationName: '{{ TLSInspectionConfigurationName }}' + TLSInspectionConfiguration: null + Description: '{{ Description }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkfirewall.tls_inspection_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +network-firewall:ListTLSInspectionConfigurations +``` diff --git a/website/docs/services/networkfirewall/tls_inspection_configurations_list_only/index.md b/website/docs/services/networkfirewall/tls_inspection_configurations_list_only/index.md new file mode 100644 index 0000000..68f79c6 --- /dev/null +++ b/website/docs/services/networkfirewall/tls_inspection_configurations_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: tls_inspection_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tls_inspection_configurations_list_only + - networkfirewall + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tls_inspection_configurations in a region or regions, for all properties use tls_inspection_configurations + +## Overview + + + + + + + +
Nametls_inspection_configurations_list_only
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tls_inspection_configurations in a region. +```sql +SELECT +region, +tls_inspection_configuration_arn +FROM aws.networkfirewall.tls_inspection_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tls_inspection_configurations_list_only resource, see tls_inspection_configurations + diff --git a/website/docs/services/networkmanager/connect_attachment_tags/index.md b/website/docs/services/networkmanager/connect_attachment_tags/index.md new file mode 100644 index 0000000..a51e548 --- /dev/null +++ b/website/docs/services/networkmanager/connect_attachment_tags/index.md @@ -0,0 +1,109 @@ +--- +title: connect_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connect_attachment_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connect_attachments in a region + +## Overview + + + + + + + +
Nameconnect_attachment_tags
TypeResource
DescriptionAWS::NetworkManager::ConnectAttachment Resource Type Definition
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the CoreNetwork that the attachment will be attached to.
stringThe ARN of a core network.
stringThe ID of the attachment.
stringThe ID of the attachment account owner.
stringThe type of attachment.
stringState of the attachment.
stringEdge location of the attachment.
stringThe attachment resource ARN.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment.
objectThe attachment to move from one segment to another.
stringThe name of the network function group attachment.
objectThe attachment to move from one network function group to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringId of transport attachment
objectProtocol options for connect attachment
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connect_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +created_at, +updated_at, +transport_attachment_id, +options, +tag_key, +tag_value +FROM aws.networkmanager.connect_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connect_attachment_tags resource, see connect_attachments + diff --git a/website/docs/services/networkmanager/connect_attachments/index.md b/website/docs/services/networkmanager/connect_attachments/index.md new file mode 100644 index 0000000..6073598 --- /dev/null +++ b/website/docs/services/networkmanager/connect_attachments/index.md @@ -0,0 +1,299 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connect_attachment resource or lists connect_attachments in a region + +## Overview + + + + + + + +
Nameconnect_attachments
TypeResource
DescriptionAWS::NetworkManager::ConnectAttachment Resource Type Definition
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the CoreNetwork that the attachment will be attached to.
stringThe ARN of a core network.
stringThe ID of the attachment.
stringThe ID of the attachment account owner.
stringThe type of attachment.
stringState of the attachment.
stringEdge location of the attachment.
stringThe attachment resource ARN.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment.
objectThe attachment to move from one segment to another.
stringThe name of the network function group attachment.
objectThe attachment to move from one network function group to another.
arrayTags for the attachment.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringId of transport attachment
objectProtocol options for connect attachment
stringAWS region.
+ +For more information, see AWS::NetworkManager::ConnectAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connect_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +tags, +created_at, +updated_at, +transport_attachment_id, +options +FROM aws.networkmanager.connect_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connect_attachment. +```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, +network_function_group_name, +proposed_network_function_group_change, +tags, +created_at, +updated_at, +transport_attachment_id, +options +FROM aws.networkmanager.connect_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connect_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.connect_attachments ( + CoreNetworkId, + EdgeLocation, + TransportAttachmentId, + Options, + region +) +SELECT +'{{ CoreNetworkId }}', + '{{ EdgeLocation }}', + '{{ TransportAttachmentId }}', + '{{ Options }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.connect_attachments ( + CoreNetworkId, + EdgeLocation, + ProposedSegmentChange, + NetworkFunctionGroupName, + ProposedNetworkFunctionGroupChange, + Tags, + TransportAttachmentId, + Options, + region +) +SELECT + '{{ CoreNetworkId }}', + '{{ EdgeLocation }}', + '{{ ProposedSegmentChange }}', + '{{ NetworkFunctionGroupName }}', + '{{ ProposedNetworkFunctionGroupChange }}', + '{{ Tags }}', + '{{ TransportAttachmentId }}', + '{{ Options }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connect_attachment + props: + - name: CoreNetworkId + value: '{{ CoreNetworkId }}' + - name: EdgeLocation + value: '{{ EdgeLocation }}' + - name: ProposedSegmentChange + value: + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}' + SegmentName: '{{ SegmentName }}' + - name: NetworkFunctionGroupName + value: '{{ NetworkFunctionGroupName }}' + - name: ProposedNetworkFunctionGroupChange + value: + Tags: + - null + AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}' + NetworkFunctionGroupName: '{{ NetworkFunctionGroupName }}' + - name: Tags + value: + - null + - name: TransportAttachmentId + value: '{{ TransportAttachmentId }}' + - name: Options + value: + Protocol: '{{ Protocol }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.connect_attachments +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +networkmanager:GetConnectAttachment +``` + +### Update +```json +networkmanager:GetConnectAttachment, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:GetConnectAttachment, +networkmanager:DeleteAttachment, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListAttachments +``` diff --git a/website/docs/services/networkmanager/connect_attachments_list_only/index.md b/website/docs/services/networkmanager/connect_attachments_list_only/index.md new file mode 100644 index 0000000..d75cfb0 --- /dev/null +++ b/website/docs/services/networkmanager/connect_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connect_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connect_attachments_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connect_attachments in a region or regions, for all properties use connect_attachments + +## Overview + + + + + + + +
Nameconnect_attachments_list_only
TypeResource
DescriptionAWS::NetworkManager::ConnectAttachment Resource Type Definition
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connect_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.connect_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connect_attachments_list_only resource, see connect_attachments + diff --git a/website/docs/services/networkmanager/connect_peer_tags/index.md b/website/docs/services/networkmanager/connect_peer_tags/index.md new file mode 100644 index 0000000..1218621 --- /dev/null +++ b/website/docs/services/networkmanager/connect_peer_tags/index.md @@ -0,0 +1,99 @@ +--- +title: connect_peer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connect_peer_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connect_peers in a region + +## Overview + + + + + + + +
Nameconnect_peer_tags
TypeResource
DescriptionAWS::NetworkManager::ConnectPeer Resource Type Definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address of the Connect peer.
stringThe IP address of a core network.
objectBgp options for connect peer.
arrayThe inside IP addresses used for a Connect peer configuration.
stringThe ID of the core network.
stringThe ID of the attachment to connect.
stringThe ID of the Connect peer.
stringThe Connect peer Regions where edges are located.
stringState of the connect peer.
stringConnect peer creation time.
objectConfiguration of the connect peer.
stringThe subnet ARN for the connect peer.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connect_peers in a region. +```sql +SELECT +region, +peer_address, +core_network_address, +bgp_options, +inside_cidr_blocks, +core_network_id, +connect_attachment_id, +connect_peer_id, +edge_location, +state, +created_at, +configuration, +subnet_arn, +tag_key, +tag_value +FROM aws.networkmanager.connect_peer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connect_peer_tags resource, see connect_peers + diff --git a/website/docs/services/networkmanager/connect_peers/index.md b/website/docs/services/networkmanager/connect_peers/index.md new file mode 100644 index 0000000..6fd5b33 --- /dev/null +++ b/website/docs/services/networkmanager/connect_peers/index.md @@ -0,0 +1,269 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connect_peer resource or lists connect_peers in a region + +## Overview + + + + + + + +
Nameconnect_peers
TypeResource
DescriptionAWS::NetworkManager::ConnectPeer Resource Type Definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address of the Connect peer.
stringThe IP address of a core network.
objectBgp options for connect peer.
arrayThe inside IP addresses used for a Connect peer configuration.
stringThe ID of the core network.
stringThe ID of the attachment to connect.
stringThe ID of the Connect peer.
stringThe Connect peer Regions where edges are located.
stringState of the connect peer.
stringConnect peer creation time.
objectConfiguration of the connect peer.
stringThe subnet ARN for the connect peer.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::NetworkManager::ConnectPeer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connect_peers in a region. +```sql +SELECT +region, +peer_address, +core_network_address, +bgp_options, +inside_cidr_blocks, +core_network_id, +connect_attachment_id, +connect_peer_id, +edge_location, +state, +created_at, +configuration, +subnet_arn, +tags +FROM aws.networkmanager.connect_peers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connect_peer. +```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_peers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connect_peer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.connect_peers ( + PeerAddress, + ConnectAttachmentId, + region +) +SELECT +'{{ PeerAddress }}', + '{{ ConnectAttachmentId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.connect_peers ( + PeerAddress, + CoreNetworkAddress, + BgpOptions, + InsideCidrBlocks, + ConnectAttachmentId, + SubnetArn, + Tags, + region +) +SELECT + '{{ PeerAddress }}', + '{{ CoreNetworkAddress }}', + '{{ BgpOptions }}', + '{{ InsideCidrBlocks }}', + '{{ ConnectAttachmentId }}', + '{{ SubnetArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connect_peer + props: + - name: PeerAddress + value: '{{ PeerAddress }}' + - name: CoreNetworkAddress + value: '{{ CoreNetworkAddress }}' + - name: BgpOptions + value: + PeerAsn: null + - name: InsideCidrBlocks + value: + - '{{ InsideCidrBlocks[0] }}' + - name: ConnectAttachmentId + value: '{{ ConnectAttachmentId }}' + - name: SubnetArn + value: '{{ SubnetArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.connect_peers +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +networkmanager:GetConnectPeer +``` + +### Update +```json +networkmanager:GetConnectPeer, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:GetConnectPeer, +networkmanager:DeleteConnectPeer, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListConnectPeers +``` diff --git a/website/docs/services/networkmanager/connect_peers_list_only/index.md b/website/docs/services/networkmanager/connect_peers_list_only/index.md new file mode 100644 index 0000000..104b7ed --- /dev/null +++ b/website/docs/services/networkmanager/connect_peers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connect_peers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connect_peers_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connect_peers in a region or regions, for all properties use connect_peers + +## Overview + + + + + + + +
Nameconnect_peers_list_only
TypeResource
DescriptionAWS::NetworkManager::ConnectPeer Resource Type Definition.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the Connect peer.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connect_peers in a region. +```sql +SELECT +region, +connect_peer_id +FROM aws.networkmanager.connect_peers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connect_peers_list_only resource, see connect_peers + diff --git a/website/docs/services/networkmanager/core_network_tags/index.md b/website/docs/services/networkmanager/core_network_tags/index.md new file mode 100644 index 0000000..ac75770 --- /dev/null +++ b/website/docs/services/networkmanager/core_network_tags/index.md @@ -0,0 +1,97 @@ +--- +title: core_network_tags +hide_title: false +hide_table_of_contents: false +keywords: + - core_network_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for core_networks in a region + +## Overview + + + + + + + +
Namecore_network_tags
TypeResource
DescriptionAWS::NetworkManager::CoreNetwork Resource Type Definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the global network that your core network is a part of.
stringThe Id of core network
stringThe ARN (Amazon resource name) of core network
objectLive policy document for the core network, you must provide PolicyDocument in Json Format
stringThe description of core network
stringThe creation time of core network
stringThe state of core network
arrayThe segments within a core network.
arrayThe network function groups within a core network.
arrayThe edges within a core network.
stringOwner of the core network
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all core_networks in a region. +```sql +SELECT +region, +global_network_id, +core_network_id, +core_network_arn, +policy_document, +description, +created_at, +state, +segments, +network_function_groups, +edges, +owner_account, +tag_key, +tag_value +FROM aws.networkmanager.core_network_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the core_network_tags resource, see core_networks + diff --git a/website/docs/services/networkmanager/core_networks/index.md b/website/docs/services/networkmanager/core_networks/index.md new file mode 100644 index 0000000..9d68c79 --- /dev/null +++ b/website/docs/services/networkmanager/core_networks/index.md @@ -0,0 +1,258 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a core_network resource or lists core_networks in a region + +## Overview + + + + + + + +
Namecore_networks
TypeResource
DescriptionAWS::NetworkManager::CoreNetwork Resource Type Definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the global network that your core network is a part of.
stringThe Id of core network
stringThe ARN (Amazon resource name) of core network
objectLive policy document for the core network, you must provide PolicyDocument in Json Format
stringThe description of core network
stringThe creation time of core network
stringThe state of core network
arrayThe segments within a core network.
arrayThe network function groups within a core network.
arrayThe edges within a core network.
stringOwner of the core network
arrayThe tags for the global network.
stringAWS region.
+ +For more information, see AWS::NetworkManager::CoreNetwork. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all core_networks in a region. +```sql +SELECT +region, +global_network_id, +core_network_id, +core_network_arn, +policy_document, +description, +created_at, +state, +segments, +network_function_groups, +edges, +owner_account, +tags +FROM aws.networkmanager.core_networks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual core_network. +```sql +SELECT +region, +global_network_id, +core_network_id, +core_network_arn, +policy_document, +description, +created_at, +state, +segments, +network_function_groups, +edges, +owner_account, +tags +FROM aws.networkmanager.core_networks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new core_network resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.core_networks ( + GlobalNetworkId, + region +) +SELECT +'{{ GlobalNetworkId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.core_networks ( + GlobalNetworkId, + PolicyDocument, + Description, + Tags, + region +) +SELECT + '{{ GlobalNetworkId }}', + '{{ PolicyDocument }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: core_network + props: + - name: GlobalNetworkId + value: '{{ GlobalNetworkId }}' + - name: PolicyDocument + value: {} + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.core_networks +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +networkmanager:ListCoreNetworks +``` diff --git a/website/docs/services/networkmanager/core_networks_list_only/index.md b/website/docs/services/networkmanager/core_networks_list_only/index.md new file mode 100644 index 0000000..dfe5a7f --- /dev/null +++ b/website/docs/services/networkmanager/core_networks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: core_networks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - core_networks_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists core_networks in a region or regions, for all properties use core_networks + +## Overview + + + + + + + +
Namecore_networks_list_only
TypeResource
DescriptionAWS::NetworkManager::CoreNetwork Resource Type Definition.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Id of core network
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all core_networks in a region. +```sql +SELECT +region, +core_network_id +FROM aws.networkmanager.core_networks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the core_networks_list_only resource, see core_networks + diff --git a/website/docs/services/networkmanager/customer_gateway_associations/index.md b/website/docs/services/networkmanager/customer_gateway_associations/index.md new file mode 100644 index 0000000..d397505 --- /dev/null +++ b/website/docs/services/networkmanager/customer_gateway_associations/index.md @@ -0,0 +1,210 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a customer_gateway_association resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of the global network.
stringThe Amazon Resource Name (ARN) of the customer gateway.
stringThe ID of the device
stringThe ID of the link
stringAWS region.
+ +For more information, see AWS::NetworkManager::CustomerGatewayAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all customer_gateway_associations in a region. +```sql +SELECT +region, +global_network_id, +customer_gateway_arn, +device_id, +link_id +FROM aws.networkmanager.customer_gateway_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual customer_gateway_association. +```sql +SELECT +region, +global_network_id, +customer_gateway_arn, +device_id, +link_id +FROM aws.networkmanager.customer_gateway_associations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new customer_gateway_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.customer_gateway_associations ( + GlobalNetworkId, + CustomerGatewayArn, + DeviceId, + region +) +SELECT +'{{ GlobalNetworkId }}', + '{{ CustomerGatewayArn }}', + '{{ DeviceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.customer_gateway_associations ( + GlobalNetworkId, + CustomerGatewayArn, + DeviceId, + LinkId, + region +) +SELECT + '{{ GlobalNetworkId }}', + '{{ CustomerGatewayArn }}', + '{{ DeviceId }}', + '{{ LinkId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: customer_gateway_association + props: + - name: GlobalNetworkId + value: '{{ GlobalNetworkId }}' + - name: CustomerGatewayArn + value: '{{ CustomerGatewayArn }}' + - name: DeviceId + value: '{{ DeviceId }}' + - name: LinkId + value: '{{ LinkId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.customer_gateway_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the customer_gateway_associations resource, the following permissions are required: + +### Create +```json +networkmanager:GetCustomerGatewayAssociations, +networkmanager:AssociateCustomerGateway +``` + +### Read +```json +networkmanager:GetCustomerGatewayAssociations +``` + +### List +```json +networkmanager:GetCustomerGatewayAssociations +``` + +### Delete +```json +networkmanager:DisassociateCustomerGateway +``` diff --git a/website/docs/services/networkmanager/customer_gateway_associations_list_only/index.md b/website/docs/services/networkmanager/customer_gateway_associations_list_only/index.md new file mode 100644 index 0000000..11139aa --- /dev/null +++ b/website/docs/services/networkmanager/customer_gateway_associations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: customer_gateway_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - customer_gateway_associations_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists customer_gateway_associations in a region or regions, for all properties use customer_gateway_associations + +## Overview + + + + + + + +
Namecustomer_gateway_associations_list_only
TypeResource
DescriptionThe AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the global network.
stringThe Amazon Resource Name (ARN) of the customer gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all customer_gateway_associations in a region. +```sql +SELECT +region, +global_network_id, +customer_gateway_arn +FROM aws.networkmanager.customer_gateway_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the customer_gateway_associations_list_only resource, see customer_gateway_associations + diff --git a/website/docs/services/networkmanager/device_tags/index.md b/website/docs/services/networkmanager/device_tags/index.md new file mode 100644 index 0000000..64a8bb4 --- /dev/null +++ b/website/docs/services/networkmanager/device_tags/index.md @@ -0,0 +1,101 @@ +--- +title: device_tags +hide_title: false +hide_table_of_contents: false +keywords: + - device_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for devices in a region + +## Overview + + + + + + + +
Namedevice_tags
TypeResource
DescriptionThe AWS::NetworkManager::Device type describes a device.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the device.
stringThe ID of the device.
stringThe description of the device.
stringThe ID of the global network.
objectThe Amazon Web Services location of the device, if applicable.
objectThe site location.
stringThe device model
stringThe device serial number.
stringThe site ID.
stringThe device type.
stringThe device vendor.
stringThe date and time that the device was created.
stringThe state of the device.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all devices in a region. +```sql +SELECT +region, +device_arn, +device_id, +description, +global_network_id, +aws_location, +location, +model, +serial_number, +site_id, +type, +vendor, +created_at, +state, +tag_key, +tag_value +FROM aws.networkmanager.device_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the device_tags resource, see devices + diff --git a/website/docs/services/networkmanager/devices/index.md b/website/docs/services/networkmanager/devices/index.md new file mode 100644 index 0000000..b96ba70 --- /dev/null +++ b/website/docs/services/networkmanager/devices/index.md @@ -0,0 +1,283 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a device resource or lists devices in a region + +## Overview + + + + + + + +
Namedevices
TypeResource
DescriptionThe AWS::NetworkManager::Device type describes a device.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the device.
stringThe ID of the device.
stringThe description of the device.
arrayThe tags for the device.
stringThe ID of the global network.
objectThe Amazon Web Services location of the device, if applicable.
objectThe site location.
stringThe device model
stringThe device serial number.
stringThe site ID.
stringThe device type.
stringThe device vendor.
stringThe date and time that the device was created.
stringThe state of the device.
stringAWS region.
+ +For more information, see AWS::NetworkManager::Device. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all devices in a region. +```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.devices +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual device. +```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.devices +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new device resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.devices ( + GlobalNetworkId, + region +) +SELECT +'{{ GlobalNetworkId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.devices ( + Description, + Tags, + GlobalNetworkId, + AWSLocation, + Location, + Model, + SerialNumber, + SiteId, + Type, + Vendor, + region +) +SELECT + '{{ Description }}', + '{{ Tags }}', + '{{ GlobalNetworkId }}', + '{{ AWSLocation }}', + '{{ Location }}', + '{{ Model }}', + '{{ SerialNumber }}', + '{{ SiteId }}', + '{{ Type }}', + '{{ Vendor }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: device + props: + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: GlobalNetworkId + value: '{{ GlobalNetworkId }}' + - name: AWSLocation + value: + Zone: '{{ Zone }}' + SubnetArn: '{{ SubnetArn }}' + - name: Location + value: + Address: '{{ Address }}' + Latitude: '{{ Latitude }}' + Longitude: '{{ Longitude }}' + - name: Model + value: '{{ Model }}' + - name: SerialNumber + value: '{{ SerialNumber }}' + - name: SiteId + value: '{{ SiteId }}' + - name: Type + value: '{{ Type }}' + - name: Vendor + value: '{{ Vendor }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.devices +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the devices resource, the following permissions are required: + +### Create +```json +networkmanager:CreateDevice, +networkmanager:GetDevices, +networkmanager:TagResource +``` + +### Read +```json +networkmanager:GetDevices +``` + +### Update +```json +networkmanager:UpdateDevice, +networkmanager:ListTagsForResource, +networkmanager:GetDevices, +networkmanager:TagResource, +networkmanager:UntagResource +``` + +### Delete +```json +networkmanager:GetDevices, +networkmanager:DeleteDevice +``` + +### List +```json +networkmanager:GetDevices +``` diff --git a/website/docs/services/networkmanager/devices_list_only/index.md b/website/docs/services/networkmanager/devices_list_only/index.md new file mode 100644 index 0000000..77ebadf --- /dev/null +++ b/website/docs/services/networkmanager/devices_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: devices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - devices_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists devices in a region or regions, for all properties use devices + +## Overview + + + + + + + +
Namedevices_list_only
TypeResource
DescriptionThe AWS::NetworkManager::Device type describes a device.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the device.
stringThe ID of the global network.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all devices in a region. +```sql +SELECT +region, +global_network_id, +device_id +FROM aws.networkmanager.devices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the devices_list_only resource, see devices + diff --git a/website/docs/services/networkmanager/direct_connect_gateway_attachment_tags/index.md b/website/docs/services/networkmanager/direct_connect_gateway_attachment_tags/index.md new file mode 100644 index 0000000..39f6fc6 --- /dev/null +++ b/website/docs/services/networkmanager/direct_connect_gateway_attachment_tags/index.md @@ -0,0 +1,107 @@ +--- +title: direct_connect_gateway_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - direct_connect_gateway_attachment_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for direct_connect_gateway_attachments in a region + +## Overview + + + + + + + +
Namedirect_connect_gateway_attachment_tags
TypeResource
DescriptionAWS::NetworkManager::DirectConnectGatewayAttachment Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of a core network for the Direct Connect Gateway attachment.
stringThe ARN of a core network for the Direct Connect Gateway attachment.
stringId of the attachment.
stringOwner account of the attachment.
stringAttachment type.
stringState of the attachment.
arrayThe Regions where the edges are located.
stringThe ARN of the Direct Connect Gateway.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment..
objectThe attachment to move from one segment to another.
stringThe name of the network function group attachment.
objectThe attachment to move from one network function group to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all direct_connect_gateway_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_locations, +direct_connect_gateway_arn, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +created_at, +updated_at, +tag_key, +tag_value +FROM aws.networkmanager.direct_connect_gateway_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the direct_connect_gateway_attachment_tags resource, see direct_connect_gateway_attachments + diff --git a/website/docs/services/networkmanager/direct_connect_gateway_attachments/index.md b/website/docs/services/networkmanager/direct_connect_gateway_attachments/index.md new file mode 100644 index 0000000..0d641fc --- /dev/null +++ b/website/docs/services/networkmanager/direct_connect_gateway_attachments/index.md @@ -0,0 +1,289 @@ +--- +title: direct_connect_gateway_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - direct_connect_gateway_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a direct_connect_gateway_attachment resource or lists direct_connect_gateway_attachments in a region + +## Overview + + + + + + + +
Namedirect_connect_gateway_attachments
TypeResource
DescriptionAWS::NetworkManager::DirectConnectGatewayAttachment Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of a core network for the Direct Connect Gateway attachment.
stringThe ARN of a core network for the Direct Connect Gateway attachment.
stringId of the attachment.
stringOwner account of the attachment.
stringAttachment type.
stringState of the attachment.
arrayThe Regions where the edges are located.
stringThe ARN of the Direct Connect Gateway.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment..
objectThe attachment to move from one segment to another.
stringThe name of the network function group attachment.
objectThe attachment to move from one network function group to another.
arrayTags for the attachment.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringAWS region.
+ +For more information, see AWS::NetworkManager::DirectConnectGatewayAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all direct_connect_gateway_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_locations, +direct_connect_gateway_arn, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +tags, +created_at, +updated_at +FROM aws.networkmanager.direct_connect_gateway_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual direct_connect_gateway_attachment. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_locations, +direct_connect_gateway_arn, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +tags, +created_at, +updated_at +FROM aws.networkmanager.direct_connect_gateway_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new direct_connect_gateway_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.direct_connect_gateway_attachments ( + CoreNetworkId, + EdgeLocations, + DirectConnectGatewayArn, + region +) +SELECT +'{{ CoreNetworkId }}', + '{{ EdgeLocations }}', + '{{ DirectConnectGatewayArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.direct_connect_gateway_attachments ( + CoreNetworkId, + EdgeLocations, + DirectConnectGatewayArn, + ProposedSegmentChange, + ProposedNetworkFunctionGroupChange, + Tags, + region +) +SELECT + '{{ CoreNetworkId }}', + '{{ EdgeLocations }}', + '{{ DirectConnectGatewayArn }}', + '{{ ProposedSegmentChange }}', + '{{ ProposedNetworkFunctionGroupChange }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: direct_connect_gateway_attachment + props: + - name: CoreNetworkId + value: '{{ CoreNetworkId }}' + - name: EdgeLocations + value: + - '{{ EdgeLocations[0] }}' + - name: DirectConnectGatewayArn + value: '{{ DirectConnectGatewayArn }}' + - name: ProposedSegmentChange + value: + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}' + SegmentName: '{{ SegmentName }}' + - name: ProposedNetworkFunctionGroupChange + value: + Tags: + - null + AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}' + NetworkFunctionGroupName: '{{ NetworkFunctionGroupName }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.direct_connect_gateway_attachments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the direct_connect_gateway_attachments resource, the following permissions are required: + +### Create +```json +networkmanager:CreateDirectConnectGatewayAttachment, +networkmanager:GetDirectConnectGatewayAttachment, +networkmanager:TagResource, +ec2:DescribeRegions, +iam:CreateServiceLinkedRole +``` + +### Read +```json +networkmanager:GetDirectConnectGatewayAttachment +``` + +### Update +```json +networkmanager:UpdateDirectConnectGatewayAttachment, +networkmanager:GetDirectConnectGatewayAttachment, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:DeleteAttachment, +networkmanager:GetDirectConnectGatewayAttachment, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListAttachments +``` diff --git a/website/docs/services/networkmanager/direct_connect_gateway_attachments_list_only/index.md b/website/docs/services/networkmanager/direct_connect_gateway_attachments_list_only/index.md new file mode 100644 index 0000000..36e3ba6 --- /dev/null +++ b/website/docs/services/networkmanager/direct_connect_gateway_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: direct_connect_gateway_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - direct_connect_gateway_attachments_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists direct_connect_gateway_attachments in a region or regions, for all properties use direct_connect_gateway_attachments + +## Overview + + + + + + + +
Namedirect_connect_gateway_attachments_list_only
TypeResource
DescriptionAWS::NetworkManager::DirectConnectGatewayAttachment Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId of the attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all direct_connect_gateway_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.direct_connect_gateway_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the direct_connect_gateway_attachments_list_only resource, see direct_connect_gateway_attachments + diff --git a/website/docs/services/networkmanager/global_network_tags/index.md b/website/docs/services/networkmanager/global_network_tags/index.md new file mode 100644 index 0000000..0552302 --- /dev/null +++ b/website/docs/services/networkmanager/global_network_tags/index.md @@ -0,0 +1,85 @@ +--- +title: global_network_tags +hide_title: false +hide_table_of_contents: false +keywords: + - global_network_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for global_networks in a region + +## Overview + + + + + + + +
Nameglobal_network_tags
TypeResource
DescriptionThe AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the global network.
stringThe ID of the global network.
stringThe description of the global network.
stringThe date and time that the global network was created.
stringThe state of the global network.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all global_networks in a region. +```sql +SELECT +region, +arn, +id, +description, +created_at, +state, +tag_key, +tag_value +FROM aws.networkmanager.global_network_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_network_tags resource, see global_networks + diff --git a/website/docs/services/networkmanager/global_networks/index.md b/website/docs/services/networkmanager/global_networks/index.md new file mode 100644 index 0000000..f55779d --- /dev/null +++ b/website/docs/services/networkmanager/global_networks/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a global_network resource or lists global_networks in a region + +## Overview + + + + + + + +
Nameglobal_networks
TypeResource
DescriptionThe AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the global network.
stringThe ID of the global network.
stringThe description of the global network.
arrayThe tags for the global network.
stringThe date and time that the global network was created.
stringThe state of the global network.
stringAWS region.
+ +For more information, see AWS::NetworkManager::GlobalNetwork. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all global_networks in a region. +```sql +SELECT +region, +arn, +id, +description, +tags, +created_at, +state +FROM aws.networkmanager.global_networks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual global_network. +```sql +SELECT +region, +arn, +id, +description, +tags, +created_at, +state +FROM aws.networkmanager.global_networks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new global_network resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.global_networks ( + Description, + Tags, + CreatedAt, + State, + region +) +SELECT +'{{ Description }}', + '{{ Tags }}', + '{{ CreatedAt }}', + '{{ State }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.global_networks ( + Description, + Tags, + CreatedAt, + State, + region +) +SELECT + '{{ Description }}', + '{{ Tags }}', + '{{ CreatedAt }}', + '{{ State }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: global_network + props: + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CreatedAt + value: '{{ CreatedAt }}' + - name: State + value: '{{ State }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.global_networks +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +networkmanager:DescribeGlobalNetworks +``` + +### Update +```json +networkmanager:UpdateGlobalNetwork, +networkmanager:DescribeGlobalNetworks, +networkmanager:TagResource, +networkmanager:UntagResource, +networkmanager:ListTagsForResource +``` + +### Delete +```json +networkmanager:DeleteGlobalNetwork, +networkmanager:DescribeGlobalNetworks +``` + +### List +```json +networkmanager:DescribeGlobalNetworks +``` diff --git a/website/docs/services/networkmanager/global_networks_list_only/index.md b/website/docs/services/networkmanager/global_networks_list_only/index.md new file mode 100644 index 0000000..e392719 --- /dev/null +++ b/website/docs/services/networkmanager/global_networks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: global_networks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - global_networks_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists global_networks in a region or regions, for all properties use global_networks + +## Overview + + + + + + + +
Nameglobal_networks_list_only
TypeResource
DescriptionThe AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the global network.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all global_networks in a region. +```sql +SELECT +region, +id +FROM aws.networkmanager.global_networks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_networks_list_only resource, see global_networks + diff --git a/website/docs/services/networkmanager/index.md b/website/docs/services/networkmanager/index.md new file mode 100644 index 0000000..14bc8ad --- /dev/null +++ b/website/docs/services/networkmanager/index.md @@ -0,0 +1,77 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The networkmanager service documentation. + +:::info Service Summary + +
+
+total resources: 42
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/networkmanager/link_associations/index.md b/website/docs/services/networkmanager/link_associations/index.md new file mode 100644 index 0000000..ee7cff1 --- /dev/null +++ b/website/docs/services/networkmanager/link_associations/index.md @@ -0,0 +1,203 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a link_association resource or lists 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.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the global network.
stringThe ID of the device
stringThe ID of the link
stringAWS region.
+ +For more information, see AWS::NetworkManager::LinkAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all link_associations in a region. +```sql +SELECT +region, +global_network_id, +device_id, +link_id +FROM aws.networkmanager.link_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual link_association. +```sql +SELECT +region, +global_network_id, +device_id, +link_id +FROM aws.networkmanager.link_associations +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new link_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.link_associations ( + GlobalNetworkId, + DeviceId, + LinkId, + region +) +SELECT +'{{ GlobalNetworkId }}', + '{{ DeviceId }}', + '{{ LinkId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.link_associations ( + GlobalNetworkId, + DeviceId, + LinkId, + region +) +SELECT + '{{ GlobalNetworkId }}', + '{{ DeviceId }}', + '{{ LinkId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: link_association + props: + - name: GlobalNetworkId + value: '{{ GlobalNetworkId }}' + - name: DeviceId + value: '{{ DeviceId }}' + - name: LinkId + value: '{{ LinkId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.link_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the link_associations resource, the following permissions are required: + +### Create +```json +networkmanager:GetLinkAssociations, +networkmanager:AssociateLink +``` + +### Read +```json +networkmanager:GetLinkAssociations +``` + +### List +```json +networkmanager:GetLinkAssociations +``` + +### Delete +```json +networkmanager:DisassociateLink +``` diff --git a/website/docs/services/networkmanager/link_associations_list_only/index.md b/website/docs/services/networkmanager/link_associations_list_only/index.md new file mode 100644 index 0000000..b9b7172 --- /dev/null +++ b/website/docs/services/networkmanager/link_associations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: link_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - link_associations_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists link_associations in a region or regions, for all properties use link_associations + +## Overview + + + + + + + +
Namelink_associations_list_only
TypeResource
DescriptionThe AWS::NetworkManager::LinkAssociation type associates a link to a device. The device and link must be in the same global network and the same site.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the global network.
stringThe ID of the device
stringThe ID of the link
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all link_associations in a region. +```sql +SELECT +region, +global_network_id, +device_id, +link_id +FROM aws.networkmanager.link_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the link_associations_list_only resource, see link_associations + diff --git a/website/docs/services/networkmanager/link_tags/index.md b/website/docs/services/networkmanager/link_tags/index.md new file mode 100644 index 0000000..56f444d --- /dev/null +++ b/website/docs/services/networkmanager/link_tags/index.md @@ -0,0 +1,95 @@ +--- +title: link_tags +hide_title: false +hide_table_of_contents: false +keywords: + - link_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for links in a region + +## Overview + + + + + + + +
Namelink_tags
TypeResource
DescriptionThe AWS::NetworkManager::Link type describes a link.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the link.
stringThe ID of the link.
stringThe ID of the global network.
stringThe ID of the site
objectThe Bandwidth for the link.
stringThe provider of the link.
stringThe description of the link.
stringThe type of the link.
stringThe date and time that the device was created.
stringThe state of the link.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all links in a region. +```sql +SELECT +region, +link_arn, +link_id, +global_network_id, +site_id, +bandwidth, +provider, +description, +type, +created_at, +state, +tag_key, +tag_value +FROM aws.networkmanager.link_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the link_tags resource, see links + diff --git a/website/docs/services/networkmanager/links/index.md b/website/docs/services/networkmanager/links/index.md new file mode 100644 index 0000000..be5fe44 --- /dev/null +++ b/website/docs/services/networkmanager/links/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a link resource or lists links in a region + +## Overview + + + + + + + +
Namelinks
TypeResource
DescriptionThe AWS::NetworkManager::Link type describes a link.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the link.
stringThe ID of the link.
stringThe ID of the global network.
stringThe ID of the site
objectThe Bandwidth for the link.
stringThe provider of the link.
stringThe description of the link.
arrayThe tags for the link.
stringThe type of the link.
stringThe date and time that the device was created.
stringThe state of the link.
stringAWS region.
+ +For more information, see AWS::NetworkManager::Link. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all links in a region. +```sql +SELECT +region, +link_arn, +link_id, +global_network_id, +site_id, +bandwidth, +provider, +description, +tags, +type, +created_at, +state +FROM aws.networkmanager.links +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual link. +```sql +SELECT +region, +link_arn, +link_id, +global_network_id, +site_id, +bandwidth, +provider, +description, +tags, +type, +created_at, +state +FROM aws.networkmanager.links +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new link resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.links ( + GlobalNetworkId, + SiteId, + Bandwidth, + region +) +SELECT +'{{ GlobalNetworkId }}', + '{{ SiteId }}', + '{{ Bandwidth }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.links ( + GlobalNetworkId, + SiteId, + Bandwidth, + Provider, + Description, + Tags, + Type, + region +) +SELECT + '{{ GlobalNetworkId }}', + '{{ SiteId }}', + '{{ Bandwidth }}', + '{{ Provider }}', + '{{ Description }}', + '{{ Tags }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: link + props: + - name: GlobalNetworkId + value: '{{ GlobalNetworkId }}' + - name: SiteId + value: '{{ SiteId }}' + - name: Bandwidth + value: + DownloadSpeed: '{{ DownloadSpeed }}' + UploadSpeed: '{{ UploadSpeed }}' + - name: Provider + value: '{{ Provider }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.links +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the links resource, the following permissions are required: + +### Create +```json +networkmanager:CreateLink, +networkmanager:GetLinks, +networkmanager:TagResource +``` + +### Read +```json +networkmanager:GetLinks +``` + +### Update +```json +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:GetLinks, +networkmanager:UntagResource, +networkmanager:UpdateLink +``` + +### Delete +```json +networkmanager:GetLinks, +networkmanager:DeleteLink +``` + +### List +```json +networkmanager:GetLinks +``` diff --git a/website/docs/services/networkmanager/links_list_only/index.md b/website/docs/services/networkmanager/links_list_only/index.md new file mode 100644 index 0000000..d7df83c --- /dev/null +++ b/website/docs/services/networkmanager/links_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: links_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - links_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists links in a region or regions, for all properties use links + +## Overview + + + + + + + +
Namelinks_list_only
TypeResource
DescriptionThe AWS::NetworkManager::Link type describes a link.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the link.
stringThe ID of the global network.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all links in a region. +```sql +SELECT +region, +global_network_id, +link_id +FROM aws.networkmanager.links_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the links_list_only resource, see links + diff --git a/website/docs/services/networkmanager/site_tags/index.md b/website/docs/services/networkmanager/site_tags/index.md new file mode 100644 index 0000000..a13a38d --- /dev/null +++ b/website/docs/services/networkmanager/site_tags/index.md @@ -0,0 +1,89 @@ +--- +title: site_tags +hide_title: false +hide_table_of_contents: false +keywords: + - site_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sites in a region + +## Overview + + + + + + + +
Namesite_tags
TypeResource
DescriptionThe AWS::NetworkManager::Site type describes a site.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the site.
stringThe ID of the site.
stringThe description of the site.
stringThe ID of the global network.
objectThe location of the site.
stringThe date and time that the device was created.
stringThe state of the site.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sites in a region. +```sql +SELECT +region, +site_arn, +site_id, +description, +global_network_id, +location, +created_at, +state, +tag_key, +tag_value +FROM aws.networkmanager.site_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the site_tags resource, see sites + diff --git a/website/docs/services/networkmanager/site_to_site_vpn_attachment_tags/index.md b/website/docs/services/networkmanager/site_to_site_vpn_attachment_tags/index.md new file mode 100644 index 0000000..92bb917 --- /dev/null +++ b/website/docs/services/networkmanager/site_to_site_vpn_attachment_tags/index.md @@ -0,0 +1,107 @@ +--- +title: site_to_site_vpn_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - site_to_site_vpn_attachment_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for site_to_site_vpn_attachments in a region + +## Overview + + + + + + + +
Namesite_to_site_vpn_attachment_tags
TypeResource
DescriptionAWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of a core network where you're creating a site-to-site VPN attachment.
stringThe ARN of a core network for the VPC attachment.
stringThe ID of the attachment.
stringOwner account of the attachment.
stringThe type of attachment.
stringThe state of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment that attachment is in.
objectThe attachment to move from one segment to another.
stringThe name of the network function group attachment.
objectThe attachment to move from one network function group to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringThe ARN of the site-to-site VPN attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all site_to_site_vpn_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +created_at, +updated_at, +vpn_connection_arn, +tag_key, +tag_value +FROM aws.networkmanager.site_to_site_vpn_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the site_to_site_vpn_attachment_tags resource, see site_to_site_vpn_attachments + diff --git a/website/docs/services/networkmanager/site_to_site_vpn_attachments/index.md b/website/docs/services/networkmanager/site_to_site_vpn_attachments/index.md new file mode 100644 index 0000000..ab88178 --- /dev/null +++ b/website/docs/services/networkmanager/site_to_site_vpn_attachments/index.md @@ -0,0 +1,283 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a site_to_site_vpn_attachment resource or lists site_to_site_vpn_attachments in a region + +## Overview + + + + + + + +
Namesite_to_site_vpn_attachments
TypeResource
DescriptionAWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of a core network where you're creating a site-to-site VPN attachment.
stringThe ARN of a core network for the VPC attachment.
stringThe ID of the attachment.
stringOwner account of the attachment.
stringThe type of attachment.
stringThe state of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment that attachment is in.
objectThe attachment to move from one segment to another.
stringThe name of the network function group attachment.
objectThe attachment to move from one network function group to another.
arrayTags for the attachment.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringThe ARN of the site-to-site VPN attachment.
stringAWS region.
+ +For more information, see AWS::NetworkManager::SiteToSiteVpnAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all site_to_site_vpn_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +tags, +created_at, +updated_at, +vpn_connection_arn +FROM aws.networkmanager.site_to_site_vpn_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual site_to_site_vpn_attachment. +```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, +network_function_group_name, +proposed_network_function_group_change, +tags, +created_at, +updated_at, +vpn_connection_arn +FROM aws.networkmanager.site_to_site_vpn_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new site_to_site_vpn_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.site_to_site_vpn_attachments ( + CoreNetworkId, + VpnConnectionArn, + region +) +SELECT +'{{ CoreNetworkId }}', + '{{ VpnConnectionArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.site_to_site_vpn_attachments ( + CoreNetworkId, + ProposedSegmentChange, + NetworkFunctionGroupName, + ProposedNetworkFunctionGroupChange, + Tags, + VpnConnectionArn, + region +) +SELECT + '{{ CoreNetworkId }}', + '{{ ProposedSegmentChange }}', + '{{ NetworkFunctionGroupName }}', + '{{ ProposedNetworkFunctionGroupChange }}', + '{{ Tags }}', + '{{ VpnConnectionArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: site_to_site_vpn_attachment + props: + - name: CoreNetworkId + value: '{{ CoreNetworkId }}' + - name: ProposedSegmentChange + value: + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}' + SegmentName: '{{ SegmentName }}' + - name: NetworkFunctionGroupName + value: '{{ NetworkFunctionGroupName }}' + - name: ProposedNetworkFunctionGroupChange + value: + Tags: + - null + AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}' + NetworkFunctionGroupName: '{{ NetworkFunctionGroupName }}' + - name: Tags + value: + - null + - name: VpnConnectionArn + value: '{{ VpnConnectionArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.site_to_site_vpn_attachments +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +networkmanager:GetSiteToSiteVpnAttachment +``` + +### Update +```json +networkmanager:GetSiteToSiteVpnAttachment, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:GetSiteToSiteVpnAttachment, +networkmanager:DeleteAttachment, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListAttachments +``` diff --git a/website/docs/services/networkmanager/site_to_site_vpn_attachments_list_only/index.md b/website/docs/services/networkmanager/site_to_site_vpn_attachments_list_only/index.md new file mode 100644 index 0000000..bd611e7 --- /dev/null +++ b/website/docs/services/networkmanager/site_to_site_vpn_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: site_to_site_vpn_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - site_to_site_vpn_attachments_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists site_to_site_vpn_attachments in a region or regions, for all properties use site_to_site_vpn_attachments + +## Overview + + + + + + + +
Namesite_to_site_vpn_attachments_list_only
TypeResource
DescriptionAWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all site_to_site_vpn_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.site_to_site_vpn_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the site_to_site_vpn_attachments_list_only resource, see site_to_site_vpn_attachments + diff --git a/website/docs/services/networkmanager/sites/index.md b/website/docs/services/networkmanager/sites/index.md new file mode 100644 index 0000000..2927a08 --- /dev/null +++ b/website/docs/services/networkmanager/sites/index.md @@ -0,0 +1,239 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a site resource or lists sites in a region + +## Overview + + + + + + + +
Namesites
TypeResource
DescriptionThe AWS::NetworkManager::Site type describes a site.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the site.
stringThe ID of the site.
stringThe description of the site.
arrayThe tags for the site.
stringThe ID of the global network.
objectThe location of the site.
stringThe date and time that the device was created.
stringThe state of the site.
stringAWS region.
+ +For more information, see AWS::NetworkManager::Site. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all sites in a region. +```sql +SELECT +region, +site_arn, +site_id, +description, +tags, +global_network_id, +location, +created_at, +state +FROM aws.networkmanager.sites +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual site. +```sql +SELECT +region, +site_arn, +site_id, +description, +tags, +global_network_id, +location, +created_at, +state +FROM aws.networkmanager.sites +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new site resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.sites ( + GlobalNetworkId, + region +) +SELECT +'{{ GlobalNetworkId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.sites ( + Description, + Tags, + GlobalNetworkId, + Location, + region +) +SELECT + '{{ Description }}', + '{{ Tags }}', + '{{ GlobalNetworkId }}', + '{{ Location }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: site + props: + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: GlobalNetworkId + value: '{{ GlobalNetworkId }}' + - name: Location + value: + Address: '{{ Address }}' + Latitude: '{{ Latitude }}' + Longitude: '{{ Longitude }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.sites +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the sites resource, the following permissions are required: + +### Create +```json +networkmanager:CreateSite, +networkmanager:GetSites, +networkmanager:TagResource +``` + +### Read +```json +networkmanager:GetSites +``` + +### Update +```json +networkmanager:GetSites, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +networkmanager:UpdateSite +``` + +### Delete +```json +networkmanager:GetSites, +networkmanager:DeleteSite +``` + +### List +```json +networkmanager:GetSites +``` diff --git a/website/docs/services/networkmanager/sites_list_only/index.md b/website/docs/services/networkmanager/sites_list_only/index.md new file mode 100644 index 0000000..d65624c --- /dev/null +++ b/website/docs/services/networkmanager/sites_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: sites_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sites_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sites in a region or regions, for all properties use sites + +## Overview + + + + + + + +
Namesites_list_only
TypeResource
DescriptionThe AWS::NetworkManager::Site type describes a site.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the site.
stringThe ID of the global network.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sites in a region. +```sql +SELECT +region, +global_network_id, +site_id +FROM aws.networkmanager.sites_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sites_list_only resource, see sites + diff --git a/website/docs/services/networkmanager/transit_gateway_peering_tags/index.md b/website/docs/services/networkmanager/transit_gateway_peering_tags/index.md new file mode 100644 index 0000000..6027c16 --- /dev/null +++ b/website/docs/services/networkmanager/transit_gateway_peering_tags/index.md @@ -0,0 +1,97 @@ +--- +title: transit_gateway_peering_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peering_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_peerings in a region + +## Overview + + + + + + + +
Nametransit_gateway_peering_tags
TypeResource
DescriptionAWS::NetworkManager::TransitGatewayPeering Resoruce Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Id of the core network that you want to peer a transit gateway to.
stringThe ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to.
stringThe ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network
stringThe ID of the TransitGatewayPeeringAttachment
stringThe Id of the transit gateway peering
stringThe state of the transit gateway peering
stringThe location of the transit gateway peering
stringThe ARN (Amazon Resource Name) of the resource that you will peer to a core network
stringPeering owner account Id
stringPeering type (TransitGatewayPeering)
stringThe creation time of the transit gateway peering
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_peerings in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +transit_gateway_arn, +transit_gateway_peering_attachment_id, +peering_id, +state, +edge_location, +resource_arn, +owner_account_id, +peering_type, +created_at, +tag_key, +tag_value +FROM aws.networkmanager.transit_gateway_peering_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_peering_tags resource, see transit_gateway_peerings + diff --git a/website/docs/services/networkmanager/transit_gateway_peerings/index.md b/website/docs/services/networkmanager/transit_gateway_peerings/index.md new file mode 100644 index 0000000..d3ca76d --- /dev/null +++ b/website/docs/services/networkmanager/transit_gateway_peerings/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_peering resource or lists transit_gateway_peerings in a region + +## Overview + + + + + + + +
Nametransit_gateway_peerings
TypeResource
DescriptionAWS::NetworkManager::TransitGatewayPeering Resoruce Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Id of the core network that you want to peer a transit gateway to.
stringThe ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to.
stringThe ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network
stringThe ID of the TransitGatewayPeeringAttachment
stringThe Id of the transit gateway peering
stringThe state of the transit gateway peering
stringThe location of the transit gateway peering
stringThe ARN (Amazon Resource Name) of the resource that you will peer to a core network
stringPeering owner account Id
stringPeering type (TransitGatewayPeering)
stringThe creation time of the transit gateway peering
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::NetworkManager::TransitGatewayPeering. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_peerings in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +transit_gateway_arn, +transit_gateway_peering_attachment_id, +peering_id, +state, +edge_location, +resource_arn, +owner_account_id, +peering_type, +created_at, +tags +FROM aws.networkmanager.transit_gateway_peerings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_peering. +```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_peerings +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_peering resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.transit_gateway_peerings ( + CoreNetworkId, + TransitGatewayArn, + region +) +SELECT +'{{ CoreNetworkId }}', + '{{ TransitGatewayArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.transit_gateway_peerings ( + CoreNetworkId, + TransitGatewayArn, + Tags, + region +) +SELECT + '{{ CoreNetworkId }}', + '{{ TransitGatewayArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_peering + props: + - name: CoreNetworkId + value: '{{ CoreNetworkId }}' + - name: TransitGatewayArn + value: '{{ TransitGatewayArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.transit_gateway_peerings +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +networkmanager:GetTransitGatewayPeering +``` + +### Update +```json +networkmanager:TagResource, +networkmanager:UntagResource, +networkmanager:ListTagsForResource, +networkmanager:GetTransitGatewayPeering, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:DeletePeering, +networkmanager:GetTransitGatewayPeering, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListPeerings +``` diff --git a/website/docs/services/networkmanager/transit_gateway_peerings_list_only/index.md b/website/docs/services/networkmanager/transit_gateway_peerings_list_only/index.md new file mode 100644 index 0000000..a3c583a --- /dev/null +++ b/website/docs/services/networkmanager/transit_gateway_peerings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_peerings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peerings_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_peerings in a region or regions, for all properties use transit_gateway_peerings + +## Overview + + + + + + + +
Nametransit_gateway_peerings_list_only
TypeResource
DescriptionAWS::NetworkManager::TransitGatewayPeering Resoruce Type.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Id of the transit gateway peering
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_peerings in a region. +```sql +SELECT +region, +peering_id +FROM aws.networkmanager.transit_gateway_peerings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_peerings_list_only resource, see transit_gateway_peerings + diff --git a/website/docs/services/networkmanager/transit_gateway_registrations/index.md b/website/docs/services/networkmanager/transit_gateway_registrations/index.md new file mode 100644 index 0000000..caa6c66 --- /dev/null +++ b/website/docs/services/networkmanager/transit_gateway_registrations/index.md @@ -0,0 +1,195 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_registration resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the global network.
stringThe Amazon Resource Name (ARN) of the transit gateway.
stringAWS region.
+ +For more information, see AWS::NetworkManager::TransitGatewayRegistration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_registrations in a region. +```sql +SELECT +region, +global_network_id, +transit_gateway_arn +FROM aws.networkmanager.transit_gateway_registrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_registration. +```sql +SELECT +region, +global_network_id, +transit_gateway_arn +FROM aws.networkmanager.transit_gateway_registrations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_registration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.transit_gateway_registrations ( + GlobalNetworkId, + TransitGatewayArn, + region +) +SELECT +'{{ GlobalNetworkId }}', + '{{ TransitGatewayArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.transit_gateway_registrations ( + GlobalNetworkId, + TransitGatewayArn, + region +) +SELECT + '{{ GlobalNetworkId }}', + '{{ TransitGatewayArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_registration + props: + - name: GlobalNetworkId + value: '{{ GlobalNetworkId }}' + - name: TransitGatewayArn + value: '{{ TransitGatewayArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.transit_gateway_registrations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the transit_gateway_registrations resource, the following permissions are required: + +### Create +```json +networkmanager:RegisterTransitGateway, +networkmanager:GetTransitGatewayRegistrations +``` + +### Read +```json +networkmanager:GetTransitGatewayRegistrations +``` + +### List +```json +networkmanager:GetTransitGatewayRegistrations +``` + +### Delete +```json +networkmanager:DeregisterTransitGateway, +networkmanager:GetTransitGatewayRegistrations +``` diff --git a/website/docs/services/networkmanager/transit_gateway_registrations_list_only/index.md b/website/docs/services/networkmanager/transit_gateway_registrations_list_only/index.md new file mode 100644 index 0000000..ee3585f --- /dev/null +++ b/website/docs/services/networkmanager/transit_gateway_registrations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: transit_gateway_registrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_registrations_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_registrations in a region or regions, for all properties use transit_gateway_registrations + +## Overview + + + + + + + +
Nametransit_gateway_registrations_list_only
TypeResource
DescriptionThe AWS::NetworkManager::TransitGatewayRegistration type registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the global network.
stringThe Amazon Resource Name (ARN) of the transit gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_registrations in a region. +```sql +SELECT +region, +global_network_id, +transit_gateway_arn +FROM aws.networkmanager.transit_gateway_registrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_registrations_list_only resource, see transit_gateway_registrations + diff --git a/website/docs/services/networkmanager/transit_gateway_route_table_attachment_tags/index.md b/website/docs/services/networkmanager/transit_gateway_route_table_attachment_tags/index.md new file mode 100644 index 0000000..ce49711 --- /dev/null +++ b/website/docs/services/networkmanager/transit_gateway_route_table_attachment_tags/index.md @@ -0,0 +1,109 @@ +--- +title: transit_gateway_route_table_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_attachment_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_route_table_attachments in a region + +## Overview + + + + + + + +
Nametransit_gateway_route_table_attachment_tags
TypeResource
DescriptionAWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Id of peering between transit gateway and core network.
stringThe Arn of transit gateway route table.
stringThe ID of a core network where you're creating a site-to-site VPN attachment.
stringThe ARN of a core network for the VPC attachment.
stringThe ID of the attachment.
stringOwner account of the attachment.
stringThe type of attachment.
stringThe state of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment that attachment is in.
objectThe attachment to move from one segment to another.
stringThe name of the network function group attachment.
objectThe attachment to move from one network function group to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_route_table_attachments in a region. +```sql +SELECT +region, +peering_id, +transit_gateway_route_table_arn, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +created_at, +updated_at, +tag_key, +tag_value +FROM aws.networkmanager.transit_gateway_route_table_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_table_attachment_tags resource, see transit_gateway_route_table_attachments + diff --git a/website/docs/services/networkmanager/transit_gateway_route_table_attachments/index.md b/website/docs/services/networkmanager/transit_gateway_route_table_attachments/index.md new file mode 100644 index 0000000..4c2fa35 --- /dev/null +++ b/website/docs/services/networkmanager/transit_gateway_route_table_attachments/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a transit_gateway_route_table_attachment resource or lists transit_gateway_route_table_attachments in a region + +## Overview + + + + + + + +
Nametransit_gateway_route_table_attachments
TypeResource
DescriptionAWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Id of peering between transit gateway and core network.
stringThe Arn of transit gateway route table.
stringThe ID of a core network where you're creating a site-to-site VPN attachment.
stringThe ARN of a core network for the VPC attachment.
stringThe ID of the attachment.
stringOwner account of the attachment.
stringThe type of attachment.
stringThe state of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment that attachment is in.
objectThe attachment to move from one segment to another.
stringThe name of the network function group attachment.
objectThe attachment to move from one network function group to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::NetworkManager::TransitGatewayRouteTableAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all transit_gateway_route_table_attachments in a region. +```sql +SELECT +region, +peering_id, +transit_gateway_route_table_arn, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +created_at, +updated_at, +tags +FROM aws.networkmanager.transit_gateway_route_table_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual transit_gateway_route_table_attachment. +```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, +network_function_group_name, +proposed_network_function_group_change, +created_at, +updated_at, +tags +FROM aws.networkmanager.transit_gateway_route_table_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new transit_gateway_route_table_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.transit_gateway_route_table_attachments ( + PeeringId, + TransitGatewayRouteTableArn, + region +) +SELECT +'{{ PeeringId }}', + '{{ TransitGatewayRouteTableArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.transit_gateway_route_table_attachments ( + PeeringId, + TransitGatewayRouteTableArn, + ProposedSegmentChange, + NetworkFunctionGroupName, + ProposedNetworkFunctionGroupChange, + Tags, + region +) +SELECT + '{{ PeeringId }}', + '{{ TransitGatewayRouteTableArn }}', + '{{ ProposedSegmentChange }}', + '{{ NetworkFunctionGroupName }}', + '{{ ProposedNetworkFunctionGroupChange }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: transit_gateway_route_table_attachment + props: + - name: PeeringId + value: '{{ PeeringId }}' + - name: TransitGatewayRouteTableArn + value: '{{ TransitGatewayRouteTableArn }}' + - name: ProposedSegmentChange + value: + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}' + SegmentName: '{{ SegmentName }}' + - name: NetworkFunctionGroupName + value: '{{ NetworkFunctionGroupName }}' + - name: ProposedNetworkFunctionGroupChange + value: + Tags: + - null + AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}' + NetworkFunctionGroupName: '{{ NetworkFunctionGroupName }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.transit_gateway_route_table_attachments +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +networkmanager:GetTransitGatewayRouteTableAttachment +``` + +### Update +```json +networkmanager:GetTransitGatewayRouteTableAttachment, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:GetTransitGatewayRouteTableAttachment, +networkmanager:DeleteAttachment, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListAttachments +``` diff --git a/website/docs/services/networkmanager/transit_gateway_route_table_attachments_list_only/index.md b/website/docs/services/networkmanager/transit_gateway_route_table_attachments_list_only/index.md new file mode 100644 index 0000000..2c6b554 --- /dev/null +++ b/website/docs/services/networkmanager/transit_gateway_route_table_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_route_table_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_attachments_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_route_table_attachments in a region or regions, for all properties use transit_gateway_route_table_attachments + +## Overview + + + + + + + +
Nametransit_gateway_route_table_attachments_list_only
TypeResource
DescriptionAWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_route_table_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.transit_gateway_route_table_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_table_attachments_list_only resource, see transit_gateway_route_table_attachments + diff --git a/website/docs/services/networkmanager/vpc_attachment_tags/index.md b/website/docs/services/networkmanager/vpc_attachment_tags/index.md new file mode 100644 index 0000000..cbd4306 --- /dev/null +++ b/website/docs/services/networkmanager/vpc_attachment_tags/index.md @@ -0,0 +1,111 @@ +--- +title: vpc_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_attachment_tags + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_attachments in a region + +## Overview + + + + + + + +
Namevpc_attachment_tags
TypeResource
DescriptionAWS::NetworkManager::VpcAttachment Resoruce Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of a core network for the VPC attachment.
stringThe ARN of a core network for the VPC attachment.
stringId of the attachment.
stringOwner account of the attachment.
stringAttachment type.
stringState of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the VPC.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment..
objectThe attachment to move from one segment to another.
stringThe name of the network function group attachment.
objectThe attachment to move from one network function group to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
arraySubnet Arn list
objectVpc options of the attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +vpc_arn, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +created_at, +updated_at, +subnet_arns, +options, +tag_key, +tag_value +FROM aws.networkmanager.vpc_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_attachment_tags resource, see vpc_attachments + diff --git a/website/docs/services/networkmanager/vpc_attachments/index.md b/website/docs/services/networkmanager/vpc_attachments/index.md new file mode 100644 index 0000000..83d01c3 --- /dev/null +++ b/website/docs/services/networkmanager/vpc_attachments/index.md @@ -0,0 +1,301 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_attachment resource or lists vpc_attachments in a region + +## Overview + + + + + + + +
Namevpc_attachments
TypeResource
DescriptionAWS::NetworkManager::VpcAttachment Resoruce Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of a core network for the VPC attachment.
stringThe ARN of a core network for the VPC attachment.
stringId of the attachment.
stringOwner account of the attachment.
stringAttachment type.
stringState of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the VPC.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment..
objectThe attachment to move from one segment to another.
stringThe name of the network function group attachment.
objectThe attachment to move from one network function group to another.
arrayTags for the attachment.
stringCreation time of the attachment.
stringLast update time of the attachment.
arraySubnet Arn list
objectVpc options of the attachment.
stringAWS region.
+ +For more information, see AWS::NetworkManager::VpcAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +vpc_arn, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +network_function_group_name, +proposed_network_function_group_change, +tags, +created_at, +updated_at, +subnet_arns, +options +FROM aws.networkmanager.vpc_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_attachment. +```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, +network_function_group_name, +proposed_network_function_group_change, +tags, +created_at, +updated_at, +subnet_arns, +options +FROM aws.networkmanager.vpc_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.vpc_attachments ( + CoreNetworkId, + VpcArn, + SubnetArns, + region +) +SELECT +'{{ CoreNetworkId }}', + '{{ VpcArn }}', + '{{ SubnetArns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.networkmanager.vpc_attachments ( + CoreNetworkId, + VpcArn, + ProposedSegmentChange, + ProposedNetworkFunctionGroupChange, + Tags, + SubnetArns, + Options, + region +) +SELECT + '{{ CoreNetworkId }}', + '{{ VpcArn }}', + '{{ ProposedSegmentChange }}', + '{{ ProposedNetworkFunctionGroupChange }}', + '{{ Tags }}', + '{{ SubnetArns }}', + '{{ Options }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_attachment + props: + - name: CoreNetworkId + value: '{{ CoreNetworkId }}' + - name: VpcArn + value: '{{ VpcArn }}' + - name: ProposedSegmentChange + value: + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}' + SegmentName: '{{ SegmentName }}' + - name: ProposedNetworkFunctionGroupChange + value: + Tags: + - null + AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}' + NetworkFunctionGroupName: '{{ NetworkFunctionGroupName }}' + - name: Tags + value: + - null + - name: SubnetArns + value: + - '{{ SubnetArns[0] }}' + - name: Options + value: + Ipv6Support: '{{ Ipv6Support }}' + ApplianceModeSupport: '{{ ApplianceModeSupport }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.networkmanager.vpc_attachments +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +networkmanager:ListAttachments +``` diff --git a/website/docs/services/networkmanager/vpc_attachments_list_only/index.md b/website/docs/services/networkmanager/vpc_attachments_list_only/index.md new file mode 100644 index 0000000..ccdf6d3 --- /dev/null +++ b/website/docs/services/networkmanager/vpc_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_attachments_list_only + - networkmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_attachments in a region or regions, for all properties use vpc_attachments + +## Overview + + + + + + + +
Namevpc_attachments_list_only
TypeResource
DescriptionAWS::NetworkManager::VpcAttachment Resoruce Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId of the attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.vpc_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_attachments_list_only resource, see vpc_attachments + diff --git a/website/docs/services/oam/index.md b/website/docs/services/oam/index.md new file mode 100644 index 0000000..e3ab87c --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The oam service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/oam/link_tags/index.md b/website/docs/services/oam/link_tags/index.md new file mode 100644 index 0000000..d015ae0 --- /dev/null +++ b/website/docs/services/oam/link_tags/index.md @@ -0,0 +1,87 @@ +--- +title: link_tags +hide_title: false +hide_table_of_contents: false +keywords: + - link_tags + - oam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for links in a region + +## Overview + + + + + + + +
Namelink_tags
TypeResource
DescriptionDefinition of AWS::Oam::Link Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all links in a region. +```sql +SELECT +region, +arn, +label, +label_template, +resource_types, +sink_identifier, +link_configuration, +tag_key, +tag_value +FROM aws.oam.link_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the link_tags resource, see links + diff --git a/website/docs/services/oam/links/index.md b/website/docs/services/oam/links/index.md new file mode 100644 index 0000000..0de0dfd --- /dev/null +++ b/website/docs/services/oam/links/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a link resource or lists links in a region + +## Overview + + + + + + + +
Namelinks
TypeResource
DescriptionDefinition of AWS::Oam::Link Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
object
objectTags to apply to the link
stringAWS region.
+ +For more information, see AWS::Oam::Link. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all links in a region. +```sql +SELECT +region, +arn, +label, +label_template, +resource_types, +sink_identifier, +link_configuration, +tags +FROM aws.oam.links +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual link. +```sql +SELECT +region, +arn, +label, +label_template, +resource_types, +sink_identifier, +link_configuration, +tags +FROM aws.oam.links +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new link resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.oam.links ( + ResourceTypes, + SinkIdentifier, + region +) +SELECT +'{{ ResourceTypes }}', + '{{ SinkIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.oam.links ( + LabelTemplate, + ResourceTypes, + SinkIdentifier, + LinkConfiguration, + Tags, + region +) +SELECT + '{{ LabelTemplate }}', + '{{ ResourceTypes }}', + '{{ SinkIdentifier }}', + '{{ LinkConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: link + props: + - name: LabelTemplate + value: '{{ LabelTemplate }}' + - name: ResourceTypes + value: + - '{{ ResourceTypes[0] }}' + - name: SinkIdentifier + value: '{{ SinkIdentifier }}' + - name: LinkConfiguration + value: + MetricConfiguration: + Filter: '{{ Filter }}' + LogGroupConfiguration: null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.oam.links +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the links resource, the following permissions are required: + +### Create +```json +oam:CreateLink, +oam:GetLink, +oam:TagResource, +oam:ListTagsForResource, +cloudwatch:Link, +logs:Link, +xray:Link, +applicationinsights:Link, +internetmonitor:Link +``` + +### Read +```json +oam:GetLink, +oam:ListTagsForResource +``` + +### Update +```json +oam:GetLink, +oam:UpdateLink, +cloudwatch:Link, +logs:Link, +xray:Link, +applicationinsights:Link, +internetmonitor:Link, +oam:TagResource, +oam:UntagResource, +oam:ListTagsForResource +``` + +### Delete +```json +oam:DeleteLink, +oam:GetLink +``` + +### List +```json +oam:ListLinks +``` diff --git a/website/docs/services/oam/links_list_only/index.md b/website/docs/services/oam/links_list_only/index.md new file mode 100644 index 0000000..a39ed70 --- /dev/null +++ b/website/docs/services/oam/links_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: links_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - links_list_only + - oam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists links in a region or regions, for all properties use links + +## Overview + + + + + + + +
Namelinks_list_only
TypeResource
DescriptionDefinition of AWS::Oam::Link Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all links in a region. +```sql +SELECT +region, +arn +FROM aws.oam.links_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the links_list_only resource, see links + diff --git a/website/docs/services/oam/sink_tags/index.md b/website/docs/services/oam/sink_tags/index.md new file mode 100644 index 0000000..d3f4dc8 --- /dev/null +++ b/website/docs/services/oam/sink_tags/index.md @@ -0,0 +1,81 @@ +--- +title: sink_tags +hide_title: false +hide_table_of_contents: false +keywords: + - sink_tags + - oam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sinks in a region + +## Overview + + + + + + + +
Namesink_tags
TypeResource
DescriptionResource Type definition for AWS::Oam::Sink
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
stringThe name of the ObservabilityAccessManager Sink.
objectThe policy of this ObservabilityAccessManager Sink.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sinks in a region. +```sql +SELECT +region, +arn, +name, +policy, +tag_key, +tag_value +FROM aws.oam.sink_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sink_tags resource, see sinks + diff --git a/website/docs/services/oam/sinks/index.md b/website/docs/services/oam/sinks/index.md new file mode 100644 index 0000000..0890eb0 --- /dev/null +++ b/website/docs/services/oam/sinks/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a sink resource or lists sinks in a region + +## Overview + + + + + + + +
Namesinks
TypeResource
DescriptionResource Type definition for AWS::Oam::Sink
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
stringThe name of the ObservabilityAccessManager Sink.
objectThe policy of this ObservabilityAccessManager Sink.
objectTags to apply to the sink
stringAWS region.
+ +For more information, see AWS::Oam::Sink. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all sinks in a region. +```sql +SELECT +region, +arn, +name, +policy, +tags +FROM aws.oam.sinks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual sink. +```sql +SELECT +region, +arn, +name, +policy, +tags +FROM aws.oam.sinks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new sink resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.oam.sinks ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.oam.sinks ( + Name, + Policy, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Policy }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: sink + props: + - name: Name + value: '{{ Name }}' + - name: Policy + value: {} + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.oam.sinks +WHERE data__Identifier = '' +AND 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, +oam:TagResource, +oam:ListTagsForResource +``` + +### Delete +```json +oam:DeleteSink, +oam:GetSinkPolicy, +oam:GetSink +``` + +### List +```json +oam:ListSinks +``` + +### Read +```json +oam:GetSinkPolicy, +oam:GetSink, +oam:ListTagsForResource +``` + +### Update +```json +oam:PutSinkPolicy, +oam:GetSinkPolicy, +oam:GetSink, +oam:TagResource, +oam:UntagResource, +oam:ListTagsForResource +``` diff --git a/website/docs/services/oam/sinks_list_only/index.md b/website/docs/services/oam/sinks_list_only/index.md new file mode 100644 index 0000000..bb0c260 --- /dev/null +++ b/website/docs/services/oam/sinks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: sinks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sinks_list_only + - oam + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sinks in a region or regions, for all properties use sinks + +## Overview + + + + + + + +
Namesinks_list_only
TypeResource
DescriptionResource Type definition for AWS::Oam::Sink
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sinks in a region. +```sql +SELECT +region, +arn +FROM aws.oam.sinks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sinks_list_only resource, see sinks + diff --git a/website/docs/services/omics/annotation_store_tags/index.md b/website/docs/services/omics/annotation_store_tags/index.md new file mode 100644 index 0000000..304907e --- /dev/null +++ b/website/docs/services/omics/annotation_store_tags/index.md @@ -0,0 +1,101 @@ +--- +title: annotation_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - annotation_store_tags + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for annotation_stores in a region + +## Overview + + + + + + + +
Nameannotation_store_tags
TypeResource
DescriptionDefinition of AWS::Omics::AnnotationStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
string
undefined
number
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all annotation_stores in a region. +```sql +SELECT +region, +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_format, +store_options, +store_size_bytes, +update_time, +tag_key, +tag_value +FROM aws.omics.annotation_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the annotation_store_tags resource, see annotation_stores + diff --git a/website/docs/services/omics/annotation_stores/index.md b/website/docs/services/omics/annotation_stores/index.md new file mode 100644 index 0000000..d9ed7a3 --- /dev/null +++ b/website/docs/services/omics/annotation_stores/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an annotation_store resource or lists annotation_stores in a region + +## Overview + + + + + + + +
Nameannotation_stores
TypeResource
DescriptionDefinition of AWS::Omics::AnnotationStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
string
undefined
number
objectA map of resource tags
string
stringAWS region.
+ +For more information, see AWS::Omics::AnnotationStore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all annotation_stores in a region. +```sql +SELECT +region, +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_format, +store_options, +store_size_bytes, +tags, +update_time +FROM aws.omics.annotation_stores +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual annotation_store. +```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_stores +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new annotation_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.omics.annotation_stores ( + Name, + StoreFormat, + region +) +SELECT +'{{ Name }}', + '{{ StoreFormat }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.omics.annotation_stores ( + Description, + Name, + Reference, + SseConfig, + StoreFormat, + StoreOptions, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ Reference }}', + '{{ SseConfig }}', + '{{ StoreFormat }}', + '{{ StoreOptions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: annotation_store + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Reference + value: + ReferenceArn: '{{ ReferenceArn }}' + - name: SseConfig + value: + Type: '{{ Type }}' + KeyArn: '{{ KeyArn }}' + - name: StoreFormat + value: '{{ StoreFormat }}' + - name: StoreOptions + value: null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.omics.annotation_stores +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +omics:GetAnnotationStore +``` + +### Update +```json +omics:UpdateAnnotationStore, +omics:TagResource, +omics:UntagResource, +omics:GetAnnotationStore, +omics:ListTagsForResource +``` + +### Delete +```json +omics:DeleteAnnotationStore, +omics:ListAnnotationStores +``` + +### List +```json +omics:ListAnnotationStores +``` diff --git a/website/docs/services/omics/annotation_stores_list_only/index.md b/website/docs/services/omics/annotation_stores_list_only/index.md new file mode 100644 index 0000000..b2217e8 --- /dev/null +++ b/website/docs/services/omics/annotation_stores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: annotation_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - annotation_stores_list_only + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists annotation_stores in a region or regions, for all properties use annotation_stores + +## Overview + + + + + + + +
Nameannotation_stores_list_only
TypeResource
DescriptionDefinition of AWS::Omics::AnnotationStore Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all annotation_stores in a region. +```sql +SELECT +region, +name +FROM aws.omics.annotation_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the annotation_stores_list_only resource, see annotation_stores + diff --git a/website/docs/services/omics/index.md b/website/docs/services/omics/index.md new file mode 100644 index 0000000..2b73d2b --- /dev/null +++ b/website/docs/services/omics/index.md @@ -0,0 +1,53 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The omics service documentation. + +:::info Service Summary + +
+
+total resources: 18
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/omics/reference_store_tags/index.md b/website/docs/services/omics/reference_store_tags/index.md new file mode 100644 index 0000000..4176a2a --- /dev/null +++ b/website/docs/services/omics/reference_store_tags/index.md @@ -0,0 +1,87 @@ +--- +title: reference_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - reference_store_tags + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for reference_stores in a region + +## Overview + + + + + + + +
Namereference_store_tags
TypeResource
DescriptionDefinition of AWS::Omics::ReferenceStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe store's ARN.
stringWhen the store was created.
stringA description for the store.
stringA name for the store.
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all reference_stores in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +name, +reference_store_id, +sse_config, +tag_key, +tag_value +FROM aws.omics.reference_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the reference_store_tags resource, see reference_stores + diff --git a/website/docs/services/omics/reference_stores/index.md b/website/docs/services/omics/reference_stores/index.md new file mode 100644 index 0000000..527bf9a --- /dev/null +++ b/website/docs/services/omics/reference_stores/index.md @@ -0,0 +1,219 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a reference_store resource or lists reference_stores in a region + +## Overview + + + + + + + +
Namereference_stores
TypeResource
DescriptionDefinition of AWS::Omics::ReferenceStore Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe store's ARN.
stringWhen the store was created.
stringA description for the store.
stringA name for the store.
string
object
objectA map of resource tags
stringAWS region.
+ +For more information, see AWS::Omics::ReferenceStore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all reference_stores in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +name, +reference_store_id, +sse_config, +tags +FROM aws.omics.reference_stores +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual reference_store. +```sql +SELECT +region, +arn, +creation_time, +description, +name, +reference_store_id, +sse_config, +tags +FROM aws.omics.reference_stores +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new reference_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.omics.reference_stores ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.omics.reference_stores ( + Description, + Name, + SseConfig, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ SseConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: reference_store + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: SseConfig + value: + Type: '{{ Type }}' + KeyArn: '{{ KeyArn }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.omics.reference_stores +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the reference_stores resource, the following permissions are required: + +### Create +```json +omics:CreateReferenceStore, +omics:TagResource, +kms:DescribeKey +``` + +### Read +```json +omics:GetReferenceStore, +omics:ListTagsForResource +``` + +### Delete +```json +omics:DeleteReferenceStore +``` + +### List +```json +omics:ListReferenceStores +``` diff --git a/website/docs/services/omics/reference_stores_list_only/index.md b/website/docs/services/omics/reference_stores_list_only/index.md new file mode 100644 index 0000000..fcbfba3 --- /dev/null +++ b/website/docs/services/omics/reference_stores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: reference_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - reference_stores_list_only + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists reference_stores in a region or regions, for all properties use reference_stores + +## Overview + + + + + + + +
Namereference_stores_list_only
TypeResource
DescriptionDefinition of AWS::Omics::ReferenceStore Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all reference_stores in a region. +```sql +SELECT +region, +reference_store_id +FROM aws.omics.reference_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the reference_stores_list_only resource, see reference_stores + diff --git a/website/docs/services/omics/run_group_tags/index.md b/website/docs/services/omics/run_group_tags/index.md new file mode 100644 index 0000000..6474a4e --- /dev/null +++ b/website/docs/services/omics/run_group_tags/index.md @@ -0,0 +1,91 @@ +--- +title: run_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - run_group_tags + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for run_groups in a region + +## Overview + + + + + + + +
Namerun_group_tags
TypeResource
DescriptionDefinition of AWS::Omics::RunGroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
number
number
number
number
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all run_groups in a region. +```sql +SELECT +region, +arn, +creation_time, +id, +max_cpus, +max_gpus, +max_duration, +max_runs, +name, +tag_key, +tag_value +FROM aws.omics.run_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the run_group_tags resource, see run_groups + diff --git a/website/docs/services/omics/run_groups/index.md b/website/docs/services/omics/run_groups/index.md new file mode 100644 index 0000000..dbcdf3f --- /dev/null +++ b/website/docs/services/omics/run_groups/index.md @@ -0,0 +1,254 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a run_group resource or lists run_groups in a region + +## Overview + + + + + + + +
Namerun_groups
TypeResource
DescriptionDefinition of AWS::Omics::RunGroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
number
number
number
number
string
objectA map of resource tags
stringAWS region.
+ +For more information, see AWS::Omics::RunGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all run_groups in a region. +```sql +SELECT +region, +arn, +creation_time, +id, +max_cpus, +max_gpus, +max_duration, +max_runs, +name, +tags +FROM aws.omics.run_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual run_group. +```sql +SELECT +region, +arn, +creation_time, +id, +max_cpus, +max_gpus, +max_duration, +max_runs, +name, +tags +FROM aws.omics.run_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new run_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.omics.run_groups ( + MaxCpus, + MaxGpus, + MaxDuration, + MaxRuns, + Name, + Tags, + region +) +SELECT +'{{ MaxCpus }}', + '{{ MaxGpus }}', + '{{ MaxDuration }}', + '{{ MaxRuns }}', + '{{ Name }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.omics.run_groups ( + MaxCpus, + MaxGpus, + MaxDuration, + MaxRuns, + Name, + Tags, + region +) +SELECT + '{{ MaxCpus }}', + '{{ MaxGpus }}', + '{{ MaxDuration }}', + '{{ MaxRuns }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: run_group + props: + - name: MaxCpus + value: null + - name: MaxGpus + value: null + - name: MaxDuration + value: null + - name: MaxRuns + value: null + - name: Name + value: '{{ Name }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.omics.run_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the run_groups resource, the following permissions are required: + +### Create +```json +omics:CreateRunGroup, +omics:TagResource +``` + +### Read +```json +omics:GetRunGroup +``` + +### Update +```json +omics:UpdateRunGroup, +omics:TagResource, +omics:GetRunGroup, +omics:ListTagsForResource, +omics:UntagResource +``` + +### Delete +```json +omics:DeleteRunGroup, +omics:GetRunGroup +``` + +### List +```json +omics:ListRunGroups +``` diff --git a/website/docs/services/omics/run_groups_list_only/index.md b/website/docs/services/omics/run_groups_list_only/index.md new file mode 100644 index 0000000..eec8073 --- /dev/null +++ b/website/docs/services/omics/run_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: run_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - run_groups_list_only + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists run_groups in a region or regions, for all properties use run_groups + +## Overview + + + + + + + +
Namerun_groups_list_only
TypeResource
DescriptionDefinition of AWS::Omics::RunGroup Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all run_groups in a region. +```sql +SELECT +region, +id +FROM aws.omics.run_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the run_groups_list_only resource, see run_groups + diff --git a/website/docs/services/omics/sequence_store_tags/index.md b/website/docs/services/omics/sequence_store_tags/index.md new file mode 100644 index 0000000..c661bdb --- /dev/null +++ b/website/docs/services/omics/sequence_store_tags/index.md @@ -0,0 +1,89 @@ +--- +title: sequence_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - sequence_store_tags + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sequence_stores in a region + +## Overview + + + + + + + +
Namesequence_store_tags
TypeResource
DescriptionDefinition of AWS::Omics::SequenceStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe store's ARN.
stringWhen the store was created.
stringA description for the store.
stringA name for the store.
stringAn S3 URI representing the bucket and folder to store failed read set uploads.
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sequence_stores in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +name, +fallback_location, +sequence_store_id, +sse_config, +tag_key, +tag_value +FROM aws.omics.sequence_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sequence_store_tags resource, see sequence_stores + diff --git a/website/docs/services/omics/sequence_stores/index.md b/website/docs/services/omics/sequence_stores/index.md new file mode 100644 index 0000000..e72895d --- /dev/null +++ b/website/docs/services/omics/sequence_stores/index.md @@ -0,0 +1,226 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a sequence_store resource or lists sequence_stores in a region + +## Overview + + + + + + + +
Namesequence_stores
TypeResource
DescriptionDefinition of AWS::Omics::SequenceStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe store's ARN.
stringWhen the store was created.
stringA description for the store.
stringA name for the store.
stringAn S3 URI representing the bucket and folder to store failed read set uploads.
string
object
objectA map of resource tags
stringAWS region.
+ +For more information, see AWS::Omics::SequenceStore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all sequence_stores in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +name, +fallback_location, +sequence_store_id, +sse_config, +tags +FROM aws.omics.sequence_stores +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual sequence_store. +```sql +SELECT +region, +arn, +creation_time, +description, +name, +fallback_location, +sequence_store_id, +sse_config, +tags +FROM aws.omics.sequence_stores +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new sequence_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.omics.sequence_stores ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.omics.sequence_stores ( + Description, + Name, + FallbackLocation, + SseConfig, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ FallbackLocation }}', + '{{ SseConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: sequence_store + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: FallbackLocation + value: '{{ FallbackLocation }}' + - name: SseConfig + value: + Type: '{{ Type }}' + KeyArn: '{{ KeyArn }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.omics.sequence_stores +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the sequence_stores resource, the following permissions are required: + +### Create +```json +omics:CreateSequenceStore, +omics:TagResource, +kms:DescribeKey +``` + +### Read +```json +omics:GetSequenceStore, +omics:ListTagsForResource +``` + +### Delete +```json +omics:DeleteSequenceStore +``` + +### List +```json +omics:ListSequenceStores +``` diff --git a/website/docs/services/omics/sequence_stores_list_only/index.md b/website/docs/services/omics/sequence_stores_list_only/index.md new file mode 100644 index 0000000..8a2367a --- /dev/null +++ b/website/docs/services/omics/sequence_stores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: sequence_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sequence_stores_list_only + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sequence_stores in a region or regions, for all properties use sequence_stores + +## Overview + + + + + + + +
Namesequence_stores_list_only
TypeResource
DescriptionDefinition of AWS::Omics::SequenceStore Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sequence_stores in a region. +```sql +SELECT +region, +sequence_store_id +FROM aws.omics.sequence_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sequence_stores_list_only resource, see sequence_stores + diff --git a/website/docs/services/omics/variant_store_tags/index.md b/website/docs/services/omics/variant_store_tags/index.md new file mode 100644 index 0000000..2f3e991 --- /dev/null +++ b/website/docs/services/omics/variant_store_tags/index.md @@ -0,0 +1,97 @@ +--- +title: variant_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - variant_store_tags + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for variant_stores in a region + +## Overview + + + + + + + +
Namevariant_store_tags
TypeResource
DescriptionDefinition of AWS::Omics::VariantStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
number
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all variant_stores in a region. +```sql +SELECT +region, +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_size_bytes, +update_time, +tag_key, +tag_value +FROM aws.omics.variant_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the variant_store_tags resource, see variant_stores + diff --git a/website/docs/services/omics/variant_stores/index.md b/website/docs/services/omics/variant_stores/index.md new file mode 100644 index 0000000..52428d5 --- /dev/null +++ b/website/docs/services/omics/variant_stores/index.md @@ -0,0 +1,260 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a variant_store resource or lists variant_stores in a region + +## Overview + + + + + + + +
Namevariant_stores
TypeResource
DescriptionDefinition of AWS::Omics::VariantStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
number
objectA map of resource tags
string
stringAWS region.
+ +For more information, see AWS::Omics::VariantStore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all variant_stores in a region. +```sql +SELECT +region, +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_size_bytes, +tags, +update_time +FROM aws.omics.variant_stores +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual variant_store. +```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_stores +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new variant_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.omics.variant_stores ( + Name, + Reference, + region +) +SELECT +'{{ Name }}', + '{{ Reference }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.omics.variant_stores ( + Description, + Name, + Reference, + SseConfig, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ Reference }}', + '{{ SseConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: variant_store + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Reference + value: + ReferenceArn: '{{ ReferenceArn }}' + - name: SseConfig + value: + Type: '{{ Type }}' + KeyArn: '{{ KeyArn }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.omics.variant_stores +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +omics:GetVariantStore +``` + +### Update +```json +omics:UpdateVariantStore, +omics:TagResource, +omics:UntagResource, +omics:ListTagsForResource, +omics:GetVariantStore +``` + +### Delete +```json +omics:DeleteVariantStore, +omics:ListVariantStores +``` + +### List +```json +omics:ListVariantStores +``` diff --git a/website/docs/services/omics/variant_stores_list_only/index.md b/website/docs/services/omics/variant_stores_list_only/index.md new file mode 100644 index 0000000..6104678 --- /dev/null +++ b/website/docs/services/omics/variant_stores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: variant_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - variant_stores_list_only + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists variant_stores in a region or regions, for all properties use variant_stores + +## Overview + + + + + + + +
Namevariant_stores_list_only
TypeResource
DescriptionDefinition of AWS::Omics::VariantStore Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all variant_stores in a region. +```sql +SELECT +region, +name +FROM aws.omics.variant_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the variant_stores_list_only resource, see variant_stores + diff --git a/website/docs/services/omics/workflow_tags/index.md b/website/docs/services/omics/workflow_tags/index.md new file mode 100644 index 0000000..d6e4bd5 --- /dev/null +++ b/website/docs/services/omics/workflow_tags/index.md @@ -0,0 +1,101 @@ +--- +title: workflow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workflow_tags + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workflows in a region + +## Overview + + + + + + + +
Nameworkflow_tags
TypeResource
DescriptionDefinition of AWS::Omics::Workflow Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
object
string
string
number
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workflows in a region. +```sql +SELECT +region, +arn, +creation_time, +definition_uri, +description, +engine, +id, +main, +name, +parameter_template, +status, +accelerators, +storage_capacity, +type, +tag_key, +tag_value +FROM aws.omics.workflow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflow_tags resource, see workflows + diff --git a/website/docs/services/omics/workflows/index.md b/website/docs/services/omics/workflows/index.md new file mode 100644 index 0000000..0902563 --- /dev/null +++ b/website/docs/services/omics/workflows/index.md @@ -0,0 +1,298 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a workflow resource or lists workflows in a region + +## Overview + + + + + + + +
Nameworkflows
TypeResource
DescriptionDefinition of AWS::Omics::Workflow Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
object
string
string
number
objectA map of resource tags
string
stringAWS region.
+ +For more information, see AWS::Omics::Workflow. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all workflows in a region. +```sql +SELECT +region, +arn, +creation_time, +definition_uri, +description, +engine, +id, +main, +name, +parameter_template, +status, +accelerators, +storage_capacity, +tags, +type +FROM aws.omics.workflows +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual workflow. +```sql +SELECT +region, +arn, +creation_time, +definition_uri, +description, +engine, +id, +main, +name, +parameter_template, +status, +accelerators, +storage_capacity, +tags, +type +FROM aws.omics.workflows +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workflow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.omics.workflows ( + DefinitionUri, + Description, + Engine, + Main, + Name, + ParameterTemplate, + Accelerators, + StorageCapacity, + Tags, + region +) +SELECT +'{{ DefinitionUri }}', + '{{ Description }}', + '{{ Engine }}', + '{{ Main }}', + '{{ Name }}', + '{{ ParameterTemplate }}', + '{{ Accelerators }}', + '{{ StorageCapacity }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.omics.workflows ( + DefinitionUri, + Description, + Engine, + Main, + Name, + ParameterTemplate, + Accelerators, + StorageCapacity, + Tags, + region +) +SELECT + '{{ DefinitionUri }}', + '{{ Description }}', + '{{ Engine }}', + '{{ Main }}', + '{{ Name }}', + '{{ ParameterTemplate }}', + '{{ Accelerators }}', + '{{ StorageCapacity }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: workflow + props: + - name: DefinitionUri + value: '{{ DefinitionUri }}' + - name: Description + value: '{{ Description }}' + - name: Engine + value: '{{ Engine }}' + - name: Main + value: '{{ Main }}' + - name: Name + value: '{{ Name }}' + - name: ParameterTemplate + value: {} + - name: Accelerators + value: '{{ Accelerators }}' + - name: StorageCapacity + value: null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.omics.workflows +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +omics:GetWorkflow +``` + +### Update +```json +omics:UpdateWorkflow, +omics:GetWorkflow, +omics:TagResource, +omics:ListTagsForResource, +omics:UntagResource +``` + +### Delete +```json +omics:DeleteWorkflow, +omics:GetWorkflow +``` + +### List +```json +omics:ListWorkflows +``` diff --git a/website/docs/services/omics/workflows_list_only/index.md b/website/docs/services/omics/workflows_list_only/index.md new file mode 100644 index 0000000..2106518 --- /dev/null +++ b/website/docs/services/omics/workflows_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: workflows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workflows_list_only + - omics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workflows in a region or regions, for all properties use workflows + +## Overview + + + + + + + +
Nameworkflows_list_only
TypeResource
DescriptionDefinition of AWS::Omics::Workflow Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workflows in a region. +```sql +SELECT +region, +id +FROM aws.omics.workflows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflows_list_only resource, see workflows + diff --git a/website/docs/services/opensearchserverless/access_policies/index.md b/website/docs/services/opensearchserverless/access_policies/index.md new file mode 100644 index 0000000..127154d --- /dev/null +++ b/website/docs/services/opensearchserverless/access_policies/index.md @@ -0,0 +1,222 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_policy resource or lists access_policies in a region + +## Overview + + + + + + + +
Nameaccess_policies
TypeResource
DescriptionAmazon OpenSearchServerless access policy resource
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the policy
stringThe possible types for the access policy
stringThe description of the policy
stringThe JSON policy document that is the content for the policy
stringAWS region.
+ +For more information, see AWS::OpenSearchServerless::AccessPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_policies in a region. +```sql +SELECT +region, +name, +type, +description, +policy +FROM aws.opensearchserverless.access_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_policy. +```sql +SELECT +region, +name, +type, +description, +policy +FROM aws.opensearchserverless.access_policies +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.access_policies ( + Name, + Type, + Policy, + region +) +SELECT +'{{ Name }}', + '{{ Type }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.access_policies ( + Name, + Type, + Description, + Policy, + region +) +SELECT + '{{ Name }}', + '{{ Type }}', + '{{ Description }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_policy + props: + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: Description + value: '{{ Description }}' + - name: Policy + value: '{{ Policy }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.opensearchserverless.access_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the access_policies resource, the following permissions are required: + +### Create +```json +aoss:CreateAccessPolicy, +aoss:GetAccessPolicy +``` + +### Read +```json +aoss:GetAccessPolicy +``` + +### Update +```json +aoss:UpdateAccessPolicy, +aoss:GetAccessPolicy +``` + +### Delete +```json +aoss:DeleteAccessPolicy, +aoss:GetAccessPolicy +``` + +### List +```json +aoss:ListAccessPolicies +``` diff --git a/website/docs/services/opensearchserverless/access_policies_list_only/index.md b/website/docs/services/opensearchserverless/access_policies_list_only/index.md new file mode 100644 index 0000000..051eb41 --- /dev/null +++ b/website/docs/services/opensearchserverless/access_policies_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: access_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_policies_list_only + - opensearchserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_policies in a region or regions, for all properties use access_policies + +## Overview + + + + + + + +
Nameaccess_policies_list_only
TypeResource
DescriptionAmazon OpenSearchServerless access policy resource
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the policy
stringThe possible types for the access policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_policies in a region. +```sql +SELECT +region, +type, +name +FROM aws.opensearchserverless.access_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_policies_list_only resource, see access_policies + diff --git a/website/docs/services/opensearchserverless/collection_tags/index.md b/website/docs/services/opensearchserverless/collection_tags/index.md new file mode 100644 index 0000000..ad8e3ad --- /dev/null +++ b/website/docs/services/opensearchserverless/collection_tags/index.md @@ -0,0 +1,91 @@ +--- +title: collection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - collection_tags + - opensearchserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for collections in a region + +## Overview + + + + + + + +
Namecollection_tags
TypeResource
DescriptionAmazon OpenSearchServerless collection resource
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the collection
stringThe identifier of the collection
stringThe name of the collection.
The name must meet the following criteria:
Unique to your account and AWS Region
Starts with a lowercase letter
Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)
Contains between 3 and 32 characters
stringThe Amazon Resource Name (ARN) of the collection.
stringThe endpoint for the collection.
stringThe OpenSearch Dashboards endpoint for the collection.
stringThe possible types for the collection
stringThe possible standby replicas for the collection
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all collections in a region. +```sql +SELECT +region, +description, +id, +name, +arn, +collection_endpoint, +dashboard_endpoint, +type, +standby_replicas, +tag_key, +tag_value +FROM aws.opensearchserverless.collection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collection_tags resource, see collections + diff --git a/website/docs/services/opensearchserverless/collections/index.md b/website/docs/services/opensearchserverless/collections/index.md new file mode 100644 index 0000000..fc4a966 --- /dev/null +++ b/website/docs/services/opensearchserverless/collections/index.md @@ -0,0 +1,240 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a collection resource or lists collections in a region + +## Overview + + + + + + + +
Namecollections
TypeResource
DescriptionAmazon OpenSearchServerless collection resource
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the collection
stringThe identifier of the collection
stringThe name of the collection.
The name must meet the following criteria:
Unique to your account and AWS Region
Starts with a lowercase letter
Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)
Contains between 3 and 32 characters
arrayList of tags to be added to the resource
stringThe Amazon Resource Name (ARN) of the collection.
stringThe endpoint for the collection.
stringThe OpenSearch Dashboards endpoint for the collection.
stringThe possible types for the collection
stringThe possible standby replicas for the collection
stringAWS region.
+ +For more information, see AWS::OpenSearchServerless::Collection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all collections in a region. +```sql +SELECT +region, +description, +id, +name, +tags, +arn, +collection_endpoint, +dashboard_endpoint, +type, +standby_replicas +FROM aws.opensearchserverless.collections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual collection. +```sql +SELECT +region, +description, +id, +name, +tags, +arn, +collection_endpoint, +dashboard_endpoint, +type, +standby_replicas +FROM aws.opensearchserverless.collections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new collection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.collections ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.collections ( + Description, + Name, + Tags, + Type, + StandbyReplicas, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ Tags }}', + '{{ Type }}', + '{{ StandbyReplicas }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: collection + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + - name: StandbyReplicas + value: '{{ StandbyReplicas }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.opensearchserverless.collections +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the collections resource, the following permissions are required: + +### Create +```json +aoss:CreateCollection, +aoss:BatchGetCollection, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +aoss:DeleteCollection, +aoss:BatchGetCollection +``` + +### List +```json +aoss:ListCollections +``` + +### Read +```json +aoss:BatchGetCollection +``` + +### Update +```json +aoss:UpdateCollection, +aoss:BatchGetCollection +``` diff --git a/website/docs/services/opensearchserverless/collections_list_only/index.md b/website/docs/services/opensearchserverless/collections_list_only/index.md new file mode 100644 index 0000000..0e2218b --- /dev/null +++ b/website/docs/services/opensearchserverless/collections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: collections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - collections_list_only + - opensearchserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists collections in a region or regions, for all properties use collections + +## Overview + + + + + + + +
Namecollections_list_only
TypeResource
DescriptionAmazon OpenSearchServerless collection resource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier of the collection
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all collections in a region. +```sql +SELECT +region, +id +FROM aws.opensearchserverless.collections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collections_list_only resource, see collections + diff --git a/website/docs/services/opensearchserverless/index.md b/website/docs/services/opensearchserverless/index.md new file mode 100644 index 0000000..328e5a0 --- /dev/null +++ b/website/docs/services/opensearchserverless/index.md @@ -0,0 +1,48 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The opensearchserverless service documentation. + +:::info Service Summary + +
+
+total resources: 13
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/opensearchserverless/lifecycle_policies/index.md b/website/docs/services/opensearchserverless/lifecycle_policies/index.md new file mode 100644 index 0000000..3255b77 --- /dev/null +++ b/website/docs/services/opensearchserverless/lifecycle_policies/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a lifecycle_policy resource or lists lifecycle_policies in a region + +## Overview + + + + + + + +
Namelifecycle_policies
TypeResource
DescriptionAmazon OpenSearchServerless lifecycle policy resource
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the policy
stringThe type of lifecycle policy
stringThe description of the policy
stringThe JSON policy document that is the content for the policy
stringAWS region.
+ +For more information, see AWS::OpenSearchServerless::LifecyclePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all lifecycle_policies in a region. +```sql +SELECT +region, +name, +type, +description, +policy +FROM aws.opensearchserverless.lifecycle_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual lifecycle_policy. +```sql +SELECT +region, +name, +type, +description, +policy +FROM aws.opensearchserverless.lifecycle_policies +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new lifecycle_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.lifecycle_policies ( + Name, + Type, + Policy, + region +) +SELECT +'{{ Name }}', + '{{ Type }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.lifecycle_policies ( + Name, + Type, + Description, + Policy, + region +) +SELECT + '{{ Name }}', + '{{ Type }}', + '{{ Description }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: lifecycle_policy + props: + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: Description + value: '{{ Description }}' + - name: Policy + value: '{{ Policy }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.opensearchserverless.lifecycle_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the lifecycle_policies resource, the following permissions are required: + +### Create +```json +aoss:CreateLifecyclePolicy +``` + +### Read +```json +aoss:BatchGetLifecyclePolicy +``` + +### Update +```json +aoss:UpdateLifecyclePolicy, +aoss:BatchGetLifecyclePolicy +``` + +### Delete +```json +aoss:DeleteLifecyclePolicy +``` + +### List +```json +aoss:ListLifecyclePolicies +``` diff --git a/website/docs/services/opensearchserverless/lifecycle_policies_list_only/index.md b/website/docs/services/opensearchserverless/lifecycle_policies_list_only/index.md new file mode 100644 index 0000000..1996a5c --- /dev/null +++ b/website/docs/services/opensearchserverless/lifecycle_policies_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: lifecycle_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_policies_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists lifecycle_policies in a region or regions, for all properties use lifecycle_policies + +## Overview + + + + + + + +
Namelifecycle_policies_list_only
TypeResource
DescriptionAmazon OpenSearchServerless lifecycle policy resource
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the policy
stringThe type of lifecycle policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all lifecycle_policies in a region. +```sql +SELECT +region, +type, +name +FROM aws.opensearchserverless.lifecycle_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lifecycle_policies_list_only resource, see lifecycle_policies + diff --git a/website/docs/services/opensearchserverless/security_configs/index.md b/website/docs/services/opensearchserverless/security_configs/index.md new file mode 100644 index 0000000..2bb2e25 --- /dev/null +++ b/website/docs/services/opensearchserverless/security_configs/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_config resource or lists security_configs in a region + +## Overview + + + + + + + +
Namesecurity_configs
TypeResource
DescriptionAmazon OpenSearchServerless security config resource
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringSecurity config description
stringThe identifier of the security config
stringThe friendly name of the security config
objectDescribes saml options in form of key value map
objectDescribes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map
stringConfig type for security config
stringAWS region.
+ +For more information, see AWS::OpenSearchServerless::SecurityConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_configs in a region. +```sql +SELECT +region, +description, +id, +name, +saml_options, +iam_identity_center_options, +type +FROM aws.opensearchserverless.security_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_config. +```sql +SELECT +region, +description, +id, +name, +saml_options, +iam_identity_center_options, +type +FROM aws.opensearchserverless.security_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.security_configs ( + Description, + Name, + SamlOptions, + IamIdentityCenterOptions, + Type, + region +) +SELECT +'{{ Description }}', + '{{ Name }}', + '{{ SamlOptions }}', + '{{ IamIdentityCenterOptions }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.security_configs ( + Description, + Name, + SamlOptions, + IamIdentityCenterOptions, + Type, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ SamlOptions }}', + '{{ IamIdentityCenterOptions }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_config + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: SamlOptions + value: + Metadata: '{{ Metadata }}' + UserAttribute: '{{ UserAttribute }}' + GroupAttribute: '{{ GroupAttribute }}' + SessionTimeout: '{{ SessionTimeout }}' + - name: IamIdentityCenterOptions + value: + InstanceArn: '{{ InstanceArn }}' + ApplicationArn: '{{ ApplicationArn }}' + ApplicationName: '{{ ApplicationName }}' + ApplicationDescription: '{{ ApplicationDescription }}' + UserAttribute: '{{ UserAttribute }}' + GroupAttribute: '{{ GroupAttribute }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.opensearchserverless.security_configs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the security_configs resource, the following permissions are required: + +### Create +```json +aoss:CreateSecurityConfig, +sso:CreateApplication, +sso:ListApplications, +sso:DeleteApplication, +sso:PutApplicationAssignmentConfiguration, +sso:PutApplicationAuthenticationMethod, +sso:PutApplicationGrant +``` + +### Read +```json +aoss:GetSecurityConfig +``` + +### Update +```json +aoss:GetSecurityConfig, +aoss:UpdateSecurityConfig +``` + +### Delete +```json +aoss:DeleteSecurityConfig, +sso:ListApplicationAssignments, +sso:DeleteApplicationAssignment, +sso:DeleteApplication +``` + +### List +```json +aoss:ListSecurityConfigs +``` diff --git a/website/docs/services/opensearchserverless/security_configs_list_only/index.md b/website/docs/services/opensearchserverless/security_configs_list_only/index.md new file mode 100644 index 0000000..c21affa --- /dev/null +++ b/website/docs/services/opensearchserverless/security_configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: security_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_configs_list_only + - opensearchserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_configs in a region or regions, for all properties use security_configs + +## Overview + + + + + + + +
Namesecurity_configs_list_only
TypeResource
DescriptionAmazon OpenSearchServerless security config resource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier of the security config
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_configs in a region. +```sql +SELECT +region, +id +FROM aws.opensearchserverless.security_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_configs_list_only resource, see security_configs + diff --git a/website/docs/services/opensearchserverless/security_policies/index.md b/website/docs/services/opensearchserverless/security_policies/index.md new file mode 100644 index 0000000..d189e59 --- /dev/null +++ b/website/docs/services/opensearchserverless/security_policies/index.md @@ -0,0 +1,227 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_policy resource or lists security_policies in a region + +## Overview + + + + + + + +
Namesecurity_policies
TypeResource
DescriptionAmazon OpenSearchServerless security policy resource
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe description of the policy
stringThe JSON policy document that is the content for the policy
stringThe name of the policy
stringThe possible types for the network policy
stringAWS region.
+ +For more information, see AWS::OpenSearchServerless::SecurityPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_policies in a region. +```sql +SELECT +region, +description, +policy, +name, +type +FROM aws.opensearchserverless.security_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_policy. +```sql +SELECT +region, +description, +policy, +name, +type +FROM aws.opensearchserverless.security_policies +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.security_policies ( + Policy, + Name, + Type, + region +) +SELECT +'{{ Policy }}', + '{{ Name }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.security_policies ( + Description, + Policy, + Name, + Type, + region +) +SELECT + '{{ Description }}', + '{{ Policy }}', + '{{ Name }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_policy + props: + - name: Description + value: '{{ Description }}' + - name: Policy + value: '{{ Policy }}' + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.opensearchserverless.security_policies +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +aoss:GetSecurityPolicy, +aoss:UpdateSecurityPolicy, +kms:DescribeKey, +kms:CreateGrant +``` + +### Delete +```json +aoss:GetSecurityPolicy, +aoss:DeleteSecurityPolicy +``` + +### List +```json +aoss:ListSecurityPolicies +``` + +### Read +```json +aoss:GetSecurityPolicy, +kms:DescribeKey +``` diff --git a/website/docs/services/opensearchserverless/security_policies_list_only/index.md b/website/docs/services/opensearchserverless/security_policies_list_only/index.md new file mode 100644 index 0000000..a24edcd --- /dev/null +++ b/website/docs/services/opensearchserverless/security_policies_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: security_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_policies_list_only + - opensearchserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_policies in a region or regions, for all properties use security_policies + +## Overview + + + + + + + +
Namesecurity_policies_list_only
TypeResource
DescriptionAmazon OpenSearchServerless security policy resource
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the policy
stringThe possible types for the network policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_policies in a region. +```sql +SELECT +region, +type, +name +FROM aws.opensearchserverless.security_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_policies_list_only resource, see security_policies + diff --git a/website/docs/services/opensearchserverless/vpc_endpoints/index.md b/website/docs/services/opensearchserverless/vpc_endpoints/index.md new file mode 100644 index 0000000..40c7afc --- /dev/null +++ b/website/docs/services/opensearchserverless/vpc_endpoints/index.md @@ -0,0 +1,276 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_endpoint resource or lists vpc_endpoints in a region + +## Overview + + + + + + + +
Namevpc_endpoints
TypeResource
DescriptionAmazon OpenSearchServerless vpc endpoint resource
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the VPC Endpoint
stringThe name of the VPC Endpoint
arrayThe ID of one or more security groups to associate with the endpoint network interface
arrayThe ID of one or more subnets in which to create an endpoint network interface
stringThe ID of the VPC in which the endpoint will be used.
stringAWS region.
+ +For more information, see AWS::OpenSearchServerless::VpcEndpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_endpoints in a region. +```sql +SELECT +region, +id, +name, +security_group_ids, +subnet_ids, +vpc_id +FROM aws.opensearchserverless.vpc_endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_endpoint. +```sql +SELECT +region, +id, +name, +security_group_ids, +subnet_ids, +vpc_id +FROM aws.opensearchserverless.vpc_endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.vpc_endpoints ( + Name, + SubnetIds, + VpcId, + region +) +SELECT +'{{ Name }}', + '{{ SubnetIds }}', + '{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchserverless.vpc_endpoints ( + Name, + SecurityGroupIds, + SubnetIds, + VpcId, + region +) +SELECT + '{{ Name }}', + '{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ VpcId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_endpoint + props: + - name: Name + value: '{{ Name }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: VpcId + value: '{{ VpcId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.opensearchserverless.vpc_endpoints +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +aoss:ListVpcEndpoints, +ec2:DescribeVpcEndpoints +``` diff --git a/website/docs/services/opensearchserverless/vpc_endpoints_list_only/index.md b/website/docs/services/opensearchserverless/vpc_endpoints_list_only/index.md new file mode 100644 index 0000000..0f500a7 --- /dev/null +++ b/website/docs/services/opensearchserverless/vpc_endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoints_list_only + - opensearchserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_endpoints in a region or regions, for all properties use vpc_endpoints + +## Overview + + + + + + + +
Namevpc_endpoints_list_only
TypeResource
DescriptionAmazon OpenSearchServerless vpc endpoint resource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier of the VPC Endpoint
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_endpoints in a region. +```sql +SELECT +region, +id +FROM aws.opensearchserverless.vpc_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoints_list_only resource, see vpc_endpoints + diff --git a/website/docs/services/opensearchservice/application_tags/index.md b/website/docs/services/opensearchservice/application_tags/index.md new file mode 100644 index 0000000..e335a90 --- /dev/null +++ b/website/docs/services/opensearchservice/application_tags/index.md @@ -0,0 +1,89 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionAmazon OpenSearchService application resource
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectOptions for configuring IAM Identity Center
stringAmazon Resource Name (ARN) format.
stringThe identifier of the application.
stringThe name of the application.
stringThe endpoint for the application.
arrayList of application configurations.
arrayList of data sources.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +iam_identity_center_options, +arn, +id, +name, +endpoint, +app_configs, +data_sources, +tag_key, +tag_value +FROM aws.opensearchservice.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/opensearchservice/applications/index.md b/website/docs/services/opensearchservice/applications/index.md new file mode 100644 index 0000000..be6243f --- /dev/null +++ b/website/docs/services/opensearchservice/applications/index.md @@ -0,0 +1,254 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionAmazon OpenSearchService application resource
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectOptions for configuring IAM Identity Center
stringAmazon Resource Name (ARN) format.
stringThe identifier of the application.
stringThe name of the application.
stringThe endpoint for the application.
arrayList of application configurations.
arrayList of data sources.
arrayAn arbitrary set of tags (key-value pairs) for this application.
stringAWS region.
+ +For more information, see AWS::OpenSearchService::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +iam_identity_center_options, +arn, +id, +name, +endpoint, +app_configs, +data_sources, +tags +FROM aws.opensearchservice.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +iam_identity_center_options, +arn, +id, +name, +endpoint, +app_configs, +data_sources, +tags +FROM aws.opensearchservice.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchservice.applications ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchservice.applications ( + IamIdentityCenterOptions, + Name, + Endpoint, + AppConfigs, + DataSources, + Tags, + region +) +SELECT + '{{ IamIdentityCenterOptions }}', + '{{ Name }}', + '{{ Endpoint }}', + '{{ AppConfigs }}', + '{{ DataSources }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: IamIdentityCenterOptions + value: + Enabled: '{{ Enabled }}' + IamIdentityCenterInstanceArn: '{{ IamIdentityCenterInstanceArn }}' + IamRoleForIdentityCenterApplicationArn: '{{ IamRoleForIdentityCenterApplicationArn }}' + - name: Name + value: '{{ Name }}' + - name: Endpoint + value: '{{ Endpoint }}' + - name: AppConfigs + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: DataSources + value: + - DataSourceArn: '{{ DataSourceArn }}' + DataSourceDescription: '{{ DataSourceDescription }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.opensearchservice.applications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +es:CreateApplication, +es:GetApplication, +es:AddTags, +es:ListTags, +iam:CreateServiceLinkedRole +``` + +### Read +```json +es:GetApplication, +es:ListTags +``` + +### Update +```json +es:UpdateApplication, +es:GetApplication, +es:AddTags, +es:RemoveTags, +es:ListTags +``` + +### Delete +```json +es:GetApplication, +es:DeleteApplication +``` + +### List +```json +es:ListApplications +``` diff --git a/website/docs/services/opensearchservice/applications_list_only/index.md b/website/docs/services/opensearchservice/applications_list_only/index.md new file mode 100644 index 0000000..ad6eae3 --- /dev/null +++ b/website/docs/services/opensearchservice/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionAmazon OpenSearchService application resource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +name +FROM aws.opensearchservice.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/opensearchservice/domains/index.md b/website/docs/services/opensearchservice/domains/index.md new file mode 100644 index 0000000..306e116 --- /dev/null +++ b/website/docs/services/opensearchservice/domains/index.md @@ -0,0 +1,433 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain resource or lists domains in a region + +## Overview + + + + + + + +
Namedomains
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
object
string
string
object
object
object
object
object
object
object
object
string
string
object
object
string
string
string
object
arrayAn arbitrary set of tags (key-value pairs) for this Domain.
object
object
object
boolean
objectOptions for configuring Identity Center
stringAWS region.
+ +For more information, see AWS::OpenSearchService::Domain. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual domain. +```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, +skip_shard_migration_wait, +identity_center_options +FROM aws.opensearchservice.domains +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchservice.domains ( + ClusterConfig, + DomainName, + AccessPolicies, + IPAddressType, + EngineVersion, + AdvancedOptions, + LogPublishingOptions, + SnapshotOptions, + VPCOptions, + NodeToNodeEncryptionOptions, + DomainEndpointOptions, + CognitoOptions, + AdvancedSecurityOptions, + EBSOptions, + EncryptionAtRestOptions, + Tags, + OffPeakWindowOptions, + SoftwareUpdateOptions, + SkipShardMigrationWait, + IdentityCenterOptions, + region +) +SELECT +'{{ ClusterConfig }}', + '{{ DomainName }}', + '{{ AccessPolicies }}', + '{{ IPAddressType }}', + '{{ EngineVersion }}', + '{{ AdvancedOptions }}', + '{{ LogPublishingOptions }}', + '{{ SnapshotOptions }}', + '{{ VPCOptions }}', + '{{ NodeToNodeEncryptionOptions }}', + '{{ DomainEndpointOptions }}', + '{{ CognitoOptions }}', + '{{ AdvancedSecurityOptions }}', + '{{ EBSOptions }}', + '{{ EncryptionAtRestOptions }}', + '{{ Tags }}', + '{{ OffPeakWindowOptions }}', + '{{ SoftwareUpdateOptions }}', + '{{ SkipShardMigrationWait }}', + '{{ IdentityCenterOptions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.opensearchservice.domains ( + ClusterConfig, + DomainName, + AccessPolicies, + IPAddressType, + EngineVersion, + AdvancedOptions, + LogPublishingOptions, + SnapshotOptions, + VPCOptions, + NodeToNodeEncryptionOptions, + DomainEndpointOptions, + CognitoOptions, + AdvancedSecurityOptions, + EBSOptions, + EncryptionAtRestOptions, + Tags, + OffPeakWindowOptions, + SoftwareUpdateOptions, + SkipShardMigrationWait, + IdentityCenterOptions, + region +) +SELECT + '{{ ClusterConfig }}', + '{{ DomainName }}', + '{{ AccessPolicies }}', + '{{ IPAddressType }}', + '{{ EngineVersion }}', + '{{ AdvancedOptions }}', + '{{ LogPublishingOptions }}', + '{{ SnapshotOptions }}', + '{{ VPCOptions }}', + '{{ NodeToNodeEncryptionOptions }}', + '{{ DomainEndpointOptions }}', + '{{ CognitoOptions }}', + '{{ AdvancedSecurityOptions }}', + '{{ EBSOptions }}', + '{{ EncryptionAtRestOptions }}', + '{{ Tags }}', + '{{ OffPeakWindowOptions }}', + '{{ SoftwareUpdateOptions }}', + '{{ SkipShardMigrationWait }}', + '{{ IdentityCenterOptions }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain + props: + - name: ClusterConfig + value: + InstanceCount: '{{ InstanceCount }}' + WarmEnabled: '{{ WarmEnabled }}' + WarmCount: '{{ WarmCount }}' + DedicatedMasterEnabled: '{{ DedicatedMasterEnabled }}' + ZoneAwarenessConfig: + AvailabilityZoneCount: '{{ AvailabilityZoneCount }}' + DedicatedMasterCount: '{{ DedicatedMasterCount }}' + InstanceType: '{{ InstanceType }}' + WarmType: '{{ WarmType }}' + ZoneAwarenessEnabled: '{{ ZoneAwarenessEnabled }}' + DedicatedMasterType: '{{ DedicatedMasterType }}' + MultiAZWithStandbyEnabled: '{{ MultiAZWithStandbyEnabled }}' + ColdStorageOptions: + Enabled: '{{ Enabled }}' + NodeOptions: + - NodeType: '{{ NodeType }}' + NodeConfig: + Enabled: '{{ Enabled }}' + Type: '{{ Type }}' + Count: '{{ Count }}' + - name: DomainName + value: '{{ DomainName }}' + - name: AccessPolicies + value: {} + - name: IPAddressType + value: '{{ IPAddressType }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: AdvancedOptions + value: {} + - name: LogPublishingOptions + value: {} + - name: SnapshotOptions + value: + AutomatedSnapshotStartHour: '{{ AutomatedSnapshotStartHour }}' + - name: VPCOptions + value: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: NodeToNodeEncryptionOptions + value: + Enabled: '{{ Enabled }}' + - name: DomainEndpointOptions + value: + CustomEndpointCertificateArn: '{{ CustomEndpointCertificateArn }}' + CustomEndpointEnabled: '{{ CustomEndpointEnabled }}' + EnforceHTTPS: '{{ EnforceHTTPS }}' + CustomEndpoint: '{{ CustomEndpoint }}' + TLSSecurityPolicy: '{{ TLSSecurityPolicy }}' + - name: CognitoOptions + value: + Enabled: '{{ Enabled }}' + IdentityPoolId: '{{ IdentityPoolId }}' + UserPoolId: '{{ UserPoolId }}' + RoleArn: '{{ RoleArn }}' + - name: AdvancedSecurityOptions + value: + Enabled: '{{ Enabled }}' + MasterUserOptions: + MasterUserPassword: '{{ MasterUserPassword }}' + MasterUserName: '{{ MasterUserName }}' + MasterUserARN: '{{ MasterUserARN }}' + InternalUserDatabaseEnabled: '{{ InternalUserDatabaseEnabled }}' + AnonymousAuthEnabled: '{{ AnonymousAuthEnabled }}' + SAMLOptions: + Enabled: '{{ Enabled }}' + Idp: + MetadataContent: '{{ MetadataContent }}' + EntityId: '{{ EntityId }}' + MasterUserName: '{{ MasterUserName }}' + MasterBackendRole: '{{ MasterBackendRole }}' + SubjectKey: '{{ SubjectKey }}' + RolesKey: '{{ RolesKey }}' + SessionTimeoutMinutes: '{{ SessionTimeoutMinutes }}' + JWTOptions: + Enabled: '{{ Enabled }}' + PublicKey: '{{ PublicKey }}' + SubjectKey: '{{ SubjectKey }}' + RolesKey: '{{ RolesKey }}' + AnonymousAuthDisableDate: '{{ AnonymousAuthDisableDate }}' + - name: EBSOptions + value: + EBSEnabled: '{{ EBSEnabled }}' + VolumeType: '{{ VolumeType }}' + Iops: '{{ Iops }}' + VolumeSize: '{{ VolumeSize }}' + Throughput: '{{ Throughput }}' + - name: EncryptionAtRestOptions + value: + KmsKeyId: '{{ KmsKeyId }}' + Enabled: '{{ Enabled }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: OffPeakWindowOptions + value: + Enabled: '{{ Enabled }}' + OffPeakWindow: + WindowStartTime: + Hours: '{{ Hours }}' + Minutes: '{{ Minutes }}' + - name: SoftwareUpdateOptions + value: + AutoSoftwareUpdateEnabled: '{{ AutoSoftwareUpdateEnabled }}' + - name: SkipShardMigrationWait + value: '{{ SkipShardMigrationWait }}' + - name: IdentityCenterOptions + value: + EnabledAPIAccess: '{{ EnabledAPIAccess }}' + IdentityCenterInstanceARN: '{{ IdentityCenterInstanceARN }}' + SubjectKey: '{{ SubjectKey }}' + RolesKey: '{{ RolesKey }}' + IdentityCenterApplicationARN: '{{ IdentityCenterApplicationARN }}' + IdentityStoreId: '{{ IdentityStoreId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.opensearchservice.domains +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/opensearchservice/index.md b/website/docs/services/opensearchservice/index.md new file mode 100644 index 0000000..d98fa37 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The opensearchservice service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/opsworkscm/index.md b/website/docs/services/opsworkscm/index.md new file mode 100644 index 0000000..4035712 --- /dev/null +++ b/website/docs/services/opsworkscm/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The opsworkscm service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/opsworkscm/server_tags/index.md b/website/docs/services/opsworkscm/server_tags/index.md new file mode 100644 index 0000000..547f5e6 --- /dev/null +++ b/website/docs/services/opsworkscm/server_tags/index.md @@ -0,0 +1,119 @@ +--- +title: server_tags +hide_title: false +hide_table_of_contents: false +keywords: + - server_tags + - opsworkscm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for servers in a region + +## Overview + + + + + + + +
Nameserver_tags
TypeResource
DescriptionResource Type definition for AWS::OpsWorksCM::Server
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
string
boolean
string
string
string
array
array
string
string
string
string
array
integer
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all servers in a region. +```sql +SELECT +region, +key_pair, +engine_version, +service_role_arn, +disable_automated_backup, +backup_id, +engine_model, +preferred_maintenance_window, +associate_public_ip_address, +instance_profile_arn, +custom_certificate, +preferred_backup_window, +security_group_ids, +subnet_ids, +custom_domain, +endpoint, +custom_private_key, +server_name, +engine_attributes, +backup_retention_count, +arn, +instance_type, +engine, +tag_key, +tag_value +FROM aws.opsworkscm.server_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the server_tags resource, see servers + diff --git a/website/docs/services/opsworkscm/servers/index.md b/website/docs/services/opsworkscm/servers/index.md new file mode 100644 index 0000000..72d7f89 --- /dev/null +++ b/website/docs/services/opsworkscm/servers/index.md @@ -0,0 +1,353 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a server resource or lists servers in a region + +## Overview + + + + + + + +
Nameservers
TypeResource
DescriptionResource Type definition for AWS::OpsWorksCM::Server
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
string
boolean
string
string
string
array
array
string
string
string
string
array
integer
string
string
array
string
stringAWS region.
+ +For more information, see AWS::OpsWorksCM::Server. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all servers in a region. +```sql +SELECT +region, +key_pair, +engine_version, +service_role_arn, +disable_automated_backup, +backup_id, +engine_model, +preferred_maintenance_window, +associate_public_ip_address, +instance_profile_arn, +custom_certificate, +preferred_backup_window, +security_group_ids, +subnet_ids, +custom_domain, +endpoint, +custom_private_key, +server_name, +engine_attributes, +backup_retention_count, +arn, +instance_type, +tags, +engine +FROM aws.opsworkscm.servers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual server. +```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.servers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new server resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.opsworkscm.servers ( + ServiceRoleArn, + InstanceProfileArn, + InstanceType, + region +) +SELECT +'{{ ServiceRoleArn }}', + '{{ InstanceProfileArn }}', + '{{ InstanceType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.opsworkscm.servers ( + KeyPair, + EngineVersion, + ServiceRoleArn, + DisableAutomatedBackup, + BackupId, + EngineModel, + PreferredMaintenanceWindow, + AssociatePublicIpAddress, + InstanceProfileArn, + CustomCertificate, + PreferredBackupWindow, + SecurityGroupIds, + SubnetIds, + CustomDomain, + CustomPrivateKey, + EngineAttributes, + BackupRetentionCount, + InstanceType, + Tags, + Engine, + region +) +SELECT + '{{ KeyPair }}', + '{{ EngineVersion }}', + '{{ ServiceRoleArn }}', + '{{ DisableAutomatedBackup }}', + '{{ BackupId }}', + '{{ EngineModel }}', + '{{ PreferredMaintenanceWindow }}', + '{{ AssociatePublicIpAddress }}', + '{{ InstanceProfileArn }}', + '{{ CustomCertificate }}', + '{{ PreferredBackupWindow }}', + '{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ CustomDomain }}', + '{{ CustomPrivateKey }}', + '{{ EngineAttributes }}', + '{{ BackupRetentionCount }}', + '{{ InstanceType }}', + '{{ Tags }}', + '{{ Engine }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: server + props: + - name: KeyPair + value: '{{ KeyPair }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: ServiceRoleArn + value: '{{ ServiceRoleArn }}' + - name: DisableAutomatedBackup + value: '{{ DisableAutomatedBackup }}' + - name: BackupId + value: '{{ BackupId }}' + - name: EngineModel + value: '{{ EngineModel }}' + - name: PreferredMaintenanceWindow + value: '{{ PreferredMaintenanceWindow }}' + - name: AssociatePublicIpAddress + value: '{{ AssociatePublicIpAddress }}' + - name: InstanceProfileArn + value: '{{ InstanceProfileArn }}' + - name: CustomCertificate + value: '{{ CustomCertificate }}' + - name: PreferredBackupWindow + value: '{{ PreferredBackupWindow }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: CustomDomain + value: '{{ CustomDomain }}' + - name: CustomPrivateKey + value: '{{ CustomPrivateKey }}' + - name: EngineAttributes + value: + - Value: '{{ Value }}' + Name: '{{ Name }}' + - name: BackupRetentionCount + value: '{{ BackupRetentionCount }}' + - name: InstanceType + value: '{{ InstanceType }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Engine + value: '{{ Engine }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.opsworkscm.servers +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +opsworks-cm:DeleteServer, +opsworks-cm:DescribeServers +``` + +### Update +```json +opsworks-cm:UpdateServer, +opsworks-cm:TagResource, +opsworks-cm:UntagResource, +opsworks-cm:DescribeServers +``` + +### List +```json +opsworks-cm:DescribeServers, +opsworks-cm:ListTagsForResource +``` + +### Read +```json +opsworks-cm:DescribeServers +``` diff --git a/website/docs/services/opsworkscm/servers_list_only/index.md b/website/docs/services/opsworkscm/servers_list_only/index.md new file mode 100644 index 0000000..629be8c --- /dev/null +++ b/website/docs/services/opsworkscm/servers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: servers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - servers_list_only + - opsworkscm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists servers in a region or regions, for all properties use servers + +## Overview + + + + + + + +
Nameservers_list_only
TypeResource
DescriptionResource Type definition for AWS::OpsWorksCM::Server
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all servers in a region. +```sql +SELECT +region, +server_name +FROM aws.opsworkscm.servers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the servers_list_only resource, see servers + diff --git a/website/docs/services/organizations/account_tags/index.md b/website/docs/services/organizations/account_tags/index.md new file mode 100644 index 0000000..3f5a9f2 --- /dev/null +++ b/website/docs/services/organizations/account_tags/index.md @@ -0,0 +1,93 @@ +--- +title: account_tags +hide_title: false +hide_table_of_contents: false +keywords: + - account_tags + - organizations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for accounts in a region + +## Overview + + + + + + + +
Nameaccount_tags
TypeResource
DescriptionYou can use AWS::Organizations::Account to manage accounts in organization.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe friendly name of the member account.
stringThe email address of the owner to assign to the new member account.
stringThe name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
arrayList of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
stringIf the account was created successfully, the unique identifier (ID) of the new account.
stringThe Amazon Resource Name (ARN) of the account.
stringThe method by which the account joined the organization.
stringThe date the account became a part of the organization.
stringThe status of the account in the organization.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all accounts in a region. +```sql +SELECT +region, +account_name, +email, +role_name, +parent_ids, +account_id, +arn, +joined_method, +joined_timestamp, +status, +tag_key, +tag_value +FROM aws.organizations.account_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the account_tags resource, see accounts + diff --git a/website/docs/services/organizations/accounts/index.md b/website/docs/services/organizations/accounts/index.md new file mode 100644 index 0000000..73de3f1 --- /dev/null +++ b/website/docs/services/organizations/accounts/index.md @@ -0,0 +1,256 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an account resource or lists accounts in a region + +## Overview + + + + + + + +
Nameaccounts
TypeResource
DescriptionYou can use AWS::Organizations::Account to manage accounts in organization.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe friendly name of the member account.
stringThe email address of the owner to assign to the new member account.
stringThe name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
arrayList of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
arrayA list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.
stringIf the account was created successfully, the unique identifier (ID) of the new account.
stringThe Amazon Resource Name (ARN) of the account.
stringThe method by which the account joined the organization.
stringThe date the account became a part of the organization.
stringThe status of the account in the organization.
stringAWS region.
+ +For more information, see AWS::Organizations::Account. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all accounts in a region. +```sql +SELECT +region, +account_name, +email, +role_name, +parent_ids, +tags, +account_id, +arn, +joined_method, +joined_timestamp, +status +FROM aws.organizations.accounts +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual account. +```sql +SELECT +region, +account_name, +email, +role_name, +parent_ids, +tags, +account_id, +arn, +joined_method, +joined_timestamp, +status +FROM aws.organizations.accounts +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new account resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.organizations.accounts ( + AccountName, + Email, + region +) +SELECT +'{{ AccountName }}', + '{{ Email }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.organizations.accounts ( + AccountName, + Email, + RoleName, + ParentIds, + Tags, + region +) +SELECT + '{{ AccountName }}', + '{{ Email }}', + '{{ RoleName }}', + '{{ ParentIds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: account + props: + - name: AccountName + value: '{{ AccountName }}' + - name: Email + value: '{{ Email }}' + - name: RoleName + value: '{{ RoleName }}' + - name: ParentIds + value: + - '{{ ParentIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.organizations.accounts +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +organizations:ListAccounts +``` diff --git a/website/docs/services/organizations/accounts_list_only/index.md b/website/docs/services/organizations/accounts_list_only/index.md new file mode 100644 index 0000000..cf0898b --- /dev/null +++ b/website/docs/services/organizations/accounts_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: accounts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - accounts_list_only + - organizations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists accounts in a region or regions, for all properties use accounts + +## Overview + + + + + + + +
Nameaccounts_list_only
TypeResource
DescriptionYou can use AWS::Organizations::Account to manage accounts in organization.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringIf the account was created successfully, the unique identifier (ID) of the new account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all accounts in a region. +```sql +SELECT +region, +account_id +FROM aws.organizations.accounts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the accounts_list_only resource, see accounts + diff --git a/website/docs/services/organizations/index.md b/website/docs/services/organizations/index.md new file mode 100644 index 0000000..201679c --- /dev/null +++ b/website/docs/services/organizations/index.md @@ -0,0 +1,49 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The organizations service documentation. + +:::info Service Summary + +
+
+total resources: 14
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/organizations/organizational_unit_tags/index.md b/website/docs/services/organizations/organizational_unit_tags/index.md new file mode 100644 index 0000000..afcb6d0 --- /dev/null +++ b/website/docs/services/organizations/organizational_unit_tags/index.md @@ -0,0 +1,83 @@ +--- +title: organizational_unit_tags +hide_title: false +hide_table_of_contents: false +keywords: + - organizational_unit_tags + - organizations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for organizational_units in a region + +## Overview + + + + + + + +
Nameorganizational_unit_tags
TypeResource
DescriptionYou can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this OU.
stringThe unique identifier (ID) associated with this OU.
stringThe friendly name of this OU.
stringThe unique identifier (ID) of the parent root or OU that you want to create the new OU in.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all organizational_units in a region. +```sql +SELECT +region, +arn, +id, +name, +parent_id, +tag_key, +tag_value +FROM aws.organizations.organizational_unit_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organizational_unit_tags resource, see organizational_units + diff --git a/website/docs/services/organizations/organizational_units/index.md b/website/docs/services/organizations/organizational_units/index.md new file mode 100644 index 0000000..54f57e0 --- /dev/null +++ b/website/docs/services/organizations/organizational_units/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an organizational_unit resource or lists 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.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this OU.
stringThe unique identifier (ID) associated with this OU.
stringThe friendly name of this OU.
stringThe unique identifier (ID) of the parent root or OU that you want to create the new OU in.
arrayA list of tags that you want to attach to the newly created OU.
stringAWS region.
+ +For more information, see AWS::Organizations::OrganizationalUnit. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all organizational_units in a region. +```sql +SELECT +region, +arn, +id, +name, +parent_id, +tags +FROM aws.organizations.organizational_units +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual organizational_unit. +```sql +SELECT +region, +arn, +id, +name, +parent_id, +tags +FROM aws.organizations.organizational_units +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new organizational_unit resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.organizations.organizational_units ( + Name, + ParentId, + region +) +SELECT +'{{ Name }}', + '{{ ParentId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.organizations.organizational_units ( + Name, + ParentId, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ ParentId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: organizational_unit + props: + - name: Name + value: '{{ Name }}' + - name: ParentId + value: '{{ ParentId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.organizations.organizational_units +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +organizations:ListOrganizationalUnitsForParent +``` diff --git a/website/docs/services/organizations/organizational_units_list_only/index.md b/website/docs/services/organizations/organizational_units_list_only/index.md new file mode 100644 index 0000000..3c76b3e --- /dev/null +++ b/website/docs/services/organizations/organizational_units_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: organizational_units_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - organizational_units_list_only + - organizations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists organizational_units in a region or regions, for all properties use organizational_units + +## Overview + + + + + + + +
Nameorganizational_units_list_only
TypeResource
DescriptionYou can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) associated with this OU.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all organizational_units in a region. +```sql +SELECT +region, +id +FROM aws.organizations.organizational_units_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organizational_units_list_only resource, see organizational_units + diff --git a/website/docs/services/organizations/organizations/index.md b/website/docs/services/organizations/organizations/index.md new file mode 100644 index 0000000..6be0c61 --- /dev/null +++ b/website/docs/services/organizations/organizations/index.md @@ -0,0 +1,217 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an organization resource or lists organizations in a region + +## Overview + + + + + + + +
Nameorganizations
TypeResource
DescriptionResource schema for AWS::Organizations::Organization
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) of an organization.
stringThe Amazon Resource Name (ARN) of an organization.
stringSpecifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
stringThe Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.
stringThe unique identifier (ID) of the management account of an organization.
stringThe email address that is associated with the AWS account that is designated as the management account for the organization.
stringThe unique identifier (ID) for the root.
stringAWS region.
+ +For more information, see AWS::Organizations::Organization. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all organizations in a region. +```sql +SELECT +region, +id, +arn, +feature_set, +management_account_arn, +management_account_id, +management_account_email, +root_id +FROM aws.organizations.organizations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual organization. +```sql +SELECT +region, +id, +arn, +feature_set, +management_account_arn, +management_account_id, +management_account_email, +root_id +FROM aws.organizations.organizations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new organization resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.organizations.organizations ( + FeatureSet, + region +) +SELECT +'{{ FeatureSet }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.organizations.organizations ( + FeatureSet, + region +) +SELECT + '{{ FeatureSet }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: organization + props: + - name: FeatureSet + value: '{{ FeatureSet }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.organizations.organizations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +organizations:DescribeOrganization, +organizations:ListRoots +``` + +### Delete +```json +organizations:DeleteOrganization, +organizations:DescribeOrganization +``` + +### List +```json +organizations:DescribeOrganization +``` + +### Update +```json +organizations:DescribeOrganization +``` diff --git a/website/docs/services/organizations/organizations_list_only/index.md b/website/docs/services/organizations/organizations_list_only/index.md new file mode 100644 index 0000000..4616ef0 --- /dev/null +++ b/website/docs/services/organizations/organizations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: organizations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - organizations_list_only + - organizations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists organizations in a region or regions, for all properties use organizations + +## Overview + + + + + + + +
Nameorganizations_list_only
TypeResource
DescriptionResource schema for AWS::Organizations::Organization
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) of an organization.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all organizations in a region. +```sql +SELECT +region, +id +FROM aws.organizations.organizations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organizations_list_only resource, see organizations + diff --git a/website/docs/services/organizations/policies/index.md b/website/docs/services/organizations/policies/index.md new file mode 100644 index 0000000..9ce4ccf --- /dev/null +++ b/website/docs/services/organizations/policies/index.md @@ -0,0 +1,260 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a policy resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the Policy
stringThe type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2
objectThe Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
stringHuman readable description of the policy
arrayList of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
arrayA list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
stringId of the Policy
stringARN of the Policy
booleanA boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
stringAWS region.
+ +For more information, see AWS::Organizations::Policy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all policies in a region. +```sql +SELECT +region, +name, +type, +content, +description, +target_ids, +tags, +id, +arn, +aws_managed +FROM aws.organizations.policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual policy. +```sql +SELECT +region, +name, +type, +content, +description, +target_ids, +tags, +id, +arn, +aws_managed +FROM aws.organizations.policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.organizations.policies ( + Name, + Type, + Content, + region +) +SELECT +'{{ Name }}', + '{{ Type }}', + '{{ Content }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.organizations.policies ( + Name, + Type, + Content, + Description, + TargetIds, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Type }}', + '{{ Content }}', + '{{ Description }}', + '{{ TargetIds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: policy + props: + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: Content + value: {} + - name: Description + value: '{{ Description }}' + - name: TargetIds + value: + - '{{ TargetIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.organizations.policies +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +organizations:ListPolicies +``` diff --git a/website/docs/services/organizations/policies_list_only/index.md b/website/docs/services/organizations/policies_list_only/index.md new file mode 100644 index 0000000..5da3b9c --- /dev/null +++ b/website/docs/services/organizations/policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policies_list_only + - organizations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policies in a region or regions, for all properties use policies + +## Overview + + + + + + + +
Namepolicies_list_only
TypeResource
DescriptionPolicies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId of the Policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policies in a region. +```sql +SELECT +region, +id +FROM aws.organizations.policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policies_list_only resource, see policies + diff --git a/website/docs/services/organizations/policy_tags/index.md b/website/docs/services/organizations/policy_tags/index.md new file mode 100644 index 0000000..0e594b1 --- /dev/null +++ b/website/docs/services/organizations/policy_tags/index.md @@ -0,0 +1,91 @@ +--- +title: policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - policy_tags + - organizations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for policies in a region + +## Overview + + + + + + + +
Namepolicy_tags
TypeResource
DescriptionPolicies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the Policy
stringThe type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2
objectThe Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
stringHuman readable description of the policy
arrayList of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
stringId of the Policy
stringARN of the Policy
booleanA boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all policies in a region. +```sql +SELECT +region, +name, +type, +content, +description, +target_ids, +id, +arn, +aws_managed, +tag_key, +tag_value +FROM aws.organizations.policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_tags resource, see policies + diff --git a/website/docs/services/organizations/resource_policies/index.md b/website/docs/services/organizations/resource_policies/index.md new file mode 100644 index 0000000..92ac04e --- /dev/null +++ b/website/docs/services/organizations/resource_policies/index.md @@ -0,0 +1,217 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_policy resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) associated with this resource policy.
stringThe Amazon Resource Name (ARN) of the resource policy.
objectThe policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
arrayA list of tags that you want to attach to the resource policy
stringAWS region.
+ +For more information, see AWS::Organizations::ResourcePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_policies in a region. +```sql +SELECT +region, +id, +arn, +content, +tags +FROM aws.organizations.resource_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_policy. +```sql +SELECT +region, +id, +arn, +content, +tags +FROM aws.organizations.resource_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.organizations.resource_policies ( + Content, + region +) +SELECT +'{{ Content }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.organizations.resource_policies ( + Content, + Tags, + region +) +SELECT + '{{ Content }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_policy + props: + - name: Content + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.organizations.resource_policies +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +organizations:DescribeResourcePolicy, +organizations:ListTagsForResource +``` + +### Update +```json +organizations:DescribeResourcePolicy, +organizations:PutResourcePolicy, +organizations:ListTagsForResource, +organizations:TagResource, +organizations:UntagResource +``` + +### Delete +```json +organizations:DeleteResourcePolicy +``` + +### List +```json +organizations:DescribeResourcePolicy +``` diff --git a/website/docs/services/organizations/resource_policies_list_only/index.md b/website/docs/services/organizations/resource_policies_list_only/index.md new file mode 100644 index 0000000..afca348 --- /dev/null +++ b/website/docs/services/organizations/resource_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - organizations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionYou can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) associated with this resource policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +id +FROM aws.organizations.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + diff --git a/website/docs/services/organizations/resource_policy_tags/index.md b/website/docs/services/organizations/resource_policy_tags/index.md new file mode 100644 index 0000000..bd86c8a --- /dev/null +++ b/website/docs/services/organizations/resource_policy_tags/index.md @@ -0,0 +1,81 @@ +--- +title: resource_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policy_tags + - organizations + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resource_policies in a region + +## Overview + + + + + + + +
Nameresource_policy_tags
TypeResource
DescriptionYou can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) associated with this resource policy.
stringThe Amazon Resource Name (ARN) of the resource policy.
objectThe policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resource_policies in a region. +```sql +SELECT +region, +id, +arn, +content, +tag_key, +tag_value +FROM aws.organizations.resource_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policy_tags resource, see resource_policies + diff --git a/website/docs/services/osis/index.md b/website/docs/services/osis/index.md new file mode 100644 index 0000000..d5f9b4c --- /dev/null +++ b/website/docs/services/osis/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The osis service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/osis/pipeline_tags/index.md b/website/docs/services/osis/pipeline_tags/index.md new file mode 100644 index 0000000..0c3d784 --- /dev/null +++ b/website/docs/services/osis/pipeline_tags/index.md @@ -0,0 +1,99 @@ +--- +title: pipeline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline_tags + - osis + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pipelines in a region + +## Overview + + + + + + + +
Namepipeline_tags
TypeResource
DescriptionAn OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectKey-value pairs to configure buffering.
objectKey-value pairs to configure encryption at rest.
objectKey-value pairs to configure log publishing.
integerThe maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
integerThe minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
stringThe Data Prepper pipeline configuration.
stringName of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
objectContainer for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion Service creates the pipeline with a public endpoint.
arrayThe VPC interface endpoints that have access to the pipeline.
stringThe VPC endpoint service name for the pipeline.
stringThe Amazon Resource Name (ARN) of the pipeline.
arrayA list of endpoints that can be used for ingesting data into a pipeline
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pipelines in a region. +```sql +SELECT +region, +buffer_options, +encryption_at_rest_options, +log_publishing_options, +max_units, +min_units, +pipeline_configuration_body, +pipeline_name, +vpc_options, +vpc_endpoints, +vpc_endpoint_service, +pipeline_arn, +ingest_endpoint_urls, +tag_key, +tag_value +FROM aws.osis.pipeline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipeline_tags resource, see pipelines + diff --git a/website/docs/services/osis/pipelines/index.md b/website/docs/services/osis/pipelines/index.md new file mode 100644 index 0000000..f5c7544 --- /dev/null +++ b/website/docs/services/osis/pipelines/index.md @@ -0,0 +1,304 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a pipeline resource or lists pipelines in a region + +## Overview + + + + + + + +
Namepipelines
TypeResource
DescriptionAn OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectKey-value pairs to configure buffering.
objectKey-value pairs to configure encryption at rest.
objectKey-value pairs to configure log publishing.
integerThe maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
integerThe minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
stringThe Data Prepper pipeline configuration.
stringName of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
arrayAn array of key-value pairs to apply to this resource.
objectContainer for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion Service creates the pipeline with a public endpoint.
arrayThe VPC interface endpoints that have access to the pipeline.
stringThe VPC endpoint service name for the pipeline.
stringThe Amazon Resource Name (ARN) of the pipeline.
arrayA list of endpoints that can be used for ingesting data into a pipeline
stringAWS region.
+ +For more information, see AWS::OSIS::Pipeline. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all pipelines in a region. +```sql +SELECT +region, +buffer_options, +encryption_at_rest_options, +log_publishing_options, +max_units, +min_units, +pipeline_configuration_body, +pipeline_name, +tags, +vpc_options, +vpc_endpoints, +vpc_endpoint_service, +pipeline_arn, +ingest_endpoint_urls +FROM aws.osis.pipelines +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual pipeline. +```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, +vpc_endpoint_service, +pipeline_arn, +ingest_endpoint_urls +FROM aws.osis.pipelines +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.osis.pipelines ( + MaxUnits, + MinUnits, + PipelineConfigurationBody, + PipelineName, + region +) +SELECT +'{{ MaxUnits }}', + '{{ MinUnits }}', + '{{ PipelineConfigurationBody }}', + '{{ PipelineName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.osis.pipelines ( + BufferOptions, + EncryptionAtRestOptions, + LogPublishingOptions, + MaxUnits, + MinUnits, + PipelineConfigurationBody, + PipelineName, + Tags, + VpcOptions, + region +) +SELECT + '{{ BufferOptions }}', + '{{ EncryptionAtRestOptions }}', + '{{ LogPublishingOptions }}', + '{{ MaxUnits }}', + '{{ MinUnits }}', + '{{ PipelineConfigurationBody }}', + '{{ PipelineName }}', + '{{ Tags }}', + '{{ VpcOptions }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: pipeline + props: + - name: BufferOptions + value: + PersistentBufferEnabled: '{{ PersistentBufferEnabled }}' + - name: EncryptionAtRestOptions + value: + KmsKeyArn: '{{ KmsKeyArn }}' + - name: LogPublishingOptions + value: + IsLoggingEnabled: '{{ IsLoggingEnabled }}' + CloudWatchLogDestination: + LogGroup: '{{ LogGroup }}' + - name: MaxUnits + value: '{{ MaxUnits }}' + - name: MinUnits + value: '{{ MinUnits }}' + - name: PipelineConfigurationBody + value: '{{ PipelineConfigurationBody }}' + - name: PipelineName + value: '{{ PipelineName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VpcOptions + value: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + VpcEndpointManagement: '{{ VpcEndpointManagement }}' + VpcAttachmentOptions: + AttachToVpc: '{{ AttachToVpc }}' + CidrBlock: '{{ CidrBlock }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.osis.pipelines +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +osis:ListPipelines +``` diff --git a/website/docs/services/osis/pipelines_list_only/index.md b/website/docs/services/osis/pipelines_list_only/index.md new file mode 100644 index 0000000..9fb3fb4 --- /dev/null +++ b/website/docs/services/osis/pipelines_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipelines in a region or regions, for all properties use pipelines + +## Overview + + + + + + + +
Namepipelines_list_only
TypeResource
DescriptionAn OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the pipeline.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipelines in a region. +```sql +SELECT +region, +pipeline_arn +FROM aws.osis.pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipelines_list_only resource, see pipelines + diff --git a/website/docs/services/panorama/application_instance_tags/index.md b/website/docs/services/panorama/application_instance_tags/index.md new file mode 100644 index 0000000..dee3e8e --- /dev/null +++ b/website/docs/services/panorama/application_instance_tags/index.md @@ -0,0 +1,105 @@ +--- +title: application_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_instance_tags + - panorama + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for application_instances in a region + +## Overview + + + + + + + +
Nameapplication_instance_tags
TypeResource
DescriptionCreates an application instance and deploys it to a device.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe device's ID.
stringA description for the application instance.
stringThe ID of an application instance to replace with the new instance.
integer
string
objectSetting overrides for the application manifest.
integer
stringThe ARN of a runtime role for the application instance.
stringA name for the application instance.
string
string
objectThe application's manifest document.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all application_instances in a region. +```sql +SELECT +region, +default_runtime_context_device_name, +status, +default_runtime_context_device, +description, +application_instance_id_to_replace, +created_time, +health_status, +manifest_overrides_payload, +last_updated_time, +runtime_role_arn, +name, +application_instance_id, +status_description, +manifest_payload, +arn, +tag_key, +tag_value +FROM aws.panorama.application_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_instance_tags resource, see application_instances + diff --git a/website/docs/services/panorama/application_instances/index.md b/website/docs/services/panorama/application_instances/index.md new file mode 100644 index 0000000..76e39e7 --- /dev/null +++ b/website/docs/services/panorama/application_instances/index.md @@ -0,0 +1,305 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application_instance resource or lists application_instances in a region + +## Overview + + + + + + + +
Nameapplication_instances
TypeResource
DescriptionCreates an application instance and deploys it to a device.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe device's ID.
stringA description for the application instance.
stringThe ID of an application instance to replace with the new instance.
integer
string
objectSetting overrides for the application manifest.
integer
stringThe ARN of a runtime role for the application instance.
stringA name for the application instance.
string
string
objectThe application's manifest document.
string
arrayTags for the application instance.
stringAWS region.
+ +For more information, see AWS::Panorama::ApplicationInstance. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all application_instances in a region. +```sql +SELECT +region, +default_runtime_context_device_name, +status, +default_runtime_context_device, +description, +application_instance_id_to_replace, +created_time, +health_status, +manifest_overrides_payload, +last_updated_time, +runtime_role_arn, +name, +application_instance_id, +status_description, +manifest_payload, +arn, +tags +FROM aws.panorama.application_instances +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application_instance. +```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_instances +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.panorama.application_instances ( + DefaultRuntimeContextDevice, + ManifestPayload, + region +) +SELECT +'{{ DefaultRuntimeContextDevice }}', + '{{ ManifestPayload }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.panorama.application_instances ( + DefaultRuntimeContextDevice, + Description, + ApplicationInstanceIdToReplace, + ManifestOverridesPayload, + RuntimeRoleArn, + Name, + ManifestPayload, + Tags, + region +) +SELECT + '{{ DefaultRuntimeContextDevice }}', + '{{ Description }}', + '{{ ApplicationInstanceIdToReplace }}', + '{{ ManifestOverridesPayload }}', + '{{ RuntimeRoleArn }}', + '{{ Name }}', + '{{ ManifestPayload }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application_instance + props: + - name: DefaultRuntimeContextDevice + value: '{{ DefaultRuntimeContextDevice }}' + - name: Description + value: '{{ Description }}' + - name: ApplicationInstanceIdToReplace + value: '{{ ApplicationInstanceIdToReplace }}' + - name: ManifestOverridesPayload + value: + PayloadData: '{{ PayloadData }}' + - name: RuntimeRoleArn + value: '{{ RuntimeRoleArn }}' + - name: Name + value: '{{ Name }}' + - name: ManifestPayload + value: + PayloadData: '{{ PayloadData }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.panorama.application_instances +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the application_instances resource, the following permissions are required: + +### Read +```json +panorama:DescribeApplicationInstance, +panorama:DescribeApplicationInstanceDetails, +panorama:ListTagsForResource, +s3:ListObjects, +s3:GetObject, +s3:GetObjectVersion +``` + +### Create +```json +panorama:CreateApplicationInstance, +panorama:ListTagsForResource, +panorama:TagResource, +panorama:DescribeApplicationInstance, +panorama:DescribeApplicationInstanceDetails, +iam:PassRole, +s3:ListBucket, +s3:PutObject, +s3:GetObject, +s3:GetObjectVersion +``` + +### Update +```json +panorama:ListTagsForResource, +panorama:TagResource, +panorama:UntagResource, +panorama:DescribeApplicationInstance, +panorama:DescribeApplicationInstanceDetails, +s3:ListObjects, +s3:GetObject, +s3:GetObjectVersion +``` + +### List +```json +panorama:ListApplicationInstances, +s3:ListBucket, +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/website/docs/services/panorama/application_instances_list_only/index.md b/website/docs/services/panorama/application_instances_list_only/index.md new file mode 100644 index 0000000..575c18a --- /dev/null +++ b/website/docs/services/panorama/application_instances_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: application_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - application_instances_list_only + - panorama + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists application_instances in a region or regions, for all properties use application_instances + +## Overview + + + + + + + +
Nameapplication_instances_list_only
TypeResource
DescriptionCreates an application instance and deploys it to a device.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all application_instances in a region. +```sql +SELECT +region, +application_instance_id +FROM aws.panorama.application_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_instances_list_only resource, see application_instances + diff --git a/website/docs/services/panorama/index.md b/website/docs/services/panorama/index.md new file mode 100644 index 0000000..90154ea --- /dev/null +++ b/website/docs/services/panorama/index.md @@ -0,0 +1,42 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The panorama service documentation. + +:::info Service Summary + +
+
+total resources: 7
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/panorama/package_tags/index.md b/website/docs/services/panorama/package_tags/index.md new file mode 100644 index 0000000..8c81ef7 --- /dev/null +++ b/website/docs/services/panorama/package_tags/index.md @@ -0,0 +1,85 @@ +--- +title: package_tags +hide_title: false +hide_table_of_contents: false +keywords: + - package_tags + - panorama + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for packages in a region + +## Overview + + + + + + + +
Namepackage_tags
TypeResource
DescriptionCreates a package and storage location in an Amazon S3 access point.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA name for the package.
string
string
objectA storage location.
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all packages in a region. +```sql +SELECT +region, +package_name, +package_id, +arn, +storage_location, +created_time, +tag_key, +tag_value +FROM aws.panorama.package_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the package_tags resource, see packages + diff --git a/website/docs/services/panorama/package_versions/index.md b/website/docs/services/panorama/package_versions/index.md new file mode 100644 index 0000000..d61bcef --- /dev/null +++ b/website/docs/services/panorama/package_versions/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a package_version resource or lists package_versions in a region + +## Overview + + + + + + + +
Namepackage_versions
TypeResource
DescriptionRegisters a package version.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAn owner account.
stringA package ID.
string
stringA package version.
stringA patch version.
booleanWhether to mark the new version as the latest version.
boolean
string
string
string
integer
stringIf the version was marked latest, the new version to maker as latest.
stringAWS region.
+ +For more information, see AWS::Panorama::PackageVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual package_version. +```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_versions +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new package_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.panorama.package_versions ( + PackageId, + PackageVersion, + PatchVersion, + region +) +SELECT +'{{ PackageId }}', + '{{ PackageVersion }}', + '{{ PatchVersion }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.panorama.package_versions ( + OwnerAccount, + PackageId, + PackageVersion, + PatchVersion, + MarkLatest, + UpdatedLatestPatchVersion, + region +) +SELECT + '{{ OwnerAccount }}', + '{{ PackageId }}', + '{{ PackageVersion }}', + '{{ PatchVersion }}', + '{{ MarkLatest }}', + '{{ UpdatedLatestPatchVersion }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: package_version + props: + - name: OwnerAccount + value: '{{ OwnerAccount }}' + - name: PackageId + value: '{{ PackageId }}' + - name: PackageVersion + value: '{{ PackageVersion }}' + - name: PatchVersion + value: '{{ PatchVersion }}' + - name: MarkLatest + value: '{{ MarkLatest }}' + - name: UpdatedLatestPatchVersion + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.panorama.package_versions +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/panorama/packages/index.md b/website/docs/services/panorama/packages/index.md new file mode 100644 index 0000000..06d53bc --- /dev/null +++ b/website/docs/services/panorama/packages/index.md @@ -0,0 +1,254 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a package resource or lists packages in a region + +## Overview + + + + + + + +
Namepackages
TypeResource
DescriptionCreates a package and storage location in an Amazon S3 access point.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA name for the package.
string
string
objectA storage location.
integer
arrayTags for the package.
stringAWS region.
+ +For more information, see AWS::Panorama::Package. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all packages in a region. +```sql +SELECT +region, +package_name, +package_id, +arn, +storage_location, +created_time, +tags +FROM aws.panorama.packages +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual package. +```sql +SELECT +region, +package_name, +package_id, +arn, +storage_location, +created_time, +tags +FROM aws.panorama.packages +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new package resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.panorama.packages ( + PackageName, + region +) +SELECT +'{{ PackageName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.panorama.packages ( + PackageName, + StorageLocation, + Tags, + region +) +SELECT + '{{ PackageName }}', + '{{ StorageLocation }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: package + props: + - name: PackageName + value: '{{ PackageName }}' + - name: StorageLocation + value: + Bucket: '{{ Bucket }}' + RepoPrefixLocation: '{{ RepoPrefixLocation }}' + GeneratedPrefixLocation: '{{ GeneratedPrefixLocation }}' + BinaryPrefixLocation: '{{ BinaryPrefixLocation }}' + ManifestPrefixLocation: '{{ ManifestPrefixLocation }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.panorama.packages +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +panorama:ListPackages, +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/website/docs/services/panorama/packages_list_only/index.md b/website/docs/services/panorama/packages_list_only/index.md new file mode 100644 index 0000000..c2b8f7e --- /dev/null +++ b/website/docs/services/panorama/packages_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: packages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - packages_list_only + - panorama + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists packages in a region or regions, for all properties use packages + +## Overview + + + + + + + +
Namepackages_list_only
TypeResource
DescriptionCreates a package and storage location in an Amazon S3 access point.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all packages in a region. +```sql +SELECT +region, +package_id +FROM aws.panorama.packages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the packages_list_only resource, see packages + diff --git a/website/docs/services/paymentcryptography/aliases/index.md b/website/docs/services/paymentcryptography/aliases/index.md new file mode 100644 index 0000000..875a4e8 --- /dev/null +++ b/website/docs/services/paymentcryptography/aliases/index.md @@ -0,0 +1,201 @@ +--- +title: aliases +hide_title: false +hide_table_of_contents: false +keywords: + - aliases + - paymentcryptography + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an alias resource or lists aliases in a region + +## Overview + + + + + + + +
Namealiases
TypeResource
DescriptionDefinition of AWS::PaymentCryptography::Alias Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +For more information, see AWS::PaymentCryptography::Alias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all aliases in a region. +```sql +SELECT +region, +alias_name, +key_arn +FROM aws.paymentcryptography.aliases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual alias. +```sql +SELECT +region, +alias_name, +key_arn +FROM aws.paymentcryptography.aliases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.paymentcryptography.aliases ( + AliasName, + region +) +SELECT +'{{ AliasName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.paymentcryptography.aliases ( + AliasName, + KeyArn, + region +) +SELECT + '{{ AliasName }}', + '{{ KeyArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: alias + props: + - name: AliasName + value: '{{ AliasName }}' + - name: KeyArn + value: '{{ KeyArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.paymentcryptography.aliases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the aliases resource, the following permissions are required: + +### Create +```json +payment-cryptography:CreateAlias +``` + +### Read +```json +payment-cryptography:GetAlias +``` + +### Update +```json +payment-cryptography:UpdateAlias +``` + +### Delete +```json +payment-cryptography:DeleteAlias +``` + +### List +```json +payment-cryptography:ListAliases +``` diff --git a/website/docs/services/paymentcryptography/aliases_list_only/index.md b/website/docs/services/paymentcryptography/aliases_list_only/index.md new file mode 100644 index 0000000..ec85d25 --- /dev/null +++ b/website/docs/services/paymentcryptography/aliases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - aliases_list_only + - paymentcryptography + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists aliases in a region or regions, for all properties use aliases + +## Overview + + + + + + + +
Namealiases_list_only
TypeResource
DescriptionDefinition of AWS::PaymentCryptography::Alias Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all aliases in a region. +```sql +SELECT +region, +alias_name +FROM aws.paymentcryptography.aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the aliases_list_only resource, see aliases + diff --git a/website/docs/services/paymentcryptography/index.md b/website/docs/services/paymentcryptography/index.md new file mode 100644 index 0000000..bbdecd4 --- /dev/null +++ b/website/docs/services/paymentcryptography/index.md @@ -0,0 +1,40 @@ +--- +title: paymentcryptography +hide_title: false +hide_table_of_contents: false +keywords: + - paymentcryptography + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The paymentcryptography service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/paymentcryptography/key_tags/index.md b/website/docs/services/paymentcryptography/key_tags/index.md new file mode 100644 index 0000000..4ec7bf4 --- /dev/null +++ b/website/docs/services/paymentcryptography/key_tags/index.md @@ -0,0 +1,89 @@ +--- +title: key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - key_tags + - paymentcryptography + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for keys in a region + +## Overview + + + + + + + +
Namekey_tags
TypeResource
DescriptionDefinition of AWS::PaymentCryptography::Key Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
boolean
object
string
string
stringDefines the source of a key
stringDefines the state of a key
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all keys in a region. +```sql +SELECT +region, +enabled, +exportable, +key_attributes, +key_check_value_algorithm, +key_identifier, +key_origin, +key_state, +tag_key, +tag_value +FROM aws.paymentcryptography.key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the key_tags resource, see keys + diff --git a/website/docs/services/paymentcryptography/keys/index.md b/website/docs/services/paymentcryptography/keys/index.md new file mode 100644 index 0000000..4c2916d --- /dev/null +++ b/website/docs/services/paymentcryptography/keys/index.md @@ -0,0 +1,257 @@ +--- +title: keys +hide_title: false +hide_table_of_contents: false +keywords: + - keys + - paymentcryptography + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a key resource or lists keys in a region + +## Overview + + + + + + + +
Namekeys
TypeResource
DescriptionDefinition of AWS::PaymentCryptography::Key Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
boolean
boolean
object
string
string
stringDefines the source of a key
stringDefines the state of a key
array
stringAWS region.
+ +For more information, see AWS::PaymentCryptography::Key. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all keys in a region. +```sql +SELECT +region, +enabled, +exportable, +key_attributes, +key_check_value_algorithm, +key_identifier, +key_origin, +key_state, +tags +FROM aws.paymentcryptography.keys +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual key. +```sql +SELECT +region, +enabled, +exportable, +key_attributes, +key_check_value_algorithm, +key_identifier, +key_origin, +key_state, +tags +FROM aws.paymentcryptography.keys +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.paymentcryptography.keys ( + Exportable, + KeyAttributes, + region +) +SELECT +'{{ Exportable }}', + '{{ KeyAttributes }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.paymentcryptography.keys ( + Enabled, + Exportable, + KeyAttributes, + KeyCheckValueAlgorithm, + Tags, + region +) +SELECT + '{{ Enabled }}', + '{{ Exportable }}', + '{{ KeyAttributes }}', + '{{ KeyCheckValueAlgorithm }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: key + props: + - name: Enabled + value: '{{ Enabled }}' + - name: Exportable + value: '{{ Exportable }}' + - name: KeyAttributes + value: + KeyUsage: '{{ KeyUsage }}' + KeyClass: '{{ KeyClass }}' + KeyAlgorithm: '{{ KeyAlgorithm }}' + KeyModesOfUse: + Encrypt: '{{ Encrypt }}' + Decrypt: '{{ Decrypt }}' + Wrap: '{{ Wrap }}' + Unwrap: '{{ Unwrap }}' + Generate: '{{ Generate }}' + Sign: '{{ Sign }}' + Verify: '{{ Verify }}' + DeriveKey: '{{ DeriveKey }}' + NoRestrictions: '{{ NoRestrictions }}' + - name: KeyCheckValueAlgorithm + value: '{{ KeyCheckValueAlgorithm }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.paymentcryptography.keys +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the keys resource, the following permissions are required: + +### Create +```json +payment-cryptography:GetKey, +payment-cryptography:CreateKey, +payment-cryptography:TagResource +``` + +### Read +```json +payment-cryptography:GetKey, +payment-cryptography:ListTagsForResource +``` + +### Update +```json +payment-cryptography:GetKey, +payment-cryptography:ListTagsForResource, +payment-cryptography:TagResource, +payment-cryptography:UntagResource, +payment-cryptography:StartKeyUsage, +payment-cryptography:StopKeyUsage +``` + +### Delete +```json +payment-cryptography:GetKey, +payment-cryptography:DeleteKey +``` + +### List +```json +payment-cryptography:ListKeys +``` diff --git a/website/docs/services/paymentcryptography/keys_list_only/index.md b/website/docs/services/paymentcryptography/keys_list_only/index.md new file mode 100644 index 0000000..216b525 --- /dev/null +++ b/website/docs/services/paymentcryptography/keys_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - keys_list_only + - paymentcryptography + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists keys in a region or regions, for all properties use keys + +## Overview + + + + + + + +
Namekeys_list_only
TypeResource
DescriptionDefinition of AWS::PaymentCryptography::Key Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all keys in a region. +```sql +SELECT +region, +key_identifier +FROM aws.paymentcryptography.keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the keys_list_only resource, see keys + diff --git a/website/docs/services/pcaconnectorad/connector_tags/index.md b/website/docs/services/pcaconnectorad/connector_tags/index.md new file mode 100644 index 0000000..2e0cbef --- /dev/null +++ b/website/docs/services/pcaconnectorad/connector_tags/index.md @@ -0,0 +1,83 @@ +--- +title: connector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connector_tags + - pcaconnectorad + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connectors in a region + +## Overview + + + + + + + +
Nameconnector_tags
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::Connector Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connectors in a region. +```sql +SELECT +region, +certificate_authority_arn, +connector_arn, +directory_id, +vpc_information, +tag_key, +tag_value +FROM aws.pcaconnectorad.connector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connector_tags resource, see connectors + diff --git a/website/docs/services/pcaconnectorad/connectors/index.md b/website/docs/services/pcaconnectorad/connectors/index.md new file mode 100644 index 0000000..60aa1fb --- /dev/null +++ b/website/docs/services/pcaconnectorad/connectors/index.md @@ -0,0 +1,241 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connector resource or lists connectors in a region + +## Overview + + + + + + + +
Nameconnectors
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::Connector Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
object
stringAWS region.
+ +For more information, see AWS::PCAConnectorAD::Connector. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connectors in a region. +```sql +SELECT +region, +certificate_authority_arn, +connector_arn, +directory_id, +tags, +vpc_information +FROM aws.pcaconnectorad.connectors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connector. +```sql +SELECT +region, +certificate_authority_arn, +connector_arn, +directory_id, +tags, +vpc_information +FROM aws.pcaconnectorad.connectors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorad.connectors ( + CertificateAuthorityArn, + DirectoryId, + VpcInformation, + region +) +SELECT +'{{ CertificateAuthorityArn }}', + '{{ DirectoryId }}', + '{{ VpcInformation }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorad.connectors ( + CertificateAuthorityArn, + DirectoryId, + Tags, + VpcInformation, + region +) +SELECT + '{{ CertificateAuthorityArn }}', + '{{ DirectoryId }}', + '{{ Tags }}', + '{{ VpcInformation }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connector + props: + - name: CertificateAuthorityArn + value: '{{ CertificateAuthorityArn }}' + - name: DirectoryId + value: '{{ DirectoryId }}' + - name: Tags + value: {} + - name: VpcInformation + value: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pcaconnectorad.connectors +WHERE data__Identifier = '' +AND 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, +pca-connector-ad:TagResource +``` + +### Read +```json +pca-connector-ad:ListTagsForResource, +pca-connector-ad:GetConnector +``` + +### Delete +```json +ec2:DeleteVpcEndpoints, +ec2:DescribeVpcEndpoints, +pca-connector-ad:GetConnector, +pca-connector-ad:DeleteConnector, +pca-connector-ad:UntagResource +``` + +### List +```json +pca-connector-ad:ListConnectors +``` + +### Update +```json +pca-connector-ad:ListTagsForResource, +pca-connector-ad:TagResource, +pca-connector-ad:UntagResource +``` diff --git a/website/docs/services/pcaconnectorad/connectors_list_only/index.md b/website/docs/services/pcaconnectorad/connectors_list_only/index.md new file mode 100644 index 0000000..687943a --- /dev/null +++ b/website/docs/services/pcaconnectorad/connectors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connectors_list_only + - pcaconnectorad + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connectors in a region or regions, for all properties use connectors + +## Overview + + + + + + + +
Nameconnectors_list_only
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::Connector Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connectors in a region. +```sql +SELECT +region, +connector_arn +FROM aws.pcaconnectorad.connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connectors_list_only resource, see connectors + diff --git a/website/docs/services/pcaconnectorad/directory_registration_tags/index.md b/website/docs/services/pcaconnectorad/directory_registration_tags/index.md new file mode 100644 index 0000000..68ac1ab --- /dev/null +++ b/website/docs/services/pcaconnectorad/directory_registration_tags/index.md @@ -0,0 +1,79 @@ +--- +title: directory_registration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - directory_registration_tags + - pcaconnectorad + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for directory_registrations in a region + +## Overview + + + + + + + +
Namedirectory_registration_tags
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all directory_registrations in a region. +```sql +SELECT +region, +directory_id, +directory_registration_arn, +tag_key, +tag_value +FROM aws.pcaconnectorad.directory_registration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the directory_registration_tags resource, see directory_registrations + diff --git a/website/docs/services/pcaconnectorad/directory_registrations/index.md b/website/docs/services/pcaconnectorad/directory_registrations/index.md new file mode 100644 index 0000000..4a6011a --- /dev/null +++ b/website/docs/services/pcaconnectorad/directory_registrations/index.md @@ -0,0 +1,216 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a directory_registration resource or lists directory_registrations in a region + +## Overview + + + + + + + +
Namedirectory_registrations
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
object
stringAWS region.
+ +For more information, see AWS::PCAConnectorAD::DirectoryRegistration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all directory_registrations in a region. +```sql +SELECT +region, +directory_id, +directory_registration_arn, +tags +FROM aws.pcaconnectorad.directory_registrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual directory_registration. +```sql +SELECT +region, +directory_id, +directory_registration_arn, +tags +FROM aws.pcaconnectorad.directory_registrations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new directory_registration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorad.directory_registrations ( + DirectoryId, + region +) +SELECT +'{{ DirectoryId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorad.directory_registrations ( + DirectoryId, + Tags, + region +) +SELECT + '{{ DirectoryId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: directory_registration + props: + - name: DirectoryId + value: '{{ DirectoryId }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pcaconnectorad.directory_registrations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the directory_registrations resource, the following permissions are required: + +### Create +```json +ds:AuthorizeApplication, +ds:DescribeDirectories, +pca-connector-ad:GetDirectoryRegistration, +pca-connector-ad:CreateDirectoryRegistration, +pca-connector-ad:TagResource +``` + +### Read +```json +pca-connector-ad:GetDirectoryRegistration, +pca-connector-ad:ListTagsForResource +``` + +### Delete +```json +ds:DescribeDirectories, +ds:UnauthorizeApplication, +ds:UpdateAuthorizedApplication, +pca-connector-ad:GetDirectoryRegistration, +pca-connector-ad:DeleteDirectoryRegistration, +pca-connector-ad:UntagResource +``` + +### List +```json +pca-connector-ad:ListDirectoryRegistrations +``` + +### Update +```json +pca-connector-ad:ListTagsForResource, +pca-connector-ad:TagResource, +pca-connector-ad:UntagResource +``` diff --git a/website/docs/services/pcaconnectorad/directory_registrations_list_only/index.md b/website/docs/services/pcaconnectorad/directory_registrations_list_only/index.md new file mode 100644 index 0000000..0ee8172 --- /dev/null +++ b/website/docs/services/pcaconnectorad/directory_registrations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: directory_registrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - directory_registrations_list_only + - pcaconnectorad + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists directory_registrations in a region or regions, for all properties use directory_registrations + +## Overview + + + + + + + +
Namedirectory_registrations_list_only
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all directory_registrations in a region. +```sql +SELECT +region, +directory_registration_arn +FROM aws.pcaconnectorad.directory_registrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the directory_registrations_list_only resource, see directory_registrations + diff --git a/website/docs/services/pcaconnectorad/index.md b/website/docs/services/pcaconnectorad/index.md new file mode 100644 index 0000000..4552ae5 --- /dev/null +++ b/website/docs/services/pcaconnectorad/index.md @@ -0,0 +1,48 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The pcaconnectorad service documentation. + +:::info Service Summary + +
+
+total resources: 13
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/pcaconnectorad/service_principal_names/index.md b/website/docs/services/pcaconnectorad/service_principal_names/index.md new file mode 100644 index 0000000..3e60ee5 --- /dev/null +++ b/website/docs/services/pcaconnectorad/service_principal_names/index.md @@ -0,0 +1,197 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_principal_name resource or lists service_principal_names in a region + +## Overview + + + + + + + +
Nameservice_principal_names
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +For more information, see AWS::PCAConnectorAD::ServicePrincipalName. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all service_principal_names in a region. +```sql +SELECT +region, +connector_arn, +directory_registration_arn +FROM aws.pcaconnectorad.service_principal_names +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service_principal_name. +```sql +SELECT +region, +connector_arn, +directory_registration_arn +FROM aws.pcaconnectorad.service_principal_names +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_principal_name resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorad.service_principal_names ( + ConnectorArn, + DirectoryRegistrationArn, + region +) +SELECT +'{{ ConnectorArn }}', + '{{ DirectoryRegistrationArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorad.service_principal_names ( + ConnectorArn, + DirectoryRegistrationArn, + region +) +SELECT + '{{ ConnectorArn }}', + '{{ DirectoryRegistrationArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_principal_name + props: + - name: ConnectorArn + value: '{{ ConnectorArn }}' + - name: DirectoryRegistrationArn + value: '{{ DirectoryRegistrationArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pcaconnectorad.service_principal_names +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +pca-connector-ad:GetServicePrincipalName +``` + +### Delete +```json +ds:UpdateAuthorizedApplication, +pca-connector-ad:GetServicePrincipalName, +pca-connector-ad:DeleteServicePrincipalName +``` + +### List +```json +pca-connector-ad:ListServicePrincipalNames +``` diff --git a/website/docs/services/pcaconnectorad/service_principal_names_list_only/index.md b/website/docs/services/pcaconnectorad/service_principal_names_list_only/index.md new file mode 100644 index 0000000..fab099c --- /dev/null +++ b/website/docs/services/pcaconnectorad/service_principal_names_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: service_principal_names_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_principal_names_list_only + - pcaconnectorad + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_principal_names in a region or regions, for all properties use service_principal_names + +## Overview + + + + + + + +
Nameservice_principal_names_list_only
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_principal_names in a region. +```sql +SELECT +region, +connector_arn, +directory_registration_arn +FROM aws.pcaconnectorad.service_principal_names_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_principal_names_list_only resource, see service_principal_names + diff --git a/website/docs/services/pcaconnectorad/template_group_access_control_entries/index.md b/website/docs/services/pcaconnectorad/template_group_access_control_entries/index.md new file mode 100644 index 0000000..4b4cb9e --- /dev/null +++ b/website/docs/services/pcaconnectorad/template_group_access_control_entries/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a template_group_access_control_entry resource or lists template_group_access_control_entries in a region + +## Overview + + + + + + + +
Nametemplate_group_access_control_entries
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
object
string
string
string
stringAWS region.
+ +For more information, see AWS::PCAConnectorAD::TemplateGroupAccessControlEntry. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all template_group_access_control_entries in a region. +```sql +SELECT +region, +access_rights, +group_display_name, +group_security_identifier, +template_arn +FROM aws.pcaconnectorad.template_group_access_control_entries +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual template_group_access_control_entry. +```sql +SELECT +region, +access_rights, +group_display_name, +group_security_identifier, +template_arn +FROM aws.pcaconnectorad.template_group_access_control_entries +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new template_group_access_control_entry resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorad.template_group_access_control_entries ( + AccessRights, + GroupDisplayName, + region +) +SELECT +'{{ AccessRights }}', + '{{ GroupDisplayName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorad.template_group_access_control_entries ( + AccessRights, + GroupDisplayName, + GroupSecurityIdentifier, + TemplateArn, + region +) +SELECT + '{{ AccessRights }}', + '{{ GroupDisplayName }}', + '{{ GroupSecurityIdentifier }}', + '{{ TemplateArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: template_group_access_control_entry + props: + - name: AccessRights + value: + Enroll: '{{ Enroll }}' + AutoEnroll: null + - name: GroupDisplayName + value: '{{ GroupDisplayName }}' + - name: GroupSecurityIdentifier + value: '{{ GroupSecurityIdentifier }}' + - name: TemplateArn + value: '{{ TemplateArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pcaconnectorad.template_group_access_control_entries +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +pca-connector-ad:GetTemplateGroupAccessControlEntry +``` + +### Update +```json +pca-connector-ad:UpdateTemplateGroupAccessControlEntry +``` + +### Delete +```json +pca-connector-ad:DeleteTemplateGroupAccessControlEntry, +pca-connector-ad:GetTemplateGroupAccessControlEntry +``` + +### List +```json +pca-connector-ad:ListTemplateGroupAccessControlEntries +``` diff --git a/website/docs/services/pcaconnectorad/template_group_access_control_entries_list_only/index.md b/website/docs/services/pcaconnectorad/template_group_access_control_entries_list_only/index.md new file mode 100644 index 0000000..4de708b --- /dev/null +++ b/website/docs/services/pcaconnectorad/template_group_access_control_entries_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: template_group_access_control_entries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - template_group_access_control_entries_list_only + - pcaconnectorad + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists template_group_access_control_entries in a region or regions, for all properties use template_group_access_control_entries + +## Overview + + + + + + + +
Nametemplate_group_access_control_entries_list_only
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all template_group_access_control_entries in a region. +```sql +SELECT +region, +group_security_identifier, +template_arn +FROM aws.pcaconnectorad.template_group_access_control_entries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the template_group_access_control_entries_list_only resource, see template_group_access_control_entries + diff --git a/website/docs/services/pcaconnectorad/template_tags/index.md b/website/docs/services/pcaconnectorad/template_tags/index.md new file mode 100644 index 0000000..294a33a --- /dev/null +++ b/website/docs/services/pcaconnectorad/template_tags/index.md @@ -0,0 +1,85 @@ +--- +title: template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - template_tags + - pcaconnectorad + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for templates in a region + +## Overview + + + + + + + +
Nametemplate_tags
TypeResource
DescriptionRepresents a template that defines certificate configurations, both for issuance and client handling
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
boolean
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all templates in a region. +```sql +SELECT +region, +connector_arn, +definition, +name, +reenroll_all_certificate_holders, +template_arn, +tag_key, +tag_value +FROM aws.pcaconnectorad.template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the template_tags resource, see templates + diff --git a/website/docs/services/pcaconnectorad/templates/index.md b/website/docs/services/pcaconnectorad/templates/index.md new file mode 100644 index 0000000..88b0e7f --- /dev/null +++ b/website/docs/services/pcaconnectorad/templates/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a template resource or lists templates in a region + +## Overview + + + + + + + +
Nametemplates
TypeResource
DescriptionRepresents a template that defines certificate configurations, both for issuance and client handling
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
boolean
object
string
stringAWS region.
+ +For more information, see AWS::PCAConnectorAD::Template. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all templates in a region. +```sql +SELECT +region, +connector_arn, +definition, +name, +reenroll_all_certificate_holders, +tags, +template_arn +FROM aws.pcaconnectorad.templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual template. +```sql +SELECT +region, +connector_arn, +definition, +name, +reenroll_all_certificate_holders, +tags, +template_arn +FROM aws.pcaconnectorad.templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorad.templates ( + ConnectorArn, + Definition, + Name, + region +) +SELECT +'{{ ConnectorArn }}', + '{{ Definition }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorad.templates ( + ConnectorArn, + Definition, + Name, + ReenrollAllCertificateHolders, + Tags, + region +) +SELECT + '{{ ConnectorArn }}', + '{{ Definition }}', + '{{ Name }}', + '{{ ReenrollAllCertificateHolders }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: template + props: + - name: ConnectorArn + value: '{{ ConnectorArn }}' + - name: Definition + value: null + - name: Name + value: '{{ Name }}' + - name: ReenrollAllCertificateHolders + value: '{{ ReenrollAllCertificateHolders }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pcaconnectorad.templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the templates resource, the following permissions are required: + +### Create +```json +pca-connector-ad:CreateTemplate, +pca-connector-ad:TagResource +``` + +### 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, +pca-connector-ad:UntagResource +``` + +### List +```json +pca-connector-ad:ListTemplates +``` diff --git a/website/docs/services/pcaconnectorad/templates_list_only/index.md b/website/docs/services/pcaconnectorad/templates_list_only/index.md new file mode 100644 index 0000000..c2700f2 --- /dev/null +++ b/website/docs/services/pcaconnectorad/templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - templates_list_only + - pcaconnectorad + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists templates in a region or regions, for all properties use templates + +## Overview + + + + + + + +
Nametemplates_list_only
TypeResource
DescriptionRepresents a template that defines certificate configurations, both for issuance and client handling
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all templates in a region. +```sql +SELECT +region, +template_arn +FROM aws.pcaconnectorad.templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the templates_list_only resource, see templates + diff --git a/website/docs/services/pcaconnectorscep/challenge_tags/index.md b/website/docs/services/pcaconnectorscep/challenge_tags/index.md new file mode 100644 index 0000000..ff2a169 --- /dev/null +++ b/website/docs/services/pcaconnectorscep/challenge_tags/index.md @@ -0,0 +1,79 @@ +--- +title: challenge_tags +hide_title: false +hide_table_of_contents: false +keywords: + - challenge_tags + - pcaconnectorscep + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for challenges in a region + +## Overview + + + + + + + +
Namechallenge_tags
TypeResource
DescriptionRepresents a SCEP Challenge that is used for certificate enrollment
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all challenges in a region. +```sql +SELECT +region, +challenge_arn, +connector_arn, +tag_key, +tag_value +FROM aws.pcaconnectorscep.challenge_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the challenge_tags resource, see challenges + diff --git a/website/docs/services/pcaconnectorscep/challenges/index.md b/website/docs/services/pcaconnectorscep/challenges/index.md new file mode 100644 index 0000000..7c3fa90 --- /dev/null +++ b/website/docs/services/pcaconnectorscep/challenges/index.md @@ -0,0 +1,210 @@ +--- +title: challenges +hide_title: false +hide_table_of_contents: false +keywords: + - challenges + - pcaconnectorscep + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a challenge resource or lists challenges in a region + +## Overview + + + + + + + +
Namechallenges
TypeResource
DescriptionRepresents a SCEP Challenge that is used for certificate enrollment
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
object
stringAWS region.
+ +For more information, see AWS::PCAConnectorSCEP::Challenge. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all challenges in a region. +```sql +SELECT +region, +challenge_arn, +connector_arn, +tags +FROM aws.pcaconnectorscep.challenges +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual challenge. +```sql +SELECT +region, +challenge_arn, +connector_arn, +tags +FROM aws.pcaconnectorscep.challenges +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new challenge resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorscep.challenges ( + ConnectorArn, + region +) +SELECT +'{{ ConnectorArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorscep.challenges ( + ConnectorArn, + Tags, + region +) +SELECT + '{{ ConnectorArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: challenge + props: + - name: ConnectorArn + value: '{{ ConnectorArn }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pcaconnectorscep.challenges +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the challenges resource, the following permissions are required: + +### Create +```json +pca-connector-scep:CreateChallenge, +pca-connector-scep:TagResource +``` + +### Read +```json +pca-connector-scep:ListTagsForResource, +pca-connector-scep:GetChallengeMetadata +``` + +### Delete +```json +pca-connector-scep:GetChallengeMetadata, +pca-connector-scep:DeleteChallenge, +pca-connector-scep:UntagResource +``` + +### List +```json +pca-connector-scep:ListChallengeMetadata +``` + +### Update +```json +pca-connector-scep:ListTagsForResource, +pca-connector-scep:TagResource, +pca-connector-scep:UntagResource +``` diff --git a/website/docs/services/pcaconnectorscep/challenges_list_only/index.md b/website/docs/services/pcaconnectorscep/challenges_list_only/index.md new file mode 100644 index 0000000..2725078 --- /dev/null +++ b/website/docs/services/pcaconnectorscep/challenges_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: challenges_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - challenges_list_only + - pcaconnectorscep + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists challenges in a region or regions, for all properties use challenges + +## Overview + + + + + + + +
Namechallenges_list_only
TypeResource
DescriptionRepresents a SCEP Challenge that is used for certificate enrollment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all challenges in a region. +```sql +SELECT +region, +challenge_arn +FROM aws.pcaconnectorscep.challenges_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the challenges_list_only resource, see challenges + diff --git a/website/docs/services/pcaconnectorscep/connector_tags/index.md b/website/docs/services/pcaconnectorscep/connector_tags/index.md new file mode 100644 index 0000000..b8ead29 --- /dev/null +++ b/website/docs/services/pcaconnectorscep/connector_tags/index.md @@ -0,0 +1,87 @@ +--- +title: connector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connector_tags + - pcaconnectorscep + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connectors in a region + +## Overview + + + + + + + +
Nameconnector_tags
TypeResource
DescriptionRepresents a Connector that allows certificate issuance through Simple Certificate Enrollment Protocol (SCEP)
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connectors in a region. +```sql +SELECT +region, +certificate_authority_arn, +connector_arn, +type, +endpoint, +mobile_device_management, +open_id_configuration, +tag_key, +tag_value +FROM aws.pcaconnectorscep.connector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connector_tags resource, see connectors + diff --git a/website/docs/services/pcaconnectorscep/connectors/index.md b/website/docs/services/pcaconnectorscep/connectors/index.md new file mode 100644 index 0000000..e4a8705 --- /dev/null +++ b/website/docs/services/pcaconnectorscep/connectors/index.md @@ -0,0 +1,235 @@ +--- +title: connectors +hide_title: false +hide_table_of_contents: false +keywords: + - connectors + - pcaconnectorscep + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connector resource or lists connectors in a region + +## Overview + + + + + + + +
Nameconnectors
TypeResource
DescriptionRepresents a Connector that allows certificate issuance through Simple Certificate Enrollment Protocol (SCEP)
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
object
stringAWS region.
+ +For more information, see AWS::PCAConnectorSCEP::Connector. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connectors in a region. +```sql +SELECT +region, +certificate_authority_arn, +connector_arn, +type, +endpoint, +mobile_device_management, +open_id_configuration, +tags +FROM aws.pcaconnectorscep.connectors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connector. +```sql +SELECT +region, +certificate_authority_arn, +connector_arn, +type, +endpoint, +mobile_device_management, +open_id_configuration, +tags +FROM aws.pcaconnectorscep.connectors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorscep.connectors ( + CertificateAuthorityArn, + region +) +SELECT +'{{ CertificateAuthorityArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pcaconnectorscep.connectors ( + CertificateAuthorityArn, + MobileDeviceManagement, + Tags, + region +) +SELECT + '{{ CertificateAuthorityArn }}', + '{{ MobileDeviceManagement }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connector + props: + - name: CertificateAuthorityArn + value: '{{ CertificateAuthorityArn }}' + - name: MobileDeviceManagement + value: {} + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pcaconnectorscep.connectors +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +```json +acm-pca:DescribeCertificateAuthority, +acm-pca:GetCertificate, +acm-pca:GetCertificateAuthorityCertificate, +acm-pca:IssueCertificate, +pca-connector-scep:GetConnector, +pca-connector-scep:CreateConnector, +pca-connector-scep:TagResource +``` + +### Read +```json +pca-connector-scep:ListTagsForResource, +pca-connector-scep:GetConnector +``` + +### Delete +```json +acm-pca:DescribeCertificateAuthority, +acm-pca:GetCertificate, +acm-pca:GetCertificateAuthorityCertificate, +acm-pca:IssueCertificate, +pca-connector-scep:GetConnector, +pca-connector-scep:DeleteConnector, +pca-connector-scep:UntagResource +``` + +### List +```json +pca-connector-scep:ListConnectors +``` + +### Update +```json +pca-connector-scep:ListTagsForResource, +pca-connector-scep:TagResource, +pca-connector-scep:UntagResource +``` diff --git a/website/docs/services/pcaconnectorscep/connectors_list_only/index.md b/website/docs/services/pcaconnectorscep/connectors_list_only/index.md new file mode 100644 index 0000000..c37ab68 --- /dev/null +++ b/website/docs/services/pcaconnectorscep/connectors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connectors_list_only + - pcaconnectorscep + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connectors in a region or regions, for all properties use connectors + +## Overview + + + + + + + +
Nameconnectors_list_only
TypeResource
DescriptionRepresents a Connector that allows certificate issuance through Simple Certificate Enrollment Protocol (SCEP)
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connectors in a region. +```sql +SELECT +region, +connector_arn +FROM aws.pcaconnectorscep.connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connectors_list_only resource, see connectors + diff --git a/website/docs/services/pcaconnectorscep/index.md b/website/docs/services/pcaconnectorscep/index.md new file mode 100644 index 0000000..0a5e47d --- /dev/null +++ b/website/docs/services/pcaconnectorscep/index.md @@ -0,0 +1,41 @@ +--- +title: pcaconnectorscep +hide_title: false +hide_table_of_contents: false +keywords: + - pcaconnectorscep + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The pcaconnectorscep service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/pcs/cluster_tags/index.md b/website/docs/services/pcs/cluster_tags/index.md new file mode 100644 index 0000000..1ade685 --- /dev/null +++ b/website/docs/services/pcs/cluster_tags/index.md @@ -0,0 +1,95 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - pcs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + + + +
Namecluster_tags
TypeResource
DescriptionAWS::PCS::Cluster resource creates an AWS PCS cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique Amazon Resource Name (ARN) of the cluster.
arrayThe list of endpoints available for interaction with the scheduler.
arrayThe list of errors that occurred during cluster provisioning.
stringThe generated unique ID of the cluster.
stringThe name that identifies the cluster.
objectThe networking configuration for the cluster's control plane.
objectThe cluster management and job scheduling software associated with the cluster.
stringThe size of the cluster.
objectAdditional options related to the Slurm scheduler.
stringThe provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +arn, +endpoints, +error_info, +id, +name, +networking, +scheduler, +size, +slurm_configuration, +status, +tag_key, +tag_value +FROM aws.pcs.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + diff --git a/website/docs/services/pcs/clusters/index.md b/website/docs/services/pcs/clusters/index.md new file mode 100644 index 0000000..4188f2c --- /dev/null +++ b/website/docs/services/pcs/clusters/index.md @@ -0,0 +1,277 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - clusters + - pcs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster resource or lists clusters in a region + +## Overview + + + + + + + +
Nameclusters
TypeResource
DescriptionAWS::PCS::Cluster resource creates an AWS PCS cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique Amazon Resource Name (ARN) of the cluster.
arrayThe list of endpoints available for interaction with the scheduler.
arrayThe list of errors that occurred during cluster provisioning.
stringThe generated unique ID of the cluster.
stringThe name that identifies the cluster.
objectThe networking configuration for the cluster's control plane.
objectThe cluster management and job scheduling software associated with the cluster.
stringThe size of the cluster.
objectAdditional options related to the Slurm scheduler.
stringThe provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
stringAWS region.
+ +For more information, see AWS::PCS::Cluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all clusters in a region. +```sql +SELECT +region, +arn, +endpoints, +error_info, +id, +name, +networking, +scheduler, +size, +slurm_configuration, +status, +tags +FROM aws.pcs.clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster. +```sql +SELECT +region, +arn, +endpoints, +error_info, +id, +name, +networking, +scheduler, +size, +slurm_configuration, +status, +tags +FROM aws.pcs.clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pcs.clusters ( + Networking, + Scheduler, + Size, + region +) +SELECT +'{{ Networking }}', + '{{ Scheduler }}', + '{{ Size }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pcs.clusters ( + Name, + Networking, + Scheduler, + Size, + SlurmConfiguration, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Networking }}', + '{{ Scheduler }}', + '{{ Size }}', + '{{ SlurmConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster + props: + - name: Name + value: '{{ Name }}' + - name: Networking + value: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + - name: Scheduler + value: + Type: '{{ Type }}' + Version: '{{ Version }}' + - name: Size + value: '{{ Size }}' + - name: SlurmConfiguration + value: + AuthKey: + SecretArn: '{{ SecretArn }}' + SecretVersion: '{{ SecretVersion }}' + ScaleDownIdleTimeInSeconds: '{{ ScaleDownIdleTimeInSeconds }}' + SlurmCustomSettings: + - ParameterName: '{{ ParameterName }}' + ParameterValue: '{{ ParameterValue }}' + - name: Tags + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pcs.clusters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +```json +ec2:CreateNetworkInterface, +ec2:DescribeVpcs, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +ec2:GetSecurityGroupsForVpc, +iam:CreateServiceLinkedRole, +secretsmanager:CreateSecret, +secretsmanager:TagResource, +pcs:CreateCluster, +pcs:GetCluster, +pcs:ListTagsForResource, +pcs:TagResource +``` + +### Read +```json +pcs:GetCluster, +pcs:ListTagsForResource +``` + +### Update +```json +pcs:GetCluster, +pcs:ListTagsForResource, +pcs:TagResource, +pcs:UntagResource +``` + +### Delete +```json +pcs:DeleteCluster, +pcs:GetCluster +``` + +### List +```json +pcs:ListClusters +``` diff --git a/website/docs/services/pcs/clusters_list_only/index.md b/website/docs/services/pcs/clusters_list_only/index.md new file mode 100644 index 0000000..7fcb7f9 --- /dev/null +++ b/website/docs/services/pcs/clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - pcs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + + + +
Nameclusters_list_only
TypeResource
DescriptionAWS::PCS::Cluster resource creates an AWS PCS cluster.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique Amazon Resource Name (ARN) of the cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +arn +FROM aws.pcs.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + diff --git a/website/docs/services/pcs/compute_node_group_tags/index.md b/website/docs/services/pcs/compute_node_group_tags/index.md new file mode 100644 index 0000000..4b5c0f4 --- /dev/null +++ b/website/docs/services/pcs/compute_node_group_tags/index.md @@ -0,0 +1,105 @@ +--- +title: compute_node_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - compute_node_group_tags + - pcs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for compute_node_groups in a region + +## Overview + + + + + + + +
Namecompute_node_group_tags
TypeResource
DescriptionAWS::PCS::ComputeNodeGroup resource creates an AWS PCS compute node group.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances. If not provided, AWS PCS uses the AMI ID specified in the custom launch template.
stringThe unique Amazon Resource Name (ARN) of the compute node group.
stringThe ID of the cluster of the compute node group.
objectAn Amazon EC2 launch template AWS PCS uses to launch compute nodes.
arrayThe list of errors that occurred during compute node group provisioning.
stringThe Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
stringThe generated unique ID of the compute node group.
arrayA list of EC2 instance configurations that AWS PCS can provision in the compute node group.
stringThe name that identifies the compute node group.
stringSpecifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
objectSpecifies the boundaries of the compute node group auto scaling.
objectAdditional options related to the Slurm scheduler.
objectAdditional configuration when you specify SPOT as the purchase option.
stringThe provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.
arrayThe list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all compute_node_groups in a region. +```sql +SELECT +region, +ami_id, +arn, +cluster_id, +custom_launch_template, +error_info, +iam_instance_profile_arn, +id, +instance_configs, +name, +purchase_option, +scaling_configuration, +slurm_configuration, +spot_options, +status, +subnet_ids, +tag_key, +tag_value +FROM aws.pcs.compute_node_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the compute_node_group_tags resource, see compute_node_groups + diff --git a/website/docs/services/pcs/compute_node_groups/index.md b/website/docs/services/pcs/compute_node_groups/index.md new file mode 100644 index 0000000..f25862f --- /dev/null +++ b/website/docs/services/pcs/compute_node_groups/index.md @@ -0,0 +1,355 @@ +--- +title: compute_node_groups +hide_title: false +hide_table_of_contents: false +keywords: + - compute_node_groups + - pcs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a compute_node_group resource or lists compute_node_groups in a region + +## Overview + + + + + + + +
Namecompute_node_groups
TypeResource
DescriptionAWS::PCS::ComputeNodeGroup resource creates an AWS PCS compute node group.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances. If not provided, AWS PCS uses the AMI ID specified in the custom launch template.
stringThe unique Amazon Resource Name (ARN) of the compute node group.
stringThe ID of the cluster of the compute node group.
objectAn Amazon EC2 launch template AWS PCS uses to launch compute nodes.
arrayThe list of errors that occurred during compute node group provisioning.
stringThe Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
stringThe generated unique ID of the compute node group.
arrayA list of EC2 instance configurations that AWS PCS can provision in the compute node group.
stringThe name that identifies the compute node group.
stringSpecifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
objectSpecifies the boundaries of the compute node group auto scaling.
objectAdditional options related to the Slurm scheduler.
objectAdditional configuration when you specify SPOT as the purchase option.
stringThe provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.
arrayThe list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.
1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
stringAWS region.
+ +For more information, see AWS::PCS::ComputeNodeGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all compute_node_groups in a region. +```sql +SELECT +region, +ami_id, +arn, +cluster_id, +custom_launch_template, +error_info, +iam_instance_profile_arn, +id, +instance_configs, +name, +purchase_option, +scaling_configuration, +slurm_configuration, +spot_options, +status, +subnet_ids, +tags +FROM aws.pcs.compute_node_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual compute_node_group. +```sql +SELECT +region, +ami_id, +arn, +cluster_id, +custom_launch_template, +error_info, +iam_instance_profile_arn, +id, +instance_configs, +name, +purchase_option, +scaling_configuration, +slurm_configuration, +spot_options, +status, +subnet_ids, +tags +FROM aws.pcs.compute_node_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new compute_node_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pcs.compute_node_groups ( + ClusterId, + CustomLaunchTemplate, + IamInstanceProfileArn, + InstanceConfigs, + ScalingConfiguration, + SubnetIds, + region +) +SELECT +'{{ ClusterId }}', + '{{ CustomLaunchTemplate }}', + '{{ IamInstanceProfileArn }}', + '{{ InstanceConfigs }}', + '{{ ScalingConfiguration }}', + '{{ SubnetIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pcs.compute_node_groups ( + AmiId, + ClusterId, + CustomLaunchTemplate, + IamInstanceProfileArn, + InstanceConfigs, + Name, + PurchaseOption, + ScalingConfiguration, + SlurmConfiguration, + SpotOptions, + SubnetIds, + Tags, + region +) +SELECT + '{{ AmiId }}', + '{{ ClusterId }}', + '{{ CustomLaunchTemplate }}', + '{{ IamInstanceProfileArn }}', + '{{ InstanceConfigs }}', + '{{ Name }}', + '{{ PurchaseOption }}', + '{{ ScalingConfiguration }}', + '{{ SlurmConfiguration }}', + '{{ SpotOptions }}', + '{{ SubnetIds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: compute_node_group + props: + - name: AmiId + value: '{{ AmiId }}' + - name: ClusterId + value: '{{ ClusterId }}' + - name: CustomLaunchTemplate + value: + Id: '{{ Id }}' + Version: '{{ Version }}' + - name: IamInstanceProfileArn + value: '{{ IamInstanceProfileArn }}' + - name: InstanceConfigs + value: + - InstanceType: '{{ InstanceType }}' + - name: Name + value: '{{ Name }}' + - name: PurchaseOption + value: '{{ PurchaseOption }}' + - name: ScalingConfiguration + value: + MaxInstanceCount: '{{ MaxInstanceCount }}' + MinInstanceCount: '{{ MinInstanceCount }}' + - name: SlurmConfiguration + value: + SlurmCustomSettings: + - ParameterName: '{{ ParameterName }}' + ParameterValue: '{{ ParameterValue }}' + - name: SpotOptions + value: + AllocationStrategy: '{{ AllocationStrategy }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: Tags + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pcs.compute_node_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the compute_node_groups resource, the following permissions are required: + +### Create +```json +ec2:DescribeImages, +ec2:DescribeVpcs, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +ec2:DescribeLaunchTemplates, +ec2:DescribeLaunchTemplateVersions, +ec2:DescribeInstanceTypes, +ec2:DescribeInstanceTypeOfferings, +ec2:RunInstances, +ec2:CreateFleet, +ec2:CreateTags, +iam:PassRole, +iam:GetInstanceProfile, +pcs:CreateComputeNodeGroup, +pcs:GetComputeNodeGroup, +pcs:ListTagsForResource, +pcs:TagResource +``` + +### Read +```json +pcs:GetComputeNodeGroup, +pcs:ListTagsForResource +``` + +### Update +```json +ec2:DescribeImages, +ec2:DescribeVpcs, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +ec2:DescribeLaunchTemplates, +ec2:DescribeLaunchTemplateVersions, +ec2:DescribeInstanceTypes, +ec2:DescribeInstanceTypeOfferings, +ec2:RunInstances, +ec2:CreateFleet, +ec2:CreateTags, +iam:PassRole, +iam:GetInstanceProfile, +pcs:GetComputeNodeGroup, +pcs:UpdateComputeNodeGroup, +pcs:ListTagsForResource, +pcs:TagResource, +pcs:UntagResource +``` + +### Delete +```json +ec2:DescribeImages, +ec2:DescribeVpcs, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +ec2:DescribeLaunchTemplates, +ec2:DescribeLaunchTemplateVersions, +ec2:DescribeInstanceTypes, +ec2:DescribeInstanceTypeOfferings, +ec2:TerminateInstances, +ec2:CreateFleet, +ec2:CreateTags, +iam:PassRole, +iam:GetInstanceProfile, +pcs:GetComputeNodeGroup, +pcs:DeleteComputeNodeGroup, +pcs:ListTagsForResource, +pcs:TagResource, +pcs:UntagResource +``` + +### List +```json +pcs:ListClusters, +pcs:ListComputeNodeGroups +``` diff --git a/website/docs/services/pcs/compute_node_groups_list_only/index.md b/website/docs/services/pcs/compute_node_groups_list_only/index.md new file mode 100644 index 0000000..866c064 --- /dev/null +++ b/website/docs/services/pcs/compute_node_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: compute_node_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - compute_node_groups_list_only + - pcs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists compute_node_groups in a region or regions, for all properties use compute_node_groups + +## Overview + + + + + + + +
Namecompute_node_groups_list_only
TypeResource
DescriptionAWS::PCS::ComputeNodeGroup resource creates an AWS PCS compute node group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique Amazon Resource Name (ARN) of the compute node group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all compute_node_groups in a region. +```sql +SELECT +region, +arn +FROM aws.pcs.compute_node_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the compute_node_groups_list_only resource, see compute_node_groups + diff --git a/website/docs/services/pcs/index.md b/website/docs/services/pcs/index.md new file mode 100644 index 0000000..1d3a78b --- /dev/null +++ b/website/docs/services/pcs/index.md @@ -0,0 +1,44 @@ +--- +title: pcs +hide_title: false +hide_table_of_contents: false +keywords: + - pcs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The pcs service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/pcs/queue_tags/index.md b/website/docs/services/pcs/queue_tags/index.md new file mode 100644 index 0000000..78db932 --- /dev/null +++ b/website/docs/services/pcs/queue_tags/index.md @@ -0,0 +1,89 @@ +--- +title: queue_tags +hide_title: false +hide_table_of_contents: false +keywords: + - queue_tags + - pcs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for queues in a region + +## Overview + + + + + + + +
Namequeue_tags
TypeResource
DescriptionAWS::PCS::Queue resource creates an AWS PCS queue.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique Amazon Resource Name (ARN) of the queue.
stringThe ID of the cluster of the queue.
arrayThe list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.
arrayThe list of errors that occurred during queue provisioning.
stringThe generated unique ID of the queue.
stringThe name that identifies the queue.
stringThe provisioning status of the queue. The provisioning status doesn't indicate the overall health of the queue.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all queues in a region. +```sql +SELECT +region, +arn, +cluster_id, +compute_node_group_configurations, +error_info, +id, +name, +status, +tag_key, +tag_value +FROM aws.pcs.queue_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queue_tags resource, see queues + diff --git a/website/docs/services/pcs/queues/index.md b/website/docs/services/pcs/queues/index.md new file mode 100644 index 0000000..2bdfd66 --- /dev/null +++ b/website/docs/services/pcs/queues/index.md @@ -0,0 +1,246 @@ +--- +title: queues +hide_title: false +hide_table_of_contents: false +keywords: + - queues + - pcs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a queue resource or lists queues in a region + +## Overview + + + + + + + +
Namequeues
TypeResource
DescriptionAWS::PCS::Queue resource creates an AWS PCS queue.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique Amazon Resource Name (ARN) of the queue.
stringThe ID of the cluster of the queue.
arrayThe list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.
arrayThe list of errors that occurred during queue provisioning.
stringThe generated unique ID of the queue.
stringThe name that identifies the queue.
stringThe provisioning status of the queue. The provisioning status doesn't indicate the overall health of the queue.
object1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
stringAWS region.
+ +For more information, see AWS::PCS::Queue. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all queues in a region. +```sql +SELECT +region, +arn, +cluster_id, +compute_node_group_configurations, +error_info, +id, +name, +status, +tags +FROM aws.pcs.queues +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual queue. +```sql +SELECT +region, +arn, +cluster_id, +compute_node_group_configurations, +error_info, +id, +name, +status, +tags +FROM aws.pcs.queues +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pcs.queues ( + ClusterId, + region +) +SELECT +'{{ ClusterId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pcs.queues ( + ClusterId, + ComputeNodeGroupConfigurations, + Name, + Tags, + region +) +SELECT + '{{ ClusterId }}', + '{{ ComputeNodeGroupConfigurations }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: queue + props: + - name: ClusterId + value: '{{ ClusterId }}' + - name: ComputeNodeGroupConfigurations + value: + - ComputeNodeGroupId: '{{ ComputeNodeGroupId }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pcs.queues +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the queues resource, the following permissions are required: + +### Create +```json +ec2:CreateNetworkInterface, +ec2:DescribeVpcs, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +ec2:GetSecurityGroupsForVpc, +iam:CreateServiceLinkedRole, +secretsmanager:CreateSecret, +secretsmanager:TagResource, +pcs:CreateQueue, +pcs:GetQueue, +pcs:ListTagsForResource, +pcs:TagResource +``` + +### Read +```json +pcs:GetQueue, +pcs:ListTagsForResource +``` + +### Update +```json +pcs:GetQueue, +pcs:UpdateQueue, +pcs:ListTagsForResource, +pcs:TagResource, +pcs:UntagResource +``` + +### Delete +```json +pcs:DeleteQueue, +pcs:GetQueue +``` + +### List +```json +pcs:ListClusters, +pcs:ListQueues +``` diff --git a/website/docs/services/pcs/queues_list_only/index.md b/website/docs/services/pcs/queues_list_only/index.md new file mode 100644 index 0000000..ee983b1 --- /dev/null +++ b/website/docs/services/pcs/queues_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queues_list_only + - pcs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queues in a region or regions, for all properties use queues + +## Overview + + + + + + + +
Namequeues_list_only
TypeResource
DescriptionAWS::PCS::Queue resource creates an AWS PCS queue.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique Amazon Resource Name (ARN) of the queue.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queues in a region. +```sql +SELECT +region, +arn +FROM aws.pcs.queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queues_list_only resource, see queues + diff --git a/website/docs/services/personalize/dataset_groups/index.md b/website/docs/services/personalize/dataset_groups/index.md new file mode 100644 index 0000000..24c0555 --- /dev/null +++ b/website/docs/services/personalize/dataset_groups/index.md @@ -0,0 +1,211 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dataset_group resource or lists dataset_groups in a region + +## Overview + + + + + + + +
Namedataset_groups
TypeResource
DescriptionResource Schema for AWS::Personalize::DatasetGroup.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the dataset group.
stringThe name for the new dataset group.
stringThe Amazon Resource Name(ARN) of a AWS Key Management Service (KMS) key used to encrypt the datasets.
stringThe ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
stringThe domain of a Domain dataset group.
stringAWS region.
+ +For more information, see AWS::Personalize::DatasetGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dataset_groups in a region. +```sql +SELECT +region, +dataset_group_arn, +name, +kms_key_arn, +role_arn, +domain +FROM aws.personalize.dataset_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dataset_group. +```sql +SELECT +region, +dataset_group_arn, +name, +kms_key_arn, +role_arn, +domain +FROM aws.personalize.dataset_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dataset_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.personalize.dataset_groups ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.personalize.dataset_groups ( + Name, + KmsKeyArn, + RoleArn, + Domain, + region +) +SELECT + '{{ Name }}', + '{{ KmsKeyArn }}', + '{{ RoleArn }}', + '{{ Domain }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dataset_group + props: + - name: Name + value: '{{ Name }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Domain + value: '{{ Domain }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.personalize.dataset_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +personalize:DescribeDatasetGroup +``` + +### Delete +```json +personalize:DescribeDatasetGroup, +personalize:DeleteDatasetGroup +``` + +### List +```json +personalize:ListDatasetGroups +``` diff --git a/website/docs/services/personalize/dataset_groups_list_only/index.md b/website/docs/services/personalize/dataset_groups_list_only/index.md new file mode 100644 index 0000000..355b8ca --- /dev/null +++ b/website/docs/services/personalize/dataset_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dataset_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_groups_list_only + - personalize + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dataset_groups in a region or regions, for all properties use dataset_groups + +## Overview + + + + + + + +
Namedataset_groups_list_only
TypeResource
DescriptionResource Schema for AWS::Personalize::DatasetGroup.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the dataset group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dataset_groups in a region. +```sql +SELECT +region, +dataset_group_arn +FROM aws.personalize.dataset_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_groups_list_only resource, see dataset_groups + diff --git a/website/docs/services/personalize/datasets/index.md b/website/docs/services/personalize/datasets/index.md new file mode 100644 index 0000000..e046f17 --- /dev/null +++ b/website/docs/services/personalize/datasets/index.md @@ -0,0 +1,245 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dataset resource or lists datasets in a region + +## Overview + + + + + + + +
Namedatasets
TypeResource
DescriptionResource schema for AWS::Personalize::Dataset.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the dataset
stringThe ARN of the dataset
stringThe type of dataset
stringThe Amazon Resource Name (ARN) of the dataset group to add the dataset to
stringThe ARN of the schema to associate with the dataset. The schema defines the dataset fields.
objectInitial DatasetImportJob for the created dataset
stringAWS region.
+ +For more information, see AWS::Personalize::Dataset. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all datasets in a region. +```sql +SELECT +region, +name, +dataset_arn, +dataset_type, +dataset_group_arn, +schema_arn, +dataset_import_job +FROM aws.personalize.datasets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dataset. +```sql +SELECT +region, +name, +dataset_arn, +dataset_type, +dataset_group_arn, +schema_arn, +dataset_import_job +FROM aws.personalize.datasets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dataset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.personalize.datasets ( + Name, + DatasetType, + DatasetGroupArn, + SchemaArn, + region +) +SELECT +'{{ Name }}', + '{{ DatasetType }}', + '{{ DatasetGroupArn }}', + '{{ SchemaArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.personalize.datasets ( + Name, + DatasetType, + DatasetGroupArn, + SchemaArn, + DatasetImportJob, + region +) +SELECT + '{{ Name }}', + '{{ DatasetType }}', + '{{ DatasetGroupArn }}', + '{{ SchemaArn }}', + '{{ DatasetImportJob }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dataset + props: + - name: Name + value: '{{ Name }}' + - name: DatasetType + value: '{{ DatasetType }}' + - name: DatasetGroupArn + value: '{{ DatasetGroupArn }}' + - name: SchemaArn + value: '{{ SchemaArn }}' + - name: DatasetImportJob + value: + JobName: '{{ JobName }}' + DatasetImportJobArn: '{{ DatasetImportJobArn }}' + DatasetArn: '{{ DatasetArn }}' + DataSource: + DataLocation: '{{ DataLocation }}' + RoleArn: '{{ RoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.personalize.datasets +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +personalize:DescribeDataset +``` + +### Update +```json +personalize:DescribeDataset, +personalize:CreateDatasetImportJob, +personalize:DescribeDatasetImportJob, +iam:PassRole +``` + +### Delete +```json +personalize:DeleteDataset, +personalize:DescribeDataset +``` + +### List +```json +personalize:ListDatasets +``` diff --git a/website/docs/services/personalize/datasets_list_only/index.md b/website/docs/services/personalize/datasets_list_only/index.md new file mode 100644 index 0000000..441e41a --- /dev/null +++ b/website/docs/services/personalize/datasets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: datasets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - datasets_list_only + - personalize + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists datasets in a region or regions, for all properties use datasets + +## Overview + + + + + + + +
Namedatasets_list_only
TypeResource
DescriptionResource schema for AWS::Personalize::Dataset.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the dataset
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all datasets in a region. +```sql +SELECT +region, +dataset_arn +FROM aws.personalize.datasets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datasets_list_only resource, see datasets + diff --git a/website/docs/services/personalize/index.md b/website/docs/services/personalize/index.md new file mode 100644 index 0000000..41de6dd --- /dev/null +++ b/website/docs/services/personalize/index.md @@ -0,0 +1,43 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The personalize service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/personalize/schemata/index.md b/website/docs/services/personalize/schemata/index.md new file mode 100644 index 0000000..31fe35b --- /dev/null +++ b/website/docs/services/personalize/schemata/index.md @@ -0,0 +1,205 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a schema resource or lists schemata in a region + +## Overview + + + + + + + +
Nameschemata
TypeResource
DescriptionResource schema for AWS::Personalize::Schema.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName for the schema.
stringArn for the schema.
stringA schema in Avro JSON format.
stringThe domain of a Domain dataset group.
stringAWS region.
+ +For more information, see AWS::Personalize::Schema. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all schemata in a region. +```sql +SELECT +region, +name, +schema_arn, +schema, +domain +FROM aws.personalize.schemata +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual schema. +```sql +SELECT +region, +name, +schema_arn, +schema, +domain +FROM aws.personalize.schemata +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new schema resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.personalize.schemata ( + Name, + Schema, + region +) +SELECT +'{{ Name }}', + '{{ Schema }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.personalize.schemata ( + Name, + Schema, + Domain, + region +) +SELECT + '{{ Name }}', + '{{ Schema }}', + '{{ Domain }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: schema + props: + - name: Name + value: '{{ Name }}' + - name: Schema + value: '{{ Schema }}' + - name: Domain + value: '{{ Domain }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.personalize.schemata +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the schemata resource, the following permissions are required: + +### Create +```json +personalize:CreateSchema, +personalize:DescribeSchema +``` + +### Read +```json +personalize:DescribeSchema +``` + +### Delete +```json +personalize:DeleteSchema, +personalize:DescribeSchema +``` + +### List +```json +personalize:ListSchemas +``` diff --git a/website/docs/services/personalize/schemata_list_only/index.md b/website/docs/services/personalize/schemata_list_only/index.md new file mode 100644 index 0000000..4f3a06d --- /dev/null +++ b/website/docs/services/personalize/schemata_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: schemata_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schemata_list_only + - personalize + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schemata in a region or regions, for all properties use schemata + +## Overview + + + + + + + +
Nameschemata_list_only
TypeResource
DescriptionResource schema for AWS::Personalize::Schema.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringArn for the schema.
stringA schema in Avro JSON format.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schemata in a region. +```sql +SELECT +region, +schema_arn +FROM aws.personalize.schemata_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schemata_list_only resource, see schemata + diff --git a/website/docs/services/personalize/solutions/index.md b/website/docs/services/personalize/solutions/index.md new file mode 100644 index 0000000..528f91f --- /dev/null +++ b/website/docs/services/personalize/solutions/index.md @@ -0,0 +1,261 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a solution resource or lists solutions in a region + +## Overview + + + + + + + +
Namesolutions
TypeResource
DescriptionResource schema for AWS::Personalize::Solution.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the solution
stringThe ARN of the solution
stringWhen your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model. If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.
stringThe ARN of the dataset group that provides the training data.
booleanWhether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.
booleanWhether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false.
stringThe ARN of the recipe to use for model training. Only specified when performAutoML is false.
objectThe configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.
stringAWS region.
+ +For more information, see AWS::Personalize::Solution. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all solutions in a region. +```sql +SELECT +region, +name, +solution_arn, +event_type, +dataset_group_arn, +perform_auto_ml, +perform_hpo, +recipe_arn, +solution_config +FROM aws.personalize.solutions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual solution. +```sql +SELECT +region, +name, +solution_arn, +event_type, +dataset_group_arn, +perform_auto_ml, +perform_hpo, +recipe_arn, +solution_config +FROM aws.personalize.solutions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new solution resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.personalize.solutions ( + Name, + DatasetGroupArn, + region +) +SELECT +'{{ Name }}', + '{{ DatasetGroupArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.personalize.solutions ( + Name, + EventType, + DatasetGroupArn, + PerformAutoML, + PerformHPO, + RecipeArn, + SolutionConfig, + region +) +SELECT + '{{ Name }}', + '{{ EventType }}', + '{{ DatasetGroupArn }}', + '{{ PerformAutoML }}', + '{{ PerformHPO }}', + '{{ RecipeArn }}', + '{{ SolutionConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: solution + props: + - name: Name + value: '{{ Name }}' + - name: EventType + value: '{{ EventType }}' + - name: DatasetGroupArn + value: '{{ DatasetGroupArn }}' + - name: PerformAutoML + value: '{{ PerformAutoML }}' + - name: PerformHPO + value: '{{ PerformHPO }}' + - name: RecipeArn + value: '{{ RecipeArn }}' + - name: SolutionConfig + value: + AlgorithmHyperParameters: {} + AutoMLConfig: + MetricName: '{{ MetricName }}' + RecipeList: + - '{{ RecipeList[0] }}' + EventValueThreshold: '{{ EventValueThreshold }}' + FeatureTransformationParameters: {} + HpoConfig: + AlgorithmHyperParameterRanges: + CategoricalHyperParameterRanges: + - Name: '{{ Name }}' + Values: + - '{{ Values[0] }}' + ContinuousHyperParameterRanges: + - Name: '{{ Name }}' + MinValue: null + MaxValue: null + IntegerHyperParameterRanges: + - Name: '{{ Name }}' + MinValue: '{{ MinValue }}' + MaxValue: '{{ MaxValue }}' + HpoObjective: + MetricName: '{{ MetricName }}' + Type: '{{ Type }}' + MetricRegex: '{{ MetricRegex }}' + HpoResourceConfig: + MaxNumberOfTrainingJobs: '{{ MaxNumberOfTrainingJobs }}' + MaxParallelTrainingJobs: '{{ MaxParallelTrainingJobs }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.personalize.solutions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the solutions resource, the following permissions are required: + +### Create +```json +personalize:CreateSolution, +personalize:DescribeSolution +``` + +### Read +```json +personalize:DescribeSolution +``` + +### Delete +```json +personalize:DeleteSolution, +personalize:DescribeSolution +``` + +### List +```json +personalize:ListSolutions +``` diff --git a/website/docs/services/personalize/solutions_list_only/index.md b/website/docs/services/personalize/solutions_list_only/index.md new file mode 100644 index 0000000..5a2ce7a --- /dev/null +++ b/website/docs/services/personalize/solutions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: solutions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - solutions_list_only + - personalize + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists solutions in a region or regions, for all properties use solutions + +## Overview + + + + + + + +
Namesolutions_list_only
TypeResource
DescriptionResource schema for AWS::Personalize::Solution.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the solution
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all solutions in a region. +```sql +SELECT +region, +solution_arn +FROM aws.personalize.solutions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the solutions_list_only resource, see solutions + diff --git a/website/docs/services/pinpoint/in_app_template_tags/index.md b/website/docs/services/pinpoint/in_app_template_tags/index.md new file mode 100644 index 0000000..8494bce --- /dev/null +++ b/website/docs/services/pinpoint/in_app_template_tags/index.md @@ -0,0 +1,87 @@ +--- +title: in_app_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - in_app_template_tags + - pinpoint + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for in_app_templates in a region + +## Overview + + + + + + + +
Namein_app_template_tags
TypeResource
DescriptionResource Type definition for AWS::Pinpoint::InAppTemplate
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
array
object
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all in_app_templates in a region. +```sql +SELECT +region, +arn, +content, +custom_config, +layout, +template_description, +template_name, +tag_key, +tag_value +FROM aws.pinpoint.in_app_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the in_app_template_tags resource, see in_app_templates + diff --git a/website/docs/services/pinpoint/in_app_templates/index.md b/website/docs/services/pinpoint/in_app_templates/index.md new file mode 100644 index 0000000..efe3b58 --- /dev/null +++ b/website/docs/services/pinpoint/in_app_templates/index.md @@ -0,0 +1,264 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an in_app_template resource or lists in_app_templates in a region + +## Overview + + + + + + + +
Namein_app_templates
TypeResource
DescriptionResource Type definition for AWS::Pinpoint::InAppTemplate
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
array
object
string
object
string
string
stringAWS region.
+ +For more information, see AWS::Pinpoint::InAppTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all in_app_templates in a region. +```sql +SELECT +region, +arn, +content, +custom_config, +layout, +tags, +template_description, +template_name +FROM aws.pinpoint.in_app_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual in_app_template. +```sql +SELECT +region, +arn, +content, +custom_config, +layout, +tags, +template_description, +template_name +FROM aws.pinpoint.in_app_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new in_app_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pinpoint.in_app_templates ( + TemplateName, + region +) +SELECT +'{{ TemplateName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pinpoint.in_app_templates ( + Content, + CustomConfig, + Layout, + Tags, + TemplateDescription, + TemplateName, + region +) +SELECT + '{{ Content }}', + '{{ CustomConfig }}', + '{{ Layout }}', + '{{ Tags }}', + '{{ TemplateDescription }}', + '{{ TemplateName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: in_app_template + props: + - name: Content + value: + - BackgroundColor: '{{ BackgroundColor }}' + BodyConfig: + Alignment: '{{ Alignment }}' + Body: '{{ Body }}' + TextColor: '{{ TextColor }}' + HeaderConfig: + Alignment: null + Header: '{{ Header }}' + TextColor: '{{ TextColor }}' + ImageUrl: '{{ ImageUrl }}' + PrimaryBtn: + Android: + ButtonAction: '{{ ButtonAction }}' + Link: '{{ Link }}' + DefaultConfig: + BackgroundColor: '{{ BackgroundColor }}' + BorderRadius: '{{ BorderRadius }}' + ButtonAction: null + Link: '{{ Link }}' + Text: '{{ Text }}' + TextColor: '{{ TextColor }}' + IOS: null + Web: null + SecondaryBtn: null + - name: CustomConfig + value: {} + - name: Layout + value: '{{ Layout }}' + - name: Tags + value: {} + - name: TemplateDescription + value: '{{ TemplateDescription }}' + - name: TemplateName + value: '{{ TemplateName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pinpoint.in_app_templates +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +mobiletargeting:DeleteInAppTemplate, +mobiletargeting:GetInAppTemplate +``` + +### List +```json +mobiletargeting:GetInAppTemplate, +mobiletargeting:ListTemplates +``` + +### Read +```json +mobiletargeting:GetInAppTemplate, +mobiletargeting:ListTemplates +``` + +### Update +```json +mobiletargeting:UpdateInAppTemplate, +mobiletargeting:GetInAppTemplate, +mobiletargeting:TagResource, +mobiletargeting:UntagResource +``` diff --git a/website/docs/services/pinpoint/in_app_templates_list_only/index.md b/website/docs/services/pinpoint/in_app_templates_list_only/index.md new file mode 100644 index 0000000..d49612a --- /dev/null +++ b/website/docs/services/pinpoint/in_app_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: in_app_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - in_app_templates_list_only + - pinpoint + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists in_app_templates in a region or regions, for all properties use in_app_templates + +## Overview + + + + + + + +
Namein_app_templates_list_only
TypeResource
DescriptionResource Type definition for AWS::Pinpoint::InAppTemplate
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all in_app_templates in a region. +```sql +SELECT +region, +template_name +FROM aws.pinpoint.in_app_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the in_app_templates_list_only resource, see in_app_templates + diff --git a/website/docs/services/pinpoint/index.md b/website/docs/services/pinpoint/index.md new file mode 100644 index 0000000..54139da --- /dev/null +++ b/website/docs/services/pinpoint/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The pinpoint service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/pipes/index.md b/website/docs/services/pipes/index.md new file mode 100644 index 0000000..5a40ba2 --- /dev/null +++ b/website/docs/services/pipes/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The pipes service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/pipes/pipe_tags/index.md b/website/docs/services/pipes/pipe_tags/index.md new file mode 100644 index 0000000..4109a2c --- /dev/null +++ b/website/docs/services/pipes/pipe_tags/index.md @@ -0,0 +1,109 @@ +--- +title: pipe_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pipe_tags + - pipes + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pipes in a region + +## Overview + + + + + + + +
Namepipe_tags
TypeResource
DescriptionDefinition of AWS::Pipes::Pipe Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
string
string
object
string
string
string
object
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pipes in a region. +```sql +SELECT +region, +arn, +creation_time, +current_state, +description, +desired_state, +enrichment, +enrichment_parameters, +kms_key_identifier, +last_modified_time, +log_configuration, +name, +role_arn, +source, +source_parameters, +state_reason, +target, +target_parameters, +tag_key, +tag_value +FROM aws.pipes.pipe_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipe_tags resource, see pipes + diff --git a/website/docs/services/pipes/pipes/index.md b/website/docs/services/pipes/pipes/index.md new file mode 100644 index 0000000..f951664 --- /dev/null +++ b/website/docs/services/pipes/pipes/index.md @@ -0,0 +1,554 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a pipe resource or lists pipes in a region + +## Overview + + + + + + + +
Namepipes
TypeResource
DescriptionDefinition of AWS::Pipes::Pipe Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
string
string
object
string
string
string
object
string
object
string
object
stringAWS region.
+ +For more information, see AWS::Pipes::Pipe. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all pipes in a region. +```sql +SELECT +region, +arn, +creation_time, +current_state, +description, +desired_state, +enrichment, +enrichment_parameters, +kms_key_identifier, +last_modified_time, +log_configuration, +name, +role_arn, +source, +source_parameters, +state_reason, +tags, +target, +target_parameters +FROM aws.pipes.pipes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual pipe. +```sql +SELECT +region, +arn, +creation_time, +current_state, +description, +desired_state, +enrichment, +enrichment_parameters, +kms_key_identifier, +last_modified_time, +log_configuration, +name, +role_arn, +source, +source_parameters, +state_reason, +tags, +target, +target_parameters +FROM aws.pipes.pipes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pipe resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.pipes.pipes ( + RoleArn, + Source, + Target, + region +) +SELECT +'{{ RoleArn }}', + '{{ Source }}', + '{{ Target }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.pipes.pipes ( + Description, + DesiredState, + Enrichment, + EnrichmentParameters, + KmsKeyIdentifier, + LogConfiguration, + Name, + RoleArn, + Source, + SourceParameters, + Tags, + Target, + TargetParameters, + region +) +SELECT + '{{ Description }}', + '{{ DesiredState }}', + '{{ Enrichment }}', + '{{ EnrichmentParameters }}', + '{{ KmsKeyIdentifier }}', + '{{ LogConfiguration }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ Source }}', + '{{ SourceParameters }}', + '{{ Tags }}', + '{{ Target }}', + '{{ TargetParameters }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: pipe + props: + - name: Description + value: '{{ Description }}' + - name: DesiredState + value: '{{ DesiredState }}' + - name: Enrichment + value: '{{ Enrichment }}' + - name: EnrichmentParameters + value: + InputTemplate: '{{ InputTemplate }}' + HttpParameters: + PathParameterValues: + - '{{ PathParameterValues[0] }}' + HeaderParameters: {} + QueryStringParameters: {} + - name: KmsKeyIdentifier + value: '{{ KmsKeyIdentifier }}' + - name: LogConfiguration + value: + S3LogDestination: + BucketName: '{{ BucketName }}' + Prefix: '{{ Prefix }}' + BucketOwner: '{{ BucketOwner }}' + OutputFormat: '{{ OutputFormat }}' + FirehoseLogDestination: + DeliveryStreamArn: '{{ DeliveryStreamArn }}' + CloudwatchLogsLogDestination: + LogGroupArn: '{{ LogGroupArn }}' + Level: '{{ Level }}' + IncludeExecutionData: + - '{{ IncludeExecutionData[0] }}' + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Source + value: '{{ Source }}' + - name: SourceParameters + value: + FilterCriteria: + Filters: + - Pattern: '{{ Pattern }}' + KinesisStreamParameters: + BatchSize: '{{ BatchSize }}' + DeadLetterConfig: + Arn: '{{ Arn }}' + OnPartialBatchItemFailure: '{{ OnPartialBatchItemFailure }}' + MaximumBatchingWindowInSeconds: '{{ MaximumBatchingWindowInSeconds }}' + MaximumRecordAgeInSeconds: '{{ MaximumRecordAgeInSeconds }}' + MaximumRetryAttempts: '{{ MaximumRetryAttempts }}' + ParallelizationFactor: '{{ ParallelizationFactor }}' + StartingPosition: '{{ StartingPosition }}' + StartingPositionTimestamp: '{{ StartingPositionTimestamp }}' + DynamoDBStreamParameters: + BatchSize: '{{ BatchSize }}' + DeadLetterConfig: null + OnPartialBatchItemFailure: null + MaximumBatchingWindowInSeconds: '{{ MaximumBatchingWindowInSeconds }}' + MaximumRecordAgeInSeconds: '{{ MaximumRecordAgeInSeconds }}' + MaximumRetryAttempts: '{{ MaximumRetryAttempts }}' + ParallelizationFactor: '{{ ParallelizationFactor }}' + StartingPosition: '{{ StartingPosition }}' + SqsQueueParameters: + BatchSize: '{{ BatchSize }}' + MaximumBatchingWindowInSeconds: '{{ MaximumBatchingWindowInSeconds }}' + ActiveMQBrokerParameters: + Credentials: null + QueueName: '{{ QueueName }}' + BatchSize: '{{ BatchSize }}' + MaximumBatchingWindowInSeconds: '{{ MaximumBatchingWindowInSeconds }}' + RabbitMQBrokerParameters: + Credentials: null + QueueName: '{{ QueueName }}' + VirtualHost: '{{ VirtualHost }}' + BatchSize: '{{ BatchSize }}' + MaximumBatchingWindowInSeconds: '{{ MaximumBatchingWindowInSeconds }}' + ManagedStreamingKafkaParameters: + TopicName: '{{ TopicName }}' + StartingPosition: '{{ StartingPosition }}' + BatchSize: '{{ BatchSize }}' + MaximumBatchingWindowInSeconds: '{{ MaximumBatchingWindowInSeconds }}' + ConsumerGroupID: '{{ ConsumerGroupID }}' + Credentials: null + SelfManagedKafkaParameters: + TopicName: '{{ TopicName }}' + StartingPosition: '{{ StartingPosition }}' + AdditionalBootstrapServers: + - '{{ AdditionalBootstrapServers[0] }}' + BatchSize: '{{ BatchSize }}' + MaximumBatchingWindowInSeconds: '{{ MaximumBatchingWindowInSeconds }}' + ConsumerGroupID: '{{ ConsumerGroupID }}' + Credentials: null + ServerRootCaCertificate: '{{ ServerRootCaCertificate }}' + Vpc: + Subnets: + - '{{ Subnets[0] }}' + SecurityGroup: + - '{{ SecurityGroup[0] }}' + - name: Tags + value: {} + - name: Target + value: '{{ Target }}' + - name: TargetParameters + value: + InputTemplate: '{{ InputTemplate }}' + LambdaFunctionParameters: + InvocationType: '{{ InvocationType }}' + StepFunctionStateMachineParameters: + InvocationType: null + KinesisStreamParameters: + PartitionKey: '{{ PartitionKey }}' + EcsTaskParameters: + TaskDefinitionArn: '{{ TaskDefinitionArn }}' + TaskCount: '{{ TaskCount }}' + LaunchType: '{{ LaunchType }}' + NetworkConfiguration: + AwsvpcConfiguration: + Subnets: + - '{{ Subnets[0] }}' + SecurityGroups: + - '{{ SecurityGroups[0] }}' + AssignPublicIp: '{{ AssignPublicIp }}' + PlatformVersion: '{{ PlatformVersion }}' + Group: '{{ Group }}' + CapacityProviderStrategy: + - CapacityProvider: '{{ CapacityProvider }}' + Weight: '{{ Weight }}' + Base: '{{ Base }}' + EnableECSManagedTags: '{{ EnableECSManagedTags }}' + EnableExecuteCommand: '{{ EnableExecuteCommand }}' + PlacementConstraints: + - Type: '{{ Type }}' + Expression: '{{ Expression }}' + PlacementStrategy: + - Type: '{{ Type }}' + Field: '{{ Field }}' + PropagateTags: '{{ PropagateTags }}' + ReferenceId: '{{ ReferenceId }}' + Overrides: + ContainerOverrides: + - Command: + - '{{ Command[0] }}' + Cpu: '{{ Cpu }}' + Environment: + - Name: '{{ Name }}' + Value: '{{ Value }}' + EnvironmentFiles: + - Type: '{{ Type }}' + Value: '{{ Value }}' + Memory: '{{ Memory }}' + MemoryReservation: '{{ MemoryReservation }}' + Name: '{{ Name }}' + ResourceRequirements: + - Type: '{{ Type }}' + Value: '{{ Value }}' + Cpu: '{{ Cpu }}' + EphemeralStorage: + SizeInGiB: '{{ SizeInGiB }}' + ExecutionRoleArn: '{{ ExecutionRoleArn }}' + InferenceAcceleratorOverrides: + - DeviceName: '{{ DeviceName }}' + DeviceType: '{{ DeviceType }}' + Memory: '{{ Memory }}' + TaskRoleArn: '{{ TaskRoleArn }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + BatchJobParameters: + JobDefinition: '{{ JobDefinition }}' + JobName: '{{ JobName }}' + ArrayProperties: + Size: '{{ Size }}' + RetryStrategy: + Attempts: '{{ Attempts }}' + ContainerOverrides: + Command: + - '{{ Command[0] }}' + Environment: + - Name: '{{ Name }}' + Value: '{{ Value }}' + InstanceType: '{{ InstanceType }}' + ResourceRequirements: + - Type: '{{ Type }}' + Value: '{{ Value }}' + DependsOn: + - JobId: '{{ JobId }}' + Type: '{{ Type }}' + Parameters: {} + SqsQueueParameters: + MessageGroupId: '{{ MessageGroupId }}' + MessageDeduplicationId: '{{ MessageDeduplicationId }}' + HttpParameters: + PathParameterValues: + - '{{ PathParameterValues[0] }}' + HeaderParameters: null + QueryStringParameters: null + RedshiftDataParameters: + SecretManagerArn: '{{ SecretManagerArn }}' + Database: '{{ Database }}' + DbUser: '{{ DbUser }}' + StatementName: '{{ StatementName }}' + WithEvent: '{{ WithEvent }}' + Sqls: + - '{{ Sqls[0] }}' + SageMakerPipelineParameters: + PipelineParameterList: + - Name: '{{ Name }}' + Value: '{{ Value }}' + EventBridgeEventBusParameters: + EndpointId: '{{ EndpointId }}' + DetailType: '{{ DetailType }}' + Source: '{{ Source }}' + Resources: + - '{{ Resources[0] }}' + Time: '{{ Time }}' + CloudWatchLogsParameters: + LogStreamName: '{{ LogStreamName }}' + Timestamp: '{{ Timestamp }}' + TimestreamParameters: + TimeValue: '{{ TimeValue }}' + EpochTimeUnit: '{{ EpochTimeUnit }}' + TimeFieldType: '{{ TimeFieldType }}' + TimestampFormat: '{{ TimestampFormat }}' + VersionValue: '{{ VersionValue }}' + DimensionMappings: + - DimensionValue: '{{ DimensionValue }}' + DimensionValueType: '{{ DimensionValueType }}' + DimensionName: '{{ DimensionName }}' + SingleMeasureMappings: + - MeasureValue: '{{ MeasureValue }}' + MeasureValueType: '{{ MeasureValueType }}' + MeasureName: '{{ MeasureName }}' + MultiMeasureMappings: + - MultiMeasureName: '{{ MultiMeasureName }}' + MultiMeasureAttributeMappings: + - MeasureValue: '{{ MeasureValue }}' + MeasureValueType: null + MultiMeasureAttributeName: '{{ MultiMeasureAttributeName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.pipes.pipes +WHERE data__Identifier = '' +AND 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, +kms:DescribeKey, +kms:Decrypt, +kms:GenerateDataKey +``` + +### Read +```json +pipes:DescribePipe, +kms:Decrypt +``` + +### 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, +kms:DescribeKey, +kms:Decrypt, +kms:GenerateDataKey +``` + +### Delete +```json +pipes:DeletePipe, +pipes:DescribePipe, +pipes:UntagResource, +logs:CreateLogDelivery, +logs:UpdateLogDelivery, +logs:DeleteLogDelivery, +logs:GetLogDelivery, +logs:ListLogDeliveries, +kms:DescribeKey, +kms:Decrypt, +kms:GenerateDataKey +``` + +### List +```json +pipes:ListPipes +``` diff --git a/website/docs/services/pipes/pipes_list_only/index.md b/website/docs/services/pipes/pipes_list_only/index.md new file mode 100644 index 0000000..e1385a3 --- /dev/null +++ b/website/docs/services/pipes/pipes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pipes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipes_list_only + - pipes + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipes in a region or regions, for all properties use pipes + +## Overview + + + + + + + +
Namepipes_list_only
TypeResource
DescriptionDefinition of AWS::Pipes::Pipe Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipes in a region. +```sql +SELECT +region, +name +FROM aws.pipes.pipes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipes_list_only resource, see pipes + diff --git a/website/docs/services/proton/environment_account_connection_tags/index.md b/website/docs/services/proton/environment_account_connection_tags/index.md new file mode 100644 index 0000000..6b7069a --- /dev/null +++ b/website/docs/services/proton/environment_account_connection_tags/index.md @@ -0,0 +1,93 @@ +--- +title: environment_account_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_account_connection_tags + - proton + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environment_account_connections in a region + +## Overview + + + + + + + +
Nameenvironment_account_connection_tags
TypeResource
DescriptionResource Schema describing various properties for AWS Proton Environment Account Connections resources.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the environment account connection.
stringThe Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
stringThe Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
stringThe environment account that's connected to the environment account connection.
stringThe name of the AWS Proton environment that's created in the associated management account.
stringThe ID of the environment account connection.
stringThe ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
stringThe Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.
stringThe status of the environment account connection.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environment_account_connections in a region. +```sql +SELECT +region, +arn, +codebuild_role_arn, +component_role_arn, +environment_account_id, +environment_name, +id, +management_account_id, +role_arn, +status, +tag_key, +tag_value +FROM aws.proton.environment_account_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_account_connection_tags resource, see environment_account_connections + diff --git a/website/docs/services/proton/environment_account_connections/index.md b/website/docs/services/proton/environment_account_connections/index.md new file mode 100644 index 0000000..2c5d74b --- /dev/null +++ b/website/docs/services/proton/environment_account_connections/index.md @@ -0,0 +1,276 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment_account_connection resource or lists environment_account_connections in a region + +## Overview + + + + + + + +
Nameenvironment_account_connections
TypeResource
DescriptionResource Schema describing various properties for AWS Proton Environment Account Connections resources.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the environment account connection.
stringThe Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
stringThe Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
stringThe environment account that's connected to the environment account connection.
stringThe name of the AWS Proton environment that's created in the associated management account.
stringThe ID of the environment account connection.
stringThe ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
stringThe Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.
stringThe status of the environment account connection.
array

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


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

stringAWS region.
+ +For more information, see AWS::Proton::EnvironmentAccountConnection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environment_account_connections in a region. +```sql +SELECT +region, +arn, +codebuild_role_arn, +component_role_arn, +environment_account_id, +environment_name, +id, +management_account_id, +role_arn, +status, +tags +FROM aws.proton.environment_account_connections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment_account_connection. +```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_connections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment_account_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.proton.environment_account_connections ( + CodebuildRoleArn, + ComponentRoleArn, + EnvironmentAccountId, + EnvironmentName, + ManagementAccountId, + RoleArn, + Tags, + region +) +SELECT +'{{ CodebuildRoleArn }}', + '{{ ComponentRoleArn }}', + '{{ EnvironmentAccountId }}', + '{{ EnvironmentName }}', + '{{ ManagementAccountId }}', + '{{ RoleArn }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.proton.environment_account_connections ( + CodebuildRoleArn, + ComponentRoleArn, + EnvironmentAccountId, + EnvironmentName, + ManagementAccountId, + RoleArn, + Tags, + region +) +SELECT + '{{ CodebuildRoleArn }}', + '{{ ComponentRoleArn }}', + '{{ EnvironmentAccountId }}', + '{{ EnvironmentName }}', + '{{ ManagementAccountId }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment_account_connection + props: + - name: CodebuildRoleArn + value: '{{ CodebuildRoleArn }}' + - name: ComponentRoleArn + value: '{{ ComponentRoleArn }}' + - name: EnvironmentAccountId + value: '{{ EnvironmentAccountId }}' + - name: EnvironmentName + value: '{{ EnvironmentName }}' + - name: ManagementAccountId + value: '{{ ManagementAccountId }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.proton.environment_account_connections +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +proton:ListEnvironmentAccountConnections +``` diff --git a/website/docs/services/proton/environment_account_connections_list_only/index.md b/website/docs/services/proton/environment_account_connections_list_only/index.md new file mode 100644 index 0000000..22c0414 --- /dev/null +++ b/website/docs/services/proton/environment_account_connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environment_account_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environment_account_connections_list_only + - proton + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environment_account_connections in a region or regions, for all properties use environment_account_connections + +## Overview + + + + + + + +
Nameenvironment_account_connections_list_only
TypeResource
DescriptionResource Schema describing various properties for AWS Proton Environment Account Connections resources.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the environment account connection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environment_account_connections in a region. +```sql +SELECT +region, +arn +FROM aws.proton.environment_account_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_account_connections_list_only resource, see environment_account_connections + diff --git a/website/docs/services/proton/environment_template_tags/index.md b/website/docs/services/proton/environment_template_tags/index.md new file mode 100644 index 0000000..e710983 --- /dev/null +++ b/website/docs/services/proton/environment_template_tags/index.md @@ -0,0 +1,87 @@ +--- +title: environment_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_template_tags + - proton + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environment_templates in a region + +## Overview + + + + + + + +
Nameenvironment_template_tags
TypeResource
DescriptionDefinition of AWS::Proton::EnvironmentTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string

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

string

A description of the environment template.

string

The environment template name as displayed in the developer interface.

string

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

string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environment_templates in a region. +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +provisioning, +tag_key, +tag_value +FROM aws.proton.environment_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_template_tags resource, see environment_templates + diff --git a/website/docs/services/proton/environment_templates/index.md b/website/docs/services/proton/environment_templates/index.md new file mode 100644 index 0000000..7a328c5 --- /dev/null +++ b/website/docs/services/proton/environment_templates/index.md @@ -0,0 +1,402 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment_template resource or lists environment_templates in a region + +## Overview + + + + + + + +
Nameenvironment_templates
TypeResource
DescriptionDefinition of AWS::Proton::EnvironmentTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string

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

string

A description of the environment template.

string

The environment template name as displayed in the developer interface.

string

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

string
string
array

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


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

stringAWS region.
+ +For more information, see AWS::Proton::EnvironmentTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environment_templates in a region. +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +provisioning, +tags +FROM aws.proton.environment_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment_template. +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +provisioning, +tags +FROM aws.proton.environment_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.proton.environment_templates ( + Description, + DisplayName, + EncryptionKey, + Name, + Provisioning, + Tags, + region +) +SELECT +'{{ Description }}', + '{{ DisplayName }}', + '{{ EncryptionKey }}', + '{{ Name }}', + '{{ Provisioning }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.proton.environment_templates ( + Description, + DisplayName, + EncryptionKey, + Name, + Provisioning, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ DisplayName }}', + '{{ EncryptionKey }}', + '{{ Name }}', + '{{ Provisioning }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment_template + props: + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: EncryptionKey + value: '{{ EncryptionKey }}' + - name: Name + value: '{{ Name }}' + - name: Provisioning + value: '{{ Provisioning }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.proton.environment_templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the environment_templates resource, the following permissions are required: + +### Create +```json +proton:CreateEnvironmentTemplate, +proton:DeleteEnvironmentTemplate, +proton:ListTagsForResource, +proton:TagResource, +proton:GetEnvironmentTemplate, +kms:CancelKeyDeletion, +kms:CreateAlias, +kms:CreateCustomKeyStore, +kms:CreateGrant, +kms:CreateKey, +kms:DeleteAlias, +kms:DeleteCustomKeyStore, +kms:DeleteImportedKeyMaterial, +kms:DescribeCustomKeyStores, +kms:DescribeKey, +kms:DisableKey, +kms:DisableKeyRotation, +kms:EnableKey, +kms:EnableKeyRotation, +kms:GenerateDataKey, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:GetParametersForImport, +kms:GetPublicKey, +kms:ListAliases, +kms:ListGrants, +kms:ListKeyPolicies, +kms:ListKeyRotations, +kms:ListKeys, +kms:ListResourceTags, +kms:ListRetirableGrants, +kms:PutKeyPolicy, +kms:RevokeGrant, +kms:ScheduleKeyDeletion, +kms:TagResource, +kms:UntagResource, +kms:UpdateAlias, +kms:UpdateCustomKeyStore, +kms:UpdateKeyDescription, +kms:UpdatePrimaryRegion +``` + +### Read +```json +proton:CreateEnvironmentTemplate, +proton:DeleteEnvironmentTemplate, +proton:ListTagsForResource, +proton:GetEnvironmentTemplate, +kms:CancelKeyDeletion, +kms:CreateAlias, +kms:CreateCustomKeyStore, +kms:CreateGrant, +kms:CreateKey, +kms:DeleteAlias, +kms:DeleteCustomKeyStore, +kms:DeleteImportedKeyMaterial, +kms:DescribeCustomKeyStores, +kms:DescribeKey, +kms:DisableKey, +kms:DisableKeyRotation, +kms:EnableKey, +kms:EnableKeyRotation, +kms:GenerateDataKey, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:GetParametersForImport, +kms:GetPublicKey, +kms:ListAliases, +kms:ListGrants, +kms:ListKeyPolicies, +kms:ListKeyRotations, +kms:ListKeys, +kms:ListResourceTags, +kms:ListRetirableGrants, +kms:PutKeyPolicy, +kms:RevokeGrant, +kms:ScheduleKeyDeletion, +kms:TagResource, +kms:UntagResource, +kms:UpdateAlias, +kms:UpdateCustomKeyStore, +kms:UpdateKeyDescription, +kms:UpdatePrimaryRegion +``` + +### Update +```json +proton:CreateEnvironmentTemplate, +proton:DeleteEnvironmentTemplate, +proton:GetEnvironmentTemplate, +proton:ListTagsForResource, +proton:TagResource, +proton:UpdateEnvironmentTemplate, +proton:UntagResource, +kms:CancelKeyDeletion, +kms:CreateAlias, +kms:CreateCustomKeyStore, +kms:CreateGrant, +kms:CreateKey, +kms:DeleteAlias, +kms:DeleteCustomKeyStore, +kms:DeleteImportedKeyMaterial, +kms:DescribeCustomKeyStores, +kms:DescribeKey, +kms:DisableKey, +kms:DisableKeyRotation, +kms:EnableKey, +kms:EnableKeyRotation, +kms:GenerateDataKey, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:GetParametersForImport, +kms:GetPublicKey, +kms:ListAliases, +kms:ListGrants, +kms:ListKeyPolicies, +kms:ListKeyRotations, +kms:ListKeys, +kms:ListResourceTags, +kms:ListRetirableGrants, +kms:PutKeyPolicy, +kms:RevokeGrant, +kms:ScheduleKeyDeletion, +kms:TagResource, +kms:UntagResource, +kms:UpdateAlias, +kms:UpdateCustomKeyStore, +kms:UpdateKeyDescription, +kms:UpdatePrimaryRegion +``` + +### Delete +```json +proton:CreateEnvironmentTemplate, +proton:DeleteEnvironmentTemplate, +proton:GetEnvironmentTemplate, +proton:ListTagsForResource, +proton:TagResource, +proton:UntagResource, +kms:CancelKeyDeletion, +kms:CreateAlias, +kms:CreateCustomKeyStore, +kms:CreateGrant, +kms:CreateKey, +kms:DeleteAlias, +kms:DeleteCustomKeyStore, +kms:DeleteImportedKeyMaterial, +kms:DescribeCustomKeyStores, +kms:DescribeKey, +kms:DisableKey, +kms:DisableKeyRotation, +kms:EnableKey, +kms:EnableKeyRotation, +kms:GenerateDataKey, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:GetParametersForImport, +kms:GetPublicKey, +kms:ListAliases, +kms:ListGrants, +kms:ListKeyPolicies, +kms:ListKeyRotations, +kms:ListKeys, +kms:ListResourceTags, +kms:ListRetirableGrants, +kms:PutKeyPolicy, +kms:RevokeGrant, +kms:ScheduleKeyDeletion, +kms:TagResource, +kms:UntagResource, +kms:UpdateAlias, +kms:UpdateCustomKeyStore, +kms:UpdateKeyDescription, +kms:UpdatePrimaryRegion +``` + +### List +```json +proton:ListEnvironmentTemplates +``` diff --git a/website/docs/services/proton/environment_templates_list_only/index.md b/website/docs/services/proton/environment_templates_list_only/index.md new file mode 100644 index 0000000..90891a4 --- /dev/null +++ b/website/docs/services/proton/environment_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environment_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environment_templates_list_only + - proton + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environment_templates in a region or regions, for all properties use environment_templates + +## Overview + + + + + + + +
Nameenvironment_templates_list_only
TypeResource
DescriptionDefinition of AWS::Proton::EnvironmentTemplate Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string

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

stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environment_templates in a region. +```sql +SELECT +region, +arn +FROM aws.proton.environment_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_templates_list_only resource, see environment_templates + diff --git a/website/docs/services/proton/index.md b/website/docs/services/proton/index.md new file mode 100644 index 0000000..6902cfa --- /dev/null +++ b/website/docs/services/proton/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The proton service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/proton/service_template_tags/index.md b/website/docs/services/proton/service_template_tags/index.md new file mode 100644 index 0000000..50266c5 --- /dev/null +++ b/website/docs/services/proton/service_template_tags/index.md @@ -0,0 +1,87 @@ +--- +title: service_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_template_tags + - proton + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_templates in a region + +## Overview + + + + + + + +
Nameservice_template_tags
TypeResource
DescriptionDefinition of AWS::Proton::ServiceTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string

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

string

A description of the service template.

string

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

string

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

string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_templates in a region. +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +pipeline_provisioning, +tag_key, +tag_value +FROM aws.proton.service_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_template_tags resource, see service_templates + diff --git a/website/docs/services/proton/service_templates/index.md b/website/docs/services/proton/service_templates/index.md new file mode 100644 index 0000000..385c52b --- /dev/null +++ b/website/docs/services/proton/service_templates/index.md @@ -0,0 +1,394 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_template resource or lists service_templates in a region + +## Overview + + + + + + + +
Nameservice_templates
TypeResource
DescriptionDefinition of AWS::Proton::ServiceTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string

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

string

A description of the service template.

string

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

string

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

string
string
array

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


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

stringAWS region.
+ +For more information, see AWS::Proton::ServiceTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all service_templates in a region. +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +pipeline_provisioning, +tags +FROM aws.proton.service_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service_template. +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +pipeline_provisioning, +tags +FROM aws.proton.service_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.proton.service_templates ( + Description, + DisplayName, + EncryptionKey, + Name, + PipelineProvisioning, + Tags, + region +) +SELECT +'{{ Description }}', + '{{ DisplayName }}', + '{{ EncryptionKey }}', + '{{ Name }}', + '{{ PipelineProvisioning }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.proton.service_templates ( + Description, + DisplayName, + EncryptionKey, + Name, + PipelineProvisioning, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ DisplayName }}', + '{{ EncryptionKey }}', + '{{ Name }}', + '{{ PipelineProvisioning }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_template + props: + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: EncryptionKey + value: '{{ EncryptionKey }}' + - name: Name + value: '{{ Name }}' + - name: PipelineProvisioning + value: '{{ PipelineProvisioning }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.proton.service_templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the service_templates resource, the following permissions are required: + +### Create +```json +proton:CreateServiceTemplate, +proton:TagResource, +proton:GetServiceTemplate, +kms:CancelKeyDeletion, +kms:CreateAlias, +kms:CreateCustomKeyStore, +kms:CreateGrant, +kms:CreateKey, +kms:DeleteAlias, +kms:DeleteCustomKeyStore, +kms:DeleteImportedKeyMaterial, +kms:DescribeCustomKeyStores, +kms:DescribeKey, +kms:DisableKey, +kms:DisableKeyRotation, +kms:EnableKey, +kms:EnableKeyRotation, +kms:GenerateDataKey, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:GetParametersForImport, +kms:GetPublicKey, +kms:ListAliases, +kms:ListGrants, +kms:ListKeyPolicies, +kms:ListKeyRotations, +kms:ListKeys, +kms:ListResourceTags, +kms:ListRetirableGrants, +kms:PutKeyPolicy, +kms:RevokeGrant, +kms:ScheduleKeyDeletion, +kms:TagResource, +kms:UntagResource, +kms:UpdateAlias, +kms:UpdateCustomKeyStore, +kms:UpdateKeyDescription, +kms:UpdatePrimaryRegion +``` + +### Read +```json +proton:GetServiceTemplate, +proton:ListTagsForResource, +kms:CancelKeyDeletion, +kms:CreateAlias, +kms:CreateCustomKeyStore, +kms:CreateGrant, +kms:CreateKey, +kms:DeleteAlias, +kms:DeleteCustomKeyStore, +kms:DeleteImportedKeyMaterial, +kms:DescribeCustomKeyStores, +kms:DescribeKey, +kms:DisableKey, +kms:DisableKeyRotation, +kms:EnableKey, +kms:EnableKeyRotation, +kms:GenerateDataKey, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:GetParametersForImport, +kms:GetPublicKey, +kms:ListAliases, +kms:ListGrants, +kms:ListKeyPolicies, +kms:ListKeyRotations, +kms:ListKeys, +kms:ListResourceTags, +kms:ListRetirableGrants, +kms:PutKeyPolicy, +kms:RevokeGrant, +kms:ScheduleKeyDeletion, +kms:TagResource, +kms:UntagResource, +kms:UpdateAlias, +kms:UpdateCustomKeyStore, +kms:UpdateKeyDescription, +kms:UpdatePrimaryRegion +``` + +### Update +```json +proton:GetServiceTemplate, +proton:CreateServiceTemplate, +proton:ListTagsForResource, +proton:TagResource, +proton:UntagResource, +proton:UpdateServiceTemplate, +kms:CancelKeyDeletion, +kms:CreateAlias, +kms:CreateCustomKeyStore, +kms:CreateGrant, +kms:CreateKey, +kms:DeleteAlias, +kms:DeleteCustomKeyStore, +kms:DeleteImportedKeyMaterial, +kms:DescribeCustomKeyStores, +kms:DescribeKey, +kms:DisableKey, +kms:DisableKeyRotation, +kms:EnableKey, +kms:EnableKeyRotation, +kms:GenerateDataKey, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:GetParametersForImport, +kms:GetPublicKey, +kms:ListAliases, +kms:ListGrants, +kms:ListKeyPolicies, +kms:ListKeyRotations, +kms:ListKeys, +kms:ListResourceTags, +kms:ListRetirableGrants, +kms:PutKeyPolicy, +kms:RevokeGrant, +kms:ScheduleKeyDeletion, +kms:TagResource, +kms:UntagResource, +kms:UpdateAlias, +kms:UpdateCustomKeyStore, +kms:UpdateKeyDescription, +kms:UpdatePrimaryRegion +``` + +### Delete +```json +proton:DeleteServiceTemplate, +proton:UntagResource, +proton:GetServiceTemplate, +kms:CancelKeyDeletion, +kms:CreateAlias, +kms:CreateCustomKeyStore, +kms:CreateGrant, +kms:CreateKey, +kms:DeleteAlias, +kms:DeleteCustomKeyStore, +kms:DeleteImportedKeyMaterial, +kms:DescribeCustomKeyStores, +kms:DescribeKey, +kms:DisableKey, +kms:DisableKeyRotation, +kms:EnableKey, +kms:EnableKeyRotation, +kms:GenerateDataKey, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:GetParametersForImport, +kms:GetPublicKey, +kms:ListAliases, +kms:ListGrants, +kms:ListKeyPolicies, +kms:ListKeyRotations, +kms:ListKeys, +kms:ListResourceTags, +kms:ListRetirableGrants, +kms:PutKeyPolicy, +kms:RevokeGrant, +kms:ScheduleKeyDeletion, +kms:TagResource, +kms:UntagResource, +kms:UpdateAlias, +kms:UpdateCustomKeyStore, +kms:UpdateKeyDescription, +kms:UpdatePrimaryRegion +``` + +### List +```json +proton:ListServiceTemplates +``` diff --git a/website/docs/services/proton/service_templates_list_only/index.md b/website/docs/services/proton/service_templates_list_only/index.md new file mode 100644 index 0000000..0155eef --- /dev/null +++ b/website/docs/services/proton/service_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: service_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_templates_list_only + - proton + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_templates in a region or regions, for all properties use service_templates + +## Overview + + + + + + + +
Nameservice_templates_list_only
TypeResource
DescriptionDefinition of AWS::Proton::ServiceTemplate Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string

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

stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_templates in a region. +```sql +SELECT +region, +arn +FROM aws.proton.service_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_templates_list_only resource, see service_templates + diff --git a/website/docs/services/qbusiness/application_tags/index.md b/website/docs/services/qbusiness/application_tags/index.md new file mode 100644 index 0000000..1c5ce7a --- /dev/null +++ b/website/docs/services/qbusiness/application_tags/index.md @@ -0,0 +1,113 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::Application Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
object
array
string
string
string
object
string
string
string
string
object
object
object
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_arn, +application_id, +attachments_configuration, +auto_subscription_configuration, +client_ids_for_oid_c, +created_at, +description, +display_name, +encryption_configuration, +iam_identity_provider_arn, +identity_center_application_arn, +identity_center_instance_arn, +identity_type, +personalization_configuration, +q_apps_configuration, +quick_sight_configuration, +role_arn, +status, +updated_at, +tag_key, +tag_value +FROM aws.qbusiness.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/qbusiness/applications/index.md b/website/docs/services/qbusiness/applications/index.md new file mode 100644 index 0000000..d065178 --- /dev/null +++ b/website/docs/services/qbusiness/applications/index.md @@ -0,0 +1,344 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionDefinition of AWS::QBusiness::Application Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
object
array
string
string
string
object
string
string
string
string
object
object
object
string
string
array
string
stringAWS region.
+ +For more information, see AWS::QBusiness::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +application_arn, +application_id, +attachments_configuration, +auto_subscription_configuration, +client_ids_for_oid_c, +created_at, +description, +display_name, +encryption_configuration, +iam_identity_provider_arn, +identity_center_application_arn, +identity_center_instance_arn, +identity_type, +personalization_configuration, +q_apps_configuration, +quick_sight_configuration, +role_arn, +status, +tags, +updated_at +FROM aws.qbusiness.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +application_arn, +application_id, +attachments_configuration, +auto_subscription_configuration, +client_ids_for_oid_c, +created_at, +description, +display_name, +encryption_configuration, +iam_identity_provider_arn, +identity_center_application_arn, +identity_center_instance_arn, +identity_type, +personalization_configuration, +q_apps_configuration, +quick_sight_configuration, +role_arn, +status, +tags, +updated_at +FROM aws.qbusiness.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.applications ( + DisplayName, + region +) +SELECT +'{{ DisplayName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.applications ( + AttachmentsConfiguration, + AutoSubscriptionConfiguration, + ClientIdsForOIDC, + Description, + DisplayName, + EncryptionConfiguration, + IamIdentityProviderArn, + IdentityCenterInstanceArn, + IdentityType, + PersonalizationConfiguration, + QAppsConfiguration, + QuickSightConfiguration, + RoleArn, + Tags, + region +) +SELECT + '{{ AttachmentsConfiguration }}', + '{{ AutoSubscriptionConfiguration }}', + '{{ ClientIdsForOIDC }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ EncryptionConfiguration }}', + '{{ IamIdentityProviderArn }}', + '{{ IdentityCenterInstanceArn }}', + '{{ IdentityType }}', + '{{ PersonalizationConfiguration }}', + '{{ QAppsConfiguration }}', + '{{ QuickSightConfiguration }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: AttachmentsConfiguration + value: + AttachmentsControlMode: '{{ AttachmentsControlMode }}' + - name: AutoSubscriptionConfiguration + value: + AutoSubscribe: '{{ AutoSubscribe }}' + DefaultSubscriptionType: '{{ DefaultSubscriptionType }}' + - name: ClientIdsForOIDC + value: + - '{{ ClientIdsForOIDC[0] }}' + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: EncryptionConfiguration + value: + KmsKeyId: '{{ KmsKeyId }}' + - name: IamIdentityProviderArn + value: '{{ IamIdentityProviderArn }}' + - name: IdentityCenterInstanceArn + value: '{{ IdentityCenterInstanceArn }}' + - name: IdentityType + value: '{{ IdentityType }}' + - name: PersonalizationConfiguration + value: + PersonalizationControlMode: '{{ PersonalizationControlMode }}' + - name: QAppsConfiguration + value: + QAppsControlMode: '{{ QAppsControlMode }}' + - name: QuickSightConfiguration + value: + ClientNamespace: '{{ ClientNamespace }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.qbusiness.applications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +iam:GetSAMLProvider, +iam:PassRole, +kms:CreateGrant, +kms:DescribeKey, +qbusiness:CreateApplication, +qbusiness:GetApplication, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +qbusiness:UpdateApplication, +quicksight:DescribeAccountSubscription, +quicksight:ListNamespaces, +sso:CreateApplication, +sso:DeleteApplication, +sso:DescribeInstance, +sso:PutApplicationAccessScope, +sso:PutApplicationAuthenticationMethod, +sso:PutApplicationGrant +``` + +### Read +```json +qbusiness:GetApplication, +qbusiness:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +qbusiness:GetApplication, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +qbusiness:UntagResource, +qbusiness:UpdateApplication, +sso:CreateApplication, +sso:DeleteApplication, +sso:DescribeInstance, +sso:PutApplicationAccessScope, +sso:PutApplicationAuthenticationMethod, +sso:PutApplicationGrant +``` + +### Delete +```json +kms:RetireGrant, +qbusiness:DeleteApplication, +qbusiness:GetApplication, +sso:DeleteApplication +``` + +### List +```json +qbusiness:ListApplications +``` diff --git a/website/docs/services/qbusiness/applications_list_only/index.md b/website/docs/services/qbusiness/applications_list_only/index.md new file mode 100644 index 0000000..711d846 --- /dev/null +++ b/website/docs/services/qbusiness/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::Application Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_id +FROM aws.qbusiness.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/qbusiness/data_accessor_tags/index.md b/website/docs/services/qbusiness/data_accessor_tags/index.md new file mode 100644 index 0000000..be5dec0 --- /dev/null +++ b/website/docs/services/qbusiness/data_accessor_tags/index.md @@ -0,0 +1,93 @@ +--- +title: data_accessor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_accessor_tags + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_accessors in a region + +## Overview + + + + + + + +
Namedata_accessor_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::DataAccessor Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_accessors in a region. +```sql +SELECT +region, +action_configurations, +application_id, +created_at, +data_accessor_arn, +data_accessor_id, +display_name, +idc_application_arn, +principal, +updated_at, +tag_key, +tag_value +FROM aws.qbusiness.data_accessor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_accessor_tags resource, see data_accessors + diff --git a/website/docs/services/qbusiness/data_accessors/index.md b/website/docs/services/qbusiness/data_accessors/index.md new file mode 100644 index 0000000..f2eddf0 --- /dev/null +++ b/website/docs/services/qbusiness/data_accessors/index.md @@ -0,0 +1,276 @@ +--- +title: data_accessors +hide_title: false +hide_table_of_contents: false +keywords: + - data_accessors + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_accessor resource or lists data_accessors in a region + +## Overview + + + + + + + +
Namedata_accessors
TypeResource
DescriptionDefinition of AWS::QBusiness::DataAccessor Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
string
string
string
string
array
string
stringAWS region.
+ +For more information, see AWS::QBusiness::DataAccessor. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_accessors in a region. +```sql +SELECT +region, +action_configurations, +application_id, +created_at, +data_accessor_arn, +data_accessor_id, +display_name, +idc_application_arn, +principal, +tags, +updated_at +FROM aws.qbusiness.data_accessors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_accessor. +```sql +SELECT +region, +action_configurations, +application_id, +created_at, +data_accessor_arn, +data_accessor_id, +display_name, +idc_application_arn, +principal, +tags, +updated_at +FROM aws.qbusiness.data_accessors +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_accessor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.data_accessors ( + ActionConfigurations, + ApplicationId, + DisplayName, + Principal, + region +) +SELECT +'{{ ActionConfigurations }}', + '{{ ApplicationId }}', + '{{ DisplayName }}', + '{{ Principal }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.data_accessors ( + ActionConfigurations, + ApplicationId, + DisplayName, + Principal, + Tags, + region +) +SELECT + '{{ ActionConfigurations }}', + '{{ ApplicationId }}', + '{{ DisplayName }}', + '{{ Principal }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_accessor + props: + - name: ActionConfigurations + value: + - Action: '{{ Action }}' + FilterConfiguration: + DocumentAttributeFilter: + AndAllFilters: + - null + OrAllFilters: + - null + NotFilter: null + EqualsTo: + Name: '{{ Name }}' + Value: null + ContainsAll: null + ContainsAny: null + GreaterThan: null + GreaterThanOrEquals: null + LessThan: null + LessThanOrEquals: null + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: Principal + value: '{{ Principal }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.qbusiness.data_accessors +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the data_accessors resource, the following permissions are required: + +### Create +```json +qbusiness:CreateDataAccessor, +qbusiness:GetDataAccessor, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +sso:CreateApplication, +sso:PutApplicationAuthenticationMethod, +sso:PutApplicationGrant, +sso:PutApplicationAccessScope +``` + +### Read +```json +qbusiness:GetDataAccessor, +qbusiness:ListTagsForResource +``` + +### Update +```json +qbusiness:GetDataAccessor, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +qbusiness:UntagResource, +qbusiness:UpdateDataAccessor +``` + +### Delete +```json +qbusiness:DeleteDataAccessor, +qbusiness:GetDataAccessor, +sso:DeleteApplication +``` + +### List +```json +qbusiness:ListDataAccessors +``` diff --git a/website/docs/services/qbusiness/data_accessors_list_only/index.md b/website/docs/services/qbusiness/data_accessors_list_only/index.md new file mode 100644 index 0000000..1d079d7 --- /dev/null +++ b/website/docs/services/qbusiness/data_accessors_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: data_accessors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_accessors_list_only + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_accessors in a region or regions, for all properties use data_accessors + +## Overview + + + + + + + +
Namedata_accessors_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::DataAccessor Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_accessors in a region. +```sql +SELECT +region, +application_id, +data_accessor_id +FROM aws.qbusiness.data_accessors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_accessors_list_only resource, see data_accessors + diff --git a/website/docs/services/qbusiness/data_source_tags/index.md b/website/docs/services/qbusiness/data_source_tags/index.md new file mode 100644 index 0000000..6b26853 --- /dev/null +++ b/website/docs/services/qbusiness/data_source_tags/index.md @@ -0,0 +1,107 @@ +--- +title: data_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_source_tags + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_sources in a region + +## Overview + + + + + + + +
Namedata_source_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::DataSource Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
object
string
string
string
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_sources in a region. +```sql +SELECT +region, +application_id, +configuration, +created_at, +data_source_arn, +data_source_id, +description, +display_name, +document_enrichment_configuration, +media_extraction_configuration, +index_id, +role_arn, +status, +sync_schedule, +type, +updated_at, +vpc_configuration, +tag_key, +tag_value +FROM aws.qbusiness.data_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_source_tags resource, see data_sources + diff --git a/website/docs/services/qbusiness/data_sources/index.md b/website/docs/services/qbusiness/data_sources/index.md new file mode 100644 index 0000000..ba22919 --- /dev/null +++ b/website/docs/services/qbusiness/data_sources/index.md @@ -0,0 +1,323 @@ +--- +title: data_sources +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_source resource or lists data_sources in a region + +## Overview + + + + + + + +
Namedata_sources
TypeResource
DescriptionDefinition of AWS::QBusiness::DataSource Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
object
string
string
string
string
array
string
string
object
stringAWS region.
+ +For more information, see AWS::QBusiness::DataSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_sources in a region. +```sql +SELECT +region, +application_id, +configuration, +created_at, +data_source_arn, +data_source_id, +description, +display_name, +document_enrichment_configuration, +media_extraction_configuration, +index_id, +role_arn, +status, +sync_schedule, +tags, +type, +updated_at, +vpc_configuration +FROM aws.qbusiness.data_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_source. +```sql +SELECT +region, +application_id, +configuration, +created_at, +data_source_arn, +data_source_id, +description, +display_name, +document_enrichment_configuration, +media_extraction_configuration, +index_id, +role_arn, +status, +sync_schedule, +tags, +type, +updated_at, +vpc_configuration +FROM aws.qbusiness.data_sources +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.data_sources ( + ApplicationId, + Configuration, + DisplayName, + IndexId, + region +) +SELECT +'{{ ApplicationId }}', + '{{ Configuration }}', + '{{ DisplayName }}', + '{{ IndexId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.data_sources ( + ApplicationId, + Configuration, + Description, + DisplayName, + DocumentEnrichmentConfiguration, + MediaExtractionConfiguration, + IndexId, + RoleArn, + SyncSchedule, + Tags, + VpcConfiguration, + region +) +SELECT + '{{ ApplicationId }}', + '{{ Configuration }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ DocumentEnrichmentConfiguration }}', + '{{ MediaExtractionConfiguration }}', + '{{ IndexId }}', + '{{ RoleArn }}', + '{{ SyncSchedule }}', + '{{ Tags }}', + '{{ VpcConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_source + props: + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: Configuration + value: null + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: DocumentEnrichmentConfiguration + value: + InlineConfigurations: + - Condition: + Key: '{{ Key }}' + Operator: '{{ Operator }}' + Value: null + Target: + Key: '{{ Key }}' + Value: null + AttributeValueOperator: '{{ AttributeValueOperator }}' + DocumentContentOperator: '{{ DocumentContentOperator }}' + PreExtractionHookConfiguration: + InvocationCondition: null + LambdaArn: '{{ LambdaArn }}' + S3BucketName: '{{ S3BucketName }}' + RoleArn: '{{ RoleArn }}' + PostExtractionHookConfiguration: null + - name: MediaExtractionConfiguration + value: + ImageExtractionConfiguration: + ImageExtractionStatus: '{{ ImageExtractionStatus }}' + - name: IndexId + value: '{{ IndexId }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: SyncSchedule + value: '{{ SyncSchedule }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VpcConfiguration + value: + SubnetIds: + - '{{ SubnetIds[0] }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.qbusiness.data_sources +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the data_sources resource, the following permissions are required: + +### Create +```json +iam:PassRole, +qbusiness:CreateDataSource, +qbusiness:GetDataSource, +qbusiness:ListTagsForResource, +qbusiness:TagResource +``` + +### Read +```json +qbusiness:GetDataSource, +qbusiness:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +qbusiness:GetDataSource, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +qbusiness:UntagResource, +qbusiness:UpdateDataSource +``` + +### Delete +```json +qbusiness:DeleteDataSource, +qbusiness:GetDataSource +``` + +### List +```json +qbusiness:ListDataSources +``` diff --git a/website/docs/services/qbusiness/data_sources_list_only/index.md b/website/docs/services/qbusiness/data_sources_list_only/index.md new file mode 100644 index 0000000..89d8dcf --- /dev/null +++ b/website/docs/services/qbusiness/data_sources_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::DataSource Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +application_id, +data_source_id, +index_id +FROM aws.qbusiness.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + diff --git a/website/docs/services/qbusiness/index.md b/website/docs/services/qbusiness/index.md new file mode 100644 index 0000000..1ffd8d5 --- /dev/null +++ b/website/docs/services/qbusiness/index.md @@ -0,0 +1,58 @@ +--- +title: qbusiness +hide_title: false +hide_table_of_contents: false +keywords: + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The qbusiness service documentation. + +:::info Service Summary + +
+
+total resources: 23
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/qbusiness/index_tags/index.md b/website/docs/services/qbusiness/index_tags/index.md new file mode 100644 index 0000000..5420a32 --- /dev/null +++ b/website/docs/services/qbusiness/index_tags/index.md @@ -0,0 +1,99 @@ +--- +title: index_tags +hide_title: false +hide_table_of_contents: false +keywords: + - index_tags + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for indices in a region + +## Overview + + + + + + + +
Nameindex_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::Index Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
string
array
string
string
object
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all indices in a region. +```sql +SELECT +region, +application_id, +capacity_configuration, +created_at, +description, +display_name, +document_attribute_configurations, +index_arn, +index_id, +index_statistics, +type, +status, +updated_at, +tag_key, +tag_value +FROM aws.qbusiness.index_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the index_tags resource, see indices + diff --git a/website/docs/services/qbusiness/indices/index.md b/website/docs/services/qbusiness/indices/index.md new file mode 100644 index 0000000..3eeda08 --- /dev/null +++ b/website/docs/services/qbusiness/indices/index.md @@ -0,0 +1,272 @@ +--- +title: indices +hide_title: false +hide_table_of_contents: false +keywords: + - indices + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an index resource or lists indices in a region + +## Overview + + + + + + + +
Nameindices
TypeResource
DescriptionDefinition of AWS::QBusiness::Index Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
string
array
string
string
object
string
string
array
string
stringAWS region.
+ +For more information, see AWS::QBusiness::Index. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all indices in a region. +```sql +SELECT +region, +application_id, +capacity_configuration, +created_at, +description, +display_name, +document_attribute_configurations, +index_arn, +index_id, +index_statistics, +type, +status, +tags, +updated_at +FROM aws.qbusiness.indices +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual index. +```sql +SELECT +region, +application_id, +capacity_configuration, +created_at, +description, +display_name, +document_attribute_configurations, +index_arn, +index_id, +index_statistics, +type, +status, +tags, +updated_at +FROM aws.qbusiness.indices +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new index resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.indices ( + ApplicationId, + DisplayName, + region +) +SELECT +'{{ ApplicationId }}', + '{{ DisplayName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.indices ( + ApplicationId, + CapacityConfiguration, + Description, + DisplayName, + DocumentAttributeConfigurations, + Type, + Tags, + region +) +SELECT + '{{ ApplicationId }}', + '{{ CapacityConfiguration }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ DocumentAttributeConfigurations }}', + '{{ Type }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: index + props: + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: CapacityConfiguration + value: + Units: null + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: DocumentAttributeConfigurations + value: + - Name: '{{ Name }}' + Type: '{{ Type }}' + Search: '{{ Search }}' + - name: Type + value: '{{ Type }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.qbusiness.indices +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the indices resource, the following permissions are required: + +### Create +```json +qbusiness:CreateIndex, +qbusiness:GetIndex, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +qbusiness:UpdateIndex +``` + +### Read +```json +qbusiness:GetIndex, +qbusiness:ListTagsForResource +``` + +### Update +```json +qbusiness:GetIndex, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +qbusiness:UntagResource, +qbusiness:UpdateIndex +``` + +### Delete +```json +qbusiness:DeleteIndex, +qbusiness:GetIndex +``` + +### List +```json +qbusiness:ListIndices +``` diff --git a/website/docs/services/qbusiness/indices_list_only/index.md b/website/docs/services/qbusiness/indices_list_only/index.md new file mode 100644 index 0000000..7d1773d --- /dev/null +++ b/website/docs/services/qbusiness/indices_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: indices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - indices_list_only + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists indices in a region or regions, for all properties use indices + +## Overview + + + + + + + +
Nameindices_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::Index Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all indices in a region. +```sql +SELECT +region, +application_id, +index_id +FROM aws.qbusiness.indices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the indices_list_only resource, see indices + diff --git a/website/docs/services/qbusiness/permissions/index.md b/website/docs/services/qbusiness/permissions/index.md new file mode 100644 index 0000000..8edc5e5 --- /dev/null +++ b/website/docs/services/qbusiness/permissions/index.md @@ -0,0 +1,214 @@ +--- +title: permissions +hide_title: false +hide_table_of_contents: false +keywords: + - permissions + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a permission resource or lists permissions in a region + +## Overview + + + + + + + +
Namepermissions
TypeResource
DescriptionDefinition of AWS::QBusiness::Permission Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
array
string
stringAWS region.
+ +For more information, see AWS::QBusiness::Permission. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all permissions in a region. +```sql +SELECT +region, +application_id, +statement_id, +actions, +principal +FROM aws.qbusiness.permissions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual permission. +```sql +SELECT +region, +application_id, +statement_id, +actions, +principal +FROM aws.qbusiness.permissions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.permissions ( + ApplicationId, + StatementId, + Actions, + Principal, + region +) +SELECT +'{{ ApplicationId }}', + '{{ StatementId }}', + '{{ Actions }}', + '{{ Principal }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.permissions ( + ApplicationId, + StatementId, + Actions, + Principal, + region +) +SELECT + '{{ ApplicationId }}', + '{{ StatementId }}', + '{{ Actions }}', + '{{ Principal }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: permission + props: + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: StatementId + value: '{{ StatementId }}' + - name: Actions + value: + - '{{ Actions[0] }}' + - name: Principal + value: '{{ Principal }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.qbusiness.permissions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the permissions resource, the following permissions are required: + +### Create +```json +qbusiness:AssociatePermission, +qbusiness:PutResourcePolicy +``` + +### Read +```json +qbusiness:GetPolicy +``` + +### Delete +```json +qbusiness:DisassociatePermission, +qbusiness:PutResourcePolicy +``` + +### List +```json +qbusiness:GetPolicy +``` diff --git a/website/docs/services/qbusiness/permissions_list_only/index.md b/website/docs/services/qbusiness/permissions_list_only/index.md new file mode 100644 index 0000000..30cd187 --- /dev/null +++ b/website/docs/services/qbusiness/permissions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - permissions_list_only + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists permissions in a region or regions, for all properties use permissions + +## Overview + + + + + + + +
Namepermissions_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::Permission Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all permissions in a region. +```sql +SELECT +region, +application_id, +statement_id +FROM aws.qbusiness.permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permissions_list_only resource, see permissions + diff --git a/website/docs/services/qbusiness/plugin_tags/index.md b/website/docs/services/qbusiness/plugin_tags/index.md new file mode 100644 index 0000000..f7637fa --- /dev/null +++ b/website/docs/services/qbusiness/plugin_tags/index.md @@ -0,0 +1,99 @@ +--- +title: plugin_tags +hide_title: false +hide_table_of_contents: false +keywords: + - plugin_tags + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for plugins in a region + +## Overview + + + + + + + +
Nameplugin_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::Plugin Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
string
object
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all plugins in a region. +```sql +SELECT +region, +application_id, +auth_configuration, +build_status, +created_at, +custom_plugin_configuration, +display_name, +plugin_arn, +plugin_id, +server_url, +state, +type, +updated_at, +tag_key, +tag_value +FROM aws.qbusiness.plugin_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the plugin_tags resource, see plugins + diff --git a/website/docs/services/qbusiness/plugins/index.md b/website/docs/services/qbusiness/plugins/index.md new file mode 100644 index 0000000..d47d214 --- /dev/null +++ b/website/docs/services/qbusiness/plugins/index.md @@ -0,0 +1,278 @@ +--- +title: plugins +hide_title: false +hide_table_of_contents: false +keywords: + - plugins + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a plugin resource or lists plugins in a region + +## Overview + + + + + + + +
Nameplugins
TypeResource
DescriptionDefinition of AWS::QBusiness::Plugin Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
string
object
string
string
string
string
string
array
string
string
stringAWS region.
+ +For more information, see AWS::QBusiness::Plugin. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all plugins in a region. +```sql +SELECT +region, +application_id, +auth_configuration, +build_status, +created_at, +custom_plugin_configuration, +display_name, +plugin_arn, +plugin_id, +server_url, +state, +tags, +type, +updated_at +FROM aws.qbusiness.plugins +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual plugin. +```sql +SELECT +region, +application_id, +auth_configuration, +build_status, +created_at, +custom_plugin_configuration, +display_name, +plugin_arn, +plugin_id, +server_url, +state, +tags, +type, +updated_at +FROM aws.qbusiness.plugins +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new plugin resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.plugins ( + AuthConfiguration, + DisplayName, + Type, + region +) +SELECT +'{{ AuthConfiguration }}', + '{{ DisplayName }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.plugins ( + ApplicationId, + AuthConfiguration, + CustomPluginConfiguration, + DisplayName, + ServerUrl, + State, + Tags, + Type, + region +) +SELECT + '{{ ApplicationId }}', + '{{ AuthConfiguration }}', + '{{ CustomPluginConfiguration }}', + '{{ DisplayName }}', + '{{ ServerUrl }}', + '{{ State }}', + '{{ Tags }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: plugin + props: + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: AuthConfiguration + value: null + - name: CustomPluginConfiguration + value: + Description: '{{ Description }}' + ApiSchemaType: '{{ ApiSchemaType }}' + ApiSchema: null + - name: DisplayName + value: '{{ DisplayName }}' + - name: ServerUrl + value: '{{ ServerUrl }}' + - name: State + value: '{{ State }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.qbusiness.plugins +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the plugins resource, the following permissions are required: + +### Create +```json +iam:PassRole, +qbusiness:CreatePlugin, +qbusiness:GetPlugin, +qbusiness:ListTagsForResource, +qbusiness:TagResource +``` + +### Read +```json +qbusiness:GetPlugin, +qbusiness:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +qbusiness:GetPlugin, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +qbusiness:UntagResource, +qbusiness:UpdatePlugin +``` + +### Delete +```json +qbusiness:DeletePlugin, +qbusiness:GetPlugin +``` + +### List +```json +qbusiness:ListPlugins +``` diff --git a/website/docs/services/qbusiness/plugins_list_only/index.md b/website/docs/services/qbusiness/plugins_list_only/index.md new file mode 100644 index 0000000..89f481e --- /dev/null +++ b/website/docs/services/qbusiness/plugins_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: plugins_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - plugins_list_only + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists plugins in a region or regions, for all properties use plugins + +## Overview + + + + + + + +
Nameplugins_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::Plugin Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all plugins in a region. +```sql +SELECT +region, +application_id, +plugin_id +FROM aws.qbusiness.plugins_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the plugins_list_only resource, see plugins + diff --git a/website/docs/services/qbusiness/retriever_tags/index.md b/website/docs/services/qbusiness/retriever_tags/index.md new file mode 100644 index 0000000..c1d4c87 --- /dev/null +++ b/website/docs/services/qbusiness/retriever_tags/index.md @@ -0,0 +1,95 @@ +--- +title: retriever_tags +hide_title: false +hide_table_of_contents: false +keywords: + - retriever_tags + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for retrievers in a region + +## Overview + + + + + + + +
Nameretriever_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::Retriever Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all retrievers in a region. +```sql +SELECT +region, +application_id, +configuration, +created_at, +display_name, +retriever_arn, +retriever_id, +role_arn, +status, +type, +updated_at, +tag_key, +tag_value +FROM aws.qbusiness.retriever_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the retriever_tags resource, see retrievers + diff --git a/website/docs/services/qbusiness/retrievers/index.md b/website/docs/services/qbusiness/retrievers/index.md new file mode 100644 index 0000000..668fdd8 --- /dev/null +++ b/website/docs/services/qbusiness/retrievers/index.md @@ -0,0 +1,263 @@ +--- +title: retrievers +hide_title: false +hide_table_of_contents: false +keywords: + - retrievers + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a retriever resource or lists retrievers in a region + +## Overview + + + + + + + +
Nameretrievers
TypeResource
DescriptionDefinition of AWS::QBusiness::Retriever Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
string
string
string
string
string
array
string
string
stringAWS region.
+ +For more information, see AWS::QBusiness::Retriever. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all retrievers in a region. +```sql +SELECT +region, +application_id, +configuration, +created_at, +display_name, +retriever_arn, +retriever_id, +role_arn, +status, +tags, +type, +updated_at +FROM aws.qbusiness.retrievers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual retriever. +```sql +SELECT +region, +application_id, +configuration, +created_at, +display_name, +retriever_arn, +retriever_id, +role_arn, +status, +tags, +type, +updated_at +FROM aws.qbusiness.retrievers +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new retriever resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.retrievers ( + ApplicationId, + Configuration, + DisplayName, + Type, + region +) +SELECT +'{{ ApplicationId }}', + '{{ Configuration }}', + '{{ DisplayName }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.retrievers ( + ApplicationId, + Configuration, + DisplayName, + RoleArn, + Tags, + Type, + region +) +SELECT + '{{ ApplicationId }}', + '{{ Configuration }}', + '{{ DisplayName }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: retriever + props: + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: Configuration + value: null + - name: DisplayName + value: '{{ DisplayName }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.qbusiness.retrievers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the retrievers resource, the following permissions are required: + +### Create +```json +iam:PassRole, +qbusiness:CreateRetriever, +qbusiness:GetRetriever, +qbusiness:ListTagsForResource, +qbusiness:TagResource +``` + +### Read +```json +qbusiness:GetRetriever, +qbusiness:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +qbusiness:GetRetriever, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +qbusiness:UntagResource, +qbusiness:UpdateRetriever +``` + +### Delete +```json +qbusiness:DeleteRetriever, +qbusiness:GetRetriever +``` + +### List +```json +qbusiness:ListRetrievers +``` diff --git a/website/docs/services/qbusiness/retrievers_list_only/index.md b/website/docs/services/qbusiness/retrievers_list_only/index.md new file mode 100644 index 0000000..b5c5bb7 --- /dev/null +++ b/website/docs/services/qbusiness/retrievers_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: retrievers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - retrievers_list_only + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists retrievers in a region or regions, for all properties use retrievers + +## Overview + + + + + + + +
Nameretrievers_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::Retriever Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all retrievers in a region. +```sql +SELECT +region, +application_id, +retriever_id +FROM aws.qbusiness.retrievers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the retrievers_list_only resource, see retrievers + diff --git a/website/docs/services/qbusiness/web_experience_tags/index.md b/website/docs/services/qbusiness/web_experience_tags/index.md new file mode 100644 index 0000000..71da5b7 --- /dev/null +++ b/website/docs/services/qbusiness/web_experience_tags/index.md @@ -0,0 +1,105 @@ +--- +title: web_experience_tags +hide_title: false +hide_table_of_contents: false +keywords: + - web_experience_tags + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for web_experiences in a region + +## Overview + + + + + + + +
Nameweb_experience_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::WebExperience Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
undefined
string
string
string
string
string
string
string
string
string
array
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all web_experiences in a region. +```sql +SELECT +region, +application_id, +created_at, +default_endpoint, +identity_provider_configuration, +role_arn, +sample_prompts_control_mode, +status, +subtitle, +title, +updated_at, +web_experience_arn, +web_experience_id, +welcome_message, +origins, +customization_configuration, +tag_key, +tag_value +FROM aws.qbusiness.web_experience_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the web_experience_tags resource, see web_experiences + diff --git a/website/docs/services/qbusiness/web_experiences/index.md b/website/docs/services/qbusiness/web_experiences/index.md new file mode 100644 index 0000000..c83a22e --- /dev/null +++ b/website/docs/services/qbusiness/web_experiences/index.md @@ -0,0 +1,297 @@ +--- +title: web_experiences +hide_title: false +hide_table_of_contents: false +keywords: + - web_experiences + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a web_experience resource or lists web_experiences in a region + +## Overview + + + + + + + +
Nameweb_experiences
TypeResource
DescriptionDefinition of AWS::QBusiness::WebExperience Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
undefined
string
string
string
string
array
string
string
string
string
string
array
object
stringAWS region.
+ +For more information, see AWS::QBusiness::WebExperience. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all web_experiences in a region. +```sql +SELECT +region, +application_id, +created_at, +default_endpoint, +identity_provider_configuration, +role_arn, +sample_prompts_control_mode, +status, +subtitle, +tags, +title, +updated_at, +web_experience_arn, +web_experience_id, +welcome_message, +origins, +customization_configuration +FROM aws.qbusiness.web_experiences +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual web_experience. +```sql +SELECT +region, +application_id, +created_at, +default_endpoint, +identity_provider_configuration, +role_arn, +sample_prompts_control_mode, +status, +subtitle, +tags, +title, +updated_at, +web_experience_arn, +web_experience_id, +welcome_message, +origins, +customization_configuration +FROM aws.qbusiness.web_experiences +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new web_experience resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.web_experiences ( + ApplicationId, + region +) +SELECT +'{{ ApplicationId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.qbusiness.web_experiences ( + ApplicationId, + IdentityProviderConfiguration, + RoleArn, + SamplePromptsControlMode, + Subtitle, + Tags, + Title, + WelcomeMessage, + Origins, + CustomizationConfiguration, + region +) +SELECT + '{{ ApplicationId }}', + '{{ IdentityProviderConfiguration }}', + '{{ RoleArn }}', + '{{ SamplePromptsControlMode }}', + '{{ Subtitle }}', + '{{ Tags }}', + '{{ Title }}', + '{{ WelcomeMessage }}', + '{{ Origins }}', + '{{ CustomizationConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: web_experience + props: + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: IdentityProviderConfiguration + value: null + - name: RoleArn + value: '{{ RoleArn }}' + - name: SamplePromptsControlMode + value: '{{ SamplePromptsControlMode }}' + - name: Subtitle + value: '{{ Subtitle }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Title + value: '{{ Title }}' + - name: WelcomeMessage + value: '{{ WelcomeMessage }}' + - name: Origins + value: + - '{{ Origins[0] }}' + - name: CustomizationConfiguration + value: + CustomCSSUrl: '{{ CustomCSSUrl }}' + LogoUrl: '{{ LogoUrl }}' + FontUrl: '{{ FontUrl }}' + FaviconUrl: '{{ FaviconUrl }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.qbusiness.web_experiences +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the web_experiences resource, the following permissions are required: + +### Create +```json +iam:PassRole, +qbusiness:CreateWebExperience, +qbusiness:GetWebExperience, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +sso:PutApplicationGrant, +sso:UpdateApplication +``` + +### Read +```json +qbusiness:GetWebExperience, +qbusiness:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +qbusiness:GetWebExperience, +qbusiness:ListTagsForResource, +qbusiness:TagResource, +qbusiness:UntagResource, +qbusiness:UpdateWebExperience, +sso:PutApplicationGrant, +sso:UpdateApplication +``` + +### Delete +```json +qbusiness:DeleteWebExperience, +qbusiness:GetWebExperience +``` + +### List +```json +qbusiness:ListWebExperiences +``` diff --git a/website/docs/services/qbusiness/web_experiences_list_only/index.md b/website/docs/services/qbusiness/web_experiences_list_only/index.md new file mode 100644 index 0000000..98f6d33 --- /dev/null +++ b/website/docs/services/qbusiness/web_experiences_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: web_experiences_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - web_experiences_list_only + - qbusiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists web_experiences in a region or regions, for all properties use web_experiences + +## Overview + + + + + + + +
Nameweb_experiences_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::WebExperience Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all web_experiences in a region. +```sql +SELECT +region, +application_id, +web_experience_id +FROM aws.qbusiness.web_experiences_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the web_experiences_list_only resource, see web_experiences + diff --git a/website/docs/services/qldb/index.md b/website/docs/services/qldb/index.md new file mode 100644 index 0000000..3b4f025 --- /dev/null +++ b/website/docs/services/qldb/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The qldb service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/qldb/stream_tags/index.md b/website/docs/services/qldb/stream_tags/index.md new file mode 100644 index 0000000..35d9d01 --- /dev/null +++ b/website/docs/services/qldb/stream_tags/index.md @@ -0,0 +1,91 @@ +--- +title: stream_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stream_tags + - qldb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for streams in a region + +## Overview + + + + + + + +
Namestream_tags
TypeResource
DescriptionResource schema for AWS::QLDB::Stream.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all streams in a region. +```sql +SELECT +region, +ledger_name, +stream_name, +role_arn, +inclusive_start_time, +exclusive_end_time, +kinesis_configuration, +arn, +id, +tag_key, +tag_value +FROM aws.qldb.stream_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_tags resource, see streams + diff --git a/website/docs/services/qldb/streams/index.md b/website/docs/services/qldb/streams/index.md new file mode 100644 index 0000000..8e91863 --- /dev/null +++ b/website/docs/services/qldb/streams/index.md @@ -0,0 +1,260 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a stream resource or lists streams in a region + +## Overview + + + + + + + +
Namestreams
TypeResource
DescriptionResource schema for AWS::QLDB::Stream.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
arrayAn array of key-value pairs to apply to this resource.
string
string
stringAWS region.
+ +For more information, see AWS::QLDB::Stream. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all streams in a region. +```sql +SELECT +region, +ledger_name, +stream_name, +role_arn, +inclusive_start_time, +exclusive_end_time, +kinesis_configuration, +tags, +arn, +id +FROM aws.qldb.streams +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual stream. +```sql +SELECT +region, +ledger_name, +stream_name, +role_arn, +inclusive_start_time, +exclusive_end_time, +kinesis_configuration, +tags, +arn, +id +FROM aws.qldb.streams +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.qldb.streams ( + LedgerName, + StreamName, + RoleArn, + InclusiveStartTime, + KinesisConfiguration, + region +) +SELECT +'{{ LedgerName }}', + '{{ StreamName }}', + '{{ RoleArn }}', + '{{ InclusiveStartTime }}', + '{{ KinesisConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.qldb.streams ( + LedgerName, + StreamName, + RoleArn, + InclusiveStartTime, + ExclusiveEndTime, + KinesisConfiguration, + Tags, + region +) +SELECT + '{{ LedgerName }}', + '{{ StreamName }}', + '{{ RoleArn }}', + '{{ InclusiveStartTime }}', + '{{ ExclusiveEndTime }}', + '{{ KinesisConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: stream + props: + - name: LedgerName + value: '{{ LedgerName }}' + - name: StreamName + value: '{{ StreamName }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: InclusiveStartTime + value: '{{ InclusiveStartTime }}' + - name: ExclusiveEndTime + value: '{{ ExclusiveEndTime }}' + - name: KinesisConfiguration + value: + StreamArn: null + AggregationEnabled: '{{ AggregationEnabled }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.qldb.streams +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the streams resource, the following permissions are required: + +### Create +```json +iam:PassRole, +qldb:StreamJournalToKinesis, +qldb:DescribeJournalKinesisStream +``` + +### Delete +```json +qldb:CancelJournalKinesisStream, +qldb:DescribeJournalKinesisStream +``` + +### Read +```json +qldb:DescribeJournalKinesisStream, +qldb:ListTagsForResource +``` + +### Update +```json +qldb:DescribeJournalKinesisStream, +qldb:UntagResource, +qldb:TagResource +``` + +### List +```json +qldb:listJournalKinesisStreamsForLedger +``` diff --git a/website/docs/services/qldb/streams_list_only/index.md b/website/docs/services/qldb/streams_list_only/index.md new file mode 100644 index 0000000..df715f8 --- /dev/null +++ b/website/docs/services/qldb/streams_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - streams_list_only + - qldb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists streams in a region or regions, for all properties use streams + +## Overview + + + + + + + +
Namestreams_list_only
TypeResource
DescriptionResource schema for AWS::QLDB::Stream.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all streams in a region. +```sql +SELECT +region, +ledger_name, +id +FROM aws.qldb.streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the streams_list_only resource, see streams + diff --git a/website/docs/services/quicksight/analyses/index.md b/website/docs/services/quicksight/analyses/index.md new file mode 100644 index 0000000..86900a9 --- /dev/null +++ b/website/docs/services/quicksight/analyses/index.md @@ -0,0 +1,2196 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an analysis resource or lists analyses in a region + +## Overview + + + + + + + +
Nameanalyses
TypeResource
DescriptionDefinition of the AWS::QuickSight::Analysis Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string

The time that the analysis was created.

object

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

array

The ARNs of the datasets of the analysis.

object

The source entity of an analysis.

string

The ARN of the theme of the analysis.

object
string

The time that the analysis was last updated.

object

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

array
string

The descriptive name of the analysis.

array

Errors associated with the analysis.

string
string
array
string

The Amazon Resource Name (ARN) of the analysis.

array
array

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

stringAWS region.
+ +For more information, see AWS::QuickSight::Analysis. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all analyses in a region. +```sql +SELECT +region, +status, +created_time, +parameters, +data_set_arns, +source_entity, +theme_arn, +definition, +last_updated_time, +validation_strategy, +folder_arns, +name, +errors, +analysis_id, +aws_account_id, +permissions, +arn, +tags, +sheets +FROM aws.quicksight.analyses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual analysis. +```sql +SELECT +region, +status, +created_time, +parameters, +data_set_arns, +source_entity, +theme_arn, +definition, +last_updated_time, +validation_strategy, +folder_arns, +name, +errors, +analysis_id, +aws_account_id, +permissions, +arn, +tags, +sheets +FROM aws.quicksight.analyses +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new analysis resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.analyses ( + Name, + AnalysisId, + AwsAccountId, + region +) +SELECT +'{{ Name }}', + '{{ AnalysisId }}', + '{{ AwsAccountId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.analyses ( + Status, + Parameters, + SourceEntity, + ThemeArn, + Definition, + ValidationStrategy, + FolderArns, + Name, + Errors, + AnalysisId, + AwsAccountId, + Permissions, + Tags, + Sheets, + region +) +SELECT + '{{ Status }}', + '{{ Parameters }}', + '{{ SourceEntity }}', + '{{ ThemeArn }}', + '{{ Definition }}', + '{{ ValidationStrategy }}', + '{{ FolderArns }}', + '{{ Name }}', + '{{ Errors }}', + '{{ AnalysisId }}', + '{{ AwsAccountId }}', + '{{ Permissions }}', + '{{ Tags }}', + '{{ Sheets }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: analysis + props: + - name: Status + value: '{{ Status }}' + - name: Parameters + value: + StringParameters: + - Values: + - '{{ Values[0] }}' + Name: '{{ Name }}' + DecimalParameters: + - Values: + - null + Name: '{{ Name }}' + IntegerParameters: + - Values: + - null + Name: '{{ Name }}' + DateTimeParameters: + - Values: + - '{{ Values[0] }}' + Name: '{{ Name }}' + - name: SourceEntity + value: + SourceTemplate: + DataSetReferences: + - DataSetArn: '{{ DataSetArn }}' + DataSetPlaceholder: '{{ DataSetPlaceholder }}' + Arn: '{{ Arn }}' + - name: ThemeArn + value: '{{ ThemeArn }}' + - name: Definition + value: + Options: + Timezone: '{{ Timezone }}' + WeekStart: '{{ WeekStart }}' + FilterGroups: + - Status: '{{ Status }}' + Filters: + - NestedFilter: + Column: + ColumnName: '{{ ColumnName }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + InnerFilter: + CategoryInnerFilter: + Configuration: + CustomFilterListConfiguration: + CategoryValues: + - '{{ CategoryValues[0] }}' + NullOption: '{{ NullOption }}' + MatchOperator: '{{ MatchOperator }}' + SelectAllOptions: '{{ SelectAllOptions }}' + CustomFilterConfiguration: + CategoryValue: '{{ CategoryValue }}' + ParameterName: '{{ ParameterName }}' + NullOption: null + MatchOperator: null + SelectAllOptions: null + FilterListConfiguration: + CategoryValues: + - '{{ CategoryValues[0] }}' + NullOption: null + MatchOperator: null + SelectAllOptions: null + Column: null + DefaultFilterControlConfiguration: + ControlOptions: + DefaultSliderOptions: + Type: '{{ Type }}' + StepSize: null + DisplayOptions: + TitleOptions: + CustomLabel: '{{ CustomLabel }}' + Visibility: null + FontConfiguration: + FontStyle: '{{ FontStyle }}' + FontSize: + Relative: '{{ Relative }}' + FontDecoration: '{{ FontDecoration }}' + FontColor: '{{ FontColor }}' + FontWeight: + Name: '{{ Name }}' + InfoIconLabelOptions: + Visibility: null + InfoIconText: '{{ InfoIconText }}' + MaximumValue: null + MinimumValue: null + DefaultRelativeDateTimeOptions: + DisplayOptions: + TitleOptions: null + InfoIconLabelOptions: null + DateTimeFormat: '{{ DateTimeFormat }}' + CommitMode: '{{ CommitMode }}' + DefaultTextFieldOptions: + DisplayOptions: + TitleOptions: null + PlaceholderOptions: + Visibility: null + InfoIconLabelOptions: null + DefaultTextAreaOptions: + Delimiter: '{{ Delimiter }}' + DisplayOptions: + TitleOptions: null + PlaceholderOptions: null + InfoIconLabelOptions: null + DefaultDropdownOptions: + Type: '{{ Type }}' + DisplayOptions: + TitleOptions: null + SelectAllOptions: + Visibility: null + InfoIconLabelOptions: null + CommitMode: null + SelectableValues: + Values: + - '{{ Values[0] }}' + DefaultDateTimePickerOptions: + Type: '{{ Type }}' + DisplayOptions: + TitleOptions: null + InfoIconLabelOptions: null + DateTimeFormat: '{{ DateTimeFormat }}' + CommitMode: null + DefaultListOptions: + Type: null + DisplayOptions: + TitleOptions: null + SearchOptions: + Visibility: null + SelectAllOptions: null + InfoIconLabelOptions: null + SelectableValues: null + Title: '{{ Title }}' + IncludeInnerSet: '{{ IncludeInnerSet }}' + FilterId: '{{ FilterId }}' + NumericEqualityFilter: + AggregationFunction: + AttributeAggregationFunction: + SimpleAttributeAggregation: '{{ SimpleAttributeAggregation }}' + ValueForMultipleValues: '{{ ValueForMultipleValues }}' + DateAggregationFunction: '{{ DateAggregationFunction }}' + NumericalAggregationFunction: + PercentileAggregation: + PercentileValue: null + SimpleNumericalAggregation: '{{ SimpleNumericalAggregation }}' + CategoricalAggregationFunction: '{{ CategoricalAggregationFunction }}' + Column: null + Value: null + ParameterName: '{{ ParameterName }}' + NullOption: null + MatchOperator: '{{ MatchOperator }}' + SelectAllOptions: '{{ SelectAllOptions }}' + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + NumericRangeFilter: + AggregationFunction: null + Column: null + IncludeMaximum: '{{ IncludeMaximum }}' + RangeMinimum: + StaticValue: null + Parameter: '{{ Parameter }}' + NullOption: null + SelectAllOptions: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + RangeMaximum: null + IncludeMinimum: '{{ IncludeMinimum }}' + TimeRangeFilter: + RangeMinimumValue: + RollingDate: + Expression: '{{ Expression }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + StaticValue: '{{ StaticValue }}' + Parameter: '{{ Parameter }}' + Column: null + RangeMaximumValue: null + IncludeMaximum: '{{ IncludeMaximum }}' + TimeGranularity: '{{ TimeGranularity }}' + NullOption: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + IncludeMinimum: '{{ IncludeMinimum }}' + ExcludePeriodConfiguration: + Status: null + Amount: null + Granularity: null + RelativeDatesFilter: + RelativeDateValue: null + Column: null + RelativeDateType: '{{ RelativeDateType }}' + TimeGranularity: null + ParameterName: '{{ ParameterName }}' + NullOption: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + AnchorDateConfiguration: + AnchorOption: '{{ AnchorOption }}' + ParameterName: '{{ ParameterName }}' + MinimumGranularity: null + ExcludePeriodConfiguration: null + TopBottomFilter: + AggregationSortConfigurations: + - AggregationFunction: null + SortDirection: '{{ SortDirection }}' + Column: null + Column: null + TimeGranularity: null + ParameterName: '{{ ParameterName }}' + Limit: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + TimeEqualityFilter: + Column: null + RollingDate: null + Value: '{{ Value }}' + TimeGranularity: null + ParameterName: '{{ ParameterName }}' + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + CategoryFilter: + Configuration: null + Column: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + CrossDataset: '{{ CrossDataset }}' + ScopeConfiguration: + AllSheets: {} + SelectedSheets: + SheetVisualScopingConfigurations: + - Scope: '{{ Scope }}' + SheetId: '{{ SheetId }}' + VisualIds: + - '{{ VisualIds[0] }}' + FilterGroupId: '{{ FilterGroupId }}' + QueryExecutionOptions: + QueryExecutionMode: '{{ QueryExecutionMode }}' + StaticFiles: + - ImageStaticFile: + StaticFileId: '{{ StaticFileId }}' + Source: + UrlOptions: + Url: '{{ Url }}' + S3Options: + BucketName: '{{ BucketName }}' + ObjectKey: '{{ ObjectKey }}' + Region: '{{ Region }}' + SpatialStaticFile: + StaticFileId: '{{ StaticFileId }}' + Source: null + CalculatedFields: + - Expression: '{{ Expression }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + Name: '{{ Name }}' + DataSetIdentifierDeclarations: + - Identifier: '{{ Identifier }}' + DataSetArn: '{{ DataSetArn }}' + ColumnConfigurations: + - Role: '{{ Role }}' + FormatConfiguration: + NumberFormatConfiguration: + FormatConfiguration: + NumberDisplayFormatConfiguration: + NegativeValueConfiguration: + DisplayMode: '{{ DisplayMode }}' + DecimalPlacesConfiguration: + DecimalPlaces: null + NumberScale: '{{ NumberScale }}' + NullValueFormatConfiguration: + NullString: '{{ NullString }}' + Suffix: '{{ Suffix }}' + SeparatorConfiguration: + DecimalSeparator: '{{ DecimalSeparator }}' + ThousandsSeparator: + Symbol: null + Visibility: null + Prefix: '{{ Prefix }}' + CurrencyDisplayFormatConfiguration: + NegativeValueConfiguration: null + DecimalPlacesConfiguration: null + NumberScale: null + NullValueFormatConfiguration: null + Suffix: '{{ Suffix }}' + SeparatorConfiguration: null + Symbol: '{{ Symbol }}' + Prefix: '{{ Prefix }}' + PercentageDisplayFormatConfiguration: + NegativeValueConfiguration: null + DecimalPlacesConfiguration: null + NullValueFormatConfiguration: null + Suffix: '{{ Suffix }}' + SeparatorConfiguration: null + Prefix: '{{ Prefix }}' + DateTimeFormatConfiguration: + NumericFormatConfiguration: null + NullValueFormatConfiguration: null + DateTimeFormat: '{{ DateTimeFormat }}' + StringFormatConfiguration: + NumericFormatConfiguration: null + NullValueFormatConfiguration: null + Column: null + ColorsConfiguration: + CustomColors: + - Color: '{{ Color }}' + FieldValue: '{{ FieldValue }}' + SpecialValue: '{{ SpecialValue }}' + AnalysisDefaults: + DefaultNewSheetConfiguration: + SheetContentType: '{{ SheetContentType }}' + InteractiveLayoutConfiguration: + FreeForm: + CanvasSizeOptions: + ScreenCanvasSizeOptions: + OptimizedViewPortWidth: '{{ OptimizedViewPortWidth }}' + Grid: + CanvasSizeOptions: + ScreenCanvasSizeOptions: + OptimizedViewPortWidth: '{{ OptimizedViewPortWidth }}' + ResizeOption: '{{ ResizeOption }}' + PaginatedLayoutConfiguration: + SectionBased: + CanvasSizeOptions: + PaperCanvasSizeOptions: + PaperMargin: + Left: '{{ Left }}' + Top: '{{ Top }}' + Right: '{{ Right }}' + Bottom: '{{ Bottom }}' + PaperSize: '{{ PaperSize }}' + PaperOrientation: '{{ PaperOrientation }}' + Sheets: + - Description: '{{ Description }}' + ParameterControls: + - Slider: + ParameterControlId: '{{ ParameterControlId }}' + StepSize: null + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + MaximumValue: null + MinimumValue: null + TextArea: + ParameterControlId: '{{ ParameterControlId }}' + Delimiter: '{{ Delimiter }}' + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + Dropdown: + ParameterControlId: '{{ ParameterControlId }}' + Type: null + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + CascadingControlConfiguration: + SourceControls: + - SourceSheetControlId: '{{ SourceSheetControlId }}' + ColumnToMatch: null + Title: '{{ Title }}' + CommitMode: null + SelectableValues: + LinkToDataSetColumn: null + Values: + - '{{ Values[0] }}' + TextField: + ParameterControlId: '{{ ParameterControlId }}' + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + List: + ParameterControlId: '{{ ParameterControlId }}' + Type: null + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + CascadingControlConfiguration: null + Title: '{{ Title }}' + SelectableValues: null + DateTimePicker: + ParameterControlId: '{{ ParameterControlId }}' + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + TextBoxes: + - SheetTextBoxId: '{{ SheetTextBoxId }}' + Content: '{{ Content }}' + Layouts: + - Configuration: + GridLayout: + CanvasSizeOptions: null + Elements: + - ElementType: '{{ ElementType }}' + ColumnSpan: null + ColumnIndex: null + RowIndex: null + RowSpan: null + ElementId: '{{ ElementId }}' + FreeFormLayout: + CanvasSizeOptions: null + Elements: + - ElementType: null + BorderStyle: + Color: '{{ Color }}' + Visibility: null + Height: '{{ Height }}' + Visibility: null + RenderingRules: + - Expression: '{{ Expression }}' + ConfigurationOverrides: + Visibility: null + YAxisLocation: '{{ YAxisLocation }}' + LoadingAnimation: + Visibility: null + Width: '{{ Width }}' + BackgroundStyle: + Color: '{{ Color }}' + Visibility: null + ElementId: '{{ ElementId }}' + XAxisLocation: '{{ XAxisLocation }}' + SelectedBorderStyle: null + SectionBasedLayout: + CanvasSizeOptions: null + FooterSections: + - Layout: + FreeFormLayout: + Elements: + - null + Style: + Padding: null + Height: '{{ Height }}' + SectionId: '{{ SectionId }}' + BodySections: + - Content: + Layout: null + Style: null + PageBreakConfiguration: + After: + Status: '{{ Status }}' + SectionId: '{{ SectionId }}' + HeaderSections: + - null + ContentType: null + SheetId: '{{ SheetId }}' + FilterControls: + - Slider: + FilterControlId: '{{ FilterControlId }}' + Type: null + StepSize: null + DisplayOptions: null + Title: '{{ Title }}' + MaximumValue: null + SourceFilterId: '{{ SourceFilterId }}' + MinimumValue: null + TextArea: + FilterControlId: '{{ FilterControlId }}' + Delimiter: '{{ Delimiter }}' + DisplayOptions: null + Title: '{{ Title }}' + SourceFilterId: '{{ SourceFilterId }}' + Dropdown: + FilterControlId: '{{ FilterControlId }}' + Type: null + DisplayOptions: null + CascadingControlConfiguration: null + Title: '{{ Title }}' + CommitMode: null + SourceFilterId: '{{ SourceFilterId }}' + SelectableValues: null + TextField: + FilterControlId: '{{ FilterControlId }}' + DisplayOptions: null + Title: '{{ Title }}' + SourceFilterId: '{{ SourceFilterId }}' + List: + FilterControlId: '{{ FilterControlId }}' + Type: null + DisplayOptions: null + CascadingControlConfiguration: null + Title: '{{ Title }}' + SourceFilterId: '{{ SourceFilterId }}' + SelectableValues: null + DateTimePicker: + FilterControlId: '{{ FilterControlId }}' + Type: null + DisplayOptions: null + Title: '{{ Title }}' + CommitMode: null + SourceFilterId: '{{ SourceFilterId }}' + RelativeDateTime: + FilterControlId: '{{ FilterControlId }}' + DisplayOptions: null + Title: '{{ Title }}' + CommitMode: null + SourceFilterId: '{{ SourceFilterId }}' + CrossSheet: + FilterControlId: '{{ FilterControlId }}' + CascadingControlConfiguration: null + SourceFilterId: '{{ SourceFilterId }}' + Images: + - Actions: + - Status: null + Trigger: '{{ Trigger }}' + CustomActionId: '{{ CustomActionId }}' + Name: '{{ Name }}' + ActionOperations: + - NavigationOperation: + LocalNavigationConfiguration: + TargetSheetId: '{{ TargetSheetId }}' + SetParametersOperation: + ParameterValueConfigurations: + - DestinationParameterName: '{{ DestinationParameterName }}' + Value: + CustomValuesConfiguration: + IncludeNullValue: '{{ IncludeNullValue }}' + CustomValues: + DecimalValues: + - null + IntegerValues: + - null + StringValues: + - '{{ StringValues[0] }}' + DateTimeValues: + - '{{ DateTimeValues[0] }}' + SourceParameterName: '{{ SourceParameterName }}' + SelectAllValueOptions: '{{ SelectAllValueOptions }}' + SourceField: '{{ SourceField }}' + SourceColumn: null + URLOperation: + URLTemplate: '{{ URLTemplate }}' + URLTarget: '{{ URLTarget }}' + SheetImageId: '{{ SheetImageId }}' + Tooltip: + Visibility: null + TooltipText: + PlainText: '{{ PlainText }}' + Scaling: + ScalingType: '{{ ScalingType }}' + Interactions: + ImageMenuOption: + AvailabilityStatus: null + Source: + SheetImageStaticFileSource: + StaticFileId: '{{ StaticFileId }}' + ImageContentAltText: '{{ ImageContentAltText }}' + SheetControlLayouts: + - Configuration: + GridLayout: null + Title: '{{ Title }}' + Visuals: + - FunnelChartVisual: + Subtitle: + Visibility: null + FormatText: + RichText: '{{ RichText }}' + PlainText: '{{ PlainText }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategoryItemsLimit: + ItemsLimit: null + OtherCategories: '{{ OtherCategories }}' + CategorySort: + - FieldSort: + FieldId: '{{ FieldId }}' + Direction: null + ColumnSort: + AggregationFunction: null + SortBy: null + Direction: null + DataLabelOptions: + MeasureLabelVisibility: null + Position: '{{ Position }}' + Visibility: null + CategoryLabelVisibility: null + LabelColor: '{{ LabelColor }}' + MeasureDataLabelStyle: '{{ MeasureDataLabelStyle }}' + LabelFontConfiguration: null + CategoryLabelOptions: + Visibility: null + SortIconVisibility: null + AxisLabelOptions: + - CustomLabel: '{{ CustomLabel }}' + ApplyTo: + Column: null + FieldId: '{{ FieldId }}' + FontConfiguration: null + FieldWells: + FunnelChartAggregatedFieldWells: + Category: + - DateDimensionField: + HierarchyId: '{{ HierarchyId }}' + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + DateGranularity: null + NumericalDimensionField: + HierarchyId: '{{ HierarchyId }}' + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + CategoricalDimensionField: + HierarchyId: '{{ HierarchyId }}' + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + Values: + - DateMeasureField: + AggregationFunction: null + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + NumericalMeasureField: + AggregationFunction: null + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + CategoricalMeasureField: + AggregationFunction: null + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + CalculatedMeasureField: + Expression: '{{ Expression }}' + FieldId: '{{ FieldId }}' + Tooltip: + SelectedTooltipType: '{{ SelectedTooltipType }}' + TooltipVisibility: null + FieldBasedTooltip: + TooltipFields: + - FieldTooltipItem: + TooltipTarget: '{{ TooltipTarget }}' + FieldId: '{{ FieldId }}' + Label: '{{ Label }}' + Visibility: null + ColumnTooltipItem: + Aggregation: null + TooltipTarget: null + Column: null + Label: '{{ Label }}' + Visibility: null + AggregationVisibility: null + TooltipTitleType: '{{ TooltipTitleType }}' + ValueLabelOptions: null + VisualPalette: + ChartColor: '{{ ChartColor }}' + ColorMap: + - Element: + DataPathType: + PivotTableDataPathType: '{{ PivotTableDataPathType }}' + FieldId: '{{ FieldId }}' + FieldValue: '{{ FieldValue }}' + Color: '{{ Color }}' + TimeGranularity: null + Actions: + - Status: null + Trigger: '{{ Trigger }}' + CustomActionId: '{{ CustomActionId }}' + Name: '{{ Name }}' + ActionOperations: + - NavigationOperation: null + SetParametersOperation: null + FilterOperation: + SelectedFieldsConfiguration: + SelectedColumns: + - null + SelectedFields: + - '{{ SelectedFields[0] }}' + SelectedFieldOptions: '{{ SelectedFieldOptions }}' + TargetVisualsConfiguration: + SameSheetTargetVisualConfiguration: + TargetVisualOptions: '{{ TargetVisualOptions }}' + TargetVisuals: + - '{{ TargetVisuals[0] }}' + URLOperation: null + Title: + Visibility: null + FormatText: + RichText: '{{ RichText }}' + PlainText: '{{ PlainText }}' + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - DateTimeHierarchy: + HierarchyId: '{{ HierarchyId }}' + DrillDownFilters: + - NumericEqualityFilter: + Column: null + Value: null + TimeRangeFilter: + Column: null + RangeMinimum: '{{ RangeMinimum }}' + TimeGranularity: null + RangeMaximum: '{{ RangeMaximum }}' + CategoryFilter: + Column: null + CategoryValues: + - '{{ CategoryValues[0] }}' + ExplicitHierarchy: + HierarchyId: '{{ HierarchyId }}' + DrillDownFilters: + - null + Columns: + - null + PredefinedHierarchy: + HierarchyId: '{{ HierarchyId }}' + DrillDownFilters: + - null + Columns: + - null + BoxPlotVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategorySort: + - null + PaginationConfiguration: + PageSize: null + PageNumber: null + Legend: + Position: '{{ Position }}' + ValueFontConfiguration: null + Title: null + Visibility: null + Height: '{{ Height }}' + Width: '{{ Width }}' + ReferenceLines: + - Status: null + DataConfiguration: + DynamicConfiguration: + Column: null + MeasureAggregationFunction: null + Calculation: null + AxisBinding: '{{ AxisBinding }}' + SeriesType: '{{ SeriesType }}' + StaticConfiguration: + Value: null + LabelConfiguration: + HorizontalPosition: '{{ HorizontalPosition }}' + ValueLabelConfiguration: + FormatConfiguration: null + RelativePosition: '{{ RelativePosition }}' + CustomLabelConfiguration: + CustomLabel: '{{ CustomLabel }}' + FontColor: '{{ FontColor }}' + FontConfiguration: null + VerticalPosition: '{{ VerticalPosition }}' + StyleConfiguration: + Pattern: '{{ Pattern }}' + Color: '{{ Color }}' + CategoryAxis: + DataOptions: + DateAxisOptions: + MissingDateVisibility: null + NumericAxisOptions: + Scale: + Logarithmic: + Base: null + Linear: + StepSize: null + StepCount: null + Range: + DataDriven: {} + MinMax: + Minimum: null + Maximum: null + TickLabelOptions: + RotationAngle: null + LabelOptions: null + AxisOffset: '{{ AxisOffset }}' + AxisLineVisibility: null + GridLineVisibility: null + ScrollbarOptions: + VisibleRange: + PercentRange: + From: null + To: null + Visibility: null + PrimaryYAxisLabelOptions: null + CategoryLabelOptions: null + FieldWells: + BoxPlotAggregatedFieldWells: + GroupBy: + - null + Values: + - null + Tooltip: null + BoxPlotOptions: + StyleOptions: + FillStyle: '{{ FillStyle }}' + OutlierVisibility: null + AllDataPointsVisibility: null + PrimaryYAxisDisplayOptions: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + GeospatialMapVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + Legend: null + MapStyleOptions: + BaseMapStyle: '{{ BaseMapStyle }}' + FieldWells: + GeospatialMapAggregatedFieldWells: + Colors: + - null + Values: + - null + Geospatial: + - null + Tooltip: null + WindowOptions: + Bounds: + West: null + South: null + North: null + East: null + MapZoomMode: '{{ MapZoomMode }}' + PointStyleOptions: + SelectedPointStyle: '{{ SelectedPointStyle }}' + ClusterMarkerConfiguration: + ClusterMarker: + SimpleClusterMarker: + Color: '{{ Color }}' + HeatmapConfiguration: + HeatmapColor: + Colors: + - Color: '{{ Color }}' + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + ScatterPlotVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + YAxisLabelOptions: null + Legend: null + YAxisDisplayOptions: null + DataLabels: + DataLabelTypes: + - MaximumLabelType: + Visibility: null + DataPathLabelType: + FieldId: '{{ FieldId }}' + Visibility: null + FieldValue: '{{ FieldValue }}' + RangeEndsLabelType: + Visibility: null + FieldLabelType: + FieldId: '{{ FieldId }}' + Visibility: null + MinimumLabelType: + Visibility: null + MeasureLabelVisibility: null + Position: null + LabelContent: '{{ LabelContent }}' + Visibility: null + TotalsVisibility: null + Overlap: '{{ Overlap }}' + CategoryLabelVisibility: null + LabelColor: '{{ LabelColor }}' + LabelFontConfiguration: null + FieldWells: + ScatterPlotUnaggregatedFieldWells: + Category: + - null + Size: + - null + Label: + - null + XAxis: + - null + YAxis: + - null + ScatterPlotCategoricallyAggregatedFieldWells: + Category: + - null + Size: + - null + Label: + - null + XAxis: + - null + YAxis: + - null + Tooltip: null + XAxisLabelOptions: null + VisualPalette: null + XAxisDisplayOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + RadarChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + ColorSort: + - null + ColorItemsLimit: null + CategoryItemsLimit: null + CategorySort: + - null + Legend: null + Shape: '{{ Shape }}' + BaseSeriesSettings: + AreaStyleSettings: + Visibility: null + ColorLabelOptions: null + CategoryLabelOptions: null + AxesRangeScale: '{{ AxesRangeScale }}' + VisualPalette: null + AlternateBandColorsVisibility: null + StartAngle: null + CategoryAxis: null + FieldWells: + RadarChartAggregatedFieldWells: + Category: + - null + Color: + - null + Values: + - null + ColorAxis: null + AlternateBandOddColor: '{{ AlternateBandOddColor }}' + AlternateBandEvenColor: '{{ AlternateBandEvenColor }}' + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + ComboChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + ColorSort: + - null + ColorItemsLimit: null + CategoryItemsLimit: null + CategorySort: + - null + Legend: null + ReferenceLines: + - null + ColorLabelOptions: null + BarDataLabels: null + CategoryLabelOptions: null + Tooltip: null + SingleAxisOptions: + YAxisOptions: + YAxis: '{{ YAxis }}' + PrimaryYAxisDisplayOptions: null + VisualPalette: null + BarsArrangement: '{{ BarsArrangement }}' + SecondaryYAxisLabelOptions: null + LineDataLabels: null + CategoryAxis: null + PrimaryYAxisLabelOptions: null + FieldWells: + ComboChartAggregatedFieldWells: + BarValues: + - null + Category: + - null + Colors: + - null + LineValues: + - null + SecondaryYAxisDisplayOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + WordCloudVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategoryItemsLimit: null + CategorySort: + - null + CategoryLabelOptions: null + FieldWells: + WordCloudAggregatedFieldWells: + GroupBy: + - null + Size: + - null + WordCloudOptions: + WordOrientation: '{{ WordOrientation }}' + WordScaling: '{{ WordScaling }}' + CloudLayout: '{{ CloudLayout }}' + MaximumStringLength: null + WordCasing: '{{ WordCasing }}' + WordPadding: '{{ WordPadding }}' + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + SankeyDiagramVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + WeightSort: + - null + SourceItemsLimit: null + DestinationItemsLimit: null + DataLabels: null + FieldWells: + SankeyDiagramAggregatedFieldWells: + Destination: + - null + Source: + - null + Weight: + - null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + GaugeChartVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Arc: + ForegroundColor: + Gradient: + Expression: '{{ Expression }}' + Color: + Stops: + - GradientOffset: null + DataValue: null + Color: '{{ Color }}' + Solid: + Expression: '{{ Expression }}' + Color: '{{ Color }}' + PrimaryValue: + TextColor: null + Icon: + CustomCondition: + Expression: '{{ Expression }}' + Color: '{{ Color }}' + DisplayConfiguration: + IconDisplayOption: '{{ IconDisplayOption }}' + IconOptions: + UnicodeIcon: '{{ UnicodeIcon }}' + Icon: '{{ Icon }}' + IconSet: + Expression: '{{ Expression }}' + IconSetType: '{{ IconSetType }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + DataLabels: null + FieldWells: + TargetValues: + - null + Values: + - null + TooltipOptions: null + GaugeChartOptions: + Arc: + ArcAngle: null + ArcThickness: '{{ ArcThickness }}' + Comparison: + ComparisonMethod: '{{ ComparisonMethod }}' + ComparisonFormat: + NumberDisplayFormatConfiguration: null + PercentageDisplayFormatConfiguration: null + PrimaryValueDisplayType: '{{ PrimaryValueDisplayType }}' + ArcAxis: + Range: + Min: null + Max: null + ReserveRange: null + PrimaryValueFontConfiguration: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + FilledMapVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Shape: + Format: + BackgroundColor: null + FieldId: '{{ FieldId }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategorySort: + - null + Legend: null + MapStyleOptions: null + FieldWells: + FilledMapAggregatedFieldWells: + Values: + - null + Geospatial: + - null + Tooltip: null + WindowOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + WaterfallVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + CategoryAxisLabelOptions: null + SortConfiguration: + BreakdownItemsLimit: null + CategorySort: + - null + Legend: null + DataLabels: null + PrimaryYAxisLabelOptions: null + FieldWells: + WaterfallChartAggregatedFieldWells: + Categories: + - null + Breakdowns: + - null + Values: + - null + WaterfallChartOptions: + TotalBarLabel: '{{ TotalBarLabel }}' + ColorConfiguration: + GroupColorConfiguration: + NegativeBarColor: '{{ NegativeBarColor }}' + TotalBarColor: '{{ TotalBarColor }}' + PositiveBarColor: '{{ PositiveBarColor }}' + CategoryAxisDisplayOptions: null + PrimaryYAxisDisplayOptions: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + CustomContentVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + ContentUrl: '{{ ContentUrl }}' + ContentType: '{{ ContentType }}' + ImageScaling: '{{ ImageScaling }}' + Actions: + - null + DataSetIdentifier: '{{ DataSetIdentifier }}' + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + PieChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + SmallMultiplesSort: + - null + CategoryItemsLimit: null + CategorySort: + - null + SmallMultiplesLimitConfiguration: null + Legend: null + DataLabels: null + ContributionAnalysisDefaults: + - MeasureFieldId: '{{ MeasureFieldId }}' + ContributorDimensions: + - null + CategoryLabelOptions: null + FieldWells: + PieChartAggregatedFieldWells: + Category: + - null + Values: + - null + SmallMultiples: + - null + Tooltip: null + DonutOptions: + DonutCenterOptions: + LabelVisibility: null + ArcOptions: + ArcThickness: '{{ ArcThickness }}' + SmallMultiplesOptions: + MaxVisibleRows: null + PanelConfiguration: + BorderThickness: '{{ BorderThickness }}' + BorderStyle: '{{ BorderStyle }}' + GutterSpacing: '{{ GutterSpacing }}' + BackgroundVisibility: null + BorderVisibility: null + BorderColor: '{{ BorderColor }}' + Title: + Visibility: null + FontConfiguration: null + HorizontalTextAlignment: '{{ HorizontalTextAlignment }}' + GutterVisibility: null + BackgroundColor: '{{ BackgroundColor }}' + MaxVisibleColumns: null + XAxis: + Placement: '{{ Placement }}' + Scale: '{{ Scale }}' + YAxis: null + ValueLabelOptions: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + KPIVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - PrimaryValue: + TextColor: null + Icon: null + ActualValue: + TextColor: null + Icon: null + ComparisonValue: + TextColor: null + Icon: null + ProgressBar: + ForegroundColor: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + TrendGroupSort: + - null + KPIOptions: + SecondaryValueFontConfiguration: null + VisualLayoutOptions: + StandardLayout: + Type: '{{ Type }}' + TrendArrows: + Visibility: null + SecondaryValue: + Visibility: null + Comparison: null + PrimaryValueDisplayType: null + ProgressBar: + Visibility: null + PrimaryValueFontConfiguration: null + Sparkline: + Type: '{{ Type }}' + Color: '{{ Color }}' + TooltipVisibility: null + Visibility: null + FieldWells: + TargetValues: + - null + TrendGroups: + - null + Values: + - null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + HistogramVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + YAxisDisplayOptions: null + DataLabels: null + BinOptions: + BinWidth: + BinCountLimit: null + Value: null + StartValue: null + SelectedBinType: '{{ SelectedBinType }}' + BinCount: + Value: null + FieldWells: + HistogramAggregatedFieldWells: + Values: + - null + Tooltip: null + XAxisLabelOptions: null + VisualPalette: null + XAxisDisplayOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + PluginVisual: + Subtitle: null + PluginArn: '{{ PluginArn }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + PluginVisualTableQuerySort: + ItemsLimitConfiguration: + ItemsLimit: null + RowSort: + - null + VisualOptions: + VisualProperties: + - Value: '{{ Value }}' + Name: '{{ Name }}' + FieldWells: + - Unaggregated: + - FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + AxisName: '{{ AxisName }}' + Measures: + - null + Dimensions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + TableVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Row: + TextColor: null + BackgroundColor: null + Cell: + FieldId: '{{ FieldId }}' + TextFormat: + TextColor: null + Icon: null + BackgroundColor: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + RowSort: + - null + PaginationConfiguration: null + PaginatedReportOptions: + OverflowColumnHeaderVisibility: null + VerticalOverflowVisibility: null + TableOptions: + HeaderStyle: + VerticalTextAlignment: '{{ VerticalTextAlignment }}' + Visibility: null + Height: null + FontConfiguration: null + Border: + UniformBorder: + Thickness: null + Color: '{{ Color }}' + Style: '{{ Style }}' + SideSpecificBorder: + Left: null + Top: null + InnerHorizontal: null + Right: null + Bottom: null + InnerVertical: null + TextWrap: '{{ TextWrap }}' + HorizontalTextAlignment: null + BackgroundColor: '{{ BackgroundColor }}' + CellStyle: null + Orientation: '{{ Orientation }}' + RowAlternateColorOptions: + Status: null + UsePrimaryBackgroundColor: null + RowAlternateColors: + - '{{ RowAlternateColors[0] }}' + TableInlineVisualizations: + - DataBars: + PositiveColor: '{{ PositiveColor }}' + FieldId: '{{ FieldId }}' + NegativeColor: '{{ NegativeColor }}' + FieldWells: + TableUnaggregatedFieldWells: + Values: + - null + TableAggregatedFieldWells: + GroupBy: + - null + Values: + - null + FieldOptions: + Order: + - '{{ Order[0] }}' + PinnedFieldOptions: + PinnedLeftFields: + - '{{ PinnedLeftFields[0] }}' + SelectedFieldOptions: + - CustomLabel: '{{ CustomLabel }}' + URLStyling: + LinkConfiguration: + Target: null + Content: + CustomIconContent: + Icon: '{{ Icon }}' + CustomTextContent: + Value: '{{ Value }}' + FontConfiguration: null + ImageConfiguration: + SizingOptions: + TableCellImageScalingConfiguration: '{{ TableCellImageScalingConfiguration }}' + FieldId: '{{ FieldId }}' + Visibility: null + Width: '{{ Width }}' + TotalOptions: + TotalAggregationOptions: + - TotalAggregationFunction: + SimpleTotalAggregationFunction: '{{ SimpleTotalAggregationFunction }}' + FieldId: '{{ FieldId }}' + CustomLabel: '{{ CustomLabel }}' + ScrollStatus: '{{ ScrollStatus }}' + Placement: '{{ Placement }}' + TotalCellStyle: null + TotalsVisibility: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + PivotTableVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Cell: + Scope: + Role: '{{ Role }}' + Scopes: + - null + FieldId: '{{ FieldId }}' + TextFormat: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + FieldSortOptions: + - SortBy: + Field: null + DataPath: + SortPaths: + - null + Direction: null + Column: null + FieldId: '{{ FieldId }}' + PaginatedReportOptions: + OverflowColumnHeaderVisibility: null + VerticalOverflowVisibility: null + TableOptions: + RowFieldNamesStyle: null + RowHeaderStyle: null + CollapsedRowDimensionsVisibility: null + RowsLayout: '{{ RowsLayout }}' + MetricPlacement: '{{ MetricPlacement }}' + DefaultCellWidth: '{{ DefaultCellWidth }}' + ColumnNamesVisibility: null + RowsLabelOptions: + CustomLabel: '{{ CustomLabel }}' + Visibility: null + SingleMetricVisibility: null + ColumnHeaderStyle: null + ToggleButtonsVisibility: null + CellStyle: null + RowAlternateColorOptions: null + FieldWells: + PivotTableAggregatedFieldWells: + Values: + - null + Columns: + - null + Rows: + - null + FieldOptions: + CollapseStateOptions: + - Target: + FieldId: '{{ FieldId }}' + FieldDataPathValues: + - null + State: '{{ State }}' + DataPathOptions: + - DataPathList: + - null + Width: '{{ Width }}' + SelectedFieldOptions: + - CustomLabel: '{{ CustomLabel }}' + FieldId: '{{ FieldId }}' + Visibility: null + TotalOptions: + ColumnSubtotalOptions: + CustomLabel: '{{ CustomLabel }}' + FieldLevelOptions: + - FieldId: '{{ FieldId }}' + ValueCellStyle: null + TotalCellStyle: null + TotalsVisibility: null + FieldLevel: '{{ FieldLevel }}' + MetricHeaderCellStyle: null + StyleTargets: + - CellType: '{{ CellType }}' + RowSubtotalOptions: null + RowTotalOptions: + TotalAggregationOptions: + - null + CustomLabel: '{{ CustomLabel }}' + ValueCellStyle: null + ScrollStatus: null + Placement: null + TotalCellStyle: null + TotalsVisibility: null + MetricHeaderCellStyle: null + ColumnTotalOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + BarChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + SmallMultiplesSort: + - null + ColorSort: + - null + ColorItemsLimit: null + CategoryItemsLimit: null + CategorySort: + - null + SmallMultiplesLimitConfiguration: null + Legend: null + ReferenceLines: + - null + DataLabels: null + ColorLabelOptions: null + CategoryLabelOptions: null + Tooltip: null + SmallMultiplesOptions: null + Orientation: '{{ Orientation }}' + VisualPalette: null + ValueLabelOptions: null + BarsArrangement: null + CategoryAxis: null + ContributionAnalysisDefaults: + - null + FieldWells: + BarChartAggregatedFieldWells: + Category: + - null + Colors: + - null + Values: + - null + SmallMultiples: + - null + ValueAxis: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + HeatMapVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + HeatMapRowSort: + - null + HeatMapRowItemsLimitConfiguration: null + HeatMapColumnItemsLimitConfiguration: null + HeatMapColumnSort: + - null + ColumnLabelOptions: null + Legend: null + DataLabels: null + FieldWells: + HeatMapAggregatedFieldWells: + Values: + - null + Columns: + - null + Rows: + - null + Tooltip: null + ColorScale: + Colors: + - DataValue: null + Color: '{{ Color }}' + ColorFillType: '{{ ColorFillType }}' + NullValueColor: null + RowLabelOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + TreeMapVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + TreeMapSort: + - null + TreeMapGroupItemsLimitConfiguration: null + Legend: null + DataLabels: null + ColorLabelOptions: null + SizeLabelOptions: null + FieldWells: + TreeMapAggregatedFieldWells: + Sizes: + - null + Colors: + - null + Groups: + - null + Tooltip: null + ColorScale: null + GroupLabelOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + InsightVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + Actions: + - null + DataSetIdentifier: '{{ DataSetIdentifier }}' + InsightConfiguration: + Computations: + - PeriodToDate: + PeriodTimeGranularity: null + Value: null + Time: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + GrowthRate: + Value: null + Time: null + PeriodSize: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + TopBottomRanked: + Type: '{{ Type }}' + Category: null + ResultSize: null + Value: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + TotalAggregation: + Value: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + Forecast: + PeriodsBackward: null + PeriodsForward: null + PredictionInterval: null + Seasonality: '{{ Seasonality }}' + CustomSeasonalityValue: null + Value: null + Time: null + UpperBoundary: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + LowerBoundary: null + MaximumMinimum: + Type: '{{ Type }}' + Value: null + Time: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + PeriodOverPeriod: + Value: null + Time: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + MetricComparison: + TargetValue: null + Time: null + ComputationId: '{{ ComputationId }}' + FromValue: null + Name: '{{ Name }}' + TopBottomMovers: + Type: null + Category: null + Value: null + SortOrder: '{{ SortOrder }}' + Time: null + MoverSize: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + UniqueValues: + Category: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + CustomNarrative: + Narrative: '{{ Narrative }}' + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + LineChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategoryItemsLimitConfiguration: null + ColorItemsLimitConfiguration: null + SmallMultiplesSort: + - null + CategorySort: + - null + SmallMultiplesLimitConfiguration: null + Legend: null + ReferenceLines: + - null + DataLabels: null + Tooltip: null + SingleAxisOptions: null + SmallMultiplesOptions: null + PrimaryYAxisDisplayOptions: + MissingDataConfigurations: + - TreatmentOption: '{{ TreatmentOption }}' + AxisOptions: null + VisualPalette: null + XAxisDisplayOptions: null + DefaultSeriesSettings: + LineStyleSettings: + LineInterpolation: '{{ LineInterpolation }}' + LineStyle: '{{ LineStyle }}' + LineVisibility: null + LineWidth: '{{ LineWidth }}' + AxisBinding: null + MarkerStyleSettings: + MarkerShape: '{{ MarkerShape }}' + MarkerSize: '{{ MarkerSize }}' + MarkerVisibility: null + MarkerColor: '{{ MarkerColor }}' + SecondaryYAxisLabelOptions: null + ForecastConfigurations: + - ForecastProperties: + PeriodsBackward: null + PeriodsForward: null + PredictionInterval: null + Seasonality: null + UpperBoundary: null + LowerBoundary: null + Scenario: + WhatIfRangeScenario: + StartDate: '{{ StartDate }}' + Value: null + EndDate: '{{ EndDate }}' + WhatIfPointScenario: + Value: null + Date: '{{ Date }}' + Series: + - FieldSeriesItem: + FieldId: '{{ FieldId }}' + AxisBinding: null + Settings: + LineStyleSettings: null + MarkerStyleSettings: null + DataFieldSeriesItem: + FieldId: '{{ FieldId }}' + AxisBinding: null + FieldValue: '{{ FieldValue }}' + Settings: null + Type: '{{ Type }}' + PrimaryYAxisLabelOptions: null + ContributionAnalysisDefaults: + - null + FieldWells: + LineChartAggregatedFieldWells: + Category: + - null + Colors: + - null + Values: + - null + SmallMultiples: + - null + SecondaryYAxisDisplayOptions: null + XAxisLabelOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + EmptyVisual: + VisualId: '{{ VisualId }}' + Actions: + - null + DataSetIdentifier: '{{ DataSetIdentifier }}' + Name: '{{ Name }}' + ParameterDeclarations: + - StringParameterDeclaration: + MappedDataSetParameters: + - DataSetParameterName: '{{ DataSetParameterName }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + DefaultValues: + DynamicValue: + GroupNameColumn: null + DefaultValueColumn: null + UserNameColumn: null + StaticValues: + - '{{ StaticValues[0] }}' + ParameterValueType: '{{ ParameterValueType }}' + ValueWhenUnset: + ValueWhenUnsetOption: '{{ ValueWhenUnsetOption }}' + CustomValue: '{{ CustomValue }}' + Name: '{{ Name }}' + DateTimeParameterDeclaration: + MappedDataSetParameters: + - null + DefaultValues: + RollingDate: null + DynamicValue: null + StaticValues: + - '{{ StaticValues[0] }}' + TimeGranularity: null + ValueWhenUnset: + ValueWhenUnsetOption: null + CustomValue: '{{ CustomValue }}' + Name: '{{ Name }}' + DecimalParameterDeclaration: + MappedDataSetParameters: + - null + DefaultValues: + DynamicValue: null + StaticValues: + - null + ParameterValueType: null + ValueWhenUnset: + ValueWhenUnsetOption: null + CustomValue: null + Name: '{{ Name }}' + IntegerParameterDeclaration: + MappedDataSetParameters: + - null + DefaultValues: + DynamicValue: null + StaticValues: + - null + ParameterValueType: null + ValueWhenUnset: + ValueWhenUnsetOption: null + CustomValue: null + Name: '{{ Name }}' + - name: ValidationStrategy + value: + Mode: '{{ Mode }}' + - name: FolderArns + value: + - '{{ FolderArns[0] }}' + - name: Name + value: '{{ Name }}' + - name: Errors + value: + - Type: '{{ Type }}' + Message: '{{ Message }}' + ViolatedEntities: + - Path: '{{ Path }}' + - name: AnalysisId + value: '{{ AnalysisId }}' + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: Permissions + value: + - Principal: '{{ Principal }}' + Actions: + - '{{ Actions[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Sheets + value: + - SheetId: '{{ SheetId }}' + Images: + - null + Name: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.analyses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the analyses resource, the following permissions are required: + +### Read +```json +quicksight:DescribeAnalysis, +quicksight:DescribeAnalysisPermissions, +quicksight:ListTagsForResource +``` + +### Create +```json +quicksight:DescribeAnalysis, +quicksight:DescribeAnalysisPermissions, +quicksight:CreateAnalysis, +quicksight:DescribeTemplate, +quicksight:DescribeTheme, +quicksight:PassDataSet, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource, +quicksight:CreateFolderMembership, +quicksight:DeleteFolderMembership, +quicksight:ListFoldersForResource +``` + +### Update +```json +quicksight:DescribeAnalysis, +quicksight:DescribeAnalysisPermissions, +quicksight:UpdateAnalysis, +quicksight:UpdateAnalysisPermissions, +quicksight:CreateFolderMembership, +quicksight:DeleteFolderMembership, +quicksight:ListFoldersForResource, +quicksight:DescribeTemplate, +quicksight:DescribeTheme, +quicksight:PassDataSet, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### List +```json +quicksight:ListAnalyses +``` + +### Delete +```json +quicksight:DescribeAnalysis, +quicksight:DeleteAnalysis +``` diff --git a/website/docs/services/quicksight/analyses_list_only/index.md b/website/docs/services/quicksight/analyses_list_only/index.md new file mode 100644 index 0000000..597f821 --- /dev/null +++ b/website/docs/services/quicksight/analyses_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: analyses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - analyses_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists analyses in a region or regions, for all properties use analyses + +## Overview + + + + + + + +
Nameanalyses_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Analysis Resource Type.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all analyses in a region. +```sql +SELECT +region, +analysis_id, +aws_account_id +FROM aws.quicksight.analyses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analyses_list_only resource, see analyses + diff --git a/website/docs/services/quicksight/analysis_tags/index.md b/website/docs/services/quicksight/analysis_tags/index.md new file mode 100644 index 0000000..0a2fd0f --- /dev/null +++ b/website/docs/services/quicksight/analysis_tags/index.md @@ -0,0 +1,109 @@ +--- +title: analysis_tags +hide_title: false +hide_table_of_contents: false +keywords: + - analysis_tags + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for analyses in a region + +## Overview + + + + + + + +
Nameanalysis_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::Analysis Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string

The time that the analysis was created.

object

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

array

The ARNs of the datasets of the analysis.

object

The source entity of an analysis.

string

The ARN of the theme of the analysis.

object
string

The time that the analysis was last updated.

object

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

array
string

The descriptive name of the analysis.

array

Errors associated with the analysis.

string
string
array
string

The Amazon Resource Name (ARN) of the analysis.

array

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

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all analyses in a region. +```sql +SELECT +region, +status, +created_time, +parameters, +data_set_arns, +source_entity, +theme_arn, +definition, +last_updated_time, +validation_strategy, +folder_arns, +name, +errors, +analysis_id, +aws_account_id, +permissions, +arn, +sheets, +tag_key, +tag_value +FROM aws.quicksight.analysis_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analysis_tags resource, see analyses + diff --git a/website/docs/services/quicksight/custom_permissions/index.md b/website/docs/services/quicksight/custom_permissions/index.md new file mode 100644 index 0000000..d77f3f4 --- /dev/null +++ b/website/docs/services/quicksight/custom_permissions/index.md @@ -0,0 +1,244 @@ +--- +title: custom_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - custom_permissions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a custom_permission resource or lists custom_permissions in a region + +## Overview + + + + + + + +
Namecustom_permissions
TypeResource
DescriptionDefinition of the AWS::QuickSight::CustomPermissions Resource Type.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
array
stringAWS region.
+ +For more information, see AWS::QuickSight::CustomPermissions. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all custom_permissions in a region. +```sql +SELECT +region, +arn, +aws_account_id, +capabilities, +custom_permissions_name, +tags +FROM aws.quicksight.custom_permissions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual custom_permission. +```sql +SELECT +region, +arn, +aws_account_id, +capabilities, +custom_permissions_name, +tags +FROM aws.quicksight.custom_permissions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new custom_permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.custom_permissions ( + AwsAccountId, + CustomPermissionsName, + region +) +SELECT +'{{ AwsAccountId }}', + '{{ CustomPermissionsName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.custom_permissions ( + AwsAccountId, + Capabilities, + CustomPermissionsName, + Tags, + region +) +SELECT + '{{ AwsAccountId }}', + '{{ Capabilities }}', + '{{ CustomPermissionsName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: custom_permission + props: + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: Capabilities + value: + ExportToCsv: '{{ ExportToCsv }}' + ExportToExcel: null + CreateAndUpdateThemes: null + AddOrRunAnomalyDetectionForAnalyses: null + ShareAnalyses: null + CreateAndUpdateDatasets: null + ShareDatasets: null + SubscribeDashboardEmailReports: null + CreateAndUpdateDashboardEmailReports: null + ShareDashboards: null + CreateAndUpdateThresholdAlerts: null + RenameSharedFolders: null + CreateSharedFolders: null + CreateAndUpdateDataSources: null + ShareDataSources: null + ViewAccountSPICECapacity: null + CreateSPICEDataset: null + - name: CustomPermissionsName + value: '{{ CustomPermissionsName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.custom_permissions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the custom_permissions resource, the following permissions are required: + +### Create +```json +quicksight:CreateCustomPermissions, +quicksight:TagResource +``` + +### Read +```json +quicksight:DescribeCustomPermissions, +quicksight:ListTagsForResource +``` + +### Update +```json +quicksight:UpdateCustomPermissions, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### Delete +```json +quicksight:DeleteCustomPermissions +``` + +### List +```json +quicksight:ListCustomPermissions +``` diff --git a/website/docs/services/quicksight/custom_permissions_list_only/index.md b/website/docs/services/quicksight/custom_permissions_list_only/index.md new file mode 100644 index 0000000..336f36c --- /dev/null +++ b/website/docs/services/quicksight/custom_permissions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: custom_permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_permissions_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_permissions in a region or regions, for all properties use custom_permissions + +## Overview + + + + + + + +
Namecustom_permissions_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::CustomPermissions Resource Type.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_permissions in a region. +```sql +SELECT +region, +aws_account_id, +custom_permissions_name +FROM aws.quicksight.custom_permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_permissions_list_only resource, see custom_permissions + diff --git a/website/docs/services/quicksight/custom_permissions_tags/index.md b/website/docs/services/quicksight/custom_permissions_tags/index.md new file mode 100644 index 0000000..b2acc3c --- /dev/null +++ b/website/docs/services/quicksight/custom_permissions_tags/index.md @@ -0,0 +1,83 @@ +--- +title: custom_permissions_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_permissions_tags + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_permissions in a region + +## Overview + + + + + + + +
Namecustom_permissions_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::CustomPermissions Resource Type.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_permissions in a region. +```sql +SELECT +region, +arn, +aws_account_id, +capabilities, +custom_permissions_name, +tag_key, +tag_value +FROM aws.quicksight.custom_permissions_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_permissions_tags resource, see custom_permissions + diff --git a/website/docs/services/quicksight/dashboard_tags/index.md b/website/docs/services/quicksight/dashboard_tags/index.md new file mode 100644 index 0000000..a4eca45 --- /dev/null +++ b/website/docs/services/quicksight/dashboard_tags/index.md @@ -0,0 +1,113 @@ +--- +title: dashboard_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dashboard_tags + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dashboards in a region + +## Overview + + + + + + + +
Namedashboard_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::Dashboard Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The time that this dashboard was created.

object

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

string
object

Dashboard source entity.

string
object
string

The last time that this dashboard was updated.

object

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

array
string
object
string
object

Dashboard publish options.

string

The last time that this dashboard was published.

object

Dashboard version.

string
array
array
string

The Amazon Resource Name (ARN) of the resource.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dashboards in a region. +```sql +SELECT +region, +created_time, +parameters, +version_description, +source_entity, +theme_arn, +definition, +last_updated_time, +validation_strategy, +folder_arns, +dashboard_id, +link_sharing_configuration, +name, +dashboard_publish_options, +last_published_time, +version, +aws_account_id, +permissions, +link_entities, +arn, +tag_key, +tag_value +FROM aws.quicksight.dashboard_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboard_tags resource, see dashboards + diff --git a/website/docs/services/quicksight/dashboards/index.md b/website/docs/services/quicksight/dashboards/index.md new file mode 100644 index 0000000..725b8c3 --- /dev/null +++ b/website/docs/services/quicksight/dashboards/index.md @@ -0,0 +1,2223 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dashboard resource or lists dashboards in a region + +## Overview + + + + + + + +
Namedashboards
TypeResource
DescriptionDefinition of the AWS::QuickSight::Dashboard Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The time that this dashboard was created.

object

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

string
object

Dashboard source entity.

string
object
string

The last time that this dashboard was updated.

object

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

array
string
object
string
object

Dashboard publish options.

string

The last time that this dashboard was published.

object

Dashboard version.

string
array
array
string

The Amazon Resource Name (ARN) of the resource.

array
stringAWS region.
+ +For more information, see AWS::QuickSight::Dashboard. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dashboards in a region. +```sql +SELECT +region, +created_time, +parameters, +version_description, +source_entity, +theme_arn, +definition, +last_updated_time, +validation_strategy, +folder_arns, +dashboard_id, +link_sharing_configuration, +name, +dashboard_publish_options, +last_published_time, +version, +aws_account_id, +permissions, +link_entities, +arn, +tags +FROM aws.quicksight.dashboards +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dashboard. +```sql +SELECT +region, +created_time, +parameters, +version_description, +source_entity, +theme_arn, +definition, +last_updated_time, +validation_strategy, +folder_arns, +dashboard_id, +link_sharing_configuration, +name, +dashboard_publish_options, +last_published_time, +version, +aws_account_id, +permissions, +link_entities, +arn, +tags +FROM aws.quicksight.dashboards +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dashboard resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.dashboards ( + DashboardId, + Name, + AwsAccountId, + region +) +SELECT +'{{ DashboardId }}', + '{{ Name }}', + '{{ AwsAccountId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.dashboards ( + Parameters, + VersionDescription, + SourceEntity, + ThemeArn, + Definition, + ValidationStrategy, + FolderArns, + DashboardId, + LinkSharingConfiguration, + Name, + DashboardPublishOptions, + AwsAccountId, + Permissions, + LinkEntities, + Tags, + region +) +SELECT + '{{ Parameters }}', + '{{ VersionDescription }}', + '{{ SourceEntity }}', + '{{ ThemeArn }}', + '{{ Definition }}', + '{{ ValidationStrategy }}', + '{{ FolderArns }}', + '{{ DashboardId }}', + '{{ LinkSharingConfiguration }}', + '{{ Name }}', + '{{ DashboardPublishOptions }}', + '{{ AwsAccountId }}', + '{{ Permissions }}', + '{{ LinkEntities }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dashboard + props: + - name: Parameters + value: + StringParameters: + - Values: + - '{{ Values[0] }}' + Name: '{{ Name }}' + DecimalParameters: + - Values: + - null + Name: '{{ Name }}' + IntegerParameters: + - Values: + - null + Name: '{{ Name }}' + DateTimeParameters: + - Values: + - '{{ Values[0] }}' + Name: '{{ Name }}' + - name: VersionDescription + value: '{{ VersionDescription }}' + - name: SourceEntity + value: + SourceTemplate: + DataSetReferences: + - DataSetArn: '{{ DataSetArn }}' + DataSetPlaceholder: '{{ DataSetPlaceholder }}' + Arn: '{{ Arn }}' + - name: ThemeArn + value: '{{ ThemeArn }}' + - name: Definition + value: + Options: + Timezone: '{{ Timezone }}' + WeekStart: '{{ WeekStart }}' + FilterGroups: + - Status: '{{ Status }}' + Filters: + - NestedFilter: + Column: + ColumnName: '{{ ColumnName }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + InnerFilter: + CategoryInnerFilter: + Configuration: + CustomFilterListConfiguration: + CategoryValues: + - '{{ CategoryValues[0] }}' + NullOption: '{{ NullOption }}' + MatchOperator: '{{ MatchOperator }}' + SelectAllOptions: '{{ SelectAllOptions }}' + CustomFilterConfiguration: + CategoryValue: '{{ CategoryValue }}' + ParameterName: '{{ ParameterName }}' + NullOption: null + MatchOperator: null + SelectAllOptions: null + FilterListConfiguration: + CategoryValues: + - '{{ CategoryValues[0] }}' + NullOption: null + MatchOperator: null + SelectAllOptions: null + Column: null + DefaultFilterControlConfiguration: + ControlOptions: + DefaultSliderOptions: + Type: '{{ Type }}' + StepSize: null + DisplayOptions: + TitleOptions: + CustomLabel: '{{ CustomLabel }}' + Visibility: null + FontConfiguration: + FontStyle: '{{ FontStyle }}' + FontSize: + Relative: '{{ Relative }}' + FontDecoration: '{{ FontDecoration }}' + FontColor: '{{ FontColor }}' + FontWeight: + Name: '{{ Name }}' + InfoIconLabelOptions: + Visibility: null + InfoIconText: '{{ InfoIconText }}' + MaximumValue: null + MinimumValue: null + DefaultRelativeDateTimeOptions: + DisplayOptions: + TitleOptions: null + InfoIconLabelOptions: null + DateTimeFormat: '{{ DateTimeFormat }}' + CommitMode: '{{ CommitMode }}' + DefaultTextFieldOptions: + DisplayOptions: + TitleOptions: null + PlaceholderOptions: + Visibility: null + InfoIconLabelOptions: null + DefaultTextAreaOptions: + Delimiter: '{{ Delimiter }}' + DisplayOptions: + TitleOptions: null + PlaceholderOptions: null + InfoIconLabelOptions: null + DefaultDropdownOptions: + Type: '{{ Type }}' + DisplayOptions: + TitleOptions: null + SelectAllOptions: + Visibility: null + InfoIconLabelOptions: null + CommitMode: null + SelectableValues: + Values: + - '{{ Values[0] }}' + DefaultDateTimePickerOptions: + Type: '{{ Type }}' + DisplayOptions: + TitleOptions: null + InfoIconLabelOptions: null + DateTimeFormat: '{{ DateTimeFormat }}' + CommitMode: null + DefaultListOptions: + Type: null + DisplayOptions: + TitleOptions: null + SearchOptions: + Visibility: null + SelectAllOptions: null + InfoIconLabelOptions: null + SelectableValues: null + Title: '{{ Title }}' + IncludeInnerSet: '{{ IncludeInnerSet }}' + FilterId: '{{ FilterId }}' + NumericEqualityFilter: + AggregationFunction: + AttributeAggregationFunction: + SimpleAttributeAggregation: '{{ SimpleAttributeAggregation }}' + ValueForMultipleValues: '{{ ValueForMultipleValues }}' + DateAggregationFunction: '{{ DateAggregationFunction }}' + NumericalAggregationFunction: + PercentileAggregation: + PercentileValue: null + SimpleNumericalAggregation: '{{ SimpleNumericalAggregation }}' + CategoricalAggregationFunction: '{{ CategoricalAggregationFunction }}' + Column: null + Value: null + ParameterName: '{{ ParameterName }}' + NullOption: null + MatchOperator: '{{ MatchOperator }}' + SelectAllOptions: '{{ SelectAllOptions }}' + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + NumericRangeFilter: + AggregationFunction: null + Column: null + IncludeMaximum: '{{ IncludeMaximum }}' + RangeMinimum: + StaticValue: null + Parameter: '{{ Parameter }}' + NullOption: null + SelectAllOptions: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + RangeMaximum: null + IncludeMinimum: '{{ IncludeMinimum }}' + TimeRangeFilter: + RangeMinimumValue: + RollingDate: + Expression: '{{ Expression }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + StaticValue: '{{ StaticValue }}' + Parameter: '{{ Parameter }}' + Column: null + RangeMaximumValue: null + IncludeMaximum: '{{ IncludeMaximum }}' + TimeGranularity: '{{ TimeGranularity }}' + NullOption: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + IncludeMinimum: '{{ IncludeMinimum }}' + ExcludePeriodConfiguration: + Status: null + Amount: null + Granularity: null + RelativeDatesFilter: + RelativeDateValue: null + Column: null + RelativeDateType: '{{ RelativeDateType }}' + TimeGranularity: null + ParameterName: '{{ ParameterName }}' + NullOption: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + AnchorDateConfiguration: + AnchorOption: '{{ AnchorOption }}' + ParameterName: '{{ ParameterName }}' + MinimumGranularity: null + ExcludePeriodConfiguration: null + TopBottomFilter: + AggregationSortConfigurations: + - AggregationFunction: null + SortDirection: '{{ SortDirection }}' + Column: null + Column: null + TimeGranularity: null + ParameterName: '{{ ParameterName }}' + Limit: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + TimeEqualityFilter: + Column: null + RollingDate: null + Value: '{{ Value }}' + TimeGranularity: null + ParameterName: '{{ ParameterName }}' + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + CategoryFilter: + Configuration: null + Column: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + CrossDataset: '{{ CrossDataset }}' + ScopeConfiguration: + AllSheets: {} + SelectedSheets: + SheetVisualScopingConfigurations: + - Scope: '{{ Scope }}' + SheetId: '{{ SheetId }}' + VisualIds: + - '{{ VisualIds[0] }}' + FilterGroupId: '{{ FilterGroupId }}' + StaticFiles: + - ImageStaticFile: + StaticFileId: '{{ StaticFileId }}' + Source: + UrlOptions: + Url: '{{ Url }}' + S3Options: + BucketName: '{{ BucketName }}' + ObjectKey: '{{ ObjectKey }}' + Region: '{{ Region }}' + SpatialStaticFile: + StaticFileId: '{{ StaticFileId }}' + Source: null + CalculatedFields: + - Expression: '{{ Expression }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + Name: '{{ Name }}' + DataSetIdentifierDeclarations: + - Identifier: '{{ Identifier }}' + DataSetArn: '{{ DataSetArn }}' + ColumnConfigurations: + - Role: '{{ Role }}' + FormatConfiguration: + NumberFormatConfiguration: + FormatConfiguration: + NumberDisplayFormatConfiguration: + NegativeValueConfiguration: + DisplayMode: '{{ DisplayMode }}' + DecimalPlacesConfiguration: + DecimalPlaces: null + NumberScale: '{{ NumberScale }}' + NullValueFormatConfiguration: + NullString: '{{ NullString }}' + Suffix: '{{ Suffix }}' + SeparatorConfiguration: + DecimalSeparator: '{{ DecimalSeparator }}' + ThousandsSeparator: + Symbol: null + Visibility: null + Prefix: '{{ Prefix }}' + CurrencyDisplayFormatConfiguration: + NegativeValueConfiguration: null + DecimalPlacesConfiguration: null + NumberScale: null + NullValueFormatConfiguration: null + Suffix: '{{ Suffix }}' + SeparatorConfiguration: null + Symbol: '{{ Symbol }}' + Prefix: '{{ Prefix }}' + PercentageDisplayFormatConfiguration: + NegativeValueConfiguration: null + DecimalPlacesConfiguration: null + NullValueFormatConfiguration: null + Suffix: '{{ Suffix }}' + SeparatorConfiguration: null + Prefix: '{{ Prefix }}' + DateTimeFormatConfiguration: + NumericFormatConfiguration: null + NullValueFormatConfiguration: null + DateTimeFormat: '{{ DateTimeFormat }}' + StringFormatConfiguration: + NumericFormatConfiguration: null + NullValueFormatConfiguration: null + Column: null + ColorsConfiguration: + CustomColors: + - Color: '{{ Color }}' + FieldValue: '{{ FieldValue }}' + SpecialValue: '{{ SpecialValue }}' + AnalysisDefaults: + DefaultNewSheetConfiguration: + SheetContentType: '{{ SheetContentType }}' + InteractiveLayoutConfiguration: + FreeForm: + CanvasSizeOptions: + ScreenCanvasSizeOptions: + OptimizedViewPortWidth: '{{ OptimizedViewPortWidth }}' + Grid: + CanvasSizeOptions: + ScreenCanvasSizeOptions: + OptimizedViewPortWidth: '{{ OptimizedViewPortWidth }}' + ResizeOption: '{{ ResizeOption }}' + PaginatedLayoutConfiguration: + SectionBased: + CanvasSizeOptions: + PaperCanvasSizeOptions: + PaperMargin: + Left: '{{ Left }}' + Top: '{{ Top }}' + Right: '{{ Right }}' + Bottom: '{{ Bottom }}' + PaperSize: '{{ PaperSize }}' + PaperOrientation: '{{ PaperOrientation }}' + Sheets: + - Description: '{{ Description }}' + ParameterControls: + - Slider: + ParameterControlId: '{{ ParameterControlId }}' + StepSize: null + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + MaximumValue: null + MinimumValue: null + TextArea: + ParameterControlId: '{{ ParameterControlId }}' + Delimiter: '{{ Delimiter }}' + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + Dropdown: + ParameterControlId: '{{ ParameterControlId }}' + Type: null + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + CascadingControlConfiguration: + SourceControls: + - SourceSheetControlId: '{{ SourceSheetControlId }}' + ColumnToMatch: null + Title: '{{ Title }}' + CommitMode: null + SelectableValues: + LinkToDataSetColumn: null + Values: + - '{{ Values[0] }}' + TextField: + ParameterControlId: '{{ ParameterControlId }}' + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + List: + ParameterControlId: '{{ ParameterControlId }}' + Type: null + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + CascadingControlConfiguration: null + Title: '{{ Title }}' + SelectableValues: null + DateTimePicker: + ParameterControlId: '{{ ParameterControlId }}' + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + TextBoxes: + - SheetTextBoxId: '{{ SheetTextBoxId }}' + Content: '{{ Content }}' + Layouts: + - Configuration: + GridLayout: + CanvasSizeOptions: null + Elements: + - ElementType: '{{ ElementType }}' + ColumnSpan: null + ColumnIndex: null + RowIndex: null + RowSpan: null + ElementId: '{{ ElementId }}' + FreeFormLayout: + CanvasSizeOptions: null + Elements: + - ElementType: null + BorderStyle: + Color: '{{ Color }}' + Visibility: null + Height: '{{ Height }}' + Visibility: null + RenderingRules: + - Expression: '{{ Expression }}' + ConfigurationOverrides: + Visibility: null + YAxisLocation: '{{ YAxisLocation }}' + LoadingAnimation: + Visibility: null + Width: '{{ Width }}' + BackgroundStyle: + Color: '{{ Color }}' + Visibility: null + ElementId: '{{ ElementId }}' + XAxisLocation: '{{ XAxisLocation }}' + SelectedBorderStyle: null + SectionBasedLayout: + CanvasSizeOptions: null + FooterSections: + - Layout: + FreeFormLayout: + Elements: + - null + Style: + Padding: null + Height: '{{ Height }}' + SectionId: '{{ SectionId }}' + BodySections: + - Content: + Layout: null + Style: null + PageBreakConfiguration: + After: + Status: '{{ Status }}' + SectionId: '{{ SectionId }}' + HeaderSections: + - null + ContentType: null + SheetId: '{{ SheetId }}' + FilterControls: + - Slider: + FilterControlId: '{{ FilterControlId }}' + Type: null + StepSize: null + DisplayOptions: null + Title: '{{ Title }}' + MaximumValue: null + SourceFilterId: '{{ SourceFilterId }}' + MinimumValue: null + TextArea: + FilterControlId: '{{ FilterControlId }}' + Delimiter: '{{ Delimiter }}' + DisplayOptions: null + Title: '{{ Title }}' + SourceFilterId: '{{ SourceFilterId }}' + Dropdown: + FilterControlId: '{{ FilterControlId }}' + Type: null + DisplayOptions: null + CascadingControlConfiguration: null + Title: '{{ Title }}' + CommitMode: null + SourceFilterId: '{{ SourceFilterId }}' + SelectableValues: null + TextField: + FilterControlId: '{{ FilterControlId }}' + DisplayOptions: null + Title: '{{ Title }}' + SourceFilterId: '{{ SourceFilterId }}' + List: + FilterControlId: '{{ FilterControlId }}' + Type: null + DisplayOptions: null + CascadingControlConfiguration: null + Title: '{{ Title }}' + SourceFilterId: '{{ SourceFilterId }}' + SelectableValues: null + DateTimePicker: + FilterControlId: '{{ FilterControlId }}' + Type: null + DisplayOptions: null + Title: '{{ Title }}' + CommitMode: null + SourceFilterId: '{{ SourceFilterId }}' + RelativeDateTime: + FilterControlId: '{{ FilterControlId }}' + DisplayOptions: null + Title: '{{ Title }}' + CommitMode: null + SourceFilterId: '{{ SourceFilterId }}' + CrossSheet: + FilterControlId: '{{ FilterControlId }}' + CascadingControlConfiguration: null + SourceFilterId: '{{ SourceFilterId }}' + Images: + - Actions: + - Status: null + Trigger: '{{ Trigger }}' + CustomActionId: '{{ CustomActionId }}' + Name: '{{ Name }}' + ActionOperations: + - NavigationOperation: + LocalNavigationConfiguration: + TargetSheetId: '{{ TargetSheetId }}' + SetParametersOperation: + ParameterValueConfigurations: + - DestinationParameterName: '{{ DestinationParameterName }}' + Value: + CustomValuesConfiguration: + IncludeNullValue: '{{ IncludeNullValue }}' + CustomValues: + DecimalValues: + - null + IntegerValues: + - null + StringValues: + - '{{ StringValues[0] }}' + DateTimeValues: + - '{{ DateTimeValues[0] }}' + SourceParameterName: '{{ SourceParameterName }}' + SelectAllValueOptions: '{{ SelectAllValueOptions }}' + SourceField: '{{ SourceField }}' + SourceColumn: null + URLOperation: + URLTemplate: '{{ URLTemplate }}' + URLTarget: '{{ URLTarget }}' + SheetImageId: '{{ SheetImageId }}' + Tooltip: + Visibility: null + TooltipText: + PlainText: '{{ PlainText }}' + Scaling: + ScalingType: '{{ ScalingType }}' + Interactions: + ImageMenuOption: + AvailabilityStatus: null + Source: + SheetImageStaticFileSource: + StaticFileId: '{{ StaticFileId }}' + ImageContentAltText: '{{ ImageContentAltText }}' + SheetControlLayouts: + - Configuration: + GridLayout: null + Title: '{{ Title }}' + Visuals: + - FunnelChartVisual: + Subtitle: + Visibility: null + FormatText: + RichText: '{{ RichText }}' + PlainText: '{{ PlainText }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategoryItemsLimit: + ItemsLimit: null + OtherCategories: '{{ OtherCategories }}' + CategorySort: + - FieldSort: + FieldId: '{{ FieldId }}' + Direction: null + ColumnSort: + AggregationFunction: null + SortBy: null + Direction: null + DataLabelOptions: + MeasureLabelVisibility: null + Position: '{{ Position }}' + Visibility: null + CategoryLabelVisibility: null + LabelColor: '{{ LabelColor }}' + MeasureDataLabelStyle: '{{ MeasureDataLabelStyle }}' + LabelFontConfiguration: null + CategoryLabelOptions: + Visibility: null + SortIconVisibility: null + AxisLabelOptions: + - CustomLabel: '{{ CustomLabel }}' + ApplyTo: + Column: null + FieldId: '{{ FieldId }}' + FontConfiguration: null + FieldWells: + FunnelChartAggregatedFieldWells: + Category: + - DateDimensionField: + HierarchyId: '{{ HierarchyId }}' + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + DateGranularity: null + NumericalDimensionField: + HierarchyId: '{{ HierarchyId }}' + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + CategoricalDimensionField: + HierarchyId: '{{ HierarchyId }}' + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + Values: + - DateMeasureField: + AggregationFunction: null + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + NumericalMeasureField: + AggregationFunction: null + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + CategoricalMeasureField: + AggregationFunction: null + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + CalculatedMeasureField: + Expression: '{{ Expression }}' + FieldId: '{{ FieldId }}' + Tooltip: + SelectedTooltipType: '{{ SelectedTooltipType }}' + TooltipVisibility: null + FieldBasedTooltip: + TooltipFields: + - FieldTooltipItem: + TooltipTarget: '{{ TooltipTarget }}' + FieldId: '{{ FieldId }}' + Label: '{{ Label }}' + Visibility: null + ColumnTooltipItem: + Aggregation: null + TooltipTarget: null + Column: null + Label: '{{ Label }}' + Visibility: null + AggregationVisibility: null + TooltipTitleType: '{{ TooltipTitleType }}' + ValueLabelOptions: null + VisualPalette: + ChartColor: '{{ ChartColor }}' + ColorMap: + - Element: + DataPathType: + PivotTableDataPathType: '{{ PivotTableDataPathType }}' + FieldId: '{{ FieldId }}' + FieldValue: '{{ FieldValue }}' + Color: '{{ Color }}' + TimeGranularity: null + Actions: + - Status: null + Trigger: '{{ Trigger }}' + CustomActionId: '{{ CustomActionId }}' + Name: '{{ Name }}' + ActionOperations: + - NavigationOperation: null + SetParametersOperation: null + FilterOperation: + SelectedFieldsConfiguration: + SelectedColumns: + - null + SelectedFields: + - '{{ SelectedFields[0] }}' + SelectedFieldOptions: '{{ SelectedFieldOptions }}' + TargetVisualsConfiguration: + SameSheetTargetVisualConfiguration: + TargetVisualOptions: '{{ TargetVisualOptions }}' + TargetVisuals: + - '{{ TargetVisuals[0] }}' + URLOperation: null + Title: + Visibility: null + FormatText: + RichText: '{{ RichText }}' + PlainText: '{{ PlainText }}' + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - DateTimeHierarchy: + HierarchyId: '{{ HierarchyId }}' + DrillDownFilters: + - NumericEqualityFilter: + Column: null + Value: null + TimeRangeFilter: + Column: null + RangeMinimum: '{{ RangeMinimum }}' + TimeGranularity: null + RangeMaximum: '{{ RangeMaximum }}' + CategoryFilter: + Column: null + CategoryValues: + - '{{ CategoryValues[0] }}' + ExplicitHierarchy: + HierarchyId: '{{ HierarchyId }}' + DrillDownFilters: + - null + Columns: + - null + PredefinedHierarchy: + HierarchyId: '{{ HierarchyId }}' + DrillDownFilters: + - null + Columns: + - null + BoxPlotVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategorySort: + - null + PaginationConfiguration: + PageSize: null + PageNumber: null + Legend: + Position: '{{ Position }}' + ValueFontConfiguration: null + Title: null + Visibility: null + Height: '{{ Height }}' + Width: '{{ Width }}' + ReferenceLines: + - Status: null + DataConfiguration: + DynamicConfiguration: + Column: null + MeasureAggregationFunction: null + Calculation: null + AxisBinding: '{{ AxisBinding }}' + SeriesType: '{{ SeriesType }}' + StaticConfiguration: + Value: null + LabelConfiguration: + HorizontalPosition: '{{ HorizontalPosition }}' + ValueLabelConfiguration: + FormatConfiguration: null + RelativePosition: '{{ RelativePosition }}' + CustomLabelConfiguration: + CustomLabel: '{{ CustomLabel }}' + FontColor: '{{ FontColor }}' + FontConfiguration: null + VerticalPosition: '{{ VerticalPosition }}' + StyleConfiguration: + Pattern: '{{ Pattern }}' + Color: '{{ Color }}' + CategoryAxis: + DataOptions: + DateAxisOptions: + MissingDateVisibility: null + NumericAxisOptions: + Scale: + Logarithmic: + Base: null + Linear: + StepSize: null + StepCount: null + Range: + DataDriven: {} + MinMax: + Minimum: null + Maximum: null + TickLabelOptions: + RotationAngle: null + LabelOptions: null + AxisOffset: '{{ AxisOffset }}' + AxisLineVisibility: null + GridLineVisibility: null + ScrollbarOptions: + VisibleRange: + PercentRange: + From: null + To: null + Visibility: null + PrimaryYAxisLabelOptions: null + CategoryLabelOptions: null + FieldWells: + BoxPlotAggregatedFieldWells: + GroupBy: + - null + Values: + - null + Tooltip: null + BoxPlotOptions: + StyleOptions: + FillStyle: '{{ FillStyle }}' + OutlierVisibility: null + AllDataPointsVisibility: null + PrimaryYAxisDisplayOptions: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + GeospatialMapVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + Legend: null + MapStyleOptions: + BaseMapStyle: '{{ BaseMapStyle }}' + FieldWells: + GeospatialMapAggregatedFieldWells: + Colors: + - null + Values: + - null + Geospatial: + - null + Tooltip: null + WindowOptions: + Bounds: + West: null + South: null + North: null + East: null + MapZoomMode: '{{ MapZoomMode }}' + PointStyleOptions: + SelectedPointStyle: '{{ SelectedPointStyle }}' + ClusterMarkerConfiguration: + ClusterMarker: + SimpleClusterMarker: + Color: '{{ Color }}' + HeatmapConfiguration: + HeatmapColor: + Colors: + - Color: '{{ Color }}' + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + ScatterPlotVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + YAxisLabelOptions: null + Legend: null + YAxisDisplayOptions: null + DataLabels: + DataLabelTypes: + - MaximumLabelType: + Visibility: null + DataPathLabelType: + FieldId: '{{ FieldId }}' + Visibility: null + FieldValue: '{{ FieldValue }}' + RangeEndsLabelType: + Visibility: null + FieldLabelType: + FieldId: '{{ FieldId }}' + Visibility: null + MinimumLabelType: + Visibility: null + MeasureLabelVisibility: null + Position: null + LabelContent: '{{ LabelContent }}' + Visibility: null + TotalsVisibility: null + Overlap: '{{ Overlap }}' + CategoryLabelVisibility: null + LabelColor: '{{ LabelColor }}' + LabelFontConfiguration: null + FieldWells: + ScatterPlotUnaggregatedFieldWells: + Category: + - null + Size: + - null + Label: + - null + XAxis: + - null + YAxis: + - null + ScatterPlotCategoricallyAggregatedFieldWells: + Category: + - null + Size: + - null + Label: + - null + XAxis: + - null + YAxis: + - null + Tooltip: null + XAxisLabelOptions: null + VisualPalette: null + XAxisDisplayOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + RadarChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + ColorSort: + - null + ColorItemsLimit: null + CategoryItemsLimit: null + CategorySort: + - null + Legend: null + Shape: '{{ Shape }}' + BaseSeriesSettings: + AreaStyleSettings: + Visibility: null + ColorLabelOptions: null + CategoryLabelOptions: null + AxesRangeScale: '{{ AxesRangeScale }}' + VisualPalette: null + AlternateBandColorsVisibility: null + StartAngle: null + CategoryAxis: null + FieldWells: + RadarChartAggregatedFieldWells: + Category: + - null + Color: + - null + Values: + - null + ColorAxis: null + AlternateBandOddColor: '{{ AlternateBandOddColor }}' + AlternateBandEvenColor: '{{ AlternateBandEvenColor }}' + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + ComboChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + ColorSort: + - null + ColorItemsLimit: null + CategoryItemsLimit: null + CategorySort: + - null + Legend: null + ReferenceLines: + - null + ColorLabelOptions: null + BarDataLabels: null + CategoryLabelOptions: null + Tooltip: null + SingleAxisOptions: + YAxisOptions: + YAxis: '{{ YAxis }}' + PrimaryYAxisDisplayOptions: null + VisualPalette: null + BarsArrangement: '{{ BarsArrangement }}' + SecondaryYAxisLabelOptions: null + LineDataLabels: null + CategoryAxis: null + PrimaryYAxisLabelOptions: null + FieldWells: + ComboChartAggregatedFieldWells: + BarValues: + - null + Category: + - null + Colors: + - null + LineValues: + - null + SecondaryYAxisDisplayOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + WordCloudVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategoryItemsLimit: null + CategorySort: + - null + CategoryLabelOptions: null + FieldWells: + WordCloudAggregatedFieldWells: + GroupBy: + - null + Size: + - null + WordCloudOptions: + WordOrientation: '{{ WordOrientation }}' + WordScaling: '{{ WordScaling }}' + CloudLayout: '{{ CloudLayout }}' + MaximumStringLength: null + WordCasing: '{{ WordCasing }}' + WordPadding: '{{ WordPadding }}' + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + SankeyDiagramVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + WeightSort: + - null + SourceItemsLimit: null + DestinationItemsLimit: null + DataLabels: null + FieldWells: + SankeyDiagramAggregatedFieldWells: + Destination: + - null + Source: + - null + Weight: + - null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + GaugeChartVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Arc: + ForegroundColor: + Gradient: + Expression: '{{ Expression }}' + Color: + Stops: + - GradientOffset: null + DataValue: null + Color: '{{ Color }}' + Solid: + Expression: '{{ Expression }}' + Color: '{{ Color }}' + PrimaryValue: + TextColor: null + Icon: + CustomCondition: + Expression: '{{ Expression }}' + Color: '{{ Color }}' + DisplayConfiguration: + IconDisplayOption: '{{ IconDisplayOption }}' + IconOptions: + UnicodeIcon: '{{ UnicodeIcon }}' + Icon: '{{ Icon }}' + IconSet: + Expression: '{{ Expression }}' + IconSetType: '{{ IconSetType }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + DataLabels: null + FieldWells: + TargetValues: + - null + Values: + - null + TooltipOptions: null + GaugeChartOptions: + Arc: + ArcAngle: null + ArcThickness: '{{ ArcThickness }}' + Comparison: + ComparisonMethod: '{{ ComparisonMethod }}' + ComparisonFormat: + NumberDisplayFormatConfiguration: null + PercentageDisplayFormatConfiguration: null + PrimaryValueDisplayType: '{{ PrimaryValueDisplayType }}' + ArcAxis: + Range: + Min: null + Max: null + ReserveRange: null + PrimaryValueFontConfiguration: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + FilledMapVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Shape: + Format: + BackgroundColor: null + FieldId: '{{ FieldId }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategorySort: + - null + Legend: null + MapStyleOptions: null + FieldWells: + FilledMapAggregatedFieldWells: + Values: + - null + Geospatial: + - null + Tooltip: null + WindowOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + WaterfallVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + CategoryAxisLabelOptions: null + SortConfiguration: + BreakdownItemsLimit: null + CategorySort: + - null + Legend: null + DataLabels: null + PrimaryYAxisLabelOptions: null + FieldWells: + WaterfallChartAggregatedFieldWells: + Categories: + - null + Breakdowns: + - null + Values: + - null + WaterfallChartOptions: + TotalBarLabel: '{{ TotalBarLabel }}' + ColorConfiguration: + GroupColorConfiguration: + NegativeBarColor: '{{ NegativeBarColor }}' + TotalBarColor: '{{ TotalBarColor }}' + PositiveBarColor: '{{ PositiveBarColor }}' + CategoryAxisDisplayOptions: null + PrimaryYAxisDisplayOptions: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + CustomContentVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + ContentUrl: '{{ ContentUrl }}' + ContentType: '{{ ContentType }}' + ImageScaling: '{{ ImageScaling }}' + Actions: + - null + DataSetIdentifier: '{{ DataSetIdentifier }}' + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + PieChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + SmallMultiplesSort: + - null + CategoryItemsLimit: null + CategorySort: + - null + SmallMultiplesLimitConfiguration: null + Legend: null + DataLabels: null + ContributionAnalysisDefaults: + - MeasureFieldId: '{{ MeasureFieldId }}' + ContributorDimensions: + - null + CategoryLabelOptions: null + FieldWells: + PieChartAggregatedFieldWells: + Category: + - null + Values: + - null + SmallMultiples: + - null + Tooltip: null + DonutOptions: + DonutCenterOptions: + LabelVisibility: null + ArcOptions: + ArcThickness: '{{ ArcThickness }}' + SmallMultiplesOptions: + MaxVisibleRows: null + PanelConfiguration: + BorderThickness: '{{ BorderThickness }}' + BorderStyle: '{{ BorderStyle }}' + GutterSpacing: '{{ GutterSpacing }}' + BackgroundVisibility: null + BorderVisibility: null + BorderColor: '{{ BorderColor }}' + Title: + Visibility: null + FontConfiguration: null + HorizontalTextAlignment: '{{ HorizontalTextAlignment }}' + GutterVisibility: null + BackgroundColor: '{{ BackgroundColor }}' + MaxVisibleColumns: null + XAxis: + Placement: '{{ Placement }}' + Scale: '{{ Scale }}' + YAxis: null + ValueLabelOptions: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + KPIVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - PrimaryValue: + TextColor: null + Icon: null + ActualValue: + TextColor: null + Icon: null + ComparisonValue: + TextColor: null + Icon: null + ProgressBar: + ForegroundColor: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + TrendGroupSort: + - null + KPIOptions: + SecondaryValueFontConfiguration: null + VisualLayoutOptions: + StandardLayout: + Type: '{{ Type }}' + TrendArrows: + Visibility: null + SecondaryValue: + Visibility: null + Comparison: null + PrimaryValueDisplayType: null + ProgressBar: + Visibility: null + PrimaryValueFontConfiguration: null + Sparkline: + Type: '{{ Type }}' + Color: '{{ Color }}' + TooltipVisibility: null + Visibility: null + FieldWells: + TargetValues: + - null + TrendGroups: + - null + Values: + - null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + HistogramVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + YAxisDisplayOptions: null + DataLabels: null + BinOptions: + BinWidth: + BinCountLimit: null + Value: null + StartValue: null + SelectedBinType: '{{ SelectedBinType }}' + BinCount: + Value: null + FieldWells: + HistogramAggregatedFieldWells: + Values: + - null + Tooltip: null + XAxisLabelOptions: null + VisualPalette: null + XAxisDisplayOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + PluginVisual: + Subtitle: null + PluginArn: '{{ PluginArn }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + PluginVisualTableQuerySort: + ItemsLimitConfiguration: + ItemsLimit: null + RowSort: + - null + VisualOptions: + VisualProperties: + - Value: '{{ Value }}' + Name: '{{ Name }}' + FieldWells: + - Unaggregated: + - FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + AxisName: '{{ AxisName }}' + Measures: + - null + Dimensions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + TableVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Row: + TextColor: null + BackgroundColor: null + Cell: + FieldId: '{{ FieldId }}' + TextFormat: + TextColor: null + Icon: null + BackgroundColor: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + RowSort: + - null + PaginationConfiguration: null + PaginatedReportOptions: + OverflowColumnHeaderVisibility: null + VerticalOverflowVisibility: null + TableOptions: + HeaderStyle: + VerticalTextAlignment: '{{ VerticalTextAlignment }}' + Visibility: null + Height: null + FontConfiguration: null + Border: + UniformBorder: + Thickness: null + Color: '{{ Color }}' + Style: '{{ Style }}' + SideSpecificBorder: + Left: null + Top: null + InnerHorizontal: null + Right: null + Bottom: null + InnerVertical: null + TextWrap: '{{ TextWrap }}' + HorizontalTextAlignment: null + BackgroundColor: '{{ BackgroundColor }}' + CellStyle: null + Orientation: '{{ Orientation }}' + RowAlternateColorOptions: + Status: null + UsePrimaryBackgroundColor: null + RowAlternateColors: + - '{{ RowAlternateColors[0] }}' + TableInlineVisualizations: + - DataBars: + PositiveColor: '{{ PositiveColor }}' + FieldId: '{{ FieldId }}' + NegativeColor: '{{ NegativeColor }}' + FieldWells: + TableUnaggregatedFieldWells: + Values: + - null + TableAggregatedFieldWells: + GroupBy: + - null + Values: + - null + FieldOptions: + Order: + - '{{ Order[0] }}' + PinnedFieldOptions: + PinnedLeftFields: + - '{{ PinnedLeftFields[0] }}' + SelectedFieldOptions: + - CustomLabel: '{{ CustomLabel }}' + URLStyling: + LinkConfiguration: + Target: null + Content: + CustomIconContent: + Icon: '{{ Icon }}' + CustomTextContent: + Value: '{{ Value }}' + FontConfiguration: null + ImageConfiguration: + SizingOptions: + TableCellImageScalingConfiguration: '{{ TableCellImageScalingConfiguration }}' + FieldId: '{{ FieldId }}' + Visibility: null + Width: '{{ Width }}' + TotalOptions: + TotalAggregationOptions: + - TotalAggregationFunction: + SimpleTotalAggregationFunction: '{{ SimpleTotalAggregationFunction }}' + FieldId: '{{ FieldId }}' + CustomLabel: '{{ CustomLabel }}' + ScrollStatus: '{{ ScrollStatus }}' + Placement: '{{ Placement }}' + TotalCellStyle: null + TotalsVisibility: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + PivotTableVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Cell: + Scope: + Role: '{{ Role }}' + Scopes: + - null + FieldId: '{{ FieldId }}' + TextFormat: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + FieldSortOptions: + - SortBy: + Field: null + DataPath: + SortPaths: + - null + Direction: null + Column: null + FieldId: '{{ FieldId }}' + PaginatedReportOptions: + OverflowColumnHeaderVisibility: null + VerticalOverflowVisibility: null + TableOptions: + RowFieldNamesStyle: null + RowHeaderStyle: null + CollapsedRowDimensionsVisibility: null + RowsLayout: '{{ RowsLayout }}' + MetricPlacement: '{{ MetricPlacement }}' + DefaultCellWidth: '{{ DefaultCellWidth }}' + ColumnNamesVisibility: null + RowsLabelOptions: + CustomLabel: '{{ CustomLabel }}' + Visibility: null + SingleMetricVisibility: null + ColumnHeaderStyle: null + ToggleButtonsVisibility: null + CellStyle: null + RowAlternateColorOptions: null + FieldWells: + PivotTableAggregatedFieldWells: + Values: + - null + Columns: + - null + Rows: + - null + FieldOptions: + CollapseStateOptions: + - Target: + FieldId: '{{ FieldId }}' + FieldDataPathValues: + - null + State: '{{ State }}' + DataPathOptions: + - DataPathList: + - null + Width: '{{ Width }}' + SelectedFieldOptions: + - CustomLabel: '{{ CustomLabel }}' + FieldId: '{{ FieldId }}' + Visibility: null + TotalOptions: + ColumnSubtotalOptions: + CustomLabel: '{{ CustomLabel }}' + FieldLevelOptions: + - FieldId: '{{ FieldId }}' + ValueCellStyle: null + TotalCellStyle: null + TotalsVisibility: null + FieldLevel: '{{ FieldLevel }}' + MetricHeaderCellStyle: null + StyleTargets: + - CellType: '{{ CellType }}' + RowSubtotalOptions: null + RowTotalOptions: + TotalAggregationOptions: + - null + CustomLabel: '{{ CustomLabel }}' + ValueCellStyle: null + ScrollStatus: null + Placement: null + TotalCellStyle: null + TotalsVisibility: null + MetricHeaderCellStyle: null + ColumnTotalOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + BarChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + SmallMultiplesSort: + - null + ColorSort: + - null + ColorItemsLimit: null + CategoryItemsLimit: null + CategorySort: + - null + SmallMultiplesLimitConfiguration: null + Legend: null + ReferenceLines: + - null + DataLabels: null + ColorLabelOptions: null + CategoryLabelOptions: null + Tooltip: null + SmallMultiplesOptions: null + Orientation: '{{ Orientation }}' + VisualPalette: null + ValueLabelOptions: null + BarsArrangement: null + CategoryAxis: null + ContributionAnalysisDefaults: + - null + FieldWells: + BarChartAggregatedFieldWells: + Category: + - null + Colors: + - null + Values: + - null + SmallMultiples: + - null + ValueAxis: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + HeatMapVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + HeatMapRowSort: + - null + HeatMapRowItemsLimitConfiguration: null + HeatMapColumnItemsLimitConfiguration: null + HeatMapColumnSort: + - null + ColumnLabelOptions: null + Legend: null + DataLabels: null + FieldWells: + HeatMapAggregatedFieldWells: + Values: + - null + Columns: + - null + Rows: + - null + Tooltip: null + ColorScale: + Colors: + - DataValue: null + Color: '{{ Color }}' + ColorFillType: '{{ ColorFillType }}' + NullValueColor: null + RowLabelOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + TreeMapVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + TreeMapSort: + - null + TreeMapGroupItemsLimitConfiguration: null + Legend: null + DataLabels: null + ColorLabelOptions: null + SizeLabelOptions: null + FieldWells: + TreeMapAggregatedFieldWells: + Sizes: + - null + Colors: + - null + Groups: + - null + Tooltip: null + ColorScale: null + GroupLabelOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + InsightVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + Actions: + - null + DataSetIdentifier: '{{ DataSetIdentifier }}' + InsightConfiguration: + Computations: + - PeriodToDate: + PeriodTimeGranularity: null + Value: null + Time: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + GrowthRate: + Value: null + Time: null + PeriodSize: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + TopBottomRanked: + Type: '{{ Type }}' + Category: null + ResultSize: null + Value: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + TotalAggregation: + Value: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + Forecast: + PeriodsBackward: null + PeriodsForward: null + PredictionInterval: null + Seasonality: '{{ Seasonality }}' + CustomSeasonalityValue: null + Value: null + Time: null + UpperBoundary: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + LowerBoundary: null + MaximumMinimum: + Type: '{{ Type }}' + Value: null + Time: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + PeriodOverPeriod: + Value: null + Time: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + MetricComparison: + TargetValue: null + Time: null + ComputationId: '{{ ComputationId }}' + FromValue: null + Name: '{{ Name }}' + TopBottomMovers: + Type: null + Category: null + Value: null + SortOrder: '{{ SortOrder }}' + Time: null + MoverSize: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + UniqueValues: + Category: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + CustomNarrative: + Narrative: '{{ Narrative }}' + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + LineChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategoryItemsLimitConfiguration: null + ColorItemsLimitConfiguration: null + SmallMultiplesSort: + - null + CategorySort: + - null + SmallMultiplesLimitConfiguration: null + Legend: null + ReferenceLines: + - null + DataLabels: null + Tooltip: null + SingleAxisOptions: null + SmallMultiplesOptions: null + PrimaryYAxisDisplayOptions: + MissingDataConfigurations: + - TreatmentOption: '{{ TreatmentOption }}' + AxisOptions: null + VisualPalette: null + XAxisDisplayOptions: null + DefaultSeriesSettings: + LineStyleSettings: + LineInterpolation: '{{ LineInterpolation }}' + LineStyle: '{{ LineStyle }}' + LineVisibility: null + LineWidth: '{{ LineWidth }}' + AxisBinding: null + MarkerStyleSettings: + MarkerShape: '{{ MarkerShape }}' + MarkerSize: '{{ MarkerSize }}' + MarkerVisibility: null + MarkerColor: '{{ MarkerColor }}' + SecondaryYAxisLabelOptions: null + ForecastConfigurations: + - ForecastProperties: + PeriodsBackward: null + PeriodsForward: null + PredictionInterval: null + Seasonality: null + UpperBoundary: null + LowerBoundary: null + Scenario: + WhatIfRangeScenario: + StartDate: '{{ StartDate }}' + Value: null + EndDate: '{{ EndDate }}' + WhatIfPointScenario: + Value: null + Date: '{{ Date }}' + Series: + - FieldSeriesItem: + FieldId: '{{ FieldId }}' + AxisBinding: null + Settings: + LineStyleSettings: null + MarkerStyleSettings: null + DataFieldSeriesItem: + FieldId: '{{ FieldId }}' + AxisBinding: null + FieldValue: '{{ FieldValue }}' + Settings: null + Type: '{{ Type }}' + PrimaryYAxisLabelOptions: null + ContributionAnalysisDefaults: + - null + FieldWells: + LineChartAggregatedFieldWells: + Category: + - null + Colors: + - null + Values: + - null + SmallMultiples: + - null + SecondaryYAxisDisplayOptions: null + XAxisLabelOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + EmptyVisual: + VisualId: '{{ VisualId }}' + Actions: + - null + DataSetIdentifier: '{{ DataSetIdentifier }}' + Name: '{{ Name }}' + ParameterDeclarations: + - StringParameterDeclaration: + MappedDataSetParameters: + - DataSetParameterName: '{{ DataSetParameterName }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + DefaultValues: + DynamicValue: + GroupNameColumn: null + DefaultValueColumn: null + UserNameColumn: null + StaticValues: + - '{{ StaticValues[0] }}' + ParameterValueType: '{{ ParameterValueType }}' + ValueWhenUnset: + ValueWhenUnsetOption: '{{ ValueWhenUnsetOption }}' + CustomValue: '{{ CustomValue }}' + Name: '{{ Name }}' + DateTimeParameterDeclaration: + MappedDataSetParameters: + - null + DefaultValues: + RollingDate: null + DynamicValue: null + StaticValues: + - '{{ StaticValues[0] }}' + TimeGranularity: null + ValueWhenUnset: + ValueWhenUnsetOption: null + CustomValue: '{{ CustomValue }}' + Name: '{{ Name }}' + DecimalParameterDeclaration: + MappedDataSetParameters: + - null + DefaultValues: + DynamicValue: null + StaticValues: + - null + ParameterValueType: null + ValueWhenUnset: + ValueWhenUnsetOption: null + CustomValue: null + Name: '{{ Name }}' + IntegerParameterDeclaration: + MappedDataSetParameters: + - null + DefaultValues: + DynamicValue: null + StaticValues: + - null + ParameterValueType: null + ValueWhenUnset: + ValueWhenUnsetOption: null + CustomValue: null + Name: '{{ Name }}' + - name: ValidationStrategy + value: + Mode: '{{ Mode }}' + - name: FolderArns + value: + - '{{ FolderArns[0] }}' + - name: DashboardId + value: '{{ DashboardId }}' + - name: LinkSharingConfiguration + value: + Permissions: + - Principal: '{{ Principal }}' + Actions: + - '{{ Actions[0] }}' + - name: Name + value: '{{ Name }}' + - name: DashboardPublishOptions + value: + SheetControlsOption: + VisibilityState: '{{ VisibilityState }}' + ExportToCSVOption: + AvailabilityStatus: '{{ AvailabilityStatus }}' + DataPointMenuLabelOption: + AvailabilityStatus: null + DataPointDrillUpDownOption: + AvailabilityStatus: null + AdHocFilteringOption: + AvailabilityStatus: null + VisualPublishOptions: + ExportHiddenFieldsOption: + AvailabilityStatus: null + VisualMenuOption: null + DataPointTooltipOption: + AvailabilityStatus: null + VisualAxisSortOption: + AvailabilityStatus: null + ExportWithHiddenFieldsOption: + AvailabilityStatus: null + SheetLayoutElementMaximizationOption: + AvailabilityStatus: null + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: Permissions + value: + - null + - name: LinkEntities + value: + - '{{ LinkEntities[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.dashboards +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the dashboards resource, the following permissions are required: + +### Read +```json +quicksight:DescribeDashboard, +quicksight:DescribeDashboardPermissions, +quicksight:ListTagsForResource +``` + +### Create +```json +quicksight:DescribeDashboard, +quicksight:DescribeDashboardPermissions, +quicksight:CreateDashboard, +quicksight:DescribeTemplate, +quicksight:DescribeTheme, +quicksight:PassDataSet, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource, +quicksight:CreateFolderMembership, +quicksight:DeleteFolderMembership, +quicksight:ListFoldersForResource +``` + +### Update +```json +quicksight:DescribeDashboard, +quicksight:DescribeDashboardPermissions, +quicksight:UpdateDashboard, +quicksight:UpdateDashboardLinks, +quicksight:UpdateDashboardPermissions, +quicksight:UpdateDashboardPublishedVersion, +quicksight:DescribeTemplate, +quicksight:DescribeTheme, +quicksight:PassDataSet, +quicksight:CreateFolderMembership, +quicksight:DeleteFolderMembership, +quicksight:ListFoldersForResource, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### List +```json +quicksight:ListDashboards +``` + +### Delete +```json +quicksight:DescribeDashboard, +quicksight:DeleteDashboard +``` diff --git a/website/docs/services/quicksight/dashboards_list_only/index.md b/website/docs/services/quicksight/dashboards_list_only/index.md new file mode 100644 index 0000000..71d7784 --- /dev/null +++ b/website/docs/services/quicksight/dashboards_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: dashboards_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dashboards_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dashboards in a region or regions, for all properties use dashboards + +## Overview + + + + + + + +
Namedashboards_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Dashboard Resource Type.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dashboards in a region. +```sql +SELECT +region, +aws_account_id, +dashboard_id +FROM aws.quicksight.dashboards_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboards_list_only resource, see dashboards + diff --git a/website/docs/services/quicksight/data_set_tags/index.md b/website/docs/services/quicksight/data_set_tags/index.md new file mode 100644 index 0000000..964912e --- /dev/null +++ b/website/docs/services/quicksight/data_set_tags/index.md @@ -0,0 +1,121 @@ +--- +title: data_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_set_tags + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_sets in a region + +## Overview + + + + + + + +
Namedata_set_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::DataSet Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string

The time that this dataset was created.

object
string

The last time that this dataset was updated.

string
array

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

number

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

object
object

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


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

object

The refresh properties of a dataset.

object

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

object

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

array

A set of one or more definitions of a
ColumnLevelPermissionRule
.

string

The display name for the dataset.

array

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

string
array

The parameter declarations of the dataset.

object
string
object

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

array

A list of resource permissions on the dataset.

array

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

string

The Amazon Resource Name (ARN) of the resource.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_sets in a region. +```sql +SELECT +region, +physical_table_map, +created_time, +field_folders, +last_updated_time, +data_set_id, +folder_arns, +consumed_spice_capacity_in_bytes, +performance_configuration, +row_level_permission_data_set, +data_set_refresh_properties, +row_level_permission_tag_configuration, +ingestion_wait_policy, +column_level_permission_rules, +name, +column_groups, +import_mode, +dataset_parameters, +logical_table_map, +aws_account_id, +data_set_usage_configuration, +permissions, +output_columns, +arn, +tag_key, +tag_value +FROM aws.quicksight.data_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_set_tags resource, see data_sets + diff --git a/website/docs/services/quicksight/data_sets/index.md b/website/docs/services/quicksight/data_sets/index.md new file mode 100644 index 0000000..747d1d2 --- /dev/null +++ b/website/docs/services/quicksight/data_sets/index.md @@ -0,0 +1,480 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_set resource or lists data_sets in a region + +## Overview + + + + + + + +
Namedata_sets
TypeResource
DescriptionDefinition of the AWS::QuickSight::DataSet Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string

The time that this dataset was created.

object
string

The last time that this dataset was updated.

string
array

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

number

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

object
object

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


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

object

The refresh properties of a dataset.

object

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

object

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

array

A set of one or more definitions of a
ColumnLevelPermissionRule
.

string

The display name for the dataset.

array

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

string
array

The parameter declarations of the dataset.

object
string
object

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

array

A list of resource permissions on the dataset.

array

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

string

The Amazon Resource Name (ARN) of the resource.

array

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

stringAWS region.
+ +For more information, see AWS::QuickSight::DataSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_sets in a region. +```sql +SELECT +region, +physical_table_map, +created_time, +field_folders, +last_updated_time, +data_set_id, +folder_arns, +consumed_spice_capacity_in_bytes, +performance_configuration, +row_level_permission_data_set, +data_set_refresh_properties, +row_level_permission_tag_configuration, +ingestion_wait_policy, +column_level_permission_rules, +name, +column_groups, +import_mode, +dataset_parameters, +logical_table_map, +aws_account_id, +data_set_usage_configuration, +permissions, +output_columns, +arn, +tags +FROM aws.quicksight.data_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_set. +```sql +SELECT +region, +physical_table_map, +created_time, +field_folders, +last_updated_time, +data_set_id, +folder_arns, +consumed_spice_capacity_in_bytes, +performance_configuration, +row_level_permission_data_set, +data_set_refresh_properties, +row_level_permission_tag_configuration, +ingestion_wait_policy, +column_level_permission_rules, +name, +column_groups, +import_mode, +dataset_parameters, +logical_table_map, +aws_account_id, +data_set_usage_configuration, +permissions, +output_columns, +arn, +tags +FROM aws.quicksight.data_sets +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.data_sets ( + PhysicalTableMap, + FieldFolders, + DataSetId, + FolderArns, + PerformanceConfiguration, + RowLevelPermissionDataSet, + DataSetRefreshProperties, + RowLevelPermissionTagConfiguration, + IngestionWaitPolicy, + ColumnLevelPermissionRules, + Name, + ColumnGroups, + ImportMode, + DatasetParameters, + LogicalTableMap, + AwsAccountId, + DataSetUsageConfiguration, + Permissions, + Tags, + region +) +SELECT +'{{ PhysicalTableMap }}', + '{{ FieldFolders }}', + '{{ DataSetId }}', + '{{ FolderArns }}', + '{{ PerformanceConfiguration }}', + '{{ RowLevelPermissionDataSet }}', + '{{ DataSetRefreshProperties }}', + '{{ RowLevelPermissionTagConfiguration }}', + '{{ IngestionWaitPolicy }}', + '{{ ColumnLevelPermissionRules }}', + '{{ Name }}', + '{{ ColumnGroups }}', + '{{ ImportMode }}', + '{{ DatasetParameters }}', + '{{ LogicalTableMap }}', + '{{ AwsAccountId }}', + '{{ DataSetUsageConfiguration }}', + '{{ Permissions }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.data_sets ( + PhysicalTableMap, + FieldFolders, + DataSetId, + FolderArns, + PerformanceConfiguration, + RowLevelPermissionDataSet, + DataSetRefreshProperties, + RowLevelPermissionTagConfiguration, + IngestionWaitPolicy, + ColumnLevelPermissionRules, + Name, + ColumnGroups, + ImportMode, + DatasetParameters, + LogicalTableMap, + AwsAccountId, + DataSetUsageConfiguration, + Permissions, + Tags, + region +) +SELECT + '{{ PhysicalTableMap }}', + '{{ FieldFolders }}', + '{{ DataSetId }}', + '{{ FolderArns }}', + '{{ PerformanceConfiguration }}', + '{{ RowLevelPermissionDataSet }}', + '{{ DataSetRefreshProperties }}', + '{{ RowLevelPermissionTagConfiguration }}', + '{{ IngestionWaitPolicy }}', + '{{ ColumnLevelPermissionRules }}', + '{{ Name }}', + '{{ ColumnGroups }}', + '{{ ImportMode }}', + '{{ DatasetParameters }}', + '{{ LogicalTableMap }}', + '{{ AwsAccountId }}', + '{{ DataSetUsageConfiguration }}', + '{{ Permissions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_set + props: + - name: PhysicalTableMap + value: {} + - name: FieldFolders + value: {} + - name: DataSetId + value: '{{ DataSetId }}' + - name: FolderArns + value: + - '{{ FolderArns[0] }}' + - name: PerformanceConfiguration + value: + UniqueKeys: + - ColumnNames: + - '{{ ColumnNames[0] }}' + - name: RowLevelPermissionDataSet + value: + Status: '{{ Status }}' + FormatVersion: '{{ FormatVersion }}' + Arn: '{{ Arn }}' + Namespace: '{{ Namespace }}' + PermissionPolicy: '{{ PermissionPolicy }}' + - name: DataSetRefreshProperties + value: + RefreshConfiguration: + IncrementalRefresh: + LookbackWindow: + ColumnName: '{{ ColumnName }}' + SizeUnit: '{{ SizeUnit }}' + Size: null + - name: RowLevelPermissionTagConfiguration + value: + Status: null + TagRules: + - ColumnName: '{{ ColumnName }}' + TagKey: '{{ TagKey }}' + MatchAllValue: '{{ MatchAllValue }}' + TagMultiValueDelimiter: '{{ TagMultiValueDelimiter }}' + TagRuleConfigurations: + - - '{{ 0[0] }}' + - name: IngestionWaitPolicy + value: + WaitForSpiceIngestion: '{{ WaitForSpiceIngestion }}' + IngestionWaitTimeInHours: null + - name: ColumnLevelPermissionRules + value: + - ColumnNames: + - '{{ ColumnNames[0] }}' + Principals: + - '{{ Principals[0] }}' + - name: Name + value: '{{ Name }}' + - name: ColumnGroups + value: + - GeoSpatialColumnGroup: + Columns: + - '{{ Columns[0] }}' + CountryCode: '{{ CountryCode }}' + Name: '{{ Name }}' + - name: ImportMode + value: '{{ ImportMode }}' + - name: DatasetParameters + value: + - IntegerDatasetParameter: + ValueType: '{{ ValueType }}' + DefaultValues: + StaticValues: + - null + Id: '{{ Id }}' + Name: '{{ Name }}' + DateTimeDatasetParameter: + ValueType: null + TimeGranularity: '{{ TimeGranularity }}' + DefaultValues: + StaticValues: + - '{{ StaticValues[0] }}' + Id: '{{ Id }}' + Name: '{{ Name }}' + DecimalDatasetParameter: + ValueType: null + DefaultValues: + StaticValues: + - null + Id: '{{ Id }}' + Name: '{{ Name }}' + StringDatasetParameter: + ValueType: null + DefaultValues: + StaticValues: + - '{{ StaticValues[0] }}' + Id: '{{ Id }}' + Name: '{{ Name }}' + - name: LogicalTableMap + value: {} + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: DataSetUsageConfiguration + value: + DisableUseAsImportedSource: '{{ DisableUseAsImportedSource }}' + DisableUseAsDirectQuerySource: '{{ DisableUseAsDirectQuerySource }}' + - name: Permissions + value: + - Principal: '{{ Principal }}' + Actions: + - '{{ Actions[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.data_sets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the data_sets resource, the following permissions are required: + +### Read +```json +quicksight:DescribeDataSet, +quicksight:DescribeDataSetPermissions, +quicksight:ListTagsForResource, +quicksight:DescribeDataSetRefreshProperties +``` + +### Create +```json +quicksight:DescribeDataSet, +quicksight:DescribeDataSetPermissions, +quicksight:DescribeIngestion, +quicksight:ListIngestions, +quicksight:CreateDataSet, +quicksight:PassDataSource, +quicksight:PassDataSet, +quicksight:TagResource, +quicksight:ListTagsForResource, +quicksight:DescribeDataSetRefreshProperties, +quicksight:PutDataSetRefreshProperties, +quicksight:CreateFolderMembership, +quicksight:DeleteFolderMembership, +quicksight:ListFoldersForResource +``` + +### Update +```json +quicksight:DescribeDataSet, +quicksight:DescribeDataSetPermissions, +quicksight:PassDataSource, +quicksight:UpdateDataSet, +quicksight:UpdateDataSetPermissions, +quicksight:PassDataSet, +quicksight:DescribeIngestion, +quicksight:ListIngestions, +quicksight:CancelIngestion, +quicksight:CreateFolderMembership, +quicksight:DeleteFolderMembership, +quicksight:ListFoldersForResource, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource, +quicksight:PutDataSetRefreshProperties, +quicksight:DescribeDataSetRefreshProperties, +quicksight:DeleteDataSetRefreshProperties +``` + +### List +```json +quicksight:DescribeDataSet, +quicksight:ListDataSets +``` + +### Delete +```json +quicksight:DescribeDataSet, +quicksight:DeleteDataSet, +quicksight:ListTagsForResource, +quicksight:DescribeIngestion, +quicksight:DeleteDataSetRefreshProperties, +quicksight:DescribeDataSetRefreshProperties +``` diff --git a/website/docs/services/quicksight/data_sets_list_only/index.md b/website/docs/services/quicksight/data_sets_list_only/index.md new file mode 100644 index 0000000..b5dba73 --- /dev/null +++ b/website/docs/services/quicksight/data_sets_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: data_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sets_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sets in a region or regions, for all properties use data_sets + +## Overview + + + + + + + +
Namedata_sets_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::DataSet Resource Type.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sets in a region. +```sql +SELECT +region, +aws_account_id, +data_set_id +FROM aws.quicksight.data_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sets_list_only resource, see data_sets + diff --git a/website/docs/services/quicksight/data_source_tags/index.md b/website/docs/services/quicksight/data_source_tags/index.md new file mode 100644 index 0000000..a7d3d48 --- /dev/null +++ b/website/docs/services/quicksight/data_source_tags/index.md @@ -0,0 +1,107 @@ +--- +title: data_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_source_tags + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_sources in a region + +## Overview + + + + + + + +
Namedata_source_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::DataSource Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array

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

string

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

string
string

The time that this data source was created.

object

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

string
object

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

object

Error information for the data source creation or update.

array
string

The last time that this data source was updated.

string
array
object

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

string
string
object

VPC connection properties.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_sources in a region. +```sql +SELECT +region, +alternate_data_source_parameters, +arn, +aws_account_id, +created_time, +credentials, +data_source_id, +data_source_parameters, +error_info, +folder_arns, +last_updated_time, +name, +permissions, +ssl_properties, +status, +type, +vpc_connection_properties, +tag_key, +tag_value +FROM aws.quicksight.data_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_source_tags resource, see data_sources + diff --git a/website/docs/services/quicksight/data_sources/index.md b/website/docs/services/quicksight/data_sources/index.md new file mode 100644 index 0000000..535133e --- /dev/null +++ b/website/docs/services/quicksight/data_sources/index.md @@ -0,0 +1,425 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_source resource or lists data_sources in a region + +## Overview + + + + + + + +
Namedata_sources
TypeResource
DescriptionDefinition of the AWS::QuickSight::DataSource Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array

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

string

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

string
string

The time that this data source was created.

object

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

string
object

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

object

Error information for the data source creation or update.

array
string

The last time that this data source was updated.

string
array
object

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

string
array
string
object

VPC connection properties.

stringAWS region.
+ +For more information, see AWS::QuickSight::DataSource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_sources in a region. +```sql +SELECT +region, +alternate_data_source_parameters, +arn, +aws_account_id, +created_time, +credentials, +data_source_id, +data_source_parameters, +error_info, +folder_arns, +last_updated_time, +name, +permissions, +ssl_properties, +status, +tags, +type, +vpc_connection_properties +FROM aws.quicksight.data_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_source. +```sql +SELECT +region, +alternate_data_source_parameters, +arn, +aws_account_id, +created_time, +credentials, +data_source_id, +data_source_parameters, +error_info, +folder_arns, +last_updated_time, +name, +permissions, +ssl_properties, +status, +tags, +type, +vpc_connection_properties +FROM aws.quicksight.data_sources +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.data_sources ( + Name, + Type, + region +) +SELECT +'{{ Name }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.data_sources ( + AlternateDataSourceParameters, + AwsAccountId, + Credentials, + DataSourceId, + DataSourceParameters, + ErrorInfo, + FolderArns, + Name, + Permissions, + SslProperties, + Tags, + Type, + VpcConnectionProperties, + region +) +SELECT + '{{ AlternateDataSourceParameters }}', + '{{ AwsAccountId }}', + '{{ Credentials }}', + '{{ DataSourceId }}', + '{{ DataSourceParameters }}', + '{{ ErrorInfo }}', + '{{ FolderArns }}', + '{{ Name }}', + '{{ Permissions }}', + '{{ SslProperties }}', + '{{ Tags }}', + '{{ Type }}', + '{{ VpcConnectionProperties }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_source + props: + - name: AlternateDataSourceParameters + value: + - AmazonElasticsearchParameters: + Domain: '{{ Domain }}' + AthenaParameters: + WorkGroup: '{{ WorkGroup }}' + RoleArn: '{{ RoleArn }}' + AuroraParameters: + Host: '{{ Host }}' + Port: null + Database: '{{ Database }}' + AuroraPostgreSqlParameters: + Host: '{{ Host }}' + Port: null + Database: '{{ Database }}' + MariaDbParameters: + Host: '{{ Host }}' + Port: null + Database: '{{ Database }}' + MySqlParameters: + Host: '{{ Host }}' + Port: null + Database: '{{ Database }}' + OracleParameters: + Host: '{{ Host }}' + Port: null + Database: '{{ Database }}' + PostgreSqlParameters: + Host: '{{ Host }}' + Port: null + Database: '{{ Database }}' + PrestoParameters: + Host: '{{ Host }}' + Port: null + Catalog: '{{ Catalog }}' + RdsParameters: + InstanceId: '{{ InstanceId }}' + Database: '{{ Database }}' + RedshiftParameters: + Host: '{{ Host }}' + Port: null + Database: '{{ Database }}' + ClusterId: '{{ ClusterId }}' + IAMParameters: + RoleArn: '{{ RoleArn }}' + DatabaseUser: '{{ DatabaseUser }}' + DatabaseGroups: + - '{{ DatabaseGroups[0] }}' + AutoCreateDatabaseUser: '{{ AutoCreateDatabaseUser }}' + IdentityCenterConfiguration: + EnableIdentityPropagation: '{{ EnableIdentityPropagation }}' + S3Parameters: + ManifestFileLocation: + Bucket: '{{ Bucket }}' + Key: '{{ Key }}' + RoleArn: '{{ RoleArn }}' + SnowflakeParameters: + Host: '{{ Host }}' + Database: '{{ Database }}' + Warehouse: '{{ Warehouse }}' + AuthenticationType: '{{ AuthenticationType }}' + DatabaseAccessControlRole: '{{ DatabaseAccessControlRole }}' + OAuthParameters: + TokenProviderUrl: '{{ TokenProviderUrl }}' + OAuthScope: '{{ OAuthScope }}' + IdentityProviderVpcConnectionProperties: + VpcConnectionArn: '{{ VpcConnectionArn }}' + IdentityProviderResourceUri: '{{ IdentityProviderResourceUri }}' + SparkParameters: + Host: '{{ Host }}' + Port: null + SqlServerParameters: + Host: '{{ Host }}' + Port: null + Database: '{{ Database }}' + TeradataParameters: + Host: '{{ Host }}' + Port: null + Database: '{{ Database }}' + AmazonOpenSearchParameters: + Domain: '{{ Domain }}' + DatabricksParameters: + Host: '{{ Host }}' + Port: null + SqlEndpointPath: '{{ SqlEndpointPath }}' + StarburstParameters: + Host: '{{ Host }}' + Port: null + Catalog: '{{ Catalog }}' + ProductType: '{{ ProductType }}' + DatabaseAccessControlRole: '{{ DatabaseAccessControlRole }}' + AuthenticationType: null + OAuthParameters: null + TrinoParameters: + Host: '{{ Host }}' + Port: null + Catalog: '{{ Catalog }}' + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: Credentials + value: + CredentialPair: + Username: '{{ Username }}' + Password: '{{ Password }}' + AlternateDataSourceParameters: + - null + CopySourceArn: '{{ CopySourceArn }}' + SecretArn: '{{ SecretArn }}' + - name: DataSourceId + value: '{{ DataSourceId }}' + - name: DataSourceParameters + value: null + - name: ErrorInfo + value: + Type: '{{ Type }}' + Message: '{{ Message }}' + - name: FolderArns + value: + - '{{ FolderArns[0] }}' + - name: Name + value: '{{ Name }}' + - name: Permissions + value: + - Principal: '{{ Principal }}' + Actions: + - '{{ Actions[0] }}' + - name: SslProperties + value: + DisableSsl: '{{ DisableSsl }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + - name: VpcConnectionProperties + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.data_sources +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the data_sources resource, the following permissions are required: + +### Read +```json +quicksight:DescribeDataSource, +quicksight:DescribeDataSourcePermissions, +quicksight:ListTagsForResource +``` + +### Create +```json +quicksight:CreateDataSource, +quicksight:DescribeDataSource, +quicksight:DescribeDataSourcePermissions, +quicksight:TagResource, +quicksight:ListTagsForResource, +quicksight:CreateFolderMembership, +quicksight:DeleteFolderMembership, +quicksight:ListFoldersForResource +``` + +### Update +```json +quicksight:DescribeDataSource, +quicksight:DescribeDataSourcePermissions, +quicksight:UpdateDataSource, +quicksight:UpdateDataSourcePermissions, +quicksight:CreateFolderMembership, +quicksight:DeleteFolderMembership, +quicksight:ListFoldersForResource, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### Delete +```json +quicksight:DescribeDataSource, +quicksight:DescribeDataSourcePermissions, +quicksight:DeleteDataSource, +quicksight:ListTagsForResource +``` + +### List +```json +quicksight:DescribeDataSource, +quicksight:ListDataSources +``` diff --git a/website/docs/services/quicksight/data_sources_list_only/index.md b/website/docs/services/quicksight/data_sources_list_only/index.md new file mode 100644 index 0000000..4c7dc84 --- /dev/null +++ b/website/docs/services/quicksight/data_sources_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::DataSource Resource Type.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +aws_account_id, +data_source_id +FROM aws.quicksight.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + diff --git a/website/docs/services/quicksight/folder_tags/index.md b/website/docs/services/quicksight/folder_tags/index.md new file mode 100644 index 0000000..51065b6 --- /dev/null +++ b/website/docs/services/quicksight/folder_tags/index.md @@ -0,0 +1,95 @@ +--- +title: folder_tags +hide_title: false +hide_table_of_contents: false +keywords: + - folder_tags + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for folders in a region + +## Overview + + + + + + + +
Namefolder_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::Folder Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) for the folder.

string
string

The time that the folder was created.

string
string
string

The time that the folder was last updated.

string
string
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all folders in a region. +```sql +SELECT +region, +arn, +aws_account_id, +created_time, +folder_id, +folder_type, +last_updated_time, +name, +parent_folder_arn, +permissions, +sharing_model, +tag_key, +tag_value +FROM aws.quicksight.folder_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the folder_tags resource, see folders + diff --git a/website/docs/services/quicksight/folders/index.md b/website/docs/services/quicksight/folders/index.md new file mode 100644 index 0000000..0a94a6e --- /dev/null +++ b/website/docs/services/quicksight/folders/index.md @@ -0,0 +1,284 @@ +--- +title: folders +hide_title: false +hide_table_of_contents: false +keywords: + - folders + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a folder resource or lists folders in a region + +## Overview + + + + + + + +
Namefolders
TypeResource
DescriptionDefinition of the AWS::QuickSight::Folder Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) for the folder.

string
string

The time that the folder was created.

string
string
string

The time that the folder was last updated.

string
string
array
string
array
stringAWS region.
+ +For more information, see AWS::QuickSight::Folder. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all folders in a region. +```sql +SELECT +region, +arn, +aws_account_id, +created_time, +folder_id, +folder_type, +last_updated_time, +name, +parent_folder_arn, +permissions, +sharing_model, +tags +FROM aws.quicksight.folders +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual folder. +```sql +SELECT +region, +arn, +aws_account_id, +created_time, +folder_id, +folder_type, +last_updated_time, +name, +parent_folder_arn, +permissions, +sharing_model, +tags +FROM aws.quicksight.folders +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new folder resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.folders ( + AwsAccountId, + FolderId, + FolderType, + Name, + ParentFolderArn, + Permissions, + SharingModel, + Tags, + region +) +SELECT +'{{ AwsAccountId }}', + '{{ FolderId }}', + '{{ FolderType }}', + '{{ Name }}', + '{{ ParentFolderArn }}', + '{{ Permissions }}', + '{{ SharingModel }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.folders ( + AwsAccountId, + FolderId, + FolderType, + Name, + ParentFolderArn, + Permissions, + SharingModel, + Tags, + region +) +SELECT + '{{ AwsAccountId }}', + '{{ FolderId }}', + '{{ FolderType }}', + '{{ Name }}', + '{{ ParentFolderArn }}', + '{{ Permissions }}', + '{{ SharingModel }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: folder + props: + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: FolderId + value: '{{ FolderId }}' + - name: FolderType + value: '{{ FolderType }}' + - name: Name + value: '{{ Name }}' + - name: ParentFolderArn + value: '{{ ParentFolderArn }}' + - name: Permissions + value: + - Principal: '{{ Principal }}' + Actions: + - '{{ Actions[0] }}' + - name: SharingModel + value: '{{ SharingModel }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.folders +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the folders resource, the following permissions are required: + +### Read +```json +quicksight:DescribeFolder, +quicksight:DescribeFolderPermissions, +quicksight:ListTagsForResource +``` + +### Create +```json +quicksight:CreateFolder, +quicksight:DescribeFolder, +quicksight:UpdateFolderPermissions, +quicksight:DescribeFolderPermissions, +quicksight:TagResource, +quicksight:ListTagsForResource +``` + +### Update +```json +quicksight:DescribeFolder, +quicksight:UpdateFolder, +quicksight:DescribeFolderPermissions, +quicksight:UpdateFolderPermissions, +quicksight:ListTagsForResource, +quicksight:TagResource, +quicksight:UntagResource +``` + +### Delete +```json +quicksight:DeleteFolder +``` + +### List +```json +quicksight:ListFolders +``` diff --git a/website/docs/services/quicksight/folders_list_only/index.md b/website/docs/services/quicksight/folders_list_only/index.md new file mode 100644 index 0000000..2975bf3 --- /dev/null +++ b/website/docs/services/quicksight/folders_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: folders_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - folders_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists folders in a region or regions, for all properties use folders + +## Overview + + + + + + + +
Namefolders_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Folder Resource Type.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all folders in a region. +```sql +SELECT +region, +aws_account_id, +folder_id +FROM aws.quicksight.folders_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the folders_list_only resource, see folders + diff --git a/website/docs/services/quicksight/index.md b/website/docs/services/quicksight/index.md new file mode 100644 index 0000000..7a2b302 --- /dev/null +++ b/website/docs/services/quicksight/index.md @@ -0,0 +1,66 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The quicksight service documentation. + +:::info Service Summary + +
+
+total resources: 31
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/quicksight/refresh_schedules/index.md b/website/docs/services/quicksight/refresh_schedules/index.md new file mode 100644 index 0000000..1d4bec0 --- /dev/null +++ b/website/docs/services/quicksight/refresh_schedules/index.md @@ -0,0 +1,224 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a refresh_schedule resource or lists refresh_schedules in a region + +## Overview + + + + + + + +
Namerefresh_schedules
TypeResource
DescriptionDefinition of the AWS::QuickSight::RefreshSchedule Resource Type.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string

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

string
string
object
stringAWS region.
+ +For more information, see AWS::QuickSight::RefreshSchedule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all refresh_schedules in a region. +```sql +SELECT +region, +arn, +aws_account_id, +data_set_id, +schedule +FROM aws.quicksight.refresh_schedules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual refresh_schedule. +```sql +SELECT +region, +arn, +aws_account_id, +data_set_id, +schedule +FROM aws.quicksight.refresh_schedules +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new refresh_schedule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.refresh_schedules ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.refresh_schedules ( + AwsAccountId, + DataSetId, + Schedule, + region +) +SELECT + '{{ AwsAccountId }}', + '{{ DataSetId }}', + '{{ Schedule }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: refresh_schedule + props: + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: DataSetId + value: '{{ DataSetId }}' + - name: Schedule + value: + ScheduleId: '{{ ScheduleId }}' + ScheduleFrequency: + Interval: '{{ Interval }}' + RefreshOnDay: + DayOfWeek: '{{ DayOfWeek }}' + DayOfMonth: '{{ DayOfMonth }}' + TimeZone: '{{ TimeZone }}' + TimeOfTheDay: '{{ TimeOfTheDay }}' + StartAfterDateTime: '{{ StartAfterDateTime }}' + RefreshType: '{{ RefreshType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.refresh_schedules +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the refresh_schedules resource, the following permissions are required: + +### Create +```json +quicksight:CreateRefreshSchedule, +quicksight:DescribeRefreshSchedule +``` + +### Update +```json +quicksight:UpdateRefreshSchedule, +quicksight:DescribeRefreshSchedule +``` + +### Delete +```json +quicksight:DeleteRefreshSchedule, +quicksight:DescribeRefreshSchedule +``` + +### List +```json +quicksight:ListRefreshSchedules +``` + +### Read +```json +quicksight:DescribeRefreshSchedule +``` diff --git a/website/docs/services/quicksight/refresh_schedules_list_only/index.md b/website/docs/services/quicksight/refresh_schedules_list_only/index.md new file mode 100644 index 0000000..c3b9673 --- /dev/null +++ b/website/docs/services/quicksight/refresh_schedules_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: refresh_schedules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - refresh_schedules_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists refresh_schedules in a region or regions, for all properties use refresh_schedules + +## Overview + + + + + + + +
Namerefresh_schedules_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::RefreshSchedule Resource Type.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all refresh_schedules in a region. +```sql +SELECT +region, +aws_account_id, +data_set_id, +schedule/schedule_id +FROM aws.quicksight.refresh_schedules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the refresh_schedules_list_only resource, see refresh_schedules + diff --git a/website/docs/services/quicksight/template_tags/index.md b/website/docs/services/quicksight/template_tags/index.md new file mode 100644 index 0000000..c511f08 --- /dev/null +++ b/website/docs/services/quicksight/template_tags/index.md @@ -0,0 +1,99 @@ +--- +title: template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - template_tags + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for templates in a region + +## Overview + + + + + + + +
Nametemplate_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::Template Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

Time when this was created.

string
object

The source entity of the template.

object
string

Time when this was last updated.

object

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

string
object

A version of a template.

string
array
string

The Amazon Resource Name (ARN) of the template.

string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all templates in a region. +```sql +SELECT +region, +created_time, +version_description, +source_entity, +definition, +last_updated_time, +validation_strategy, +name, +version, +aws_account_id, +permissions, +arn, +template_id, +tag_key, +tag_value +FROM aws.quicksight.template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the template_tags resource, see templates + diff --git a/website/docs/services/quicksight/templates/index.md b/website/docs/services/quicksight/templates/index.md new file mode 100644 index 0000000..4cd4272 --- /dev/null +++ b/website/docs/services/quicksight/templates/index.md @@ -0,0 +1,2121 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a template resource or lists templates in a region + +## Overview + + + + + + + +
Nametemplates
TypeResource
DescriptionDefinition of the AWS::QuickSight::Template Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

Time when this was created.

string
object

The source entity of the template.

object
string

Time when this was last updated.

object

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

string
object

A version of a template.

string
array
string

The Amazon Resource Name (ARN) of the template.

array
string
stringAWS region.
+ +For more information, see AWS::QuickSight::Template. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all templates in a region. +```sql +SELECT +region, +created_time, +version_description, +source_entity, +definition, +last_updated_time, +validation_strategy, +name, +version, +aws_account_id, +permissions, +arn, +tags, +template_id +FROM aws.quicksight.templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual template. +```sql +SELECT +region, +created_time, +version_description, +source_entity, +definition, +last_updated_time, +validation_strategy, +name, +version, +aws_account_id, +permissions, +arn, +tags, +template_id +FROM aws.quicksight.templates +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.templates ( + AwsAccountId, + TemplateId, + region +) +SELECT +'{{ AwsAccountId }}', + '{{ TemplateId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.templates ( + VersionDescription, + SourceEntity, + Definition, + ValidationStrategy, + Name, + AwsAccountId, + Permissions, + Tags, + TemplateId, + region +) +SELECT + '{{ VersionDescription }}', + '{{ SourceEntity }}', + '{{ Definition }}', + '{{ ValidationStrategy }}', + '{{ Name }}', + '{{ AwsAccountId }}', + '{{ Permissions }}', + '{{ Tags }}', + '{{ TemplateId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: template + props: + - name: VersionDescription + value: '{{ VersionDescription }}' + - name: SourceEntity + value: + SourceAnalysis: + DataSetReferences: + - DataSetArn: '{{ DataSetArn }}' + DataSetPlaceholder: '{{ DataSetPlaceholder }}' + Arn: '{{ Arn }}' + SourceTemplate: + Arn: '{{ Arn }}' + - name: Definition + value: + Options: + Timezone: '{{ Timezone }}' + WeekStart: '{{ WeekStart }}' + FilterGroups: + - Status: '{{ Status }}' + Filters: + - NestedFilter: + Column: + ColumnName: '{{ ColumnName }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + InnerFilter: + CategoryInnerFilter: + Configuration: + CustomFilterListConfiguration: + CategoryValues: + - '{{ CategoryValues[0] }}' + NullOption: '{{ NullOption }}' + MatchOperator: '{{ MatchOperator }}' + SelectAllOptions: '{{ SelectAllOptions }}' + CustomFilterConfiguration: + CategoryValue: '{{ CategoryValue }}' + ParameterName: '{{ ParameterName }}' + NullOption: null + MatchOperator: null + SelectAllOptions: null + FilterListConfiguration: + CategoryValues: + - '{{ CategoryValues[0] }}' + NullOption: null + MatchOperator: null + SelectAllOptions: null + Column: null + DefaultFilterControlConfiguration: + ControlOptions: + DefaultSliderOptions: + Type: '{{ Type }}' + StepSize: null + DisplayOptions: + TitleOptions: + CustomLabel: '{{ CustomLabel }}' + Visibility: null + FontConfiguration: + FontStyle: '{{ FontStyle }}' + FontSize: + Relative: '{{ Relative }}' + FontDecoration: '{{ FontDecoration }}' + FontColor: '{{ FontColor }}' + FontWeight: + Name: '{{ Name }}' + InfoIconLabelOptions: + Visibility: null + InfoIconText: '{{ InfoIconText }}' + MaximumValue: null + MinimumValue: null + DefaultRelativeDateTimeOptions: + DisplayOptions: + TitleOptions: null + InfoIconLabelOptions: null + DateTimeFormat: '{{ DateTimeFormat }}' + CommitMode: '{{ CommitMode }}' + DefaultTextFieldOptions: + DisplayOptions: + TitleOptions: null + PlaceholderOptions: + Visibility: null + InfoIconLabelOptions: null + DefaultTextAreaOptions: + Delimiter: '{{ Delimiter }}' + DisplayOptions: + TitleOptions: null + PlaceholderOptions: null + InfoIconLabelOptions: null + DefaultDropdownOptions: + Type: '{{ Type }}' + DisplayOptions: + TitleOptions: null + SelectAllOptions: + Visibility: null + InfoIconLabelOptions: null + CommitMode: null + SelectableValues: + Values: + - '{{ Values[0] }}' + DefaultDateTimePickerOptions: + Type: '{{ Type }}' + DisplayOptions: + TitleOptions: null + InfoIconLabelOptions: null + DateTimeFormat: '{{ DateTimeFormat }}' + CommitMode: null + DefaultListOptions: + Type: null + DisplayOptions: + TitleOptions: null + SearchOptions: + Visibility: null + SelectAllOptions: null + InfoIconLabelOptions: null + SelectableValues: null + Title: '{{ Title }}' + IncludeInnerSet: '{{ IncludeInnerSet }}' + FilterId: '{{ FilterId }}' + NumericEqualityFilter: + AggregationFunction: + AttributeAggregationFunction: + SimpleAttributeAggregation: '{{ SimpleAttributeAggregation }}' + ValueForMultipleValues: '{{ ValueForMultipleValues }}' + DateAggregationFunction: '{{ DateAggregationFunction }}' + NumericalAggregationFunction: + PercentileAggregation: + PercentileValue: null + SimpleNumericalAggregation: '{{ SimpleNumericalAggregation }}' + CategoricalAggregationFunction: '{{ CategoricalAggregationFunction }}' + Column: null + Value: null + ParameterName: '{{ ParameterName }}' + NullOption: null + MatchOperator: '{{ MatchOperator }}' + SelectAllOptions: '{{ SelectAllOptions }}' + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + NumericRangeFilter: + AggregationFunction: null + Column: null + IncludeMaximum: '{{ IncludeMaximum }}' + RangeMinimum: + StaticValue: null + Parameter: '{{ Parameter }}' + NullOption: null + SelectAllOptions: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + RangeMaximum: null + IncludeMinimum: '{{ IncludeMinimum }}' + TimeRangeFilter: + RangeMinimumValue: + RollingDate: + Expression: '{{ Expression }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + StaticValue: '{{ StaticValue }}' + Parameter: '{{ Parameter }}' + Column: null + RangeMaximumValue: null + IncludeMaximum: '{{ IncludeMaximum }}' + TimeGranularity: '{{ TimeGranularity }}' + NullOption: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + IncludeMinimum: '{{ IncludeMinimum }}' + ExcludePeriodConfiguration: + Status: null + Amount: null + Granularity: null + RelativeDatesFilter: + RelativeDateValue: null + Column: null + RelativeDateType: '{{ RelativeDateType }}' + TimeGranularity: null + ParameterName: '{{ ParameterName }}' + NullOption: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + AnchorDateConfiguration: + AnchorOption: '{{ AnchorOption }}' + ParameterName: '{{ ParameterName }}' + MinimumGranularity: null + ExcludePeriodConfiguration: null + TopBottomFilter: + AggregationSortConfigurations: + - AggregationFunction: null + SortDirection: '{{ SortDirection }}' + Column: null + Column: null + TimeGranularity: null + ParameterName: '{{ ParameterName }}' + Limit: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + TimeEqualityFilter: + Column: null + RollingDate: null + Value: '{{ Value }}' + TimeGranularity: null + ParameterName: '{{ ParameterName }}' + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + CategoryFilter: + Configuration: null + Column: null + DefaultFilterControlConfiguration: null + FilterId: '{{ FilterId }}' + CrossDataset: '{{ CrossDataset }}' + ScopeConfiguration: + AllSheets: {} + SelectedSheets: + SheetVisualScopingConfigurations: + - Scope: '{{ Scope }}' + SheetId: '{{ SheetId }}' + VisualIds: + - '{{ VisualIds[0] }}' + FilterGroupId: '{{ FilterGroupId }}' + QueryExecutionOptions: + QueryExecutionMode: '{{ QueryExecutionMode }}' + CalculatedFields: + - Expression: '{{ Expression }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + Name: '{{ Name }}' + DataSetConfigurations: + - Placeholder: '{{ Placeholder }}' + DataSetSchema: + ColumnSchemaList: + - DataType: '{{ DataType }}' + GeographicRole: '{{ GeographicRole }}' + Name: '{{ Name }}' + ColumnGroupSchemaList: + - ColumnGroupColumnSchemaList: + - Name: '{{ Name }}' + Name: '{{ Name }}' + ColumnConfigurations: + - Role: '{{ Role }}' + FormatConfiguration: + NumberFormatConfiguration: + FormatConfiguration: + NumberDisplayFormatConfiguration: + NegativeValueConfiguration: + DisplayMode: '{{ DisplayMode }}' + DecimalPlacesConfiguration: + DecimalPlaces: null + NumberScale: '{{ NumberScale }}' + NullValueFormatConfiguration: + NullString: '{{ NullString }}' + Suffix: '{{ Suffix }}' + SeparatorConfiguration: + DecimalSeparator: '{{ DecimalSeparator }}' + ThousandsSeparator: + Symbol: null + Visibility: null + Prefix: '{{ Prefix }}' + CurrencyDisplayFormatConfiguration: + NegativeValueConfiguration: null + DecimalPlacesConfiguration: null + NumberScale: null + NullValueFormatConfiguration: null + Suffix: '{{ Suffix }}' + SeparatorConfiguration: null + Symbol: '{{ Symbol }}' + Prefix: '{{ Prefix }}' + PercentageDisplayFormatConfiguration: + NegativeValueConfiguration: null + DecimalPlacesConfiguration: null + NullValueFormatConfiguration: null + Suffix: '{{ Suffix }}' + SeparatorConfiguration: null + Prefix: '{{ Prefix }}' + DateTimeFormatConfiguration: + NumericFormatConfiguration: null + NullValueFormatConfiguration: null + DateTimeFormat: '{{ DateTimeFormat }}' + StringFormatConfiguration: + NumericFormatConfiguration: null + NullValueFormatConfiguration: null + Column: null + ColorsConfiguration: + CustomColors: + - Color: '{{ Color }}' + FieldValue: '{{ FieldValue }}' + SpecialValue: '{{ SpecialValue }}' + AnalysisDefaults: + DefaultNewSheetConfiguration: + SheetContentType: '{{ SheetContentType }}' + InteractiveLayoutConfiguration: + FreeForm: + CanvasSizeOptions: + ScreenCanvasSizeOptions: + OptimizedViewPortWidth: '{{ OptimizedViewPortWidth }}' + Grid: + CanvasSizeOptions: + ScreenCanvasSizeOptions: + OptimizedViewPortWidth: '{{ OptimizedViewPortWidth }}' + ResizeOption: '{{ ResizeOption }}' + PaginatedLayoutConfiguration: + SectionBased: + CanvasSizeOptions: + PaperCanvasSizeOptions: + PaperMargin: + Left: '{{ Left }}' + Top: '{{ Top }}' + Right: '{{ Right }}' + Bottom: '{{ Bottom }}' + PaperSize: '{{ PaperSize }}' + PaperOrientation: '{{ PaperOrientation }}' + Sheets: + - Description: '{{ Description }}' + ParameterControls: + - Slider: + ParameterControlId: '{{ ParameterControlId }}' + StepSize: null + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + MaximumValue: null + MinimumValue: null + TextArea: + ParameterControlId: '{{ ParameterControlId }}' + Delimiter: '{{ Delimiter }}' + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + Dropdown: + ParameterControlId: '{{ ParameterControlId }}' + Type: null + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + CascadingControlConfiguration: + SourceControls: + - SourceSheetControlId: '{{ SourceSheetControlId }}' + ColumnToMatch: null + Title: '{{ Title }}' + CommitMode: null + SelectableValues: + LinkToDataSetColumn: null + Values: + - '{{ Values[0] }}' + TextField: + ParameterControlId: '{{ ParameterControlId }}' + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + List: + ParameterControlId: '{{ ParameterControlId }}' + Type: null + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + CascadingControlConfiguration: null + Title: '{{ Title }}' + SelectableValues: null + DateTimePicker: + ParameterControlId: '{{ ParameterControlId }}' + DisplayOptions: null + SourceParameterName: '{{ SourceParameterName }}' + Title: '{{ Title }}' + TextBoxes: + - SheetTextBoxId: '{{ SheetTextBoxId }}' + Content: '{{ Content }}' + Layouts: + - Configuration: + GridLayout: + CanvasSizeOptions: null + Elements: + - ElementType: '{{ ElementType }}' + ColumnSpan: null + ColumnIndex: null + RowIndex: null + RowSpan: null + ElementId: '{{ ElementId }}' + FreeFormLayout: + CanvasSizeOptions: null + Elements: + - ElementType: null + BorderStyle: + Color: '{{ Color }}' + Visibility: null + Height: '{{ Height }}' + Visibility: null + RenderingRules: + - Expression: '{{ Expression }}' + ConfigurationOverrides: + Visibility: null + YAxisLocation: '{{ YAxisLocation }}' + LoadingAnimation: + Visibility: null + Width: '{{ Width }}' + BackgroundStyle: + Color: '{{ Color }}' + Visibility: null + ElementId: '{{ ElementId }}' + XAxisLocation: '{{ XAxisLocation }}' + SelectedBorderStyle: null + SectionBasedLayout: + CanvasSizeOptions: null + FooterSections: + - Layout: + FreeFormLayout: + Elements: + - null + Style: + Padding: null + Height: '{{ Height }}' + SectionId: '{{ SectionId }}' + BodySections: + - Content: + Layout: null + Style: null + PageBreakConfiguration: + After: + Status: '{{ Status }}' + SectionId: '{{ SectionId }}' + HeaderSections: + - null + ContentType: null + SheetId: '{{ SheetId }}' + FilterControls: + - Slider: + FilterControlId: '{{ FilterControlId }}' + Type: null + StepSize: null + DisplayOptions: null + Title: '{{ Title }}' + MaximumValue: null + SourceFilterId: '{{ SourceFilterId }}' + MinimumValue: null + TextArea: + FilterControlId: '{{ FilterControlId }}' + Delimiter: '{{ Delimiter }}' + DisplayOptions: null + Title: '{{ Title }}' + SourceFilterId: '{{ SourceFilterId }}' + Dropdown: + FilterControlId: '{{ FilterControlId }}' + Type: null + DisplayOptions: null + CascadingControlConfiguration: null + Title: '{{ Title }}' + CommitMode: null + SourceFilterId: '{{ SourceFilterId }}' + SelectableValues: null + TextField: + FilterControlId: '{{ FilterControlId }}' + DisplayOptions: null + Title: '{{ Title }}' + SourceFilterId: '{{ SourceFilterId }}' + List: + FilterControlId: '{{ FilterControlId }}' + Type: null + DisplayOptions: null + CascadingControlConfiguration: null + Title: '{{ Title }}' + SourceFilterId: '{{ SourceFilterId }}' + SelectableValues: null + DateTimePicker: + FilterControlId: '{{ FilterControlId }}' + Type: null + DisplayOptions: null + Title: '{{ Title }}' + CommitMode: null + SourceFilterId: '{{ SourceFilterId }}' + RelativeDateTime: + FilterControlId: '{{ FilterControlId }}' + DisplayOptions: null + Title: '{{ Title }}' + CommitMode: null + SourceFilterId: '{{ SourceFilterId }}' + CrossSheet: + FilterControlId: '{{ FilterControlId }}' + CascadingControlConfiguration: null + SourceFilterId: '{{ SourceFilterId }}' + Images: + - Actions: + - Status: null + Trigger: '{{ Trigger }}' + CustomActionId: '{{ CustomActionId }}' + Name: '{{ Name }}' + ActionOperations: + - NavigationOperation: + LocalNavigationConfiguration: + TargetSheetId: '{{ TargetSheetId }}' + SetParametersOperation: + ParameterValueConfigurations: + - DestinationParameterName: '{{ DestinationParameterName }}' + Value: + CustomValuesConfiguration: + IncludeNullValue: '{{ IncludeNullValue }}' + CustomValues: + DecimalValues: + - null + IntegerValues: + - null + StringValues: + - '{{ StringValues[0] }}' + DateTimeValues: + - '{{ DateTimeValues[0] }}' + SourceParameterName: '{{ SourceParameterName }}' + SelectAllValueOptions: '{{ SelectAllValueOptions }}' + SourceField: '{{ SourceField }}' + SourceColumn: null + URLOperation: + URLTemplate: '{{ URLTemplate }}' + URLTarget: '{{ URLTarget }}' + SheetImageId: '{{ SheetImageId }}' + Tooltip: + Visibility: null + TooltipText: + PlainText: '{{ PlainText }}' + Scaling: + ScalingType: '{{ ScalingType }}' + Interactions: + ImageMenuOption: + AvailabilityStatus: null + Source: + SheetImageStaticFileSource: + StaticFileId: '{{ StaticFileId }}' + ImageContentAltText: '{{ ImageContentAltText }}' + SheetControlLayouts: + - Configuration: + GridLayout: null + Title: '{{ Title }}' + Visuals: + - FunnelChartVisual: + Subtitle: + Visibility: null + FormatText: + RichText: '{{ RichText }}' + PlainText: '{{ PlainText }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategoryItemsLimit: + ItemsLimit: null + OtherCategories: '{{ OtherCategories }}' + CategorySort: + - FieldSort: + FieldId: '{{ FieldId }}' + Direction: null + ColumnSort: + AggregationFunction: null + SortBy: null + Direction: null + DataLabelOptions: + MeasureLabelVisibility: null + Position: '{{ Position }}' + Visibility: null + CategoryLabelVisibility: null + LabelColor: '{{ LabelColor }}' + MeasureDataLabelStyle: '{{ MeasureDataLabelStyle }}' + LabelFontConfiguration: null + CategoryLabelOptions: + Visibility: null + SortIconVisibility: null + AxisLabelOptions: + - CustomLabel: '{{ CustomLabel }}' + ApplyTo: + Column: null + FieldId: '{{ FieldId }}' + FontConfiguration: null + FieldWells: + FunnelChartAggregatedFieldWells: + Category: + - DateDimensionField: + HierarchyId: '{{ HierarchyId }}' + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + DateGranularity: null + NumericalDimensionField: + HierarchyId: '{{ HierarchyId }}' + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + CategoricalDimensionField: + HierarchyId: '{{ HierarchyId }}' + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + Values: + - DateMeasureField: + AggregationFunction: null + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + NumericalMeasureField: + AggregationFunction: null + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + CategoricalMeasureField: + AggregationFunction: null + FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + CalculatedMeasureField: + Expression: '{{ Expression }}' + FieldId: '{{ FieldId }}' + Tooltip: + SelectedTooltipType: '{{ SelectedTooltipType }}' + TooltipVisibility: null + FieldBasedTooltip: + TooltipFields: + - FieldTooltipItem: + TooltipTarget: '{{ TooltipTarget }}' + FieldId: '{{ FieldId }}' + Label: '{{ Label }}' + Visibility: null + ColumnTooltipItem: + Aggregation: null + TooltipTarget: null + Column: null + Label: '{{ Label }}' + Visibility: null + AggregationVisibility: null + TooltipTitleType: '{{ TooltipTitleType }}' + ValueLabelOptions: null + VisualPalette: + ChartColor: '{{ ChartColor }}' + ColorMap: + - Element: + DataPathType: + PivotTableDataPathType: '{{ PivotTableDataPathType }}' + FieldId: '{{ FieldId }}' + FieldValue: '{{ FieldValue }}' + Color: '{{ Color }}' + TimeGranularity: null + Actions: + - Status: null + Trigger: '{{ Trigger }}' + CustomActionId: '{{ CustomActionId }}' + Name: '{{ Name }}' + ActionOperations: + - NavigationOperation: null + SetParametersOperation: null + FilterOperation: + SelectedFieldsConfiguration: + SelectedColumns: + - null + SelectedFields: + - '{{ SelectedFields[0] }}' + SelectedFieldOptions: '{{ SelectedFieldOptions }}' + TargetVisualsConfiguration: + SameSheetTargetVisualConfiguration: + TargetVisualOptions: '{{ TargetVisualOptions }}' + TargetVisuals: + - '{{ TargetVisuals[0] }}' + URLOperation: null + Title: + Visibility: null + FormatText: + RichText: '{{ RichText }}' + PlainText: '{{ PlainText }}' + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - DateTimeHierarchy: + HierarchyId: '{{ HierarchyId }}' + DrillDownFilters: + - NumericEqualityFilter: + Column: null + Value: null + TimeRangeFilter: + Column: null + RangeMinimum: '{{ RangeMinimum }}' + TimeGranularity: null + RangeMaximum: '{{ RangeMaximum }}' + CategoryFilter: + Column: null + CategoryValues: + - '{{ CategoryValues[0] }}' + ExplicitHierarchy: + HierarchyId: '{{ HierarchyId }}' + DrillDownFilters: + - null + Columns: + - null + PredefinedHierarchy: + HierarchyId: '{{ HierarchyId }}' + DrillDownFilters: + - null + Columns: + - null + BoxPlotVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategorySort: + - null + PaginationConfiguration: + PageSize: null + PageNumber: null + Legend: + Position: '{{ Position }}' + ValueFontConfiguration: null + Title: null + Visibility: null + Height: '{{ Height }}' + Width: '{{ Width }}' + ReferenceLines: + - Status: null + DataConfiguration: + DynamicConfiguration: + Column: null + MeasureAggregationFunction: null + Calculation: null + AxisBinding: '{{ AxisBinding }}' + SeriesType: '{{ SeriesType }}' + StaticConfiguration: + Value: null + LabelConfiguration: + HorizontalPosition: '{{ HorizontalPosition }}' + ValueLabelConfiguration: + FormatConfiguration: null + RelativePosition: '{{ RelativePosition }}' + CustomLabelConfiguration: + CustomLabel: '{{ CustomLabel }}' + FontColor: '{{ FontColor }}' + FontConfiguration: null + VerticalPosition: '{{ VerticalPosition }}' + StyleConfiguration: + Pattern: '{{ Pattern }}' + Color: '{{ Color }}' + CategoryAxis: + DataOptions: + DateAxisOptions: + MissingDateVisibility: null + NumericAxisOptions: + Scale: + Logarithmic: + Base: null + Linear: + StepSize: null + StepCount: null + Range: + DataDriven: {} + MinMax: + Minimum: null + Maximum: null + TickLabelOptions: + RotationAngle: null + LabelOptions: null + AxisOffset: '{{ AxisOffset }}' + AxisLineVisibility: null + GridLineVisibility: null + ScrollbarOptions: + VisibleRange: + PercentRange: + From: null + To: null + Visibility: null + PrimaryYAxisLabelOptions: null + CategoryLabelOptions: null + FieldWells: + BoxPlotAggregatedFieldWells: + GroupBy: + - null + Values: + - null + Tooltip: null + BoxPlotOptions: + StyleOptions: + FillStyle: '{{ FillStyle }}' + OutlierVisibility: null + AllDataPointsVisibility: null + PrimaryYAxisDisplayOptions: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + GeospatialMapVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + Legend: null + MapStyleOptions: + BaseMapStyle: '{{ BaseMapStyle }}' + FieldWells: + GeospatialMapAggregatedFieldWells: + Colors: + - null + Values: + - null + Geospatial: + - null + Tooltip: null + WindowOptions: + Bounds: + West: null + South: null + North: null + East: null + MapZoomMode: '{{ MapZoomMode }}' + PointStyleOptions: + SelectedPointStyle: '{{ SelectedPointStyle }}' + ClusterMarkerConfiguration: + ClusterMarker: + SimpleClusterMarker: + Color: '{{ Color }}' + HeatmapConfiguration: + HeatmapColor: + Colors: + - Color: '{{ Color }}' + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + ScatterPlotVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + YAxisLabelOptions: null + Legend: null + YAxisDisplayOptions: null + DataLabels: + DataLabelTypes: + - MaximumLabelType: + Visibility: null + DataPathLabelType: + FieldId: '{{ FieldId }}' + Visibility: null + FieldValue: '{{ FieldValue }}' + RangeEndsLabelType: + Visibility: null + FieldLabelType: + FieldId: '{{ FieldId }}' + Visibility: null + MinimumLabelType: + Visibility: null + MeasureLabelVisibility: null + Position: null + LabelContent: '{{ LabelContent }}' + Visibility: null + TotalsVisibility: null + Overlap: '{{ Overlap }}' + CategoryLabelVisibility: null + LabelColor: '{{ LabelColor }}' + LabelFontConfiguration: null + FieldWells: + ScatterPlotUnaggregatedFieldWells: + Category: + - null + Size: + - null + Label: + - null + XAxis: + - null + YAxis: + - null + ScatterPlotCategoricallyAggregatedFieldWells: + Category: + - null + Size: + - null + Label: + - null + XAxis: + - null + YAxis: + - null + Tooltip: null + XAxisLabelOptions: null + VisualPalette: null + XAxisDisplayOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + RadarChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + ColorSort: + - null + ColorItemsLimit: null + CategoryItemsLimit: null + CategorySort: + - null + Legend: null + Shape: '{{ Shape }}' + BaseSeriesSettings: + AreaStyleSettings: + Visibility: null + ColorLabelOptions: null + CategoryLabelOptions: null + AxesRangeScale: '{{ AxesRangeScale }}' + VisualPalette: null + AlternateBandColorsVisibility: null + StartAngle: null + CategoryAxis: null + FieldWells: + RadarChartAggregatedFieldWells: + Category: + - null + Color: + - null + Values: + - null + ColorAxis: null + AlternateBandOddColor: '{{ AlternateBandOddColor }}' + AlternateBandEvenColor: '{{ AlternateBandEvenColor }}' + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + ComboChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + ColorSort: + - null + ColorItemsLimit: null + CategoryItemsLimit: null + CategorySort: + - null + Legend: null + ReferenceLines: + - null + ColorLabelOptions: null + BarDataLabels: null + CategoryLabelOptions: null + Tooltip: null + SingleAxisOptions: + YAxisOptions: + YAxis: '{{ YAxis }}' + PrimaryYAxisDisplayOptions: null + VisualPalette: null + BarsArrangement: '{{ BarsArrangement }}' + SecondaryYAxisLabelOptions: null + LineDataLabels: null + CategoryAxis: null + PrimaryYAxisLabelOptions: null + FieldWells: + ComboChartAggregatedFieldWells: + BarValues: + - null + Category: + - null + Colors: + - null + LineValues: + - null + SecondaryYAxisDisplayOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + WordCloudVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategoryItemsLimit: null + CategorySort: + - null + CategoryLabelOptions: null + FieldWells: + WordCloudAggregatedFieldWells: + GroupBy: + - null + Size: + - null + WordCloudOptions: + WordOrientation: '{{ WordOrientation }}' + WordScaling: '{{ WordScaling }}' + CloudLayout: '{{ CloudLayout }}' + MaximumStringLength: null + WordCasing: '{{ WordCasing }}' + WordPadding: '{{ WordPadding }}' + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + SankeyDiagramVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + WeightSort: + - null + SourceItemsLimit: null + DestinationItemsLimit: null + DataLabels: null + FieldWells: + SankeyDiagramAggregatedFieldWells: + Destination: + - null + Source: + - null + Weight: + - null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + GaugeChartVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Arc: + ForegroundColor: + Gradient: + Expression: '{{ Expression }}' + Color: + Stops: + - GradientOffset: null + DataValue: null + Color: '{{ Color }}' + Solid: + Expression: '{{ Expression }}' + Color: '{{ Color }}' + PrimaryValue: + TextColor: null + Icon: + CustomCondition: + Expression: '{{ Expression }}' + Color: '{{ Color }}' + DisplayConfiguration: + IconDisplayOption: '{{ IconDisplayOption }}' + IconOptions: + UnicodeIcon: '{{ UnicodeIcon }}' + Icon: '{{ Icon }}' + IconSet: + Expression: '{{ Expression }}' + IconSetType: '{{ IconSetType }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + DataLabels: null + FieldWells: + TargetValues: + - null + Values: + - null + TooltipOptions: null + GaugeChartOptions: + Arc: + ArcAngle: null + ArcThickness: '{{ ArcThickness }}' + Comparison: + ComparisonMethod: '{{ ComparisonMethod }}' + ComparisonFormat: + NumberDisplayFormatConfiguration: null + PercentageDisplayFormatConfiguration: null + PrimaryValueDisplayType: '{{ PrimaryValueDisplayType }}' + ArcAxis: + Range: + Min: null + Max: null + ReserveRange: null + PrimaryValueFontConfiguration: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + FilledMapVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Shape: + Format: + BackgroundColor: null + FieldId: '{{ FieldId }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategorySort: + - null + Legend: null + MapStyleOptions: null + FieldWells: + FilledMapAggregatedFieldWells: + Values: + - null + Geospatial: + - null + Tooltip: null + WindowOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + WaterfallVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + CategoryAxisLabelOptions: null + SortConfiguration: + BreakdownItemsLimit: null + CategorySort: + - null + Legend: null + DataLabels: null + PrimaryYAxisLabelOptions: null + FieldWells: + WaterfallChartAggregatedFieldWells: + Categories: + - null + Breakdowns: + - null + Values: + - null + WaterfallChartOptions: + TotalBarLabel: '{{ TotalBarLabel }}' + ColorConfiguration: + GroupColorConfiguration: + NegativeBarColor: '{{ NegativeBarColor }}' + TotalBarColor: '{{ TotalBarColor }}' + PositiveBarColor: '{{ PositiveBarColor }}' + CategoryAxisDisplayOptions: null + PrimaryYAxisDisplayOptions: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + CustomContentVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + ContentUrl: '{{ ContentUrl }}' + ContentType: '{{ ContentType }}' + ImageScaling: '{{ ImageScaling }}' + Actions: + - null + DataSetIdentifier: '{{ DataSetIdentifier }}' + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + PieChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + SmallMultiplesSort: + - null + CategoryItemsLimit: null + CategorySort: + - null + SmallMultiplesLimitConfiguration: null + Legend: null + DataLabels: null + ContributionAnalysisDefaults: + - MeasureFieldId: '{{ MeasureFieldId }}' + ContributorDimensions: + - null + CategoryLabelOptions: null + FieldWells: + PieChartAggregatedFieldWells: + Category: + - null + Values: + - null + SmallMultiples: + - null + Tooltip: null + DonutOptions: + DonutCenterOptions: + LabelVisibility: null + ArcOptions: + ArcThickness: '{{ ArcThickness }}' + SmallMultiplesOptions: + MaxVisibleRows: null + PanelConfiguration: + BorderThickness: '{{ BorderThickness }}' + BorderStyle: '{{ BorderStyle }}' + GutterSpacing: '{{ GutterSpacing }}' + BackgroundVisibility: null + BorderVisibility: null + BorderColor: '{{ BorderColor }}' + Title: + Visibility: null + FontConfiguration: null + HorizontalTextAlignment: '{{ HorizontalTextAlignment }}' + GutterVisibility: null + BackgroundColor: '{{ BackgroundColor }}' + MaxVisibleColumns: null + XAxis: + Placement: '{{ Placement }}' + Scale: '{{ Scale }}' + YAxis: null + ValueLabelOptions: null + VisualPalette: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + KPIVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - PrimaryValue: + TextColor: null + Icon: null + ActualValue: + TextColor: null + Icon: null + ComparisonValue: + TextColor: null + Icon: null + ProgressBar: + ForegroundColor: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + TrendGroupSort: + - null + KPIOptions: + SecondaryValueFontConfiguration: null + VisualLayoutOptions: + StandardLayout: + Type: '{{ Type }}' + TrendArrows: + Visibility: null + SecondaryValue: + Visibility: null + Comparison: null + PrimaryValueDisplayType: null + ProgressBar: + Visibility: null + PrimaryValueFontConfiguration: null + Sparkline: + Type: '{{ Type }}' + Color: '{{ Color }}' + TooltipVisibility: null + Visibility: null + FieldWells: + TargetValues: + - null + TrendGroups: + - null + Values: + - null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + HistogramVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + YAxisDisplayOptions: null + DataLabels: null + BinOptions: + BinWidth: + BinCountLimit: null + Value: null + StartValue: null + SelectedBinType: '{{ SelectedBinType }}' + BinCount: + Value: null + FieldWells: + HistogramAggregatedFieldWells: + Values: + - null + Tooltip: null + XAxisLabelOptions: null + VisualPalette: null + XAxisDisplayOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + PluginVisual: + Subtitle: null + PluginArn: '{{ PluginArn }}' + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + PluginVisualTableQuerySort: + ItemsLimitConfiguration: + ItemsLimit: null + RowSort: + - null + VisualOptions: + VisualProperties: + - Value: '{{ Value }}' + Name: '{{ Name }}' + FieldWells: + - Unaggregated: + - FormatConfiguration: null + Column: null + FieldId: '{{ FieldId }}' + AxisName: '{{ AxisName }}' + Measures: + - null + Dimensions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + TableVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Row: + TextColor: null + BackgroundColor: null + Cell: + FieldId: '{{ FieldId }}' + TextFormat: + TextColor: null + Icon: null + BackgroundColor: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + RowSort: + - null + PaginationConfiguration: null + PaginatedReportOptions: + OverflowColumnHeaderVisibility: null + VerticalOverflowVisibility: null + TableOptions: + HeaderStyle: + VerticalTextAlignment: '{{ VerticalTextAlignment }}' + Visibility: null + Height: null + FontConfiguration: null + Border: + UniformBorder: + Thickness: null + Color: '{{ Color }}' + Style: '{{ Style }}' + SideSpecificBorder: + Left: null + Top: null + InnerHorizontal: null + Right: null + Bottom: null + InnerVertical: null + TextWrap: '{{ TextWrap }}' + HorizontalTextAlignment: null + BackgroundColor: '{{ BackgroundColor }}' + CellStyle: null + Orientation: '{{ Orientation }}' + RowAlternateColorOptions: + Status: null + UsePrimaryBackgroundColor: null + RowAlternateColors: + - '{{ RowAlternateColors[0] }}' + TableInlineVisualizations: + - DataBars: + PositiveColor: '{{ PositiveColor }}' + FieldId: '{{ FieldId }}' + NegativeColor: '{{ NegativeColor }}' + FieldWells: + TableUnaggregatedFieldWells: + Values: + - null + TableAggregatedFieldWells: + GroupBy: + - null + Values: + - null + FieldOptions: + Order: + - '{{ Order[0] }}' + PinnedFieldOptions: + PinnedLeftFields: + - '{{ PinnedLeftFields[0] }}' + SelectedFieldOptions: + - CustomLabel: '{{ CustomLabel }}' + URLStyling: + LinkConfiguration: + Target: null + Content: + CustomIconContent: + Icon: '{{ Icon }}' + CustomTextContent: + Value: '{{ Value }}' + FontConfiguration: null + ImageConfiguration: + SizingOptions: + TableCellImageScalingConfiguration: '{{ TableCellImageScalingConfiguration }}' + FieldId: '{{ FieldId }}' + Visibility: null + Width: '{{ Width }}' + TotalOptions: + TotalAggregationOptions: + - TotalAggregationFunction: + SimpleTotalAggregationFunction: '{{ SimpleTotalAggregationFunction }}' + FieldId: '{{ FieldId }}' + CustomLabel: '{{ CustomLabel }}' + ScrollStatus: '{{ ScrollStatus }}' + Placement: '{{ Placement }}' + TotalCellStyle: null + TotalsVisibility: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + PivotTableVisual: + Subtitle: null + ConditionalFormatting: + ConditionalFormattingOptions: + - Cell: + Scope: + Role: '{{ Role }}' + Scopes: + - null + FieldId: '{{ FieldId }}' + TextFormat: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + FieldSortOptions: + - SortBy: + Field: null + DataPath: + SortPaths: + - null + Direction: null + Column: null + FieldId: '{{ FieldId }}' + PaginatedReportOptions: + OverflowColumnHeaderVisibility: null + VerticalOverflowVisibility: null + TableOptions: + RowFieldNamesStyle: null + RowHeaderStyle: null + CollapsedRowDimensionsVisibility: null + RowsLayout: '{{ RowsLayout }}' + MetricPlacement: '{{ MetricPlacement }}' + DefaultCellWidth: '{{ DefaultCellWidth }}' + ColumnNamesVisibility: null + RowsLabelOptions: + CustomLabel: '{{ CustomLabel }}' + Visibility: null + SingleMetricVisibility: null + ColumnHeaderStyle: null + ToggleButtonsVisibility: null + CellStyle: null + RowAlternateColorOptions: null + FieldWells: + PivotTableAggregatedFieldWells: + Values: + - null + Columns: + - null + Rows: + - null + FieldOptions: + CollapseStateOptions: + - Target: + FieldId: '{{ FieldId }}' + FieldDataPathValues: + - null + State: '{{ State }}' + DataPathOptions: + - DataPathList: + - null + Width: '{{ Width }}' + SelectedFieldOptions: + - CustomLabel: '{{ CustomLabel }}' + FieldId: '{{ FieldId }}' + Visibility: null + TotalOptions: + ColumnSubtotalOptions: + CustomLabel: '{{ CustomLabel }}' + FieldLevelOptions: + - FieldId: '{{ FieldId }}' + ValueCellStyle: null + TotalCellStyle: null + TotalsVisibility: null + FieldLevel: '{{ FieldLevel }}' + MetricHeaderCellStyle: null + StyleTargets: + - CellType: '{{ CellType }}' + RowSubtotalOptions: null + RowTotalOptions: + TotalAggregationOptions: + - null + CustomLabel: '{{ CustomLabel }}' + ValueCellStyle: null + ScrollStatus: null + Placement: null + TotalCellStyle: null + TotalsVisibility: null + MetricHeaderCellStyle: null + ColumnTotalOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + BarChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + SmallMultiplesSort: + - null + ColorSort: + - null + ColorItemsLimit: null + CategoryItemsLimit: null + CategorySort: + - null + SmallMultiplesLimitConfiguration: null + Legend: null + ReferenceLines: + - null + DataLabels: null + ColorLabelOptions: null + CategoryLabelOptions: null + Tooltip: null + SmallMultiplesOptions: null + Orientation: '{{ Orientation }}' + VisualPalette: null + ValueLabelOptions: null + BarsArrangement: null + CategoryAxis: null + ContributionAnalysisDefaults: + - null + FieldWells: + BarChartAggregatedFieldWells: + Category: + - null + Colors: + - null + Values: + - null + SmallMultiples: + - null + ValueAxis: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + HeatMapVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + HeatMapRowSort: + - null + HeatMapRowItemsLimitConfiguration: null + HeatMapColumnItemsLimitConfiguration: null + HeatMapColumnSort: + - null + ColumnLabelOptions: null + Legend: null + DataLabels: null + FieldWells: + HeatMapAggregatedFieldWells: + Values: + - null + Columns: + - null + Rows: + - null + Tooltip: null + ColorScale: + Colors: + - DataValue: null + Color: '{{ Color }}' + ColorFillType: '{{ ColorFillType }}' + NullValueColor: null + RowLabelOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + TreeMapVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + TreeMapSort: + - null + TreeMapGroupItemsLimitConfiguration: null + Legend: null + DataLabels: null + ColorLabelOptions: null + SizeLabelOptions: null + FieldWells: + TreeMapAggregatedFieldWells: + Sizes: + - null + Colors: + - null + Groups: + - null + Tooltip: null + ColorScale: null + GroupLabelOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + InsightVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + Actions: + - null + DataSetIdentifier: '{{ DataSetIdentifier }}' + InsightConfiguration: + Computations: + - PeriodToDate: + PeriodTimeGranularity: null + Value: null + Time: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + GrowthRate: + Value: null + Time: null + PeriodSize: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + TopBottomRanked: + Type: '{{ Type }}' + Category: null + ResultSize: null + Value: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + TotalAggregation: + Value: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + Forecast: + PeriodsBackward: null + PeriodsForward: null + PredictionInterval: null + Seasonality: '{{ Seasonality }}' + CustomSeasonalityValue: null + Value: null + Time: null + UpperBoundary: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + LowerBoundary: null + MaximumMinimum: + Type: '{{ Type }}' + Value: null + Time: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + PeriodOverPeriod: + Value: null + Time: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + MetricComparison: + TargetValue: null + Time: null + ComputationId: '{{ ComputationId }}' + FromValue: null + Name: '{{ Name }}' + TopBottomMovers: + Type: null + Category: null + Value: null + SortOrder: '{{ SortOrder }}' + Time: null + MoverSize: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + UniqueValues: + Category: null + ComputationId: '{{ ComputationId }}' + Name: '{{ Name }}' + CustomNarrative: + Narrative: '{{ Narrative }}' + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + LineChartVisual: + Subtitle: null + VisualId: '{{ VisualId }}' + ChartConfiguration: + SortConfiguration: + CategoryItemsLimitConfiguration: null + ColorItemsLimitConfiguration: null + SmallMultiplesSort: + - null + CategorySort: + - null + SmallMultiplesLimitConfiguration: null + Legend: null + ReferenceLines: + - null + DataLabels: null + Tooltip: null + SingleAxisOptions: null + SmallMultiplesOptions: null + PrimaryYAxisDisplayOptions: + MissingDataConfigurations: + - TreatmentOption: '{{ TreatmentOption }}' + AxisOptions: null + VisualPalette: null + XAxisDisplayOptions: null + DefaultSeriesSettings: + LineStyleSettings: + LineInterpolation: '{{ LineInterpolation }}' + LineStyle: '{{ LineStyle }}' + LineVisibility: null + LineWidth: '{{ LineWidth }}' + AxisBinding: null + MarkerStyleSettings: + MarkerShape: '{{ MarkerShape }}' + MarkerSize: '{{ MarkerSize }}' + MarkerVisibility: null + MarkerColor: '{{ MarkerColor }}' + SecondaryYAxisLabelOptions: null + ForecastConfigurations: + - ForecastProperties: + PeriodsBackward: null + PeriodsForward: null + PredictionInterval: null + Seasonality: null + UpperBoundary: null + LowerBoundary: null + Scenario: + WhatIfRangeScenario: + StartDate: '{{ StartDate }}' + Value: null + EndDate: '{{ EndDate }}' + WhatIfPointScenario: + Value: null + Date: '{{ Date }}' + Series: + - FieldSeriesItem: + FieldId: '{{ FieldId }}' + AxisBinding: null + Settings: + LineStyleSettings: null + MarkerStyleSettings: null + DataFieldSeriesItem: + FieldId: '{{ FieldId }}' + AxisBinding: null + FieldValue: '{{ FieldValue }}' + Settings: null + Type: '{{ Type }}' + PrimaryYAxisLabelOptions: null + ContributionAnalysisDefaults: + - null + FieldWells: + LineChartAggregatedFieldWells: + Category: + - null + Colors: + - null + Values: + - null + SmallMultiples: + - null + SecondaryYAxisDisplayOptions: null + XAxisLabelOptions: null + Actions: + - null + Title: null + VisualContentAltText: '{{ VisualContentAltText }}' + ColumnHierarchies: + - null + EmptyVisual: + VisualId: '{{ VisualId }}' + Actions: + - null + DataSetIdentifier: '{{ DataSetIdentifier }}' + Name: '{{ Name }}' + ParameterDeclarations: + - StringParameterDeclaration: + MappedDataSetParameters: + - DataSetParameterName: '{{ DataSetParameterName }}' + DataSetIdentifier: '{{ DataSetIdentifier }}' + DefaultValues: + DynamicValue: + GroupNameColumn: null + DefaultValueColumn: null + UserNameColumn: null + StaticValues: + - '{{ StaticValues[0] }}' + ParameterValueType: '{{ ParameterValueType }}' + ValueWhenUnset: + ValueWhenUnsetOption: '{{ ValueWhenUnsetOption }}' + CustomValue: '{{ CustomValue }}' + Name: '{{ Name }}' + DateTimeParameterDeclaration: + MappedDataSetParameters: + - null + DefaultValues: + RollingDate: null + DynamicValue: null + StaticValues: + - '{{ StaticValues[0] }}' + TimeGranularity: null + ValueWhenUnset: + ValueWhenUnsetOption: null + CustomValue: '{{ CustomValue }}' + Name: '{{ Name }}' + DecimalParameterDeclaration: + MappedDataSetParameters: + - null + DefaultValues: + DynamicValue: null + StaticValues: + - null + ParameterValueType: null + ValueWhenUnset: + ValueWhenUnsetOption: null + CustomValue: null + Name: '{{ Name }}' + IntegerParameterDeclaration: + MappedDataSetParameters: + - null + DefaultValues: + DynamicValue: null + StaticValues: + - null + ParameterValueType: null + ValueWhenUnset: + ValueWhenUnsetOption: null + CustomValue: null + Name: '{{ Name }}' + - name: ValidationStrategy + value: + Mode: '{{ Mode }}' + - name: Name + value: '{{ Name }}' + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: Permissions + value: + - Principal: '{{ Principal }}' + Actions: + - '{{ Actions[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TemplateId + value: '{{ TemplateId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the templates resource, the following permissions are required: + +### Read +```json +quicksight:DescribeTemplate, +quicksight:DescribeTemplatePermissions, +quicksight:ListTagsForResource +``` + +### Create +```json +quicksight:DescribeTemplate, +quicksight:DescribeTemplatePermissions, +quicksight:CreateTemplate, +quicksight:DescribeAnalysis, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### Update +```json +quicksight:DescribeTemplate, +quicksight:DescribeTemplatePermissions, +quicksight:UpdateTemplate, +quicksight:UpdateTemplatePermissions, +quicksight:PassDataSet, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### List +```json +quicksight:ListTemplates +``` + +### Delete +```json +quicksight:DescribeTemplate, +quicksight:DeleteTemplate +``` diff --git a/website/docs/services/quicksight/templates_list_only/index.md b/website/docs/services/quicksight/templates_list_only/index.md new file mode 100644 index 0000000..db7131b --- /dev/null +++ b/website/docs/services/quicksight/templates_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - templates_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists templates in a region or regions, for all properties use templates + +## Overview + + + + + + + +
Nametemplates_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Template Resource Type.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all templates in a region. +```sql +SELECT +region, +aws_account_id, +template_id +FROM aws.quicksight.templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the templates_list_only resource, see templates + diff --git a/website/docs/services/quicksight/theme_tags/index.md b/website/docs/services/quicksight/theme_tags/index.md new file mode 100644 index 0000000..4d4d310 --- /dev/null +++ b/website/docs/services/quicksight/theme_tags/index.md @@ -0,0 +1,99 @@ +--- +title: theme_tags +hide_title: false +hide_table_of_contents: false +keywords: + - theme_tags + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for themes in a region + +## Overview + + + + + + + +
Nametheme_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::Theme Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the theme.

string
string
object

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

string

The date and time that the theme was created.

string

The date and time that the theme was last updated.

string
array
string
string
object

A version of a theme.

string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all themes in a region. +```sql +SELECT +region, +arn, +aws_account_id, +base_theme_id, +configuration, +created_time, +last_updated_time, +name, +permissions, +theme_id, +type, +version, +version_description, +tag_key, +tag_value +FROM aws.quicksight.theme_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the theme_tags resource, see themes + diff --git a/website/docs/services/quicksight/themes/index.md b/website/docs/services/quicksight/themes/index.md new file mode 100644 index 0000000..0280029 --- /dev/null +++ b/website/docs/services/quicksight/themes/index.md @@ -0,0 +1,320 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a theme resource or lists themes in a region + +## Overview + + + + + + + +
Namethemes
TypeResource
DescriptionDefinition of the AWS::QuickSight::Theme Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the theme.

string
string
object

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

string

The date and time that the theme was created.

string

The date and time that the theme was last updated.

string
array
array
string
string
object

A version of a theme.

string
stringAWS region.
+ +For more information, see AWS::QuickSight::Theme. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all themes in a region. +```sql +SELECT +region, +arn, +aws_account_id, +base_theme_id, +configuration, +created_time, +last_updated_time, +name, +permissions, +tags, +theme_id, +type, +version, +version_description +FROM aws.quicksight.themes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual theme. +```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.themes +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new theme resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.themes ( + AwsAccountId, + BaseThemeId, + Configuration, + Name, + ThemeId, + region +) +SELECT +'{{ AwsAccountId }}', + '{{ BaseThemeId }}', + '{{ Configuration }}', + '{{ Name }}', + '{{ ThemeId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.themes ( + AwsAccountId, + BaseThemeId, + Configuration, + Name, + Permissions, + Tags, + ThemeId, + VersionDescription, + region +) +SELECT + '{{ AwsAccountId }}', + '{{ BaseThemeId }}', + '{{ Configuration }}', + '{{ Name }}', + '{{ Permissions }}', + '{{ Tags }}', + '{{ ThemeId }}', + '{{ VersionDescription }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: theme + props: + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: BaseThemeId + value: '{{ BaseThemeId }}' + - name: Configuration + value: + DataColorPalette: + Colors: + - '{{ Colors[0] }}' + MinMaxGradient: + - '{{ MinMaxGradient[0] }}' + EmptyFillColor: '{{ EmptyFillColor }}' + UIColorPalette: + PrimaryForeground: '{{ PrimaryForeground }}' + PrimaryBackground: '{{ PrimaryBackground }}' + SecondaryForeground: '{{ SecondaryForeground }}' + SecondaryBackground: '{{ SecondaryBackground }}' + Accent: '{{ Accent }}' + AccentForeground: '{{ AccentForeground }}' + Danger: '{{ Danger }}' + DangerForeground: '{{ DangerForeground }}' + Warning: '{{ Warning }}' + WarningForeground: '{{ WarningForeground }}' + Success: '{{ Success }}' + SuccessForeground: '{{ SuccessForeground }}' + Dimension: '{{ Dimension }}' + DimensionForeground: '{{ DimensionForeground }}' + Measure: '{{ Measure }}' + MeasureForeground: '{{ MeasureForeground }}' + Sheet: + Tile: + Border: + Show: '{{ Show }}' + TileLayout: + Gutter: + Show: '{{ Show }}' + Margin: + Show: '{{ Show }}' + Typography: + FontFamilies: + - FontFamily: '{{ FontFamily }}' + - name: Name + value: '{{ Name }}' + - name: Permissions + value: + - Principal: '{{ Principal }}' + Actions: + - '{{ Actions[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ThemeId + value: '{{ ThemeId }}' + - name: VersionDescription + value: '{{ VersionDescription }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.themes +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the themes resource, the following permissions are required: + +### Read +```json +quicksight:DescribeTheme, +quicksight:DescribeThemePermissions, +quicksight:ListTagsForResource +``` + +### Create +```json +quicksight:DescribeTheme, +quicksight:DescribeThemePermissions, +quicksight:CreateTheme, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### List +```json +quicksight:ListThemes +``` + +### 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/website/docs/services/quicksight/themes_list_only/index.md b/website/docs/services/quicksight/themes_list_only/index.md new file mode 100644 index 0000000..82ead88 --- /dev/null +++ b/website/docs/services/quicksight/themes_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: themes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - themes_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists themes in a region or regions, for all properties use themes + +## Overview + + + + + + + +
Namethemes_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Theme Resource Type.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all themes in a region. +```sql +SELECT +region, +theme_id, +aws_account_id +FROM aws.quicksight.themes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the themes_list_only resource, see themes + diff --git a/website/docs/services/quicksight/topics/index.md b/website/docs/services/quicksight/topics/index.md new file mode 100644 index 0000000..66049e0 --- /dev/null +++ b/website/docs/services/quicksight/topics/index.md @@ -0,0 +1,382 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a topic resource or lists topics in a region + +## Overview + + + + + + + +
Nametopics
TypeResource
DescriptionDefinition of the AWS::QuickSight::Topic Resource Type.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
string
string
stringAWS region.
+ +For more information, see AWS::QuickSight::Topic. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all topics in a region. +```sql +SELECT +region, +arn, +aws_account_id, +data_sets, +description, +name, +topic_id, +user_experience_version +FROM aws.quicksight.topics +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual topic. +```sql +SELECT +region, +arn, +aws_account_id, +data_sets, +description, +name, +topic_id, +user_experience_version +FROM aws.quicksight.topics +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new topic resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.topics ( + AwsAccountId, + DataSets, + Description, + Name, + TopicId, + UserExperienceVersion, + region +) +SELECT +'{{ AwsAccountId }}', + '{{ DataSets }}', + '{{ Description }}', + '{{ Name }}', + '{{ TopicId }}', + '{{ UserExperienceVersion }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.topics ( + AwsAccountId, + DataSets, + Description, + Name, + TopicId, + UserExperienceVersion, + region +) +SELECT + '{{ AwsAccountId }}', + '{{ DataSets }}', + '{{ Description }}', + '{{ Name }}', + '{{ TopicId }}', + '{{ UserExperienceVersion }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: topic + props: + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: DataSets + value: + - DatasetArn: '{{ DatasetArn }}' + DatasetName: '{{ DatasetName }}' + DatasetDescription: '{{ DatasetDescription }}' + DataAggregation: + DatasetRowDateGranularity: '{{ DatasetRowDateGranularity }}' + DefaultDateColumnName: '{{ DefaultDateColumnName }}' + Filters: + - FilterDescription: '{{ FilterDescription }}' + FilterClass: '{{ FilterClass }}' + FilterName: '{{ FilterName }}' + FilterSynonyms: + - '{{ FilterSynonyms[0] }}' + OperandFieldName: '{{ OperandFieldName }}' + FilterType: '{{ FilterType }}' + CategoryFilter: + CategoryFilterFunction: '{{ CategoryFilterFunction }}' + CategoryFilterType: '{{ CategoryFilterType }}' + Constant: + ConstantType: '{{ ConstantType }}' + SingularConstant: '{{ SingularConstant }}' + CollectiveConstant: + ValueList: + - '{{ ValueList[0] }}' + Inverse: '{{ Inverse }}' + NumericEqualityFilter: + Constant: + ConstantType: null + SingularConstant: '{{ SingularConstant }}' + Aggregation: '{{ Aggregation }}' + NumericRangeFilter: + Inclusive: '{{ Inclusive }}' + Constant: + ConstantType: null + RangeConstant: + Minimum: '{{ Minimum }}' + Maximum: '{{ Maximum }}' + Aggregation: null + DateRangeFilter: + Inclusive: '{{ Inclusive }}' + Constant: null + RelativeDateFilter: + TimeGranularity: null + RelativeDateFilterFunction: '{{ RelativeDateFilterFunction }}' + Constant: null + Columns: + - ColumnName: '{{ ColumnName }}' + ColumnFriendlyName: '{{ ColumnFriendlyName }}' + ColumnDescription: '{{ ColumnDescription }}' + ColumnSynonyms: + - '{{ ColumnSynonyms[0] }}' + ColumnDataRole: '{{ ColumnDataRole }}' + Aggregation: '{{ Aggregation }}' + IsIncludedInTopic: '{{ IsIncludedInTopic }}' + DisableIndexing: '{{ DisableIndexing }}' + ComparativeOrder: + UseOrdering: '{{ UseOrdering }}' + SpecifedOrder: + - '{{ SpecifedOrder[0] }}' + TreatUndefinedSpecifiedValues: '{{ TreatUndefinedSpecifiedValues }}' + SemanticType: + TypeName: '{{ TypeName }}' + SubTypeName: '{{ SubTypeName }}' + TypeParameters: {} + TruthyCellValue: '{{ TruthyCellValue }}' + TruthyCellValueSynonyms: + - '{{ TruthyCellValueSynonyms[0] }}' + FalseyCellValue: '{{ FalseyCellValue }}' + FalseyCellValueSynonyms: + - '{{ FalseyCellValueSynonyms[0] }}' + TimeGranularity: null + AllowedAggregations: + - '{{ AllowedAggregations[0] }}' + NotAllowedAggregations: + - null + DefaultFormatting: + DisplayFormat: '{{ DisplayFormat }}' + DisplayFormatOptions: + UseBlankCellFormat: '{{ UseBlankCellFormat }}' + BlankCellFormat: '{{ BlankCellFormat }}' + DateFormat: '{{ DateFormat }}' + DecimalSeparator: '{{ DecimalSeparator }}' + GroupingSeparator: '{{ GroupingSeparator }}' + UseGrouping: '{{ UseGrouping }}' + FractionDigits: null + Prefix: '{{ Prefix }}' + Suffix: '{{ Suffix }}' + UnitScaler: '{{ UnitScaler }}' + NegativeFormat: + Prefix: '{{ Prefix }}' + Suffix: '{{ Suffix }}' + CurrencySymbol: '{{ CurrencySymbol }}' + NeverAggregateInFilter: '{{ NeverAggregateInFilter }}' + CellValueSynonyms: + - CellValue: '{{ CellValue }}' + Synonyms: + - '{{ Synonyms[0] }}' + NonAdditive: '{{ NonAdditive }}' + CalculatedFields: + - CalculatedFieldName: '{{ CalculatedFieldName }}' + CalculatedFieldDescription: '{{ CalculatedFieldDescription }}' + Expression: '{{ Expression }}' + CalculatedFieldSynonyms: + - '{{ CalculatedFieldSynonyms[0] }}' + IsIncludedInTopic: '{{ IsIncludedInTopic }}' + DisableIndexing: '{{ DisableIndexing }}' + ColumnDataRole: null + TimeGranularity: null + DefaultFormatting: null + Aggregation: null + ComparativeOrder: null + SemanticType: null + AllowedAggregations: + - null + NotAllowedAggregations: + - null + NeverAggregateInFilter: '{{ NeverAggregateInFilter }}' + CellValueSynonyms: + - null + NonAdditive: '{{ NonAdditive }}' + NamedEntities: + - EntityName: '{{ EntityName }}' + EntityDescription: '{{ EntityDescription }}' + EntitySynonyms: + - '{{ EntitySynonyms[0] }}' + SemanticEntityType: + TypeName: '{{ TypeName }}' + SubTypeName: '{{ SubTypeName }}' + TypeParameters: null + Definition: + - FieldName: '{{ FieldName }}' + PropertyName: '{{ PropertyName }}' + PropertyRole: '{{ PropertyRole }}' + PropertyUsage: '{{ PropertyUsage }}' + Metric: + Aggregation: '{{ Aggregation }}' + AggregationFunctionParameters: {} + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: TopicId + value: '{{ TopicId }}' + - name: UserExperienceVersion + value: '{{ UserExperienceVersion }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.topics +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the topics resource, the following permissions are required: + +### Create +```json +quicksight:CreateTopic, +quicksight:PassDataSet, +quicksight:DescribeTopicRefresh +``` + +### Read +```json +quicksight:DescribeTopic +``` + +### Update +```json +quicksight:UpdateTopic, +quicksight:PassDataSet, +quicksight:DescribeTopicRefresh +``` + +### Delete +```json +quicksight:DeleteTopic +``` + +### List +```json +quicksight:ListTopics +``` diff --git a/website/docs/services/quicksight/topics_list_only/index.md b/website/docs/services/quicksight/topics_list_only/index.md new file mode 100644 index 0000000..2e6cc9d --- /dev/null +++ b/website/docs/services/quicksight/topics_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: topics_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - topics_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists topics in a region or regions, for all properties use topics + +## Overview + + + + + + + +
Nametopics_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Topic Resource Type.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all topics in a region. +```sql +SELECT +region, +aws_account_id, +topic_id +FROM aws.quicksight.topics_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topics_list_only resource, see topics + diff --git a/website/docs/services/quicksight/vpc_connection_tags/index.md b/website/docs/services/quicksight/vpc_connection_tags/index.md new file mode 100644 index 0000000..b420467 --- /dev/null +++ b/website/docs/services/quicksight/vpc_connection_tags/index.md @@ -0,0 +1,103 @@ +--- +title: vpc_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connection_tags + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_connections in a region + +## Overview + + + + + + + +
Namevpc_connection_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::VPCConnection Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

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

string
string
string

The time that the VPC connection was created.

array
string

The time that the VPC connection was last updated.

string
array

A list of network interfaces.

string
array
string
array
string
string

The Amazon EC2 VPC ID associated with the VPC connection.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_connections in a region. +```sql +SELECT +region, +arn, +availability_status, +aws_account_id, +created_time, +dns_resolvers, +last_updated_time, +name, +network_interfaces, +role_arn, +security_group_ids, +status, +subnet_ids, +vpc_connection_id, +vpc_id, +tag_key, +tag_value +FROM aws.quicksight.vpc_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connection_tags resource, see vpc_connections + diff --git a/website/docs/services/quicksight/vpc_connections/index.md b/website/docs/services/quicksight/vpc_connections/index.md new file mode 100644 index 0000000..573050b --- /dev/null +++ b/website/docs/services/quicksight/vpc_connections/index.md @@ -0,0 +1,302 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vpc_connection resource or lists vpc_connections in a region + +## Overview + + + + + + + +
Namevpc_connections
TypeResource
DescriptionDefinition of the AWS::QuickSight::VPCConnection Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

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

string
string
string

The time that the VPC connection was created.

array
string

The time that the VPC connection was last updated.

string
array

A list of network interfaces.

string
array
string
array
array
string
string

The Amazon EC2 VPC ID associated with the VPC connection.

stringAWS region.
+ +For more information, see AWS::QuickSight::VPCConnection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all vpc_connections in a region. +```sql +SELECT +region, +arn, +availability_status, +aws_account_id, +created_time, +dns_resolvers, +last_updated_time, +name, +network_interfaces, +role_arn, +security_group_ids, +status, +subnet_ids, +tags, +vpc_connection_id, +vpc_id +FROM aws.quicksight.vpc_connections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual vpc_connection. +```sql +SELECT +region, +arn, +availability_status, +aws_account_id, +created_time, +dns_resolvers, +last_updated_time, +name, +network_interfaces, +role_arn, +security_group_ids, +status, +subnet_ids, +tags, +vpc_connection_id, +vpc_id +FROM aws.quicksight.vpc_connections +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.vpc_connections ( + AvailabilityStatus, + AwsAccountId, + DnsResolvers, + Name, + RoleArn, + SecurityGroupIds, + SubnetIds, + Tags, + VPCConnectionId, + region +) +SELECT +'{{ AvailabilityStatus }}', + '{{ AwsAccountId }}', + '{{ DnsResolvers }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ Tags }}', + '{{ VPCConnectionId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.quicksight.vpc_connections ( + AvailabilityStatus, + AwsAccountId, + DnsResolvers, + Name, + RoleArn, + SecurityGroupIds, + SubnetIds, + Tags, + VPCConnectionId, + region +) +SELECT + '{{ AvailabilityStatus }}', + '{{ AwsAccountId }}', + '{{ DnsResolvers }}', + '{{ Name }}', + '{{ RoleArn }}', + '{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ Tags }}', + '{{ VPCConnectionId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vpc_connection + props: + - name: AvailabilityStatus + value: '{{ AvailabilityStatus }}' + - name: AwsAccountId + value: '{{ AwsAccountId }}' + - name: DnsResolvers + value: + - '{{ DnsResolvers[0] }}' + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VPCConnectionId + value: '{{ VPCConnectionId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.quicksight.vpc_connections +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +quicksight:ListVPCConnections +``` diff --git a/website/docs/services/quicksight/vpc_connections_list_only/index.md b/website/docs/services/quicksight/vpc_connections_list_only/index.md new file mode 100644 index 0000000..cc4b6e0 --- /dev/null +++ b/website/docs/services/quicksight/vpc_connections_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: vpc_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connections_list_only + - quicksight + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_connections in a region or regions, for all properties use vpc_connections + +## Overview + + + + + + + +
Namevpc_connections_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::VPCConnection Resource Type.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_connections in a region. +```sql +SELECT +region, +aws_account_id, +vpc_connection_id +FROM aws.quicksight.vpc_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connections_list_only resource, see vpc_connections + diff --git a/website/docs/services/ram/index.md b/website/docs/services/ram/index.md new file mode 100644 index 0000000..ee0cba7 --- /dev/null +++ b/website/docs/services/ram/index.md @@ -0,0 +1,41 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The ram service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/ram/permission_tags/index.md b/website/docs/services/ram/permission_tags/index.md new file mode 100644 index 0000000..b773d24 --- /dev/null +++ b/website/docs/services/ram/permission_tags/index.md @@ -0,0 +1,89 @@ +--- +title: permission_tags +hide_title: false +hide_table_of_contents: false +keywords: + - permission_tags + - ram + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for permissions in a region + +## Overview + + + + + + + +
Namepermission_tags
TypeResource
DescriptionResource type definition for AWS::RAM::Permission
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the permission.
stringVersion of the permission.
booleanSet to true to use this as the default permission.
string
stringThe resource type this permission can be used with.
objectPolicy template for the permission.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all permissions in a region. +```sql +SELECT +region, +arn, +name, +version, +is_resource_type_default, +permission_type, +resource_type, +policy_template, +tag_key, +tag_value +FROM aws.ram.permission_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permission_tags resource, see permissions + diff --git a/website/docs/services/ram/permissions/index.md b/website/docs/services/ram/permissions/index.md new file mode 100644 index 0000000..4f1ce07 --- /dev/null +++ b/website/docs/services/ram/permissions/index.md @@ -0,0 +1,244 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a permission resource or lists permissions in a region + +## Overview + + + + + + + +
Namepermissions
TypeResource
DescriptionResource type definition for AWS::RAM::Permission
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the permission.
stringVersion of the permission.
booleanSet to true to use this as the default permission.
string
stringThe resource type this permission can be used with.
objectPolicy template for the permission.
array
stringAWS region.
+ +For more information, see AWS::RAM::Permission. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all permissions in a region. +```sql +SELECT +region, +arn, +name, +version, +is_resource_type_default, +permission_type, +resource_type, +policy_template, +tags +FROM aws.ram.permissions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual permission. +```sql +SELECT +region, +arn, +name, +version, +is_resource_type_default, +permission_type, +resource_type, +policy_template, +tags +FROM aws.ram.permissions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ram.permissions ( + Name, + ResourceType, + PolicyTemplate, + region +) +SELECT +'{{ Name }}', + '{{ ResourceType }}', + '{{ PolicyTemplate }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ram.permissions ( + Name, + ResourceType, + PolicyTemplate, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ ResourceType }}', + '{{ PolicyTemplate }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: permission + props: + - name: Name + value: '{{ Name }}' + - name: ResourceType + value: '{{ ResourceType }}' + - name: PolicyTemplate + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ram.permissions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the permissions resource, the following permissions are required: + +### Create +```json +ram:CreatePermission, +ram:TagResource +``` + +### 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 +``` + +### List +```json +ram:ListPermissions, +ram:ListPermissionVersions +``` diff --git a/website/docs/services/ram/permissions_list_only/index.md b/website/docs/services/ram/permissions_list_only/index.md new file mode 100644 index 0000000..1bc170f --- /dev/null +++ b/website/docs/services/ram/permissions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - permissions_list_only + - ram + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists permissions in a region or regions, for all properties use permissions + +## Overview + + + + + + + +
Namepermissions_list_only
TypeResource
DescriptionResource type definition for AWS::RAM::Permission
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all permissions in a region. +```sql +SELECT +region, +arn +FROM aws.ram.permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permissions_list_only resource, see permissions + diff --git a/website/docs/services/ram/resource_share_tags/index.md b/website/docs/services/ram/resource_share_tags/index.md new file mode 100644 index 0000000..d4a299e --- /dev/null +++ b/website/docs/services/ram/resource_share_tags/index.md @@ -0,0 +1,89 @@ +--- +title: resource_share_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resource_share_tags + - ram + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resource_shares in a region + +## Overview + + + + + + + +
Nameresource_share_tags
TypeResource
DescriptionResource type definition for AWS::RAM::ResourceShare
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
booleanSpecifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`.
string
stringSpecifies the name of the resource share.
arraySpecifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.
arraySpecifies the principals to associate with the resource share. The possible values are:
- An AWS account ID
- An Amazon Resource Name (ARN) of an organization in AWS Organizations
- An ARN of an organizational unit (OU) in AWS Organizations
- An ARN of an IAM role
- An ARN of an IAM user
arraySpecifies a list of one or more ARNs of the resources to associate with the resource share.
arraySpecifies from which source accounts the service principal has access to the resources in this resource share.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resource_shares in a region. +```sql +SELECT +region, +allow_external_principals, +arn, +name, +permission_arns, +principals, +resource_arns, +sources, +tag_key, +tag_value +FROM aws.ram.resource_share_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_share_tags resource, see resource_shares + diff --git a/website/docs/services/ram/resource_shares/index.md b/website/docs/services/ram/resource_shares/index.md new file mode 100644 index 0000000..d673929 --- /dev/null +++ b/website/docs/services/ram/resource_shares/index.md @@ -0,0 +1,256 @@ +--- +title: resource_shares +hide_title: false +hide_table_of_contents: false +keywords: + - resource_shares + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_share resource or lists resource_shares in a region + +## Overview + + + + + + + +
Nameresource_shares
TypeResource
DescriptionResource type definition for AWS::RAM::ResourceShare
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
booleanSpecifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`.
string
stringSpecifies the name of the resource share.
arraySpecifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.
arraySpecifies the principals to associate with the resource share. The possible values are:
- An AWS account ID
- An Amazon Resource Name (ARN) of an organization in AWS Organizations
- An ARN of an organizational unit (OU) in AWS Organizations
- An ARN of an IAM role
- An ARN of an IAM user
arraySpecifies a list of one or more ARNs of the resources to associate with the resource share.
arraySpecifies from which source accounts the service principal has access to the resources in this resource share.
arraySpecifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.
stringAWS region.
+ +For more information, see AWS::RAM::ResourceShare. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_shares in a region. +```sql +SELECT +region, +allow_external_principals, +arn, +name, +permission_arns, +principals, +resource_arns, +sources, +tags +FROM aws.ram.resource_shares +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_share. +```sql +SELECT +region, +allow_external_principals, +arn, +name, +permission_arns, +principals, +resource_arns, +sources, +tags +FROM aws.ram.resource_shares +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_share resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ram.resource_shares ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ram.resource_shares ( + AllowExternalPrincipals, + Name, + PermissionArns, + Principals, + ResourceArns, + Sources, + Tags, + region +) +SELECT + '{{ AllowExternalPrincipals }}', + '{{ Name }}', + '{{ PermissionArns }}', + '{{ Principals }}', + '{{ ResourceArns }}', + '{{ Sources }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_share + props: + - name: AllowExternalPrincipals + value: '{{ AllowExternalPrincipals }}' + - name: Name + value: '{{ Name }}' + - name: PermissionArns + value: + - '{{ PermissionArns[0] }}' + - name: Principals + value: + - '{{ Principals[0] }}' + - name: ResourceArns + value: + - '{{ ResourceArns[0] }}' + - name: Sources + value: + - '{{ Sources[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ram.resource_shares +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_shares resource, the following permissions are required: + +### Create +```json +ram:CreateResourceShare, +ram:TagResource +``` + +### Read +```json +ram:GetResourceShares +``` + +### Update +```json +ram:GetPermission, +ram:GetResourceShares, +ram:GetResourceShareAssociations, +ram:ListResourceSharePermissions, +ram:UpdateResourceShare, +ram:AssociateResourceSharePermission, +ram:AssociateResourceShare, +ram:DisassociateResourceShare, +ram:UntagResource, +ram:TagResource +``` + +### Delete +```json +ram:DeleteResourceShare, +ram:GetResourceShares +``` + +### List +```json +ram:GetResourceShares +``` diff --git a/website/docs/services/ram/resource_shares_list_only/index.md b/website/docs/services/ram/resource_shares_list_only/index.md new file mode 100644 index 0000000..6593352 --- /dev/null +++ b/website/docs/services/ram/resource_shares_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_shares_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_shares_list_only + - ram + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_shares in a region or regions, for all properties use resource_shares + +## Overview + + + + + + + +
Nameresource_shares_list_only
TypeResource
DescriptionResource type definition for AWS::RAM::ResourceShare
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_shares in a region. +```sql +SELECT +region, +arn +FROM aws.ram.resource_shares_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_shares_list_only resource, see resource_shares + diff --git a/website/docs/services/rbin/index.md b/website/docs/services/rbin/index.md new file mode 100644 index 0000000..43d8ffa --- /dev/null +++ b/website/docs/services/rbin/index.md @@ -0,0 +1,38 @@ +--- +title: rbin +hide_title: false +hide_table_of_contents: false +keywords: + - rbin + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The rbin service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/rbin/rule_tags/index.md b/website/docs/services/rbin/rule_tags/index.md new file mode 100644 index 0000000..f3113c3 --- /dev/null +++ b/website/docs/services/rbin/rule_tags/index.md @@ -0,0 +1,95 @@ +--- +title: rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rule_tags + - rbin + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rules in a region + +## Overview + + + + + + + +
Namerule_tags
TypeResource
DescriptionResource Type definition for AWS::Rbin::Rule
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringRule Arn is unique for each rule.
stringThe unique ID of the retention rule.
stringThe description of the retention rule.
arrayInformation about the resource tags used to identify resources that are retained by the retention rule.
arrayInformation about the exclude resource tags used to identify resources that are excluded by the retention rule.
stringThe resource type retained by the retention rule.
objectInformation about the retention period for which the retention rule is to retain resources.
stringThe state of the retention rule. Only retention rules that are in the available state retain resources.
objectInformation about the retention rule lock configuration.
stringThe lock state for the retention rule.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rules in a region. +```sql +SELECT +region, +arn, +identifier, +description, +resource_tags, +exclude_resource_tags, +resource_type, +retention_period, +status, +lock_configuration, +lock_state, +tag_key, +tag_value +FROM aws.rbin.rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_tags resource, see rules + diff --git a/website/docs/services/rbin/rules/index.md b/website/docs/services/rbin/rules/index.md new file mode 100644 index 0000000..0f21216 --- /dev/null +++ b/website/docs/services/rbin/rules/index.md @@ -0,0 +1,280 @@ +--- +title: rules +hide_title: false +hide_table_of_contents: false +keywords: + - rules + - rbin + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a rule resource or lists rules in a region + +## Overview + + + + + + + +
Namerules
TypeResource
DescriptionResource Type definition for AWS::Rbin::Rule
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringRule Arn is unique for each rule.
stringThe unique ID of the retention rule.
stringThe description of the retention rule.
arrayInformation about the resource tags used to identify resources that are retained by the retention rule.
arrayInformation about the exclude resource tags used to identify resources that are excluded by the retention rule.
stringThe resource type retained by the retention rule.
arrayInformation about the tags assigned to the retention rule.
objectInformation about the retention period for which the retention rule is to retain resources.
stringThe state of the retention rule. Only retention rules that are in the available state retain resources.
objectInformation about the retention rule lock configuration.
stringThe lock state for the retention rule.
stringAWS region.
+ +For more information, see AWS::Rbin::Rule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rules in a region. +```sql +SELECT +region, +arn, +identifier, +description, +resource_tags, +exclude_resource_tags, +resource_type, +tags, +retention_period, +status, +lock_configuration, +lock_state +FROM aws.rbin.rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual rule. +```sql +SELECT +region, +arn, +identifier, +description, +resource_tags, +exclude_resource_tags, +resource_type, +tags, +retention_period, +status, +lock_configuration, +lock_state +FROM aws.rbin.rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rbin.rules ( + ResourceType, + RetentionPeriod, + region +) +SELECT +'{{ ResourceType }}', + '{{ RetentionPeriod }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rbin.rules ( + Description, + ResourceTags, + ExcludeResourceTags, + ResourceType, + Tags, + RetentionPeriod, + Status, + LockConfiguration, + region +) +SELECT + '{{ Description }}', + '{{ ResourceTags }}', + '{{ ExcludeResourceTags }}', + '{{ ResourceType }}', + '{{ Tags }}', + '{{ RetentionPeriod }}', + '{{ Status }}', + '{{ LockConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: rule + props: + - name: Description + value: '{{ Description }}' + - name: ResourceTags + value: + - ResourceTagKey: '{{ ResourceTagKey }}' + ResourceTagValue: '{{ ResourceTagValue }}' + - name: ExcludeResourceTags + value: + - null + - name: ResourceType + value: '{{ ResourceType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: RetentionPeriod + value: + RetentionPeriodValue: '{{ RetentionPeriodValue }}' + RetentionPeriodUnit: '{{ RetentionPeriodUnit }}' + - name: Status + value: '{{ Status }}' + - name: LockConfiguration + value: + UnlockDelayValue: '{{ UnlockDelayValue }}' + UnlockDelayUnit: '{{ UnlockDelayUnit }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rbin.rules +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the rules resource, the following permissions are required: + +### Create +```json +rbin:CreateRule, +rbin:GetRule, +rbin:LockRule, +rbin:TagResource, +iam:PassRole +``` + +### Read +```json +rbin:GetRule, +rbin:ListTagsForResource, +iam:PassRole +``` + +### Update +```json +rbin:GetRule, +rbin:UpdateRule, +rbin:LockRule, +rbin:UnlockRule, +rbin:TagResource, +rbin:UntagResource, +rbin:ListTagsForResource, +iam:PassRole +``` + +### Delete +```json +rbin:GetRule, +rbin:DeleteRule, +iam:PassRole +``` + +### List +```json +rbin:ListRules, +rbin:ListTagsForResource, +iam:PassRole +``` diff --git a/website/docs/services/rbin/rules_list_only/index.md b/website/docs/services/rbin/rules_list_only/index.md new file mode 100644 index 0000000..dc8b31b --- /dev/null +++ b/website/docs/services/rbin/rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rules_list_only + - rbin + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rules in a region or regions, for all properties use rules + +## Overview + + + + + + + +
Namerules_list_only
TypeResource
DescriptionResource Type definition for AWS::Rbin::Rule
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringRule Arn is unique for each rule.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rules in a region. +```sql +SELECT +region, +arn +FROM aws.rbin.rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rules_list_only resource, see rules + diff --git a/website/docs/services/rds/customdb_engine_version_tags/index.md b/website/docs/services/rds/customdb_engine_version_tags/index.md new file mode 100644 index 0000000..d94dbb1 --- /dev/null +++ b/website/docs/services/rds/customdb_engine_version_tags/index.md @@ -0,0 +1,99 @@ +--- +title: customdb_engine_version_tags +hide_title: false +hide_table_of_contents: false +keywords: + - customdb_engine_version_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for customdb_engine_versions in a region + +## Overview + + + + + + + +
Namecustomdb_engine_version_tags
TypeResource
DescriptionCreates a custom DB engine version (CEV).
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
stringThe Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.
stringAn optional description of your CEV.
stringThe database engine to use for your custom engine version (CEV).
Valid values:
+ custom-oracle-ee
+ custom-oracle-ee-cdb
stringThe name of your CEV. The name format is major version.customized_string. For example, a valid CEV 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.
*Constraints:* Minimum length is 1. Maximum length is 60.
*Pattern:* ^[a-z0-9_.-]{1,60$}
stringThe AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*.
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
stringThe CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
+ MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*.
string
stringThe ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.
booleanSpecifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify ImageId.
stringA value that indicates the ID of the AMI.
stringA value that indicates the status of a custom engine version (CEV).
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all customdb_engine_versions in a region. +```sql +SELECT +region, +database_installation_files_s3_bucket_name, +database_installation_files_s3_prefix, +description, +engine, +engine_version, +kms_key_id, +manifest, +db_engine_version_arn, +source_custom_db_engine_version_identifier, +use_aws_provided_latest_image, +image_id, +status, +tag_key, +tag_value +FROM aws.rds.customdb_engine_version_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the customdb_engine_version_tags resource, see customdb_engine_versions + diff --git a/website/docs/services/rds/customdb_engine_versions/index.md b/website/docs/services/rds/customdb_engine_versions/index.md new file mode 100644 index 0000000..d0c74f3 --- /dev/null +++ b/website/docs/services/rds/customdb_engine_versions/index.md @@ -0,0 +1,302 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a customdb_engine_version resource or lists customdb_engine_versions in a region + +## Overview + + + + + + + +
Namecustomdb_engine_versions
TypeResource
DescriptionCreates a custom DB engine version (CEV).
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
stringThe Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.
stringAn optional description of your CEV.
stringThe database engine to use for your custom engine version (CEV).
Valid values:
+ custom-oracle-ee
+ custom-oracle-ee-cdb
stringThe name of your CEV. The name format is major version.customized_string. For example, a valid CEV 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.
*Constraints:* Minimum length is 1. Maximum length is 60.
*Pattern:* ^[a-z0-9_.-]{1,60$}
stringThe AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*.
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
stringThe CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
+ MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*.
string
stringThe ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.
booleanSpecifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify ImageId.
stringA value that indicates the ID of the AMI.
stringA value that indicates the status of a custom engine version (CEV).
arrayA list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*
stringAWS region.
+ +For more information, see AWS::RDS::CustomDBEngineVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all customdb_engine_versions in a region. +```sql +SELECT +region, +database_installation_files_s3_bucket_name, +database_installation_files_s3_prefix, +description, +engine, +engine_version, +kms_key_id, +manifest, +db_engine_version_arn, +source_custom_db_engine_version_identifier, +use_aws_provided_latest_image, +image_id, +status, +tags +FROM aws.rds.customdb_engine_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual customdb_engine_version. +```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_versions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new customdb_engine_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.customdb_engine_versions ( + Engine, + EngineVersion, + region +) +SELECT +'{{ Engine }}', + '{{ EngineVersion }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.customdb_engine_versions ( + DatabaseInstallationFilesS3BucketName, + DatabaseInstallationFilesS3Prefix, + Description, + Engine, + EngineVersion, + KMSKeyId, + Manifest, + SourceCustomDbEngineVersionIdentifier, + UseAwsProvidedLatestImage, + ImageId, + Status, + Tags, + region +) +SELECT + '{{ DatabaseInstallationFilesS3BucketName }}', + '{{ DatabaseInstallationFilesS3Prefix }}', + '{{ Description }}', + '{{ Engine }}', + '{{ EngineVersion }}', + '{{ KMSKeyId }}', + '{{ Manifest }}', + '{{ SourceCustomDbEngineVersionIdentifier }}', + '{{ UseAwsProvidedLatestImage }}', + '{{ ImageId }}', + '{{ Status }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: customdb_engine_version + props: + - name: DatabaseInstallationFilesS3BucketName + value: '{{ DatabaseInstallationFilesS3BucketName }}' + - name: DatabaseInstallationFilesS3Prefix + value: '{{ DatabaseInstallationFilesS3Prefix }}' + - name: Description + value: '{{ Description }}' + - name: Engine + value: '{{ Engine }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: KMSKeyId + value: '{{ KMSKeyId }}' + - name: Manifest + value: '{{ Manifest }}' + - name: SourceCustomDbEngineVersionIdentifier + value: '{{ SourceCustomDbEngineVersionIdentifier }}' + - name: UseAwsProvidedLatestImage + value: '{{ UseAwsProvidedLatestImage }}' + - name: ImageId + value: '{{ ImageId }}' + - name: Status + value: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.customdb_engine_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +rds:DescribeDBEngineVersions +``` + +### Update +```json +rds:AddTagsToResource, +rds:DescribeDBEngineVersions, +rds:ModifyCustomDBEngineVersion, +rds:RemoveTagsFromResource +``` + +### Delete +```json +rds:DeleteCustomDBEngineVersion, +rds:DescribeDBEngineVersions +``` + +### List +```json +rds:DescribeDBEngineVersions +``` diff --git a/website/docs/services/rds/customdb_engine_versions_list_only/index.md b/website/docs/services/rds/customdb_engine_versions_list_only/index.md new file mode 100644 index 0000000..4c1c705 --- /dev/null +++ b/website/docs/services/rds/customdb_engine_versions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: customdb_engine_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - customdb_engine_versions_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists customdb_engine_versions in a region or regions, for all properties use customdb_engine_versions + +## Overview + + + + + + + +
Namecustomdb_engine_versions_list_only
TypeResource
DescriptionCreates a custom DB engine version (CEV).
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe database engine to use for your custom engine version (CEV).
Valid values:
+ custom-oracle-ee
+ custom-oracle-ee-cdb
stringThe name of your CEV. The name format is major version.customized_string. For example, a valid CEV 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.
*Constraints:* Minimum length is 1. Maximum length is 60.
*Pattern:* ^[a-z0-9_.-]{1,60$}
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all customdb_engine_versions in a region. +```sql +SELECT +region, +engine, +engine_version +FROM aws.rds.customdb_engine_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the customdb_engine_versions_list_only resource, see customdb_engine_versions + diff --git a/website/docs/services/rds/db_cluster_parameter_group_tags/index.md b/website/docs/services/rds/db_cluster_parameter_group_tags/index.md new file mode 100644 index 0000000..353e260 --- /dev/null +++ b/website/docs/services/rds/db_cluster_parameter_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: db_cluster_parameter_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster_parameter_group_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_cluster_parameter_groups in a region + +## Overview + + + + + + + +
Namedb_cluster_parameter_group_tags
TypeResource
DescriptionThe AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group.
For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe description for the DB cluster parameter group.
stringThe DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
*Aurora MySQL*
Example: aurora-mysql5.7, aurora-mysql8.0
*Aurora PostgreSQL*
Example: aurora-postgresql14
*RDS for MySQL*
Example: mysql8.0
*RDS for PostgreSQL*
Example: postgres13
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
+ aurora-mysql
+ aurora-postgresql
+ mysql
+ postgres
objectProvides a list of parameters for the DB cluster parameter group.
stringThe name of the DB cluster parameter group.
Constraints:
+ Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_cluster_parameter_groups in a region. +```sql +SELECT +region, +description, +family, +parameters, +db_cluster_parameter_group_name, +tag_key, +tag_value +FROM aws.rds.db_cluster_parameter_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_cluster_parameter_group_tags resource, see db_cluster_parameter_groups + diff --git a/website/docs/services/rds/db_cluster_parameter_groups/index.md b/website/docs/services/rds/db_cluster_parameter_groups/index.md new file mode 100644 index 0000000..41ef073 --- /dev/null +++ b/website/docs/services/rds/db_cluster_parameter_groups/index.md @@ -0,0 +1,248 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a db_cluster_parameter_group resource or lists 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 information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe description for the DB cluster parameter group.
stringThe DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
*Aurora MySQL*
Example: aurora-mysql5.7, aurora-mysql8.0
*Aurora PostgreSQL*
Example: aurora-postgresql14
*RDS for MySQL*
Example: mysql8.0
*RDS for PostgreSQL*
Example: postgres13
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
+ aurora-mysql
+ aurora-postgresql
+ mysql
+ postgres
objectProvides a list of parameters for the DB cluster parameter group.
stringThe name of the DB cluster parameter group.
Constraints:
+ Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.
arrayTags to assign to the DB cluster parameter group.
stringAWS region.
+ +For more information, see AWS::RDS::DBClusterParameterGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all db_cluster_parameter_groups in a region. +```sql +SELECT +region, +description, +family, +parameters, +db_cluster_parameter_group_name, +tags +FROM aws.rds.db_cluster_parameter_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual db_cluster_parameter_group. +```sql +SELECT +region, +description, +family, +parameters, +db_cluster_parameter_group_name, +tags +FROM aws.rds.db_cluster_parameter_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new db_cluster_parameter_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_cluster_parameter_groups ( + Description, + Family, + Parameters, + region +) +SELECT +'{{ Description }}', + '{{ Family }}', + '{{ Parameters }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_cluster_parameter_groups ( + Description, + Family, + Parameters, + DBClusterParameterGroupName, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Family }}', + '{{ Parameters }}', + '{{ DBClusterParameterGroupName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: db_cluster_parameter_group + props: + - name: Description + value: '{{ Description }}' + - name: Family + value: '{{ Family }}' + - name: Parameters + value: {} + - name: DBClusterParameterGroupName + value: '{{ DBClusterParameterGroupName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.db_cluster_parameter_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +rds:DescribeDBClusterParameterGroups +``` diff --git a/website/docs/services/rds/db_cluster_parameter_groups_list_only/index.md b/website/docs/services/rds/db_cluster_parameter_groups_list_only/index.md new file mode 100644 index 0000000..be1191b --- /dev/null +++ b/website/docs/services/rds/db_cluster_parameter_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: db_cluster_parameter_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster_parameter_groups_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_cluster_parameter_groups in a region or regions, for all properties use db_cluster_parameter_groups + +## Overview + + + + + + + +
Namedb_cluster_parameter_groups_list_only
TypeResource
DescriptionThe AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group.
For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the DB cluster parameter group.
Constraints:
+ Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_cluster_parameter_groups in a region. +```sql +SELECT +region, +db_cluster_parameter_group_name +FROM aws.rds.db_cluster_parameter_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_cluster_parameter_groups_list_only resource, see db_cluster_parameter_groups + diff --git a/website/docs/services/rds/db_cluster_tags/index.md b/website/docs/services/rds/db_cluster_tags/index.md new file mode 100644 index 0000000..497c3ec --- /dev/null +++ b/website/docs/services/rds/db_cluster_tags/index.md @@ -0,0 +1,199 @@ +--- +title: db_cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_clusters in a region + +## Overview + + + + + + + +
Namedb_cluster_tags
TypeResource
DescriptionThe AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For more information about creating 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*.
For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*.
You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
*Updating DB clusters*
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
1. Create a snapshot of the DB cluster. For more information, see [Creating a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).
1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the SnapshotIdentifier property with the ID of the DB cluster snapshot that you want to use.
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 DB cluster 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, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
1. Update the stack.

Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: PreferredBackupWindow, PreferredMaintenanceWindow, and Port. This limitation doesn't apply to provisioned DB clusters.
For more information about updating other properties of this resource, see ModifyDBCluster. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).
*Deleting DB clusters*
The default DeletionPolicy for AWS::RDS::DBCluster resources is Snapshot. For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThis data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
+ CreateDBInstance
+ DescribeDBInstances
+ DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
objectThis data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
+ CreateDBInstance
+ DescribeDBInstances
+ DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
integerThe amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
This setting is required to create a Multi-AZ DB cluster.
arrayProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
arrayA list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*.
Valid for: Aurora DB clusters only
booleanSpecifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster
integerThe target backtrack window, in seconds. To disable backtracking, set this value to 0.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
+ If specified, this value must be set to a number from 0 to 259,200 (72 hours).
integerThe number of days for which automated backups are retained.
Default: 1
Constraints:
+ Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringSpecifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database, allowing you to create a DB shard group for horizontal scaling (sharding) capabilities. When set to standard (the default), the cluster uses normal DB instance creation.
booleanA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe mode of Database Insights to enable for the DB cluster.
If you set this value to advanced, you must also set the PerformanceInsightsEnabled parameter to true and the PerformanceInsightsRetentionPeriod parameter to 465.
Valid for Cluster Type: Aurora DB clusters only
stringThe name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
string
stringThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all AWS-Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
string
stringThe name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
+ The DB parameter group must be in the same DB parameter group family as this DB cluster.
+ The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
stringReserved for future use.
stringIf you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource.
If you aren't configuring a global database cluster, don't specify this property.
To remove the DB cluster from a global database cluster, specify an empty value for the GlobalClusterIdentifier property.
For information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*.
Valid for: Aurora DB clusters only
stringThe DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe name of the DB cluster parameter group to associate with this DB cluster.
If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.
To list all of the available DB cluster parameter group names, use the following command:
aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringA DB subnet group that you want to associate with this DB cluster.
If you are restoring a DB cluster to a point in time with RestoreType set to copy-on-write, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
booleanA value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringIndicates the directory ID of the Active Directory to create the DB cluster.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.
Valid for: Aurora DB clusters only
stringSpecifies the name of the IAM role to use when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
arrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.
*Aurora MySQL*
Valid values: audit, error, general, slowquery
*Aurora PostgreSQL*
Valid values: postgresql
Valid for: Aurora DB clusters and Multi-AZ DB clusters
booleanSpecifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
booleanSpecifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*.
Valid for Cluster Type: Aurora DB clusters only
booleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.*
Valid for: Aurora DB clusters only
booleanSpecifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
stringThe name of the database engine to be used for this DB cluster.
Valid Values:
+ aurora-mysql
+ aurora-postgresql
+ mysql
+ postgres

Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
+ Amazon Aurora - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide*
+ Amazon RDS - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
stringThe DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.
For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*:
+ [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
+ [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)

Valid for Cluster Type: Aurora DB clusters only
stringThe version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
*Aurora MySQL*
For information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide*.
*Aurora PostgreSQL*
For information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide*.
*MySQL*
For information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*.
*PostgreSQL*
For information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
booleanSpecifies whether to manage the master user password with AWS Secrets Manager.
For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
+ Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
integerThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
+ Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
stringThe Amazon Resource Name (ARN) of the AWS KMS 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 KMS key is used. If you specify this property, you must set the StorageEncrypted property to true.
If you specify the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe name of the master user for the DB cluster.
If you specify the SourceDBClusterIdentifier, SnapshotIdentifier, or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe master password for the DB instance.
If you specify the SourceDBClusterIdentifier, SnapshotIdentifier, or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
objectThe secret managed by RDS in AWS Secrets Manager for the master user password.
When you restore a DB cluster from a snapshot, Amazon RDS generates a new secret instead of reusing the secret specified in the SecretArn property. This ensures that the restored DB cluster is securely managed with a dedicated secret. To maintain consistent integration with your application, you might need to update resource configurations to reference the newly created secret.
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* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*
integerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
stringThe Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
stringThe network type of the DB cluster.
Valid values:
+ IPV4
+ DUAL

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL).
For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*
Valid for: Aurora DB clusters only
booleanSpecifies whether to turn on Performance Insights for the DB cluster.
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*.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
stringThe AWS KMS key identifier for encryption of Performance Insights data.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't 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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
integerThe number of days to retain Performance Insights data.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
+ 7
+ *month* * 31, where *month* is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
+ 731

Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.
integerThe port number on which the DB instances in the DB cluster accept connections.
Default:
+ When EngineMode is provisioned, 3306 (for both Aurora MySQL and Aurora PostgreSQL)
+ When EngineMode is serverless:
+ 3306 when Engine is aurora or aurora-mysql
+ 5432 when Engine is aurora-postgresql


The No interruption on update behavior only applies to DB clusters. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe daily time range during which automated backups are created. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide.*
Constraints:
+ Must be in the format hh24:mi-hh24:mi.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide.*
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
booleanSpecifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
+ If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
+ If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
+ If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
+ If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
stringThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
Valid for: Aurora DB clusters only
stringThe date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
+ Must be before the latest restorable time for the DB instance
+ Must be specified if UseLatestRestorableTime parameter isn't provided
+ Can't be specified if the UseLatestRestorableTime parameter is enabled
+ Can't be specified if the RestoreType parameter is copy-on-write

This property must be used with SourceDBClusterIdentifier property. The resulting cluster will have the identifier that matches the value of the DBclusterIdentifier property.
Example: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe type of restore to be performed. You can specify one of the following values:
+ full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
+ copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
objectThe scaling configuration of an Aurora Serverless V2 DB cluster.
This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ScalingConfiguration property.
Valid for: Aurora Serverless v2 DB clusters only
objectThe scaling configuration of an Aurora Serverless v1 DB cluster.
This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property.
Valid for: Aurora Serverless v1 DB clusters only
stringThe identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
If you specify the SnapshotIdentifier property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:
+ GlobalClusterIdentifier
+ MasterUsername
+ MasterUserPassword
+ ReplicationSourceIdentifier
+ RestoreType
+ SourceDBClusterIdentifier
+ SourceRegion
+ StorageEncrypted (for an encrypted snapshot)
+ UseLatestRestorableTime

Constraints:
+ Must match the identifier of an existing Snapshot.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringWhen restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
Constraints:
+ Must match the identifier of an existing DBCluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
Valid for: Aurora DB clusters only
booleanIndicates whether the DB cluster is encrypted.
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier 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.
If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to false.
If you specify both the StorageEncrypted and SnapshotIdentifier properties without specifying the KmsKeyId property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
integer
stringThe storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings).
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
+ Aurora DB clusters - aurora | aurora-iopt1
+ Multi-AZ DB clusters - io1 | io2 | gp3

Default:
+ Aurora DB clusters - aurora
+ Multi-AZ DB clusters - io1

When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to aurora.
booleanA value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
arrayA list of EC2 VPC security groups to associate with this DB cluster.
If you plan to update the resource, don't specify VPC security groups in a shared VPC.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_clusters in a region. +```sql +SELECT +region, +endpoint, +read_endpoint, +allocated_storage, +associated_roles, +availability_zones, +auto_minor_version_upgrade, +backtrack_window, +backup_retention_period, +cluster_scalability_type, +copy_tags_to_snapshot, +database_insights_mode, +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, +enable_local_write_forwarding, +engine, +engine_lifecycle_support, +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, +use_latest_restorable_time, +vpc_security_group_ids, +tag_key, +tag_value +FROM aws.rds.db_cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_cluster_tags resource, see db_clusters + diff --git a/website/docs/services/rds/db_clusters/index.md b/website/docs/services/rds/db_clusters/index.md new file mode 100644 index 0000000..ad3a52a --- /dev/null +++ b/website/docs/services/rds/db_clusters/index.md @@ -0,0 +1,784 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a db_cluster resource or lists db_clusters in a region + +## Overview + + + + + + + +
Namedb_clusters
TypeResource
DescriptionThe AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For more information about creating 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*.
For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*.
You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
*Updating DB clusters*
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
1. Create a snapshot of the DB cluster. For more information, see [Creating a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).
1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the SnapshotIdentifier property with the ID of the DB cluster snapshot that you want to use.
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 DB cluster 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, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
1. Update the stack.

Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: PreferredBackupWindow, PreferredMaintenanceWindow, and Port. This limitation doesn't apply to provisioned DB clusters.
For more information about updating other properties of this resource, see ModifyDBCluster. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).
*Deleting DB clusters*
The default DeletionPolicy for AWS::RDS::DBCluster resources is Snapshot. For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThis data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
+ CreateDBInstance
+ DescribeDBInstances
+ DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
objectThis data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
+ CreateDBInstance
+ DescribeDBInstances
+ DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
integerThe amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
This setting is required to create a Multi-AZ DB cluster.
arrayProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
arrayA list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*.
Valid for: Aurora DB clusters only
booleanSpecifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster
integerThe target backtrack window, in seconds. To disable backtracking, set this value to 0.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
+ If specified, this value must be set to a number from 0 to 259,200 (72 hours).
integerThe number of days for which automated backups are retained.
Default: 1
Constraints:
+ Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringSpecifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database, allowing you to create a DB shard group for horizontal scaling (sharding) capabilities. When set to standard (the default), the cluster uses normal DB instance creation.
booleanA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe mode of Database Insights to enable for the DB cluster.
If you set this value to advanced, you must also set the PerformanceInsightsEnabled parameter to true and the PerformanceInsightsRetentionPeriod parameter to 465.
Valid for Cluster Type: Aurora DB clusters only
stringThe name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
string
stringThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all AWS-Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
string
stringThe name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
+ The DB parameter group must be in the same DB parameter group family as this DB cluster.
+ The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
stringReserved for future use.
stringIf you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource.
If you aren't configuring a global database cluster, don't specify this property.
To remove the DB cluster from a global database cluster, specify an empty value for the GlobalClusterIdentifier property.
For information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*.
Valid for: Aurora DB clusters only
stringThe DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe name of the DB cluster parameter group to associate with this DB cluster.
If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.
To list all of the available DB cluster parameter group names, use the following command:
aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringA DB subnet group that you want to associate with this DB cluster.
If you are restoring a DB cluster to a point in time with RestoreType set to copy-on-write, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
booleanA value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringIndicates the directory ID of the Active Directory to create the DB cluster.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.
Valid for: Aurora DB clusters only
stringSpecifies the name of the IAM role to use when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
arrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.
*Aurora MySQL*
Valid values: audit, error, general, slowquery
*Aurora PostgreSQL*
Valid values: postgresql
Valid for: Aurora DB clusters and Multi-AZ DB clusters
booleanSpecifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
booleanSpecifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*.
Valid for Cluster Type: Aurora DB clusters only
booleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.*
Valid for: Aurora DB clusters only
booleanSpecifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
stringThe name of the database engine to be used for this DB cluster.
Valid Values:
+ aurora-mysql
+ aurora-postgresql
+ mysql
+ postgres

Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
+ Amazon Aurora - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide*
+ Amazon RDS - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
stringThe DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.
For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*:
+ [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
+ [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)

Valid for Cluster Type: Aurora DB clusters only
stringThe version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
*Aurora MySQL*
For information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide*.
*Aurora PostgreSQL*
For information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide*.
*MySQL*
For information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*.
*PostgreSQL*
For information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
booleanSpecifies whether to manage the master user password with AWS Secrets Manager.
For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
+ Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
integerThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
+ Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
stringThe Amazon Resource Name (ARN) of the AWS KMS 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 KMS key is used. If you specify this property, you must set the StorageEncrypted property to true.
If you specify the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe name of the master user for the DB cluster.
If you specify the SourceDBClusterIdentifier, SnapshotIdentifier, or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe master password for the DB instance.
If you specify the SourceDBClusterIdentifier, SnapshotIdentifier, or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
objectThe secret managed by RDS in AWS Secrets Manager for the master user password.
When you restore a DB cluster from a snapshot, Amazon RDS generates a new secret instead of reusing the secret specified in the SecretArn property. This ensures that the restored DB cluster is securely managed with a dedicated secret. To maintain consistent integration with your application, you might need to update resource configurations to reference the newly created secret.
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* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*
integerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
stringThe Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
stringThe network type of the DB cluster.
Valid values:
+ IPV4
+ DUAL

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL).
For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*
Valid for: Aurora DB clusters only
booleanSpecifies whether to turn on Performance Insights for the DB cluster.
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*.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
stringThe AWS KMS key identifier for encryption of Performance Insights data.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't 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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
integerThe number of days to retain Performance Insights data.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
+ 7
+ *month* * 31, where *month* is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
+ 731

Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.
integerThe port number on which the DB instances in the DB cluster accept connections.
Default:
+ When EngineMode is provisioned, 3306 (for both Aurora MySQL and Aurora PostgreSQL)
+ When EngineMode is serverless:
+ 3306 when Engine is aurora or aurora-mysql
+ 5432 when Engine is aurora-postgresql


The No interruption on update behavior only applies to DB clusters. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe daily time range during which automated backups are created. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide.*
Constraints:
+ Must be in the format hh24:mi-hh24:mi.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide.*
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
booleanSpecifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
+ If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
+ If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
+ If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
+ If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
stringThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
Valid for: Aurora DB clusters only
stringThe date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
+ Must be before the latest restorable time for the DB instance
+ Must be specified if UseLatestRestorableTime parameter isn't provided
+ Can't be specified if the UseLatestRestorableTime parameter is enabled
+ Can't be specified if the RestoreType parameter is copy-on-write

This property must be used with SourceDBClusterIdentifier property. The resulting cluster will have the identifier that matches the value of the DBclusterIdentifier property.
Example: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe type of restore to be performed. You can specify one of the following values:
+ full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
+ copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
objectThe scaling configuration of an Aurora Serverless V2 DB cluster.
This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ScalingConfiguration property.
Valid for: Aurora Serverless v2 DB clusters only
objectThe scaling configuration of an Aurora Serverless v1 DB cluster.
This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property.
Valid for: Aurora Serverless v1 DB clusters only
stringThe identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
If you specify the SnapshotIdentifier property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:
+ GlobalClusterIdentifier
+ MasterUsername
+ MasterUserPassword
+ ReplicationSourceIdentifier
+ RestoreType
+ SourceDBClusterIdentifier
+ SourceRegion
+ StorageEncrypted (for an encrypted snapshot)
+ UseLatestRestorableTime

Constraints:
+ Must match the identifier of an existing Snapshot.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringWhen restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
Constraints:
+ Must match the identifier of an existing DBCluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringThe AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
Valid for: Aurora DB clusters only
booleanIndicates whether the DB cluster is encrypted.
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier 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.
If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to false.
If you specify both the StorageEncrypted and SnapshotIdentifier properties without specifying the KmsKeyId property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
integer
stringThe storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings).
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
+ Aurora DB clusters - aurora | aurora-iopt1
+ Multi-AZ DB clusters - io1 | io2 | gp3

Default:
+ Aurora DB clusters - aurora
+ Multi-AZ DB clusters - io1

When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to aurora.
arrayTags to assign to the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
booleanA value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
arrayA list of EC2 VPC security groups to associate with this DB cluster.
If you plan to update the resource, don't specify VPC security groups in a shared VPC.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringAWS region.
+ +For more information, see AWS::RDS::DBCluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all db_clusters in a region. +```sql +SELECT +region, +endpoint, +read_endpoint, +allocated_storage, +associated_roles, +availability_zones, +auto_minor_version_upgrade, +backtrack_window, +backup_retention_period, +cluster_scalability_type, +copy_tags_to_snapshot, +database_insights_mode, +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, +enable_local_write_forwarding, +engine, +engine_lifecycle_support, +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_clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual db_cluster. +```sql +SELECT +region, +endpoint, +read_endpoint, +allocated_storage, +associated_roles, +availability_zones, +auto_minor_version_upgrade, +backtrack_window, +backup_retention_period, +cluster_scalability_type, +copy_tags_to_snapshot, +database_insights_mode, +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, +enable_local_write_forwarding, +engine, +engine_lifecycle_support, +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_clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new db_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_clusters ( + ReadEndpoint, + AllocatedStorage, + AssociatedRoles, + AvailabilityZones, + AutoMinorVersionUpgrade, + BacktrackWindow, + BackupRetentionPeriod, + ClusterScalabilityType, + CopyTagsToSnapshot, + DatabaseInsightsMode, + DatabaseName, + DBClusterInstanceClass, + DBInstanceParameterGroupName, + DBSystemId, + GlobalClusterIdentifier, + DBClusterIdentifier, + DBClusterParameterGroupName, + DBSubnetGroupName, + DeletionProtection, + Domain, + DomainIAMRoleName, + EnableCloudwatchLogsExports, + EnableGlobalWriteForwarding, + EnableHttpEndpoint, + EnableIAMDatabaseAuthentication, + EnableLocalWriteForwarding, + Engine, + EngineLifecycleSupport, + EngineMode, + EngineVersion, + ManageMasterUserPassword, + Iops, + KmsKeyId, + MasterUsername, + MasterUserPassword, + MasterUserSecret, + MonitoringInterval, + MonitoringRoleArn, + NetworkType, + PerformanceInsightsEnabled, + PerformanceInsightsKmsKeyId, + PerformanceInsightsRetentionPeriod, + Port, + PreferredBackupWindow, + PreferredMaintenanceWindow, + PubliclyAccessible, + ReplicationSourceIdentifier, + RestoreToTime, + RestoreType, + ServerlessV2ScalingConfiguration, + ScalingConfiguration, + SnapshotIdentifier, + SourceDBClusterIdentifier, + SourceRegion, + StorageEncrypted, + StorageType, + Tags, + UseLatestRestorableTime, + VpcSecurityGroupIds, + region +) +SELECT +'{{ ReadEndpoint }}', + '{{ AllocatedStorage }}', + '{{ AssociatedRoles }}', + '{{ AvailabilityZones }}', + '{{ AutoMinorVersionUpgrade }}', + '{{ BacktrackWindow }}', + '{{ BackupRetentionPeriod }}', + '{{ ClusterScalabilityType }}', + '{{ CopyTagsToSnapshot }}', + '{{ DatabaseInsightsMode }}', + '{{ DatabaseName }}', + '{{ DBClusterInstanceClass }}', + '{{ DBInstanceParameterGroupName }}', + '{{ DBSystemId }}', + '{{ GlobalClusterIdentifier }}', + '{{ DBClusterIdentifier }}', + '{{ DBClusterParameterGroupName }}', + '{{ DBSubnetGroupName }}', + '{{ DeletionProtection }}', + '{{ Domain }}', + '{{ DomainIAMRoleName }}', + '{{ EnableCloudwatchLogsExports }}', + '{{ EnableGlobalWriteForwarding }}', + '{{ EnableHttpEndpoint }}', + '{{ EnableIAMDatabaseAuthentication }}', + '{{ EnableLocalWriteForwarding }}', + '{{ Engine }}', + '{{ EngineLifecycleSupport }}', + '{{ EngineMode }}', + '{{ EngineVersion }}', + '{{ ManageMasterUserPassword }}', + '{{ Iops }}', + '{{ KmsKeyId }}', + '{{ MasterUsername }}', + '{{ MasterUserPassword }}', + '{{ MasterUserSecret }}', + '{{ MonitoringInterval }}', + '{{ MonitoringRoleArn }}', + '{{ NetworkType }}', + '{{ PerformanceInsightsEnabled }}', + '{{ PerformanceInsightsKmsKeyId }}', + '{{ PerformanceInsightsRetentionPeriod }}', + '{{ Port }}', + '{{ PreferredBackupWindow }}', + '{{ PreferredMaintenanceWindow }}', + '{{ PubliclyAccessible }}', + '{{ ReplicationSourceIdentifier }}', + '{{ RestoreToTime }}', + '{{ RestoreType }}', + '{{ ServerlessV2ScalingConfiguration }}', + '{{ ScalingConfiguration }}', + '{{ SnapshotIdentifier }}', + '{{ SourceDBClusterIdentifier }}', + '{{ SourceRegion }}', + '{{ StorageEncrypted }}', + '{{ StorageType }}', + '{{ Tags }}', + '{{ UseLatestRestorableTime }}', + '{{ VpcSecurityGroupIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_clusters ( + ReadEndpoint, + AllocatedStorage, + AssociatedRoles, + AvailabilityZones, + AutoMinorVersionUpgrade, + BacktrackWindow, + BackupRetentionPeriod, + ClusterScalabilityType, + CopyTagsToSnapshot, + DatabaseInsightsMode, + DatabaseName, + DBClusterInstanceClass, + DBInstanceParameterGroupName, + DBSystemId, + GlobalClusterIdentifier, + DBClusterIdentifier, + DBClusterParameterGroupName, + DBSubnetGroupName, + DeletionProtection, + Domain, + DomainIAMRoleName, + EnableCloudwatchLogsExports, + EnableGlobalWriteForwarding, + EnableHttpEndpoint, + EnableIAMDatabaseAuthentication, + EnableLocalWriteForwarding, + Engine, + EngineLifecycleSupport, + EngineMode, + EngineVersion, + ManageMasterUserPassword, + Iops, + KmsKeyId, + MasterUsername, + MasterUserPassword, + MasterUserSecret, + MonitoringInterval, + MonitoringRoleArn, + NetworkType, + PerformanceInsightsEnabled, + PerformanceInsightsKmsKeyId, + PerformanceInsightsRetentionPeriod, + Port, + PreferredBackupWindow, + PreferredMaintenanceWindow, + PubliclyAccessible, + ReplicationSourceIdentifier, + RestoreToTime, + RestoreType, + ServerlessV2ScalingConfiguration, + ScalingConfiguration, + SnapshotIdentifier, + SourceDBClusterIdentifier, + SourceRegion, + StorageEncrypted, + StorageType, + Tags, + UseLatestRestorableTime, + VpcSecurityGroupIds, + region +) +SELECT + '{{ ReadEndpoint }}', + '{{ AllocatedStorage }}', + '{{ AssociatedRoles }}', + '{{ AvailabilityZones }}', + '{{ AutoMinorVersionUpgrade }}', + '{{ BacktrackWindow }}', + '{{ BackupRetentionPeriod }}', + '{{ ClusterScalabilityType }}', + '{{ CopyTagsToSnapshot }}', + '{{ DatabaseInsightsMode }}', + '{{ DatabaseName }}', + '{{ DBClusterInstanceClass }}', + '{{ DBInstanceParameterGroupName }}', + '{{ DBSystemId }}', + '{{ GlobalClusterIdentifier }}', + '{{ DBClusterIdentifier }}', + '{{ DBClusterParameterGroupName }}', + '{{ DBSubnetGroupName }}', + '{{ DeletionProtection }}', + '{{ Domain }}', + '{{ DomainIAMRoleName }}', + '{{ EnableCloudwatchLogsExports }}', + '{{ EnableGlobalWriteForwarding }}', + '{{ EnableHttpEndpoint }}', + '{{ EnableIAMDatabaseAuthentication }}', + '{{ EnableLocalWriteForwarding }}', + '{{ Engine }}', + '{{ EngineLifecycleSupport }}', + '{{ EngineMode }}', + '{{ EngineVersion }}', + '{{ ManageMasterUserPassword }}', + '{{ Iops }}', + '{{ KmsKeyId }}', + '{{ MasterUsername }}', + '{{ MasterUserPassword }}', + '{{ MasterUserSecret }}', + '{{ MonitoringInterval }}', + '{{ MonitoringRoleArn }}', + '{{ NetworkType }}', + '{{ PerformanceInsightsEnabled }}', + '{{ PerformanceInsightsKmsKeyId }}', + '{{ PerformanceInsightsRetentionPeriod }}', + '{{ Port }}', + '{{ PreferredBackupWindow }}', + '{{ PreferredMaintenanceWindow }}', + '{{ PubliclyAccessible }}', + '{{ ReplicationSourceIdentifier }}', + '{{ RestoreToTime }}', + '{{ RestoreType }}', + '{{ ServerlessV2ScalingConfiguration }}', + '{{ ScalingConfiguration }}', + '{{ SnapshotIdentifier }}', + '{{ SourceDBClusterIdentifier }}', + '{{ SourceRegion }}', + '{{ StorageEncrypted }}', + '{{ StorageType }}', + '{{ Tags }}', + '{{ UseLatestRestorableTime }}', + '{{ VpcSecurityGroupIds }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: db_cluster + props: + - name: ReadEndpoint + value: + Address: '{{ Address }}' + - name: AllocatedStorage + value: '{{ AllocatedStorage }}' + - name: AssociatedRoles + value: + - FeatureName: '{{ FeatureName }}' + RoleArn: '{{ RoleArn }}' + - name: AvailabilityZones + value: + - '{{ AvailabilityZones[0] }}' + - name: AutoMinorVersionUpgrade + value: '{{ AutoMinorVersionUpgrade }}' + - name: BacktrackWindow + value: '{{ BacktrackWindow }}' + - name: BackupRetentionPeriod + value: '{{ BackupRetentionPeriod }}' + - name: ClusterScalabilityType + value: '{{ ClusterScalabilityType }}' + - name: CopyTagsToSnapshot + value: '{{ CopyTagsToSnapshot }}' + - name: DatabaseInsightsMode + value: '{{ DatabaseInsightsMode }}' + - name: DatabaseName + value: '{{ DatabaseName }}' + - name: DBClusterInstanceClass + value: '{{ DBClusterInstanceClass }}' + - name: DBInstanceParameterGroupName + value: '{{ DBInstanceParameterGroupName }}' + - name: DBSystemId + value: '{{ DBSystemId }}' + - name: GlobalClusterIdentifier + value: '{{ GlobalClusterIdentifier }}' + - name: DBClusterIdentifier + value: '{{ DBClusterIdentifier }}' + - name: DBClusterParameterGroupName + value: '{{ DBClusterParameterGroupName }}' + - name: DBSubnetGroupName + value: '{{ DBSubnetGroupName }}' + - name: DeletionProtection + value: '{{ DeletionProtection }}' + - name: Domain + value: '{{ Domain }}' + - name: DomainIAMRoleName + value: '{{ DomainIAMRoleName }}' + - name: EnableCloudwatchLogsExports + value: + - '{{ EnableCloudwatchLogsExports[0] }}' + - name: EnableGlobalWriteForwarding + value: '{{ EnableGlobalWriteForwarding }}' + - name: EnableHttpEndpoint + value: '{{ EnableHttpEndpoint }}' + - name: EnableIAMDatabaseAuthentication + value: '{{ EnableIAMDatabaseAuthentication }}' + - name: EnableLocalWriteForwarding + value: '{{ EnableLocalWriteForwarding }}' + - name: Engine + value: '{{ Engine }}' + - name: EngineLifecycleSupport + value: '{{ EngineLifecycleSupport }}' + - name: EngineMode + value: '{{ EngineMode }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: ManageMasterUserPassword + value: '{{ ManageMasterUserPassword }}' + - name: Iops + value: '{{ Iops }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: MasterUsername + value: '{{ MasterUsername }}' + - name: MasterUserPassword + value: '{{ MasterUserPassword }}' + - name: MasterUserSecret + value: + SecretArn: '{{ SecretArn }}' + KmsKeyId: '{{ KmsKeyId }}' + - name: MonitoringInterval + value: '{{ MonitoringInterval }}' + - name: MonitoringRoleArn + value: '{{ MonitoringRoleArn }}' + - name: NetworkType + value: '{{ NetworkType }}' + - name: PerformanceInsightsEnabled + value: '{{ PerformanceInsightsEnabled }}' + - name: PerformanceInsightsKmsKeyId + value: '{{ PerformanceInsightsKmsKeyId }}' + - name: PerformanceInsightsRetentionPeriod + value: '{{ PerformanceInsightsRetentionPeriod }}' + - name: Port + value: '{{ Port }}' + - name: PreferredBackupWindow + value: '{{ PreferredBackupWindow }}' + - name: PreferredMaintenanceWindow + value: '{{ PreferredMaintenanceWindow }}' + - name: PubliclyAccessible + value: '{{ PubliclyAccessible }}' + - name: ReplicationSourceIdentifier + value: '{{ ReplicationSourceIdentifier }}' + - name: RestoreToTime + value: '{{ RestoreToTime }}' + - name: RestoreType + value: '{{ RestoreType }}' + - name: ServerlessV2ScalingConfiguration + value: + MinCapacity: null + MaxCapacity: null + SecondsUntilAutoPause: '{{ SecondsUntilAutoPause }}' + - name: ScalingConfiguration + value: + AutoPause: '{{ AutoPause }}' + MaxCapacity: '{{ MaxCapacity }}' + MinCapacity: '{{ MinCapacity }}' + SecondsBeforeTimeout: '{{ SecondsBeforeTimeout }}' + SecondsUntilAutoPause: '{{ SecondsUntilAutoPause }}' + TimeoutAction: '{{ TimeoutAction }}' + - name: SnapshotIdentifier + value: '{{ SnapshotIdentifier }}' + - name: SourceDBClusterIdentifier + value: '{{ SourceDBClusterIdentifier }}' + - name: SourceRegion + value: '{{ SourceRegion }}' + - name: StorageEncrypted + value: '{{ StorageEncrypted }}' + - name: StorageType + value: '{{ StorageType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: UseLatestRestorableTime + value: '{{ UseLatestRestorableTime }}' + - name: VpcSecurityGroupIds + value: + - '{{ VpcSecurityGroupIds[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.db_clusters +WHERE data__Identifier = '' +AND 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:DescribeDBClusterSnapshots, +rds:DescribeDBSnapshots, +rds:DescribeEvents, +rds:EnableHttpEndpoint, +rds:ModifyDBCluster, +rds:RestoreDBClusterFromSnapshot, +rds:RestoreDBClusterToPointInTime, +secretsmanager:CreateSecret, +secretsmanager:TagResource +``` + +### 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:AddTagsToResource, +rds:CreateDBClusterSnapshot, +rds:DeleteDBCluster, +rds:DeleteDBInstance, +rds:DescribeDBClusters, +rds:DescribeGlobalClusters, +rds:RemoveFromGlobalCluster +``` + +### List +```json +rds:DescribeDBClusters +``` diff --git a/website/docs/services/rds/db_clusters_list_only/index.md b/website/docs/services/rds/db_clusters_list_only/index.md new file mode 100644 index 0000000..f51a483 --- /dev/null +++ b/website/docs/services/rds/db_clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: db_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_clusters_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_clusters in a region or regions, for all properties use db_clusters + +## Overview + + + + + + + +
Namedb_clusters_list_only
TypeResource
DescriptionThe AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For more information about creating 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*.
For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*.
You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
*Updating DB clusters*
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
1. Create a snapshot of the DB cluster. For more information, see [Creating a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).
1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the SnapshotIdentifier property with the ID of the DB cluster snapshot that you want to use.
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 DB cluster 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, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
1. Update the stack.

Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: PreferredBackupWindow, PreferredMaintenanceWindow, and Port. This limitation doesn't apply to provisioned DB clusters.
For more information about updating other properties of this resource, see ModifyDBCluster. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).
*Deleting DB clusters*
The default DeletionPolicy for AWS::RDS::DBCluster resources is Snapshot. For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ First character must be a letter.
+ Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_clusters in a region. +```sql +SELECT +region, +db_cluster_identifier +FROM aws.rds.db_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_clusters_list_only resource, see db_clusters + diff --git a/website/docs/services/rds/db_instance_tags/index.md b/website/docs/services/rds/db_instance_tags/index.md new file mode 100644 index 0000000..3d65f8c --- /dev/null +++ b/website/docs/services/rds/db_instance_tags/index.md @@ -0,0 +1,237 @@ +--- +title: db_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_instance_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_instances in a region + +## Overview + + + + + + + +
Namedb_instance_tags
TypeResource
DescriptionThe AWS::RDS::DBInstance resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.
For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.
For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
*Updating DB instances*
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
1. Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html).
1. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use.
After you restore a DB instance with a DBSnapshotIdentifier property, you can delete the DBSnapshotIdentifier property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
1. Update the stack.

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

For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments).
*Amazon Aurora*
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
*Db2*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

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

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

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

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

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

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

+ Magnetic storage (standard):
+ Enterprise and Standard editions: Must be an integer from 20 to 1024.
+ Web and Express editions: Must be an integer from 20 to 1024.
booleanA value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
arrayThe IAMlong (IAM) roles associated with the DB instance.
*Amazon Aurora*
Not applicable. The associated roles are managed by the DB cluster.
booleanA value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
stringThe AWS-Region associated with the automated backup.
stringThe AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
stringThe Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.
Constraints:
+ The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
+ The specified Availability Zone must be in the same AWS-Region as the current endpoint.

Example: us-east-1d
integerThe number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
*Amazon Aurora*
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
+ Must be a value from 0 to 35
+ Can't be set to 0 if the DB instance is a source to read replicas
stringThe identifier of the CA certificate for this DB instance.
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.
objectThe details of the DB instance's server certificate.
booleanSpecifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
+ For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.*
+ For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.

This setting doesn't apply to RDS Custom DB instances.
stringFor supported engines, indicates that the DB instance should be associated with the specified character set.
*Amazon Aurora*
Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).
booleanSpecifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
stringThe instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
This setting is required for RDS Custom.
Constraints:
+ The profile must exist in your account.
+ The profile must have an IAM role that Amazon EC2 has permissions to assume.
+ The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.
string
stringThe identifier of the DB cluster that this DB instance will belong to.
This setting doesn't apply to RDS Custom DB instances.
stringThe identifier for the Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.
Constraints:
+ Must match the identifier of an existing Multi-AZ DB cluster snapshot.
+ Can't be specified when DBSnapshotIdentifier is specified.
+ Must be specified when DBSnapshotIdentifier isn't specified.
+ If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
+ Can't be the identifier of an Aurora DB cluster snapshot.
string
stringThe compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.
stringA name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
string
stringThe meaning of this parameter differs according to the database engine you use.
If you specify the DBSnapshotIdentifier property, this property only applies to RDS for Oracle.
*Amazon Aurora*
Not applicable. The database name is managed by the DB cluster.
*Db2*
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
+ Must contain 1 to 64 letters or numbers.
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Can't be a word reserved by the specified database engine.

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

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

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

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

*SQL Server*
Not applicable. Must be null.
stringThe name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
arrayA list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.
If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.
If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:
+ AllocatedStorage
+ AutoMinorVersionUpgrade
+ AvailabilityZone
+ BackupRetentionPeriod
+ CharacterSetName
+ DBInstanceClass
+ DBName
+ DBParameterGroupName
+ DBSecurityGroups
+ DBSubnetGroupName
+ Engine
+ EngineVersion
+ Iops
+ LicenseModel
+ MasterUsername
+ MasterUserPassword
+ MultiAZ
+ OptionGroupName
+ PreferredBackupWindow
+ PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
stringThe name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.
By specifying this property, you can create a DB instance from the specified DB snapshot. If the DBSnapshotIdentifier property is an empty string or the AWS::RDS::DBInstance declaration has no DBSnapshotIdentifier property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.
Some DB instance properties aren't valid when you restore from a snapshot, such as the MasterUsername and MasterUserPassword properties. For information about the properties that you can specify, see the RestoreDBInstanceFromDBSnapshot action in the *Amazon RDS API Reference*.
After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
If you specify the DBSnapshotIdentifier property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
+ CharacterSetName
+ DBClusterIdentifier
+ DBName
+ KmsKeyId
+ MasterUsername
+ MasterUserPassword
+ PromotionTier
+ SourceDBInstanceIdentifier
+ SourceRegion
+ StorageEncrypted (for an unencrypted snapshot)
+ Timezone

*Amazon Aurora*
Not applicable. Snapshot restore is managed by the DB cluster.
stringA DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.
If there's no DB subnet group, then the DB instance isn't a VPC DB instance.
For more information about using Amazon RDS in a VPC, see [Amazon VPC and Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
stringThe Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.
booleanIndicates whether the DB instance has a dedicated log volume (DLV) enabled.
booleanA value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
*Amazon Aurora*
Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
booleanSpecifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
This setting doesn't apply to Amazon Aurora DB instances. 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.
stringThe Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.
stringThe ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
arrayThe IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
+ Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237
stringThe fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
+ Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain
stringThe name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to the following DB instances:
+ Amazon Aurora (The domain is managed by the DB cluster.)
+ RDS Custom
stringThe Active Directory organizational unit for your DB instance to join.
Constraints:
+ Must be in the distinguished name format.
+ Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
arrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*.
*Amazon Aurora*
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
*Db2*
Valid values: diag.log, notify.log
*MariaDB*
Valid values: audit, error, general, slowquery
*Microsoft SQL Server*
Valid values: agent, error
*MySQL*
Valid values: audit, error, general, slowquery
*Oracle*
Valid values: alert, audit, listener, trace, oemagent
*PostgreSQL*
Valid values: postgresql, upgrade
booleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*
*Amazon Aurora*
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
booleanSpecifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.
This setting doesn't apply to RDS Custom DB instances.
objectThe connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
stringThe name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.
This property is required when creating a DB instance.
You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb. Converting to the CDB architecture requires an interruption.
Valid Values:
+ aurora-mysql (for Aurora MySQL DB instances)
+ aurora-postgresql (for Aurora PostgreSQL DB instances)
+ custom-oracle-ee (for RDS Custom for Oracle DB instances)
+ custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
+ custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
+ custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
+ custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
+ db2-ae
+ db2-se
+ mariadb
+ mysql
+ oracle-ee
+ oracle-ee-cdb
+ oracle-se2
+ oracle-se2-cdb
+ postgres
+ sqlserver-ee
+ sqlserver-se
+ sqlserver-ex
+ sqlserver-web
stringThe life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
stringThe version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
*Amazon Aurora*
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
*Db2*
See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*MariaDB*
See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*Microsoft SQL Server*
See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.*
*MySQL*
See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*Oracle*
See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.*
*PostgreSQL*
See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*
booleanSpecifies whether to manage the master user password with AWS Secrets Manager.
For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
Constraints:
+ Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
integerThe number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.
If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.
If you specify io1 for the StorageType property, then you must also specify the Iops property.
Constraints:
+ For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
+ For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
stringThe ARN of the AWS KMS key that's used to encrypt the DB instance, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.
If you specify the SourceDBInstanceIdentifier or SourceDbiResourceId 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. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.
If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified KmsKeyId property is used.
If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.
If you specify the DBSnapshotIdentifier property, don't specify this property. The StorageEncrypted property value is inherited from the snapshot. If the DB instance is encrypted, the specified KmsKeyId property is also inherited from the snapshot.
If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
*Amazon Aurora*
Not applicable. The KMS key identifier is managed by the DB cluster.
stringLicense model information for this DB instance.
Valid Values:
+ Aurora MySQL - general-public-license
+ Aurora PostgreSQL - postgresql-license
+ RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.*
+ RDS for MariaDB - general-public-license
+ RDS for Microsoft SQL Server - license-included
+ RDS for MySQL - general-public-license
+ RDS for Oracle - bring-your-own-license or license-included
+ RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.
stringThe master user name for the DB instance.
If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot.
When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.
*Amazon Aurora*
Not applicable. The name for the master user is managed by the DB cluster.
*RDS for Db2*
Constraints:
+ Must be 1 to 16 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.

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

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

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

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

*RDS for PostgreSQL*
Constraints:
+ Must be 1 to 63 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.
stringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@".
*Amazon Aurora*
Not applicable. The password for the master user is managed by the DB cluster.
*RDS for Db2*
Must contain from 8 to 255 characters.
*RDS for MariaDB*
Constraints: Must contain from 8 to 41 characters.
*RDS for Microsoft SQL Server*
Constraints: Must contain from 8 to 128 characters.
*RDS for MySQL*
Constraints: Must contain from 8 to 41 characters.
*RDS for Oracle*
Constraints: Must contain from 8 to 30 characters.
*RDS for PostgreSQL*
Constraints: Must contain from 8 to 128 characters.
objectThe secret managed by RDS in AWS Secrets Manager for the master user password.
For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
integerThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.
This setting doesn't apply to the following DB instances:
+ Amazon Aurora (Storage is managed by the DB cluster.)
+ RDS Custom
integerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
stringThe ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom DB instances.
booleanSpecifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to the following DB instances:
+ Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
+ RDS Custom
stringThe name of the NCHAR character set for the Oracle DB instance.
This setting doesn't apply to RDS Custom DB instances.
stringThe network type of the DB instance.
Valid values:
+ IPV4
+ DUAL

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL).
For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*
stringIndicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
stringThe AWS KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.
For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).
integerThe number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
+ 7
+ *month* * 31, where *month* is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
+ 731

Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
stringThe port number on which the database accepts connections.
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
Valid Values: 1150-65535
Default:
+ RDS for Db2 - 50000
+ RDS for MariaDB - 3306
+ RDS for Microsoft SQL Server - 1433
+ RDS for MySQL - 3306
+ RDS for Oracle - 1521
+ RDS for PostgreSQL - 5432

Constraints:
+ For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
stringThe daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.*
Constraints:
+ Must be in the format hh24:mi-hh24:mi.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.

*Amazon Aurora*
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
stringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.*
This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.
Constraints: Minimum 30-minute window.
arrayThe number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
integerThe order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.
This setting doesn't apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
booleanIndicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.
The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.
stringThe open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.
This setting is only supported in RDS for Oracle.
Default: open-read-only
Valid Values: open-read-only or mounted
stringThe date and time to restore from. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*.
Constraints:
+ Must be a time in Universal Coordinated Time (UTC) format.
+ Must be before the latest restorable time for the DB instance.
+ Can't be specified if the UseLatestRestorableTime parameter is enabled.

Example: 2009-09-07T23:45:00Z
stringThe identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
+ Must be the identifier of an existing Multi-AZ DB cluster.
+ Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
+ The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
+ The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
stringThe resource ID of the source DB instance from which to restore.
stringThe Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
stringIf you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.
For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
The SourceDBInstanceIdentifier property determines whether a DB instance is a read replica. If you remove the SourceDBInstanceIdentifier property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.
If you specify the UseLatestRestorableTime or RestoreTime properties in conjunction with the SourceDBInstanceIdentifier property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.
+ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the VPCSecurityGroups property. If you don't specify the property, the read replica inherits the value of the VPCSecurityGroups property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's VPCSecurityGroups property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.
+ Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
+ If you specify SourceDBInstanceIdentifier, don't specify the DBSnapshotIdentifier property. You can't create a read replica from a snapshot.
+ Don't set the BackupRetentionPeriod, DBName, MasterUsername, MasterUserPassword, and PreferredBackupWindow properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.
+ If the source DB instance is in a different region than the read replica, specify the source region in SourceRegion, and specify an ARN for a valid DB instance in SourceDBInstanceIdentifier. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*.
+ For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.
stringThe ID of the region that contains the source DB instance for the read replica.
booleanA value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBInstanceIdentifier or SourceDbiResourceId property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used.
If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup.
If you specify DBSnapshotIdentifier property, don't specify this property. The value is inherited from the snapshot.
*Amazon Aurora*
Not applicable. The encryption for DB instances is managed by the DB cluster.
stringThe storage type to associate with the DB instance.
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp2.
integerSpecifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
string
string
stringThe time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).
booleanSpecifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
booleanSpecifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*.
Constraints:
+ Can't be specified if the RestoreTime parameter is provided.
arrayA list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.
If you plan to update the resource, don't specify VPC security groups in a shared VPC.
If you set VPCSecurityGroups, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.
You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:
+ You can't revert to using an RDS security group after you establish a VPC security group membership.
+ When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
+ To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.
*Amazon Aurora*
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_instances in a region. +```sql +SELECT +region, +allocated_storage, +allow_major_version_upgrade, +associated_roles, +auto_minor_version_upgrade, +automatic_backup_replication_region, +automatic_backup_replication_kms_key_id, +availability_zone, +backup_retention_period, +ca_certificate_identifier, +certificate_details, +certificate_rotation_restart, +character_set_name, +copy_tags_to_snapshot, +custom_iam_instance_profile, +database_insights_mode, +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_lifecycle_support, +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, +tde_credential_arn, +tde_credential_password, +timezone, +use_default_processor_features, +use_latest_restorable_time, +vpc_security_groups, +tag_key, +tag_value +FROM aws.rds.db_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_instance_tags resource, see db_instances + diff --git a/website/docs/services/rds/db_instances/index.md b/website/docs/services/rds/db_instances/index.md new file mode 100644 index 0000000..a539656 --- /dev/null +++ b/website/docs/services/rds/db_instances/index.md @@ -0,0 +1,989 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a db_instance resource or lists 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.
For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.
For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
*Updating DB instances*
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
1. Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html).
1. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use.
After you restore a DB instance with a DBSnapshotIdentifier property, you can delete the DBSnapshotIdentifier property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
1. Update the stack.

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

For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments).
*Amazon Aurora*
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
*Db2*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

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

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

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

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

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

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

+ Magnetic storage (standard):
+ Enterprise and Standard editions: Must be an integer from 20 to 1024.
+ Web and Express editions: Must be an integer from 20 to 1024.
booleanA value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
arrayThe IAMlong (IAM) roles associated with the DB instance.
*Amazon Aurora*
Not applicable. The associated roles are managed by the DB cluster.
booleanA value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
stringThe AWS-Region associated with the automated backup.
stringThe AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
stringThe Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.
Constraints:
+ The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
+ The specified Availability Zone must be in the same AWS-Region as the current endpoint.

Example: us-east-1d
integerThe number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
*Amazon Aurora*
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
+ Must be a value from 0 to 35
+ Can't be set to 0 if the DB instance is a source to read replicas
stringThe identifier of the CA certificate for this DB instance.
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.
objectThe details of the DB instance's server certificate.
booleanSpecifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
+ For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.*
+ For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.

This setting doesn't apply to RDS Custom DB instances.
stringFor supported engines, indicates that the DB instance should be associated with the specified character set.
*Amazon Aurora*
Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).
booleanSpecifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
stringThe instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
This setting is required for RDS Custom.
Constraints:
+ The profile must exist in your account.
+ The profile must have an IAM role that Amazon EC2 has permissions to assume.
+ The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.
string
stringThe identifier of the DB cluster that this DB instance will belong to.
This setting doesn't apply to RDS Custom DB instances.
stringThe identifier for the Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.
Constraints:
+ Must match the identifier of an existing Multi-AZ DB cluster snapshot.
+ Can't be specified when DBSnapshotIdentifier is specified.
+ Must be specified when DBSnapshotIdentifier isn't specified.
+ If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
+ Can't be the identifier of an Aurora DB cluster snapshot.
string
stringThe compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.
stringA name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
string
stringThe meaning of this parameter differs according to the database engine you use.
If you specify the DBSnapshotIdentifier property, this property only applies to RDS for Oracle.
*Amazon Aurora*
Not applicable. The database name is managed by the DB cluster.
*Db2*
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
+ Must contain 1 to 64 letters or numbers.
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Can't be a word reserved by the specified database engine.

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

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

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

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

*SQL Server*
Not applicable. Must be null.
stringThe name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
arrayA list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.
If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.
If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:
+ AllocatedStorage
+ AutoMinorVersionUpgrade
+ AvailabilityZone
+ BackupRetentionPeriod
+ CharacterSetName
+ DBInstanceClass
+ DBName
+ DBParameterGroupName
+ DBSecurityGroups
+ DBSubnetGroupName
+ Engine
+ EngineVersion
+ Iops
+ LicenseModel
+ MasterUsername
+ MasterUserPassword
+ MultiAZ
+ OptionGroupName
+ PreferredBackupWindow
+ PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
stringThe name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.
By specifying this property, you can create a DB instance from the specified DB snapshot. If the DBSnapshotIdentifier property is an empty string or the AWS::RDS::DBInstance declaration has no DBSnapshotIdentifier property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.
Some DB instance properties aren't valid when you restore from a snapshot, such as the MasterUsername and MasterUserPassword properties. For information about the properties that you can specify, see the RestoreDBInstanceFromDBSnapshot action in the *Amazon RDS API Reference*.
After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
If you specify the DBSnapshotIdentifier property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
+ CharacterSetName
+ DBClusterIdentifier
+ DBName
+ KmsKeyId
+ MasterUsername
+ MasterUserPassword
+ PromotionTier
+ SourceDBInstanceIdentifier
+ SourceRegion
+ StorageEncrypted (for an unencrypted snapshot)
+ Timezone

*Amazon Aurora*
Not applicable. Snapshot restore is managed by the DB cluster.
stringA DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.
If there's no DB subnet group, then the DB instance isn't a VPC DB instance.
For more information about using Amazon RDS in a VPC, see [Amazon VPC and Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
stringThe Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.
booleanIndicates whether the DB instance has a dedicated log volume (DLV) enabled.
booleanA value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
*Amazon Aurora*
Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
booleanSpecifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
This setting doesn't apply to Amazon Aurora DB instances. 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.
stringThe Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.
stringThe ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
arrayThe IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
+ Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237
stringThe fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
+ Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain
stringThe name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to the following DB instances:
+ Amazon Aurora (The domain is managed by the DB cluster.)
+ RDS Custom
stringThe Active Directory organizational unit for your DB instance to join.
Constraints:
+ Must be in the distinguished name format.
+ Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
arrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*.
*Amazon Aurora*
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
*Db2*
Valid values: diag.log, notify.log
*MariaDB*
Valid values: audit, error, general, slowquery
*Microsoft SQL Server*
Valid values: agent, error
*MySQL*
Valid values: audit, error, general, slowquery
*Oracle*
Valid values: alert, audit, listener, trace, oemagent
*PostgreSQL*
Valid values: postgresql, upgrade
booleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*
*Amazon Aurora*
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
booleanSpecifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.
This setting doesn't apply to RDS Custom DB instances.
objectThe connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
stringThe name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.
This property is required when creating a DB instance.
You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb. Converting to the CDB architecture requires an interruption.
Valid Values:
+ aurora-mysql (for Aurora MySQL DB instances)
+ aurora-postgresql (for Aurora PostgreSQL DB instances)
+ custom-oracle-ee (for RDS Custom for Oracle DB instances)
+ custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
+ custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
+ custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
+ custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
+ db2-ae
+ db2-se
+ mariadb
+ mysql
+ oracle-ee
+ oracle-ee-cdb
+ oracle-se2
+ oracle-se2-cdb
+ postgres
+ sqlserver-ee
+ sqlserver-se
+ sqlserver-ex
+ sqlserver-web
stringThe life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
stringThe version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
*Amazon Aurora*
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
*Db2*
See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*MariaDB*
See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*Microsoft SQL Server*
See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.*
*MySQL*
See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*Oracle*
See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.*
*PostgreSQL*
See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*
booleanSpecifies whether to manage the master user password with AWS Secrets Manager.
For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
Constraints:
+ Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
integerThe number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.
If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.
If you specify io1 for the StorageType property, then you must also specify the Iops property.
Constraints:
+ For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
+ For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
stringThe ARN of the AWS KMS key that's used to encrypt the DB instance, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.
If you specify the SourceDBInstanceIdentifier or SourceDbiResourceId 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. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.
If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified KmsKeyId property is used.
If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.
If you specify the DBSnapshotIdentifier property, don't specify this property. The StorageEncrypted property value is inherited from the snapshot. If the DB instance is encrypted, the specified KmsKeyId property is also inherited from the snapshot.
If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
*Amazon Aurora*
Not applicable. The KMS key identifier is managed by the DB cluster.
stringLicense model information for this DB instance.
Valid Values:
+ Aurora MySQL - general-public-license
+ Aurora PostgreSQL - postgresql-license
+ RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.*
+ RDS for MariaDB - general-public-license
+ RDS for Microsoft SQL Server - license-included
+ RDS for MySQL - general-public-license
+ RDS for Oracle - bring-your-own-license or license-included
+ RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.
stringThe master user name for the DB instance.
If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot.
When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.
*Amazon Aurora*
Not applicable. The name for the master user is managed by the DB cluster.
*RDS for Db2*
Constraints:
+ Must be 1 to 16 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.

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

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

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

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

*RDS for PostgreSQL*
Constraints:
+ Must be 1 to 63 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.
stringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@".
*Amazon Aurora*
Not applicable. The password for the master user is managed by the DB cluster.
*RDS for Db2*
Must contain from 8 to 255 characters.
*RDS for MariaDB*
Constraints: Must contain from 8 to 41 characters.
*RDS for Microsoft SQL Server*
Constraints: Must contain from 8 to 128 characters.
*RDS for MySQL*
Constraints: Must contain from 8 to 41 characters.
*RDS for Oracle*
Constraints: Must contain from 8 to 30 characters.
*RDS for PostgreSQL*
Constraints: Must contain from 8 to 128 characters.
objectThe secret managed by RDS in AWS Secrets Manager for the master user password.
For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
integerThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.
This setting doesn't apply to the following DB instances:
+ Amazon Aurora (Storage is managed by the DB cluster.)
+ RDS Custom
integerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
stringThe ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom DB instances.
booleanSpecifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to the following DB instances:
+ Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
+ RDS Custom
stringThe name of the NCHAR character set for the Oracle DB instance.
This setting doesn't apply to RDS Custom DB instances.
stringThe network type of the DB instance.
Valid values:
+ IPV4
+ DUAL

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL).
For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*
stringIndicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
stringThe AWS KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.
For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).
integerThe number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
+ 7
+ *month* * 31, where *month* is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
+ 731

Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
stringThe port number on which the database accepts connections.
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
Valid Values: 1150-65535
Default:
+ RDS for Db2 - 50000
+ RDS for MariaDB - 3306
+ RDS for Microsoft SQL Server - 1433
+ RDS for MySQL - 3306
+ RDS for Oracle - 1521
+ RDS for PostgreSQL - 5432

Constraints:
+ For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
stringThe daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.*
Constraints:
+ Must be in the format hh24:mi-hh24:mi.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.

*Amazon Aurora*
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
stringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.*
This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.
Constraints: Minimum 30-minute window.
arrayThe number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
integerThe order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.
This setting doesn't apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
booleanIndicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.
The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.
stringThe open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.
This setting is only supported in RDS for Oracle.
Default: open-read-only
Valid Values: open-read-only or mounted
stringThe date and time to restore from. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*.
Constraints:
+ Must be a time in Universal Coordinated Time (UTC) format.
+ Must be before the latest restorable time for the DB instance.
+ Can't be specified if the UseLatestRestorableTime parameter is enabled.

Example: 2009-09-07T23:45:00Z
stringThe identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
+ Must be the identifier of an existing Multi-AZ DB cluster.
+ Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
+ The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
+ The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
stringThe resource ID of the source DB instance from which to restore.
stringThe Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
stringIf you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.
For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
The SourceDBInstanceIdentifier property determines whether a DB instance is a read replica. If you remove the SourceDBInstanceIdentifier property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.
If you specify the UseLatestRestorableTime or RestoreTime properties in conjunction with the SourceDBInstanceIdentifier property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.
+ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the VPCSecurityGroups property. If you don't specify the property, the read replica inherits the value of the VPCSecurityGroups property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's VPCSecurityGroups property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.
+ Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
+ If you specify SourceDBInstanceIdentifier, don't specify the DBSnapshotIdentifier property. You can't create a read replica from a snapshot.
+ Don't set the BackupRetentionPeriod, DBName, MasterUsername, MasterUserPassword, and PreferredBackupWindow properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.
+ If the source DB instance is in a different region than the read replica, specify the source region in SourceRegion, and specify an ARN for a valid DB instance in SourceDBInstanceIdentifier. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*.
+ For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.
stringThe ID of the region that contains the source DB instance for the read replica.
booleanA value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBInstanceIdentifier or SourceDbiResourceId property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used.
If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup.
If you specify DBSnapshotIdentifier property, don't specify this property. The value is inherited from the snapshot.
*Amazon Aurora*
Not applicable. The encryption for DB instances is managed by the DB cluster.
stringThe storage type to associate with the DB instance.
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp2.
integerSpecifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
arrayTags to assign to the DB instance.
string
string
stringThe time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).
booleanSpecifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
booleanSpecifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*.
Constraints:
+ Can't be specified if the RestoreTime parameter is provided.
arrayA list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.
If you plan to update the resource, don't specify VPC security groups in a shared VPC.
If you set VPCSecurityGroups, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.
You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:
+ You can't revert to using an RDS security group after you establish a VPC security group membership.
+ When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
+ To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.
*Amazon Aurora*
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
stringAWS region.
+ +For more information, see AWS::RDS::DBInstance. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all db_instances in a region. +```sql +SELECT +region, +allocated_storage, +allow_major_version_upgrade, +associated_roles, +auto_minor_version_upgrade, +automatic_backup_replication_region, +automatic_backup_replication_kms_key_id, +availability_zone, +backup_retention_period, +ca_certificate_identifier, +certificate_details, +certificate_rotation_restart, +character_set_name, +copy_tags_to_snapshot, +custom_iam_instance_profile, +database_insights_mode, +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_lifecycle_support, +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_instances +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual db_instance. +```sql +SELECT +region, +allocated_storage, +allow_major_version_upgrade, +associated_roles, +auto_minor_version_upgrade, +automatic_backup_replication_region, +automatic_backup_replication_kms_key_id, +availability_zone, +backup_retention_period, +ca_certificate_identifier, +certificate_details, +certificate_rotation_restart, +character_set_name, +copy_tags_to_snapshot, +custom_iam_instance_profile, +database_insights_mode, +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_lifecycle_support, +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_instances +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new db_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_instances ( + AllocatedStorage, + AllowMajorVersionUpgrade, + AssociatedRoles, + AutoMinorVersionUpgrade, + AutomaticBackupReplicationRegion, + AutomaticBackupReplicationKmsKeyId, + AvailabilityZone, + BackupRetentionPeriod, + CACertificateIdentifier, + CertificateDetails, + CertificateRotationRestart, + CharacterSetName, + CopyTagsToSnapshot, + CustomIAMInstanceProfile, + DBClusterIdentifier, + DBClusterSnapshotIdentifier, + DBInstanceClass, + DBInstanceIdentifier, + DBName, + DBParameterGroupName, + DBSecurityGroups, + DBSnapshotIdentifier, + DBSubnetGroupName, + DBSystemId, + DedicatedLogVolume, + DeleteAutomatedBackups, + DeletionProtection, + Domain, + DomainAuthSecretArn, + DomainDnsIps, + DomainFqdn, + DomainIAMRoleName, + DomainOu, + EnableCloudwatchLogsExports, + EnableIAMDatabaseAuthentication, + EnablePerformanceInsights, + Endpoint, + Engine, + EngineLifecycleSupport, + EngineVersion, + ManageMasterUserPassword, + Iops, + KmsKeyId, + LicenseModel, + MasterUsername, + MasterUserPassword, + MasterUserSecret, + MaxAllocatedStorage, + MonitoringInterval, + MonitoringRoleArn, + MultiAZ, + NcharCharacterSetName, + NetworkType, + OptionGroupName, + PerformanceInsightsKMSKeyId, + PerformanceInsightsRetentionPeriod, + Port, + PreferredBackupWindow, + PreferredMaintenanceWindow, + ProcessorFeatures, + PromotionTier, + PubliclyAccessible, + ReplicaMode, + RestoreTime, + SourceDBClusterIdentifier, + SourceDbiResourceId, + SourceDBInstanceAutomatedBackupsArn, + SourceDBInstanceIdentifier, + SourceRegion, + StorageEncrypted, + StorageType, + StorageThroughput, + Tags, + TdeCredentialArn, + TdeCredentialPassword, + Timezone, + UseDefaultProcessorFeatures, + UseLatestRestorableTime, + VPCSecurityGroups, + region +) +SELECT +'{{ AllocatedStorage }}', + '{{ AllowMajorVersionUpgrade }}', + '{{ AssociatedRoles }}', + '{{ AutoMinorVersionUpgrade }}', + '{{ AutomaticBackupReplicationRegion }}', + '{{ AutomaticBackupReplicationKmsKeyId }}', + '{{ AvailabilityZone }}', + '{{ BackupRetentionPeriod }}', + '{{ CACertificateIdentifier }}', + '{{ CertificateDetails }}', + '{{ CertificateRotationRestart }}', + '{{ CharacterSetName }}', + '{{ CopyTagsToSnapshot }}', + '{{ CustomIAMInstanceProfile }}', + '{{ DBClusterIdentifier }}', + '{{ DBClusterSnapshotIdentifier }}', + '{{ DBInstanceClass }}', + '{{ DBInstanceIdentifier }}', + '{{ DBName }}', + '{{ DBParameterGroupName }}', + '{{ DBSecurityGroups }}', + '{{ DBSnapshotIdentifier }}', + '{{ DBSubnetGroupName }}', + '{{ DBSystemId }}', + '{{ DedicatedLogVolume }}', + '{{ DeleteAutomatedBackups }}', + '{{ DeletionProtection }}', + '{{ Domain }}', + '{{ DomainAuthSecretArn }}', + '{{ DomainDnsIps }}', + '{{ DomainFqdn }}', + '{{ DomainIAMRoleName }}', + '{{ DomainOu }}', + '{{ EnableCloudwatchLogsExports }}', + '{{ EnableIAMDatabaseAuthentication }}', + '{{ EnablePerformanceInsights }}', + '{{ Endpoint }}', + '{{ Engine }}', + '{{ EngineLifecycleSupport }}', + '{{ EngineVersion }}', + '{{ ManageMasterUserPassword }}', + '{{ Iops }}', + '{{ KmsKeyId }}', + '{{ LicenseModel }}', + '{{ MasterUsername }}', + '{{ MasterUserPassword }}', + '{{ MasterUserSecret }}', + '{{ MaxAllocatedStorage }}', + '{{ MonitoringInterval }}', + '{{ MonitoringRoleArn }}', + '{{ MultiAZ }}', + '{{ NcharCharacterSetName }}', + '{{ NetworkType }}', + '{{ OptionGroupName }}', + '{{ PerformanceInsightsKMSKeyId }}', + '{{ PerformanceInsightsRetentionPeriod }}', + '{{ Port }}', + '{{ PreferredBackupWindow }}', + '{{ PreferredMaintenanceWindow }}', + '{{ ProcessorFeatures }}', + '{{ PromotionTier }}', + '{{ PubliclyAccessible }}', + '{{ ReplicaMode }}', + '{{ RestoreTime }}', + '{{ SourceDBClusterIdentifier }}', + '{{ SourceDbiResourceId }}', + '{{ SourceDBInstanceAutomatedBackupsArn }}', + '{{ SourceDBInstanceIdentifier }}', + '{{ SourceRegion }}', + '{{ StorageEncrypted }}', + '{{ StorageType }}', + '{{ StorageThroughput }}', + '{{ Tags }}', + '{{ TdeCredentialArn }}', + '{{ TdeCredentialPassword }}', + '{{ Timezone }}', + '{{ UseDefaultProcessorFeatures }}', + '{{ UseLatestRestorableTime }}', + '{{ VPCSecurityGroups }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_instances ( + AllocatedStorage, + AllowMajorVersionUpgrade, + AssociatedRoles, + AutoMinorVersionUpgrade, + AutomaticBackupReplicationRegion, + AutomaticBackupReplicationKmsKeyId, + AvailabilityZone, + BackupRetentionPeriod, + CACertificateIdentifier, + CertificateDetails, + CertificateRotationRestart, + CharacterSetName, + CopyTagsToSnapshot, + CustomIAMInstanceProfile, + DBClusterIdentifier, + DBClusterSnapshotIdentifier, + DBInstanceClass, + DBInstanceIdentifier, + DBName, + DBParameterGroupName, + DBSecurityGroups, + DBSnapshotIdentifier, + DBSubnetGroupName, + DBSystemId, + DedicatedLogVolume, + DeleteAutomatedBackups, + DeletionProtection, + Domain, + DomainAuthSecretArn, + DomainDnsIps, + DomainFqdn, + DomainIAMRoleName, + DomainOu, + EnableCloudwatchLogsExports, + EnableIAMDatabaseAuthentication, + EnablePerformanceInsights, + Endpoint, + Engine, + EngineLifecycleSupport, + EngineVersion, + ManageMasterUserPassword, + Iops, + KmsKeyId, + LicenseModel, + MasterUsername, + MasterUserPassword, + MasterUserSecret, + MaxAllocatedStorage, + MonitoringInterval, + MonitoringRoleArn, + MultiAZ, + NcharCharacterSetName, + NetworkType, + OptionGroupName, + PerformanceInsightsKMSKeyId, + PerformanceInsightsRetentionPeriod, + Port, + PreferredBackupWindow, + PreferredMaintenanceWindow, + ProcessorFeatures, + PromotionTier, + PubliclyAccessible, + ReplicaMode, + RestoreTime, + SourceDBClusterIdentifier, + SourceDbiResourceId, + SourceDBInstanceAutomatedBackupsArn, + SourceDBInstanceIdentifier, + SourceRegion, + StorageEncrypted, + StorageType, + StorageThroughput, + Tags, + TdeCredentialArn, + TdeCredentialPassword, + Timezone, + UseDefaultProcessorFeatures, + UseLatestRestorableTime, + VPCSecurityGroups, + region +) +SELECT + '{{ AllocatedStorage }}', + '{{ AllowMajorVersionUpgrade }}', + '{{ AssociatedRoles }}', + '{{ AutoMinorVersionUpgrade }}', + '{{ AutomaticBackupReplicationRegion }}', + '{{ AutomaticBackupReplicationKmsKeyId }}', + '{{ AvailabilityZone }}', + '{{ BackupRetentionPeriod }}', + '{{ CACertificateIdentifier }}', + '{{ CertificateDetails }}', + '{{ CertificateRotationRestart }}', + '{{ CharacterSetName }}', + '{{ CopyTagsToSnapshot }}', + '{{ CustomIAMInstanceProfile }}', + '{{ DBClusterIdentifier }}', + '{{ DBClusterSnapshotIdentifier }}', + '{{ DBInstanceClass }}', + '{{ DBInstanceIdentifier }}', + '{{ DBName }}', + '{{ DBParameterGroupName }}', + '{{ DBSecurityGroups }}', + '{{ DBSnapshotIdentifier }}', + '{{ DBSubnetGroupName }}', + '{{ DBSystemId }}', + '{{ DedicatedLogVolume }}', + '{{ DeleteAutomatedBackups }}', + '{{ DeletionProtection }}', + '{{ Domain }}', + '{{ DomainAuthSecretArn }}', + '{{ DomainDnsIps }}', + '{{ DomainFqdn }}', + '{{ DomainIAMRoleName }}', + '{{ DomainOu }}', + '{{ EnableCloudwatchLogsExports }}', + '{{ EnableIAMDatabaseAuthentication }}', + '{{ EnablePerformanceInsights }}', + '{{ Endpoint }}', + '{{ Engine }}', + '{{ EngineLifecycleSupport }}', + '{{ EngineVersion }}', + '{{ ManageMasterUserPassword }}', + '{{ Iops }}', + '{{ KmsKeyId }}', + '{{ LicenseModel }}', + '{{ MasterUsername }}', + '{{ MasterUserPassword }}', + '{{ MasterUserSecret }}', + '{{ MaxAllocatedStorage }}', + '{{ MonitoringInterval }}', + '{{ MonitoringRoleArn }}', + '{{ MultiAZ }}', + '{{ NcharCharacterSetName }}', + '{{ NetworkType }}', + '{{ OptionGroupName }}', + '{{ PerformanceInsightsKMSKeyId }}', + '{{ PerformanceInsightsRetentionPeriod }}', + '{{ Port }}', + '{{ PreferredBackupWindow }}', + '{{ PreferredMaintenanceWindow }}', + '{{ ProcessorFeatures }}', + '{{ PromotionTier }}', + '{{ PubliclyAccessible }}', + '{{ ReplicaMode }}', + '{{ RestoreTime }}', + '{{ SourceDBClusterIdentifier }}', + '{{ SourceDbiResourceId }}', + '{{ SourceDBInstanceAutomatedBackupsArn }}', + '{{ SourceDBInstanceIdentifier }}', + '{{ SourceRegion }}', + '{{ StorageEncrypted }}', + '{{ StorageType }}', + '{{ StorageThroughput }}', + '{{ Tags }}', + '{{ TdeCredentialArn }}', + '{{ TdeCredentialPassword }}', + '{{ Timezone }}', + '{{ UseDefaultProcessorFeatures }}', + '{{ UseLatestRestorableTime }}', + '{{ VPCSecurityGroups }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: db_instance + props: + - name: AllocatedStorage + value: '{{ AllocatedStorage }}' + - name: AllowMajorVersionUpgrade + value: '{{ AllowMajorVersionUpgrade }}' + - name: AssociatedRoles + value: + - FeatureName: '{{ FeatureName }}' + RoleArn: '{{ RoleArn }}' + - name: AutoMinorVersionUpgrade + value: '{{ AutoMinorVersionUpgrade }}' + - name: AutomaticBackupReplicationRegion + value: '{{ AutomaticBackupReplicationRegion }}' + - name: AutomaticBackupReplicationKmsKeyId + value: '{{ AutomaticBackupReplicationKmsKeyId }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: BackupRetentionPeriod + value: '{{ BackupRetentionPeriod }}' + - name: CACertificateIdentifier + value: '{{ CACertificateIdentifier }}' + - name: CertificateDetails + value: + CAIdentifier: '{{ CAIdentifier }}' + ValidTill: '{{ ValidTill }}' + - name: CertificateRotationRestart + value: '{{ CertificateRotationRestart }}' + - name: CharacterSetName + value: '{{ CharacterSetName }}' + - name: CopyTagsToSnapshot + value: '{{ CopyTagsToSnapshot }}' + - name: CustomIAMInstanceProfile + value: '{{ CustomIAMInstanceProfile }}' + - name: DBClusterIdentifier + value: '{{ DBClusterIdentifier }}' + - name: DBClusterSnapshotIdentifier + value: '{{ DBClusterSnapshotIdentifier }}' + - name: DBInstanceClass + value: '{{ DBInstanceClass }}' + - name: DBInstanceIdentifier + value: '{{ DBInstanceIdentifier }}' + - name: DBName + value: '{{ DBName }}' + - name: DBParameterGroupName + value: '{{ DBParameterGroupName }}' + - name: DBSecurityGroups + value: + - '{{ DBSecurityGroups[0] }}' + - name: DBSnapshotIdentifier + value: '{{ DBSnapshotIdentifier }}' + - name: DBSubnetGroupName + value: '{{ DBSubnetGroupName }}' + - name: DBSystemId + value: '{{ DBSystemId }}' + - name: DedicatedLogVolume + value: '{{ DedicatedLogVolume }}' + - name: DeleteAutomatedBackups + value: '{{ DeleteAutomatedBackups }}' + - name: DeletionProtection + value: '{{ DeletionProtection }}' + - name: Domain + value: '{{ Domain }}' + - name: DomainAuthSecretArn + value: '{{ DomainAuthSecretArn }}' + - name: DomainDnsIps + value: + - '{{ DomainDnsIps[0] }}' + - name: DomainFqdn + value: '{{ DomainFqdn }}' + - name: DomainIAMRoleName + value: '{{ DomainIAMRoleName }}' + - name: DomainOu + value: '{{ DomainOu }}' + - name: EnableCloudwatchLogsExports + value: + - '{{ EnableCloudwatchLogsExports[0] }}' + - name: EnableIAMDatabaseAuthentication + value: '{{ EnableIAMDatabaseAuthentication }}' + - name: EnablePerformanceInsights + value: '{{ EnablePerformanceInsights }}' + - name: Endpoint + value: + Address: '{{ Address }}' + Port: '{{ Port }}' + HostedZoneId: '{{ HostedZoneId }}' + - name: Engine + value: '{{ Engine }}' + - name: EngineLifecycleSupport + value: '{{ EngineLifecycleSupport }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: ManageMasterUserPassword + value: '{{ ManageMasterUserPassword }}' + - name: Iops + value: '{{ Iops }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: LicenseModel + value: '{{ LicenseModel }}' + - name: MasterUsername + value: '{{ MasterUsername }}' + - name: MasterUserPassword + value: '{{ MasterUserPassword }}' + - name: MasterUserSecret + value: + SecretArn: '{{ SecretArn }}' + KmsKeyId: '{{ KmsKeyId }}' + - name: MaxAllocatedStorage + value: '{{ MaxAllocatedStorage }}' + - name: MonitoringInterval + value: '{{ MonitoringInterval }}' + - name: MonitoringRoleArn + value: '{{ MonitoringRoleArn }}' + - name: MultiAZ + value: '{{ MultiAZ }}' + - name: NcharCharacterSetName + value: '{{ NcharCharacterSetName }}' + - name: NetworkType + value: '{{ NetworkType }}' + - name: OptionGroupName + value: '{{ OptionGroupName }}' + - name: PerformanceInsightsKMSKeyId + value: '{{ PerformanceInsightsKMSKeyId }}' + - name: PerformanceInsightsRetentionPeriod + value: '{{ PerformanceInsightsRetentionPeriod }}' + - name: Port + value: '{{ Port }}' + - name: PreferredBackupWindow + value: '{{ PreferredBackupWindow }}' + - name: PreferredMaintenanceWindow + value: '{{ PreferredMaintenanceWindow }}' + - name: ProcessorFeatures + value: + - Name: '{{ Name }}' + Value: '{{ Value }}' + - name: PromotionTier + value: '{{ PromotionTier }}' + - name: PubliclyAccessible + value: '{{ PubliclyAccessible }}' + - name: ReplicaMode + value: '{{ ReplicaMode }}' + - name: RestoreTime + value: '{{ RestoreTime }}' + - name: SourceDBClusterIdentifier + value: '{{ SourceDBClusterIdentifier }}' + - name: SourceDbiResourceId + value: '{{ SourceDbiResourceId }}' + - name: SourceDBInstanceAutomatedBackupsArn + value: '{{ SourceDBInstanceAutomatedBackupsArn }}' + - name: SourceDBInstanceIdentifier + value: '{{ SourceDBInstanceIdentifier }}' + - name: SourceRegion + value: '{{ SourceRegion }}' + - name: StorageEncrypted + value: '{{ StorageEncrypted }}' + - name: StorageType + value: '{{ StorageType }}' + - name: StorageThroughput + value: '{{ StorageThroughput }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TdeCredentialArn + value: '{{ TdeCredentialArn }}' + - name: TdeCredentialPassword + value: '{{ TdeCredentialPassword }}' + - name: Timezone + value: '{{ Timezone }}' + - name: UseDefaultProcessorFeatures + value: '{{ UseDefaultProcessorFeatures }}' + - name: UseLatestRestorableTime + value: '{{ UseLatestRestorableTime }}' + - name: VPCSecurityGroups + value: + - '{{ VPCSecurityGroups[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.db_instances +WHERE data__Identifier = '' +AND 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 +``` + +### 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:AddTagsToResource, +rds:CreateDBSnapshot, +rds:DeleteDBInstance, +rds:DescribeDBInstances +``` + +### List +```json +rds:DescribeDBInstances +``` diff --git a/website/docs/services/rds/db_instances_list_only/index.md b/website/docs/services/rds/db_instances_list_only/index.md new file mode 100644 index 0000000..a127645 --- /dev/null +++ b/website/docs/services/rds/db_instances_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: db_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_instances_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_instances in a region or regions, for all properties use db_instances + +## Overview + + + + + + + +
Namedb_instances_list_only
TypeResource
DescriptionThe AWS::RDS::DBInstance resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.
For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.
For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
*Updating DB instances*
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
1. Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html).
1. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use.
After you restore a DB instance with a DBSnapshotIdentifier property, you can delete the DBSnapshotIdentifier property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
1. Update the stack.

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

For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_instances in a region. +```sql +SELECT +region, +db_instance_identifier +FROM aws.rds.db_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_instances_list_only resource, see db_instances + diff --git a/website/docs/services/rds/db_parameter_group_tags/index.md b/website/docs/services/rds/db_parameter_group_tags/index.md new file mode 100644 index 0000000..482778e --- /dev/null +++ b/website/docs/services/rds/db_parameter_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: db_parameter_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_parameter_group_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_parameter_groups in a region + +## Overview + + + + + + + +
Namedb_parameter_group_tags
TypeResource
DescriptionThe AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.
This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.
For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the DB parameter group.
Constraints:
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group.
This value is stored as a lowercase string.
stringProvides the customer-specified description for this DB parameter group.
stringThe DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
+ aurora-mysql
+ aurora-postgresql
+ db2-ae
+ db2-se
+ mysql
+ oracle-ee
+ oracle-ee-cdb
+ oracle-se2
+ oracle-se2-cdb
+ postgres
+ sqlserver-ee
+ sqlserver-se
+ sqlserver-ex
+ sqlserver-web
objectAn array of parameter names and values for the parameter update. You must specify at least one parameter name and value.
For more information about parameter groups, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*, or [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_parameter_groups in a region. +```sql +SELECT +region, +db_parameter_group_name, +description, +family, +parameters, +tag_key, +tag_value +FROM aws.rds.db_parameter_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_parameter_group_tags resource, see db_parameter_groups + diff --git a/website/docs/services/rds/db_parameter_groups/index.md b/website/docs/services/rds/db_parameter_groups/index.md new file mode 100644 index 0000000..ce97512 --- /dev/null +++ b/website/docs/services/rds/db_parameter_groups/index.md @@ -0,0 +1,244 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a db_parameter_group resource or lists 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.
This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.
For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the DB parameter group.
Constraints:
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group.
This value is stored as a lowercase string.
stringProvides the customer-specified description for this DB parameter group.
stringThe DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
+ aurora-mysql
+ aurora-postgresql
+ db2-ae
+ db2-se
+ mysql
+ oracle-ee
+ oracle-ee-cdb
+ oracle-se2
+ oracle-se2-cdb
+ postgres
+ sqlserver-ee
+ sqlserver-se
+ sqlserver-ex
+ sqlserver-web
objectAn array of parameter names and values for the parameter update. You must specify at least one parameter name and value.
For more information about parameter groups, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*, or [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
arrayTags to assign to the DB parameter group.
stringAWS region.
+ +For more information, see AWS::RDS::DBParameterGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all db_parameter_groups in a region. +```sql +SELECT +region, +db_parameter_group_name, +description, +family, +parameters, +tags +FROM aws.rds.db_parameter_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual db_parameter_group. +```sql +SELECT +region, +db_parameter_group_name, +description, +family, +parameters, +tags +FROM aws.rds.db_parameter_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new db_parameter_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_parameter_groups ( + Description, + Family, + region +) +SELECT +'{{ Description }}', + '{{ Family }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_parameter_groups ( + DBParameterGroupName, + Description, + Family, + Parameters, + Tags, + region +) +SELECT + '{{ DBParameterGroupName }}', + '{{ Description }}', + '{{ Family }}', + '{{ Parameters }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: db_parameter_group + props: + - name: DBParameterGroupName + value: '{{ DBParameterGroupName }}' + - name: Description + value: '{{ Description }}' + - name: Family + value: '{{ Family }}' + - name: Parameters + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.db_parameter_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +rds:DescribeDBParameterGroups +``` diff --git a/website/docs/services/rds/db_parameter_groups_list_only/index.md b/website/docs/services/rds/db_parameter_groups_list_only/index.md new file mode 100644 index 0000000..7971fb6 --- /dev/null +++ b/website/docs/services/rds/db_parameter_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: db_parameter_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_parameter_groups_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_parameter_groups in a region or regions, for all properties use db_parameter_groups + +## Overview + + + + + + + +
Namedb_parameter_groups_list_only
TypeResource
DescriptionThe AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.
This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.
For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the DB parameter group.
Constraints:
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group.
This value is stored as a lowercase string.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_parameter_groups in a region. +```sql +SELECT +region, +db_parameter_group_name +FROM aws.rds.db_parameter_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_parameter_groups_list_only resource, see db_parameter_groups + diff --git a/website/docs/services/rds/db_proxies/index.md b/website/docs/services/rds/db_proxies/index.md new file mode 100644 index 0000000..9d61517 --- /dev/null +++ b/website/docs/services/rds/db_proxies/index.md @@ -0,0 +1,289 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a db_proxy resource or lists db_proxies in a region + +## Overview + + + + + + + +
Namedb_proxies
TypeResource
DescriptionResource schema for AWS::RDS::DBProxy
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe authorization mechanism that the proxy uses.
stringThe Amazon Resource Name (ARN) for the proxy.
stringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
booleanWhether the proxy includes detailed information about SQL statements in its logs.
stringThe endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
stringThe kinds of databases that the proxy can connect to.
integerThe number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
booleanA Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
stringThe Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
arrayAn optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
stringVPC ID to associate with the new DB proxy.
arrayVPC security group IDs to associate with the new proxy.
arrayVPC subnet IDs to associate with the new proxy.
stringAWS region.
+ +For more information, see AWS::RDS::DBProxy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all db_proxies in a region. +```sql +SELECT +region, +auth, +db_proxy_arn, +db_proxy_name, +debug_logging, +endpoint, +engine_family, +idle_client_timeout, +require_tls, +role_arn, +tags, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids +FROM aws.rds.db_proxies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual db_proxy. +```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_proxies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new db_proxy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_proxies ( + Auth, + DBProxyName, + EngineFamily, + RoleArn, + VpcSubnetIds, + region +) +SELECT +'{{ Auth }}', + '{{ DBProxyName }}', + '{{ EngineFamily }}', + '{{ RoleArn }}', + '{{ VpcSubnetIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_proxies ( + Auth, + DBProxyName, + DebugLogging, + EngineFamily, + IdleClientTimeout, + RequireTLS, + RoleArn, + Tags, + VpcSecurityGroupIds, + VpcSubnetIds, + region +) +SELECT + '{{ Auth }}', + '{{ DBProxyName }}', + '{{ DebugLogging }}', + '{{ EngineFamily }}', + '{{ IdleClientTimeout }}', + '{{ RequireTLS }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ VpcSecurityGroupIds }}', + '{{ VpcSubnetIds }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: db_proxy + props: + - name: Auth + value: + - AuthScheme: '{{ AuthScheme }}' + Description: '{{ Description }}' + IAMAuth: '{{ IAMAuth }}' + SecretArn: '{{ SecretArn }}' + ClientPasswordAuthType: '{{ ClientPasswordAuthType }}' + - name: DBProxyName + value: '{{ DBProxyName }}' + - name: DebugLogging + value: '{{ DebugLogging }}' + - name: EngineFamily + value: '{{ EngineFamily }}' + - name: IdleClientTimeout + value: '{{ IdleClientTimeout }}' + - name: RequireTLS + value: '{{ RequireTLS }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VpcSecurityGroupIds + value: + - '{{ VpcSecurityGroupIds[0] }}' + - name: VpcSubnetIds + value: + - '{{ VpcSubnetIds[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.db_proxies +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +rds:DescribeDBProxies +``` + +### Update +```json +rds:ModifyDBProxy, +rds:AddTagsToResource, +rds:RemoveTagsFromResource, +iam:PassRole +``` + +### Delete +```json +rds:DescribeDBProxies, +rds:DeleteDBProxy +``` + +### List +```json +rds:DescribeDBProxies +``` diff --git a/website/docs/services/rds/db_proxies_list_only/index.md b/website/docs/services/rds/db_proxies_list_only/index.md new file mode 100644 index 0000000..c4dc8f8 --- /dev/null +++ b/website/docs/services/rds/db_proxies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: db_proxies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxies_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_proxies in a region or regions, for all properties use db_proxies + +## Overview + + + + + + + +
Namedb_proxies_list_only
TypeResource
DescriptionResource schema for AWS::RDS::DBProxy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_proxies in a region. +```sql +SELECT +region, +db_proxy_name +FROM aws.rds.db_proxies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_proxies_list_only resource, see db_proxies + diff --git a/website/docs/services/rds/db_proxy_endpoint_tags/index.md b/website/docs/services/rds/db_proxy_endpoint_tags/index.md new file mode 100644 index 0000000..f22a4e9 --- /dev/null +++ b/website/docs/services/rds/db_proxy_endpoint_tags/index.md @@ -0,0 +1,93 @@ +--- +title: db_proxy_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_endpoint_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_proxy_endpoints in a region + +## Overview + + + + + + + +
Namedb_proxy_endpoint_tags
TypeResource
DescriptionResource schema for AWS::RDS::DBProxyEndpoint.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
stringThe Amazon Resource Name (ARN) for the DB proxy endpoint.
stringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
stringVPC ID to associate with the new DB proxy endpoint.
arrayVPC security group IDs to associate with the new DB proxy endpoint.
arrayVPC subnet IDs to associate with the new DB proxy endpoint.
stringThe endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
stringA value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
booleanA value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_proxy_endpoints in a region. +```sql +SELECT +region, +db_proxy_endpoint_name, +db_proxy_endpoint_arn, +db_proxy_name, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids, +endpoint, +target_role, +is_default, +tag_key, +tag_value +FROM aws.rds.db_proxy_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_proxy_endpoint_tags resource, see db_proxy_endpoints + diff --git a/website/docs/services/rds/db_proxy_endpoints/index.md b/website/docs/services/rds/db_proxy_endpoints/index.md new file mode 100644 index 0000000..676e08e --- /dev/null +++ b/website/docs/services/rds/db_proxy_endpoints/index.md @@ -0,0 +1,254 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a db_proxy_endpoint resource or lists db_proxy_endpoints in a region + +## Overview + + + + + + + +
Namedb_proxy_endpoints
TypeResource
DescriptionResource schema for AWS::RDS::DBProxyEndpoint.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
stringThe Amazon Resource Name (ARN) for the DB proxy endpoint.
stringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
stringVPC ID to associate with the new DB proxy endpoint.
arrayVPC security group IDs to associate with the new DB proxy endpoint.
arrayVPC subnet IDs to associate with the new DB proxy endpoint.
stringThe endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
stringA value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
booleanA value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
arrayAn optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
stringAWS region.
+ +For more information, see AWS::RDS::DBProxyEndpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all db_proxy_endpoints in a region. +```sql +SELECT +region, +db_proxy_endpoint_name, +db_proxy_endpoint_arn, +db_proxy_name, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids, +endpoint, +target_role, +is_default, +tags +FROM aws.rds.db_proxy_endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual db_proxy_endpoint. +```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_endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new db_proxy_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_proxy_endpoints ( + DBProxyEndpointName, + DBProxyName, + VpcSubnetIds, + region +) +SELECT +'{{ DBProxyEndpointName }}', + '{{ DBProxyName }}', + '{{ VpcSubnetIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_proxy_endpoints ( + DBProxyEndpointName, + DBProxyName, + VpcSecurityGroupIds, + VpcSubnetIds, + TargetRole, + Tags, + region +) +SELECT + '{{ DBProxyEndpointName }}', + '{{ DBProxyName }}', + '{{ VpcSecurityGroupIds }}', + '{{ VpcSubnetIds }}', + '{{ TargetRole }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: db_proxy_endpoint + props: + - name: DBProxyEndpointName + value: '{{ DBProxyEndpointName }}' + - name: DBProxyName + value: '{{ DBProxyName }}' + - name: VpcSecurityGroupIds + value: + - '{{ VpcSecurityGroupIds[0] }}' + - name: VpcSubnetIds + value: + - '{{ VpcSubnetIds[0] }}' + - name: TargetRole + value: '{{ TargetRole }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.db_proxy_endpoints +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the db_proxy_endpoints resource, the following permissions are required: + +### Create +```json +rds:CreateDBProxyEndpoint, +rds:DescribeDBProxyEndpoints +``` + +### Read +```json +rds:DescribeDBProxyEndpoints, +rds:ListTagsForResource +``` + +### Update +```json +rds:ModifyDBProxyEndpoint, +rds:AddTagsToResource, +rds:RemoveTagsFromResource +``` + +### Delete +```json +rds:DescribeDBProxyEndpoints, +rds:DeleteDBProxyEndpoint +``` + +### List +```json +rds:DescribeDBProxyEndpoints +``` diff --git a/website/docs/services/rds/db_proxy_endpoints_list_only/index.md b/website/docs/services/rds/db_proxy_endpoints_list_only/index.md new file mode 100644 index 0000000..c57da0b --- /dev/null +++ b/website/docs/services/rds/db_proxy_endpoints_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: db_proxy_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_endpoints_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_proxy_endpoints in a region or regions, for all properties use db_proxy_endpoints + +## Overview + + + + + + + +
Namedb_proxy_endpoints_list_only
TypeResource
DescriptionResource schema for AWS::RDS::DBProxyEndpoint.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
stringThe 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.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_proxy_endpoints in a region. +```sql +SELECT +region, +db_proxy_endpoint_name +FROM aws.rds.db_proxy_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_proxy_endpoints_list_only resource, see db_proxy_endpoints + diff --git a/website/docs/services/rds/db_proxy_tags/index.md b/website/docs/services/rds/db_proxy_tags/index.md new file mode 100644 index 0000000..29a4755 --- /dev/null +++ b/website/docs/services/rds/db_proxy_tags/index.md @@ -0,0 +1,99 @@ +--- +title: db_proxy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_proxies in a region + +## Overview + + + + + + + +
Namedb_proxy_tags
TypeResource
DescriptionResource schema for AWS::RDS::DBProxy
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe authorization mechanism that the proxy uses.
stringThe Amazon Resource Name (ARN) for the proxy.
stringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
booleanWhether the proxy includes detailed information about SQL statements in its logs.
stringThe endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
stringThe kinds of databases that the proxy can connect to.
integerThe number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
booleanA Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
stringThe Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
stringVPC ID to associate with the new DB proxy.
arrayVPC security group IDs to associate with the new proxy.
arrayVPC subnet IDs to associate with the new proxy.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_proxies in a region. +```sql +SELECT +region, +auth, +db_proxy_arn, +db_proxy_name, +debug_logging, +endpoint, +engine_family, +idle_client_timeout, +require_tls, +role_arn, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids, +tag_key, +tag_value +FROM aws.rds.db_proxy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_proxy_tags resource, see db_proxies + diff --git a/website/docs/services/rds/db_proxy_target_groups/index.md b/website/docs/services/rds/db_proxy_target_groups/index.md new file mode 100644 index 0000000..885a202 --- /dev/null +++ b/website/docs/services/rds/db_proxy_target_groups/index.md @@ -0,0 +1,242 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a db_proxy_target_group resource or lists db_proxy_target_groups in a region + +## Overview + + + + + + + +
Namedb_proxy_target_groups
TypeResource
DescriptionResource schema for AWS::RDS::DBProxyTargetGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the proxy.
stringThe Amazon Resource Name (ARN) representing the target group.
stringThe identifier for the DBProxyTargetGroup
object
array
array
stringAWS region.
+ +For more information, see AWS::RDS::DBProxyTargetGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all db_proxy_target_groups in a region. +```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_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual db_proxy_target_group. +```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_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new db_proxy_target_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_proxy_target_groups ( + DBProxyName, + TargetGroupName, + region +) +SELECT +'{{ DBProxyName }}', + '{{ TargetGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_proxy_target_groups ( + DBProxyName, + TargetGroupName, + ConnectionPoolConfigurationInfo, + DBInstanceIdentifiers, + DBClusterIdentifiers, + region +) +SELECT + '{{ DBProxyName }}', + '{{ TargetGroupName }}', + '{{ ConnectionPoolConfigurationInfo }}', + '{{ DBInstanceIdentifiers }}', + '{{ DBClusterIdentifiers }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: db_proxy_target_group + props: + - name: DBProxyName + value: '{{ DBProxyName }}' + - name: TargetGroupName + value: '{{ TargetGroupName }}' + - name: ConnectionPoolConfigurationInfo + value: + MaxConnectionsPercent: '{{ MaxConnectionsPercent }}' + MaxIdleConnectionsPercent: '{{ MaxIdleConnectionsPercent }}' + ConnectionBorrowTimeout: '{{ ConnectionBorrowTimeout }}' + SessionPinningFilters: + - '{{ SessionPinningFilters[0] }}' + InitQuery: '{{ InitQuery }}' + - name: DBInstanceIdentifiers + value: + - '{{ DBInstanceIdentifiers[0] }}' + - name: DBClusterIdentifiers + value: + - '{{ DBClusterIdentifiers[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.db_proxy_target_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +rds:DescribeDBProxyTargetGroups, +rds:DescribeDBProxyTargets +``` + +### Update +```json +rds:DescribeDBProxyTargetGroups, +rds:ModifyDBProxyTargetGroup, +rds:RegisterDBProxyTargets, +rds:DeregisterDBProxyTargets +``` + +### Delete +```json +rds:DeregisterDBProxyTargets +``` + +### List +```json +rds:DescribeDBProxyTargetGroups +``` diff --git a/website/docs/services/rds/db_proxy_target_groups_list_only/index.md b/website/docs/services/rds/db_proxy_target_groups_list_only/index.md new file mode 100644 index 0000000..3fc81f7 --- /dev/null +++ b/website/docs/services/rds/db_proxy_target_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: db_proxy_target_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_target_groups_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_proxy_target_groups in a region or regions, for all properties use db_proxy_target_groups + +## Overview + + + + + + + +
Namedb_proxy_target_groups_list_only
TypeResource
DescriptionResource schema for AWS::RDS::DBProxyTargetGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) representing the target group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_proxy_target_groups in a region. +```sql +SELECT +region, +target_group_arn +FROM aws.rds.db_proxy_target_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_proxy_target_groups_list_only resource, see db_proxy_target_groups + diff --git a/website/docs/services/rds/db_shard_group_tags/index.md b/website/docs/services/rds/db_shard_group_tags/index.md new file mode 100644 index 0000000..beb8187 --- /dev/null +++ b/website/docs/services/rds/db_shard_group_tags/index.md @@ -0,0 +1,91 @@ +--- +title: db_shard_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_shard_group_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_shard_groups in a region + +## Overview + + + + + + + +
Namedb_shard_group_tags
TypeResource
DescriptionThe AWS::RDS::DBShardGroup resource creates an Amazon Aurora Limitless DB Shard Group.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Web Services Region-unique, immutable identifier for the DB shard group.
stringThe name of the DB shard group.
stringThe name of the primary DB cluster for the DB shard group.
integerSpecifies whether to create standby instances for the DB shard group.
numberThe maximum capacity of the DB shard group in Aurora capacity units (ACUs).
numberThe minimum capacity of the DB shard group in Aurora capacity units (ACUs).
booleanIndicates whether the DB shard group is publicly accessible.
stringThe connection endpoint for the DB shard group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_shard_groups in a region. +```sql +SELECT +region, +db_shard_group_resource_id, +db_shard_group_identifier, +db_cluster_identifier, +compute_redundancy, +max_ac_u, +min_ac_u, +publicly_accessible, +endpoint, +tag_key, +tag_value +FROM aws.rds.db_shard_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_shard_group_tags resource, see db_shard_groups + diff --git a/website/docs/services/rds/db_shard_groups/index.md b/website/docs/services/rds/db_shard_groups/index.md new file mode 100644 index 0000000..a0492e2 --- /dev/null +++ b/website/docs/services/rds/db_shard_groups/index.md @@ -0,0 +1,259 @@ +--- +title: db_shard_groups +hide_title: false +hide_table_of_contents: false +keywords: + - db_shard_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a db_shard_group resource or lists db_shard_groups in a region + +## Overview + + + + + + + +
Namedb_shard_groups
TypeResource
DescriptionThe AWS::RDS::DBShardGroup resource creates an Amazon Aurora Limitless DB Shard Group.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Web Services Region-unique, immutable identifier for the DB shard group.
stringThe name of the DB shard group.
stringThe name of the primary DB cluster for the DB shard group.
integerSpecifies whether to create standby instances for the DB shard group.
numberThe maximum capacity of the DB shard group in Aurora capacity units (ACUs).
numberThe minimum capacity of the DB shard group in Aurora capacity units (ACUs).
booleanIndicates whether the DB shard group is publicly accessible.
stringThe connection endpoint for the DB shard group.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::RDS::DBShardGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all db_shard_groups in a region. +```sql +SELECT +region, +db_shard_group_resource_id, +db_shard_group_identifier, +db_cluster_identifier, +compute_redundancy, +max_ac_u, +min_ac_u, +publicly_accessible, +endpoint, +tags +FROM aws.rds.db_shard_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual db_shard_group. +```sql +SELECT +region, +db_shard_group_resource_id, +db_shard_group_identifier, +db_cluster_identifier, +compute_redundancy, +max_ac_u, +min_ac_u, +publicly_accessible, +endpoint, +tags +FROM aws.rds.db_shard_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new db_shard_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_shard_groups ( + DBClusterIdentifier, + MaxACU, + region +) +SELECT +'{{ DBClusterIdentifier }}', + '{{ MaxACU }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_shard_groups ( + DBShardGroupIdentifier, + DBClusterIdentifier, + ComputeRedundancy, + MaxACU, + MinACU, + PubliclyAccessible, + Tags, + region +) +SELECT + '{{ DBShardGroupIdentifier }}', + '{{ DBClusterIdentifier }}', + '{{ ComputeRedundancy }}', + '{{ MaxACU }}', + '{{ MinACU }}', + '{{ PubliclyAccessible }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: db_shard_group + props: + - name: DBShardGroupIdentifier + value: '{{ DBShardGroupIdentifier }}' + - name: DBClusterIdentifier + value: '{{ DBClusterIdentifier }}' + - name: ComputeRedundancy + value: '{{ ComputeRedundancy }}' + - name: MaxACU + value: null + - name: MinACU + value: null + - name: PubliclyAccessible + value: '{{ PubliclyAccessible }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.db_shard_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the db_shard_groups resource, the following permissions are required: + +### Create +```json +rds:AddTagsToResource, +rds:CreateDBShardGroup, +rds:DescribeDBClusters, +rds:DescribeDBShardGroups, +rds:ListTagsForResource +``` + +### Read +```json +rds:DescribeDBShardGroups, +rds:ListTagsForResource +``` + +### Update +```json +rds:AddTagsToResource, +rds:DescribeDBShardGroups, +rds:DescribeDBClusters, +rds:RemoveTagsFromResource, +rds:ModifyDBShardGroup, +rds:ListTagsForResource +``` + +### Delete +```json +rds:DeleteDBShardGroup, +rds:DescribeDBClusters, +rds:DescribeDbShardGroups +``` + +### List +```json +rds:DescribeDBShardGroups, +rds:ListTagsForResource +``` diff --git a/website/docs/services/rds/db_shard_groups_list_only/index.md b/website/docs/services/rds/db_shard_groups_list_only/index.md new file mode 100644 index 0000000..07cf789 --- /dev/null +++ b/website/docs/services/rds/db_shard_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: db_shard_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_shard_groups_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_shard_groups in a region or regions, for all properties use db_shard_groups + +## Overview + + + + + + + +
Namedb_shard_groups_list_only
TypeResource
DescriptionThe AWS::RDS::DBShardGroup resource creates an Amazon Aurora Limitless DB Shard Group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the DB shard group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_shard_groups in a region. +```sql +SELECT +region, +db_shard_group_identifier +FROM aws.rds.db_shard_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_shard_groups_list_only resource, see db_shard_groups + diff --git a/website/docs/services/rds/db_subnet_group_tags/index.md b/website/docs/services/rds/db_subnet_group_tags/index.md new file mode 100644 index 0000000..a2b2aae --- /dev/null +++ b/website/docs/services/rds/db_subnet_group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: db_subnet_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_subnet_group_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_subnet_groups in a region + +## Overview + + + + + + + +
Namedb_subnet_group_tags
TypeResource
DescriptionThe AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe description for the DB subnet group.
stringThe name for the DB subnet group. This value is stored as a lowercase string.
Constraints:
+ Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
+ Must not be default.
+ First character must be a letter.

Example: mydbsubnetgroup
arrayThe EC2 Subnet IDs for the DB subnet group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_subnet_groups in a region. +```sql +SELECT +region, +db_subnet_group_description, +db_subnet_group_name, +subnet_ids, +tag_key, +tag_value +FROM aws.rds.db_subnet_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_subnet_group_tags resource, see db_subnet_groups + diff --git a/website/docs/services/rds/db_subnet_groups/index.md b/website/docs/services/rds/db_subnet_groups/index.md new file mode 100644 index 0000000..8532b60 --- /dev/null +++ b/website/docs/services/rds/db_subnet_groups/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a db_subnet_group resource or lists 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.
For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe description for the DB subnet group.
stringThe name for the DB subnet group. This value is stored as a lowercase string.
Constraints:
+ Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
+ Must not be default.
+ First character must be a letter.

Example: mydbsubnetgroup
arrayThe EC2 Subnet IDs for the DB subnet group.
arrayTags to assign to the DB subnet group.
stringAWS region.
+ +For more information, see AWS::RDS::DBSubnetGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all db_subnet_groups in a region. +```sql +SELECT +region, +db_subnet_group_description, +db_subnet_group_name, +subnet_ids, +tags +FROM aws.rds.db_subnet_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual db_subnet_group. +```sql +SELECT +region, +db_subnet_group_description, +db_subnet_group_name, +subnet_ids, +tags +FROM aws.rds.db_subnet_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new db_subnet_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_subnet_groups ( + DBSubnetGroupDescription, + SubnetIds, + region +) +SELECT +'{{ DBSubnetGroupDescription }}', + '{{ SubnetIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.db_subnet_groups ( + DBSubnetGroupDescription, + DBSubnetGroupName, + SubnetIds, + Tags, + region +) +SELECT + '{{ DBSubnetGroupDescription }}', + '{{ DBSubnetGroupName }}', + '{{ SubnetIds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: db_subnet_group + props: + - name: DBSubnetGroupDescription + value: '{{ DBSubnetGroupDescription }}' + - name: DBSubnetGroupName + value: '{{ DBSubnetGroupName }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.db_subnet_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +rds:DescribeDBSubnetGroups +``` diff --git a/website/docs/services/rds/db_subnet_groups_list_only/index.md b/website/docs/services/rds/db_subnet_groups_list_only/index.md new file mode 100644 index 0000000..3bf134e --- /dev/null +++ b/website/docs/services/rds/db_subnet_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: db_subnet_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_subnet_groups_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_subnet_groups in a region or regions, for all properties use db_subnet_groups + +## Overview + + + + + + + +
Namedb_subnet_groups_list_only
TypeResource
DescriptionThe AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name for the DB subnet group. This value is stored as a lowercase string.
Constraints:
+ Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
+ Must not be default.
+ First character must be a letter.

Example: mydbsubnetgroup
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_subnet_groups in a region. +```sql +SELECT +region, +db_subnet_group_name +FROM aws.rds.db_subnet_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_subnet_groups_list_only resource, see db_subnet_groups + diff --git a/website/docs/services/rds/event_subscription_tags/index.md b/website/docs/services/rds/event_subscription_tags/index.md new file mode 100644 index 0000000..a145be0 --- /dev/null +++ b/website/docs/services/rds/event_subscription_tags/index.md @@ -0,0 +1,87 @@ +--- +title: event_subscription_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscription_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_subscriptions in a region + +## Overview + + + + + + + +
Nameevent_subscription_tags
TypeResource
DescriptionThe AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see [Using Amazon RDS Event Notification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide*.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the subscription.
Constraints: The name must be less than 255 characters.
booleanSpecifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
arrayA list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). You can also see this list by using the DescribeEventCategories operation.
stringThe Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.
RDS doesn't support FIFO (first in, first out) topics. For more information, see [Message ordering and deduplication (FIFO topics)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide*.
arrayThe list of identifiers of the event sources for which events are 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 can't end with a hyphen or contain two consecutive hyphens.
Constraints:
+ If SourceIds are supplied, SourceType must also be provided.
+ If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
+ If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
+ If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
+ If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
+ If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
+ If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
+ If the source type is an RDS Proxy, a DBProxyName value must be supplied.
stringThe type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid Values:db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_subscriptions in a region. +```sql +SELECT +region, +subscription_name, +enabled, +event_categories, +sns_topic_arn, +source_ids, +source_type, +tag_key, +tag_value +FROM aws.rds.event_subscription_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_subscription_tags resource, see event_subscriptions + diff --git a/website/docs/services/rds/event_subscriptions/index.md b/website/docs/services/rds/event_subscriptions/index.md new file mode 100644 index 0000000..31ba3f2 --- /dev/null +++ b/website/docs/services/rds/event_subscriptions/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_subscription resource or lists 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide*.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arrayAn optional array of key-value pairs to apply to this subscription.
stringThe name of the subscription.
Constraints: The name must be less than 255 characters.
booleanSpecifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
arrayA list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). You can also see this list by using the DescribeEventCategories operation.
stringThe Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.
RDS doesn't support FIFO (first in, first out) topics. For more information, see [Message ordering and deduplication (FIFO topics)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide*.
arrayThe list of identifiers of the event sources for which events are 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 can't end with a hyphen or contain two consecutive hyphens.
Constraints:
+ If SourceIds are supplied, SourceType must also be provided.
+ If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
+ If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
+ If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
+ If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
+ If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
+ If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
+ If the source type is an RDS Proxy, a DBProxyName value must be supplied.
stringThe type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid Values:db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
stringAWS region.
+ +For more information, see AWS::RDS::EventSubscription. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_subscriptions in a region. +```sql +SELECT +region, +tags, +subscription_name, +enabled, +event_categories, +sns_topic_arn, +source_ids, +source_type +FROM aws.rds.event_subscriptions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_subscription. +```sql +SELECT +region, +tags, +subscription_name, +enabled, +event_categories, +sns_topic_arn, +source_ids, +source_type +FROM aws.rds.event_subscriptions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.event_subscriptions ( + SnsTopicArn, + region +) +SELECT +'{{ SnsTopicArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.event_subscriptions ( + Tags, + SubscriptionName, + Enabled, + EventCategories, + SnsTopicArn, + SourceIds, + SourceType, + region +) +SELECT + '{{ Tags }}', + '{{ SubscriptionName }}', + '{{ Enabled }}', + '{{ EventCategories }}', + '{{ SnsTopicArn }}', + '{{ SourceIds }}', + '{{ SourceType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_subscription + props: + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: SubscriptionName + value: '{{ SubscriptionName }}' + - name: Enabled + value: '{{ Enabled }}' + - name: EventCategories + value: + - '{{ EventCategories[0] }}' + - name: SnsTopicArn + value: '{{ SnsTopicArn }}' + - name: SourceIds + value: + - '{{ SourceIds[0] }}' + - name: SourceType + value: '{{ SourceType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.event_subscriptions +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +rds:DescribeEventSubscriptions +``` diff --git a/website/docs/services/rds/event_subscriptions_list_only/index.md b/website/docs/services/rds/event_subscriptions_list_only/index.md new file mode 100644 index 0000000..3bf0518 --- /dev/null +++ b/website/docs/services/rds/event_subscriptions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: event_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscriptions_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_subscriptions in a region or regions, for all properties use event_subscriptions + +## Overview + + + + + + + +
Nameevent_subscriptions_list_only
TypeResource
DescriptionThe AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see [Using Amazon RDS Event Notification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the subscription.
Constraints: The name must be less than 255 characters.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_subscriptions in a region. +```sql +SELECT +region, +subscription_name +FROM aws.rds.event_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_subscriptions_list_only resource, see event_subscriptions + diff --git a/website/docs/services/rds/global_cluster_tags/index.md b/website/docs/services/rds/global_cluster_tags/index.md new file mode 100644 index 0000000..16e680f --- /dev/null +++ b/website/docs/services/rds/global_cluster_tags/index.md @@ -0,0 +1,91 @@ +--- +title: global_cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - global_cluster_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for global_clusters in a region + +## Overview + + + + + + + +
Nameglobal_cluster_tags
TypeResource
DescriptionResource Type definition for AWS::RDS::GlobalCluster
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora).
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
stringThe life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
stringThe version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
booleanThe deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
stringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
stringThe Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string.
booleanThe storage encryption setting for the new global database cluster.
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all global_clusters in a region. +```sql +SELECT +region, +engine, +engine_lifecycle_support, +engine_version, +deletion_protection, +global_cluster_identifier, +source_db_cluster_identifier, +storage_encrypted, +global_endpoint, +tag_key, +tag_value +FROM aws.rds.global_cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_cluster_tags resource, see global_clusters + diff --git a/website/docs/services/rds/global_clusters/index.md b/website/docs/services/rds/global_clusters/index.md new file mode 100644 index 0000000..23a92ce --- /dev/null +++ b/website/docs/services/rds/global_clusters/index.md @@ -0,0 +1,277 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a global_cluster resource or lists global_clusters in a region + +## Overview + + + + + + + +
Nameglobal_clusters
TypeResource
DescriptionResource Type definition for AWS::RDS::GlobalCluster
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora).
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
arrayAn array of key-value pairs to apply to this resource.
stringThe life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
stringThe version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
booleanThe deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
stringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
stringThe Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string.
booleanThe storage encryption setting for the new global database cluster.
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
object
stringAWS region.
+ +For more information, see AWS::RDS::GlobalCluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all global_clusters in a region. +```sql +SELECT +region, +engine, +tags, +engine_lifecycle_support, +engine_version, +deletion_protection, +global_cluster_identifier, +source_db_cluster_identifier, +storage_encrypted, +global_endpoint +FROM aws.rds.global_clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual global_cluster. +```sql +SELECT +region, +engine, +tags, +engine_lifecycle_support, +engine_version, +deletion_protection, +global_cluster_identifier, +source_db_cluster_identifier, +storage_encrypted, +global_endpoint +FROM aws.rds.global_clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new global_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.global_clusters ( + Engine, + Tags, + EngineLifecycleSupport, + EngineVersion, + DeletionProtection, + GlobalClusterIdentifier, + SourceDBClusterIdentifier, + StorageEncrypted, + GlobalEndpoint, + region +) +SELECT +'{{ Engine }}', + '{{ Tags }}', + '{{ EngineLifecycleSupport }}', + '{{ EngineVersion }}', + '{{ DeletionProtection }}', + '{{ GlobalClusterIdentifier }}', + '{{ SourceDBClusterIdentifier }}', + '{{ StorageEncrypted }}', + '{{ GlobalEndpoint }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.global_clusters ( + Engine, + Tags, + EngineLifecycleSupport, + EngineVersion, + DeletionProtection, + GlobalClusterIdentifier, + SourceDBClusterIdentifier, + StorageEncrypted, + GlobalEndpoint, + region +) +SELECT + '{{ Engine }}', + '{{ Tags }}', + '{{ EngineLifecycleSupport }}', + '{{ EngineVersion }}', + '{{ DeletionProtection }}', + '{{ GlobalClusterIdentifier }}', + '{{ SourceDBClusterIdentifier }}', + '{{ StorageEncrypted }}', + '{{ GlobalEndpoint }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: global_cluster + props: + - name: Engine + value: '{{ Engine }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: EngineLifecycleSupport + value: '{{ EngineLifecycleSupport }}' + - name: EngineVersion + value: '{{ EngineVersion }}' + - name: DeletionProtection + value: '{{ DeletionProtection }}' + - name: GlobalClusterIdentifier + value: '{{ GlobalClusterIdentifier }}' + - name: SourceDBClusterIdentifier + value: '{{ SourceDBClusterIdentifier }}' + - name: StorageEncrypted + value: '{{ StorageEncrypted }}' + - name: GlobalEndpoint + value: + Address: '{{ Address }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.global_clusters +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +rds:DescribeGlobalClusters +``` + +### Update +```json +rds:ModifyGlobalCluster, +rds:DescribeGlobalClusters, +rds:AddTagsToResource, +rds:RemoveTagsFromResource +``` + +### Delete +```json +rds:DescribeGlobalClusters, +rds:DeleteGlobalCluster, +rds:RemoveFromGlobalCluster, +rds:DescribeDBClusters +``` + +### List +```json +rds:DescribeGlobalClusters +``` diff --git a/website/docs/services/rds/global_clusters_list_only/index.md b/website/docs/services/rds/global_clusters_list_only/index.md new file mode 100644 index 0000000..2ffdcc1 --- /dev/null +++ b/website/docs/services/rds/global_clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: global_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - global_clusters_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists global_clusters in a region or regions, for all properties use global_clusters + +## Overview + + + + + + + +
Nameglobal_clusters_list_only
TypeResource
DescriptionResource Type definition for AWS::RDS::GlobalCluster
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all global_clusters in a region. +```sql +SELECT +region, +global_cluster_identifier +FROM aws.rds.global_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_clusters_list_only resource, see global_clusters + diff --git a/website/docs/services/rds/index.md b/website/docs/services/rds/index.md new file mode 100644 index 0000000..77e70e4 --- /dev/null +++ b/website/docs/services/rds/index.md @@ -0,0 +1,76 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The rds service documentation. + +:::info Service Summary + +
+
+total resources: 41
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/rds/integration_tags/index.md b/website/docs/services/rds/integration_tags/index.md new file mode 100644 index 0000000..8c72927 --- /dev/null +++ b/website/docs/services/rds/integration_tags/index.md @@ -0,0 +1,93 @@ +--- +title: integration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - integration_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for integrations in a region + +## Overview + + + + + + + +
Nameintegration_tags
TypeResource
DescriptionA zero-ETL integration with Amazon Redshift.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the integration.
stringA description of the integration.
stringData filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
stringThe Amazon Resource Name (ARN) of the database to use as the source for replication.
stringThe ARN of the Redshift data warehouse to use as the target for replication.
string
stringThe AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
objectAn optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the *Key Management Service Developer Guide*.
You can only include this parameter if you specify the KMSKeyId parameter.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all integrations in a region. +```sql +SELECT +region, +integration_name, +description, +data_filter, +source_arn, +target_arn, +integration_arn, +kms_key_id, +additional_encryption_context, +create_time, +tag_key, +tag_value +FROM aws.rds.integration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integration_tags resource, see integrations + diff --git a/website/docs/services/rds/integrations/index.md b/website/docs/services/rds/integrations/index.md new file mode 100644 index 0000000..b3e976e --- /dev/null +++ b/website/docs/services/rds/integrations/index.md @@ -0,0 +1,262 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an integration resource or lists integrations in a region + +## Overview + + + + + + + +
Nameintegrations
TypeResource
DescriptionA zero-ETL integration with Amazon Redshift.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the integration.
stringA description of the integration.
arrayA list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*.
stringData filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
stringThe Amazon Resource Name (ARN) of the database to use as the source for replication.
stringThe ARN of the Redshift data warehouse to use as the target for replication.
string
stringThe AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
objectAn optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the *Key Management Service Developer Guide*.
You can only include this parameter if you specify the KMSKeyId parameter.
string
stringAWS region.
+ +For more information, see AWS::RDS::Integration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all integrations in a region. +```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.integrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual integration. +```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.integrations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.integrations ( + SourceArn, + TargetArn, + region +) +SELECT +'{{ SourceArn }}', + '{{ TargetArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.integrations ( + IntegrationName, + Description, + Tags, + DataFilter, + SourceArn, + TargetArn, + KMSKeyId, + AdditionalEncryptionContext, + region +) +SELECT + '{{ IntegrationName }}', + '{{ Description }}', + '{{ Tags }}', + '{{ DataFilter }}', + '{{ SourceArn }}', + '{{ TargetArn }}', + '{{ KMSKeyId }}', + '{{ AdditionalEncryptionContext }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: integration + props: + - name: IntegrationName + value: '{{ IntegrationName }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: DataFilter + value: '{{ DataFilter }}' + - name: SourceArn + value: '{{ SourceArn }}' + - name: TargetArn + value: '{{ TargetArn }}' + - name: KMSKeyId + value: '{{ KMSKeyId }}' + - name: AdditionalEncryptionContext + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.integrations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +rds:DescribeIntegrations +``` + +### Update +```json +rds:DescribeIntegrations, +rds:AddTagsToResource, +rds:RemoveTagsFromResource, +rds:ModifyIntegration +``` + +### Delete +```json +rds:DeleteIntegration, +rds:DescribeIntegrations +``` + +### List +```json +rds:DescribeIntegrations +``` diff --git a/website/docs/services/rds/integrations_list_only/index.md b/website/docs/services/rds/integrations_list_only/index.md new file mode 100644 index 0000000..84aacd5 --- /dev/null +++ b/website/docs/services/rds/integrations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integrations_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integrations in a region or regions, for all properties use integrations + +## Overview + + + + + + + +
Nameintegrations_list_only
TypeResource
DescriptionA zero-ETL integration with Amazon Redshift.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integrations in a region. +```sql +SELECT +region, +integration_arn +FROM aws.rds.integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integrations_list_only resource, see integrations + diff --git a/website/docs/services/rds/option_group_tags/index.md b/website/docs/services/rds/option_group_tags/index.md new file mode 100644 index 0000000..7378748 --- /dev/null +++ b/website/docs/services/rds/option_group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: option_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - option_group_tags + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for option_groups in a region + +## Overview + + + + + + + +
Nameoption_group_tags
TypeResource
DescriptionThe AWS::RDS::OptionGroup resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the option group to be created.
Constraints:
+ Must be 1 to 255 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens

Example: myoptiongroup
If you don't specify a value for OptionGroupName property, a name is automatically created for the option group.
This value is stored as a lowercase string.
stringThe description of the option group.
stringSpecifies the name of the engine that this option group should be associated with.
Valid Values:
+ mariadb
+ mysql
+ oracle-ee
+ oracle-ee-cdb
+ oracle-se2
+ oracle-se2-cdb
+ postgres
+ sqlserver-ee
+ sqlserver-se
+ sqlserver-ex
+ sqlserver-web
stringSpecifies the major version of the engine that this option group should be associated with.
arrayA list of all available options for an option group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all option_groups in a region. +```sql +SELECT +region, +option_group_name, +option_group_description, +engine_name, +major_engine_version, +option_configurations, +tag_key, +tag_value +FROM aws.rds.option_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the option_group_tags resource, see option_groups + diff --git a/website/docs/services/rds/option_groups/index.md b/website/docs/services/rds/option_groups/index.md new file mode 100644 index 0000000..282a7ad --- /dev/null +++ b/website/docs/services/rds/option_groups/index.md @@ -0,0 +1,259 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an option_group resource or lists option_groups in a region + +## Overview + + + + + + + +
Nameoption_groups
TypeResource
DescriptionThe AWS::RDS::OptionGroup resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the option group to be created.
Constraints:
+ Must be 1 to 255 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens

Example: myoptiongroup
If you don't specify a value for OptionGroupName property, a name is automatically created for the option group.
This value is stored as a lowercase string.
stringThe description of the option group.
stringSpecifies the name of the engine that this option group should be associated with.
Valid Values:
+ mariadb
+ mysql
+ oracle-ee
+ oracle-ee-cdb
+ oracle-se2
+ oracle-se2-cdb
+ postgres
+ sqlserver-ee
+ sqlserver-se
+ sqlserver-ex
+ sqlserver-web
stringSpecifies the major version of the engine that this option group should be associated with.
arrayA list of all available options for an option group.
arrayTags to assign to the option group.
stringAWS region.
+ +For more information, see AWS::RDS::OptionGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all option_groups in a region. +```sql +SELECT +region, +option_group_name, +option_group_description, +engine_name, +major_engine_version, +option_configurations, +tags +FROM aws.rds.option_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual option_group. +```sql +SELECT +region, +option_group_name, +option_group_description, +engine_name, +major_engine_version, +option_configurations, +tags +FROM aws.rds.option_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new option_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rds.option_groups ( + OptionGroupDescription, + EngineName, + MajorEngineVersion, + region +) +SELECT +'{{ OptionGroupDescription }}', + '{{ EngineName }}', + '{{ MajorEngineVersion }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rds.option_groups ( + OptionGroupName, + OptionGroupDescription, + EngineName, + MajorEngineVersion, + OptionConfigurations, + Tags, + region +) +SELECT + '{{ OptionGroupName }}', + '{{ OptionGroupDescription }}', + '{{ EngineName }}', + '{{ MajorEngineVersion }}', + '{{ OptionConfigurations }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: option_group + props: + - name: OptionGroupName + value: '{{ OptionGroupName }}' + - name: OptionGroupDescription + value: '{{ OptionGroupDescription }}' + - name: EngineName + value: '{{ EngineName }}' + - name: MajorEngineVersion + value: '{{ MajorEngineVersion }}' + - name: OptionConfigurations + value: + - DBSecurityGroupMemberships: + - '{{ DBSecurityGroupMemberships[0] }}' + OptionName: '{{ OptionName }}' + OptionSettings: + - Name: '{{ Name }}' + Value: '{{ Value }}' + OptionVersion: '{{ OptionVersion }}' + Port: '{{ Port }}' + VpcSecurityGroupMemberships: + - '{{ VpcSecurityGroupMemberships[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rds.option_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +rds:DescribeOptionGroups +``` diff --git a/website/docs/services/rds/option_groups_list_only/index.md b/website/docs/services/rds/option_groups_list_only/index.md new file mode 100644 index 0000000..4eeeebc --- /dev/null +++ b/website/docs/services/rds/option_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: option_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - option_groups_list_only + - rds + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists option_groups in a region or regions, for all properties use option_groups + +## Overview + + + + + + + +
Nameoption_groups_list_only
TypeResource
DescriptionThe AWS::RDS::OptionGroup resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the option group to be created.
Constraints:
+ Must be 1 to 255 letters, numbers, or hyphens
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens

Example: myoptiongroup
If you don't specify a value for OptionGroupName property, a name is automatically created for the option group.
This value is stored as a lowercase string.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all option_groups in a region. +```sql +SELECT +region, +option_group_name +FROM aws.rds.option_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the option_groups_list_only resource, see option_groups + diff --git a/website/docs/services/redshift/cluster_parameter_group_tags/index.md b/website/docs/services/redshift/cluster_parameter_group_tags/index.md new file mode 100644 index 0000000..7afedb9 --- /dev/null +++ b/website/docs/services/redshift/cluster_parameter_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: cluster_parameter_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_parameter_group_tags + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cluster_parameter_groups in a region + +## Overview + + + + + + + +
Namecluster_parameter_group_tags
TypeResource
DescriptionResource Type definition for AWS::Redshift::ClusterParameterGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the cluster parameter group.
stringA description of the parameter group.
stringThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
arrayAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cluster_parameter_groups in a region. +```sql +SELECT +region, +parameter_group_name, +description, +parameter_group_family, +parameters, +tag_key, +tag_value +FROM aws.redshift.cluster_parameter_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_parameter_group_tags resource, see cluster_parameter_groups + diff --git a/website/docs/services/redshift/cluster_parameter_groups/index.md b/website/docs/services/redshift/cluster_parameter_groups/index.md new file mode 100644 index 0000000..a28118e --- /dev/null +++ b/website/docs/services/redshift/cluster_parameter_groups/index.md @@ -0,0 +1,260 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster_parameter_group resource or lists cluster_parameter_groups in a region + +## Overview + + + + + + + +
Namecluster_parameter_groups
TypeResource
DescriptionResource Type definition for AWS::Redshift::ClusterParameterGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the cluster parameter group.
stringA description of the parameter group.
stringThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
arrayAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Redshift::ClusterParameterGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cluster_parameter_groups in a region. +```sql +SELECT +region, +parameter_group_name, +description, +parameter_group_family, +parameters, +tags +FROM aws.redshift.cluster_parameter_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster_parameter_group. +```sql +SELECT +region, +parameter_group_name, +description, +parameter_group_family, +parameters, +tags +FROM aws.redshift.cluster_parameter_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster_parameter_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.cluster_parameter_groups ( + Description, + ParameterGroupFamily, + region +) +SELECT +'{{ Description }}', + '{{ ParameterGroupFamily }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.cluster_parameter_groups ( + ParameterGroupName, + Description, + ParameterGroupFamily, + Parameters, + Tags, + region +) +SELECT + '{{ ParameterGroupName }}', + '{{ Description }}', + '{{ ParameterGroupFamily }}', + '{{ Parameters }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster_parameter_group + props: + - name: ParameterGroupName + value: '{{ ParameterGroupName }}' + - name: Description + value: '{{ Description }}' + - name: ParameterGroupFamily + value: '{{ ParameterGroupFamily }}' + - name: Parameters + value: + - ParameterName: '{{ ParameterName }}' + ParameterValue: '{{ ParameterValue }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.redshift.cluster_parameter_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +redshift:DescribeTags, +redshift:DescribeClusterParameterGroups, +redshift:DescribeClusterParameters, +initech:ListReports +``` diff --git a/website/docs/services/redshift/cluster_parameter_groups_list_only/index.md b/website/docs/services/redshift/cluster_parameter_groups_list_only/index.md new file mode 100644 index 0000000..ecdabb8 --- /dev/null +++ b/website/docs/services/redshift/cluster_parameter_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cluster_parameter_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_parameter_groups_list_only + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cluster_parameter_groups in a region or regions, for all properties use cluster_parameter_groups + +## Overview + + + + + + + +
Namecluster_parameter_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::Redshift::ClusterParameterGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the cluster parameter group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cluster_parameter_groups in a region. +```sql +SELECT +region, +parameter_group_name +FROM aws.redshift.cluster_parameter_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_parameter_groups_list_only resource, see cluster_parameter_groups + diff --git a/website/docs/services/redshift/cluster_subnet_group_tags/index.md b/website/docs/services/redshift/cluster_subnet_group_tags/index.md new file mode 100644 index 0000000..418bf6e --- /dev/null +++ b/website/docs/services/redshift/cluster_subnet_group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: cluster_subnet_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_subnet_group_tags + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cluster_subnet_groups in a region + +## Overview + + + + + + + +
Namecluster_subnet_group_tags
TypeResource
DescriptionSpecifies an Amazon Redshift subnet group.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe description of the parameter group.
arrayThe list of VPC subnet IDs
stringThis name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be "Default".
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cluster_subnet_groups in a region. +```sql +SELECT +region, +description, +subnet_ids, +cluster_subnet_group_name, +tag_key, +tag_value +FROM aws.redshift.cluster_subnet_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_subnet_group_tags resource, see cluster_subnet_groups + diff --git a/website/docs/services/redshift/cluster_subnet_groups/index.md b/website/docs/services/redshift/cluster_subnet_groups/index.md new file mode 100644 index 0000000..e98c19f --- /dev/null +++ b/website/docs/services/redshift/cluster_subnet_groups/index.md @@ -0,0 +1,277 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster_subnet_group resource or lists cluster_subnet_groups in a region + +## Overview + + + + + + + +
Namecluster_subnet_groups
TypeResource
DescriptionSpecifies an Amazon Redshift subnet group.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe description of the parameter group.
arrayThe list of VPC subnet IDs
arrayThe list of tags for the cluster parameter group.
stringThis name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be "Default".
stringAWS region.
+ +For more information, see AWS::Redshift::ClusterSubnetGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cluster_subnet_groups in a region. +```sql +SELECT +region, +description, +subnet_ids, +tags, +cluster_subnet_group_name +FROM aws.redshift.cluster_subnet_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster_subnet_group. +```sql +SELECT +region, +description, +subnet_ids, +tags, +cluster_subnet_group_name +FROM aws.redshift.cluster_subnet_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster_subnet_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.cluster_subnet_groups ( + Description, + SubnetIds, + region +) +SELECT +'{{ Description }}', + '{{ SubnetIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.cluster_subnet_groups ( + Description, + SubnetIds, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ SubnetIds }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster_subnet_group + props: + - name: Description + value: '{{ Description }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.redshift.cluster_subnet_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### 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/website/docs/services/redshift/cluster_subnet_groups_list_only/index.md b/website/docs/services/redshift/cluster_subnet_groups_list_only/index.md new file mode 100644 index 0000000..fb29ec3 --- /dev/null +++ b/website/docs/services/redshift/cluster_subnet_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cluster_subnet_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_subnet_groups_list_only + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cluster_subnet_groups in a region or regions, for all properties use cluster_subnet_groups + +## Overview + + + + + + + +
Namecluster_subnet_groups_list_only
TypeResource
DescriptionSpecifies an Amazon Redshift subnet group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThis name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be "Default".
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cluster_subnet_groups in a region. +```sql +SELECT +region, +cluster_subnet_group_name +FROM aws.redshift.cluster_subnet_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_subnet_groups_list_only resource, see cluster_subnet_groups + diff --git a/website/docs/services/redshift/cluster_tags/index.md b/website/docs/services/redshift/cluster_tags/index.md new file mode 100644 index 0000000..9e54169 --- /dev/null +++ b/website/docs/services/redshift/cluster_tags/index.md @@ -0,0 +1,183 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + + + +
Namecluster_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
integerThe number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
booleanIf true, the data in the cluster is encrypted at rest.
integerThe port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
integerThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
stringThe destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference
booleanMajor version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True
object
objectThe namespace resource policy document that will be attached to a Redshift cluster.
stringThe name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
string
booleanA boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.
stringThe name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
arrayA list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request
stringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
booleanIndicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
booleanA boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
stringThe EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint
arrayA list of security groups to be associated with this cluster.
stringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
stringThe password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.
stringThe name of a cluster subnet group to be associated with this cluster.
object
booleanA boolean indicating whether to enable the deferred maintenance window.
stringThe node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
stringThe user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.
booleanIf true, the cluster can be accessed from a public network.
stringA unique identifier for the deferred maintenance window.
integerThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
stringThe Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
stringSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
stringThe Elastic IP (EIP) address for the cluster.
stringThe availability zone relocation status of the cluster
stringThe value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.
enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
stringThe name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
booleanThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
stringThe name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
booleanAn option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
stringThe name of the parameter group to be associated with this cluster.
stringA timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
booleanA boolean indicating if we want to rotate Encryption Keys.
arrayA list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
stringThe Amazon Resource Name (ARN) of the cluster namespace.
stringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
stringThe version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.
stringSpecifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
stringThe weekly time range (in UTC) during which automated cluster maintenance can occur.
stringA timestamp indicating the start time for the deferred maintenance window.
stringThe type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required
booleanA boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
stringThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
integerAn integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
stringThe name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database.
integerThe number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default is 7.
Constraints: Must be at least 1 and no more than 35.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +revision_target, +automated_snapshot_retention_period, +encrypted, +port, +number_of_nodes, +destination_region, +allow_version_upgrade, +endpoint, +namespace_resource_policy, +maintenance_track_name, +owner_account, +multi_az, +snapshot_cluster_identifier, +iam_roles, +kms_key_id, +snapshot_copy_manual, +manage_master_password, +availability_zone, +cluster_security_groups, +cluster_identifier, +master_user_password, +cluster_subnet_group_name, +logging_properties, +defer_maintenance, +node_type, +master_username, +publicly_accessible, +defer_maintenance_identifier, +manual_snapshot_retention_period, +resource_action, +hsm_client_certificate_identifier, +elastic_ip, +availability_zone_relocation_status, +aqua_configuration_status, +snapshot_identifier, +availability_zone_relocation, +snapshot_copy_grant_name, +enhanced_vpc_routing, +cluster_parameter_group_name, +defer_maintenance_end_time, +rotate_encryption_key, +vpc_security_group_ids, +cluster_namespace_arn, +master_password_secret_arn, +cluster_version, +hsm_configuration_identifier, +preferred_maintenance_window, +defer_maintenance_start_time, +cluster_type, +classic, +master_password_secret_kms_key_id, +defer_maintenance_duration, +db_name, +snapshot_copy_retention_period, +tag_key, +tag_value +FROM aws.redshift.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + diff --git a/website/docs/services/redshift/clusters/index.md b/website/docs/services/redshift/clusters/index.md new file mode 100644 index 0000000..18337c6 --- /dev/null +++ b/website/docs/services/redshift/clusters/index.md @@ -0,0 +1,643 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster resource or lists clusters in a region + +## Overview + + + + + + + +
Nameclusters
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
integerThe number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
booleanIf true, the data in the cluster is encrypted at rest.
integerThe port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
integerThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
stringThe destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference
booleanMajor version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True
object
objectThe namespace resource policy document that will be attached to a Redshift cluster.
stringThe name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
string
booleanA boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.
arrayThe list of tags for the cluster parameter group.
stringThe name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
arrayA list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request
stringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
booleanIndicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
booleanA boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
stringThe EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint
arrayA list of security groups to be associated with this cluster.
stringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
stringThe password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.
stringThe name of a cluster subnet group to be associated with this cluster.
object
booleanA boolean indicating whether to enable the deferred maintenance window.
stringThe node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
stringThe user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.
booleanIf true, the cluster can be accessed from a public network.
stringA unique identifier for the deferred maintenance window.
integerThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
stringThe Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
stringSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
stringThe Elastic IP (EIP) address for the cluster.
stringThe availability zone relocation status of the cluster
stringThe value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.
enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
stringThe name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
booleanThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
stringThe name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
booleanAn option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
stringThe name of the parameter group to be associated with this cluster.
stringA timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
booleanA boolean indicating if we want to rotate Encryption Keys.
arrayA list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
stringThe Amazon Resource Name (ARN) of the cluster namespace.
stringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
stringThe version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.
stringSpecifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
stringThe weekly time range (in UTC) during which automated cluster maintenance can occur.
stringA timestamp indicating the start time for the deferred maintenance window.
stringThe type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required
booleanA boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
stringThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
integerAn integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
stringThe name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database.
integerThe number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default is 7.
Constraints: Must be at least 1 and no more than 35.
stringAWS region.
+ +For more information, see AWS::Redshift::Cluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all clusters in a region. +```sql +SELECT +region, +revision_target, +automated_snapshot_retention_period, +encrypted, +port, +number_of_nodes, +destination_region, +allow_version_upgrade, +endpoint, +namespace_resource_policy, +maintenance_track_name, +owner_account, +multi_az, +tags, +snapshot_cluster_identifier, +iam_roles, +kms_key_id, +snapshot_copy_manual, +manage_master_password, +availability_zone, +cluster_security_groups, +cluster_identifier, +master_user_password, +cluster_subnet_group_name, +logging_properties, +defer_maintenance, +node_type, +master_username, +publicly_accessible, +defer_maintenance_identifier, +manual_snapshot_retention_period, +resource_action, +hsm_client_certificate_identifier, +elastic_ip, +availability_zone_relocation_status, +aqua_configuration_status, +snapshot_identifier, +availability_zone_relocation, +snapshot_copy_grant_name, +enhanced_vpc_routing, +cluster_parameter_group_name, +defer_maintenance_end_time, +rotate_encryption_key, +vpc_security_group_ids, +cluster_namespace_arn, +master_password_secret_arn, +cluster_version, +hsm_configuration_identifier, +preferred_maintenance_window, +defer_maintenance_start_time, +cluster_type, +classic, +master_password_secret_kms_key_id, +defer_maintenance_duration, +db_name, +snapshot_copy_retention_period +FROM aws.redshift.clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster. +```sql +SELECT +region, +revision_target, +automated_snapshot_retention_period, +encrypted, +port, +number_of_nodes, +destination_region, +allow_version_upgrade, +endpoint, +namespace_resource_policy, +maintenance_track_name, +owner_account, +multi_az, +tags, +snapshot_cluster_identifier, +iam_roles, +kms_key_id, +snapshot_copy_manual, +manage_master_password, +availability_zone, +cluster_security_groups, +cluster_identifier, +master_user_password, +cluster_subnet_group_name, +logging_properties, +defer_maintenance, +node_type, +master_username, +publicly_accessible, +defer_maintenance_identifier, +manual_snapshot_retention_period, +resource_action, +hsm_client_certificate_identifier, +elastic_ip, +availability_zone_relocation_status, +aqua_configuration_status, +snapshot_identifier, +availability_zone_relocation, +snapshot_copy_grant_name, +enhanced_vpc_routing, +cluster_parameter_group_name, +defer_maintenance_end_time, +rotate_encryption_key, +vpc_security_group_ids, +cluster_namespace_arn, +master_password_secret_arn, +cluster_version, +hsm_configuration_identifier, +preferred_maintenance_window, +defer_maintenance_start_time, +cluster_type, +classic, +master_password_secret_kms_key_id, +defer_maintenance_duration, +db_name, +snapshot_copy_retention_period +FROM aws.redshift.clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.clusters ( + NodeType, + MasterUsername, + ClusterType, + DBName, + region +) +SELECT +'{{ NodeType }}', + '{{ MasterUsername }}', + '{{ ClusterType }}', + '{{ DBName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.clusters ( + RevisionTarget, + AutomatedSnapshotRetentionPeriod, + Encrypted, + Port, + NumberOfNodes, + DestinationRegion, + AllowVersionUpgrade, + Endpoint, + NamespaceResourcePolicy, + MaintenanceTrackName, + OwnerAccount, + MultiAZ, + Tags, + SnapshotClusterIdentifier, + IamRoles, + KmsKeyId, + SnapshotCopyManual, + ManageMasterPassword, + AvailabilityZone, + ClusterSecurityGroups, + ClusterIdentifier, + MasterUserPassword, + ClusterSubnetGroupName, + LoggingProperties, + DeferMaintenance, + NodeType, + MasterUsername, + PubliclyAccessible, + ManualSnapshotRetentionPeriod, + ResourceAction, + HsmClientCertificateIdentifier, + ElasticIp, + AvailabilityZoneRelocationStatus, + AquaConfigurationStatus, + SnapshotIdentifier, + AvailabilityZoneRelocation, + SnapshotCopyGrantName, + EnhancedVpcRouting, + ClusterParameterGroupName, + DeferMaintenanceEndTime, + RotateEncryptionKey, + VpcSecurityGroupIds, + ClusterVersion, + HsmConfigurationIdentifier, + PreferredMaintenanceWindow, + DeferMaintenanceStartTime, + ClusterType, + Classic, + MasterPasswordSecretKmsKeyId, + DeferMaintenanceDuration, + DBName, + SnapshotCopyRetentionPeriod, + region +) +SELECT + '{{ RevisionTarget }}', + '{{ AutomatedSnapshotRetentionPeriod }}', + '{{ Encrypted }}', + '{{ Port }}', + '{{ NumberOfNodes }}', + '{{ DestinationRegion }}', + '{{ AllowVersionUpgrade }}', + '{{ Endpoint }}', + '{{ NamespaceResourcePolicy }}', + '{{ MaintenanceTrackName }}', + '{{ OwnerAccount }}', + '{{ MultiAZ }}', + '{{ Tags }}', + '{{ SnapshotClusterIdentifier }}', + '{{ IamRoles }}', + '{{ KmsKeyId }}', + '{{ SnapshotCopyManual }}', + '{{ ManageMasterPassword }}', + '{{ AvailabilityZone }}', + '{{ ClusterSecurityGroups }}', + '{{ ClusterIdentifier }}', + '{{ MasterUserPassword }}', + '{{ ClusterSubnetGroupName }}', + '{{ LoggingProperties }}', + '{{ DeferMaintenance }}', + '{{ NodeType }}', + '{{ MasterUsername }}', + '{{ PubliclyAccessible }}', + '{{ ManualSnapshotRetentionPeriod }}', + '{{ ResourceAction }}', + '{{ HsmClientCertificateIdentifier }}', + '{{ ElasticIp }}', + '{{ AvailabilityZoneRelocationStatus }}', + '{{ AquaConfigurationStatus }}', + '{{ SnapshotIdentifier }}', + '{{ AvailabilityZoneRelocation }}', + '{{ SnapshotCopyGrantName }}', + '{{ EnhancedVpcRouting }}', + '{{ ClusterParameterGroupName }}', + '{{ DeferMaintenanceEndTime }}', + '{{ RotateEncryptionKey }}', + '{{ VpcSecurityGroupIds }}', + '{{ ClusterVersion }}', + '{{ HsmConfigurationIdentifier }}', + '{{ PreferredMaintenanceWindow }}', + '{{ DeferMaintenanceStartTime }}', + '{{ ClusterType }}', + '{{ Classic }}', + '{{ MasterPasswordSecretKmsKeyId }}', + '{{ DeferMaintenanceDuration }}', + '{{ DBName }}', + '{{ SnapshotCopyRetentionPeriod }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster + props: + - name: RevisionTarget + value: '{{ RevisionTarget }}' + - name: AutomatedSnapshotRetentionPeriod + value: '{{ AutomatedSnapshotRetentionPeriod }}' + - name: Encrypted + value: '{{ Encrypted }}' + - name: Port + value: '{{ Port }}' + - name: NumberOfNodes + value: '{{ NumberOfNodes }}' + - name: DestinationRegion + value: '{{ DestinationRegion }}' + - name: AllowVersionUpgrade + value: '{{ AllowVersionUpgrade }}' + - name: Endpoint + value: + Address: '{{ Address }}' + Port: '{{ Port }}' + - name: NamespaceResourcePolicy + value: {} + - name: MaintenanceTrackName + value: '{{ MaintenanceTrackName }}' + - name: OwnerAccount + value: '{{ OwnerAccount }}' + - name: MultiAZ + value: '{{ MultiAZ }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: SnapshotClusterIdentifier + value: '{{ SnapshotClusterIdentifier }}' + - name: IamRoles + value: + - '{{ IamRoles[0] }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: SnapshotCopyManual + value: '{{ SnapshotCopyManual }}' + - name: ManageMasterPassword + value: '{{ ManageMasterPassword }}' + - name: AvailabilityZone + value: '{{ AvailabilityZone }}' + - name: ClusterSecurityGroups + value: + - '{{ ClusterSecurityGroups[0] }}' + - name: ClusterIdentifier + value: '{{ ClusterIdentifier }}' + - name: MasterUserPassword + value: '{{ MasterUserPassword }}' + - name: ClusterSubnetGroupName + value: '{{ ClusterSubnetGroupName }}' + - name: LoggingProperties + value: + BucketName: '{{ BucketName }}' + S3KeyPrefix: '{{ S3KeyPrefix }}' + LogDestinationType: '{{ LogDestinationType }}' + LogExports: + - '{{ LogExports[0] }}' + - name: DeferMaintenance + value: '{{ DeferMaintenance }}' + - name: NodeType + value: '{{ NodeType }}' + - name: MasterUsername + value: '{{ MasterUsername }}' + - name: PubliclyAccessible + value: '{{ PubliclyAccessible }}' + - name: ManualSnapshotRetentionPeriod + value: '{{ ManualSnapshotRetentionPeriod }}' + - name: ResourceAction + value: '{{ ResourceAction }}' + - name: HsmClientCertificateIdentifier + value: '{{ HsmClientCertificateIdentifier }}' + - name: ElasticIp + value: '{{ ElasticIp }}' + - name: AvailabilityZoneRelocationStatus + value: '{{ AvailabilityZoneRelocationStatus }}' + - name: AquaConfigurationStatus + value: '{{ AquaConfigurationStatus }}' + - name: SnapshotIdentifier + value: '{{ SnapshotIdentifier }}' + - name: AvailabilityZoneRelocation + value: '{{ AvailabilityZoneRelocation }}' + - name: SnapshotCopyGrantName + value: '{{ SnapshotCopyGrantName }}' + - name: EnhancedVpcRouting + value: '{{ EnhancedVpcRouting }}' + - name: ClusterParameterGroupName + value: '{{ ClusterParameterGroupName }}' + - name: DeferMaintenanceEndTime + value: '{{ DeferMaintenanceEndTime }}' + - name: RotateEncryptionKey + value: '{{ RotateEncryptionKey }}' + - name: VpcSecurityGroupIds + value: + - '{{ VpcSecurityGroupIds[0] }}' + - name: ClusterVersion + value: '{{ ClusterVersion }}' + - name: HsmConfigurationIdentifier + value: '{{ HsmConfigurationIdentifier }}' + - name: PreferredMaintenanceWindow + value: '{{ PreferredMaintenanceWindow }}' + - name: DeferMaintenanceStartTime + value: '{{ DeferMaintenanceStartTime }}' + - name: ClusterType + value: '{{ ClusterType }}' + - name: Classic + value: '{{ Classic }}' + - name: MasterPasswordSecretKmsKeyId + value: '{{ MasterPasswordSecretKmsKeyId }}' + - name: DeferMaintenanceDuration + value: '{{ DeferMaintenanceDuration }}' + - name: DBName + value: '{{ DBName }}' + - name: SnapshotCopyRetentionPeriod + value: '{{ SnapshotCopyRetentionPeriod }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.redshift.clusters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Read +```json +redshift:DescribeClusters, +redshift:DescribeLoggingStatus, +redshift:DescribeSnapshotCopyGrant, +redshift:DescribeClusterDbRevisions, +redshift:DescribeTags, +redshift:GetResourcePolicy +``` + +### 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 +``` + +### 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 +``` + +### List +```json +redshift:DescribeTags, +redshift:DescribeClusters +``` + +### Delete +```json +redshift:DescribeTags, +redshift:DescribeClusters, +redshift:DeleteCluster +``` diff --git a/website/docs/services/redshift/clusters_list_only/index.md b/website/docs/services/redshift/clusters_list_only/index.md new file mode 100644 index 0000000..9dff96b --- /dev/null +++ b/website/docs/services/redshift/clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + + + +
Nameclusters_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +cluster_identifier +FROM aws.redshift.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + diff --git a/website/docs/services/redshift/endpoint_accesses/index.md b/website/docs/services/redshift/endpoint_accesses/index.md new file mode 100644 index 0000000..1ccf2ba --- /dev/null +++ b/website/docs/services/redshift/endpoint_accesses/index.md @@ -0,0 +1,286 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an endpoint_access resource or lists endpoint_accesses in a region + +## Overview + + + + + + + +
Nameendpoint_accesses
TypeResource
DescriptionResource schema for a Redshift-managed VPC endpoint.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe status of the endpoint.
objectThe connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
stringThe DNS address of the endpoint.
stringThe name of the endpoint.
arrayA list of vpc security group ids to apply to the created endpoint access.
stringThe AWS account ID of the owner of the cluster.
stringThe subnet group name where Amazon Redshift chooses to deploy the endpoint.
integerThe port number on which the cluster accepts incoming connections.
stringThe time (UTC) that the endpoint was created.
stringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
arrayA list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.
stringAWS region.
+ +For more information, see AWS::Redshift::EndpointAccess. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all endpoint_accesses in a region. +```sql +SELECT +region, +endpoint_status, +vpc_endpoint, +address, +endpoint_name, +vpc_security_group_ids, +resource_owner, +subnet_group_name, +port, +endpoint_create_time, +cluster_identifier, +vpc_security_groups +FROM aws.redshift.endpoint_accesses +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual endpoint_access. +```sql +SELECT +region, +endpoint_status, +vpc_endpoint, +address, +endpoint_name, +vpc_security_group_ids, +resource_owner, +subnet_group_name, +port, +endpoint_create_time, +cluster_identifier, +vpc_security_groups +FROM aws.redshift.endpoint_accesses +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new endpoint_access resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.endpoint_accesses ( + EndpointName, + VpcSecurityGroupIds, + SubnetGroupName, + ClusterIdentifier, + region +) +SELECT +'{{ EndpointName }}', + '{{ VpcSecurityGroupIds }}', + '{{ SubnetGroupName }}', + '{{ ClusterIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.endpoint_accesses ( + EndpointName, + VpcSecurityGroupIds, + ResourceOwner, + SubnetGroupName, + ClusterIdentifier, + region +) +SELECT + '{{ EndpointName }}', + '{{ VpcSecurityGroupIds }}', + '{{ ResourceOwner }}', + '{{ SubnetGroupName }}', + '{{ ClusterIdentifier }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: endpoint_access + props: + - name: EndpointName + value: '{{ EndpointName }}' + - name: VpcSecurityGroupIds + value: + - '{{ VpcSecurityGroupIds[0] }}' + - name: ResourceOwner + value: '{{ ResourceOwner }}' + - name: SubnetGroupName + value: '{{ SubnetGroupName }}' + - name: ClusterIdentifier + value: '{{ ClusterIdentifier }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.redshift.endpoint_accesses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the endpoint_accesses resource, the following permissions are required: + +### Read +```json +redshift:DescribeEndpointAccess, +ec2:DescribeClientVpnEndpoints, +ec2:DescribeVpcEndpoint, +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets +``` + +### Create +```json +redshift:CreateEndpointAccess, +redshift:DescribeEndpointAccess, +ec2:CreateClientVpnEndpoint, +ec2:CreateVpcEndpoint, +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 +``` + +### List +```json +redshift:DescribeEndpointAccess, +ec2:DescribeClientVpnEndpoints, +ec2:DescribeVpcEndpoints, +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/website/docs/services/redshift/endpoint_accesses_list_only/index.md b/website/docs/services/redshift/endpoint_accesses_list_only/index.md new file mode 100644 index 0000000..0624d39 --- /dev/null +++ b/website/docs/services/redshift/endpoint_accesses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: endpoint_accesses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_accesses_list_only + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoint_accesses in a region or regions, for all properties use endpoint_accesses + +## Overview + + + + + + + +
Nameendpoint_accesses_list_only
TypeResource
DescriptionResource schema for a Redshift-managed VPC endpoint.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the endpoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoint_accesses in a region. +```sql +SELECT +region, +endpoint_name +FROM aws.redshift.endpoint_accesses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the endpoint_accesses_list_only resource, see endpoint_accesses + diff --git a/website/docs/services/redshift/endpoint_authorizations/index.md b/website/docs/services/redshift/endpoint_authorizations/index.md new file mode 100644 index 0000000..d7328f2 --- /dev/null +++ b/website/docs/services/redshift/endpoint_authorizations/index.md @@ -0,0 +1,253 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an endpoint_authorization resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe status of the authorization action.
stringThe AWS account ID of the grantee of the cluster.
stringThe target AWS account ID to grant or revoke access for.
stringThe AWS account ID of the cluster owner.
integerThe number of Redshift-managed VPC endpoints created for the authorization.
stringThe time (UTC) when the authorization was created.
arrayThe VPCs allowed access to the cluster.
booleanIndicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
booleanIndicates whether all VPCs in the grantee account are allowed access to the cluster.
arrayThe virtual private cloud (VPC) identifiers to grant or revoke access to.
stringThe cluster identifier.
stringThe status of the cluster.
stringAWS region.
+ +For more information, see AWS::Redshift::EndpointAuthorization. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all endpoint_authorizations in a region. +```sql +SELECT +region, +status, +grantee, +account, +grantor, +endpoint_count, +authorize_time, +allowed_vpcs, +force, +allowed_all_vpcs, +vpc_ids, +cluster_identifier, +cluster_status +FROM aws.redshift.endpoint_authorizations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual endpoint_authorization. +```sql +SELECT +region, +status, +grantee, +account, +grantor, +endpoint_count, +authorize_time, +allowed_vpcs, +force, +allowed_all_vpcs, +vpc_ids, +cluster_identifier, +cluster_status +FROM aws.redshift.endpoint_authorizations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new endpoint_authorization resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.endpoint_authorizations ( + Account, + ClusterIdentifier, + region +) +SELECT +'{{ Account }}', + '{{ ClusterIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.endpoint_authorizations ( + Account, + Force, + VpcIds, + ClusterIdentifier, + region +) +SELECT + '{{ Account }}', + '{{ Force }}', + '{{ VpcIds }}', + '{{ ClusterIdentifier }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: endpoint_authorization + props: + - name: Account + value: '{{ Account }}' + - name: Force + value: '{{ Force }}' + - name: VpcIds + value: + - '{{ VpcIds[0] }}' + - name: ClusterIdentifier + value: '{{ ClusterIdentifier }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.redshift.endpoint_authorizations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the endpoint_authorizations resource, the following permissions are required: + +### Read +```json +redshift:DescribeEndpointAuthorization +``` + +### Create +```json +redshift:AuthorizeEndpointAccess, +redshift:DescribeEndpointAuthorization +``` + +### Update +```json +redshift:AuthorizeEndpointAccess, +redshift:DescribeEndpointAuthorization, +redshift:RevokeEndpointAccess +``` + +### List +```json +redshift:DescribeEndpointAuthorization +``` + +### Delete +```json +redshift:RevokeEndpointAccess, +redshift:DeleteEndpointAccess, +redshift:DescribeEndpointAuthorization, +ec2:DeleteClientVpnEndpoint, +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets +``` diff --git a/website/docs/services/redshift/endpoint_authorizations_list_only/index.md b/website/docs/services/redshift/endpoint_authorizations_list_only/index.md new file mode 100644 index 0000000..a524454 --- /dev/null +++ b/website/docs/services/redshift/endpoint_authorizations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: endpoint_authorizations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_authorizations_list_only + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoint_authorizations in a region or regions, for all properties use endpoint_authorizations + +## Overview + + + + + + + +
Nameendpoint_authorizations_list_only
TypeResource
DescriptionDescribes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe target AWS account ID to grant or revoke access for.
stringThe cluster identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoint_authorizations in a region. +```sql +SELECT +region, +cluster_identifier, +account +FROM aws.redshift.endpoint_authorizations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the endpoint_authorizations_list_only resource, see endpoint_authorizations + diff --git a/website/docs/services/redshift/event_subscription_tags/index.md b/website/docs/services/redshift/event_subscription_tags/index.md new file mode 100644 index 0000000..7671dfb --- /dev/null +++ b/website/docs/services/redshift/event_subscription_tags/index.md @@ -0,0 +1,101 @@ +--- +title: event_subscription_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscription_tags + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_subscriptions in a region + +## Overview + + + + + + + +
Nameevent_subscription_tags
TypeResource
DescriptionThe `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe status of the Amazon Redshift event notification subscription.
stringThe name of the Amazon Redshift event notification subscription.
arrayThe list of Amazon Redshift event categories specified in the event notification subscription.
stringThe type of source that will be generating the events.
arraySpecifies the Amazon Redshift event categories to be published by the event notification subscription.
booleanA boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
stringSpecifies the Amazon Redshift event severity to be published by the event notification subscription.
stringThe name of the Amazon Redshift event notification subscription
arrayA list of one or more identifiers of Amazon Redshift source objects.
stringThe AWS account associated with the Amazon Redshift event notification subscription.
arrayA list of the sources that publish events to the Amazon Redshift event notification subscription.
stringThe Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
stringThe date and time the Amazon Redshift event notification subscription was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_subscriptions in a region. +```sql +SELECT +region, +status, +cust_subscription_id, +event_categories_list, +source_type, +event_categories, +enabled, +severity, +subscription_name, +source_ids, +customer_aws_id, +source_ids_list, +sns_topic_arn, +subscription_creation_time, +tag_key, +tag_value +FROM aws.redshift.event_subscription_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_subscription_tags resource, see event_subscriptions + diff --git a/website/docs/services/redshift/event_subscriptions/index.md b/website/docs/services/redshift/event_subscriptions/index.md new file mode 100644 index 0000000..5eeb872 --- /dev/null +++ b/website/docs/services/redshift/event_subscriptions/index.md @@ -0,0 +1,277 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an event_subscription resource or lists event_subscriptions in a region + +## Overview + + + + + + + +
Nameevent_subscriptions
TypeResource
DescriptionThe `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe status of the Amazon Redshift event notification subscription.
stringThe name of the Amazon Redshift event notification subscription.
arrayThe list of Amazon Redshift event categories specified in the event notification subscription.
stringThe type of source that will be generating the events.
arraySpecifies the Amazon Redshift event categories to be published by the event notification subscription.
booleanA boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
stringSpecifies the Amazon Redshift event severity to be published by the event notification subscription.
stringThe name of the Amazon Redshift event notification subscription
arrayA list of one or more identifiers of Amazon Redshift source objects.
stringThe AWS account associated with the Amazon Redshift event notification subscription.
arrayA list of the sources that publish events to the Amazon Redshift event notification subscription.
stringThe Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
stringThe date and time the Amazon Redshift event notification subscription was created.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Redshift::EventSubscription. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all event_subscriptions in a region. +```sql +SELECT +region, +status, +cust_subscription_id, +event_categories_list, +source_type, +event_categories, +enabled, +severity, +subscription_name, +source_ids, +customer_aws_id, +source_ids_list, +sns_topic_arn, +subscription_creation_time, +tags +FROM aws.redshift.event_subscriptions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual event_subscription. +```sql +SELECT +region, +status, +cust_subscription_id, +event_categories_list, +source_type, +event_categories, +enabled, +severity, +subscription_name, +source_ids, +customer_aws_id, +source_ids_list, +sns_topic_arn, +subscription_creation_time, +tags +FROM aws.redshift.event_subscriptions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new event_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.event_subscriptions ( + SubscriptionName, + region +) +SELECT +'{{ SubscriptionName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.event_subscriptions ( + SourceType, + EventCategories, + Enabled, + Severity, + SubscriptionName, + SourceIds, + SnsTopicArn, + Tags, + region +) +SELECT + '{{ SourceType }}', + '{{ EventCategories }}', + '{{ Enabled }}', + '{{ Severity }}', + '{{ SubscriptionName }}', + '{{ SourceIds }}', + '{{ SnsTopicArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: event_subscription + props: + - name: SourceType + value: '{{ SourceType }}' + - name: EventCategories + value: + - '{{ EventCategories[0] }}' + - name: Enabled + value: '{{ Enabled }}' + - name: Severity + value: '{{ Severity }}' + - name: SubscriptionName + value: '{{ SubscriptionName }}' + - name: SourceIds + value: + - '{{ SourceIds[0] }}' + - name: SnsTopicArn + value: '{{ SnsTopicArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.redshift.event_subscriptions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the event_subscriptions resource, the following permissions are required: + +### Read +```json +redshift:DescribeEventSubscriptions, +redshift:DescribeTags +``` + +### Create +```json +redshift:CreateEventSubscription, +redshift:CreateTags, +redshift:DescribeTags, +redshift:DescribeEventSubscriptions +``` + +### Update +```json +redshift:ModifyEventSubscription, +redshift:CreateTags, +redshift:DescribeTags, +redshift:DescribeEventSubscriptions, +redshift:DeleteTags +``` + +### List +```json +redshift:DescribeTags, +redshift:DescribeEventSubscriptions +``` + +### Delete +```json +redshift:DescribeEventSubscriptions, +redshift:DeleteEventSubscription, +redshift:DescribeTags, +redshift:DeleteTags +``` diff --git a/website/docs/services/redshift/event_subscriptions_list_only/index.md b/website/docs/services/redshift/event_subscriptions_list_only/index.md new file mode 100644 index 0000000..40bd20f --- /dev/null +++ b/website/docs/services/redshift/event_subscriptions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: event_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscriptions_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_subscriptions in a region or regions, for all properties use event_subscriptions + +## Overview + + + + + + + +
Nameevent_subscriptions_list_only
TypeResource
DescriptionThe `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Amazon Redshift event notification subscription
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_subscriptions in a region. +```sql +SELECT +region, +subscription_name +FROM aws.redshift.event_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_subscriptions_list_only resource, see event_subscriptions + diff --git a/website/docs/services/redshift/index.md b/website/docs/services/redshift/index.md new file mode 100644 index 0000000..32ca515 --- /dev/null +++ b/website/docs/services/redshift/index.md @@ -0,0 +1,56 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The redshift service documentation. + +:::info Service Summary + +
+
+total resources: 21
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/redshift/integration_tags/index.md b/website/docs/services/redshift/integration_tags/index.md new file mode 100644 index 0000000..3083965 --- /dev/null +++ b/website/docs/services/redshift/integration_tags/index.md @@ -0,0 +1,89 @@ +--- +title: integration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - integration_tags + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for integrations in a region + +## Overview + + + + + + + +
Nameintegration_tags
TypeResource
DescriptionIntegration from a source AWS service to a Redshift cluster
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the integration.
stringThe name of the integration.
stringThe Amazon Resource Name (ARN) of the database to use as the source for replication
stringThe Amazon Resource Name (ARN) of the Redshift data warehouse to use as the target for replication
stringThe time (UTC) when the integration was created.
stringAn KMS key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default AWS owned KMS key is used.
objectAn optional set of non-secret key–value pairs that contains additional contextual information about the data.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all integrations in a region. +```sql +SELECT +region, +integration_arn, +integration_name, +source_arn, +target_arn, +create_time, +kms_key_id, +additional_encryption_context, +tag_key, +tag_value +FROM aws.redshift.integration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integration_tags resource, see integrations + diff --git a/website/docs/services/redshift/integrations/index.md b/website/docs/services/redshift/integrations/index.md new file mode 100644 index 0000000..3be4621 --- /dev/null +++ b/website/docs/services/redshift/integrations/index.md @@ -0,0 +1,257 @@ +--- +title: integrations +hide_title: false +hide_table_of_contents: false +keywords: + - integrations + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an integration resource or lists integrations in a region + +## Overview + + + + + + + +
Nameintegrations
TypeResource
DescriptionIntegration from a source AWS service to a Redshift cluster
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the integration.
stringThe name of the integration.
stringThe Amazon Resource Name (ARN) of the database to use as the source for replication
stringThe Amazon Resource Name (ARN) of the Redshift data warehouse to use as the target for replication
arrayAn array of key-value pairs to apply to this resource.
stringThe time (UTC) when the integration was created.
stringAn KMS key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default AWS owned KMS key is used.
objectAn optional set of non-secret key–value pairs that contains additional contextual information about the data.
stringAWS region.
+ +For more information, see AWS::Redshift::Integration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all integrations in a region. +```sql +SELECT +region, +integration_arn, +integration_name, +source_arn, +target_arn, +tags, +create_time, +kms_key_id, +additional_encryption_context +FROM aws.redshift.integrations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual integration. +```sql +SELECT +region, +integration_arn, +integration_name, +source_arn, +target_arn, +tags, +create_time, +kms_key_id, +additional_encryption_context +FROM aws.redshift.integrations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.integrations ( + SourceArn, + TargetArn, + region +) +SELECT +'{{ SourceArn }}', + '{{ TargetArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.integrations ( + IntegrationName, + SourceArn, + TargetArn, + Tags, + KMSKeyId, + AdditionalEncryptionContext, + region +) +SELECT + '{{ IntegrationName }}', + '{{ SourceArn }}', + '{{ TargetArn }}', + '{{ Tags }}', + '{{ KMSKeyId }}', + '{{ AdditionalEncryptionContext }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: integration + props: + - name: IntegrationName + value: '{{ IntegrationName }}' + - name: SourceArn + value: '{{ SourceArn }}' + - name: TargetArn + value: '{{ TargetArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: KMSKeyId + value: '{{ KMSKeyId }}' + - name: AdditionalEncryptionContext + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.redshift.integrations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the integrations resource, the following permissions are required: + +### Create +```json +redshift:CreateIntegration, +redshift:DescribeIntegrations, +redshift:CreateTags, +redshift:DescribeTags, +redshift:DescribeClusters, +redshift:CreateInboundIntegration, +redshift-serverless:ListNamespaces, +kms:CreateGrant, +kms:DescribeKey +``` + +### Read +```json +redshift:DescribeIntegrations, +redshift:DescribeTags +``` + +### Update +```json +redshift:DescribeIntegrations, +redshift:ModifyIntegration, +redshift:CreateTags, +redshift:DeleteTags, +redshift:DescribeClusters, +redshift:DescribeTags, +redshift-serverless:ListNamespaces +``` + +### Delete +```json +redshift:DeleteTags, +redshift:DeleteIntegration, +redshift:DescribeIntegrations +``` + +### List +```json +redshift:DescribeTags, +redshift:DescribeIntegrations +``` diff --git a/website/docs/services/redshift/integrations_list_only/index.md b/website/docs/services/redshift/integrations_list_only/index.md new file mode 100644 index 0000000..84ac34e --- /dev/null +++ b/website/docs/services/redshift/integrations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integrations_list_only + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integrations in a region or regions, for all properties use integrations + +## Overview + + + + + + + +
Nameintegrations_list_only
TypeResource
DescriptionIntegration from a source AWS service to a Redshift cluster
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the integration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integrations in a region. +```sql +SELECT +region, +integration_arn +FROM aws.redshift.integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integrations_list_only resource, see integrations + diff --git a/website/docs/services/redshift/scheduled_actions/index.md b/website/docs/services/redshift/scheduled_actions/index.md new file mode 100644 index 0000000..72cfc7f --- /dev/null +++ b/website/docs/services/redshift/scheduled_actions/index.md @@ -0,0 +1,265 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a scheduled_action resource or lists scheduled_actions in a region + +## Overview + + + + + + + +
Namescheduled_actions
TypeResource
DescriptionThe `AWS::Redshift::ScheduledAction` resource creates an Amazon Redshift Scheduled Action.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the scheduled action.
stringThe name of the scheduled action. The name must be unique within an account.
stringThe end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
stringThe state of the scheduled action.
stringThe schedule in `at( )` or `cron( )` format.
stringThe IAM role to assume to run the target action.
stringThe start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
booleanIf true, the schedule is enabled. If false, the scheduled action does not trigger.
objectA JSON format string of the Amazon Redshift API operation with input parameters.
arrayList of times when the scheduled action will run.
stringAWS region.
+ +For more information, see AWS::Redshift::ScheduledAction. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scheduled_actions in a region. +```sql +SELECT +region, +scheduled_action_description, +scheduled_action_name, +end_time, +state, +schedule, +iam_role, +start_time, +enable, +target_action, +next_invocations +FROM aws.redshift.scheduled_actions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual scheduled_action. +```sql +SELECT +region, +scheduled_action_description, +scheduled_action_name, +end_time, +state, +schedule, +iam_role, +start_time, +enable, +target_action, +next_invocations +FROM aws.redshift.scheduled_actions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scheduled_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.scheduled_actions ( + ScheduledActionName, + region +) +SELECT +'{{ ScheduledActionName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.redshift.scheduled_actions ( + ScheduledActionDescription, + ScheduledActionName, + EndTime, + Schedule, + IamRole, + StartTime, + Enable, + TargetAction, + region +) +SELECT + '{{ ScheduledActionDescription }}', + '{{ ScheduledActionName }}', + '{{ EndTime }}', + '{{ Schedule }}', + '{{ IamRole }}', + '{{ StartTime }}', + '{{ Enable }}', + '{{ TargetAction }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: scheduled_action + props: + - name: ScheduledActionDescription + value: '{{ ScheduledActionDescription }}' + - name: ScheduledActionName + value: '{{ ScheduledActionName }}' + - name: EndTime + value: '{{ EndTime }}' + - name: Schedule + value: '{{ Schedule }}' + - name: IamRole + value: '{{ IamRole }}' + - name: StartTime + value: null + - name: Enable + value: '{{ Enable }}' + - name: TargetAction + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.redshift.scheduled_actions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the scheduled_actions resource, the following permissions are required: + +### Read +```json +redshift:DescribeScheduledActions, +redshift:DescribeTags +``` + +### Create +```json +redshift:CreateScheduledAction, +redshift:DescribeScheduledActions, +redshift:DescribeTags, +redshift:PauseCluster, +redshift:ResumeCluster, +redshift:ResizeCluster, +iam:PassRole +``` + +### Update +```json +redshift:DescribeScheduledActions, +redshift:ModifyScheduledAction, +redshift:PauseCluster, +redshift:ResumeCluster, +redshift:ResizeCluster, +redshift:DescribeTags, +iam:PassRole +``` + +### List +```json +redshift:DescribeTags, +redshift:DescribeScheduledActions +``` + +### Delete +```json +redshift:DescribeTags, +redshift:DescribeScheduledActions, +redshift:DeleteScheduledAction +``` diff --git a/website/docs/services/redshift/scheduled_actions_list_only/index.md b/website/docs/services/redshift/scheduled_actions_list_only/index.md new file mode 100644 index 0000000..39deb5e --- /dev/null +++ b/website/docs/services/redshift/scheduled_actions_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: scheduled_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_actions_list_only + - redshift + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scheduled_actions in a region or regions, for all properties use scheduled_actions + +## Overview + + + + + + + +
Namescheduled_actions_list_only
TypeResource
DescriptionThe `AWS::Redshift::ScheduledAction` resource creates an Amazon Redshift Scheduled Action.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the scheduled action. The name must be unique within an account.
stringThe schedule in `at( )` or `cron( )` format.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scheduled_actions in a region. +```sql +SELECT +region, +scheduled_action_name +FROM aws.redshift.scheduled_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_actions_list_only resource, see scheduled_actions + diff --git a/website/docs/services/redshiftserverless/index.md b/website/docs/services/redshiftserverless/index.md new file mode 100644 index 0000000..3e1f471 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The redshiftserverless service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/redshiftserverless/namespace_tags/index.md b/website/docs/services/redshiftserverless/namespace_tags/index.md new file mode 100644 index 0000000..9f3c1b1 --- /dev/null +++ b/website/docs/services/redshiftserverless/namespace_tags/index.md @@ -0,0 +1,107 @@ +--- +title: namespace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - namespace_tags + - redshiftserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for namespaces in a region + +## Overview + + + + + + + +
Namenamespace_tags
TypeResource
DescriptionDefinition of AWS::RedshiftServerless::Namespace Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
stringThe password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true.
stringThe user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
stringThe database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
stringThe default IAM role ARN for the namespace that is being created.
arrayA list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10.
stringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
arrayThe collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog
booleanIf true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
objectDefinition of Namespace resource.
stringA unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account.
stringThe name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace
integerThe number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
objectThe resource policy document that will be attached to the namespace.
stringThe ARN for the Redshift application that integrates with IAM Identity Center.
arrayThe snapshot copy configurations for the namespace.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all namespaces in a region. +```sql +SELECT +region, +admin_password_secret_kms_key_id, +admin_user_password, +admin_username, +db_name, +default_iam_role_arn, +iam_roles, +kms_key_id, +log_exports, +manage_admin_password, +namespace, +namespace_name, +final_snapshot_name, +final_snapshot_retention_period, +namespace_resource_policy, +redshift_idc_application_arn, +snapshot_copy_configurations, +tag_key, +tag_value +FROM aws.redshiftserverless.namespace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the namespace_tags resource, see namespaces + diff --git a/website/docs/services/redshiftserverless/namespaces/index.md b/website/docs/services/redshiftserverless/namespaces/index.md new file mode 100644 index 0000000..801dfd2 --- /dev/null +++ b/website/docs/services/redshiftserverless/namespaces/index.md @@ -0,0 +1,380 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a namespace resource or lists namespaces in a region + +## Overview + + + + + + + +
Namenamespaces
TypeResource
DescriptionDefinition of AWS::RedshiftServerless::Namespace Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
stringThe password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true.
stringThe user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
stringThe database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
stringThe default IAM role ARN for the namespace that is being created.
arrayA list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10.
stringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
arrayThe collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog
booleanIf true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
objectDefinition of Namespace resource.
stringA unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account.
arrayThe list of tags for the namespace.
stringThe name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace
integerThe number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
objectThe resource policy document that will be attached to the namespace.
stringThe ARN for the Redshift application that integrates with IAM Identity Center.
arrayThe snapshot copy configurations for the namespace.
stringAWS region.
+ +For more information, see AWS::RedshiftServerless::Namespace. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all namespaces in a region. +```sql +SELECT +region, +admin_password_secret_kms_key_id, +admin_user_password, +admin_username, +db_name, +default_iam_role_arn, +iam_roles, +kms_key_id, +log_exports, +manage_admin_password, +namespace, +namespace_name, +tags, +final_snapshot_name, +final_snapshot_retention_period, +namespace_resource_policy, +redshift_idc_application_arn, +snapshot_copy_configurations +FROM aws.redshiftserverless.namespaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual namespace. +```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.namespaces +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new namespace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.redshiftserverless.namespaces ( + NamespaceName, + region +) +SELECT +'{{ NamespaceName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.redshiftserverless.namespaces ( + AdminPasswordSecretKmsKeyId, + AdminUserPassword, + AdminUsername, + DbName, + DefaultIamRoleArn, + IamRoles, + KmsKeyId, + LogExports, + ManageAdminPassword, + NamespaceName, + Tags, + FinalSnapshotName, + FinalSnapshotRetentionPeriod, + NamespaceResourcePolicy, + RedshiftIdcApplicationArn, + SnapshotCopyConfigurations, + region +) +SELECT + '{{ AdminPasswordSecretKmsKeyId }}', + '{{ AdminUserPassword }}', + '{{ AdminUsername }}', + '{{ DbName }}', + '{{ DefaultIamRoleArn }}', + '{{ IamRoles }}', + '{{ KmsKeyId }}', + '{{ LogExports }}', + '{{ ManageAdminPassword }}', + '{{ NamespaceName }}', + '{{ Tags }}', + '{{ FinalSnapshotName }}', + '{{ FinalSnapshotRetentionPeriod }}', + '{{ NamespaceResourcePolicy }}', + '{{ RedshiftIdcApplicationArn }}', + '{{ SnapshotCopyConfigurations }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: namespace + props: + - name: AdminPasswordSecretKmsKeyId + value: '{{ AdminPasswordSecretKmsKeyId }}' + - name: AdminUserPassword + value: '{{ AdminUserPassword }}' + - name: AdminUsername + value: '{{ AdminUsername }}' + - name: DbName + value: '{{ DbName }}' + - name: DefaultIamRoleArn + value: '{{ DefaultIamRoleArn }}' + - name: IamRoles + value: + - '{{ IamRoles[0] }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: LogExports + value: + - '{{ LogExports[0] }}' + - name: ManageAdminPassword + value: '{{ ManageAdminPassword }}' + - name: NamespaceName + value: '{{ NamespaceName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: FinalSnapshotName + value: '{{ FinalSnapshotName }}' + - name: FinalSnapshotRetentionPeriod + value: '{{ FinalSnapshotRetentionPeriod }}' + - name: NamespaceResourcePolicy + value: {} + - name: RedshiftIdcApplicationArn + value: '{{ RedshiftIdcApplicationArn }}' + - name: SnapshotCopyConfigurations + value: + - DestinationRegion: '{{ DestinationRegion }}' + DestinationKmsKeyId: '{{ DestinationKmsKeyId }}' + SnapshotRetentionPeriod: '{{ SnapshotRetentionPeriod }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.redshiftserverless.namespaces +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the namespaces resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +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-serverless:ListTagsForResource, +redshift-serverless:TagResource, +redshift:GetResourcePolicy, +redshift:PutResourcePolicy, +secretsmanager:CreateSecret, +secretsmanager:TagResource, +secretsmanager:RotateSecret, +secretsmanager:DescribeSecret +``` + +### Read +```json +iam:PassRole, +redshift-serverless:GetNamespace, +redshift-serverless:ListTagsForResource, +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-serverless:ListTagsForResource, +redshift-serverless:TagResource, +redshift-serverless:UntagResource, +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, +redshift-serverless:ListTagsForResource, +redshift-serverless:UntagResource, +kms:RetireGrant, +secretsmanager:DescribeSecret, +secretsmanager:DeleteSecret, +redshift:DeleteResourcePolicy +``` + +### List +```json +iam:PassRole, +redshift-serverless:ListNamespaces, +redshift-serverless:ListTagsForResource +``` diff --git a/website/docs/services/redshiftserverless/namespaces_list_only/index.md b/website/docs/services/redshiftserverless/namespaces_list_only/index.md new file mode 100644 index 0000000..407cf9f --- /dev/null +++ b/website/docs/services/redshiftserverless/namespaces_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: namespaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - namespaces_list_only + - redshiftserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists namespaces in a region or regions, for all properties use namespaces + +## Overview + + + + + + + +
Namenamespaces_list_only
TypeResource
DescriptionDefinition of AWS::RedshiftServerless::Namespace Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectDefinition of Namespace resource.
stringA unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all namespaces in a region. +```sql +SELECT +region, +namespace_name +FROM aws.redshiftserverless.namespaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the namespaces_list_only resource, see namespaces + diff --git a/website/docs/services/redshiftserverless/workgroup_tags/index.md b/website/docs/services/redshiftserverless/workgroup_tags/index.md new file mode 100644 index 0000000..5563b84 --- /dev/null +++ b/website/docs/services/redshiftserverless/workgroup_tags/index.md @@ -0,0 +1,99 @@ +--- +title: workgroup_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workgroup_tags + - redshiftserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workgroups in a region + +## Overview + + + + + + + +
Nameworkgroup_tags
TypeResource
DescriptionDefinition of AWS::RedshiftServerless::Workgroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the workgroup.
stringThe namespace the workgroup is associated with.
integerThe base compute capacity of the workgroup in Redshift Processing Units (RPUs).
integerThe max compute capacity of the workgroup in Redshift Processing Units (RPUs).
booleanThe value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
arrayA list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
arrayA list of security group IDs to associate with the workgroup.
arrayA list of subnet IDs the workgroup is associated with.
booleanA value that specifies whether the workgroup can be accessible from a public network.
integerThe custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
objectA property that represents the price performance target settings for the workgroup.
objectDefinition for workgroup resource
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workgroups in a region. +```sql +SELECT +region, +workgroup_name, +namespace_name, +base_capacity, +max_capacity, +enhanced_vpc_routing, +config_parameters, +security_group_ids, +subnet_ids, +publicly_accessible, +port, +price_performance_target, +workgroup, +tag_key, +tag_value +FROM aws.redshiftserverless.workgroup_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workgroup_tags resource, see workgroups + diff --git a/website/docs/services/redshiftserverless/workgroups/index.md b/website/docs/services/redshiftserverless/workgroups/index.md new file mode 100644 index 0000000..644f4d4 --- /dev/null +++ b/website/docs/services/redshiftserverless/workgroups/index.md @@ -0,0 +1,335 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a workgroup resource or lists workgroups in a region + +## Overview + + + + + + + +
Nameworkgroups
TypeResource
DescriptionDefinition of AWS::RedshiftServerless::Workgroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the workgroup.
stringThe namespace the workgroup is associated with.
integerThe base compute capacity of the workgroup in Redshift Processing Units (RPUs).
integerThe max compute capacity of the workgroup in Redshift Processing Units (RPUs).
booleanThe value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
arrayA list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
arrayA list of security group IDs to associate with the workgroup.
arrayA list of subnet IDs the workgroup is associated with.
booleanA value that specifies whether the workgroup can be accessible from a public network.
integerThe custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
objectA property that represents the price performance target settings for the workgroup.
arrayThe map of the key-value pairs used to tag the workgroup.
objectDefinition for workgroup resource
stringAWS region.
+ +For more information, see AWS::RedshiftServerless::Workgroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all workgroups in a region. +```sql +SELECT +region, +workgroup_name, +namespace_name, +base_capacity, +max_capacity, +enhanced_vpc_routing, +config_parameters, +security_group_ids, +subnet_ids, +publicly_accessible, +port, +price_performance_target, +tags, +workgroup +FROM aws.redshiftserverless.workgroups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual workgroup. +```sql +SELECT +region, +workgroup_name, +namespace_name, +base_capacity, +max_capacity, +enhanced_vpc_routing, +config_parameters, +security_group_ids, +subnet_ids, +publicly_accessible, +port, +price_performance_target, +tags, +workgroup +FROM aws.redshiftserverless.workgroups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workgroup resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.redshiftserverless.workgroups ( + WorkgroupName, + region +) +SELECT +'{{ WorkgroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.redshiftserverless.workgroups ( + WorkgroupName, + NamespaceName, + BaseCapacity, + MaxCapacity, + EnhancedVpcRouting, + ConfigParameters, + SecurityGroupIds, + SubnetIds, + PubliclyAccessible, + Port, + PricePerformanceTarget, + Tags, + region +) +SELECT + '{{ WorkgroupName }}', + '{{ NamespaceName }}', + '{{ BaseCapacity }}', + '{{ MaxCapacity }}', + '{{ EnhancedVpcRouting }}', + '{{ ConfigParameters }}', + '{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ PubliclyAccessible }}', + '{{ Port }}', + '{{ PricePerformanceTarget }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: workgroup + props: + - name: WorkgroupName + value: '{{ WorkgroupName }}' + - name: NamespaceName + value: '{{ NamespaceName }}' + - name: BaseCapacity + value: '{{ BaseCapacity }}' + - name: MaxCapacity + value: '{{ MaxCapacity }}' + - name: EnhancedVpcRouting + value: '{{ EnhancedVpcRouting }}' + - name: ConfigParameters + value: + - ParameterKey: '{{ ParameterKey }}' + ParameterValue: '{{ ParameterValue }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: PubliclyAccessible + value: '{{ PubliclyAccessible }}' + - name: Port + value: '{{ Port }}' + - name: PricePerformanceTarget + value: + Status: '{{ Status }}' + Level: '{{ Level }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.redshiftserverless.workgroups +WHERE data__Identifier = '' +AND 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, +redshift-serverless:GetNamespace, +redshift-serverless:ListTagsForResource, +redshift-serverless:TagResource +``` + +### Read +```json +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets, +ec2:DescribeAccountAttributes, +ec2:DescribeAvailabilityZones, +redshift-serverless:GetWorkgroup, +redshift-serverless:ListTagsForResource +``` + +### 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, +redshift-serverless:ListTagsForResource, +redshift-serverless:TagResource, +redshift-serverless:UntagResource +``` + +### Delete +```json +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets, +ec2:DescribeAccountAttributes, +ec2:DescribeAvailabilityZones, +redshift-serverless:GetWorkgroup, +redshift-serverless:GetNamespace, +redshift-serverless:DeleteWorkgroup, +redshift-serverless:ListTagsForResource, +redshift-serverless:UntagResource +``` + +### List +```json +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets, +ec2:DescribeAccountAttributes, +ec2:DescribeAvailabilityZones, +redshift-serverless:ListWorkgroups, +redshift-serverless:ListTagsForResource +``` diff --git a/website/docs/services/redshiftserverless/workgroups_list_only/index.md b/website/docs/services/redshiftserverless/workgroups_list_only/index.md new file mode 100644 index 0000000..edd623d --- /dev/null +++ b/website/docs/services/redshiftserverless/workgroups_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: workgroups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workgroups_list_only + - redshiftserverless + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workgroups in a region or regions, for all properties use workgroups + +## Overview + + + + + + + +
Nameworkgroups_list_only
TypeResource
DescriptionDefinition of AWS::RedshiftServerless::Workgroup Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the workgroup.
objectDefinition for workgroup resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workgroups in a region. +```sql +SELECT +region, +workgroup_name +FROM aws.redshiftserverless.workgroups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workgroups_list_only resource, see workgroups + diff --git a/website/docs/services/refactorspaces/application_tags/index.md b/website/docs/services/refactorspaces/application_tags/index.md new file mode 100644 index 0000000..ed7543e --- /dev/null +++ b/website/docs/services/refactorspaces/application_tags/index.md @@ -0,0 +1,101 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - refactorspaces + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Application Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +api_gateway_proxy, +arn, +api_gateway_id, +vpc_link_id, +nlb_arn, +nlb_name, +application_identifier, +environment_identifier, +name, +proxy_type, +vpc_id, +stage_name, +proxy_url, +tag_key, +tag_value +FROM aws.refactorspaces.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/refactorspaces/applications/index.md b/website/docs/services/refactorspaces/applications/index.md new file mode 100644 index 0000000..f83a2ba --- /dev/null +++ b/website/docs/services/refactorspaces/applications/index.md @@ -0,0 +1,291 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Application Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
string
string
string
string
string
string
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
+ +For more information, see AWS::RefactorSpaces::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +api_gateway_proxy, +arn, +api_gateway_id, +vpc_link_id, +nlb_arn, +nlb_name, +application_identifier, +environment_identifier, +name, +proxy_type, +vpc_id, +stage_name, +proxy_url, +tags +FROM aws.refactorspaces.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```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.applications +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.refactorspaces.applications ( + EnvironmentIdentifier, + Name, + ProxyType, + VpcId, + region +) +SELECT +'{{ EnvironmentIdentifier }}', + '{{ Name }}', + '{{ ProxyType }}', + '{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.refactorspaces.applications ( + ApiGatewayProxy, + EnvironmentIdentifier, + Name, + ProxyType, + VpcId, + Tags, + region +) +SELECT + '{{ ApiGatewayProxy }}', + '{{ EnvironmentIdentifier }}', + '{{ Name }}', + '{{ ProxyType }}', + '{{ VpcId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: ApiGatewayProxy + value: + StageName: '{{ StageName }}' + EndpointType: '{{ EndpointType }}' + - name: EnvironmentIdentifier + value: '{{ EnvironmentIdentifier }}' + - name: Name + value: '{{ Name }}' + - name: ProxyType + value: '{{ ProxyType }}' + - name: VpcId + value: '{{ VpcId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.refactorspaces.applications +WHERE data__Identifier = '' +AND 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, +elasticloadbalancing:CreateLoadBalancer, +elasticloadbalancing:DescribeLoadBalancers, +elasticloadbalancing:DescribeTags, +elasticloadbalancing:AddTags, +iam:CreateServiceLinkedRole +``` + +### 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:DELETE, +apigateway:GET, +apigateway:PUT, +apigateway:UpdateRestApiPolicy +``` + +### List +```json +refactor-spaces:ListApplications, +refactor-spaces:ListTagsForResource +``` diff --git a/website/docs/services/refactorspaces/applications_list_only/index.md b/website/docs/services/refactorspaces/applications_list_only/index.md new file mode 100644 index 0000000..ca63ec9 --- /dev/null +++ b/website/docs/services/refactorspaces/applications_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Application Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +environment_identifier, +application_identifier +FROM aws.refactorspaces.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/refactorspaces/environment_tags/index.md b/website/docs/services/refactorspaces/environment_tags/index.md new file mode 100644 index 0000000..ef18690 --- /dev/null +++ b/website/docs/services/refactorspaces/environment_tags/index.md @@ -0,0 +1,87 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - refactorspaces + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + + + +
Nameenvironment_tags
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Environment Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +description, +environment_identifier, +name, +network_fabric_type, +arn, +transit_gateway_id, +tag_key, +tag_value +FROM aws.refactorspaces.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + diff --git a/website/docs/services/refactorspaces/environments/index.md b/website/docs/services/refactorspaces/environments/index.md new file mode 100644 index 0000000..43d3014 --- /dev/null +++ b/website/docs/services/refactorspaces/environments/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment resource or lists environments in a region + +## Overview + + + + + + + +
Nameenvironments
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Environment Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
+ +For more information, see AWS::RefactorSpaces::Environment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environments in a region. +```sql +SELECT +region, +description, +environment_identifier, +name, +network_fabric_type, +arn, +transit_gateway_id, +tags +FROM aws.refactorspaces.environments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment. +```sql +SELECT +region, +description, +environment_identifier, +name, +network_fabric_type, +arn, +transit_gateway_id, +tags +FROM aws.refactorspaces.environments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.refactorspaces.environments ( + Description, + Name, + NetworkFabricType, + Tags, + region +) +SELECT +'{{ Description }}', + '{{ Name }}', + '{{ NetworkFabricType }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.refactorspaces.environments ( + Description, + Name, + NetworkFabricType, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ NetworkFabricType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: NetworkFabricType + value: '{{ NetworkFabricType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.refactorspaces.environments +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +refactor-spaces:GetEnvironment, +refactor-spaces:ListTagsForResource +``` + +### Update +```json +refactor-spaces:GetEnvironment, +refactor-spaces:TagResource, +refactor-spaces:UntagResource +``` + +### 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 +``` + +### List +```json +refactor-spaces:ListEnvironments, +refactor-spaces:ListTagsForResource +``` diff --git a/website/docs/services/refactorspaces/environments_list_only/index.md b/website/docs/services/refactorspaces/environments_list_only/index.md new file mode 100644 index 0000000..9354919 --- /dev/null +++ b/website/docs/services/refactorspaces/environments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - refactorspaces + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Environment Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +environment_identifier +FROM aws.refactorspaces.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + diff --git a/website/docs/services/refactorspaces/index.md b/website/docs/services/refactorspaces/index.md new file mode 100644 index 0000000..7dc23f5 --- /dev/null +++ b/website/docs/services/refactorspaces/index.md @@ -0,0 +1,47 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The refactorspaces service documentation. + +:::info Service Summary + +
+
+total resources: 12
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/refactorspaces/route_tags/index.md b/website/docs/services/refactorspaces/route_tags/index.md new file mode 100644 index 0000000..e10669e --- /dev/null +++ b/website/docs/services/refactorspaces/route_tags/index.md @@ -0,0 +1,93 @@ +--- +title: route_tags +hide_title: false +hide_table_of_contents: false +keywords: + - route_tags + - refactorspaces + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for routes in a region + +## Overview + + + + + + + +
Nameroute_tags
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Route Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all routes in a region. +```sql +SELECT +region, +path_resource_to_id, +arn, +application_identifier, +environment_identifier, +route_identifier, +route_type, +service_identifier, +default_route, +uri_path_route, +tag_key, +tag_value +FROM aws.refactorspaces.route_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_tags resource, see routes + diff --git a/website/docs/services/refactorspaces/routes/index.md b/website/docs/services/refactorspaces/routes/index.md new file mode 100644 index 0000000..a874aba --- /dev/null +++ b/website/docs/services/refactorspaces/routes/index.md @@ -0,0 +1,329 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a route resource or lists routes in a region + +## Overview + + + + + + + +
Nameroutes
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Route Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
object
object
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
+ +For more information, see AWS::RefactorSpaces::Route. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all routes in a region. +```sql +SELECT +region, +path_resource_to_id, +arn, +application_identifier, +environment_identifier, +route_identifier, +route_type, +service_identifier, +default_route, +uri_path_route, +tags +FROM aws.refactorspaces.routes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual route. +```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.routes +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.refactorspaces.routes ( + ApplicationIdentifier, + EnvironmentIdentifier, + RouteType, + ServiceIdentifier, + region +) +SELECT +'{{ ApplicationIdentifier }}', + '{{ EnvironmentIdentifier }}', + '{{ RouteType }}', + '{{ ServiceIdentifier }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.refactorspaces.routes ( + ApplicationIdentifier, + EnvironmentIdentifier, + RouteType, + ServiceIdentifier, + DefaultRoute, + UriPathRoute, + Tags, + region +) +SELECT + '{{ ApplicationIdentifier }}', + '{{ EnvironmentIdentifier }}', + '{{ RouteType }}', + '{{ ServiceIdentifier }}', + '{{ DefaultRoute }}', + '{{ UriPathRoute }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: route + props: + - name: ApplicationIdentifier + value: '{{ ApplicationIdentifier }}' + - name: EnvironmentIdentifier + value: '{{ EnvironmentIdentifier }}' + - name: RouteType + value: '{{ RouteType }}' + - name: ServiceIdentifier + value: '{{ ServiceIdentifier }}' + - name: DefaultRoute + value: + ActivationState: '{{ ActivationState }}' + - name: UriPathRoute + value: + SourcePath: '{{ SourcePath }}' + ActivationState: null + Methods: + - '{{ Methods[0] }}' + IncludeChildPaths: '{{ IncludeChildPaths }}' + AppendSourcePath: '{{ AppendSourcePath }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.refactorspaces.routes +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +refactor-spaces:ListRoutes, +refactor-spaces:ListTagsForResource +``` + +### 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/website/docs/services/refactorspaces/routes_list_only/index.md b/website/docs/services/refactorspaces/routes_list_only/index.md new file mode 100644 index 0000000..728e71d --- /dev/null +++ b/website/docs/services/refactorspaces/routes_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - routes_list_only + - refactorspaces + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists routes in a region or regions, for all properties use routes + +## Overview + + + + + + + +
Nameroutes_list_only
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Route Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all routes in a region. +```sql +SELECT +region, +environment_identifier, +application_identifier, +route_identifier +FROM aws.refactorspaces.routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routes_list_only resource, see routes + diff --git a/website/docs/services/refactorspaces/service_tags/index.md b/website/docs/services/refactorspaces/service_tags/index.md new file mode 100644 index 0000000..70e1c8f --- /dev/null +++ b/website/docs/services/refactorspaces/service_tags/index.md @@ -0,0 +1,95 @@ +--- +title: service_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_tags + - refactorspaces + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for services in a region + +## Overview + + + + + + + +
Nameservice_tags
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Service Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all services in a region. +```sql +SELECT +region, +arn, +application_identifier, +description, +endpoint_type, +environment_identifier, +lambda_endpoint, +name, +service_identifier, +url_endpoint, +vpc_id, +tag_key, +tag_value +FROM aws.refactorspaces.service_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_tags resource, see services + diff --git a/website/docs/services/refactorspaces/services/index.md b/website/docs/services/refactorspaces/services/index.md new file mode 100644 index 0000000..872daab --- /dev/null +++ b/website/docs/services/refactorspaces/services/index.md @@ -0,0 +1,283 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service resource or lists services in a region + +## Overview + + + + + + + +
Nameservices
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Service Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
string
string
object
string
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
+ +For more information, see AWS::RefactorSpaces::Service. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all services in a region. +```sql +SELECT +region, +arn, +application_identifier, +description, +endpoint_type, +environment_identifier, +lambda_endpoint, +name, +service_identifier, +url_endpoint, +vpc_id, +tags +FROM aws.refactorspaces.services +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service. +```sql +SELECT +region, +arn, +application_identifier, +description, +endpoint_type, +environment_identifier, +lambda_endpoint, +name, +service_identifier, +url_endpoint, +vpc_id, +tags +FROM aws.refactorspaces.services +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.refactorspaces.services ( + ApplicationIdentifier, + EndpointType, + EnvironmentIdentifier, + Name, + region +) +SELECT +'{{ ApplicationIdentifier }}', + '{{ EndpointType }}', + '{{ EnvironmentIdentifier }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.refactorspaces.services ( + ApplicationIdentifier, + Description, + EndpointType, + EnvironmentIdentifier, + LambdaEndpoint, + Name, + UrlEndpoint, + VpcId, + Tags, + region +) +SELECT + '{{ ApplicationIdentifier }}', + '{{ Description }}', + '{{ EndpointType }}', + '{{ EnvironmentIdentifier }}', + '{{ LambdaEndpoint }}', + '{{ Name }}', + '{{ UrlEndpoint }}', + '{{ VpcId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service + props: + - name: ApplicationIdentifier + value: '{{ ApplicationIdentifier }}' + - name: Description + value: '{{ Description }}' + - name: EndpointType + value: '{{ EndpointType }}' + - name: EnvironmentIdentifier + value: '{{ EnvironmentIdentifier }}' + - name: LambdaEndpoint + value: + Arn: '{{ Arn }}' + - name: Name + value: '{{ Name }}' + - name: UrlEndpoint + value: + HealthUrl: '{{ HealthUrl }}' + Url: '{{ Url }}' + - name: VpcId + value: '{{ VpcId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.refactorspaces.services +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +refactor-spaces: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 +``` + +### List +```json +refactor-spaces:ListServices, +refactor-spaces:ListTagsForResource +``` diff --git a/website/docs/services/refactorspaces/services_list_only/index.md b/website/docs/services/refactorspaces/services_list_only/index.md new file mode 100644 index 0000000..1d77ae5 --- /dev/null +++ b/website/docs/services/refactorspaces/services_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: services_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - services_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists services in a region or regions, for all properties use services + +## Overview + + + + + + + +
Nameservices_list_only
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Service Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all services in a region. +```sql +SELECT +region, +environment_identifier, +application_identifier, +service_identifier +FROM aws.refactorspaces.services_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the services_list_only resource, see services + diff --git a/website/docs/services/rekognition/collection_tags/index.md b/website/docs/services/rekognition/collection_tags/index.md new file mode 100644 index 0000000..756258d --- /dev/null +++ b/website/docs/services/rekognition/collection_tags/index.md @@ -0,0 +1,79 @@ +--- +title: collection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - collection_tags + - rekognition + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for collections in a region + +## Overview + + + + + + + +
Namecollection_tags
TypeResource
DescriptionThe AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the stream processor
stringThe name of the collection
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all collections in a region. +```sql +SELECT +region, +arn, +collection_id, +tag_key, +tag_value +FROM aws.rekognition.collection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collection_tags resource, see collections + diff --git a/website/docs/services/rekognition/collections/index.md b/website/docs/services/rekognition/collections/index.md new file mode 100644 index 0000000..d6843f8 --- /dev/null +++ b/website/docs/services/rekognition/collections/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a collection resource or lists 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
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ARN of the stream processor
stringThe name of the collection
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Rekognition::Collection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all collections in a region. +```sql +SELECT +region, +arn, +collection_id, +tags +FROM aws.rekognition.collections +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual collection. +```sql +SELECT +region, +arn, +collection_id, +tags +FROM aws.rekognition.collections +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new collection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rekognition.collections ( + CollectionId, + region +) +SELECT +'{{ CollectionId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rekognition.collections ( + CollectionId, + Tags, + region +) +SELECT + '{{ CollectionId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: collection + props: + - name: CollectionId + value: '{{ CollectionId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rekognition.collections +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +rekognition:DescribeCollection, +rekognition:ListTagsForResource +``` + +### Update +```json +rekognition:TagResource, +rekognition:UntagResource, +rekognition:DescribeCollection, +rekognition:ListTagsForResource +``` + +### Delete +```json +rekognition:DeleteCollection +``` + +### List +```json +rekognition:ListCollections +``` diff --git a/website/docs/services/rekognition/collections_list_only/index.md b/website/docs/services/rekognition/collections_list_only/index.md new file mode 100644 index 0000000..6356e7d --- /dev/null +++ b/website/docs/services/rekognition/collections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: collections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - collections_list_only + - rekognition + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists collections in a region or regions, for all properties use collections + +## Overview + + + + + + + +
Namecollections_list_only
TypeResource
DescriptionThe AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the collection
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all collections in a region. +```sql +SELECT +region, +collection_id +FROM aws.rekognition.collections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collections_list_only resource, see collections + diff --git a/website/docs/services/rekognition/index.md b/website/docs/services/rekognition/index.md new file mode 100644 index 0000000..2831631 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The rekognition service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/rekognition/projects/index.md b/website/docs/services/rekognition/projects/index.md new file mode 100644 index 0000000..71b13ab --- /dev/null +++ b/website/docs/services/rekognition/projects/index.md @@ -0,0 +1,188 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a project resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ARN of the stream processor
stringThe name of the project
stringAWS region.
+ +For more information, see AWS::Rekognition::Project. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all projects in a region. +```sql +SELECT +region, +arn, +project_name +FROM aws.rekognition.projects +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual project. +```sql +SELECT +region, +arn, +project_name +FROM aws.rekognition.projects +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rekognition.projects ( + ProjectName, + region +) +SELECT +'{{ ProjectName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rekognition.projects ( + ProjectName, + region +) +SELECT + '{{ ProjectName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: project + props: + - name: ProjectName + value: '{{ ProjectName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rekognition.projects +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +```json +rekognition:CreateProject +``` + +### Read +```json +rekognition:DescribeProjects +``` + +### Delete +```json +rekognition:DescribeProjects, +rekognition:DeleteProject +``` + +### List +```json +rekognition:DescribeProjects +``` diff --git a/website/docs/services/rekognition/projects_list_only/index.md b/website/docs/services/rekognition/projects_list_only/index.md new file mode 100644 index 0000000..c33b7d7 --- /dev/null +++ b/website/docs/services/rekognition/projects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + + + +
Nameprojects_list_only
TypeResource
DescriptionThe AWS::Rekognition::Project type creates an Amazon Rekognition CustomLabels Project. A project is a grouping of the resources needed to create and manage Dataset and ProjectVersions.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the project
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +project_name +FROM aws.rekognition.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + diff --git a/website/docs/services/rekognition/stream_processor_tags/index.md b/website/docs/services/rekognition/stream_processor_tags/index.md new file mode 100644 index 0000000..8a1ea15 --- /dev/null +++ b/website/docs/services/rekognition/stream_processor_tags/index.md @@ -0,0 +1,105 @@ +--- +title: stream_processor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stream_processor_tags + - rekognition + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stream_processors in a region + +## Overview + + + + + + + +
Namestream_processor_tags
TypeResource
DescriptionThe AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the stream processor
stringName of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
stringThe KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
stringARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
objectThe Kinesis Video Stream that streams the source video.
objectFace search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both
objectConnected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both
objectThe Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature.
objectThe S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature.
objectThe ARN of the SNS notification channel where events of interests are published, as part of connected home feature.
objectIndicates whether Rekognition is allowed to store the video stream data for model-training.
arrayThe PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
arrayThe BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
stringCurrent status of the stream processor.
stringDetailed status message about the stream processor.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stream_processors in a region. +```sql +SELECT +region, +arn, +name, +kms_key_id, +role_arn, +kinesis_video_stream, +face_search_settings, +connected_home_settings, +kinesis_data_stream, +s3_destination, +notification_channel, +data_sharing_preference, +polygon_regions_of_interest, +bounding_box_regions_of_interest, +status, +status_message, +tag_key, +tag_value +FROM aws.rekognition.stream_processor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_processor_tags resource, see stream_processors + diff --git a/website/docs/services/rekognition/stream_processors/index.md b/website/docs/services/rekognition/stream_processors/index.md new file mode 100644 index 0000000..c9252a6 --- /dev/null +++ b/website/docs/services/rekognition/stream_processors/index.md @@ -0,0 +1,316 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a stream_processor resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the stream processor
stringName of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
stringThe KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
stringARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
objectThe Kinesis Video Stream that streams the source video.
objectFace search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both
objectConnected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both
objectThe Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature.
objectThe S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature.
objectThe ARN of the SNS notification channel where events of interests are published, as part of connected home feature.
objectIndicates whether Rekognition is allowed to store the video stream data for model-training.
arrayThe PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
arrayThe BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
stringCurrent status of the stream processor.
stringDetailed status message about the stream processor.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Rekognition::StreamProcessor. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all stream_processors in a region. +```sql +SELECT +region, +arn, +name, +kms_key_id, +role_arn, +kinesis_video_stream, +face_search_settings, +connected_home_settings, +kinesis_data_stream, +s3_destination, +notification_channel, +data_sharing_preference, +polygon_regions_of_interest, +bounding_box_regions_of_interest, +status, +status_message, +tags +FROM aws.rekognition.stream_processors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual stream_processor. +```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_processors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new stream_processor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rekognition.stream_processors ( + RoleArn, + KinesisVideoStream, + region +) +SELECT +'{{ RoleArn }}', + '{{ KinesisVideoStream }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rekognition.stream_processors ( + Name, + KmsKeyId, + RoleArn, + KinesisVideoStream, + FaceSearchSettings, + ConnectedHomeSettings, + KinesisDataStream, + S3Destination, + NotificationChannel, + DataSharingPreference, + PolygonRegionsOfInterest, + BoundingBoxRegionsOfInterest, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ KmsKeyId }}', + '{{ RoleArn }}', + '{{ KinesisVideoStream }}', + '{{ FaceSearchSettings }}', + '{{ ConnectedHomeSettings }}', + '{{ KinesisDataStream }}', + '{{ S3Destination }}', + '{{ NotificationChannel }}', + '{{ DataSharingPreference }}', + '{{ PolygonRegionsOfInterest }}', + '{{ BoundingBoxRegionsOfInterest }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: stream_processor + props: + - name: Name + value: '{{ Name }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: KinesisVideoStream + value: + Arn: '{{ Arn }}' + - name: FaceSearchSettings + value: + CollectionId: '{{ CollectionId }}' + FaceMatchThreshold: null + - name: ConnectedHomeSettings + value: + Labels: + - '{{ Labels[0] }}' + MinConfidence: null + - name: KinesisDataStream + value: + Arn: '{{ Arn }}' + - name: S3Destination + value: + BucketName: '{{ BucketName }}' + ObjectKeyPrefix: '{{ ObjectKeyPrefix }}' + - name: NotificationChannel + value: + Arn: '{{ Arn }}' + - name: DataSharingPreference + value: + OptIn: '{{ OptIn }}' + - name: PolygonRegionsOfInterest + value: + - - X: null + 'Y': null + - name: BoundingBoxRegionsOfInterest + value: + - Height: null + Width: null + Left: null + Top: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rekognition.stream_processors +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +rekognition:DescribeStreamProcessor, +rekognition:ListTagsForResource +``` + +### Update +```json +rekognition:TagResource, +rekognition:UntagResource, +rekognition:ListTagsForResource, +rekognition:DescribeStreamProcessor +``` + +### Delete +```json +rekognition:DeleteStreamProcessor +``` + +### List +```json +rekognition:ListStreamProcessors +``` diff --git a/website/docs/services/rekognition/stream_processors_list_only/index.md b/website/docs/services/rekognition/stream_processors_list_only/index.md new file mode 100644 index 0000000..5e896ac --- /dev/null +++ b/website/docs/services/rekognition/stream_processors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: stream_processors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stream_processors_list_only + - rekognition + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stream_processors in a region or regions, for all properties use stream_processors + +## Overview + + + + + + + +
Namestream_processors_list_only
TypeResource
DescriptionThe AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stream_processors in a region. +```sql +SELECT +region, +name +FROM aws.rekognition.stream_processors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_processors_list_only resource, see stream_processors + diff --git a/website/docs/services/resiliencehub/app_tags/index.md b/website/docs/services/resiliencehub/app_tags/index.md new file mode 100644 index 0000000..850246a --- /dev/null +++ b/website/docs/services/resiliencehub/app_tags/index.md @@ -0,0 +1,97 @@ +--- +title: app_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_tags + - resiliencehub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for apps in a region + +## Overview + + + + + + + +
Nameapp_tags
TypeResource
DescriptionResource Type Definition for AWS::ResilienceHub::App.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the app.
stringApp description.
stringAmazon Resource Name (ARN) of the App.
stringAmazon Resource Name (ARN) of the Resiliency Policy.
stringAmazon Resource Name (ARN) of the Regulatory Policy.
stringA string containing full ResilienceHub app template body.
arrayAn array of ResourceMapping objects.
stringAssessment execution schedule.
objectDefines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.
arrayThe list of events you would like to subscribe and get notification for.
stringIndicates if compliance drifts (deviations) were detected while running an assessment for your application.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all apps in a region. +```sql +SELECT +region, +name, +description, +app_arn, +resiliency_policy_arn, +regulatory_policy_arn, +app_template_body, +resource_mappings, +app_assessment_schedule, +permission_model, +event_subscriptions, +drift_status, +tag_key, +tag_value +FROM aws.resiliencehub.app_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_tags resource, see apps + diff --git a/website/docs/services/resiliencehub/apps/index.md b/website/docs/services/resiliencehub/apps/index.md new file mode 100644 index 0000000..ab46f00 --- /dev/null +++ b/website/docs/services/resiliencehub/apps/index.md @@ -0,0 +1,349 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an app resource or lists apps in a region + +## Overview + + + + + + + +
Nameapps
TypeResource
DescriptionResource Type Definition for AWS::ResilienceHub::App.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the app.
stringApp description.
stringAmazon Resource Name (ARN) of the App.
stringAmazon Resource Name (ARN) of the Resiliency Policy.
stringAmazon Resource Name (ARN) of the Regulatory Policy.
object
stringA string containing full ResilienceHub app template body.
arrayAn array of ResourceMapping objects.
stringAssessment execution schedule.
objectDefines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.
arrayThe list of events you would like to subscribe and get notification for.
stringIndicates if compliance drifts (deviations) were detected while running an assessment for your application.
stringAWS region.
+ +For more information, see AWS::ResilienceHub::App. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all apps in a region. +```sql +SELECT +region, +name, +description, +app_arn, +resiliency_policy_arn, +regulatory_policy_arn, +tags, +app_template_body, +resource_mappings, +app_assessment_schedule, +permission_model, +event_subscriptions, +drift_status +FROM aws.resiliencehub.apps +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual app. +```sql +SELECT +region, +name, +description, +app_arn, +resiliency_policy_arn, +regulatory_policy_arn, +tags, +app_template_body, +resource_mappings, +app_assessment_schedule, +permission_model, +event_subscriptions, +drift_status +FROM aws.resiliencehub.apps +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new app resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.resiliencehub.apps ( + Name, + AppTemplateBody, + ResourceMappings, + region +) +SELECT +'{{ Name }}', + '{{ AppTemplateBody }}', + '{{ ResourceMappings }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.resiliencehub.apps ( + Name, + Description, + ResiliencyPolicyArn, + RegulatoryPolicyArn, + Tags, + AppTemplateBody, + ResourceMappings, + AppAssessmentSchedule, + PermissionModel, + EventSubscriptions, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ ResiliencyPolicyArn }}', + '{{ RegulatoryPolicyArn }}', + '{{ Tags }}', + '{{ AppTemplateBody }}', + '{{ ResourceMappings }}', + '{{ AppAssessmentSchedule }}', + '{{ PermissionModel }}', + '{{ EventSubscriptions }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: app + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: ResiliencyPolicyArn + value: '{{ ResiliencyPolicyArn }}' + - name: RegulatoryPolicyArn + value: '{{ RegulatoryPolicyArn }}' + - name: Tags + value: {} + - name: AppTemplateBody + value: '{{ AppTemplateBody }}' + - name: ResourceMappings + value: + - LogicalStackName: '{{ LogicalStackName }}' + MappingType: '{{ MappingType }}' + ResourceName: '{{ ResourceName }}' + TerraformSourceName: '{{ TerraformSourceName }}' + EksSourceName: '{{ EksSourceName }}' + PhysicalResourceId: + AwsAccountId: '{{ AwsAccountId }}' + AwsRegion: '{{ AwsRegion }}' + Identifier: '{{ Identifier }}' + Type: '{{ Type }}' + - name: AppAssessmentSchedule + value: '{{ AppAssessmentSchedule }}' + - name: PermissionModel + value: + Type: '{{ Type }}' + InvokerRoleName: '{{ InvokerRoleName }}' + CrossAccountRoleArns: + - '{{ CrossAccountRoleArns[0] }}' + - name: EventSubscriptions + value: + - Name: '{{ Name }}' + EventType: '{{ EventType }}' + SnsTopicArn: '{{ SnsTopicArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.resiliencehub.apps +WHERE data__Identifier = '' +AND 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:CreateApp, +resiliencehub:DescribeApp, +resiliencehub:DescribeAppVersionTemplate, +resiliencehub:PutDraftAppVersionTemplate, +resiliencehub:AddDraftAppVersionResourceMappings, +resiliencehub:ListAppVersionResourceMappings, +resiliencehub:ListAppVersions, +resiliencehub:PublishAppVersion, +resiliencehub:ListTagsForResource, +resiliencehub:TagResource, +resiliencehub:UntagResource +``` + +### Read +```json +resiliencehub:DescribeApp, +resiliencehub:DescribeAppVersionTemplate, +resiliencehub:ListAppVersionResourceMappings, +resiliencehub:ListTagsForResource, +resiliencehub:ListAppVersions +``` + +### 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:UpdateApp, +resiliencehub:DescribeApp, +resiliencehub:DescribeAppVersionTemplate, +resiliencehub:PutDraftAppVersionTemplate, +resiliencehub:AddDraftAppVersionResourceMappings, +resiliencehub:RemoveDraftAppVersionResourceMappings, +resiliencehub:ListAppVersionResourceMappings, +resiliencehub:ListAppVersions, +resiliencehub:PublishAppVersion, +resiliencehub:ListTagsForResource, +resiliencehub:TagResource, +resiliencehub:UntagResource +``` + +### Delete +```json +resiliencehub:DeleteApp, +resiliencehub:UntagResource, +resiliencehub:ListApps +``` + +### List +```json +resiliencehub:ListApps +``` diff --git a/website/docs/services/resiliencehub/apps_list_only/index.md b/website/docs/services/resiliencehub/apps_list_only/index.md new file mode 100644 index 0000000..fc1812e --- /dev/null +++ b/website/docs/services/resiliencehub/apps_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: apps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - apps_list_only + - resiliencehub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists apps in a region or regions, for all properties use apps + +## Overview + + + + + + + +
Nameapps_list_only
TypeResource
DescriptionResource Type Definition for AWS::ResilienceHub::App.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN) of the App.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all apps in a region. +```sql +SELECT +region, +app_arn +FROM aws.resiliencehub.apps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the apps_list_only resource, see apps + diff --git a/website/docs/services/resiliencehub/index.md b/website/docs/services/resiliencehub/index.md new file mode 100644 index 0000000..5784f30 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The resiliencehub service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/resiliencehub/resiliency_policies/index.md b/website/docs/services/resiliencehub/resiliency_policies/index.md new file mode 100644 index 0000000..8df6211 --- /dev/null +++ b/website/docs/services/resiliencehub/resiliency_policies/index.md @@ -0,0 +1,250 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resiliency_policy resource or lists resiliency_policies in a region + +## Overview + + + + + + + +
Nameresiliency_policies
TypeResource
DescriptionResource Type Definition for Resiliency Policy.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of Resiliency Policy.
stringDescription of Resiliency Policy.
stringData Location Constraint of the Policy.
stringResiliency Policy Tier.
object
stringAmazon Resource Name (ARN) of the Resiliency Policy.
object
stringAWS region.
+ +For more information, see AWS::ResilienceHub::ResiliencyPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resiliency_policies in a region. +```sql +SELECT +region, +policy_name, +policy_description, +data_location_constraint, +tier, +policy, +policy_arn, +tags +FROM aws.resiliencehub.resiliency_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resiliency_policy. +```sql +SELECT +region, +policy_name, +policy_description, +data_location_constraint, +tier, +policy, +policy_arn, +tags +FROM aws.resiliencehub.resiliency_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resiliency_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.resiliencehub.resiliency_policies ( + PolicyName, + Tier, + Policy, + region +) +SELECT +'{{ PolicyName }}', + '{{ Tier }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.resiliencehub.resiliency_policies ( + PolicyName, + PolicyDescription, + DataLocationConstraint, + Tier, + Policy, + Tags, + region +) +SELECT + '{{ PolicyName }}', + '{{ PolicyDescription }}', + '{{ DataLocationConstraint }}', + '{{ Tier }}', + '{{ Policy }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resiliency_policy + props: + - name: PolicyName + value: '{{ PolicyName }}' + - name: PolicyDescription + value: '{{ PolicyDescription }}' + - name: DataLocationConstraint + value: '{{ DataLocationConstraint }}' + - name: Tier + value: '{{ Tier }}' + - name: Policy + value: + AZ: + RtoInSecs: '{{ RtoInSecs }}' + RpoInSecs: '{{ RpoInSecs }}' + Hardware: null + Software: null + Region: null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.resiliencehub.resiliency_policies +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +resiliencehub:DescribeResiliencyPolicy, +resiliencehub:UpdateResiliencyPolicy, +resiliencehub:TagResource, +resiliencehub:UntagResource, +resiliencehub:ListTagsForResource +``` + +### Read +```json +resiliencehub:DescribeResiliencyPolicy, +resiliencehub:ListTagsForResource +``` + +### Delete +```json +resiliencehub:DeleteResiliencyPolicy, +resiliencehub:UntagResource +``` + +### List +```json +resiliencehub:ListResiliencyPolicies +``` diff --git a/website/docs/services/resiliencehub/resiliency_policies_list_only/index.md b/website/docs/services/resiliencehub/resiliency_policies_list_only/index.md new file mode 100644 index 0000000..f5af6a7 --- /dev/null +++ b/website/docs/services/resiliencehub/resiliency_policies_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: resiliency_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resiliency_policies_list_only + - resiliencehub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resiliency_policies in a region or regions, for all properties use resiliency_policies + +## Overview + + + + + + + +
Nameresiliency_policies_list_only
TypeResource
DescriptionResource Type Definition for Resiliency Policy.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
object
stringAmazon Resource Name (ARN) of the Resiliency Policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resiliency_policies in a region. +```sql +SELECT +region, +policy_arn +FROM aws.resiliencehub.resiliency_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resiliency_policies_list_only resource, see resiliency_policies + diff --git a/website/docs/services/resiliencehub/resiliency_policy_tags/index.md b/website/docs/services/resiliencehub/resiliency_policy_tags/index.md new file mode 100644 index 0000000..28d841c --- /dev/null +++ b/website/docs/services/resiliencehub/resiliency_policy_tags/index.md @@ -0,0 +1,87 @@ +--- +title: resiliency_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resiliency_policy_tags + - resiliencehub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resiliency_policies in a region + +## Overview + + + + + + + +
Nameresiliency_policy_tags
TypeResource
DescriptionResource Type Definition for Resiliency Policy.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringName of Resiliency Policy.
stringDescription of Resiliency Policy.
stringData Location Constraint of the Policy.
stringResiliency Policy Tier.
object
stringAmazon Resource Name (ARN) of the Resiliency Policy.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resiliency_policies in a region. +```sql +SELECT +region, +policy_name, +policy_description, +data_location_constraint, +tier, +policy, +policy_arn, +tag_key, +tag_value +FROM aws.resiliencehub.resiliency_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resiliency_policy_tags resource, see resiliency_policies + diff --git a/website/docs/services/resourceexplorer2/default_view_associations/index.md b/website/docs/services/resourceexplorer2/default_view_associations/index.md new file mode 100644 index 0000000..661f061 --- /dev/null +++ b/website/docs/services/resourceexplorer2/default_view_associations/index.md @@ -0,0 +1,182 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a default_view_association resource or lists default_view_associations in a region + +## Overview + + + + + + + +
Namedefault_view_associations
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::DefaultViewAssociation Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe AWS principal that the default view is associated with, used as the unique identifier for this resource.
stringAWS region.
+ +For more information, see AWS::ResourceExplorer2::DefaultViewAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual default_view_association. +```sql +SELECT +region, +view_arn, +associated_aws_principal +FROM aws.resourceexplorer2.default_view_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new default_view_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.resourceexplorer2.default_view_associations ( + ViewArn, + region +) +SELECT +'{{ ViewArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.resourceexplorer2.default_view_associations ( + ViewArn, + region +) +SELECT + '{{ ViewArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: default_view_association + props: + - name: ViewArn + value: '{{ ViewArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.resourceexplorer2.default_view_associations +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/resourceexplorer2/index.md b/website/docs/services/resourceexplorer2/index.md new file mode 100644 index 0000000..3508a0f --- /dev/null +++ b/website/docs/services/resourceexplorer2/index.md @@ -0,0 +1,42 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The resourceexplorer2 service documentation. + +:::info Service Summary + +
+
+total resources: 7
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/resourceexplorer2/index_tags/index.md b/website/docs/services/resourceexplorer2/index_tags/index.md new file mode 100644 index 0000000..0a6e666 --- /dev/null +++ b/website/docs/services/resourceexplorer2/index_tags/index.md @@ -0,0 +1,81 @@ +--- +title: index_tags +hide_title: false +hide_table_of_contents: false +keywords: + - index_tags + - resourceexplorer2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for indices in a region + +## Overview + + + + + + + +
Nameindex_tags
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::Index Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all indices in a region. +```sql +SELECT +region, +arn, +type, +index_state, +tag_key, +tag_value +FROM aws.resourceexplorer2.index_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the index_tags resource, see indices + diff --git a/website/docs/services/resourceexplorer2/indices/index.md b/website/docs/services/resourceexplorer2/indices/index.md new file mode 100644 index 0000000..7c4ce97 --- /dev/null +++ b/website/docs/services/resourceexplorer2/indices/index.md @@ -0,0 +1,218 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an index resource or lists indices in a region + +## Overview + + + + + + + +
Nameindices
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::Index Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
object
string
string
stringAWS region.
+ +For more information, see AWS::ResourceExplorer2::Index. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all indices in a region. +```sql +SELECT +region, +arn, +tags, +type, +index_state +FROM aws.resourceexplorer2.indices +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual index. +```sql +SELECT +region, +arn, +tags, +type, +index_state +FROM aws.resourceexplorer2.indices +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new index resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.resourceexplorer2.indices ( + Type, + region +) +SELECT +'{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.resourceexplorer2.indices ( + Tags, + Type, + region +) +SELECT + '{{ Tags }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: index + props: + - name: Tags + value: {} + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.resourceexplorer2.indices +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +resource-explorer-2:ListIndexes +``` + +### Read +```json +resource-explorer-2:GetIndex +``` diff --git a/website/docs/services/resourceexplorer2/indices_list_only/index.md b/website/docs/services/resourceexplorer2/indices_list_only/index.md new file mode 100644 index 0000000..11e724e --- /dev/null +++ b/website/docs/services/resourceexplorer2/indices_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: indices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - indices_list_only + - resourceexplorer2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists indices in a region or regions, for all properties use indices + +## Overview + + + + + + + +
Nameindices_list_only
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::Index Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all indices in a region. +```sql +SELECT +region, +arn +FROM aws.resourceexplorer2.indices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the indices_list_only resource, see indices + diff --git a/website/docs/services/resourceexplorer2/view_tags/index.md b/website/docs/services/resourceexplorer2/view_tags/index.md new file mode 100644 index 0000000..ac664e6 --- /dev/null +++ b/website/docs/services/resourceexplorer2/view_tags/index.md @@ -0,0 +1,85 @@ +--- +title: view_tags +hide_title: false +hide_table_of_contents: false +keywords: + - view_tags + - resourceexplorer2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for views in a region + +## Overview + + + + + + + +
Nameview_tags
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::View Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all views in a region. +```sql +SELECT +region, +filters, +included_properties, +scope, +view_arn, +view_name, +tag_key, +tag_value +FROM aws.resourceexplorer2.view_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the view_tags resource, see views + diff --git a/website/docs/services/resourceexplorer2/views/index.md b/website/docs/services/resourceexplorer2/views/index.md new file mode 100644 index 0000000..04983a1 --- /dev/null +++ b/website/docs/services/resourceexplorer2/views/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a view resource or lists views in a region + +## Overview + + + + + + + +
Nameviews
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::View Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
object
array
string
object
string
string
stringAWS region.
+ +For more information, see AWS::ResourceExplorer2::View. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all views in a region. +```sql +SELECT +region, +filters, +included_properties, +scope, +tags, +view_arn, +view_name +FROM aws.resourceexplorer2.views +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual view. +```sql +SELECT +region, +filters, +included_properties, +scope, +tags, +view_arn, +view_name +FROM aws.resourceexplorer2.views +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new view resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.resourceexplorer2.views ( + ViewName, + region +) +SELECT +'{{ ViewName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.resourceexplorer2.views ( + Filters, + IncludedProperties, + Scope, + Tags, + ViewName, + region +) +SELECT + '{{ Filters }}', + '{{ IncludedProperties }}', + '{{ Scope }}', + '{{ Tags }}', + '{{ ViewName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: view + props: + - name: Filters + value: + FilterString: '{{ FilterString }}' + - name: IncludedProperties + value: + - Name: '{{ Name }}' + - name: Scope + value: '{{ Scope }}' + - name: Tags + value: {} + - name: ViewName + value: '{{ ViewName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.resourceexplorer2.views +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +resource-explorer-2:ListViews +``` diff --git a/website/docs/services/resourceexplorer2/views_list_only/index.md b/website/docs/services/resourceexplorer2/views_list_only/index.md new file mode 100644 index 0000000..07ef505 --- /dev/null +++ b/website/docs/services/resourceexplorer2/views_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: views_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - views_list_only + - resourceexplorer2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists views in a region or regions, for all properties use views + +## Overview + + + + + + + +
Nameviews_list_only
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::View Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all views in a region. +```sql +SELECT +region, +view_arn +FROM aws.resourceexplorer2.views_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the views_list_only resource, see views + diff --git a/website/docs/services/resourcegroups/group_tags/index.md b/website/docs/services/resourcegroups/group_tags/index.md new file mode 100644 index 0000000..ce28fa8 --- /dev/null +++ b/website/docs/services/resourcegroups/group_tags/index.md @@ -0,0 +1,87 @@ +--- +title: group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - group_tags + - resourcegroups + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for groups in a region + +## Overview + + + + + + + +
Namegroup_tags
TypeResource
DescriptionSchema for ResourceGroups::Group
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource group
stringThe description of the resource group
object
stringThe Resource Group ARN.
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all groups in a region. +```sql +SELECT +region, +name, +description, +resource_query, +arn, +configuration, +resources, +tag_key, +tag_value +FROM aws.resourcegroups.group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the group_tags resource, see groups + diff --git a/website/docs/services/resourcegroups/groups/index.md b/website/docs/services/resourcegroups/groups/index.md new file mode 100644 index 0000000..85b03ad --- /dev/null +++ b/website/docs/services/resourcegroups/groups/index.md @@ -0,0 +1,269 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a group resource or lists groups in a region + +## Overview + + + + + + + +
Namegroups
TypeResource
DescriptionSchema for ResourceGroups::Group
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource group
stringThe description of the resource group
object
array
stringThe Resource Group ARN.
array
array
stringAWS region.
+ +For more information, see AWS::ResourceGroups::Group. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all groups in a region. +```sql +SELECT +region, +name, +description, +resource_query, +tags, +arn, +configuration, +resources +FROM aws.resourcegroups.groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual group. +```sql +SELECT +region, +name, +description, +resource_query, +tags, +arn, +configuration, +resources +FROM aws.resourcegroups.groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.resourcegroups.groups ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.resourcegroups.groups ( + Name, + Description, + ResourceQuery, + Tags, + Configuration, + Resources, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ ResourceQuery }}', + '{{ Tags }}', + '{{ Configuration }}', + '{{ Resources }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: group + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: ResourceQuery + value: + Type: '{{ Type }}' + Query: + ResourceTypeFilters: + - '{{ ResourceTypeFilters[0] }}' + StackIdentifier: '{{ StackIdentifier }}' + TagFilters: + - Key: '{{ Key }}' + Values: + - '{{ Values[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Configuration + value: + - Type: '{{ Type }}' + Parameters: + - Name: '{{ Name }}' + Values: + - '{{ Values[0] }}' + - name: Resources + value: + - '{{ Resources[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.resourcegroups.groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +resource-groups:ListGroups +``` diff --git a/website/docs/services/resourcegroups/groups_list_only/index.md b/website/docs/services/resourcegroups/groups_list_only/index.md new file mode 100644 index 0000000..691ddf5 --- /dev/null +++ b/website/docs/services/resourcegroups/groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - groups_list_only + - resourcegroups + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists groups in a region or regions, for all properties use groups + +## Overview + + + + + + + +
Namegroups_list_only
TypeResource
DescriptionSchema for ResourceGroups::Group
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the resource group
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all groups in a region. +```sql +SELECT +region, +name +FROM aws.resourcegroups.groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the groups_list_only resource, see groups + diff --git a/website/docs/services/resourcegroups/index.md b/website/docs/services/resourcegroups/index.md new file mode 100644 index 0000000..015ab9c --- /dev/null +++ b/website/docs/services/resourcegroups/index.md @@ -0,0 +1,40 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The resourcegroups service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/resourcegroups/tag_sync_tasks/index.md b/website/docs/services/resourcegroups/tag_sync_tasks/index.md new file mode 100644 index 0000000..7a5bf1b --- /dev/null +++ b/website/docs/services/resourcegroups/tag_sync_tasks/index.md @@ -0,0 +1,226 @@ +--- +title: tag_sync_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - tag_sync_tasks + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a tag_sync_task resource or lists tag_sync_tasks in a region + +## Overview + + + + + + + +
Nametag_sync_tasks
TypeResource
DescriptionSchema for ResourceGroups::TagSyncTask
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task
stringThe Amazon resource name (ARN) of the ApplicationGroup for which the TagSyncTask is created
stringThe Name of the application group for which the TagSyncTask is created
stringThe ARN of the TagSyncTask resource
stringThe tag key. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application.
stringThe tag value. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application.
stringThe Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
stringThe status of the TagSyncTask
stringAWS region.
+ +For more information, see AWS::ResourceGroups::TagSyncTask. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all tag_sync_tasks in a region. +```sql +SELECT +region, +group, +group_arn, +group_name, +task_arn, +tag_key, +tag_value, +role_arn, +status +FROM aws.resourcegroups.tag_sync_tasks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual tag_sync_task. +```sql +SELECT +region, +group, +group_arn, +group_name, +task_arn, +tag_key, +tag_value, +role_arn, +status +FROM aws.resourcegroups.tag_sync_tasks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tag_sync_task resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.resourcegroups.tag_sync_tasks ( + Group, + TagKey, + TagValue, + RoleArn, + region +) +SELECT +'{{ Group }}', + '{{ TagKey }}', + '{{ TagValue }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.resourcegroups.tag_sync_tasks ( + Group, + TagKey, + TagValue, + RoleArn, + region +) +SELECT + '{{ Group }}', + '{{ TagKey }}', + '{{ TagValue }}', + '{{ RoleArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: tag_sync_task + props: + - name: Group + value: '{{ Group }}' + - name: TagKey + value: '{{ TagKey }}' + - name: TagValue + value: '{{ TagValue }}' + - name: RoleArn + value: '{{ RoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.resourcegroups.tag_sync_tasks +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the tag_sync_tasks resource, the following permissions are required: + +### Create +```json +resource-groups:StartTagSyncTask, +resource-groups:CreateGroup, +iam:PassRole +``` + +### Read +```json +resource-groups:GetTagSyncTask +``` + +### Delete +```json +resource-groups:CancelTagSyncTask, +resource-groups:DeleteGroup +``` + +### List +```json +resource-groups:ListTagSyncTasks +``` diff --git a/website/docs/services/resourcegroups/tag_sync_tasks_list_only/index.md b/website/docs/services/resourcegroups/tag_sync_tasks_list_only/index.md new file mode 100644 index 0000000..769d509 --- /dev/null +++ b/website/docs/services/resourcegroups/tag_sync_tasks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: tag_sync_tasks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tag_sync_tasks_list_only + - resourcegroups + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tag_sync_tasks in a region or regions, for all properties use tag_sync_tasks + +## Overview + + + + + + + +
Nametag_sync_tasks_list_only
TypeResource
DescriptionSchema for ResourceGroups::TagSyncTask
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the TagSyncTask resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tag_sync_tasks in a region. +```sql +SELECT +region, +task_arn +FROM aws.resourcegroups.tag_sync_tasks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tag_sync_tasks_list_only resource, see tag_sync_tasks + diff --git a/website/docs/services/robomaker/fleet_tags/index.md b/website/docs/services/robomaker/fleet_tags/index.md new file mode 100644 index 0000000..a046e04 --- /dev/null +++ b/website/docs/services/robomaker/fleet_tags/index.md @@ -0,0 +1,79 @@ +--- +title: fleet_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_tags + - robomaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fleets in a region + +## Overview + + + + + + + +
Namefleet_tags
TypeResource
DescriptionAWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the fleet.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fleets in a region. +```sql +SELECT +region, +arn, +name, +tag_key, +tag_value +FROM aws.robomaker.fleet_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_tags resource, see fleets + diff --git a/website/docs/services/robomaker/fleets/index.md b/website/docs/services/robomaker/fleets/index.md new file mode 100644 index 0000000..c390944 --- /dev/null +++ b/website/docs/services/robomaker/fleets/index.md @@ -0,0 +1,205 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a fleet resource or lists fleets in a region + +## Overview + + + + + + + +
Namefleets
TypeResource
DescriptionAWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
objectA key-value pair to associate with a resource.
stringThe name of the fleet.
stringAWS region.
+ +For more information, see AWS::RoboMaker::Fleet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all fleets in a region. +```sql +SELECT +region, +arn, +tags, +name +FROM aws.robomaker.fleets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual fleet. +```sql +SELECT +region, +arn, +tags, +name +FROM aws.robomaker.fleets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.fleets ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.fleets ( + Tags, + Name, + region +) +SELECT + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: fleet + props: + - name: Tags + value: {} + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.robomaker.fleets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +```json +robomaker:CreateFleet +``` + +### Read +```json +robomaker:DescribeFleet +``` + +### Delete +```json +robomaker:DeleteFleet +``` + +### Update +```json +robomaker:TagResource, +robomaker:UntagResource +``` + +### List +```json +robomaker:ListFleets +``` diff --git a/website/docs/services/robomaker/fleets_list_only/index.md b/website/docs/services/robomaker/fleets_list_only/index.md new file mode 100644 index 0000000..8b76166 --- /dev/null +++ b/website/docs/services/robomaker/fleets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleets_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleets in a region or regions, for all properties use fleets + +## Overview + + + + + + + +
Namefleets_list_only
TypeResource
DescriptionAWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleets in a region. +```sql +SELECT +region, +arn +FROM aws.robomaker.fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleets_list_only resource, see fleets + diff --git a/website/docs/services/robomaker/index.md b/website/docs/services/robomaker/index.md new file mode 100644 index 0000000..f620d65 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The robomaker service documentation. + +:::info Service Summary + +
+
+total resources: 14
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/robomaker/robot_application_tags/index.md b/website/docs/services/robomaker/robot_application_tags/index.md new file mode 100644 index 0000000..ccd8c2c --- /dev/null +++ b/website/docs/services/robomaker/robot_application_tags/index.md @@ -0,0 +1,87 @@ +--- +title: robot_application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - robot_application_tags + - robomaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for robot_applications in a region + +## Overview + + + + + + + +
Namerobot_application_tags
TypeResource
DescriptionThis schema is for testing purpose only.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the robot application.
arrayThe sources of the robot application.
stringThe URI of the Docker image for the robot application.
objectInformation about a robot software suite.
stringThe revision ID of robot application.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all robot_applications in a region. +```sql +SELECT +region, +name, +sources, +environment, +robot_software_suite, +current_revision_id, +arn, +tag_key, +tag_value +FROM aws.robomaker.robot_application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the robot_application_tags resource, see robot_applications + diff --git a/website/docs/services/robomaker/robot_application_versions/index.md b/website/docs/services/robomaker/robot_application_versions/index.md new file mode 100644 index 0000000..606e77b --- /dev/null +++ b/website/docs/services/robomaker/robot_application_versions/index.md @@ -0,0 +1,184 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a robot_application_version resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringThe revision ID of robot application.
string
string
stringAWS region.
+ +For more information, see AWS::RoboMaker::RobotApplicationVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual robot_application_version. +```sql +SELECT +region, +application, +current_revision_id, +application_version, +arn +FROM aws.robomaker.robot_application_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new robot_application_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.robot_application_versions ( + Application, + region +) +SELECT +'{{ Application }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.robot_application_versions ( + Application, + CurrentRevisionId, + region +) +SELECT + '{{ Application }}', + '{{ CurrentRevisionId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: robot_application_version + props: + - name: Application + value: '{{ Application }}' + - name: CurrentRevisionId + value: '{{ CurrentRevisionId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.robomaker.robot_application_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +robomaker:DeleteRobotApplication, +robomaker:DescribeRobotApplication +``` + +### Read +```json +robomaker:DescribeRobotApplication +``` diff --git a/website/docs/services/robomaker/robot_applications/index.md b/website/docs/services/robomaker/robot_applications/index.md new file mode 100644 index 0000000..1dca5c5 --- /dev/null +++ b/website/docs/services/robomaker/robot_applications/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a robot_application resource or lists robot_applications in a region + +## Overview + + + + + + + +
Namerobot_applications
TypeResource
DescriptionThis schema is for testing purpose only.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the robot application.
arrayThe sources of the robot application.
stringThe URI of the Docker image for the robot application.
objectInformation about a robot software suite.
stringThe revision ID of robot application.
string
objectA key-value pair to associate with a resource.
stringAWS region.
+ +For more information, see AWS::RoboMaker::RobotApplication. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all robot_applications in a region. +```sql +SELECT +region, +name, +sources, +environment, +robot_software_suite, +current_revision_id, +arn, +tags +FROM aws.robomaker.robot_applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual robot_application. +```sql +SELECT +region, +name, +sources, +environment, +robot_software_suite, +current_revision_id, +arn, +tags +FROM aws.robomaker.robot_applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new robot_application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.robot_applications ( + RobotSoftwareSuite, + region +) +SELECT +'{{ RobotSoftwareSuite }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.robot_applications ( + Name, + Sources, + Environment, + RobotSoftwareSuite, + CurrentRevisionId, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Sources }}', + '{{ Environment }}', + '{{ RobotSoftwareSuite }}', + '{{ CurrentRevisionId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: robot_application + props: + - name: Name + value: '{{ Name }}' + - name: Sources + value: + - S3Bucket: '{{ S3Bucket }}' + S3Key: '{{ S3Key }}' + Architecture: '{{ Architecture }}' + - name: Environment + value: '{{ Environment }}' + - name: RobotSoftwareSuite + value: + Name: '{{ Name }}' + Version: '{{ Version }}' + - name: CurrentRevisionId + value: '{{ CurrentRevisionId }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.robomaker.robot_applications +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +robomaker:ListRobotApplications +``` diff --git a/website/docs/services/robomaker/robot_applications_list_only/index.md b/website/docs/services/robomaker/robot_applications_list_only/index.md new file mode 100644 index 0000000..8e3423f --- /dev/null +++ b/website/docs/services/robomaker/robot_applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: robot_applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - robot_applications_list_only + - robomaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists robot_applications in a region or regions, for all properties use robot_applications + +## Overview + + + + + + + +
Namerobot_applications_list_only
TypeResource
DescriptionThis schema is for testing purpose only.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all robot_applications in a region. +```sql +SELECT +region, +arn +FROM aws.robomaker.robot_applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the robot_applications_list_only resource, see robot_applications + diff --git a/website/docs/services/robomaker/robot_tags/index.md b/website/docs/services/robomaker/robot_tags/index.md new file mode 100644 index 0000000..41e7d7a --- /dev/null +++ b/website/docs/services/robomaker/robot_tags/index.md @@ -0,0 +1,85 @@ +--- +title: robot_tags +hide_title: false +hide_table_of_contents: false +keywords: + - robot_tags + - robomaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for robots in a region + +## Overview + + + + + + + +
Namerobot_tags
TypeResource
DescriptionAWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe Amazon Resource Name (ARN) of the fleet.
stringThe target architecture of the robot.
stringThe Greengrass group id.
stringThe name for the robot.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all robots in a region. +```sql +SELECT +region, +arn, +fleet, +architecture, +greengrass_group_id, +name, +tag_key, +tag_value +FROM aws.robomaker.robot_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the robot_tags resource, see robots + diff --git a/website/docs/services/robomaker/robots/index.md b/website/docs/services/robomaker/robots/index.md new file mode 100644 index 0000000..4745947 --- /dev/null +++ b/website/docs/services/robomaker/robots/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a robot resource or lists robots in a region + +## Overview + + + + + + + +
Namerobots
TypeResource
DescriptionAWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringThe Amazon Resource Name (ARN) of the fleet.
stringThe target architecture of the robot.
stringThe Greengrass group id.
objectA key-value pair to associate with a resource.
stringThe name for the robot.
stringAWS region.
+ +For more information, see AWS::RoboMaker::Robot. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all robots in a region. +```sql +SELECT +region, +arn, +fleet, +architecture, +greengrass_group_id, +tags, +name +FROM aws.robomaker.robots +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual robot. +```sql +SELECT +region, +arn, +fleet, +architecture, +greengrass_group_id, +tags, +name +FROM aws.robomaker.robots +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new robot resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.robots ( + Architecture, + GreengrassGroupId, + region +) +SELECT +'{{ Architecture }}', + '{{ GreengrassGroupId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.robots ( + Fleet, + Architecture, + GreengrassGroupId, + Tags, + Name, + region +) +SELECT + '{{ Fleet }}', + '{{ Architecture }}', + '{{ GreengrassGroupId }}', + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: robot + props: + - name: Fleet + value: '{{ Fleet }}' + - name: Architecture + value: '{{ Architecture }}' + - name: GreengrassGroupId + value: '{{ GreengrassGroupId }}' + - name: Tags + value: {} + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.robomaker.robots +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the robots resource, the following permissions are required: + +### Create +```json +robomaker:CreateRobot, +robomaker:RegisterRobot +``` + +### Read +```json +robomaker:DescribeRobot +``` + +### Delete +```json +robomaker:DescribeRobot, +robomaker:DeleteRobot, +robomaker:DeregisterRobot +``` + +### List +```json +robomaker:ListRobots +``` + +### Update +```json +robomaker:TagResource, +robomaker:UntagResource +``` diff --git a/website/docs/services/robomaker/robots_list_only/index.md b/website/docs/services/robomaker/robots_list_only/index.md new file mode 100644 index 0000000..53e088c --- /dev/null +++ b/website/docs/services/robomaker/robots_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: robots_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - robots_list_only + - robomaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists robots in a region or regions, for all properties use robots + +## Overview + + + + + + + +
Namerobots_list_only
TypeResource
DescriptionAWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all robots in a region. +```sql +SELECT +region, +arn +FROM aws.robomaker.robots_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the robots_list_only resource, see robots + diff --git a/website/docs/services/robomaker/simulation_application_tags/index.md b/website/docs/services/robomaker/simulation_application_tags/index.md new file mode 100644 index 0000000..14bfb6f --- /dev/null +++ b/website/docs/services/robomaker/simulation_application_tags/index.md @@ -0,0 +1,91 @@ +--- +title: simulation_application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - simulation_application_tags + - robomaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for simulation_applications in a region + +## Overview + + + + + + + +
Namesimulation_application_tags
TypeResource
DescriptionThis schema is for testing purpose only.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the simulation application.
stringThe current revision id.
objectThe rendering engine for the simulation application.
objectThe robot software suite used by the simulation application.
objectThe simulation software suite used by the simulation application.
arrayThe sources of the simulation application.
stringThe URI of the Docker image for the robot application.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all simulation_applications in a region. +```sql +SELECT +region, +arn, +name, +current_revision_id, +rendering_engine, +robot_software_suite, +simulation_software_suite, +sources, +environment, +tag_key, +tag_value +FROM aws.robomaker.simulation_application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the simulation_application_tags resource, see simulation_applications + diff --git a/website/docs/services/robomaker/simulation_application_versions/index.md b/website/docs/services/robomaker/simulation_application_versions/index.md new file mode 100644 index 0000000..90c0122 --- /dev/null +++ b/website/docs/services/robomaker/simulation_application_versions/index.md @@ -0,0 +1,184 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a simulation_application_version resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringThe revision ID of robot application.
string
string
stringAWS region.
+ +For more information, see AWS::RoboMaker::SimulationApplicationVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual simulation_application_version. +```sql +SELECT +region, +application, +current_revision_id, +application_version, +arn +FROM aws.robomaker.simulation_application_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new simulation_application_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.simulation_application_versions ( + Application, + region +) +SELECT +'{{ Application }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.simulation_application_versions ( + Application, + CurrentRevisionId, + region +) +SELECT + '{{ Application }}', + '{{ CurrentRevisionId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: simulation_application_version + props: + - name: Application + value: '{{ Application }}' + - name: CurrentRevisionId + value: '{{ CurrentRevisionId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.robomaker.simulation_application_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +robomaker:DeleteSimulationApplication, +robomaker:DescribeSimulationApplication +``` + +### Read +```json +robomaker:DescribeSimulationApplication +``` diff --git a/website/docs/services/robomaker/simulation_applications/index.md b/website/docs/services/robomaker/simulation_applications/index.md new file mode 100644 index 0000000..e809b07 --- /dev/null +++ b/website/docs/services/robomaker/simulation_applications/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a simulation_application resource or lists simulation_applications in a region + +## Overview + + + + + + + +
Namesimulation_applications
TypeResource
DescriptionThis schema is for testing purpose only.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the simulation application.
stringThe current revision id.
objectThe rendering engine for the simulation application.
objectThe robot software suite used by the simulation application.
objectThe simulation software suite used by the simulation application.
arrayThe sources of the simulation application.
stringThe URI of the Docker image for the robot application.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +For more information, see AWS::RoboMaker::SimulationApplication. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all simulation_applications in a region. +```sql +SELECT +region, +arn, +name, +current_revision_id, +rendering_engine, +robot_software_suite, +simulation_software_suite, +sources, +environment, +tags +FROM aws.robomaker.simulation_applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual simulation_application. +```sql +SELECT +region, +arn, +name, +current_revision_id, +rendering_engine, +robot_software_suite, +simulation_software_suite, +sources, +environment, +tags +FROM aws.robomaker.simulation_applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new simulation_application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.simulation_applications ( + RobotSoftwareSuite, + SimulationSoftwareSuite, + region +) +SELECT +'{{ RobotSoftwareSuite }}', + '{{ SimulationSoftwareSuite }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.robomaker.simulation_applications ( + Name, + CurrentRevisionId, + RenderingEngine, + RobotSoftwareSuite, + SimulationSoftwareSuite, + Sources, + Environment, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ CurrentRevisionId }}', + '{{ RenderingEngine }}', + '{{ RobotSoftwareSuite }}', + '{{ SimulationSoftwareSuite }}', + '{{ Sources }}', + '{{ Environment }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: simulation_application + props: + - name: Name + value: '{{ Name }}' + - name: CurrentRevisionId + value: '{{ CurrentRevisionId }}' + - name: RenderingEngine + value: + Name: '{{ Name }}' + Version: '{{ Version }}' + - name: RobotSoftwareSuite + value: + Name: '{{ Name }}' + Version: '{{ Version }}' + - name: SimulationSoftwareSuite + value: + Name: '{{ Name }}' + Version: '{{ Version }}' + - name: Sources + value: + - S3Bucket: '{{ S3Bucket }}' + S3Key: '{{ S3Key }}' + Architecture: '{{ Architecture }}' + - name: Environment + value: '{{ Environment }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.robomaker.simulation_applications +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +robomaker:ListSimulationApplications +``` diff --git a/website/docs/services/robomaker/simulation_applications_list_only/index.md b/website/docs/services/robomaker/simulation_applications_list_only/index.md new file mode 100644 index 0000000..048d02b --- /dev/null +++ b/website/docs/services/robomaker/simulation_applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: simulation_applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - simulation_applications_list_only + - robomaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists simulation_applications in a region or regions, for all properties use simulation_applications + +## Overview + + + + + + + +
Namesimulation_applications_list_only
TypeResource
DescriptionThis schema is for testing purpose only.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all simulation_applications in a region. +```sql +SELECT +region, +arn +FROM aws.robomaker.simulation_applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the simulation_applications_list_only resource, see simulation_applications + diff --git a/website/docs/services/rolesanywhere/crl_tags/index.md b/website/docs/services/rolesanywhere/crl_tags/index.md new file mode 100644 index 0000000..b1ec795 --- /dev/null +++ b/website/docs/services/rolesanywhere/crl_tags/index.md @@ -0,0 +1,85 @@ +--- +title: crl_tags +hide_title: false +hide_table_of_contents: false +keywords: + - crl_tags + - rolesanywhere + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for crls in a region + +## Overview + + + + + + + +
Namecrl_tags
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::CRL Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all crls in a region. +```sql +SELECT +region, +crl_data, +crl_id, +enabled, +name, +trust_anchor_arn, +tag_key, +tag_value +FROM aws.rolesanywhere.crl_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the crl_tags resource, see crls + diff --git a/website/docs/services/rolesanywhere/crls/index.md b/website/docs/services/rolesanywhere/crls/index.md new file mode 100644 index 0000000..4901887 --- /dev/null +++ b/website/docs/services/rolesanywhere/crls/index.md @@ -0,0 +1,238 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a crl resource or lists crls in a region + +## Overview + + + + + + + +
Namecrls
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::CRL Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
array
stringAWS region.
+ +For more information, see AWS::RolesAnywhere::CRL. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all crls in a region. +```sql +SELECT +region, +crl_data, +crl_id, +enabled, +name, +trust_anchor_arn, +tags +FROM aws.rolesanywhere.crls +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual crl. +```sql +SELECT +region, +crl_data, +crl_id, +enabled, +name, +trust_anchor_arn, +tags +FROM aws.rolesanywhere.crls +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new crl resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rolesanywhere.crls ( + CrlData, + Name, + region +) +SELECT +'{{ CrlData }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rolesanywhere.crls ( + CrlData, + Enabled, + Name, + TrustAnchorArn, + Tags, + region +) +SELECT + '{{ CrlData }}', + '{{ Enabled }}', + '{{ Name }}', + '{{ TrustAnchorArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: crl + props: + - name: CrlData + value: '{{ CrlData }}' + - name: Enabled + value: '{{ Enabled }}' + - name: Name + value: '{{ Name }}' + - name: TrustAnchorArn + value: '{{ TrustAnchorArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rolesanywhere.crls +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the crls resource, the following permissions are required: + +### Create +```json +rolesanywhere:ImportCrl, +rolesanywhere:TagResource, +rolesanywhere:ListTagsForResource +``` + +### Read +```json +rolesanywhere:GetCrl, +rolesanywhere:ListTagsForResource +``` + +### Update +```json +rolesanywhere:EnableCrl, +rolesanywhere:DisableCrl, +rolesanywhere:UpdateCrl, +rolesanywhere:TagResource, +rolesanywhere:UntagResource, +rolesanywhere:ListTagsForResource +``` + +### Delete +```json +rolesanywhere:DeleteCrl +``` + +### List +```json +rolesanywhere:ListCrls, +rolesanywhere:ListTagsForResource +``` diff --git a/website/docs/services/rolesanywhere/crls_list_only/index.md b/website/docs/services/rolesanywhere/crls_list_only/index.md new file mode 100644 index 0000000..d21a836 --- /dev/null +++ b/website/docs/services/rolesanywhere/crls_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: crls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - crls_list_only + - rolesanywhere + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists crls in a region or regions, for all properties use crls + +## Overview + + + + + + + +
Namecrls_list_only
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::CRL Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all crls in a region. +```sql +SELECT +region, +crl_id +FROM aws.rolesanywhere.crls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the crls_list_only resource, see crls + diff --git a/website/docs/services/rolesanywhere/index.md b/website/docs/services/rolesanywhere/index.md new file mode 100644 index 0000000..32fd6a0 --- /dev/null +++ b/website/docs/services/rolesanywhere/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The rolesanywhere service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/rolesanywhere/profile_tags/index.md b/website/docs/services/rolesanywhere/profile_tags/index.md new file mode 100644 index 0000000..cee48cb --- /dev/null +++ b/website/docs/services/rolesanywhere/profile_tags/index.md @@ -0,0 +1,97 @@ +--- +title: profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profile_tags + - rolesanywhere + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profiles in a region + +## Overview + + + + + + + +
Nameprofile_tags
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::Profile Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
number
boolean
array
string
string
string
boolean
array
string
array
boolean
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profiles in a region. +```sql +SELECT +region, +duration_seconds, +enabled, +managed_policy_arns, +name, +profile_arn, +profile_id, +require_instance_properties, +role_arns, +session_policy, +attribute_mappings, +accept_role_session_name, +tag_key, +tag_value +FROM aws.rolesanywhere.profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_tags resource, see profiles + diff --git a/website/docs/services/rolesanywhere/profiles/index.md b/website/docs/services/rolesanywhere/profiles/index.md new file mode 100644 index 0000000..f520e81 --- /dev/null +++ b/website/docs/services/rolesanywhere/profiles/index.md @@ -0,0 +1,292 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a profile resource or lists profiles in a region + +## Overview + + + + + + + +
Nameprofiles
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::Profile Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
number
boolean
array
string
string
string
boolean
array
string
array
array
boolean
stringAWS region.
+ +For more information, see AWS::RolesAnywhere::Profile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all profiles in a region. +```sql +SELECT +region, +duration_seconds, +enabled, +managed_policy_arns, +name, +profile_arn, +profile_id, +require_instance_properties, +role_arns, +session_policy, +tags, +attribute_mappings, +accept_role_session_name +FROM aws.rolesanywhere.profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual profile. +```sql +SELECT +region, +duration_seconds, +enabled, +managed_policy_arns, +name, +profile_arn, +profile_id, +require_instance_properties, +role_arns, +session_policy, +tags, +attribute_mappings, +accept_role_session_name +FROM aws.rolesanywhere.profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rolesanywhere.profiles ( + Name, + RoleArns, + region +) +SELECT +'{{ Name }}', + '{{ RoleArns }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rolesanywhere.profiles ( + DurationSeconds, + Enabled, + ManagedPolicyArns, + Name, + RequireInstanceProperties, + RoleArns, + SessionPolicy, + Tags, + AttributeMappings, + AcceptRoleSessionName, + region +) +SELECT + '{{ DurationSeconds }}', + '{{ Enabled }}', + '{{ ManagedPolicyArns }}', + '{{ Name }}', + '{{ RequireInstanceProperties }}', + '{{ RoleArns }}', + '{{ SessionPolicy }}', + '{{ Tags }}', + '{{ AttributeMappings }}', + '{{ AcceptRoleSessionName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: profile + props: + - name: DurationSeconds + value: null + - name: Enabled + value: '{{ Enabled }}' + - name: ManagedPolicyArns + value: + - '{{ ManagedPolicyArns[0] }}' + - name: Name + value: '{{ Name }}' + - name: RequireInstanceProperties + value: '{{ RequireInstanceProperties }}' + - name: RoleArns + value: + - '{{ RoleArns[0] }}' + - name: SessionPolicy + value: '{{ SessionPolicy }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AttributeMappings + value: + - MappingRules: + - Specifier: '{{ Specifier }}' + CertificateField: '{{ CertificateField }}' + - name: AcceptRoleSessionName + value: '{{ AcceptRoleSessionName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rolesanywhere.profiles +WHERE data__Identifier = '' +AND 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, +rolesanywhere:PutAttributeMapping, +rolesanywhere:DeleteAttributeMapping +``` + +### Read +```json +rolesanywhere:GetProfile, +rolesanywhere:ListTagsForResource +``` + +### Update +```json +iam:GetRole, +iam:GetPolicy, +iam:PassRole, +rolesanywhere:GetProfile, +rolesanywhere:UpdateProfile, +rolesanywhere:EnableProfile, +rolesanywhere:DisableProfile, +rolesanywhere:TagResource, +rolesanywhere:UntagResource, +rolesanywhere:ListTagsForResource, +rolesanywhere:PutAttributeMapping, +rolesanywhere:DeleteAttributeMapping +``` + +### Delete +```json +rolesanywhere:DeleteProfile +``` + +### List +```json +rolesanywhere:ListProfiles, +rolesanywhere:ListTagsForResource +``` diff --git a/website/docs/services/rolesanywhere/profiles_list_only/index.md b/website/docs/services/rolesanywhere/profiles_list_only/index.md new file mode 100644 index 0000000..04a83fb --- /dev/null +++ b/website/docs/services/rolesanywhere/profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profiles_list_only + - rolesanywhere + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profiles in a region or regions, for all properties use profiles + +## Overview + + + + + + + +
Nameprofiles_list_only
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::Profile Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profiles in a region. +```sql +SELECT +region, +profile_id +FROM aws.rolesanywhere.profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiles_list_only resource, see profiles + diff --git a/website/docs/services/rolesanywhere/trust_anchor_tags/index.md b/website/docs/services/rolesanywhere/trust_anchor_tags/index.md new file mode 100644 index 0000000..80e799b --- /dev/null +++ b/website/docs/services/rolesanywhere/trust_anchor_tags/index.md @@ -0,0 +1,87 @@ +--- +title: trust_anchor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - trust_anchor_tags + - rolesanywhere + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for trust_anchors in a region + +## Overview + + + + + + + +
Nametrust_anchor_tags
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::TrustAnchor Resource Type.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
boolean
string
array
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all trust_anchors in a region. +```sql +SELECT +region, +enabled, +name, +notification_settings, +source, +trust_anchor_id, +trust_anchor_arn, +tag_key, +tag_value +FROM aws.rolesanywhere.trust_anchor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_anchor_tags resource, see trust_anchors + diff --git a/website/docs/services/rolesanywhere/trust_anchors/index.md b/website/docs/services/rolesanywhere/trust_anchors/index.md new file mode 100644 index 0000000..836887b --- /dev/null +++ b/website/docs/services/rolesanywhere/trust_anchors/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a trust_anchor resource or lists trust_anchors in a region + +## Overview + + + + + + + +
Nametrust_anchors
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::TrustAnchor Resource Type.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
boolean
string
array
object
array
string
string
stringAWS region.
+ +For more information, see AWS::RolesAnywhere::TrustAnchor. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all trust_anchors in a region. +```sql +SELECT +region, +enabled, +name, +notification_settings, +source, +tags, +trust_anchor_id, +trust_anchor_arn +FROM aws.rolesanywhere.trust_anchors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual trust_anchor. +```sql +SELECT +region, +enabled, +name, +notification_settings, +source, +tags, +trust_anchor_id, +trust_anchor_arn +FROM aws.rolesanywhere.trust_anchors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new trust_anchor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rolesanywhere.trust_anchors ( + Name, + Source, + region +) +SELECT +'{{ Name }}', + '{{ Source }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rolesanywhere.trust_anchors ( + Enabled, + Name, + NotificationSettings, + Source, + Tags, + region +) +SELECT + '{{ Enabled }}', + '{{ Name }}', + '{{ NotificationSettings }}', + '{{ Source }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: trust_anchor + props: + - name: Enabled + value: '{{ Enabled }}' + - name: Name + value: '{{ Name }}' + - name: NotificationSettings + value: + - Enabled: '{{ Enabled }}' + Event: '{{ Event }}' + Threshold: null + Channel: '{{ Channel }}' + - name: Source + value: + SourceType: '{{ SourceType }}' + SourceData: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rolesanywhere.trust_anchors +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +rolesanywhere:ListTrustAnchors, +rolesanywhere:ListTagsForResource +``` diff --git a/website/docs/services/rolesanywhere/trust_anchors_list_only/index.md b/website/docs/services/rolesanywhere/trust_anchors_list_only/index.md new file mode 100644 index 0000000..7cabbee --- /dev/null +++ b/website/docs/services/rolesanywhere/trust_anchors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: trust_anchors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trust_anchors_list_only + - rolesanywhere + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trust_anchors in a region or regions, for all properties use trust_anchors + +## Overview + + + + + + + +
Nametrust_anchors_list_only
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::TrustAnchor Resource Type.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trust_anchors in a region. +```sql +SELECT +region, +trust_anchor_id +FROM aws.rolesanywhere.trust_anchors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_anchors_list_only resource, see trust_anchors + diff --git a/website/docs/services/route53/cidr_collections/index.md b/website/docs/services/route53/cidr_collections/index.md new file mode 100644 index 0000000..bac15a8 --- /dev/null +++ b/website/docs/services/route53/cidr_collections/index.md @@ -0,0 +1,215 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cidr_collection resource or lists cidr_collections in a region + +## Overview + + + + + + + +
Namecidr_collections
TypeResource
DescriptionResource schema for AWS::Route53::CidrCollection.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringUUID of the CIDR collection.
stringA unique name for the CIDR collection.
stringThe Amazon resource name (ARN) to uniquely identify the AWS resource.
arrayA complex type that contains information about the list of CIDR locations.
stringAWS region.
+ +For more information, see AWS::Route53::CidrCollection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cidr_collections in a region. +```sql +SELECT +region, +id, +name, +arn, +locations +FROM aws.route53.cidr_collections +; +``` +Gets all properties from an individual cidr_collection. +```sql +SELECT +region, +id, +name, +arn, +locations +FROM aws.route53.cidr_collections +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cidr_collection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53.cidr_collections ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53.cidr_collections ( + Name, + Locations, + region +) +SELECT + '{{ Name }}', + '{{ Locations }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cidr_collection + props: + - name: Name + value: '{{ Name }}' + - name: Locations + value: + - LocationName: '{{ LocationName }}' + CidrList: + - '{{ CidrList[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53.cidr_collections +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the cidr_collections resource, the following permissions are required: + +### Create +```json +route53:CreateCidrCollection, +route53:ChangeCidrCollection +``` + +### Read +```json +route53:ListCidrCollections, +route53:ListCidrBlocks +``` + +### Update +```json +route53:ChangeCidrCollection +``` + +### Delete +```json +route53:DeleteCidrCollection, +route53:ChangeCidrCollection, +route53:ListCidrBlocks +``` + +### List +```json +route53:ListCidrCollections, +route53:ListCidrBlocks +``` diff --git a/website/docs/services/route53/cidr_collections_list_only/index.md b/website/docs/services/route53/cidr_collections_list_only/index.md new file mode 100644 index 0000000..6da8242 --- /dev/null +++ b/website/docs/services/route53/cidr_collections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cidr_collections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cidr_collections_list_only + - route53 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cidr_collections in a region or regions, for all properties use cidr_collections + +## Overview + + + + + + + +
Namecidr_collections_list_only
TypeResource
DescriptionResource schema for AWS::Route53::CidrCollection.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUUID of the CIDR collection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cidr_collections in a region. +```sql +SELECT +region, +id +FROM aws.route53.cidr_collections_list_only +; +``` + + +## Permissions + +For permissions required to operate on the cidr_collections_list_only resource, see cidr_collections + diff --git a/website/docs/services/route53/dnssecs/index.md b/website/docs/services/route53/dnssecs/index.md new file mode 100644 index 0000000..fa036d5 --- /dev/null +++ b/website/docs/services/route53/dnssecs/index.md @@ -0,0 +1,195 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dnssec resource or lists dnssecs in a region + +## Overview + + + + + + + +
Namednssecs
TypeResource
DescriptionResource used to control (enable/disable) DNSSEC in a specific hosted zone.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique string (ID) used to identify a hosted zone.
stringAWS region.
+ +For more information, see AWS::Route53::DNSSEC. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dnssecs in a region. +```sql +SELECT +region, +hosted_zone_id +FROM aws.route53.dnssecs +; +``` +Gets all properties from an individual dnssec. +```sql +SELECT +region, +hosted_zone_id +FROM aws.route53.dnssecs +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dnssec resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53.dnssecs ( + HostedZoneId, + region +) +SELECT +'{{ HostedZoneId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53.dnssecs ( + HostedZoneId, + region +) +SELECT + '{{ HostedZoneId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dnssec + props: + - name: HostedZoneId + value: '{{ HostedZoneId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53.dnssecs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### Read +```json +route53:GetDNSSEC +``` + +### Delete +```json +route53:GetDNSSEC, +route53:DisableHostedZoneDNSSEC, +kms:DescribeKey, +kms:GetPublicKey, +kms:Sign, +kms:CreateGrant +``` + +### List +```json +route53:GetDNSSEC, +route53:ListHostedZones +``` diff --git a/website/docs/services/route53/dnssecs_list_only/index.md b/website/docs/services/route53/dnssecs_list_only/index.md new file mode 100644 index 0000000..ea763e3 --- /dev/null +++ b/website/docs/services/route53/dnssecs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dnssecs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dnssecs_list_only + - route53 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dnssecs in a region or regions, for all properties use dnssecs + +## Overview + + + + + + + +
Namednssecs_list_only
TypeResource
DescriptionResource used to control (enable/disable) DNSSEC in a specific hosted zone.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique string (ID) used to identify a hosted zone.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dnssecs in a region. +```sql +SELECT +region, +hosted_zone_id +FROM aws.route53.dnssecs_list_only +; +``` + + +## Permissions + +For permissions required to operate on the dnssecs_list_only resource, see dnssecs + diff --git a/website/docs/services/route53/health_checks/index.md b/website/docs/services/route53/health_checks/index.md new file mode 100644 index 0000000..6e9bb68 --- /dev/null +++ b/website/docs/services/route53/health_checks/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a health_check resource or lists health_checks in a region + +## Overview + + + + + + + +
Namehealth_checks
TypeResource
DescriptionResource schema for AWS::Route53::HealthCheck.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
objectA complex type that contains information about the health check.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Route53::HealthCheck. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all health_checks in a region. +```sql +SELECT +region, +health_check_id, +health_check_config, +health_check_tags +FROM aws.route53.health_checks +; +``` +Gets all properties from an individual health_check. +```sql +SELECT +region, +health_check_id, +health_check_config, +health_check_tags +FROM aws.route53.health_checks +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new health_check resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53.health_checks ( + HealthCheckConfig, + region +) +SELECT +'{{ HealthCheckConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53.health_checks ( + HealthCheckConfig, + HealthCheckTags, + region +) +SELECT + '{{ HealthCheckConfig }}', + '{{ HealthCheckTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: health_check + props: + - name: HealthCheckConfig + value: + AlarmIdentifier: + Name: '{{ Name }}' + Region: '{{ Region }}' + ChildHealthChecks: + - '{{ ChildHealthChecks[0] }}' + EnableSNI: '{{ EnableSNI }}' + FailureThreshold: '{{ FailureThreshold }}' + FullyQualifiedDomainName: '{{ FullyQualifiedDomainName }}' + HealthThreshold: '{{ HealthThreshold }}' + InsufficientDataHealthStatus: '{{ InsufficientDataHealthStatus }}' + Inverted: '{{ Inverted }}' + IPAddress: '{{ IPAddress }}' + MeasureLatency: '{{ MeasureLatency }}' + Port: '{{ Port }}' + Regions: + - '{{ Regions[0] }}' + RequestInterval: '{{ RequestInterval }}' + ResourcePath: '{{ ResourcePath }}' + SearchString: '{{ SearchString }}' + RoutingControlArn: '{{ RoutingControlArn }}' + Type: '{{ Type }}' + - name: HealthCheckTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53.health_checks +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### Read +```json +route53:GetHealthCheck, +route53:ListTagsForResource +``` + +### Update +```json +route53:UpdateHealthCheck, +route53:ChangeTagsForResource, +route53:ListTagsForResource, +cloudwatch:DescribeAlarms +``` + +### Delete +```json +route53:DeleteHealthCheck +``` + +### List +```json +route53:ListHealthChecks, +route53:ListTagsForResource +``` diff --git a/website/docs/services/route53/health_checks_list_only/index.md b/website/docs/services/route53/health_checks_list_only/index.md new file mode 100644 index 0000000..adec953 --- /dev/null +++ b/website/docs/services/route53/health_checks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: health_checks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - health_checks_list_only + - route53 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists health_checks in a region or regions, for all properties use health_checks + +## Overview + + + + + + + +
Namehealth_checks_list_only
TypeResource
DescriptionResource schema for AWS::Route53::HealthCheck.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all health_checks in a region. +```sql +SELECT +region, +health_check_id +FROM aws.route53.health_checks_list_only +; +``` + + +## Permissions + +For permissions required to operate on the health_checks_list_only resource, see health_checks + diff --git a/website/docs/services/route53/hosted_zones/index.md b/website/docs/services/route53/hosted_zones/index.md new file mode 100644 index 0000000..35413b1 --- /dev/null +++ b/website/docs/services/route53/hosted_zones/index.md @@ -0,0 +1,265 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a hosted_zone resource or lists 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).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).
Note the following:
+ You can't create a hosted zone for a top-level domain (TLD) such as .com.
+ If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*.

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

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

+ Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
array*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.
For public hosted zones, omit VPCs, VPCId, and VPCRegion.
array
stringAWS region.
+ +For more information, see AWS::Route53::HostedZone. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all hosted_zones in a region. +```sql +SELECT +region, +id, +hosted_zone_config, +hosted_zone_tags, +name, +query_logging_config, +vpcs, +name_servers +FROM aws.route53.hosted_zones +; +``` +Gets all properties from an individual hosted_zone. +```sql +SELECT +region, +id, +hosted_zone_config, +hosted_zone_tags, +name, +query_logging_config, +vpcs, +name_servers +FROM aws.route53.hosted_zones +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new hosted_zone resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53.hosted_zones ( + HostedZoneConfig, + HostedZoneTags, + Name, + QueryLoggingConfig, + VPCs, + region +) +SELECT +'{{ HostedZoneConfig }}', + '{{ HostedZoneTags }}', + '{{ Name }}', + '{{ QueryLoggingConfig }}', + '{{ VPCs }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53.hosted_zones ( + HostedZoneConfig, + HostedZoneTags, + Name, + QueryLoggingConfig, + VPCs, + region +) +SELECT + '{{ HostedZoneConfig }}', + '{{ HostedZoneTags }}', + '{{ Name }}', + '{{ QueryLoggingConfig }}', + '{{ VPCs }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: hosted_zone + props: + - name: HostedZoneConfig + value: + Comment: '{{ Comment }}' + - name: HostedZoneTags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Name + value: '{{ Name }}' + - name: QueryLoggingConfig + value: + CloudWatchLogsLogGroupArn: '{{ CloudWatchLogsLogGroupArn }}' + - name: VPCs + value: + - VPCId: '{{ VPCId }}' + VPCRegion: '{{ VPCRegion }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53.hosted_zones +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### Read +```json +route53:GetHostedZone, +route53:ListTagsForResource, +route53:ListQueryLoggingConfigs +``` + +### Update +```json +route53:GetChange, +route53:GetHostedZone, +route53:ListTagsForResource, +route53:ListQueryLoggingConfigs, +route53:UpdateHostedZoneComment, +route53:ChangeTagsForResource, +route53:AssociateVPCWithHostedZone, +route53:DisassociateVPCFromHostedZone, +route53:CreateQueryLoggingConfig, +route53:DeleteQueryLoggingConfig, +ec2:DescribeVpcs +``` + +### Delete +```json +route53:DeleteHostedZone, +route53:DeleteQueryLoggingConfig, +route53:ListQueryLoggingConfigs, +route53:GetChange +``` + +### List +```json +route53:GetHostedZone, +route53:ListHostedZones, +route53:ListQueryLoggingConfigs, +route53:ListTagsForResource +``` diff --git a/website/docs/services/route53/hosted_zones_list_only/index.md b/website/docs/services/route53/hosted_zones_list_only/index.md new file mode 100644 index 0000000..cc3b2c8 --- /dev/null +++ b/website/docs/services/route53/hosted_zones_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: hosted_zones_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hosted_zones_list_only + - route53 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hosted_zones in a region or regions, for all properties use hosted_zones + +## Overview + + + + + + + +
Namehosted_zones_list_only
TypeResource
DescriptionCreates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).
Note the following:
+ You can't create a hosted zone for a top-level domain (TLD) such as .com.
+ If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*.

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

For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hosted_zones in a region. +```sql +SELECT +region, +id +FROM aws.route53.hosted_zones_list_only +; +``` + + +## Permissions + +For permissions required to operate on the hosted_zones_list_only resource, see hosted_zones + diff --git a/website/docs/services/route53/index.md b/website/docs/services/route53/index.md new file mode 100644 index 0000000..68429ba --- /dev/null +++ b/website/docs/services/route53/index.md @@ -0,0 +1,46 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The route53 service documentation. + +:::info Service Summary + +
+
+total resources: 11
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/route53/key_signing_keys/index.md b/website/docs/services/route53/key_signing_keys/index.md new file mode 100644 index 0000000..55a967c --- /dev/null +++ b/website/docs/services/route53/key_signing_keys/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a key_signing_key resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe unique string (ID) used to identify a hosted zone.
stringA string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE.
stringAn alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.
stringThe Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone.
stringAWS region.
+ +For more information, see AWS::Route53::KeySigningKey. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all key_signing_keys in a region. +```sql +SELECT +region, +hosted_zone_id, +status, +name, +key_management_service_arn +FROM aws.route53.key_signing_keys +; +``` +Gets all properties from an individual key_signing_key. +```sql +SELECT +region, +hosted_zone_id, +status, +name, +key_management_service_arn +FROM aws.route53.key_signing_keys +WHERE data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new key_signing_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53.key_signing_keys ( + HostedZoneId, + Status, + Name, + KeyManagementServiceArn, + region +) +SELECT +'{{ HostedZoneId }}', + '{{ Status }}', + '{{ Name }}', + '{{ KeyManagementServiceArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53.key_signing_keys ( + HostedZoneId, + Status, + Name, + KeyManagementServiceArn, + region +) +SELECT + '{{ HostedZoneId }}', + '{{ Status }}', + '{{ Name }}', + '{{ KeyManagementServiceArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: key_signing_key + props: + - name: HostedZoneId + value: '{{ HostedZoneId }}' + - name: Status + value: '{{ Status }}' + - name: Name + value: '{{ Name }}' + - name: KeyManagementServiceArn + value: '{{ KeyManagementServiceArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53.key_signing_keys +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### 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 +``` + +### List +```json +route53:GetDNSSEC, +route53:ListHostedZones +``` diff --git a/website/docs/services/route53/key_signing_keys_list_only/index.md b/website/docs/services/route53/key_signing_keys_list_only/index.md new file mode 100644 index 0000000..f38d86a --- /dev/null +++ b/website/docs/services/route53/key_signing_keys_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: key_signing_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - key_signing_keys_list_only + - route53 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists key_signing_keys in a region or regions, for all properties use key_signing_keys + +## Overview + + + + + + + +
Namekey_signing_keys_list_only
TypeResource
DescriptionRepresents a key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe unique string (ID) used to identify a hosted zone.
stringAn alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all key_signing_keys in a region. +```sql +SELECT +region, +hosted_zone_id, +name +FROM aws.route53.key_signing_keys_list_only +; +``` + + +## Permissions + +For permissions required to operate on the key_signing_keys_list_only resource, see key_signing_keys + diff --git a/website/docs/services/route53/resource_record_sets/index.md b/website/docs/services/route53/resource_record_sets/index.md new file mode 100644 index 0000000..f147f8b --- /dev/null +++ b/website/docs/services/route53/resource_record_sets/index.md @@ -0,0 +1,81 @@ +--- +title: resource_record_sets +hide_title: false +hide_table_of_contents: false +keywords: + - resource_record_sets + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Information about the resource record set to create or delete. + +## Overview + + + + + + + +
Nameresource_record_sets
TypeResource
DescriptionInformation about the resource record set to create or delete.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.

ChangeResourceRecordSets Only

Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify 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.

For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

You can use the asterisk * wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:

  • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.

  • The * can't replace any of the middle labels, for example, marketing.*.example.com.

  • If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

    You can't use the * wildcard for resource records sets that have a type of NS.

You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.

string

The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | DS |MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT

SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type.

Values for alias resource record sets:

  • Amazon API Gateway custom regional APIs and edge-optimized APIs: A

  • CloudFront distributions: A

    If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

  • Amazon API Gateway environment that has a regionalized subdomain: A

  • ELB load balancers: A | AAAA

  • Amazon S3 buckets: A

  • Amazon Virtual Private Cloud interface VPC endpoints A

  • Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA.

    If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.

string

Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

integer

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

  • You must specify a value for the Weight element for every weighted resource record set.

  • You can only specify one ResourceRecord per weighted resource record set.

  • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.

  • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.

  • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.

    The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

string

Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.

Note the following:

  • You can only specify one ResourceRecord per latency resource record set.

  • You can only create one latency resource record set for each Amazon EC2 Region.

  • You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.

  • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

object

Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.

If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

You can't create two geolocation resource record sets that specify the same geographic location.

The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a "no answer" response for queries from those locations.

You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

string

Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

  • When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.

  • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

  • When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.

  • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

boolean

Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following:

  • If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.

  • If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.

  • Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.

  • If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.

  • When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

  • If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

You can't create multivalue answer alias records.

integer

The resource record cache time to live (TTL), in seconds. Note the following:

  • If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.

  • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

  • All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

  • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

array

Information about the resource records to act upon.

If you're creating an alias resource record set, omit ResourceRecords.

object

Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

If you're creating resource records sets for a private hosted zone, note the following:

  • You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

  • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

string

If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

Route 53 determines whether a resource record set is healthy based on one of the following:

  • By periodically sending a request to the endpoint that is specified in the health check

  • By aggregating the status of a specified group of health checks (calculated health checks)

  • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.

For more information, see the following topics in the Amazon Route 53 Developer Guide:

When to Specify HealthCheckId

Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:

  • Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.

    If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.

    If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.

    If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.

  • Alias resource record sets: You specify the following settings:

    • You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).

    • You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.

    • You specify a health check ID for the non-alias resource record set.

    If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.

    If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

    The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.

Geolocation Routing

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:

  • The United States

  • North America

  • The default resource record set

Specifying the Health Check Endpoint by Domain Name

If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

Health check results will be unpredictable if you do the following:

  • Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.

  • Associate that health check with the resource record set.

string

When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource record set for.

To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

object

The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.

A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record.

stringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
INSERT
+ + + + + + diff --git a/website/docs/services/route53profiles/index.md b/website/docs/services/route53profiles/index.md new file mode 100644 index 0000000..18657d6 --- /dev/null +++ b/website/docs/services/route53profiles/index.md @@ -0,0 +1,43 @@ +--- +title: route53profiles +hide_title: false +hide_table_of_contents: false +keywords: + - route53profiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The route53profiles service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/route53profiles/profile_association_tags/index.md b/website/docs/services/route53profiles/profile_association_tags/index.md new file mode 100644 index 0000000..bebaf8c --- /dev/null +++ b/website/docs/services/route53profiles/profile_association_tags/index.md @@ -0,0 +1,85 @@ +--- +title: profile_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profile_association_tags + - route53profiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profile_associations in a region + +## Overview + + + + + + + +
Nameprofile_association_tags
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::ProfileAssociation
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe resource that you associated the profile with.
stringThe ID of the profile that you associated with the resource that is specified by ResourceId.
stringPrimary Identifier for Profile Association
stringThe name of an association between a Profile and a VPC.
stringThe Amazon Resource Name (ARN) of the profile association.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profile_associations in a region. +```sql +SELECT +region, +resource_id, +profile_id, +id, +name, +arn, +tag_key, +tag_value +FROM aws.route53profiles.profile_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_association_tags resource, see profile_associations + diff --git a/website/docs/services/route53profiles/profile_associations/index.md b/website/docs/services/route53profiles/profile_associations/index.md new file mode 100644 index 0000000..59b9233 --- /dev/null +++ b/website/docs/services/route53profiles/profile_associations/index.md @@ -0,0 +1,243 @@ +--- +title: profile_associations +hide_title: false +hide_table_of_contents: false +keywords: + - profile_associations + - route53profiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a profile_association resource or lists profile_associations in a region + +## Overview + + + + + + + +
Nameprofile_associations
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::ProfileAssociation
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe resource that you associated the profile with.
stringThe ID of the profile that you associated with the resource that is specified by ResourceId.
stringPrimary Identifier for Profile Association
stringThe name of an association between a Profile and a VPC.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the profile association.
stringAWS region.
+ +For more information, see AWS::Route53Profiles::ProfileAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all profile_associations in a region. +```sql +SELECT +region, +resource_id, +profile_id, +id, +name, +tags, +arn +FROM aws.route53profiles.profile_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual profile_association. +```sql +SELECT +region, +resource_id, +profile_id, +id, +name, +tags, +arn +FROM aws.route53profiles.profile_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new profile_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53profiles.profile_associations ( + ResourceId, + ProfileId, + Name, + region +) +SELECT +'{{ ResourceId }}', + '{{ ProfileId }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53profiles.profile_associations ( + ResourceId, + ProfileId, + Name, + Tags, + Arn, + region +) +SELECT + '{{ ResourceId }}', + '{{ ProfileId }}', + '{{ Name }}', + '{{ Tags }}', + '{{ Arn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: profile_association + props: + - name: ResourceId + value: '{{ ResourceId }}' + - name: ProfileId + value: '{{ ProfileId }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Arn + value: '{{ Arn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53profiles.profile_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the profile_associations resource, the following permissions are required: + +### Create +```json +route53profiles:AssociateProfile, +route53profiles:GetProfileAssociation, +ec2:DescribeVpcs, +route53profiles:TagResource, +route53profiles:ListTagsForResource +``` + +### Update +```json +route53profiles:GetProfileAssociation, +route53profiles:TagResource, +route53profiles:UntagResource, +route53profiles:ListTagsForResource +``` + +### Read +```json +route53profiles:GetProfileAssociation, +route53profiles:ListTagsForResource +``` + +### Delete +```json +route53profiles:DisassociateProfile, +route53profiles:GetProfileAssociation, +route53profiles:UntagResource, +route53profiles:ListTagsForResource +``` + +### List +```json +route53profiles:ListProfileAssociations, +route53profiles:ListTagsForResource +``` diff --git a/website/docs/services/route53profiles/profile_associations_list_only/index.md b/website/docs/services/route53profiles/profile_associations_list_only/index.md new file mode 100644 index 0000000..6ebdf58 --- /dev/null +++ b/website/docs/services/route53profiles/profile_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: profile_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profile_associations_list_only + - route53profiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profile_associations in a region or regions, for all properties use profile_associations + +## Overview + + + + + + + +
Nameprofile_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::ProfileAssociation
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringPrimary Identifier for Profile Association
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profile_associations in a region. +```sql +SELECT +region, +id +FROM aws.route53profiles.profile_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_associations_list_only resource, see profile_associations + diff --git a/website/docs/services/route53profiles/profile_resource_associations/index.md b/website/docs/services/route53profiles/profile_resource_associations/index.md new file mode 100644 index 0000000..deaa966 --- /dev/null +++ b/website/docs/services/route53profiles/profile_resource_associations/index.md @@ -0,0 +1,238 @@ +--- +title: profile_resource_associations +hide_title: false +hide_table_of_contents: false +keywords: + - profile_resource_associations + - route53profiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a profile_resource_association resource or lists profile_resource_associations in a region + +## Overview + + + + + + + +
Nameprofile_resource_associations
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::ProfileResourceAssociation
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the profile that you associated the resource to that is specified by ResourceArn.
stringPrimary Identifier for Profile Resource Association
stringThe name of an association between the Profile and resource.
stringThe arn of the resource that you associated to the Profile.
stringA JSON-formatted string with key-value pairs specifying the properties of the associated resource.
stringThe type of the resource associated to the Profile.
stringAWS region.
+ +For more information, see AWS::Route53Profiles::ProfileResourceAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all profile_resource_associations in a region. +```sql +SELECT +region, +profile_id, +id, +name, +resource_arn, +resource_properties, +resource_type +FROM aws.route53profiles.profile_resource_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual profile_resource_association. +```sql +SELECT +region, +profile_id, +id, +name, +resource_arn, +resource_properties, +resource_type +FROM aws.route53profiles.profile_resource_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new profile_resource_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53profiles.profile_resource_associations ( + ProfileId, + Name, + ResourceArn, + region +) +SELECT +'{{ ProfileId }}', + '{{ Name }}', + '{{ ResourceArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53profiles.profile_resource_associations ( + ProfileId, + Name, + ResourceArn, + ResourceProperties, + region +) +SELECT + '{{ ProfileId }}', + '{{ Name }}', + '{{ ResourceArn }}', + '{{ ResourceProperties }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: profile_resource_association + props: + - name: ProfileId + value: '{{ ProfileId }}' + - name: Name + value: '{{ Name }}' + - name: ResourceArn + value: '{{ ResourceArn }}' + - name: ResourceProperties + value: '{{ ResourceProperties }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53profiles.profile_resource_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the profile_resource_associations resource, the following permissions are required: + +### Create +```json +route53profiles:AssociateResourceToProfile, +route53profiles:GetProfileResourceAssociation, +route53resolver:*, +route53:* +``` + +### Read +```json +route53profiles:GetProfileResourceAssociation, +route53resolver:*, +route53:* +``` + +### Delete +```json +route53profiles:DisassociateResourceFromProfile, +route53profiles:GetProfileResourceAssociation, +route53resolver:*, +route53:* +``` + +### List +```json +route53profiles:ListProfileResourceAssociations, +route53resolver:*, +route53:* +``` + +### Update +```json +route53profiles:UpdateProfileResourceAssociation, +route53profiles:GetProfileResourceAssociation, +route53resolver:*, +route53:* +``` diff --git a/website/docs/services/route53profiles/profile_resource_associations_list_only/index.md b/website/docs/services/route53profiles/profile_resource_associations_list_only/index.md new file mode 100644 index 0000000..5ebfeaf --- /dev/null +++ b/website/docs/services/route53profiles/profile_resource_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: profile_resource_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profile_resource_associations_list_only + - route53profiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profile_resource_associations in a region or regions, for all properties use profile_resource_associations + +## Overview + + + + + + + +
Nameprofile_resource_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::ProfileResourceAssociation
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringPrimary Identifier for Profile Resource Association
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profile_resource_associations in a region. +```sql +SELECT +region, +id +FROM aws.route53profiles.profile_resource_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_resource_associations_list_only resource, see profile_resource_associations + diff --git a/website/docs/services/route53profiles/profile_tags/index.md b/website/docs/services/route53profiles/profile_tags/index.md new file mode 100644 index 0000000..30903a2 --- /dev/null +++ b/website/docs/services/route53profiles/profile_tags/index.md @@ -0,0 +1,83 @@ +--- +title: profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profile_tags + - route53profiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profiles in a region + +## Overview + + + + + + + +
Nameprofile_tags
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::Profile
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the profile.
stringThe id of the creator request
stringThe Amazon Resource Name (ARN) of the resolver profile.
stringThe ID of the profile.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profiles in a region. +```sql +SELECT +region, +name, +client_token, +arn, +id, +tag_key, +tag_value +FROM aws.route53profiles.profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_tags resource, see profiles + diff --git a/website/docs/services/route53profiles/profiles/index.md b/website/docs/services/route53profiles/profiles/index.md new file mode 100644 index 0000000..bbeb727 --- /dev/null +++ b/website/docs/services/route53profiles/profiles/index.md @@ -0,0 +1,223 @@ +--- +title: profiles +hide_title: false +hide_table_of_contents: false +keywords: + - profiles + - route53profiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a profile resource or lists profiles in a region + +## Overview + + + + + + + +
Nameprofiles
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::Profile
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the profile.
stringThe id of the creator request
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the resolver profile.
stringThe ID of the profile.
stringAWS region.
+ +For more information, see AWS::Route53Profiles::Profile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all profiles in a region. +```sql +SELECT +region, +name, +client_token, +tags, +arn, +id +FROM aws.route53profiles.profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual profile. +```sql +SELECT +region, +name, +client_token, +tags, +arn, +id +FROM aws.route53profiles.profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53profiles.profiles ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53profiles.profiles ( + Name, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: profile + props: + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53profiles.profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the profiles resource, the following permissions are required: + +### Create +```json +route53profiles:CreateProfile, +route53profiles:GetProfile, +route53profiles:TagResource, +route53profiles:ListTagsForResource +``` + +### Update +```json +route53profiles:GetProfile, +route53profiles:TagResource, +route53profiles:UntagResource, +route53profiles:ListTagsForResource +``` + +### Read +```json +route53profiles:GetProfile, +route53profiles:ListTagsForResource +``` + +### Delete +```json +route53profiles:DeleteProfile, +route53profiles:GetProfile, +route53profiles:UntagResource, +route53profiles:ListTagsForResource +``` + +### List +```json +route53profiles:ListProfiles, +route53profiles:ListTagsForResource +``` diff --git a/website/docs/services/route53profiles/profiles_list_only/index.md b/website/docs/services/route53profiles/profiles_list_only/index.md new file mode 100644 index 0000000..1c95a1c --- /dev/null +++ b/website/docs/services/route53profiles/profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profiles_list_only + - route53profiles + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profiles in a region or regions, for all properties use profiles + +## Overview + + + + + + + +
Nameprofiles_list_only
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::Profile
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profiles in a region. +```sql +SELECT +region, +id +FROM aws.route53profiles.profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiles_list_only resource, see profiles + diff --git a/website/docs/services/route53recoverycontrol/cluster_tags/index.md b/website/docs/services/route53recoverycontrol/cluster_tags/index.md new file mode 100644 index 0000000..8d77ef0 --- /dev/null +++ b/website/docs/services/route53recoverycontrol/cluster_tags/index.md @@ -0,0 +1,83 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - route53recoverycontrol + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + + + +
Namecluster_tags
TypeResource
DescriptionAWS Route53 Recovery Control Cluster resource schema
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of a Cluster. You can use any non-white space character in the name
stringThe Amazon Resource Name (ARN) of the cluster.
stringDeployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
arrayEndpoints for the cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +name, +cluster_arn, +status, +cluster_endpoints, +tag_key, +tag_value +FROM aws.route53recoverycontrol.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + diff --git a/website/docs/services/route53recoverycontrol/clusters/index.md b/website/docs/services/route53recoverycontrol/clusters/index.md new file mode 100644 index 0000000..31f5c90 --- /dev/null +++ b/website/docs/services/route53recoverycontrol/clusters/index.md @@ -0,0 +1,207 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster resource or lists clusters in a region + +## Overview + + + + + + + +
Nameclusters
TypeResource
DescriptionAWS Route53 Recovery Control Cluster resource schema
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of a Cluster. You can use any non-white space character in the name
stringThe Amazon Resource Name (ARN) of the cluster.
stringDeployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
arrayEndpoints for the cluster.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::Route53RecoveryControl::Cluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all clusters in a region. +```sql +SELECT +region, +name, +cluster_arn, +status, +cluster_endpoints, +tags +FROM aws.route53recoverycontrol.clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster. +```sql +SELECT +region, +name, +cluster_arn, +status, +cluster_endpoints, +tags +FROM aws.route53recoverycontrol.clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoverycontrol.clusters ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoverycontrol.clusters ( + Name, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster + props: + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53recoverycontrol.clusters +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +route53-recovery-control-config:DescribeCluster, +route53-recovery-control-config:ListTagsForResource +``` + +### Delete +```json +route53-recovery-control-config:DescribeCluster, +route53-recovery-control-config:DeleteCluster +``` + +### List +```json +route53-recovery-control-config:ListClusters +``` diff --git a/website/docs/services/route53recoverycontrol/clusters_list_only/index.md b/website/docs/services/route53recoverycontrol/clusters_list_only/index.md new file mode 100644 index 0000000..6675ac3 --- /dev/null +++ b/website/docs/services/route53recoverycontrol/clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - route53recoverycontrol + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + + + +
Nameclusters_list_only
TypeResource
DescriptionAWS Route53 Recovery Control Cluster resource schema
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +cluster_arn +FROM aws.route53recoverycontrol.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + diff --git a/website/docs/services/route53recoverycontrol/control_panel_tags/index.md b/website/docs/services/route53recoverycontrol/control_panel_tags/index.md new file mode 100644 index 0000000..1d6d104 --- /dev/null +++ b/website/docs/services/route53recoverycontrol/control_panel_tags/index.md @@ -0,0 +1,87 @@ +--- +title: control_panel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - control_panel_tags + - route53recoverycontrol + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for control_panels in a region + +## Overview + + + + + + + +
Namecontrol_panel_tags
TypeResource
DescriptionAWS Route53 Recovery Control Control Panel resource schema .
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringCluster to associate with the Control Panel
stringThe Amazon Resource Name (ARN) of the cluster.
stringThe name of the control panel. You can use any non-white space character in the name.
stringThe deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
booleanA flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
integerCount of associated routing controls
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all control_panels in a region. +```sql +SELECT +region, +cluster_arn, +control_panel_arn, +name, +status, +default_control_panel, +routing_control_count, +tag_key, +tag_value +FROM aws.route53recoverycontrol.control_panel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the control_panel_tags resource, see control_panels + diff --git a/website/docs/services/route53recoverycontrol/control_panels/index.md b/website/docs/services/route53recoverycontrol/control_panels/index.md new file mode 100644 index 0000000..ea59e3a --- /dev/null +++ b/website/docs/services/route53recoverycontrol/control_panels/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a control_panel resource or lists control_panels in a region + +## Overview + + + + + + + +
Namecontrol_panels
TypeResource
DescriptionAWS Route53 Recovery Control Control Panel resource schema .
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringCluster to associate with the Control Panel
stringThe Amazon Resource Name (ARN) of the cluster.
stringThe name of the control panel. You can use any non-white space character in the name.
stringThe deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
booleanA flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
integerCount of associated routing controls
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::Route53RecoveryControl::ControlPanel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all control_panels in a region. +```sql +SELECT +region, +cluster_arn, +control_panel_arn, +name, +status, +default_control_panel, +routing_control_count, +tags +FROM aws.route53recoverycontrol.control_panels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual control_panel. +```sql +SELECT +region, +cluster_arn, +control_panel_arn, +name, +status, +default_control_panel, +routing_control_count, +tags +FROM aws.route53recoverycontrol.control_panels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new control_panel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoverycontrol.control_panels ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoverycontrol.control_panels ( + ClusterArn, + Name, + Tags, + region +) +SELECT + '{{ ClusterArn }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: control_panel + props: + - name: ClusterArn + value: '{{ ClusterArn }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53recoverycontrol.control_panels +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +route53-recovery-control-config:ListControlPanels +``` diff --git a/website/docs/services/route53recoverycontrol/control_panels_list_only/index.md b/website/docs/services/route53recoverycontrol/control_panels_list_only/index.md new file mode 100644 index 0000000..cf09e3e --- /dev/null +++ b/website/docs/services/route53recoverycontrol/control_panels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: control_panels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - control_panels_list_only + - route53recoverycontrol + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists control_panels in a region or regions, for all properties use control_panels + +## Overview + + + + + + + +
Namecontrol_panels_list_only
TypeResource
DescriptionAWS Route53 Recovery Control Control Panel resource schema .
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all control_panels in a region. +```sql +SELECT +region, +control_panel_arn +FROM aws.route53recoverycontrol.control_panels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the control_panels_list_only resource, see control_panels + diff --git a/website/docs/services/route53recoverycontrol/index.md b/website/docs/services/route53recoverycontrol/index.md new file mode 100644 index 0000000..e7b478c --- /dev/null +++ b/website/docs/services/route53recoverycontrol/index.md @@ -0,0 +1,46 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The route53recoverycontrol service documentation. + +:::info Service Summary + +
+
+total resources: 11
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/route53recoverycontrol/routing_controls/index.md b/website/docs/services/route53recoverycontrol/routing_controls/index.md new file mode 100644 index 0000000..3e5689e --- /dev/null +++ b/website/docs/services/route53recoverycontrol/routing_controls/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a routing_control resource or lists routing_controls in a region + +## Overview + + + + + + + +
Namerouting_controls
TypeResource
DescriptionAWS Route53 Recovery Control Routing Control resource schema .
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the routing control.
stringThe Amazon Resource Name (ARN) of the control panel.
stringThe name of the routing control. You can use any non-white space character in the name.
stringThe deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
stringArn associated with Control Panel
stringAWS region.
+ +For more information, see AWS::Route53RecoveryControl::RoutingControl. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all routing_controls in a region. +```sql +SELECT +region, +routing_control_arn, +control_panel_arn, +name, +status, +cluster_arn +FROM aws.route53recoverycontrol.routing_controls +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual routing_control. +```sql +SELECT +region, +routing_control_arn, +control_panel_arn, +name, +status, +cluster_arn +FROM aws.route53recoverycontrol.routing_controls +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new routing_control resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoverycontrol.routing_controls ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoverycontrol.routing_controls ( + ControlPanelArn, + Name, + ClusterArn, + region +) +SELECT + '{{ ControlPanelArn }}', + '{{ Name }}', + '{{ ClusterArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: routing_control + props: + - name: ControlPanelArn + value: '{{ ControlPanelArn }}' + - name: Name + value: '{{ Name }}' + - name: ClusterArn + value: '{{ ClusterArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53recoverycontrol.routing_controls +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +route53-recovery-control-config:ListRoutingControls +``` diff --git a/website/docs/services/route53recoverycontrol/routing_controls_list_only/index.md b/website/docs/services/route53recoverycontrol/routing_controls_list_only/index.md new file mode 100644 index 0000000..dc1c449 --- /dev/null +++ b/website/docs/services/route53recoverycontrol/routing_controls_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: routing_controls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - routing_controls_list_only + - route53recoverycontrol + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists routing_controls in a region or regions, for all properties use routing_controls + +## Overview + + + + + + + +
Namerouting_controls_list_only
TypeResource
DescriptionAWS Route53 Recovery Control Routing Control resource schema .
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the routing control.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all routing_controls in a region. +```sql +SELECT +region, +routing_control_arn +FROM aws.route53recoverycontrol.routing_controls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routing_controls_list_only resource, see routing_controls + diff --git a/website/docs/services/route53recoverycontrol/safety_rule_tags/index.md b/website/docs/services/route53recoverycontrol/safety_rule_tags/index.md new file mode 100644 index 0000000..675ce08 --- /dev/null +++ b/website/docs/services/route53recoverycontrol/safety_rule_tags/index.md @@ -0,0 +1,89 @@ +--- +title: safety_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - safety_rule_tags + - route53recoverycontrol + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for safety_rules in a region + +## Overview + + + + + + + +
Namesafety_rule_tags
TypeResource
DescriptionResource schema for AWS Route53 Recovery Control basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectAn assertion rule enforces that, when a routing control state is changed, that the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
objectA gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
stringThe name for the safety rule.
stringThe Amazon Resource Name (ARN) of the safety rule.
stringThe Amazon Resource Name (ARN) of the control panel.
stringThe deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
objectThe rule configuration for an assertion rule or gating rule. This is the criteria that you set for specific assertion controls (routing controls) or gating controls. This configuration specifies how many controls must be enabled after a transaction completes.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all safety_rules in a region. +```sql +SELECT +region, +assertion_rule, +gating_rule, +name, +safety_rule_arn, +control_panel_arn, +status, +rule_config, +tag_key, +tag_value +FROM aws.route53recoverycontrol.safety_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the safety_rule_tags resource, see safety_rules + diff --git a/website/docs/services/route53recoverycontrol/safety_rules/index.md b/website/docs/services/route53recoverycontrol/safety_rules/index.md new file mode 100644 index 0000000..fa94260 --- /dev/null +++ b/website/docs/services/route53recoverycontrol/safety_rules/index.md @@ -0,0 +1,259 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a safety_rule resource or lists safety_rules in a region + +## Overview + + + + + + + +
Namesafety_rules
TypeResource
DescriptionResource schema for AWS Route53 Recovery Control basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectAn assertion rule enforces that, when a routing control state is changed, that the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
objectA gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
stringThe name for the safety rule.
stringThe Amazon Resource Name (ARN) of the safety rule.
stringThe Amazon Resource Name (ARN) of the control panel.
stringThe deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
objectThe rule configuration for an assertion rule or gating rule. This is the criteria that you set for specific assertion controls (routing controls) or gating controls. This configuration specifies how many controls must be enabled after a transaction completes.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::Route53RecoveryControl::SafetyRule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all safety_rules in a region. +```sql +SELECT +region, +assertion_rule, +gating_rule, +name, +safety_rule_arn, +control_panel_arn, +status, +rule_config, +tags +FROM aws.route53recoverycontrol.safety_rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual safety_rule. +```sql +SELECT +region, +assertion_rule, +gating_rule, +name, +safety_rule_arn, +control_panel_arn, +status, +rule_config, +tags +FROM aws.route53recoverycontrol.safety_rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new safety_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoverycontrol.safety_rules ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoverycontrol.safety_rules ( + AssertionRule, + GatingRule, + Name, + ControlPanelArn, + RuleConfig, + Tags, + region +) +SELECT + '{{ AssertionRule }}', + '{{ GatingRule }}', + '{{ Name }}', + '{{ ControlPanelArn }}', + '{{ RuleConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: safety_rule + props: + - name: AssertionRule + value: + WaitPeriodMs: '{{ WaitPeriodMs }}' + AssertedControls: + - '{{ AssertedControls[0] }}' + - name: GatingRule + value: + GatingControls: + - '{{ GatingControls[0] }}' + TargetControls: + - '{{ TargetControls[0] }}' + WaitPeriodMs: '{{ WaitPeriodMs }}' + - name: Name + value: '{{ Name }}' + - name: ControlPanelArn + value: '{{ ControlPanelArn }}' + - name: RuleConfig + value: + Type: '{{ Type }}' + Threshold: '{{ Threshold }}' + Inverted: '{{ Inverted }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53recoverycontrol.safety_rules +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +route53-recovery-control-config:ListSafetyRules +``` diff --git a/website/docs/services/route53recoverycontrol/safety_rules_list_only/index.md b/website/docs/services/route53recoverycontrol/safety_rules_list_only/index.md new file mode 100644 index 0000000..98366cd --- /dev/null +++ b/website/docs/services/route53recoverycontrol/safety_rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: safety_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - safety_rules_list_only + - route53recoverycontrol + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists safety_rules in a region or regions, for all properties use safety_rules + +## Overview + + + + + + + +
Namesafety_rules_list_only
TypeResource
DescriptionResource schema for AWS Route53 Recovery Control basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the safety rule.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all safety_rules in a region. +```sql +SELECT +region, +safety_rule_arn +FROM aws.route53recoverycontrol.safety_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the safety_rules_list_only resource, see safety_rules + diff --git a/website/docs/services/route53recoveryreadiness/cell_tags/index.md b/website/docs/services/route53recoveryreadiness/cell_tags/index.md new file mode 100644 index 0000000..926e880 --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/cell_tags/index.md @@ -0,0 +1,83 @@ +--- +title: cell_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cell_tags + - route53recoveryreadiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cells in a region + +## Overview + + + + + + + +
Namecell_tags
TypeResource
DescriptionThe API Schema for AWS Route53 Recovery Readiness Cells.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the cell to create.
stringThe Amazon Resource Name (ARN) of the cell.
arrayA list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions.
arrayThe readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cells in a region. +```sql +SELECT +region, +cell_name, +cell_arn, +cells, +parent_readiness_scopes, +tag_key, +tag_value +FROM aws.route53recoveryreadiness.cell_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cell_tags resource, see cells + diff --git a/website/docs/services/route53recoveryreadiness/cells/index.md b/website/docs/services/route53recoveryreadiness/cells/index.md new file mode 100644 index 0000000..5fe30e3 --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/cells/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cell resource or lists cells in a region + +## Overview + + + + + + + +
Namecells
TypeResource
DescriptionThe API Schema for AWS Route53 Recovery Readiness Cells.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the cell to create.
stringThe Amazon Resource Name (ARN) of the cell.
arrayA list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions.
arrayThe readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
arrayA collection of tags associated with a resource
stringAWS region.
+ +For more information, see AWS::Route53RecoveryReadiness::Cell. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all cells in a region. +```sql +SELECT +region, +cell_name, +cell_arn, +cells, +parent_readiness_scopes, +tags +FROM aws.route53recoveryreadiness.cells +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cell. +```sql +SELECT +region, +cell_name, +cell_arn, +cells, +parent_readiness_scopes, +tags +FROM aws.route53recoveryreadiness.cells +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cell resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoveryreadiness.cells ( + CellName, + Cells, + Tags, + region +) +SELECT +'{{ CellName }}', + '{{ Cells }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoveryreadiness.cells ( + CellName, + Cells, + Tags, + region +) +SELECT + '{{ CellName }}', + '{{ Cells }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cell + props: + - name: CellName + value: '{{ CellName }}' + - name: Cells + value: + - '{{ Cells[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53recoveryreadiness.cells +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +route53-recovery-readiness:ListCells +``` diff --git a/website/docs/services/route53recoveryreadiness/cells_list_only/index.md b/website/docs/services/route53recoveryreadiness/cells_list_only/index.md new file mode 100644 index 0000000..e4fcad4 --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/cells_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cells_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cells_list_only + - route53recoveryreadiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cells in a region or regions, for all properties use cells + +## Overview + + + + + + + +
Namecells_list_only
TypeResource
DescriptionThe API Schema for AWS Route53 Recovery Readiness Cells.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the cell to create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cells in a region. +```sql +SELECT +region, +cell_name +FROM aws.route53recoveryreadiness.cells_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cells_list_only resource, see cells + diff --git a/website/docs/services/route53recoveryreadiness/index.md b/website/docs/services/route53recoveryreadiness/index.md new file mode 100644 index 0000000..0c09282 --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/index.md @@ -0,0 +1,47 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The route53recoveryreadiness service documentation. + +:::info Service Summary + +
+
+total resources: 12
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/route53recoveryreadiness/readiness_check_tags/index.md b/website/docs/services/route53recoveryreadiness/readiness_check_tags/index.md new file mode 100644 index 0000000..bbc3c51 --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/readiness_check_tags/index.md @@ -0,0 +1,81 @@ +--- +title: readiness_check_tags +hide_title: false +hide_table_of_contents: false +keywords: + - readiness_check_tags + - route53recoveryreadiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for readiness_checks in a region + +## Overview + + + + + + + +
Namereadiness_check_tags
TypeResource
DescriptionAws Route53 Recovery Readiness Check Schema and API specification.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource set to check.
stringName of the ReadinessCheck to create.
stringThe Amazon Resource Name (ARN) of the readiness check.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all readiness_checks in a region. +```sql +SELECT +region, +resource_set_name, +readiness_check_name, +readiness_check_arn, +tag_key, +tag_value +FROM aws.route53recoveryreadiness.readiness_check_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the readiness_check_tags resource, see readiness_checks + diff --git a/website/docs/services/route53recoveryreadiness/readiness_checks/index.md b/website/docs/services/route53recoveryreadiness/readiness_checks/index.md new file mode 100644 index 0000000..2ed2ee3 --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/readiness_checks/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a readiness_check resource or lists readiness_checks in a region + +## Overview + + + + + + + +
Namereadiness_checks
TypeResource
DescriptionAws Route53 Recovery Readiness Check Schema and API specification.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource set to check.
stringName of the ReadinessCheck to create.
stringThe Amazon Resource Name (ARN) of the readiness check.
arrayA collection of tags associated with a resource.
stringAWS region.
+ +For more information, see AWS::Route53RecoveryReadiness::ReadinessCheck. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all readiness_checks in a region. +```sql +SELECT +region, +resource_set_name, +readiness_check_name, +readiness_check_arn, +tags +FROM aws.route53recoveryreadiness.readiness_checks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual readiness_check. +```sql +SELECT +region, +resource_set_name, +readiness_check_name, +readiness_check_arn, +tags +FROM aws.route53recoveryreadiness.readiness_checks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new readiness_check resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoveryreadiness.readiness_checks ( + ResourceSetName, + ReadinessCheckName, + Tags, + region +) +SELECT +'{{ ResourceSetName }}', + '{{ ReadinessCheckName }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoveryreadiness.readiness_checks ( + ResourceSetName, + ReadinessCheckName, + Tags, + region +) +SELECT + '{{ ResourceSetName }}', + '{{ ReadinessCheckName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: readiness_check + props: + - name: ResourceSetName + value: '{{ ResourceSetName }}' + - name: ReadinessCheckName + value: '{{ ReadinessCheckName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53recoveryreadiness.readiness_checks +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +route53-recovery-readiness:ListReadinessChecks, +route53-recovery-readiness:GetReadinessChecks +``` diff --git a/website/docs/services/route53recoveryreadiness/readiness_checks_list_only/index.md b/website/docs/services/route53recoveryreadiness/readiness_checks_list_only/index.md new file mode 100644 index 0000000..664e687 --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/readiness_checks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: readiness_checks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - readiness_checks_list_only + - route53recoveryreadiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists readiness_checks in a region or regions, for all properties use readiness_checks + +## Overview + + + + + + + +
Namereadiness_checks_list_only
TypeResource
DescriptionAws Route53 Recovery Readiness Check Schema and API specification.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the ReadinessCheck to create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all readiness_checks in a region. +```sql +SELECT +region, +readiness_check_name +FROM aws.route53recoveryreadiness.readiness_checks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the readiness_checks_list_only resource, see readiness_checks + diff --git a/website/docs/services/route53recoveryreadiness/recovery_group_tags/index.md b/website/docs/services/route53recoveryreadiness/recovery_group_tags/index.md new file mode 100644 index 0000000..8a3f36e --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/recovery_group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: recovery_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - recovery_group_tags + - route53recoveryreadiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for recovery_groups in a region + +## Overview + + + + + + + +
Namerecovery_group_tags
TypeResource
DescriptionAWS Route53 Recovery Readiness Recovery Group Schema and API specifications.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the recovery group to create.
arrayA list of the cell Amazon Resource Names (ARNs) in the recovery group.
stringA collection of tags associated with a resource.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all recovery_groups in a region. +```sql +SELECT +region, +recovery_group_name, +cells, +recovery_group_arn, +tag_key, +tag_value +FROM aws.route53recoveryreadiness.recovery_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recovery_group_tags resource, see recovery_groups + diff --git a/website/docs/services/route53recoveryreadiness/recovery_groups/index.md b/website/docs/services/route53recoveryreadiness/recovery_groups/index.md new file mode 100644 index 0000000..925c997 --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/recovery_groups/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a recovery_group resource or lists recovery_groups in a region + +## Overview + + + + + + + +
Namerecovery_groups
TypeResource
DescriptionAWS Route53 Recovery Readiness Recovery Group Schema and API specifications.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the recovery group to create.
arrayA list of the cell Amazon Resource Names (ARNs) in the recovery group.
stringA collection of tags associated with a resource.
arrayA collection of tags associated with a resource.
stringAWS region.
+ +For more information, see AWS::Route53RecoveryReadiness::RecoveryGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all recovery_groups in a region. +```sql +SELECT +region, +recovery_group_name, +cells, +recovery_group_arn, +tags +FROM aws.route53recoveryreadiness.recovery_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual recovery_group. +```sql +SELECT +region, +recovery_group_name, +cells, +recovery_group_arn, +tags +FROM aws.route53recoveryreadiness.recovery_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new recovery_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoveryreadiness.recovery_groups ( + RecoveryGroupName, + Cells, + Tags, + region +) +SELECT +'{{ RecoveryGroupName }}', + '{{ Cells }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoveryreadiness.recovery_groups ( + RecoveryGroupName, + Cells, + Tags, + region +) +SELECT + '{{ RecoveryGroupName }}', + '{{ Cells }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: recovery_group + props: + - name: RecoveryGroupName + value: '{{ RecoveryGroupName }}' + - name: Cells + value: + - '{{ Cells[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53recoveryreadiness.recovery_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +route53-recovery-readiness:ListRecoveryGroups +``` diff --git a/website/docs/services/route53recoveryreadiness/recovery_groups_list_only/index.md b/website/docs/services/route53recoveryreadiness/recovery_groups_list_only/index.md new file mode 100644 index 0000000..580ea67 --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/recovery_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: recovery_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - recovery_groups_list_only + - route53recoveryreadiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists recovery_groups in a region or regions, for all properties use recovery_groups + +## Overview + + + + + + + +
Namerecovery_groups_list_only
TypeResource
DescriptionAWS Route53 Recovery Readiness Recovery Group Schema and API specifications.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the recovery group to create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all recovery_groups in a region. +```sql +SELECT +region, +recovery_group_name +FROM aws.route53recoveryreadiness.recovery_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recovery_groups_list_only resource, see recovery_groups + diff --git a/website/docs/services/route53recoveryreadiness/resource_set_tags/index.md b/website/docs/services/route53recoveryreadiness/resource_set_tags/index.md new file mode 100644 index 0000000..5abef8a --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/resource_set_tags/index.md @@ -0,0 +1,83 @@ +--- +title: resource_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resource_set_tags + - route53recoveryreadiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resource_sets in a region + +## Overview + + + + + + + +
Nameresource_set_tags
TypeResource
DescriptionSchema for the AWS Route53 Recovery Readiness ResourceSet Resource and API.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource set to create.
arrayA list of resource objects in the resource set.
stringThe Amazon Resource Name (ARN) of the resource set.
stringThe resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resource_sets in a region. +```sql +SELECT +region, +resource_set_name, +resources, +resource_set_arn, +resource_set_type, +tag_key, +tag_value +FROM aws.route53recoveryreadiness.resource_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_set_tags resource, see resource_sets + diff --git a/website/docs/services/route53recoveryreadiness/resource_sets/index.md b/website/docs/services/route53recoveryreadiness/resource_sets/index.md new file mode 100644 index 0000000..202efcd --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/resource_sets/index.md @@ -0,0 +1,250 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_set resource or lists resource_sets in a region + +## Overview + + + + + + + +
Nameresource_sets
TypeResource
DescriptionSchema for the AWS Route53 Recovery Readiness ResourceSet Resource and API.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource set to create.
arrayA list of resource objects in the resource set.
stringThe Amazon Resource Name (ARN) of the resource set.
stringThe resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
arrayA tag to associate with the parameters for a resource set.
stringAWS region.
+ +For more information, see AWS::Route53RecoveryReadiness::ResourceSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_sets in a region. +```sql +SELECT +region, +resource_set_name, +resources, +resource_set_arn, +resource_set_type, +tags +FROM aws.route53recoveryreadiness.resource_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_set. +```sql +SELECT +region, +resource_set_name, +resources, +resource_set_arn, +resource_set_type, +tags +FROM aws.route53recoveryreadiness.resource_sets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoveryreadiness.resource_sets ( + Resources, + ResourceSetType, + region +) +SELECT +'{{ Resources }}', + '{{ ResourceSetType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53recoveryreadiness.resource_sets ( + ResourceSetName, + Resources, + ResourceSetType, + Tags, + region +) +SELECT + '{{ ResourceSetName }}', + '{{ Resources }}', + '{{ ResourceSetType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_set + props: + - name: ResourceSetName + value: '{{ ResourceSetName }}' + - name: Resources + value: + - ResourceArn: '{{ ResourceArn }}' + ComponentId: '{{ ComponentId }}' + DnsTargetResource: + DomainName: '{{ DomainName }}' + RecordSetId: '{{ RecordSetId }}' + HostedZoneArn: '{{ HostedZoneArn }}' + RecordType: '{{ RecordType }}' + TargetResource: + NLBResource: + Arn: '{{ Arn }}' + R53Resource: + DomainName: '{{ DomainName }}' + RecordSetId: '{{ RecordSetId }}' + ReadinessScopes: + - '{{ ReadinessScopes[0] }}' + - name: ResourceSetType + value: '{{ ResourceSetType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53recoveryreadiness.resource_sets +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +route53-recovery-readiness:ListResourceSets +``` diff --git a/website/docs/services/route53recoveryreadiness/resource_sets_list_only/index.md b/website/docs/services/route53recoveryreadiness/resource_sets_list_only/index.md new file mode 100644 index 0000000..aa09634 --- /dev/null +++ b/website/docs/services/route53recoveryreadiness/resource_sets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_sets_list_only + - route53recoveryreadiness + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_sets in a region or regions, for all properties use resource_sets + +## Overview + + + + + + + +
Nameresource_sets_list_only
TypeResource
DescriptionSchema for the AWS Route53 Recovery Readiness ResourceSet Resource and API.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the resource set to create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_sets in a region. +```sql +SELECT +region, +resource_set_name +FROM aws.route53recoveryreadiness.resource_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_sets_list_only resource, see resource_sets + diff --git a/website/docs/services/route53resolver/firewall_domain_list_tags/index.md b/website/docs/services/route53resolver/firewall_domain_list_tags/index.md new file mode 100644 index 0000000..6b370e0 --- /dev/null +++ b/website/docs/services/route53resolver/firewall_domain_list_tags/index.md @@ -0,0 +1,99 @@ +--- +title: firewall_domain_list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_domain_list_tags + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for firewall_domain_lists in a region + +## Overview + + + + + + + +
Namefirewall_domain_list_tags
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallDomainList.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringResourceId
stringArn
stringFirewallDomainListName
integerCount
stringResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallDomainListAssociationStatus
stringServicePrincipal
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
arrayAn inline list of domains to use for this domain list.
stringS3 URL to import domains from.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all firewall_domain_lists in a region. +```sql +SELECT +region, +id, +arn, +name, +domain_count, +status, +status_message, +managed_owner_name, +creator_request_id, +creation_time, +modification_time, +domains, +domain_file_url, +tag_key, +tag_value +FROM aws.route53resolver.firewall_domain_list_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_domain_list_tags resource, see firewall_domain_lists + diff --git a/website/docs/services/route53resolver/firewall_domain_lists/index.md b/website/docs/services/route53resolver/firewall_domain_lists/index.md new file mode 100644 index 0000000..a0f3ecd --- /dev/null +++ b/website/docs/services/route53resolver/firewall_domain_lists/index.md @@ -0,0 +1,266 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a firewall_domain_list resource or lists firewall_domain_lists in a region + +## Overview + + + + + + + +
Namefirewall_domain_lists
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallDomainList.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringResourceId
stringArn
stringFirewallDomainListName
integerCount
stringResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallDomainListAssociationStatus
stringServicePrincipal
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
arrayAn inline list of domains to use for this domain list.
stringS3 URL to import domains from.
arrayTags
stringAWS region.
+ +For more information, see AWS::Route53Resolver::FirewallDomainList. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all firewall_domain_lists in a region. +```sql +SELECT +region, +id, +arn, +name, +domain_count, +status, +status_message, +managed_owner_name, +creator_request_id, +creation_time, +modification_time, +domains, +domain_file_url, +tags +FROM aws.route53resolver.firewall_domain_lists +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual firewall_domain_list. +```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_lists +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new firewall_domain_list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.firewall_domain_lists ( + Name, + Domains, + DomainFileUrl, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ Domains }}', + '{{ DomainFileUrl }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.firewall_domain_lists ( + Name, + Domains, + DomainFileUrl, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Domains }}', + '{{ DomainFileUrl }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: firewall_domain_list + props: + - name: Name + value: '{{ Name }}' + - name: Domains + value: + - '{{ Domains[0] }}' + - name: DomainFileUrl + value: '{{ DomainFileUrl }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53resolver.firewall_domain_lists +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the firewall_domain_lists resource, the following permissions are required: + +### Create +```json +route53resolver:CreateFirewallDomainList, +route53resolver:GetFirewallDomainList, +route53resolver:ImportFirewallDomains, +route53resolver:UpdateFirewallDomains, +route53resolver:TagResource, +route53resolver:ListTagsForResource +``` + +### List +```json +route53resolver:ListFirewallDomainLists, +route53resolver:ListTagsForResource +``` + +### Read +```json +route53resolver:GetFirewallDomainList, +route53resolver:ListTagsForResource +``` + +### Delete +```json +route53resolver:GetFirewallDomainList, +route53resolver:DeleteFirewallDomainList, +route53resolver:UntagResource, +route53resolver:ListTagsForResource +``` + +### Update +```json +route53resolver:GetFirewallDomainList, +route53resolver:ImportFirewallDomains, +route53resolver:UpdateFirewallDomains, +route53resolver:TagResource, +route53resolver:UntagResource, +route53resolver:ListTagsForResource +``` diff --git a/website/docs/services/route53resolver/firewall_domain_lists_list_only/index.md b/website/docs/services/route53resolver/firewall_domain_lists_list_only/index.md new file mode 100644 index 0000000..3e60890 --- /dev/null +++ b/website/docs/services/route53resolver/firewall_domain_lists_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: firewall_domain_lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_domain_lists_list_only + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists firewall_domain_lists in a region or regions, for all properties use firewall_domain_lists + +## Overview + + + + + + + +
Namefirewall_domain_lists_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallDomainList.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringResourceId
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all firewall_domain_lists in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.firewall_domain_lists_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_domain_lists_list_only resource, see firewall_domain_lists + diff --git a/website/docs/services/route53resolver/firewall_rule_group_association_tags/index.md b/website/docs/services/route53resolver/firewall_rule_group_association_tags/index.md new file mode 100644 index 0000000..87b741b --- /dev/null +++ b/website/docs/services/route53resolver/firewall_rule_group_association_tags/index.md @@ -0,0 +1,101 @@ +--- +title: firewall_rule_group_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_group_association_tags + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for firewall_rule_group_associations in a region + +## Overview + + + + + + + +
Namefirewall_rule_group_association_tags
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId
stringArn
stringFirewallRuleGroupId
stringVpcId
stringFirewallRuleGroupAssociationName
integerPriority
stringMutationProtectionStatus
stringServicePrincipal
stringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallDomainListAssociationStatus
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all firewall_rule_group_associations in a region. +```sql +SELECT +region, +id, +arn, +firewall_rule_group_id, +vpc_id, +name, +priority, +mutation_protection, +managed_owner_name, +status, +status_message, +creator_request_id, +creation_time, +modification_time, +tag_key, +tag_value +FROM aws.route53resolver.firewall_rule_group_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_rule_group_association_tags resource, see firewall_rule_group_associations + diff --git a/website/docs/services/route53resolver/firewall_rule_group_associations/index.md b/website/docs/services/route53resolver/firewall_rule_group_associations/index.md new file mode 100644 index 0000000..3bff069 --- /dev/null +++ b/website/docs/services/route53resolver/firewall_rule_group_associations/index.md @@ -0,0 +1,272 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a firewall_rule_group_association resource or lists firewall_rule_group_associations in a region + +## Overview + + + + + + + +
Namefirewall_rule_group_associations
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId
stringArn
stringFirewallRuleGroupId
stringVpcId
stringFirewallRuleGroupAssociationName
integerPriority
stringMutationProtectionStatus
stringServicePrincipal
stringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallDomainListAssociationStatus
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
arrayTags
stringAWS region.
+ +For more information, see AWS::Route53Resolver::FirewallRuleGroupAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all firewall_rule_group_associations in a region. +```sql +SELECT +region, +id, +arn, +firewall_rule_group_id, +vpc_id, +name, +priority, +mutation_protection, +managed_owner_name, +status, +status_message, +creator_request_id, +creation_time, +modification_time, +tags +FROM aws.route53resolver.firewall_rule_group_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual firewall_rule_group_association. +```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_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new firewall_rule_group_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.firewall_rule_group_associations ( + FirewallRuleGroupId, + VpcId, + Priority, + region +) +SELECT +'{{ FirewallRuleGroupId }}', + '{{ VpcId }}', + '{{ Priority }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.firewall_rule_group_associations ( + FirewallRuleGroupId, + VpcId, + Name, + Priority, + MutationProtection, + Tags, + region +) +SELECT + '{{ FirewallRuleGroupId }}', + '{{ VpcId }}', + '{{ Name }}', + '{{ Priority }}', + '{{ MutationProtection }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: firewall_rule_group_association + props: + - name: FirewallRuleGroupId + value: '{{ FirewallRuleGroupId }}' + - name: VpcId + value: '{{ VpcId }}' + - name: Name + value: '{{ Name }}' + - name: Priority + value: '{{ Priority }}' + - name: MutationProtection + value: '{{ MutationProtection }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53resolver.firewall_rule_group_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the firewall_rule_group_associations resource, the following permissions are required: + +### Create +```json +route53resolver:AssociateFirewallRuleGroup, +route53resolver:GetFirewallRuleGroupAssociation, +route53resolver:TagResource, +route53resolver:ListTagsForResource, +ec2:DescribeVpcs +``` + +### Read +```json +route53resolver:GetFirewallRuleGroupAssociation, +route53resolver:ListTagsForResource +``` + +### List +```json +route53resolver:ListFirewallRuleGroupAssociations, +route53resolver:ListTagsForResource +``` + +### Delete +```json +route53resolver:DisassociateFirewallRuleGroup, +route53resolver:GetFirewallRuleGroupAssociation, +route53resolver:UntagResource, +route53resolver:ListTagsForResource +``` + +### Update +```json +route53resolver:UpdateFirewallRuleGroupAssociation, +route53resolver:GetFirewallRuleGroupAssociation, +route53resolver:TagResource, +route53resolver:UntagResource, +route53resolver:ListTagsForResource +``` diff --git a/website/docs/services/route53resolver/firewall_rule_group_associations_list_only/index.md b/website/docs/services/route53resolver/firewall_rule_group_associations_list_only/index.md new file mode 100644 index 0000000..b67f2c6 --- /dev/null +++ b/website/docs/services/route53resolver/firewall_rule_group_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: firewall_rule_group_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_group_associations_list_only + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists firewall_rule_group_associations in a region or regions, for all properties use firewall_rule_group_associations + +## Overview + + + + + + + +
Namefirewall_rule_group_associations_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all firewall_rule_group_associations in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.firewall_rule_group_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_rule_group_associations_list_only resource, see firewall_rule_group_associations + diff --git a/website/docs/services/route53resolver/firewall_rule_group_tags/index.md b/website/docs/services/route53resolver/firewall_rule_group_tags/index.md new file mode 100644 index 0000000..1b98878 --- /dev/null +++ b/website/docs/services/route53resolver/firewall_rule_group_tags/index.md @@ -0,0 +1,99 @@ +--- +title: firewall_rule_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_group_tags + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for firewall_rule_groups in a region + +## Overview + + + + + + + +
Namefirewall_rule_group_tags
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroup.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringResourceId
stringArn
stringFirewallRuleGroupName
integerCount
stringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallRuleGroupStatus
stringAccountId
stringShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
arrayFirewallRules
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all firewall_rule_groups in a region. +```sql +SELECT +region, +id, +arn, +name, +rule_count, +status, +status_message, +owner_id, +share_status, +creator_request_id, +creation_time, +modification_time, +firewall_rules, +tag_key, +tag_value +FROM aws.route53resolver.firewall_rule_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_rule_group_tags resource, see firewall_rule_groups + diff --git a/website/docs/services/route53resolver/firewall_rule_groups/index.md b/website/docs/services/route53resolver/firewall_rule_groups/index.md new file mode 100644 index 0000000..641dde3 --- /dev/null +++ b/website/docs/services/route53resolver/firewall_rule_groups/index.md @@ -0,0 +1,277 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a firewall_rule_group resource or lists firewall_rule_groups in a region + +## Overview + + + + + + + +
Namefirewall_rule_groups
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroup.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringResourceId
stringArn
stringFirewallRuleGroupName
integerCount
stringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallRuleGroupStatus
stringAccountId
stringShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
arrayFirewallRules
arrayTags
stringAWS region.
+ +For more information, see AWS::Route53Resolver::FirewallRuleGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all firewall_rule_groups in a region. +```sql +SELECT +region, +id, +arn, +name, +rule_count, +status, +status_message, +owner_id, +share_status, +creator_request_id, +creation_time, +modification_time, +firewall_rules, +tags +FROM aws.route53resolver.firewall_rule_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual firewall_rule_group. +```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_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new firewall_rule_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.firewall_rule_groups ( + Name, + FirewallRules, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ FirewallRules }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.firewall_rule_groups ( + Name, + FirewallRules, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ FirewallRules }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: firewall_rule_group + props: + - name: Name + value: '{{ Name }}' + - name: FirewallRules + value: + - FirewallDomainListId: '{{ FirewallDomainListId }}' + FirewallThreatProtectionId: '{{ FirewallThreatProtectionId }}' + Priority: '{{ Priority }}' + Action: '{{ Action }}' + BlockResponse: '{{ BlockResponse }}' + BlockOverrideDomain: '{{ BlockOverrideDomain }}' + BlockOverrideDnsType: '{{ BlockOverrideDnsType }}' + BlockOverrideTtl: '{{ BlockOverrideTtl }}' + Qtype: '{{ Qtype }}' + ConfidenceThreshold: '{{ ConfidenceThreshold }}' + DnsThreatProtection: '{{ DnsThreatProtection }}' + FirewallDomainRedirectionAction: '{{ FirewallDomainRedirectionAction }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53resolver.firewall_rule_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the firewall_rule_groups resource, the following permissions are required: + +### Create +```json +route53resolver:CreateFirewallRuleGroup, +route53resolver:GetFirewallRuleGroup, +route53resolver:ListFirewallRules, +route53resolver:CreateFirewallRule, +route53resolver:DeleteFirewallRule, +route53resolver:TagResource, +route53resolver:ListTagsForResource +``` + +### Read +```json +route53resolver:GetFirewallRuleGroup, +route53resolver:ListFirewallRules, +route53resolver:ListTagsForResource +``` + +### List +```json +route53resolver:ListFirewallRuleGroups, +route53resolver:ListTagsForResource +``` + +### Delete +```json +route53resolver:GetFirewallRuleGroup, +route53resolver:DeleteFirewallRuleGroup, +route53resolver:ListFirewallRules, +route53resolver:DeleteFirewallRule, +route53resolver:UntagResource, +route53resolver:ListTagsForResource +``` + +### Update +```json +route53resolver:GetFirewallRuleGroup, +route53resolver:ListFirewallRules, +route53resolver:CreateFirewallRule, +route53resolver:UpdateFirewallRule, +route53resolver:DeleteFirewallRule, +route53resolver:TagResource, +route53resolver:UntagResource, +route53resolver:ListTagsForResource +``` diff --git a/website/docs/services/route53resolver/firewall_rule_groups_list_only/index.md b/website/docs/services/route53resolver/firewall_rule_groups_list_only/index.md new file mode 100644 index 0000000..ea4de3f --- /dev/null +++ b/website/docs/services/route53resolver/firewall_rule_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: firewall_rule_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_groups_list_only + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists firewall_rule_groups in a region or regions, for all properties use firewall_rule_groups + +## Overview + + + + + + + +
Namefirewall_rule_groups_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroup.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringResourceId
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all firewall_rule_groups in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.firewall_rule_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_rule_groups_list_only resource, see firewall_rule_groups + diff --git a/website/docs/services/route53resolver/index.md b/website/docs/services/route53resolver/index.md new file mode 100644 index 0000000..1d5fa9a --- /dev/null +++ b/website/docs/services/route53resolver/index.md @@ -0,0 +1,60 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The route53resolver service documentation. + +:::info Service Summary + +
+
+total resources: 25
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/route53resolver/outpost_resolver_tags/index.md b/website/docs/services/route53resolver/outpost_resolver_tags/index.md new file mode 100644 index 0000000..2f16988 --- /dev/null +++ b/website/docs/services/route53resolver/outpost_resolver_tags/index.md @@ -0,0 +1,97 @@ +--- +title: outpost_resolver_tags +hide_title: false +hide_table_of_contents: false +keywords: + - outpost_resolver_tags + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for outpost_resolvers in a region + +## Overview + + + + + + + +
Nameoutpost_resolver_tags
TypeResource
DescriptionResource schema for AWS::Route53Resolver::OutpostResolver.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId
stringThe id of the creator request.
stringThe OutpostResolver name.
stringThe OutpostResolver ARN.
stringThe Outpost ARN.
stringThe OutpostResolver instance type.
stringThe OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION.
stringThe OutpostResolver status message.
integerThe number of OutpostResolvers.
stringThe OutpostResolver creation time
stringThe OutpostResolver last modified time
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all outpost_resolvers in a region. +```sql +SELECT +region, +id, +creator_request_id, +name, +arn, +outpost_arn, +preferred_instance_type, +status, +status_message, +instance_count, +creation_time, +modification_time, +tag_key, +tag_value +FROM aws.route53resolver.outpost_resolver_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the outpost_resolver_tags resource, see outpost_resolvers + diff --git a/website/docs/services/route53resolver/outpost_resolvers/index.md b/website/docs/services/route53resolver/outpost_resolvers/index.md new file mode 100644 index 0000000..5ee827d --- /dev/null +++ b/website/docs/services/route53resolver/outpost_resolvers/index.md @@ -0,0 +1,262 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an outpost_resolver resource or lists outpost_resolvers in a region + +## Overview + + + + + + + +
Nameoutpost_resolvers
TypeResource
DescriptionResource schema for AWS::Route53Resolver::OutpostResolver.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId
stringThe id of the creator request.
stringThe OutpostResolver name.
stringThe OutpostResolver ARN.
stringThe Outpost ARN.
stringThe OutpostResolver instance type.
stringThe OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION.
stringThe OutpostResolver status message.
integerThe number of OutpostResolvers.
stringThe OutpostResolver creation time
stringThe OutpostResolver last modified time
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Route53Resolver::OutpostResolver. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all outpost_resolvers in a region. +```sql +SELECT +region, +id, +creator_request_id, +name, +arn, +outpost_arn, +preferred_instance_type, +status, +status_message, +instance_count, +creation_time, +modification_time, +tags +FROM aws.route53resolver.outpost_resolvers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual outpost_resolver. +```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_resolvers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new outpost_resolver resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.outpost_resolvers ( + Name, + OutpostArn, + PreferredInstanceType, + region +) +SELECT +'{{ Name }}', + '{{ OutpostArn }}', + '{{ PreferredInstanceType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.outpost_resolvers ( + Name, + OutpostArn, + PreferredInstanceType, + InstanceCount, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ OutpostArn }}', + '{{ PreferredInstanceType }}', + '{{ InstanceCount }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: outpost_resolver + props: + - name: Name + value: '{{ Name }}' + - name: OutpostArn + value: '{{ OutpostArn }}' + - name: PreferredInstanceType + value: '{{ PreferredInstanceType }}' + - name: InstanceCount + value: '{{ InstanceCount }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53resolver.outpost_resolvers +WHERE data__Identifier = '' +AND 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, +route53resolver:TagResource +``` + +### 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 +``` + +### List +```json +route53resolver:ListOutpostResolvers, +route53resolver:ListTagsForResource +``` diff --git a/website/docs/services/route53resolver/outpost_resolvers_list_only/index.md b/website/docs/services/route53resolver/outpost_resolvers_list_only/index.md new file mode 100644 index 0000000..1be96b1 --- /dev/null +++ b/website/docs/services/route53resolver/outpost_resolvers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: outpost_resolvers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - outpost_resolvers_list_only + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists outpost_resolvers in a region or regions, for all properties use outpost_resolvers + +## Overview + + + + + + + +
Nameoutpost_resolvers_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::OutpostResolver.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all outpost_resolvers in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.outpost_resolvers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the outpost_resolvers_list_only resource, see outpost_resolvers + diff --git a/website/docs/services/route53resolver/resolver_configs/index.md b/website/docs/services/route53resolver/resolver_configs/index.md new file mode 100644 index 0000000..e2e530d --- /dev/null +++ b/website/docs/services/route53resolver/resolver_configs/index.md @@ -0,0 +1,208 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resolver_config resource or lists resolver_configs in a region + +## Overview + + + + + + + +
Nameresolver_configs
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverConfig.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringId
stringAccountId
stringResourceId
stringResolverAutodefinedReverseStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
stringRepresents the desired status of AutodefinedReverse. The only supported value on creation is DISABLE. Deletion of this resource will return AutodefinedReverse to its default value (ENABLED).
stringAWS region.
+ +For more information, see AWS::Route53Resolver::ResolverConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resolver_configs in a region. +```sql +SELECT +region, +id, +owner_id, +resource_id, +autodefined_reverse, +autodefined_reverse_flag +FROM aws.route53resolver.resolver_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resolver_config. +```sql +SELECT +region, +id, +owner_id, +resource_id, +autodefined_reverse, +autodefined_reverse_flag +FROM aws.route53resolver.resolver_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resolver_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolver_configs ( + ResourceId, + AutodefinedReverseFlag, + region +) +SELECT +'{{ ResourceId }}', + '{{ AutodefinedReverseFlag }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolver_configs ( + ResourceId, + AutodefinedReverseFlag, + region +) +SELECT + '{{ ResourceId }}', + '{{ AutodefinedReverseFlag }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resolver_config + props: + - name: ResourceId + value: '{{ ResourceId }}' + - name: AutodefinedReverseFlag + value: '{{ AutodefinedReverseFlag }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53resolver.resolver_configs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +route53resolver:GetResolverConfig, +ec2:DescribeVpcs +``` + +### Delete +```json +route53resolver:UpdateResolverConfig, +route53resolver:ListResolverConfigs, +ec2:DescribeVpcs +``` + +### List +```json +route53resolver:ListResolverConfigs, +ec2:DescribeVpcs +``` diff --git a/website/docs/services/route53resolver/resolver_configs_list_only/index.md b/website/docs/services/route53resolver/resolver_configs_list_only/index.md new file mode 100644 index 0000000..a298eff --- /dev/null +++ b/website/docs/services/route53resolver/resolver_configs_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: resolver_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_configs_list_only + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolver_configs in a region or regions, for all properties use resolver_configs + +## Overview + + + + + + + +
Nameresolver_configs_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverConfig.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringId
stringResourceId
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolver_configs in a region. +```sql +SELECT +region, +resource_id +FROM aws.route53resolver.resolver_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_configs_list_only resource, see resolver_configs + diff --git a/website/docs/services/route53resolver/resolver_query_logging_config_associations/index.md b/website/docs/services/route53resolver/resolver_query_logging_config_associations/index.md new file mode 100644 index 0000000..5c9347c --- /dev/null +++ b/website/docs/services/route53resolver/resolver_query_logging_config_associations/index.md @@ -0,0 +1,218 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resolver_query_logging_config_association resource or lists resolver_query_logging_config_associations in a region + +## Overview + + + + + + + +
Nameresolver_query_logging_config_associations
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringId
stringResolverQueryLogConfigId
stringResourceId
stringResolverQueryLogConfigAssociationStatus
stringResolverQueryLogConfigAssociationError
stringResolverQueryLogConfigAssociationErrorMessage
stringRfc3339TimeString
stringAWS region.
+ +For more information, see AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resolver_query_logging_config_associations in a region. +```sql +SELECT +region, +id, +resolver_query_log_config_id, +resource_id, +status, +error, +error_message, +creation_time +FROM aws.route53resolver.resolver_query_logging_config_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resolver_query_logging_config_association. +```sql +SELECT +region, +id, +resolver_query_log_config_id, +resource_id, +status, +error, +error_message, +creation_time +FROM aws.route53resolver.resolver_query_logging_config_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resolver_query_logging_config_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolver_query_logging_config_associations ( + ResolverQueryLogConfigId, + ResourceId, + region +) +SELECT +'{{ ResolverQueryLogConfigId }}', + '{{ ResourceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolver_query_logging_config_associations ( + ResolverQueryLogConfigId, + ResourceId, + region +) +SELECT + '{{ ResolverQueryLogConfigId }}', + '{{ ResourceId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resolver_query_logging_config_association + props: + - name: ResolverQueryLogConfigId + value: '{{ ResolverQueryLogConfigId }}' + - name: ResourceId + value: '{{ ResourceId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53resolver.resolver_query_logging_config_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +resolverquerylogging:GetConfigAssociation, +route53resolver:GetResolverQueryLogConfigAssociation +``` + +### Delete +```json +resolverquerylogging:DisassociateConfig, +resolverquerylogging:ListConfigAssociation, +route53resolver:DisassociateResolverQueryLogConfig, +route53resolver:ListResolverQueryLogConfigAssociations, +route53resolver:GetResolverQueryLogConfigAssociation +``` + +### List +```json +resolverquerylogging:ListConfigAssociations, +route53resolver:ListResolverQueryLogConfigAssociations +``` diff --git a/website/docs/services/route53resolver/resolver_query_logging_config_associations_list_only/index.md b/website/docs/services/route53resolver/resolver_query_logging_config_associations_list_only/index.md new file mode 100644 index 0000000..931571b --- /dev/null +++ b/website/docs/services/route53resolver/resolver_query_logging_config_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resolver_query_logging_config_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_query_logging_config_associations_list_only + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolver_query_logging_config_associations in a region or regions, for all properties use resolver_query_logging_config_associations + +## Overview + + + + + + + +
Nameresolver_query_logging_config_associations_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolver_query_logging_config_associations in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.resolver_query_logging_config_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_query_logging_config_associations_list_only resource, see resolver_query_logging_config_associations + diff --git a/website/docs/services/route53resolver/resolver_query_logging_configs/index.md b/website/docs/services/route53resolver/resolver_query_logging_configs/index.md new file mode 100644 index 0000000..ad20105 --- /dev/null +++ b/website/docs/services/route53resolver/resolver_query_logging_configs/index.md @@ -0,0 +1,234 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resolver_query_logging_config resource or lists resolver_query_logging_configs in a region + +## Overview + + + + + + + +
Nameresolver_query_logging_configs
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfig.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringResourceId
stringAccountId
stringResolverQueryLogConfigStatus, possible values are CREATING, CREATED, DELETED AND FAILED.
stringShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
integerCount
stringArn
stringResolverQueryLogConfigName
stringThe id of the creator request.
stringdestination arn
stringRfc3339TimeString
stringAWS region.
+ +For more information, see AWS::Route53Resolver::ResolverQueryLoggingConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resolver_query_logging_configs in a region. +```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_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resolver_query_logging_config. +```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_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resolver_query_logging_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolver_query_logging_configs ( + Name, + DestinationArn, + region +) +SELECT +'{{ Name }}', + '{{ DestinationArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolver_query_logging_configs ( + Name, + DestinationArn, + region +) +SELECT + '{{ Name }}', + '{{ DestinationArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resolver_query_logging_config + props: + - name: Name + value: '{{ Name }}' + - name: DestinationArn + value: '{{ DestinationArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53resolver.resolver_query_logging_configs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +resolverquerylogging:GetConfig, +route53resolver:GetResolverQueryLogConfig +``` + +### Delete +```json +resolverquerylogging:DeleteConfig, +resolverquerylogging:ListConfig, +route53resolver:DeleteResolverQueryLogConfig, +route53resolver:ListResolverQueryLogConfigs +``` + +### List +```json +resolverquerylogging:ListConfig, +route53resolver:ListResolverQueryLogConfigs +``` diff --git a/website/docs/services/route53resolver/resolver_query_logging_configs_list_only/index.md b/website/docs/services/route53resolver/resolver_query_logging_configs_list_only/index.md new file mode 100644 index 0000000..0f6a5a2 --- /dev/null +++ b/website/docs/services/route53resolver/resolver_query_logging_configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resolver_query_logging_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_query_logging_configs_list_only + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolver_query_logging_configs in a region or regions, for all properties use resolver_query_logging_configs + +## Overview + + + + + + + +
Nameresolver_query_logging_configs_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfig.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringResourceId
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolver_query_logging_configs in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.resolver_query_logging_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_query_logging_configs_list_only resource, see resolver_query_logging_configs + diff --git a/website/docs/services/route53resolver/resolver_rule_associations/index.md b/website/docs/services/route53resolver/resolver_rule_associations/index.md new file mode 100644 index 0000000..96ad090 --- /dev/null +++ b/website/docs/services/route53resolver/resolver_rule_associations/index.md @@ -0,0 +1,206 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resolver_rule_association resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of the VPC that you associated the Resolver rule with.
stringThe ID of the Resolver rule that you associated with the VPC that is specified by VPCId.
string
stringThe name of an association between a Resolver rule and a VPC.
stringAWS region.
+ +For more information, see AWS::Route53Resolver::ResolverRuleAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resolver_rule_associations in a region. +```sql +SELECT +region, +vpc_id, +resolver_rule_id, +resolver_rule_association_id, +name +FROM aws.route53resolver.resolver_rule_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resolver_rule_association. +```sql +SELECT +region, +vpc_id, +resolver_rule_id, +resolver_rule_association_id, +name +FROM aws.route53resolver.resolver_rule_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resolver_rule_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolver_rule_associations ( + VPCId, + ResolverRuleId, + region +) +SELECT +'{{ VPCId }}', + '{{ ResolverRuleId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolver_rule_associations ( + VPCId, + ResolverRuleId, + Name, + region +) +SELECT + '{{ VPCId }}', + '{{ ResolverRuleId }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resolver_rule_association + props: + - name: VPCId + value: '{{ VPCId }}' + - name: ResolverRuleId + value: '{{ ResolverRuleId }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53resolver.resolver_rule_associations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +route53resolver:GetResolverRuleAssociation +``` + +### Delete +```json +route53resolver:DisassociateResolverRule, +route53resolver:GetResolverRuleAssociation +``` + +### List +```json +route53resolver:ListResolverRuleAssociations +``` diff --git a/website/docs/services/route53resolver/resolver_rule_associations_list_only/index.md b/website/docs/services/route53resolver/resolver_rule_associations_list_only/index.md new file mode 100644 index 0000000..66608a0 --- /dev/null +++ b/website/docs/services/route53resolver/resolver_rule_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resolver_rule_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_rule_associations_list_only + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolver_rule_associations in a region or regions, for all properties use resolver_rule_associations + +## Overview + + + + + + + +
Nameresolver_rule_associations_list_only
TypeResource
DescriptionIn the response to an [AssociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html), [DisassociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html), or [ListResolverRuleAssociations](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) request, provides information about an association between a resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolver_rule_associations in a region. +```sql +SELECT +region, +resolver_rule_association_id +FROM aws.route53resolver.resolver_rule_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_rule_associations_list_only resource, see resolver_rule_associations + diff --git a/website/docs/services/route53resolver/resolver_rule_tags/index.md b/website/docs/services/route53resolver/resolver_rule_tags/index.md new file mode 100644 index 0000000..856574d --- /dev/null +++ b/website/docs/services/route53resolver/resolver_rule_tags/index.md @@ -0,0 +1,89 @@ +--- +title: resolver_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_rule_tags + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resolver_rules in a region + +## Overview + + + + + + + +
Nameresolver_rule_tags
TypeResource
DescriptionResource Type definition for AWS::Route53Resolver::ResolverRule
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the endpoint that the rule is associated with.
stringDNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
stringWhen you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
stringThe ID of the endpoint that the rule is associated with.
stringThe Amazon Resource Name (ARN) of the resolver rule.
arrayAn array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.
stringThe name for the Resolver rule
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resolver_rules in a region. +```sql +SELECT +region, +resolver_endpoint_id, +domain_name, +rule_type, +resolver_rule_id, +arn, +target_ips, +name, +tag_key, +tag_value +FROM aws.route53resolver.resolver_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_rule_tags resource, see resolver_rules + diff --git a/website/docs/services/route53resolver/resolver_rules/index.md b/website/docs/services/route53resolver/resolver_rules/index.md new file mode 100644 index 0000000..b2a28b0 --- /dev/null +++ b/website/docs/services/route53resolver/resolver_rules/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resolver_rule resource or lists resolver_rules in a region + +## Overview + + + + + + + +
Nameresolver_rules
TypeResource
DescriptionResource Type definition for AWS::Route53Resolver::ResolverRule
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the endpoint that the rule is associated with.
stringDNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
stringWhen you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
stringThe ID of the endpoint that the rule is associated with.
stringThe Amazon Resource Name (ARN) of the resolver rule.
arrayAn array of key-value pairs to apply to this resource.
arrayAn array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.
stringThe name for the Resolver rule
stringAWS region.
+ +For more information, see AWS::Route53Resolver::ResolverRule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resolver_rules in a region. +```sql +SELECT +region, +resolver_endpoint_id, +domain_name, +rule_type, +resolver_rule_id, +arn, +tags, +target_ips, +name +FROM aws.route53resolver.resolver_rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resolver_rule. +```sql +SELECT +region, +resolver_endpoint_id, +domain_name, +rule_type, +resolver_rule_id, +arn, +tags, +target_ips, +name +FROM aws.route53resolver.resolver_rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resolver_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolver_rules ( + RuleType, + region +) +SELECT +'{{ RuleType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolver_rules ( + ResolverEndpointId, + DomainName, + RuleType, + Tags, + TargetIps, + Name, + region +) +SELECT + '{{ ResolverEndpointId }}', + '{{ DomainName }}', + '{{ RuleType }}', + '{{ Tags }}', + '{{ TargetIps }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resolver_rule + props: + - name: ResolverEndpointId + value: '{{ ResolverEndpointId }}' + - name: DomainName + value: '{{ DomainName }}' + - name: RuleType + value: '{{ RuleType }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: TargetIps + value: + - Ipv6: '{{ Ipv6 }}' + Ip: '{{ Ip }}' + Port: '{{ Port }}' + Protocol: '{{ Protocol }}' + ServerNameIndication: '{{ ServerNameIndication }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53resolver.resolver_rules +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resolver_rules resource, the following permissions are required: + +### Read +```json +route53resolver:GetResolverRule, +route53resolver:ListTagsForResource +``` + +### Create +```json +route53resolver:CreateResolverRule, +route53resolver:GetResolverRule, +route53resolver:ListTagsForResource, +route53resolver:TagResource +``` + +### Update +```json +route53resolver:UpdateResolverRule, +route53resolver:GetResolverRule, +route53resolver:ListTagsForResource, +route53resolver:TagResource, +route53resolver:UntagResource +``` + +### List +```json +route53resolver:ListResolverRules +``` + +### Delete +```json +route53resolver:DeleteResolverRule, +route53resolver:GetResolverRule +``` diff --git a/website/docs/services/route53resolver/resolver_rules_list_only/index.md b/website/docs/services/route53resolver/resolver_rules_list_only/index.md new file mode 100644 index 0000000..693beb8 --- /dev/null +++ b/website/docs/services/route53resolver/resolver_rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resolver_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_rules_list_only + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolver_rules in a region or regions, for all properties use resolver_rules + +## Overview + + + + + + + +
Nameresolver_rules_list_only
TypeResource
DescriptionResource Type definition for AWS::Route53Resolver::ResolverRule
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the endpoint that the rule is associated with.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolver_rules in a region. +```sql +SELECT +region, +resolver_rule_id +FROM aws.route53resolver.resolver_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_rules_list_only resource, see resolver_rules + diff --git a/website/docs/services/route53resolver/resolverdnssec_configs/index.md b/website/docs/services/route53resolver/resolverdnssec_configs/index.md new file mode 100644 index 0000000..457d848 --- /dev/null +++ b/website/docs/services/route53resolver/resolverdnssec_configs/index.md @@ -0,0 +1,201 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resolverdnssec_config resource or lists resolverdnssec_configs in a region + +## Overview + + + + + + + +
Nameresolverdnssec_configs
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverDNSSECConfig.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringId
stringAccountId
stringResourceId
stringResolverDNSSECValidationStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
stringAWS region.
+ +For more information, see AWS::Route53Resolver::ResolverDNSSECConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resolverdnssec_configs in a region. +```sql +SELECT +region, +id, +owner_id, +resource_id, +validation_status +FROM aws.route53resolver.resolverdnssec_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resolverdnssec_config. +```sql +SELECT +region, +id, +owner_id, +resource_id, +validation_status +FROM aws.route53resolver.resolverdnssec_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resolverdnssec_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolverdnssec_configs ( + ResourceId, + region +) +SELECT +'{{ ResourceId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.route53resolver.resolverdnssec_configs ( + ResourceId, + region +) +SELECT + '{{ ResourceId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resolverdnssec_config + props: + - name: ResourceId + value: '{{ ResourceId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.route53resolver.resolverdnssec_configs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +resolverdnssec:GetConfig, +route53resolver:ListResolverDnssecConfigs +``` + +### Delete +```json +resolverdnssec:DeleteConfig, +route53resolver:UpdateResolverDnssecConfig, +route53resolver:ListResolverDnssecConfigs, +ec2:DescribeVpcs +``` + +### List +```json +resolverdnssec:ListConfig, +route53resolver:ListResolverDnssecConfigs +``` diff --git a/website/docs/services/route53resolver/resolverdnssec_configs_list_only/index.md b/website/docs/services/route53resolver/resolverdnssec_configs_list_only/index.md new file mode 100644 index 0000000..80986b4 --- /dev/null +++ b/website/docs/services/route53resolver/resolverdnssec_configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resolverdnssec_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolverdnssec_configs_list_only + - route53resolver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolverdnssec_configs in a region or regions, for all properties use resolverdnssec_configs + +## Overview + + + + + + + +
Nameresolverdnssec_configs_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverDNSSECConfig.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolverdnssec_configs in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.resolverdnssec_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolverdnssec_configs_list_only resource, see resolverdnssec_configs + diff --git a/website/docs/services/rum/app_monitor_tags/index.md b/website/docs/services/rum/app_monitor_tags/index.md new file mode 100644 index 0000000..885268f --- /dev/null +++ b/website/docs/services/rum/app_monitor_tags/index.md @@ -0,0 +1,87 @@ +--- +title: app_monitor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_monitor_tags + - rum + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for app_monitors in a region + +## Overview + + + + + + + +
Nameapp_monitor_tags
TypeResource
DescriptionResource Type definition for AWS::RUM::AppMonitor
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique ID of the new app monitor.
stringA name for the app monitor
stringThe top-level internet domain name for which your application has administrative authority.
booleanData collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false
objectAppMonitor configuration
objectAppMonitor custom events configuration
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all app_monitors in a region. +```sql +SELECT +region, +id, +name, +domain, +cw_log_enabled, +app_monitor_configuration, +custom_events, +tag_key, +tag_value +FROM aws.rum.app_monitor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_monitor_tags resource, see app_monitors + diff --git a/website/docs/services/rum/app_monitors/index.md b/website/docs/services/rum/app_monitors/index.md new file mode 100644 index 0000000..bea7ab6 --- /dev/null +++ b/website/docs/services/rum/app_monitors/index.md @@ -0,0 +1,344 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an app_monitor resource or lists app_monitors in a region + +## Overview + + + + + + + +
Nameapp_monitors
TypeResource
DescriptionResource Type definition for AWS::RUM::AppMonitor
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique ID of the new app monitor.
stringA name for the app monitor
stringThe top-level internet domain name for which your application has administrative authority.
booleanData collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false
arrayAssigns one or more tags (key-value pairs) to the app monitor. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.You can associate as many as 50 tags with an app monitor.
objectAppMonitor configuration
objectAppMonitor custom events configuration
stringAWS region.
+ +For more information, see AWS::RUM::AppMonitor. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all app_monitors in a region. +```sql +SELECT +region, +id, +name, +domain, +cw_log_enabled, +tags, +app_monitor_configuration, +custom_events +FROM aws.rum.app_monitors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual app_monitor. +```sql +SELECT +region, +id, +name, +domain, +cw_log_enabled, +tags, +app_monitor_configuration, +custom_events +FROM aws.rum.app_monitors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new app_monitor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.rum.app_monitors ( + Name, + Domain, + region +) +SELECT +'{{ Name }}', + '{{ Domain }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.rum.app_monitors ( + Name, + Domain, + CwLogEnabled, + Tags, + AppMonitorConfiguration, + CustomEvents, + region +) +SELECT + '{{ Name }}', + '{{ Domain }}', + '{{ CwLogEnabled }}', + '{{ Tags }}', + '{{ AppMonitorConfiguration }}', + '{{ CustomEvents }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: app_monitor + props: + - name: Name + value: '{{ Name }}' + - name: Domain + value: '{{ Domain }}' + - name: CwLogEnabled + value: '{{ CwLogEnabled }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: AppMonitorConfiguration + value: + IdentityPoolId: '{{ IdentityPoolId }}' + ExcludedPages: + - '{{ ExcludedPages[0] }}' + IncludedPages: null + FavoritePages: + - '{{ FavoritePages[0] }}' + SessionSampleRate: null + GuestRoleArn: '{{ GuestRoleArn }}' + AllowCookies: '{{ AllowCookies }}' + Telemetries: + - '{{ Telemetries[0] }}' + EnableXRay: '{{ EnableXRay }}' + MetricDestinations: + - Destination: '{{ Destination }}' + DestinationArn: '{{ DestinationArn }}' + IamRoleArn: '{{ IamRoleArn }}' + MetricDefinitions: + - Name: '{{ Name }}' + Namespace: '{{ Namespace }}' + ValueKey: '{{ ValueKey }}' + UnitLabel: '{{ UnitLabel }}' + DimensionKeys: {} + EventPattern: '{{ EventPattern }}' + - name: CustomEvents + value: + Status: '{{ Status }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.rum.app_monitors +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the app_monitors resource, the following permissions are required: + +### Create +```json +rum:GetAppMonitor, +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, +rum:ListTagsForResource, +cognito-identity:DescribeIdentityPool, +iam:GetRole, +iam:CreateServiceLinkedRole, +iam:PassRole, +rum:PutRumMetricsDestination, +rum:BatchCreateRumMetricDefinitions, +rum:ListRumMetricsDestinations, +rum:BatchGetRumMetricDefinitions +``` + +### Read +```json +rum:GetAppMonitor, +dynamodb:GetItem, +s3:GetObject, +s3:DoesObjectExist, +s3:GetObjectAcl, +rum:ListTagsForResource, +rum:ListRumMetricsDestinations, +rum:BatchGetRumMetricDefinitions +``` + +### Update +```json +rum:GetAppMonitor, +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, +iam:PassRole, +rum:PutRumMetricsDestination, +rum:DeleteRumMetricsDestination, +rum:ListRumMetricsDestinations, +rum:BatchCreateRumMetricDefinitions, +rum:BatchDeleteRumMetricDefinitions, +rum:BatchGetRumMetricDefinitions, +rum:UpdateRumMetricDefinition +``` + +### Delete +```json +rum:GetAppMonitor, +rum:DeleteAppMonitor, +dynamodb:DeleteItem, +dynamodb:Query, +logs:DeleteLogDelivery, +s3:DeleteObject, +s3:DoesObjectExist, +rum:UntagResource, +rum:ListTagsForResource, +rum:DeleteRumMetricsDestination, +rum:BatchDeleteRumMetricDefinitions, +rum:ListRumMetricsDestinations, +rum:BatchGetRumMetricDefinitions +``` + +### 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/website/docs/services/rum/app_monitors_list_only/index.md b/website/docs/services/rum/app_monitors_list_only/index.md new file mode 100644 index 0000000..e268be4 --- /dev/null +++ b/website/docs/services/rum/app_monitors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: app_monitors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - app_monitors_list_only + - rum + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists app_monitors in a region or regions, for all properties use app_monitors + +## Overview + + + + + + + +
Nameapp_monitors_list_only
TypeResource
DescriptionResource Type definition for AWS::RUM::AppMonitor
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the app monitor
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all app_monitors in a region. +```sql +SELECT +region, +name +FROM aws.rum.app_monitors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_monitors_list_only resource, see app_monitors + diff --git a/website/docs/services/rum/index.md b/website/docs/services/rum/index.md new file mode 100644 index 0000000..831a34f --- /dev/null +++ b/website/docs/services/rum/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The rum service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/s3/access_grant_tags/index.md b/website/docs/services/s3/access_grant_tags/index.md new file mode 100644 index 0000000..806873f --- /dev/null +++ b/website/docs/services/s3/access_grant_tags/index.md @@ -0,0 +1,93 @@ +--- +title: access_grant_tags +hide_title: false +hide_table_of_contents: false +keywords: + - access_grant_tags + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for access_grants in a region + +## Overview + + + + + + + +
Nameaccess_grant_tags
TypeResource
DescriptionThe AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID assigned to this access grant.
stringThe custom S3 location to be accessed by the grantee
stringThe level of access to be afforded to the grantee
stringThe ARN of the application grantees will use to access the location
stringThe type of S3SubPrefix.
stringThe S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
stringThe Amazon Resource Name (ARN) of the specified access grant.
objectThe principal who will be granted permission to access S3.
objectThe configuration options of the grant location, which is the S3 path to the data to which you are granting access.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all access_grants in a region. +```sql +SELECT +region, +access_grant_id, +access_grants_location_id, +permission, +application_arn, +s3_prefix_type, +grant_scope, +access_grant_arn, +grantee, +access_grants_location_configuration, +tag_key, +tag_value +FROM aws.s3.access_grant_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grant_tags resource, see access_grants + diff --git a/website/docs/services/s3/access_grants/index.md b/website/docs/services/s3/access_grants/index.md new file mode 100644 index 0000000..4633f1c --- /dev/null +++ b/website/docs/services/s3/access_grants/index.md @@ -0,0 +1,257 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_grant resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID assigned to this access grant.
stringThe custom S3 location to be accessed by the grantee
array
stringThe level of access to be afforded to the grantee
stringThe ARN of the application grantees will use to access the location
stringThe type of S3SubPrefix.
stringThe S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
stringThe Amazon Resource Name (ARN) of the specified access grant.
objectThe principal who will be granted permission to access S3.
objectThe configuration options of the grant location, which is the S3 path to the data to which you are granting access.
stringAWS region.
+ +For more information, see AWS::S3::AccessGrant. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_grants in a region. +```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_grants +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_grant. +```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_grants +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_grant resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3.access_grants ( + AccessGrantsLocationId, + Permission, + Grantee, + region +) +SELECT +'{{ AccessGrantsLocationId }}', + '{{ Permission }}', + '{{ Grantee }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3.access_grants ( + AccessGrantsLocationId, + Tags, + Permission, + ApplicationArn, + S3PrefixType, + Grantee, + AccessGrantsLocationConfiguration, + region +) +SELECT + '{{ AccessGrantsLocationId }}', + '{{ Tags }}', + '{{ Permission }}', + '{{ ApplicationArn }}', + '{{ S3PrefixType }}', + '{{ Grantee }}', + '{{ AccessGrantsLocationConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_grant + props: + - name: AccessGrantsLocationId + value: '{{ AccessGrantsLocationId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Permission + value: '{{ Permission }}' + - name: ApplicationArn + value: '{{ ApplicationArn }}' + - name: S3PrefixType + value: '{{ S3PrefixType }}' + - name: Grantee + value: + GranteeType: '{{ GranteeType }}' + GranteeIdentifier: '{{ GranteeIdentifier }}' + - name: AccessGrantsLocationConfiguration + value: + S3SubPrefix: '{{ S3SubPrefix }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3.access_grants +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the access_grants resource, the following permissions are required: + +### Create +```json +s3:CreateAccessGrant, +s3:TagResource +``` + +### Read +```json +s3:GetAccessGrant, +s3:ListTagsForResource +``` + +### Delete +```json +s3:DeleteAccessGrant +``` + +### List +```json +s3:ListAccessGrants +``` + +### Update +```json +s3:TagResource, +s3:UntagResource +``` diff --git a/website/docs/services/s3/access_grants_instance_tags/index.md b/website/docs/services/s3/access_grants_instance_tags/index.md new file mode 100644 index 0000000..b929154 --- /dev/null +++ b/website/docs/services/s3/access_grants_instance_tags/index.md @@ -0,0 +1,81 @@ +--- +title: access_grants_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_instance_tags + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for access_grants_instances in a region + +## Overview + + + + + + + +
Nameaccess_grants_instance_tags
TypeResource
DescriptionThe AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified Access Grants instance.
stringThe Amazon Resource Name (ARN) of the specified AWS Identity Center.
stringA unique identifier for the specified access grants instance.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all access_grants_instances in a region. +```sql +SELECT +region, +access_grants_instance_arn, +identity_center_arn, +access_grants_instance_id, +tag_key, +tag_value +FROM aws.s3.access_grants_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grants_instance_tags resource, see access_grants_instances + diff --git a/website/docs/services/s3/access_grants_instances/index.md b/website/docs/services/s3/access_grants_instances/index.md new file mode 100644 index 0000000..96eebf6 --- /dev/null +++ b/website/docs/services/s3/access_grants_instances/index.md @@ -0,0 +1,212 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_grants_instance resource or lists 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
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified Access Grants instance.
stringThe Amazon Resource Name (ARN) of the specified AWS Identity Center.
stringA unique identifier for the specified access grants instance.
array
stringAWS region.
+ +For more information, see AWS::S3::AccessGrantsInstance. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_grants_instances in a region. +```sql +SELECT +region, +access_grants_instance_arn, +identity_center_arn, +access_grants_instance_id, +tags +FROM aws.s3.access_grants_instances +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_grants_instance. +```sql +SELECT +region, +access_grants_instance_arn, +identity_center_arn, +access_grants_instance_id, +tags +FROM aws.s3.access_grants_instances +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_grants_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3.access_grants_instances ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3.access_grants_instances ( + IdentityCenterArn, + Tags, + region +) +SELECT + '{{ IdentityCenterArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_grants_instance + props: + - name: IdentityCenterArn + value: '{{ IdentityCenterArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3.access_grants_instances +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the access_grants_instances resource, the following permissions are required: + +### Create +```json +s3:CreateAccessGrantsInstance, +s3:TagResource +``` + +### Read +```json +s3:GetAccessGrantsInstance, +s3:ListTagsForResource +``` + +### Delete +```json +s3:DeleteAccessGrantsInstance +``` + +### Update +```json +s3:TagResource, +s3:UntagResource +``` + +### List +```json +s3:ListAccessGrantsInstances +``` diff --git a/website/docs/services/s3/access_grants_instances_list_only/index.md b/website/docs/services/s3/access_grants_instances_list_only/index.md new file mode 100644 index 0000000..86241a0 --- /dev/null +++ b/website/docs/services/s3/access_grants_instances_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_grants_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_instances_list_only + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_grants_instances in a region or regions, for all properties use access_grants_instances + +## Overview + + + + + + + +
Nameaccess_grants_instances_list_only
TypeResource
DescriptionThe AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified Access Grants instance.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_grants_instances in a region. +```sql +SELECT +region, +access_grants_instance_arn +FROM aws.s3.access_grants_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grants_instances_list_only resource, see access_grants_instances + diff --git a/website/docs/services/s3/access_grants_list_only/index.md b/website/docs/services/s3/access_grants_list_only/index.md new file mode 100644 index 0000000..b9caa4c --- /dev/null +++ b/website/docs/services/s3/access_grants_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_grants_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_list_only + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_grants in a region or regions, for all properties use access_grants + +## Overview + + + + + + + +
Nameaccess_grants_list_only
TypeResource
DescriptionThe AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID assigned to this access grant.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_grants in a region. +```sql +SELECT +region, +access_grant_id +FROM aws.s3.access_grants_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grants_list_only resource, see access_grants + diff --git a/website/docs/services/s3/access_grants_location_tags/index.md b/website/docs/services/s3/access_grants_location_tags/index.md new file mode 100644 index 0000000..86a6018 --- /dev/null +++ b/website/docs/services/s3/access_grants_location_tags/index.md @@ -0,0 +1,83 @@ +--- +title: access_grants_location_tags +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_location_tags + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for access_grants_locations in a region + +## Overview + + + + + + + +
Nameaccess_grants_location_tags
TypeResource
DescriptionThe AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified Access Grants location.
stringThe unique identifier for the specified Access Grants location.
stringThe Amazon Resource Name (ARN) of the access grant location's associated IAM role.
stringDescriptor for where the location actually points
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all access_grants_locations in a region. +```sql +SELECT +region, +access_grants_location_arn, +access_grants_location_id, +iam_role_arn, +location_scope, +tag_key, +tag_value +FROM aws.s3.access_grants_location_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grants_location_tags resource, see access_grants_locations + diff --git a/website/docs/services/s3/access_grants_locations/index.md b/website/docs/services/s3/access_grants_locations/index.md new file mode 100644 index 0000000..234477e --- /dev/null +++ b/website/docs/services/s3/access_grants_locations/index.md @@ -0,0 +1,222 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_grants_location resource or lists 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.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified Access Grants location.
stringThe unique identifier for the specified Access Grants location.
stringThe Amazon Resource Name (ARN) of the access grant location's associated IAM role.
stringDescriptor for where the location actually points
array
stringAWS region.
+ +For more information, see AWS::S3::AccessGrantsLocation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_grants_locations in a region. +```sql +SELECT +region, +access_grants_location_arn, +access_grants_location_id, +iam_role_arn, +location_scope, +tags +FROM aws.s3.access_grants_locations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_grants_location. +```sql +SELECT +region, +access_grants_location_arn, +access_grants_location_id, +iam_role_arn, +location_scope, +tags +FROM aws.s3.access_grants_locations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_grants_location resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3.access_grants_locations ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3.access_grants_locations ( + IamRoleArn, + LocationScope, + Tags, + region +) +SELECT + '{{ IamRoleArn }}', + '{{ LocationScope }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_grants_location + props: + - name: IamRoleArn + value: '{{ IamRoleArn }}' + - name: LocationScope + value: '{{ LocationScope }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3.access_grants_locations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +s3:GetAccessGrantsLocation, +s3:ListTagsForResource +``` + +### Delete +```json +s3:DeleteAccessGrantsLocation +``` + +### List +```json +s3:ListAccessGrantsLocations +``` + +### Update +```json +s3:UpdateAccessGrantsLocation, +s3:TagResource, +s3:UntagResource, +iam:PassRole +``` diff --git a/website/docs/services/s3/access_grants_locations_list_only/index.md b/website/docs/services/s3/access_grants_locations_list_only/index.md new file mode 100644 index 0000000..c67528a --- /dev/null +++ b/website/docs/services/s3/access_grants_locations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_grants_locations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_locations_list_only + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_grants_locations in a region or regions, for all properties use access_grants_locations + +## Overview + + + + + + + +
Nameaccess_grants_locations_list_only
TypeResource
DescriptionThe AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier for the specified Access Grants location.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_grants_locations in a region. +```sql +SELECT +region, +access_grants_location_id +FROM aws.s3.access_grants_locations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grants_locations_list_only resource, see access_grants_locations + diff --git a/website/docs/services/s3/access_points/index.md b/website/docs/services/s3/access_points/index.md new file mode 100644 index 0000000..428c920 --- /dev/null +++ b/website/docs/services/s3/access_points/index.md @@ -0,0 +1,251 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_point resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.
stringThe alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.
stringThe name of the bucket that you want to associate this Access Point with.
stringThe AWS account ID associated with the S3 bucket associated with this access point.
objectIf you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC).
objectThe PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
objectThe Access Point Policy you want to apply to this access point.
stringIndicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies.
stringThe Amazon Resource Name (ARN) of the specified accesspoint.
stringAWS region.
+ +For more information, see AWS::S3::AccessPoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_points in a region. +```sql +SELECT +region, +name, +alias, +bucket, +bucket_account_id, +vpc_configuration, +public_access_block_configuration, +policy, +network_origin, +arn +FROM aws.s3.access_points +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_point. +```sql +SELECT +region, +name, +alias, +bucket, +bucket_account_id, +vpc_configuration, +public_access_block_configuration, +policy, +network_origin, +arn +FROM aws.s3.access_points +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3.access_points ( + Bucket, + region +) +SELECT +'{{ Bucket }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3.access_points ( + Name, + Bucket, + BucketAccountId, + VpcConfiguration, + PublicAccessBlockConfiguration, + Policy, + region +) +SELECT + '{{ Name }}', + '{{ Bucket }}', + '{{ BucketAccountId }}', + '{{ VpcConfiguration }}', + '{{ PublicAccessBlockConfiguration }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_point + props: + - name: Name + value: '{{ Name }}' + - name: Bucket + value: '{{ Bucket }}' + - name: BucketAccountId + value: '{{ BucketAccountId }}' + - name: VpcConfiguration + value: + VpcId: '{{ VpcId }}' + - name: PublicAccessBlockConfiguration + value: + BlockPublicAcls: '{{ BlockPublicAcls }}' + IgnorePublicAcls: '{{ IgnorePublicAcls }}' + BlockPublicPolicy: '{{ BlockPublicPolicy }}' + RestrictPublicBuckets: '{{ RestrictPublicBuckets }}' + - name: Policy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3.access_points +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +s3:GetAccessPoint, +s3:GetAccessPointPolicy +``` + +### Update +```json +s3:PutAccessPointPolicy, +s3:PutAccessPointPublicAccessBlock, +s3:DeleteAccessPointPolicy, +s3:GetAccessPoint, +s3:GetAccessPointPolicy +``` + +### Delete +```json +s3:DeleteAccessPointPolicy, +s3:DeleteAccessPoint +``` + +### List +```json +s3:ListAccessPoints +``` diff --git a/website/docs/services/s3/access_points_list_only/index.md b/website/docs/services/s3/access_points_list_only/index.md new file mode 100644 index 0000000..005829e --- /dev/null +++ b/website/docs/services/s3/access_points_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_points_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_points in a region or regions, for all properties use access_points + +## Overview + + + + + + + +
Nameaccess_points_list_only
TypeResource
DescriptionThe AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_points in a region. +```sql +SELECT +region, +name +FROM aws.s3.access_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_points_list_only resource, see access_points + diff --git a/website/docs/services/s3/bucket_policies/index.md b/website/docs/services/s3/bucket_policies/index.md new file mode 100644 index 0000000..600b8c5 --- /dev/null +++ b/website/docs/services/s3/bucket_policies/index.md @@ -0,0 +1,207 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bucket_policy resource or lists 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.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).
The following operations are related to PutBucketPolicy:
+ [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
+ [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the Amazon S3 bucket to which the policy applies.
objectA policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this guide and [Access Policy Language Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User Guide*.
stringAWS region.
+ +For more information, see AWS::S3::BucketPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all bucket_policies in a region. +```sql +SELECT +region, +bucket, +policy_document +FROM aws.s3.bucket_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual bucket_policy. +```sql +SELECT +region, +bucket, +policy_document +FROM aws.s3.bucket_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bucket_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3.bucket_policies ( + Bucket, + PolicyDocument, + region +) +SELECT +'{{ Bucket }}', + '{{ PolicyDocument }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3.bucket_policies ( + Bucket, + PolicyDocument, + region +) +SELECT + '{{ Bucket }}', + '{{ PolicyDocument }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bucket_policy + props: + - name: Bucket + value: '{{ Bucket }}' + - name: PolicyDocument + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3.bucket_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the bucket_policies resource, the following permissions are required: + +### Create +```json +s3:GetBucketPolicy, +s3:PutBucketPolicy +``` + +### Read +```json +s3:GetBucketPolicy +``` + +### Update +```json +s3:GetBucketPolicy, +s3:PutBucketPolicy +``` + +### Delete +```json +s3:GetBucketPolicy, +s3:DeleteBucketPolicy +``` + +### List +```json +s3:GetBucketPolicy, +s3:ListAllMyBuckets +``` diff --git a/website/docs/services/s3/bucket_policies_list_only/index.md b/website/docs/services/s3/bucket_policies_list_only/index.md new file mode 100644 index 0000000..bac0f6a --- /dev/null +++ b/website/docs/services/s3/bucket_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: bucket_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policies_list_only + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bucket_policies in a region or regions, for all properties use bucket_policies + +## Overview + + + + + + + +
Namebucket_policies_list_only
TypeResource
DescriptionApplies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).
The following operations are related to PutBucketPolicy:
+ [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
+ [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Amazon S3 bucket to which the policy applies.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bucket_policies in a region. +```sql +SELECT +region, +bucket +FROM aws.s3.bucket_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bucket_policies_list_only resource, see bucket_policies + diff --git a/website/docs/services/s3/bucket_tags/index.md b/website/docs/services/s3/bucket_tags/index.md new file mode 100644 index 0000000..0e7e550 --- /dev/null +++ b/website/docs/services/s3/bucket_tags/index.md @@ -0,0 +1,123 @@ +--- +title: bucket_tags +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_tags + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for buckets in a region + +## Overview + + + + + + + +
Namebucket_tags
TypeResource
DescriptionThe AWS::S3::Bucket resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.
To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
You can only delete empty buckets. Deletion fails for buckets that have contents.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectConfigures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.
stringThis is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.
A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.
S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon.
The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.
arraySpecifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
objectSpecifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.
stringA name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
objectDescribes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.
arrayDefines how Amazon S3 handles Intelligent-Tiering storage.
arraySpecifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.
objectSpecifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.
objectSettings that define where logs are stored.
arraySpecifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).
objectConfiguration that defines how Amazon S3 handles bucket notifications.
objectThis operation is not supported by directory buckets.
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
+ The DefaultRetention settings require both a mode and a period.
+ The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
+ You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html).
booleanIndicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.
objectConfiguration that defines how Amazon S3 handles Object Ownership rules.
objectConfiguration that defines how Amazon S3 handles public access.
objectConfiguration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the VersioningConfiguration property.
Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
objectEnables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (PUT or DELETE) on objects in the bucket.
objectInformation used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
stringThe Amazon Resource Name (ARN) of the specified resource.
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all buckets in a region. +```sql +SELECT +region, +accelerate_configuration, +access_control, +analytics_configurations, +bucket_encryption, +bucket_name, +cors_configuration, +intelligent_tiering_configurations, +inventory_configurations, +lifecycle_configuration, +logging_configuration, +metrics_configurations, +notification_configuration, +object_lock_configuration, +object_lock_enabled, +ownership_controls, +public_access_block_configuration, +replication_configuration, +versioning_configuration, +website_configuration, +arn, +domain_name, +dual_stack_domain_name, +regional_domain_name, +website_url, +tag_key, +tag_value +FROM aws.s3.bucket_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bucket_tags resource, see buckets + diff --git a/website/docs/services/s3/buckets/index.md b/website/docs/services/s3/buckets/index.md new file mode 100644 index 0000000..b1731fb --- /dev/null +++ b/website/docs/services/s3/buckets/index.md @@ -0,0 +1,587 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bucket resource or lists 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.
To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
You can only delete empty buckets. Deletion fails for buckets that have contents.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectConfigures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.
stringThis is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.
A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.
S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon.
The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.
arraySpecifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
objectSpecifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.
stringA name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
objectDescribes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.
arrayDefines how Amazon S3 handles Intelligent-Tiering storage.
arraySpecifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.
objectSpecifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.
objectSettings that define where logs are stored.
arraySpecifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).
objectConfiguration that defines how Amazon S3 handles bucket notifications.
objectThis operation is not supported by directory buckets.
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
+ The DefaultRetention settings require both a mode and a period.
+ The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
+ You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html).
booleanIndicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.
objectConfiguration that defines how Amazon S3 handles Object Ownership rules.
objectConfiguration that defines how Amazon S3 handles public access.
objectConfiguration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the VersioningConfiguration property.
Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
arrayAn arbitrary set of tags (key-value pairs) for this S3 bucket.
objectEnables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (PUT or DELETE) on objects in the bucket.
objectInformation used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
stringThe Amazon Resource Name (ARN) of the specified resource.
string
string
string
string
stringAWS region.
+ +For more information, see AWS::S3::Bucket. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all buckets in a region. +```sql +SELECT +region, +accelerate_configuration, +access_control, +analytics_configurations, +bucket_encryption, +bucket_name, +cors_configuration, +intelligent_tiering_configurations, +inventory_configurations, +lifecycle_configuration, +logging_configuration, +metrics_configurations, +notification_configuration, +object_lock_configuration, +object_lock_enabled, +ownership_controls, +public_access_block_configuration, +replication_configuration, +tags, +versioning_configuration, +website_configuration, +arn, +domain_name, +dual_stack_domain_name, +regional_domain_name, +website_url +FROM aws.s3.buckets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual bucket. +```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.buckets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bucket resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3.buckets ( + BucketName, + region +) +SELECT +'{{ BucketName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3.buckets ( + AccelerateConfiguration, + AccessControl, + AnalyticsConfigurations, + BucketEncryption, + BucketName, + CorsConfiguration, + IntelligentTieringConfigurations, + InventoryConfigurations, + LifecycleConfiguration, + LoggingConfiguration, + MetricsConfigurations, + NotificationConfiguration, + ObjectLockConfiguration, + ObjectLockEnabled, + OwnershipControls, + PublicAccessBlockConfiguration, + ReplicationConfiguration, + Tags, + VersioningConfiguration, + WebsiteConfiguration, + region +) +SELECT + '{{ AccelerateConfiguration }}', + '{{ AccessControl }}', + '{{ AnalyticsConfigurations }}', + '{{ BucketEncryption }}', + '{{ BucketName }}', + '{{ CorsConfiguration }}', + '{{ IntelligentTieringConfigurations }}', + '{{ InventoryConfigurations }}', + '{{ LifecycleConfiguration }}', + '{{ LoggingConfiguration }}', + '{{ MetricsConfigurations }}', + '{{ NotificationConfiguration }}', + '{{ ObjectLockConfiguration }}', + '{{ ObjectLockEnabled }}', + '{{ OwnershipControls }}', + '{{ PublicAccessBlockConfiguration }}', + '{{ ReplicationConfiguration }}', + '{{ Tags }}', + '{{ VersioningConfiguration }}', + '{{ WebsiteConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bucket + props: + - name: AccelerateConfiguration + value: + AccelerationStatus: '{{ AccelerationStatus }}' + - name: AccessControl + value: '{{ AccessControl }}' + - name: AnalyticsConfigurations + value: + - TagFilters: + - Value: '{{ Value }}' + Key: '{{ Key }}' + StorageClassAnalysis: + DataExport: + S3BucketDestination: + OutputSchemaVersion: '{{ OutputSchemaVersion }}' + Format: '{{ Format }}' + AccountId: '{{ AccountId }}' + Arn: '{{ Arn }}' + Prefix: '{{ Prefix }}' + Encryption: {} + CloudWatchMetrics: + IsEnabled: '{{ IsEnabled }}' + Id: '{{ Id }}' + Prefix: '{{ Prefix }}' + - name: BucketEncryption + value: + ServerSideEncryptionConfiguration: + - BucketKeyEnabled: '{{ BucketKeyEnabled }}' + ServerSideEncryptionByDefault: + KMSMasterKeyID: '{{ KMSMasterKeyID }}' + SSEAlgorithm: '{{ SSEAlgorithm }}' + - name: BucketName + value: '{{ BucketName }}' + - name: CorsConfiguration + value: + CorsRules: + - AllowedHeaders: + - '{{ AllowedHeaders[0] }}' + AllowedMethods: + - '{{ AllowedMethods[0] }}' + AllowedOrigins: + - '{{ AllowedOrigins[0] }}' + ExposedHeaders: + - '{{ ExposedHeaders[0] }}' + Id: '{{ Id }}' + MaxAge: '{{ MaxAge }}' + - name: IntelligentTieringConfigurations + value: + - Id: '{{ Id }}' + Prefix: '{{ Prefix }}' + Status: '{{ Status }}' + TagFilters: + - null + Tierings: + - AccessTier: '{{ AccessTier }}' + Days: '{{ Days }}' + - name: InventoryConfigurations + value: + - Destination: + BucketArn: '{{ BucketArn }}' + BucketAccountId: '{{ BucketAccountId }}' + Format: '{{ Format }}' + Prefix: '{{ Prefix }}' + Enabled: '{{ Enabled }}' + Id: '{{ Id }}' + IncludedObjectVersions: '{{ IncludedObjectVersions }}' + OptionalFields: + - '{{ OptionalFields[0] }}' + Prefix: '{{ Prefix }}' + ScheduleFrequency: '{{ ScheduleFrequency }}' + - name: LifecycleConfiguration + value: + Rules: + - AbortIncompleteMultipartUpload: + DaysAfterInitiation: '{{ DaysAfterInitiation }}' + ExpirationDate: '{{ ExpirationDate }}' + ExpirationInDays: '{{ ExpirationInDays }}' + ExpiredObjectDeleteMarker: '{{ ExpiredObjectDeleteMarker }}' + Id: '{{ Id }}' + NoncurrentVersionExpirationInDays: '{{ NoncurrentVersionExpirationInDays }}' + NoncurrentVersionExpiration: + NoncurrentDays: '{{ NoncurrentDays }}' + NewerNoncurrentVersions: '{{ NewerNoncurrentVersions }}' + NoncurrentVersionTransition: + StorageClass: '{{ StorageClass }}' + TransitionInDays: '{{ TransitionInDays }}' + NewerNoncurrentVersions: '{{ NewerNoncurrentVersions }}' + NoncurrentVersionTransitions: + - null + Prefix: '{{ Prefix }}' + Status: '{{ Status }}' + TagFilters: + - null + ObjectSizeGreaterThan: '{{ ObjectSizeGreaterThan }}' + ObjectSizeLessThan: '{{ ObjectSizeLessThan }}' + Transition: + StorageClass: '{{ StorageClass }}' + TransitionDate: null + TransitionInDays: '{{ TransitionInDays }}' + Transitions: + - null + TransitionDefaultMinimumObjectSize: '{{ TransitionDefaultMinimumObjectSize }}' + - name: LoggingConfiguration + value: + DestinationBucketName: '{{ DestinationBucketName }}' + LogFilePrefix: '{{ LogFilePrefix }}' + TargetObjectKeyFormat: {} + - name: MetricsConfigurations + value: + - AccessPointArn: '{{ AccessPointArn }}' + Id: '{{ Id }}' + Prefix: '{{ Prefix }}' + TagFilters: + - null + - name: NotificationConfiguration + value: + EventBridgeConfiguration: + EventBridgeEnabled: '{{ EventBridgeEnabled }}' + LambdaConfigurations: + - Event: '{{ Event }}' + Filter: + S3Key: + Rules: + - Name: '{{ Name }}' + Value: '{{ Value }}' + Function: '{{ Function }}' + QueueConfigurations: + - Event: '{{ Event }}' + Filter: null + Queue: '{{ Queue }}' + TopicConfigurations: + - Event: '{{ Event }}' + Filter: null + Topic: '{{ Topic }}' + - name: ObjectLockConfiguration + value: + ObjectLockEnabled: '{{ ObjectLockEnabled }}' + Rule: + DefaultRetention: + Years: '{{ Years }}' + Days: '{{ Days }}' + Mode: '{{ Mode }}' + - name: ObjectLockEnabled + value: '{{ ObjectLockEnabled }}' + - name: OwnershipControls + value: + Rules: + - ObjectOwnership: '{{ ObjectOwnership }}' + - name: PublicAccessBlockConfiguration + value: + BlockPublicAcls: '{{ BlockPublicAcls }}' + IgnorePublicAcls: '{{ IgnorePublicAcls }}' + BlockPublicPolicy: '{{ BlockPublicPolicy }}' + RestrictPublicBuckets: '{{ RestrictPublicBuckets }}' + - name: ReplicationConfiguration + value: + Role: '{{ Role }}' + Rules: + - DeleteMarkerReplication: + Status: '{{ Status }}' + Destination: + AccessControlTranslation: + Owner: '{{ Owner }}' + Account: '{{ Account }}' + Bucket: '{{ Bucket }}' + EncryptionConfiguration: + ReplicaKmsKeyID: '{{ ReplicaKmsKeyID }}' + Metrics: + EventThreshold: + Minutes: '{{ Minutes }}' + Status: '{{ Status }}' + ReplicationTime: + Status: '{{ Status }}' + Time: null + StorageClass: '{{ StorageClass }}' + Filter: + And: + Prefix: '{{ Prefix }}' + TagFilters: + - null + Prefix: '{{ Prefix }}' + TagFilter: null + Id: '{{ Id }}' + Prefix: '{{ Prefix }}' + Priority: '{{ Priority }}' + SourceSelectionCriteria: + ReplicaModifications: + Status: '{{ Status }}' + SseKmsEncryptedObjects: + Status: '{{ Status }}' + Status: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VersioningConfiguration + value: + Status: '{{ Status }}' + - name: WebsiteConfiguration + value: + ErrorDocument: '{{ ErrorDocument }}' + IndexDocument: '{{ IndexDocument }}' + RoutingRules: + - RedirectRule: + HostName: '{{ HostName }}' + HttpRedirectCode: '{{ HttpRedirectCode }}' + Protocol: '{{ Protocol }}' + ReplaceKeyPrefixWith: '{{ ReplaceKeyPrefixWith }}' + ReplaceKeyWith: '{{ ReplaceKeyWith }}' + RoutingRuleCondition: + KeyPrefixEquals: '{{ KeyPrefixEquals }}' + HttpErrorCodeReturnedEquals: '{{ HttpErrorCodeReturnedEquals }}' + RedirectAllRequestsTo: + HostName: '{{ HostName }}' + Protocol: '{{ Protocol }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3.buckets +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +s3:ListAllMyBuckets +``` diff --git a/website/docs/services/s3/buckets_list_only/index.md b/website/docs/services/s3/buckets_list_only/index.md new file mode 100644 index 0000000..337a2c7 --- /dev/null +++ b/website/docs/services/s3/buckets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: buckets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - buckets_list_only + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists buckets in a region or regions, for all properties use buckets + +## Overview + + + + + + + +
Namebuckets_list_only
TypeResource
DescriptionThe AWS::S3::Bucket resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.
To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
You can only delete empty buckets. Deletion fails for buckets that have contents.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all buckets in a region. +```sql +SELECT +region, +bucket_name +FROM aws.s3.buckets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the buckets_list_only resource, see buckets + diff --git a/website/docs/services/s3/index.md b/website/docs/services/s3/index.md new file mode 100644 index 0000000..19ca905 --- /dev/null +++ b/website/docs/services/s3/index.md @@ -0,0 +1,60 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The s3 service documentation. + +:::info Service Summary + +
+
+total resources: 25
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/s3/multi_region_access_point_policies/index.md b/website/docs/services/s3/multi_region_access_point_policies/index.md new file mode 100644 index 0000000..d99a7d1 --- /dev/null +++ b/website/docs/services/s3/multi_region_access_point_policies/index.md @@ -0,0 +1,205 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a multi_region_access_point_policy resource or lists 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
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the Multi Region Access Point to apply policy
objectPolicy document to apply to a Multi Region Access Point
objectThe Policy Status associated with this Multi Region Access Point
stringAWS region.
+ +For more information, see AWS::S3::MultiRegionAccessPointPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all multi_region_access_point_policies in a region. +```sql +SELECT +region, +mrap_name, +policy, +policy_status +FROM aws.s3.multi_region_access_point_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual multi_region_access_point_policy. +```sql +SELECT +region, +mrap_name, +policy, +policy_status +FROM aws.s3.multi_region_access_point_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new multi_region_access_point_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3.multi_region_access_point_policies ( + MrapName, + Policy, + region +) +SELECT +'{{ MrapName }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3.multi_region_access_point_policies ( + MrapName, + Policy, + region +) +SELECT + '{{ MrapName }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: multi_region_access_point_policy + props: + - name: MrapName + value: '{{ MrapName }}' + - name: Policy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3.multi_region_access_point_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the multi_region_access_point_policies resource, the following permissions are required: + +### Update +```json +s3:PutMultiRegionAccessPointPolicy, +s3:DescribeMultiRegionAccessPointOperation +``` + +### Read +```json +s3:GetMultiRegionAccessPointPolicy, +s3:GetMultiRegionAccessPointPolicyStatus +``` + +### Delete +```json +s3:GetMultiRegionAccessPointPolicy, +s3:GetMultiRegionAccessPoint +``` + +### Create +```json +s3:PutMultiRegionAccessPointPolicy, +s3:DescribeMultiRegionAccessPointOperation +``` diff --git a/website/docs/services/s3/multi_region_access_points/index.md b/website/docs/services/s3/multi_region_access_points/index.md new file mode 100644 index 0000000..db77d05 --- /dev/null +++ b/website/docs/services/s3/multi_region_access_points/index.md @@ -0,0 +1,214 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a multi_region_access_point resource or lists 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.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Multi Region Access Point.
stringThe alias is a unique identifier to, and is part of the public DNS name for this Multi Region Access Point
stringThe timestamp of the when the Multi Region Access Point is created
objectThe PublicAccessBlock configuration that you want to apply to this Multi Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
arrayThe list of buckets that you want to associate this Multi Region Access Point with.
stringAWS region.
+ +For more information, see AWS::S3::MultiRegionAccessPoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all multi_region_access_points in a region. +```sql +SELECT +region, +name, +alias, +created_at, +public_access_block_configuration, +regions +FROM aws.s3.multi_region_access_points +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual multi_region_access_point. +```sql +SELECT +region, +name, +alias, +created_at, +public_access_block_configuration, +regions +FROM aws.s3.multi_region_access_points +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new multi_region_access_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3.multi_region_access_points ( + Regions, + region +) +SELECT +'{{ Regions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3.multi_region_access_points ( + Name, + PublicAccessBlockConfiguration, + Regions, + region +) +SELECT + '{{ Name }}', + '{{ PublicAccessBlockConfiguration }}', + '{{ Regions }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: multi_region_access_point + props: + - name: Name + value: '{{ Name }}' + - name: PublicAccessBlockConfiguration + value: + BlockPublicAcls: '{{ BlockPublicAcls }}' + IgnorePublicAcls: '{{ IgnorePublicAcls }}' + BlockPublicPolicy: '{{ BlockPublicPolicy }}' + RestrictPublicBuckets: '{{ RestrictPublicBuckets }}' + - name: Regions + value: + - Bucket: '{{ Bucket }}' + BucketAccountId: '{{ BucketAccountId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3.multi_region_access_points +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +s3:GetMultiRegionAccessPoint +``` + +### Delete +```json +s3:DeleteMultiRegionAccessPoint, +s3:DescribeMultiRegionAccessPointOperation, +s3:GetMultiRegionAccessPoint +``` + +### List +```json +s3:ListMultiRegionAccessPoints +``` diff --git a/website/docs/services/s3/multi_region_access_points_list_only/index.md b/website/docs/services/s3/multi_region_access_points_list_only/index.md new file mode 100644 index 0000000..6c8afee --- /dev/null +++ b/website/docs/services/s3/multi_region_access_points_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: multi_region_access_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - multi_region_access_points_list_only + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists multi_region_access_points in a region or regions, for all properties use multi_region_access_points + +## Overview + + + + + + + +
Namemulti_region_access_points_list_only
TypeResource
DescriptionAWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Multi Region Access Point.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all multi_region_access_points in a region. +```sql +SELECT +region, +name +FROM aws.s3.multi_region_access_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multi_region_access_points_list_only resource, see multi_region_access_points + diff --git a/website/docs/services/s3/storage_lens/index.md b/website/docs/services/s3/storage_lens/index.md new file mode 100644 index 0000000..cc7aad5 --- /dev/null +++ b/website/docs/services/s3/storage_lens/index.md @@ -0,0 +1,269 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a storage_len resource or lists storage_lens in a region + +## Overview + + + + + + + +
Namestorage_lens
TypeResource
DescriptionThe AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectSpecifies the details of Amazon S3 Storage Lens configuration.
arrayA set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.
stringAWS region.
+ +For more information, see AWS::S3::StorageLens. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all storage_lens in a region. +```sql +SELECT +region, +storage_lens_configuration, +tags +FROM aws.s3.storage_lens +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual storage_len. +```sql +SELECT +region, +storage_lens_configuration, +tags +FROM aws.s3.storage_lens +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new storage_len resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3.storage_lens ( + StorageLensConfiguration, + region +) +SELECT +'{{ StorageLensConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3.storage_lens ( + StorageLensConfiguration, + Tags, + region +) +SELECT + '{{ StorageLensConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: storage_len + props: + - name: StorageLensConfiguration + value: + Id: '{{ Id }}' + Include: + Buckets: + - '{{ Buckets[0] }}' + Regions: + - '{{ Regions[0] }}' + Exclude: null + AwsOrg: + Arn: null + AccountLevel: + ActivityMetrics: + IsEnabled: '{{ IsEnabled }}' + AdvancedCostOptimizationMetrics: + IsEnabled: '{{ IsEnabled }}' + AdvancedDataProtectionMetrics: + IsEnabled: '{{ IsEnabled }}' + DetailedStatusCodesMetrics: + IsEnabled: '{{ IsEnabled }}' + BucketLevel: + ActivityMetrics: null + AdvancedCostOptimizationMetrics: null + AdvancedDataProtectionMetrics: null + DetailedStatusCodesMetrics: null + PrefixLevel: + StorageMetrics: + IsEnabled: '{{ IsEnabled }}' + SelectionCriteria: + MaxDepth: '{{ MaxDepth }}' + Delimiter: '{{ Delimiter }}' + MinStorageBytesPercentage: null + StorageLensGroupLevel: + StorageLensGroupSelectionCriteria: + Include: + - '{{ Include[0] }}' + Exclude: + - null + DataExport: + S3BucketDestination: + OutputSchemaVersion: '{{ OutputSchemaVersion }}' + Format: '{{ Format }}' + AccountId: '{{ AccountId }}' + Arn: '{{ Arn }}' + Prefix: '{{ Prefix }}' + Encryption: {} + CloudWatchMetrics: + IsEnabled: '{{ IsEnabled }}' + IsEnabled: '{{ IsEnabled }}' + StorageLensArn: '{{ StorageLensArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3.storage_lens +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the storage_lens resource, the following permissions are required: + +### Create +```json +s3:PutStorageLensConfiguration, +s3:PutStorageLensConfigurationTagging, +s3:GetStorageLensConfiguration, +s3:GetStorageLensConfigurationTagging, +organizations:DescribeOrganization, +organizations:ListAccounts, +organizations:ListAWSServiceAccessForOrganization, +organizations:ListDelegatedAdministrators, +iam:CreateServiceLinkedRole +``` + +### 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 +``` + +### List +```json +s3:ListStorageLensConfigurations +``` diff --git a/website/docs/services/s3/storage_lens_group_tags/index.md b/website/docs/services/s3/storage_lens_group_tags/index.md new file mode 100644 index 0000000..747b0c7 --- /dev/null +++ b/website/docs/services/s3/storage_lens_group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: storage_lens_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens_group_tags + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for storage_lens_groups in a region + +## Overview + + + + + + + +
Namestorage_lens_group_tags
TypeResource
DescriptionThe AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name that identifies the Amazon S3 Storage Lens Group.
objectSets the Storage Lens Group filter.
stringThe ARN for the Amazon S3 Storage Lens Group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all storage_lens_groups in a region. +```sql +SELECT +region, +name, +filter, +storage_lens_group_arn, +tag_key, +tag_value +FROM aws.s3.storage_lens_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_lens_group_tags resource, see storage_lens_groups + diff --git a/website/docs/services/s3/storage_lens_groups/index.md b/website/docs/services/s3/storage_lens_groups/index.md new file mode 100644 index 0000000..492a7de --- /dev/null +++ b/website/docs/services/s3/storage_lens_groups/index.md @@ -0,0 +1,247 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a storage_lens_group resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name that identifies the Amazon S3 Storage Lens Group.
objectSets the Storage Lens Group filter.
stringThe ARN for the Amazon S3 Storage Lens Group.
arrayA set of tags (key-value pairs) for this Amazon S3 Storage Lens Group.
stringAWS region.
+ +For more information, see AWS::S3::StorageLensGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all storage_lens_groups in a region. +```sql +SELECT +region, +name, +filter, +storage_lens_group_arn, +tags +FROM aws.s3.storage_lens_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual storage_lens_group. +```sql +SELECT +region, +name, +filter, +storage_lens_group_arn, +tags +FROM aws.s3.storage_lens_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new storage_lens_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3.storage_lens_groups ( + Name, + Filter, + region +) +SELECT +'{{ Name }}', + '{{ Filter }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3.storage_lens_groups ( + Name, + Filter, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Filter }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: storage_lens_group + props: + - name: Name + value: '{{ Name }}' + - name: Filter + value: + MatchAnyPrefix: + - '{{ MatchAnyPrefix[0] }}' + MatchAnySuffix: + - '{{ MatchAnySuffix[0] }}' + MatchAnyTag: + - Key: '{{ Key }}' + Value: '{{ Value }}' + MatchObjectSize: + BytesGreaterThan: '{{ BytesGreaterThan }}' + BytesLessThan: '{{ BytesLessThan }}' + MatchObjectAge: + DaysGreaterThan: '{{ DaysGreaterThan }}' + DaysLessThan: '{{ DaysLessThan }}' + And: + MatchAnyPrefix: null + MatchAnySuffix: null + MatchAnyTag: null + MatchObjectSize: null + MatchObjectAge: null + Or: + MatchAnyPrefix: null + MatchAnySuffix: null + MatchAnyTag: null + MatchObjectSize: null + MatchObjectAge: null + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3.storage_lens_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +s3:GetStorageLensGroup, +s3:ListTagsForResource +``` + +### Update +```json +s3:GetStorageLensGroup, +s3:UpdateStorageLensGroup, +s3:TagResource, +s3:UntagResource, +s3:ListTagsForResource +``` + +### Delete +```json +s3:DeleteStorageLensGroup +``` + +### List +```json +s3:ListStorageLensGroups +``` diff --git a/website/docs/services/s3/storage_lens_groups_list_only/index.md b/website/docs/services/s3/storage_lens_groups_list_only/index.md new file mode 100644 index 0000000..937d249 --- /dev/null +++ b/website/docs/services/s3/storage_lens_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: storage_lens_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens_groups_list_only + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists storage_lens_groups in a region or regions, for all properties use storage_lens_groups + +## Overview + + + + + + + +
Namestorage_lens_groups_list_only
TypeResource
DescriptionThe AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name that identifies the Amazon S3 Storage Lens Group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all storage_lens_groups in a region. +```sql +SELECT +region, +name +FROM aws.s3.storage_lens_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_lens_groups_list_only resource, see storage_lens_groups + diff --git a/website/docs/services/s3/storage_lens_list_only/index.md b/website/docs/services/s3/storage_lens_list_only/index.md new file mode 100644 index 0000000..1bc3810 --- /dev/null +++ b/website/docs/services/s3/storage_lens_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: storage_lens_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens_list_only + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists storage_lens in a region or regions, for all properties use storage_lens + +## Overview + + + + + + + +
Namestorage_lens_list_only
TypeResource
DescriptionThe AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
objectSpecifies the details of Amazon S3 Storage Lens configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all storage_lens in a region. +```sql +SELECT +region, +storage_lens_configuration/id +FROM aws.s3.storage_lens_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_lens_list_only resource, see storage_lens + diff --git a/website/docs/services/s3/storage_lens_tags/index.md b/website/docs/services/s3/storage_lens_tags/index.md new file mode 100644 index 0000000..901c4fc --- /dev/null +++ b/website/docs/services/s3/storage_lens_tags/index.md @@ -0,0 +1,77 @@ +--- +title: storage_lens_tags +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens_tags + - s3 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for storage_lens in a region + +## Overview + + + + + + + +
Namestorage_lens_tags
TypeResource
DescriptionThe AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectSpecifies the details of Amazon S3 Storage Lens configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all storage_lens in a region. +```sql +SELECT +region, +storage_lens_configuration, +tag_key, +tag_value +FROM aws.s3.storage_lens_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_lens_tags resource, see storage_lens + diff --git a/website/docs/services/s3express/bucket_policies/index.md b/website/docs/services/s3express/bucket_policies/index.md new file mode 100644 index 0000000..b92e091 --- /dev/null +++ b/website/docs/services/s3express/bucket_policies/index.md @@ -0,0 +1,207 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bucket_policy resource or lists bucket_policies in a region + +## Overview + + + + + + + +
Namebucket_policies
TypeResource
DescriptionResource Type definition for AWS::S3Express::BucketPolicy.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the S3 directory bucket to which the policy applies.
objectA policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
stringAWS region.
+ +For more information, see AWS::S3Express::BucketPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all bucket_policies in a region. +```sql +SELECT +region, +bucket, +policy_document +FROM aws.s3express.bucket_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual bucket_policy. +```sql +SELECT +region, +bucket, +policy_document +FROM aws.s3express.bucket_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bucket_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3express.bucket_policies ( + Bucket, + PolicyDocument, + region +) +SELECT +'{{ Bucket }}', + '{{ PolicyDocument }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3express.bucket_policies ( + Bucket, + PolicyDocument, + region +) +SELECT + '{{ Bucket }}', + '{{ PolicyDocument }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bucket_policy + props: + - name: Bucket + value: '{{ Bucket }}' + - name: PolicyDocument + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3express.bucket_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the bucket_policies resource, the following permissions are required: + +### Create +```json +s3express:GetBucketPolicy, +s3express:PutBucketPolicy +``` + +### Read +```json +s3express:GetBucketPolicy +``` + +### Update +```json +s3express:GetBucketPolicy, +s3express:PutBucketPolicy +``` + +### Delete +```json +s3express:GetBucketPolicy, +s3express:DeleteBucketPolicy +``` + +### List +```json +s3express:GetBucketPolicy, +s3express:ListAllMyDirectoryBuckets +``` diff --git a/website/docs/services/s3express/bucket_policies_list_only/index.md b/website/docs/services/s3express/bucket_policies_list_only/index.md new file mode 100644 index 0000000..24ea30f --- /dev/null +++ b/website/docs/services/s3express/bucket_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: bucket_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policies_list_only + - s3express + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bucket_policies in a region or regions, for all properties use bucket_policies + +## Overview + + + + + + + +
Namebucket_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::S3Express::BucketPolicy.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the S3 directory bucket to which the policy applies.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bucket_policies in a region. +```sql +SELECT +region, +bucket +FROM aws.s3express.bucket_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bucket_policies_list_only resource, see bucket_policies + diff --git a/website/docs/services/s3express/directory_buckets/index.md b/website/docs/services/s3express/directory_buckets/index.md new file mode 100644 index 0000000..314c4eb --- /dev/null +++ b/website/docs/services/s3express/directory_buckets/index.md @@ -0,0 +1,256 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a directory_bucket resource or lists directory_buckets in a region + +## Overview + + + + + + + +
Namedirectory_buckets
TypeResource
DescriptionResource Type definition for AWS::S3Express::DirectoryBucket.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
stringSpecifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'.
stringReturns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'.
stringSpecifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket.
stringReturns the Amazon Resource Name (ARN) of the specified bucket.
objectSpecifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS).
objectLifecycle rules that define how Amazon S3 Express manages objects during their lifetime.
stringAWS region.
+ +For more information, see AWS::S3Express::DirectoryBucket. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all directory_buckets in a region. +```sql +SELECT +region, +bucket_name, +location_name, +availability_zone_name, +data_redundancy, +arn, +bucket_encryption, +lifecycle_configuration +FROM aws.s3express.directory_buckets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual directory_bucket. +```sql +SELECT +region, +bucket_name, +location_name, +availability_zone_name, +data_redundancy, +arn, +bucket_encryption, +lifecycle_configuration +FROM aws.s3express.directory_buckets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new directory_bucket resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3express.directory_buckets ( + LocationName, + DataRedundancy, + region +) +SELECT +'{{ LocationName }}', + '{{ DataRedundancy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3express.directory_buckets ( + BucketName, + LocationName, + DataRedundancy, + BucketEncryption, + LifecycleConfiguration, + region +) +SELECT + '{{ BucketName }}', + '{{ LocationName }}', + '{{ DataRedundancy }}', + '{{ BucketEncryption }}', + '{{ LifecycleConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: directory_bucket + props: + - name: BucketName + value: '{{ BucketName }}' + - name: LocationName + value: '{{ LocationName }}' + - name: DataRedundancy + value: '{{ DataRedundancy }}' + - name: BucketEncryption + value: + ServerSideEncryptionConfiguration: + - BucketKeyEnabled: '{{ BucketKeyEnabled }}' + ServerSideEncryptionByDefault: + KMSMasterKeyID: '{{ KMSMasterKeyID }}' + SSEAlgorithm: '{{ SSEAlgorithm }}' + - name: LifecycleConfiguration + value: + Rules: + - AbortIncompleteMultipartUpload: + DaysAfterInitiation: '{{ DaysAfterInitiation }}' + ExpirationInDays: '{{ ExpirationInDays }}' + Id: '{{ Id }}' + Prefix: '{{ Prefix }}' + Status: '{{ Status }}' + ObjectSizeGreaterThan: '{{ ObjectSizeGreaterThan }}' + ObjectSizeLessThan: '{{ ObjectSizeLessThan }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3express.directory_buckets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the directory_buckets resource, the following permissions are required: + +### Create +```json +kms:GenerateDataKey, +kms:Decrypt, +s3express:CreateBucket, +s3express:ListAllMyDirectoryBuckets, +s3express:PutEncryptionConfiguration, +s3express:PutLifecycleConfiguration +``` + +### Read +```json +s3express:ListAllMyDirectoryBuckets, +ec2:DescribeAvailabilityZones, +s3express:GetEncryptionConfiguration, +s3express:GetLifecycleConfiguration +``` + +### Update +```json +kms:GenerateDataKey, +kms:Decrypt, +s3express:PutEncryptionConfiguration, +s3express:PutLifecycleConfiguration +``` + +### Delete +```json +s3express:DeleteBucket, +s3express:ListAllMyDirectoryBuckets +``` + +### List +```json +s3express:ListAllMyDirectoryBuckets +``` diff --git a/website/docs/services/s3express/directory_buckets_list_only/index.md b/website/docs/services/s3express/directory_buckets_list_only/index.md new file mode 100644 index 0000000..9772485 --- /dev/null +++ b/website/docs/services/s3express/directory_buckets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: directory_buckets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - directory_buckets_list_only + - s3express + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists directory_buckets in a region or regions, for all properties use directory_buckets + +## Overview + + + + + + + +
Namedirectory_buckets_list_only
TypeResource
DescriptionResource Type definition for AWS::S3Express::DirectoryBucket.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringSpecifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all directory_buckets in a region. +```sql +SELECT +region, +bucket_name +FROM aws.s3express.directory_buckets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the directory_buckets_list_only resource, see directory_buckets + diff --git a/website/docs/services/s3express/index.md b/website/docs/services/s3express/index.md new file mode 100644 index 0000000..433f5e3 --- /dev/null +++ b/website/docs/services/s3express/index.md @@ -0,0 +1,39 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The s3express service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/s3objectlambda/access_point_policies/index.md b/website/docs/services/s3objectlambda/access_point_policies/index.md new file mode 100644 index 0000000..7fe45cc --- /dev/null +++ b/website/docs/services/s3objectlambda/access_point_policies/index.md @@ -0,0 +1,188 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_point_policy resource or lists 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
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies.
objectA 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.
stringAWS region.
+ +For more information, see AWS::S3ObjectLambda::AccessPointPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual access_point_policy. +```sql +SELECT +region, +object_lambda_access_point, +policy_document +FROM aws.s3objectlambda.access_point_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_point_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3objectlambda.access_point_policies ( + ObjectLambdaAccessPoint, + PolicyDocument, + region +) +SELECT +'{{ ObjectLambdaAccessPoint }}', + '{{ PolicyDocument }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3objectlambda.access_point_policies ( + ObjectLambdaAccessPoint, + PolicyDocument, + region +) +SELECT + '{{ ObjectLambdaAccessPoint }}', + '{{ PolicyDocument }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_point_policy + props: + - name: ObjectLambdaAccessPoint + value: '{{ ObjectLambdaAccessPoint }}' + - name: PolicyDocument + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3objectlambda.access_point_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the access_point_policies resource, the following permissions are required: + +### Create +```json +s3:PutAccessPointPolicyForObjectLambda, +s3:GetAccessPointPolicyForObjectLambda +``` + +### Read +```json +s3:GetAccessPointPolicyForObjectLambda +``` + +### Update +```json +s3:PutAccessPointPolicyForObjectLambda, +s3:GetAccessPointPolicyForObjectLambda +``` + +### Delete +```json +s3:DeleteAccessPointPolicyForObjectLambda, +s3:GetAccessPointPolicyForObjectLambda +``` diff --git a/website/docs/services/s3objectlambda/access_points/index.md b/website/docs/services/s3objectlambda/access_points/index.md new file mode 100644 index 0000000..d50e9d3 --- /dev/null +++ b/website/docs/services/s3objectlambda/access_points/index.md @@ -0,0 +1,233 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_point resource or lists 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
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Object lambda Access Point.
object
string
stringThe date and time when the Object lambda Access Point was created.
objectThe PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
object
objectThe Object lambda Access Point Configuration that configures transformations to be applied on the objects on specified S3 Actions
stringAWS region.
+ +For more information, see AWS::S3ObjectLambda::AccessPoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_points in a region. +```sql +SELECT +region, +name, +alias, +arn, +creation_date, +public_access_block_configuration, +policy_status, +object_lambda_configuration +FROM aws.s3objectlambda.access_points +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_point. +```sql +SELECT +region, +name, +alias, +arn, +creation_date, +public_access_block_configuration, +policy_status, +object_lambda_configuration +FROM aws.s3objectlambda.access_points +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3objectlambda.access_points ( + ObjectLambdaConfiguration, + region +) +SELECT +'{{ ObjectLambdaConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3objectlambda.access_points ( + Name, + ObjectLambdaConfiguration, + region +) +SELECT + '{{ Name }}', + '{{ ObjectLambdaConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_point + props: + - name: Name + value: '{{ Name }}' + - name: ObjectLambdaConfiguration + value: + SupportingAccessPoint: '{{ SupportingAccessPoint }}' + AllowedFeatures: + - '{{ AllowedFeatures[0] }}' + CloudWatchMetricsEnabled: '{{ CloudWatchMetricsEnabled }}' + TransformationConfigurations: + - Actions: + - '{{ Actions[0] }}' + ContentTransformation: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3objectlambda.access_points +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +s3:GetAccessPointForObjectLambda, +s3:GetAccessPointPolicyStatusForObjectLambda, +s3:GetAccessPointConfigurationForObjectLambda +``` + +### Update +```json +s3:PutAccessPointConfigurationForObjectLambda, +s3:GetAccessPointForObjectLambda, +s3:GetAccessPointPolicyStatusForObjectLambda, +s3:GetAccessPointConfigurationForObjectLambda +``` + +### Delete +```json +s3:DeleteAccessPointForObjectLambda +``` + +### List +```json +s3:ListAccessPointsForObjectLambda +``` diff --git a/website/docs/services/s3objectlambda/access_points_list_only/index.md b/website/docs/services/s3objectlambda/access_points_list_only/index.md new file mode 100644 index 0000000..2334622 --- /dev/null +++ b/website/docs/services/s3objectlambda/access_points_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_points_list_only + - s3objectlambda + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_points in a region or regions, for all properties use access_points + +## Overview + + + + + + + +
Nameaccess_points_list_only
TypeResource
DescriptionThe AWS::S3ObjectLambda::AccessPoint resource is an Amazon S3ObjectLambda resource type that you can use to add computation to S3 actions
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Object lambda Access Point.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_points in a region. +```sql +SELECT +region, +name +FROM aws.s3objectlambda.access_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_points_list_only resource, see access_points + diff --git a/website/docs/services/s3objectlambda/index.md b/website/docs/services/s3objectlambda/index.md new file mode 100644 index 0000000..3c01a86 --- /dev/null +++ b/website/docs/services/s3objectlambda/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The s3objectlambda service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/s3outposts/access_points/index.md b/website/docs/services/s3outposts/access_points/index.md new file mode 100644 index 0000000..41812c7 --- /dev/null +++ b/website/docs/services/s3outposts/access_points/index.md @@ -0,0 +1,231 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_point resource or lists access_points in a region + +## Overview + + + + + + + +
Nameaccess_points
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::AccessPoint
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified AccessPoint.
stringThe Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with.
stringA name for the AccessPoint.
objectVirtual Private Cloud (VPC) from which requests can be made to the AccessPoint.
objectThe access point policy associated with this access point.
stringAWS region.
+ +For more information, see AWS::S3Outposts::AccessPoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_points in a region. +```sql +SELECT +region, +arn, +bucket, +name, +vpc_configuration, +policy +FROM aws.s3outposts.access_points +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_point. +```sql +SELECT +region, +arn, +bucket, +name, +vpc_configuration, +policy +FROM aws.s3outposts.access_points +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3outposts.access_points ( + Bucket, + Name, + VpcConfiguration, + region +) +SELECT +'{{ Bucket }}', + '{{ Name }}', + '{{ VpcConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3outposts.access_points ( + Bucket, + Name, + VpcConfiguration, + Policy, + region +) +SELECT + '{{ Bucket }}', + '{{ Name }}', + '{{ VpcConfiguration }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_point + props: + - name: Bucket + value: '{{ Bucket }}' + - name: Name + value: '{{ Name }}' + - name: VpcConfiguration + value: + VpcId: '{{ VpcId }}' + - name: Policy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3outposts.access_points +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +s3-outposts:ListAccessPoints +``` diff --git a/website/docs/services/s3outposts/access_points_list_only/index.md b/website/docs/services/s3outposts/access_points_list_only/index.md new file mode 100644 index 0000000..49647a3 --- /dev/null +++ b/website/docs/services/s3outposts/access_points_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_points_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_points in a region or regions, for all properties use access_points + +## Overview + + + + + + + +
Nameaccess_points_list_only
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::AccessPoint
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified AccessPoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_points in a region. +```sql +SELECT +region, +arn +FROM aws.s3outposts.access_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_points_list_only resource, see access_points + diff --git a/website/docs/services/s3outposts/bucket_policies/index.md b/website/docs/services/s3outposts/bucket_policies/index.md new file mode 100644 index 0000000..b274da4 --- /dev/null +++ b/website/docs/services/s3outposts/bucket_policies/index.md @@ -0,0 +1,188 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bucket_policy resource or lists bucket_policies in a region + +## Overview + + + + + + + +
Namebucket_policies
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::BucketPolicy
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified bucket.
objectA policy document containing permissions to add to the specified bucket.
stringAWS region.
+ +For more information, see AWS::S3Outposts::BucketPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual bucket_policy. +```sql +SELECT +region, +bucket, +policy_document +FROM aws.s3outposts.bucket_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bucket_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3outposts.bucket_policies ( + Bucket, + PolicyDocument, + region +) +SELECT +'{{ Bucket }}', + '{{ PolicyDocument }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3outposts.bucket_policies ( + Bucket, + PolicyDocument, + region +) +SELECT + '{{ Bucket }}', + '{{ PolicyDocument }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bucket_policy + props: + - name: Bucket + value: '{{ Bucket }}' + - name: PolicyDocument + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3outposts.bucket_policies +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +s3-outposts:GetBucketPolicy +``` + +### Update +```json +s3-outposts:PutBucketPolicy, +s3-outposts:GetBucketPolicy +``` + +### Delete +```json +s3-outposts:DeleteBucketPolicy, +s3-outposts:GetBucketPolicy +``` diff --git a/website/docs/services/s3outposts/bucket_tags/index.md b/website/docs/services/s3outposts/bucket_tags/index.md new file mode 100644 index 0000000..e1625c9 --- /dev/null +++ b/website/docs/services/s3outposts/bucket_tags/index.md @@ -0,0 +1,83 @@ +--- +title: bucket_tags +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_tags + - s3outposts + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for buckets in a region + +## Overview + + + + + + + +
Namebucket_tags
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::Bucket
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified bucket.
stringA name for the bucket.
stringThe id of the customer outpost on which the bucket resides.
objectRules that define how Amazon S3Outposts manages objects during their lifetime.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all buckets in a region. +```sql +SELECT +region, +arn, +bucket_name, +outpost_id, +lifecycle_configuration, +tag_key, +tag_value +FROM aws.s3outposts.bucket_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bucket_tags resource, see buckets + diff --git a/website/docs/services/s3outposts/buckets/index.md b/website/docs/services/s3outposts/buckets/index.md new file mode 100644 index 0000000..9bb79d6 --- /dev/null +++ b/website/docs/services/s3outposts/buckets/index.md @@ -0,0 +1,241 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a bucket resource or lists buckets in a region + +## Overview + + + + + + + +
Namebuckets
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::Bucket
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified bucket.
stringA name for the bucket.
stringThe id of the customer outpost on which the bucket resides.
arrayAn arbitrary set of tags (key-value pairs) for this S3Outposts bucket.
objectRules that define how Amazon S3Outposts manages objects during their lifetime.
stringAWS region.
+ +For more information, see AWS::S3Outposts::Bucket. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all buckets in a region. +```sql +SELECT +region, +arn, +bucket_name, +outpost_id, +tags, +lifecycle_configuration +FROM aws.s3outposts.buckets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual bucket. +```sql +SELECT +region, +arn, +bucket_name, +outpost_id, +tags, +lifecycle_configuration +FROM aws.s3outposts.buckets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new bucket resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3outposts.buckets ( + BucketName, + OutpostId, + region +) +SELECT +'{{ BucketName }}', + '{{ OutpostId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3outposts.buckets ( + BucketName, + OutpostId, + Tags, + LifecycleConfiguration, + region +) +SELECT + '{{ BucketName }}', + '{{ OutpostId }}', + '{{ Tags }}', + '{{ LifecycleConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: bucket + props: + - name: BucketName + value: '{{ BucketName }}' + - name: OutpostId + value: '{{ OutpostId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: LifecycleConfiguration + value: + Rules: + - Status: '{{ Status }}' + Id: '{{ Id }}' + AbortIncompleteMultipartUpload: + DaysAfterInitiation: '{{ DaysAfterInitiation }}' + ExpirationDate: '{{ ExpirationDate }}' + ExpirationInDays: '{{ ExpirationInDays }}' + Filter: + Prefix: '{{ Prefix }}' + Tag: + Key: '{{ Key }}' + Value: '{{ Value }}' + AndOperator: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3outposts.buckets +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +s3-outposts:ListRegionalBuckets +``` diff --git a/website/docs/services/s3outposts/buckets_list_only/index.md b/website/docs/services/s3outposts/buckets_list_only/index.md new file mode 100644 index 0000000..aca574c --- /dev/null +++ b/website/docs/services/s3outposts/buckets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: buckets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - buckets_list_only + - s3outposts + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists buckets in a region or regions, for all properties use buckets + +## Overview + + + + + + + +
Namebuckets_list_only
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::Bucket
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified bucket.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all buckets in a region. +```sql +SELECT +region, +arn +FROM aws.s3outposts.buckets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the buckets_list_only resource, see buckets + diff --git a/website/docs/services/s3outposts/endpoints/index.md b/website/docs/services/s3outposts/endpoints/index.md new file mode 100644 index 0000000..7832c82 --- /dev/null +++ b/website/docs/services/s3outposts/endpoints/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an endpoint resource or lists endpoints in a region + +## Overview + + + + + + + +
Nameendpoints
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::Endpoint
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the endpoint.
stringThe VPC CIDR committed by this endpoint.
stringThe time the endpoint was created.
stringThe ID of the endpoint.
arrayThe network interfaces of the endpoint.
stringThe id of the customer outpost on which the bucket resides.
stringThe ID of the security group to use with the endpoint.
string
stringThe ID of the subnet in the selected VPC. The subnet must belong to the Outpost.
stringThe type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.
stringThe ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.
objectThe failure reason, if any, for a create or delete endpoint operation.
stringAWS region.
+ +For more information, see AWS::S3Outposts::Endpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all endpoints in a region. +```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.endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual endpoint. +```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.endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3outposts.endpoints ( + OutpostId, + SecurityGroupId, + SubnetId, + region +) +SELECT +'{{ OutpostId }}', + '{{ SecurityGroupId }}', + '{{ SubnetId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3outposts.endpoints ( + OutpostId, + SecurityGroupId, + SubnetId, + AccessType, + CustomerOwnedIpv4Pool, + FailedReason, + region +) +SELECT + '{{ OutpostId }}', + '{{ SecurityGroupId }}', + '{{ SubnetId }}', + '{{ AccessType }}', + '{{ CustomerOwnedIpv4Pool }}', + '{{ FailedReason }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: endpoint + props: + - name: OutpostId + value: '{{ OutpostId }}' + - name: SecurityGroupId + value: '{{ SecurityGroupId }}' + - name: SubnetId + value: '{{ SubnetId }}' + - name: AccessType + value: '{{ AccessType }}' + - name: CustomerOwnedIpv4Pool + value: '{{ CustomerOwnedIpv4Pool }}' + - name: FailedReason + value: + ErrorCode: '{{ ErrorCode }}' + Message: '{{ Message }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3outposts.endpoints +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the endpoints resource, the following permissions are required: + +### Create +```json +s3-outposts:CreateEndpoint +``` + +### Read +```json +s3-outposts:ListEndpoints +``` + +### Delete +```json +s3-outposts:DeleteEndpoint +``` + +### List +```json +s3-outposts:ListEndpoints +``` diff --git a/website/docs/services/s3outposts/endpoints_list_only/index.md b/website/docs/services/s3outposts/endpoints_list_only/index.md new file mode 100644 index 0000000..00e0f4b --- /dev/null +++ b/website/docs/services/s3outposts/endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints_list_only + - s3outposts + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoints in a region or regions, for all properties use endpoints + +## Overview + + + + + + + +
Nameendpoints_list_only
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::Endpoint
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the endpoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoints in a region. +```sql +SELECT +region, +arn +FROM aws.s3outposts.endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the endpoints_list_only resource, see endpoints + diff --git a/website/docs/services/s3outposts/index.md b/website/docs/services/s3outposts/index.md new file mode 100644 index 0000000..de898bb --- /dev/null +++ b/website/docs/services/s3outposts/index.md @@ -0,0 +1,43 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The s3outposts service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/s3tables/index.md b/website/docs/services/s3tables/index.md new file mode 100644 index 0000000..86f01c6 --- /dev/null +++ b/website/docs/services/s3tables/index.md @@ -0,0 +1,39 @@ +--- +title: s3tables +hide_title: false +hide_table_of_contents: false +keywords: + - s3tables + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The s3tables service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/s3tables/table_bucket_policies/index.md b/website/docs/services/s3tables/table_bucket_policies/index.md new file mode 100644 index 0000000..f27f48f --- /dev/null +++ b/website/docs/services/s3tables/table_bucket_policies/index.md @@ -0,0 +1,208 @@ +--- +title: table_bucket_policies +hide_title: false +hide_table_of_contents: false +keywords: + - table_bucket_policies + - s3tables + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a table_bucket_policy resource or lists table_bucket_policies in a region + +## Overview + + + + + + + +
Nametable_bucket_policies
TypeResource
DescriptionApplies an IAM resource policy to a table bucket.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectA policy document containing permissions to add to the specified table 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.
stringThe Amazon Resource Name (ARN) of the table bucket to which the policy applies.
stringAWS region.
+ +For more information, see AWS::S3Tables::TableBucketPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all table_bucket_policies in a region. +```sql +SELECT +region, +resource_policy, +table_bucket_arn +FROM aws.s3tables.table_bucket_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual table_bucket_policy. +```sql +SELECT +region, +resource_policy, +table_bucket_arn +FROM aws.s3tables.table_bucket_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new table_bucket_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3tables.table_bucket_policies ( + ResourcePolicy, + TableBucketARN, + region +) +SELECT +'{{ ResourcePolicy }}', + '{{ TableBucketARN }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3tables.table_bucket_policies ( + ResourcePolicy, + TableBucketARN, + region +) +SELECT + '{{ ResourcePolicy }}', + '{{ TableBucketARN }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: table_bucket_policy + props: + - name: ResourcePolicy + value: {} + - name: TableBucketARN + value: '{{ TableBucketARN }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3tables.table_bucket_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the table_bucket_policies resource, the following permissions are required: + +### Create +```json +s3tables:GetTableBucket, +s3tables:GetTableBucketPolicy, +s3tables:PutTableBucketPolicy +``` + +### Read +```json +s3tables:GetTableBucketPolicy +``` + +### Update +```json +s3tables:GetTableBucketPolicy, +s3tables:PutTableBucketPolicy +``` + +### Delete +```json +s3tables:GetTableBucketPolicy, +s3tables:DeleteTableBucketPolicy +``` + +### List +```json +s3tables:GetTableBucketPolicy, +s3tables:ListTableBuckets +``` diff --git a/website/docs/services/s3tables/table_bucket_policies_list_only/index.md b/website/docs/services/s3tables/table_bucket_policies_list_only/index.md new file mode 100644 index 0000000..7591b10 --- /dev/null +++ b/website/docs/services/s3tables/table_bucket_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: table_bucket_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - table_bucket_policies_list_only + - s3tables + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists table_bucket_policies in a region or regions, for all properties use table_bucket_policies + +## Overview + + + + + + + +
Nametable_bucket_policies_list_only
TypeResource
DescriptionApplies an IAM resource policy to a table bucket.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the table bucket to which the policy applies.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all table_bucket_policies in a region. +```sql +SELECT +region, +table_bucket_arn +FROM aws.s3tables.table_bucket_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the table_bucket_policies_list_only resource, see table_bucket_policies + diff --git a/website/docs/services/s3tables/table_buckets/index.md b/website/docs/services/s3tables/table_buckets/index.md new file mode 100644 index 0000000..c36c711 --- /dev/null +++ b/website/docs/services/s3tables/table_buckets/index.md @@ -0,0 +1,213 @@ +--- +title: table_buckets +hide_title: false +hide_table_of_contents: false +keywords: + - table_buckets + - s3tables + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a table_bucket resource or lists table_buckets in a region + +## Overview + + + + + + + +
Nametable_buckets
TypeResource
DescriptionCreates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the table bucket to which the policy applies.
stringA name for the table bucket.
objectSettings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots.
stringAWS region.
+ +For more information, see AWS::S3Tables::TableBucket. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all table_buckets in a region. +```sql +SELECT +region, +table_bucket_arn, +table_bucket_name, +unreferenced_file_removal +FROM aws.s3tables.table_buckets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual table_bucket. +```sql +SELECT +region, +table_bucket_arn, +table_bucket_name, +unreferenced_file_removal +FROM aws.s3tables.table_buckets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new table_bucket resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.s3tables.table_buckets ( + TableBucketName, + region +) +SELECT +'{{ TableBucketName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.s3tables.table_buckets ( + TableBucketName, + UnreferencedFileRemoval, + region +) +SELECT + '{{ TableBucketName }}', + '{{ UnreferencedFileRemoval }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: table_bucket + props: + - name: TableBucketName + value: '{{ TableBucketName }}' + - name: UnreferencedFileRemoval + value: + Status: '{{ Status }}' + UnreferencedDays: '{{ UnreferencedDays }}' + NoncurrentDays: '{{ NoncurrentDays }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.s3tables.table_buckets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the table_buckets resource, the following permissions are required: + +### Create +```json +s3tables:CreateTableBucket, +s3tables:PutTableBucketMaintenanceConfiguration, +s3tables:GetTableBucket, +s3tables:GetTableBucketMaintenanceConfiguration +``` + +### Read +```json +s3tables:GetTableBucket, +s3tables:GetTableBucketMaintenanceConfiguration +``` + +### Update +```json +s3tables:PutTableBucketMaintenanceConfiguration, +s3tables:GetTableBucket, +s3tables:GetTableBucketMaintenanceConfiguration +``` + +### Delete +```json +s3tables:DeleteTableBucket +``` + +### List +```json +s3tables:ListTableBuckets +``` diff --git a/website/docs/services/s3tables/table_buckets_list_only/index.md b/website/docs/services/s3tables/table_buckets_list_only/index.md new file mode 100644 index 0000000..1585cfd --- /dev/null +++ b/website/docs/services/s3tables/table_buckets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: table_buckets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - table_buckets_list_only + - s3tables + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists table_buckets in a region or regions, for all properties use table_buckets + +## Overview + + + + + + + +
Nametable_buckets_list_only
TypeResource
DescriptionCreates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the table bucket to which the policy applies.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all table_buckets in a region. +```sql +SELECT +region, +table_bucket_arn +FROM aws.s3tables.table_buckets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the table_buckets_list_only resource, see table_buckets + diff --git a/website/docs/services/sagemaker/app_image_config_tags/index.md b/website/docs/services/sagemaker/app_image_config_tags/index.md new file mode 100644 index 0000000..ecce94c --- /dev/null +++ b/website/docs/services/sagemaker/app_image_config_tags/index.md @@ -0,0 +1,85 @@ +--- +title: app_image_config_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_image_config_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for app_image_configs in a region + +## Overview + + + + + + + +
Nameapp_image_config_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::AppImageConfig
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the AppImageConfig.
stringThe Name of the AppImageConfig.
objectThe KernelGatewayImageConfig.
objectThe JupyterLabAppImageConfig.
objectThe CodeEditorAppImageConfig.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all app_image_configs in a region. +```sql +SELECT +region, +app_image_config_arn, +app_image_config_name, +kernel_gateway_image_config, +jupyter_lab_app_image_config, +code_editor_app_image_config, +tag_key, +tag_value +FROM aws.sagemaker.app_image_config_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_image_config_tags resource, see app_image_configs + diff --git a/website/docs/services/sagemaker/app_image_configs/index.md b/website/docs/services/sagemaker/app_image_configs/index.md new file mode 100644 index 0000000..60a4e97 --- /dev/null +++ b/website/docs/services/sagemaker/app_image_configs/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an app_image_config resource or lists app_image_configs in a region + +## Overview + + + + + + + +
Nameapp_image_configs
TypeResource
DescriptionResource Type definition for AWS::SageMaker::AppImageConfig
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the AppImageConfig.
stringThe Name of the AppImageConfig.
objectThe KernelGatewayImageConfig.
objectThe JupyterLabAppImageConfig.
objectThe CodeEditorAppImageConfig.
arrayA list of tags to apply to the AppImageConfig.
stringAWS region.
+ +For more information, see AWS::SageMaker::AppImageConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all app_image_configs in a region. +```sql +SELECT +region, +app_image_config_arn, +app_image_config_name, +kernel_gateway_image_config, +jupyter_lab_app_image_config, +code_editor_app_image_config, +tags +FROM aws.sagemaker.app_image_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual app_image_config. +```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_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new app_image_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.app_image_configs ( + AppImageConfigName, + region +) +SELECT +'{{ AppImageConfigName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.app_image_configs ( + AppImageConfigName, + KernelGatewayImageConfig, + JupyterLabAppImageConfig, + CodeEditorAppImageConfig, + Tags, + region +) +SELECT + '{{ AppImageConfigName }}', + '{{ KernelGatewayImageConfig }}', + '{{ JupyterLabAppImageConfig }}', + '{{ CodeEditorAppImageConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: app_image_config + props: + - name: AppImageConfigName + value: '{{ AppImageConfigName }}' + - name: KernelGatewayImageConfig + value: + FileSystemConfig: + DefaultGid: '{{ DefaultGid }}' + DefaultUid: '{{ DefaultUid }}' + MountPath: '{{ MountPath }}' + KernelSpecs: + - DisplayName: '{{ DisplayName }}' + Name: '{{ Name }}' + - name: JupyterLabAppImageConfig + value: + ContainerConfig: + ContainerArguments: + - '{{ ContainerArguments[0] }}' + ContainerEntrypoint: + - '{{ ContainerEntrypoint[0] }}' + ContainerEnvironmentVariables: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: CodeEditorAppImageConfig + value: + ContainerConfig: null + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.app_image_configs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the app_image_configs resource, the following permissions are required: + +### Create +```json +sagemaker:CreateAppImageConfig, +sagemaker:DescribeAppImageConfig +``` + +### Read +```json +sagemaker:DescribeAppImageConfig +``` + +### Update +```json +sagemaker:UpdateAppImageConfig, +sagemaker:DescribeAppImageConfig +``` + +### Delete +```json +sagemaker:DeleteAppImageConfig, +sagemaker:DescribeAppImageConfig +``` + +### List +```json +sagemaker:ListAppImageConfigs +``` diff --git a/website/docs/services/sagemaker/app_image_configs_list_only/index.md b/website/docs/services/sagemaker/app_image_configs_list_only/index.md new file mode 100644 index 0000000..e3cc6b2 --- /dev/null +++ b/website/docs/services/sagemaker/app_image_configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: app_image_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - app_image_configs_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists app_image_configs in a region or regions, for all properties use app_image_configs + +## Overview + + + + + + + +
Nameapp_image_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::AppImageConfig
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Name of the AppImageConfig.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all app_image_configs in a region. +```sql +SELECT +region, +app_image_config_name +FROM aws.sagemaker.app_image_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_image_configs_list_only resource, see app_image_configs + diff --git a/website/docs/services/sagemaker/app_tags/index.md b/website/docs/services/sagemaker/app_tags/index.md new file mode 100644 index 0000000..c58b8e5 --- /dev/null +++ b/website/docs/services/sagemaker/app_tags/index.md @@ -0,0 +1,87 @@ +--- +title: app_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for apps in a region + +## Overview + + + + + + + +
Nameapp_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::App
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the app.
stringThe name of the app.
stringThe type of app.
stringThe domain ID.
objectThe instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
stringThe user profile name.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all apps in a region. +```sql +SELECT +region, +app_arn, +app_name, +app_type, +domain_id, +resource_spec, +user_profile_name, +tag_key, +tag_value +FROM aws.sagemaker.app_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_tags resource, see apps + diff --git a/website/docs/services/sagemaker/apps/index.md b/website/docs/services/sagemaker/apps/index.md new file mode 100644 index 0000000..a39643c --- /dev/null +++ b/website/docs/services/sagemaker/apps/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an app resource or lists apps in a region + +## Overview + + + + + + + +
Nameapps
TypeResource
DescriptionResource Type definition for AWS::SageMaker::App
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the app.
stringThe name of the app.
stringThe type of app.
stringThe domain ID.
objectThe instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
arrayA list of tags to apply to the app.
stringThe user profile name.
stringAWS region.
+ +For more information, see AWS::SageMaker::App. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all apps in a region. +```sql +SELECT +region, +app_arn, +app_name, +app_type, +domain_id, +resource_spec, +tags, +user_profile_name +FROM aws.sagemaker.apps +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual app. +```sql +SELECT +region, +app_arn, +app_name, +app_type, +domain_id, +resource_spec, +tags, +user_profile_name +FROM aws.sagemaker.apps +WHERE region = 'us-east-1' AND data__Identifier = '|||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new app resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.apps ( + AppName, + AppType, + DomainId, + UserProfileName, + region +) +SELECT +'{{ AppName }}', + '{{ AppType }}', + '{{ DomainId }}', + '{{ UserProfileName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.apps ( + AppName, + AppType, + DomainId, + ResourceSpec, + Tags, + UserProfileName, + region +) +SELECT + '{{ AppName }}', + '{{ AppType }}', + '{{ DomainId }}', + '{{ ResourceSpec }}', + '{{ Tags }}', + '{{ UserProfileName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: app + props: + - name: AppName + value: '{{ AppName }}' + - name: AppType + value: '{{ AppType }}' + - name: DomainId + value: '{{ DomainId }}' + - name: ResourceSpec + value: + InstanceType: '{{ InstanceType }}' + SageMakerImageArn: '{{ SageMakerImageArn }}' + SageMakerImageVersionArn: '{{ SageMakerImageVersionArn }}' + LifecycleConfigArn: '{{ LifecycleConfigArn }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: UserProfileName + value: '{{ UserProfileName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.apps +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the apps resource, the following permissions are required: + +### Create +```json +sagemaker:CreateApp, +sagemaker:DescribeApp +``` + +### Read +```json +sagemaker:DescribeApp, +sagemaker:DescribeApp +``` + +### Delete +```json +sagemaker:DeleteApp, +sagemaker:DescribeApp +``` + +### List +```json +sagemaker:ListApps +``` diff --git a/website/docs/services/sagemaker/apps_list_only/index.md b/website/docs/services/sagemaker/apps_list_only/index.md new file mode 100644 index 0000000..74147d8 --- /dev/null +++ b/website/docs/services/sagemaker/apps_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: apps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - apps_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists apps in a region or regions, for all properties use apps + +## Overview + + + + + + + +
Nameapps_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::App
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the app.
stringThe type of app.
stringThe domain ID.
stringThe user profile name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all apps in a region. +```sql +SELECT +region, +app_name, +app_type, +domain_id, +user_profile_name +FROM aws.sagemaker.apps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the apps_list_only resource, see apps + diff --git a/website/docs/services/sagemaker/cluster_tags/index.md b/website/docs/services/sagemaker/cluster_tags/index.md new file mode 100644 index 0000000..5648ded --- /dev/null +++ b/website/docs/services/sagemaker/cluster_tags/index.md @@ -0,0 +1,93 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + + + +
Namecluster_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Cluster
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the HyperPod Cluster.
objectSpecifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.
stringIf node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.
stringThe time at which the HyperPod cluster was created.
arrayThe instance groups of the SageMaker HyperPod cluster.
stringThe name of the HyperPod Cluster.
stringThe failure message of the HyperPod Cluster.
objectSpecifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster.
stringThe status of the HyperPod Cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +cluster_arn, +vpc_config, +node_recovery, +creation_time, +instance_groups, +cluster_name, +failure_message, +orchestrator, +cluster_status, +tag_key, +tag_value +FROM aws.sagemaker.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + diff --git a/website/docs/services/sagemaker/clusters/index.md b/website/docs/services/sagemaker/clusters/index.md new file mode 100644 index 0000000..4513c24 --- /dev/null +++ b/website/docs/services/sagemaker/clusters/index.md @@ -0,0 +1,286 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - clusters + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cluster resource or lists clusters in a region + +## Overview + + + + + + + +
Nameclusters
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Cluster
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the HyperPod Cluster.
objectSpecifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.
stringIf node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.
stringThe time at which the HyperPod cluster was created.
arrayThe instance groups of the SageMaker HyperPod cluster.
stringThe name of the HyperPod Cluster.
stringThe failure message of the HyperPod Cluster.
objectSpecifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster.
stringThe status of the HyperPod Cluster.
arrayCustom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging.
stringAWS region.
+ +For more information, see AWS::SageMaker::Cluster. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all clusters in a region. +```sql +SELECT +region, +cluster_arn, +vpc_config, +node_recovery, +creation_time, +instance_groups, +cluster_name, +failure_message, +orchestrator, +cluster_status, +tags +FROM aws.sagemaker.clusters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual cluster. +```sql +SELECT +region, +cluster_arn, +vpc_config, +node_recovery, +creation_time, +instance_groups, +cluster_name, +failure_message, +orchestrator, +cluster_status, +tags +FROM aws.sagemaker.clusters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.clusters ( + InstanceGroups, + region +) +SELECT +'{{ InstanceGroups }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.clusters ( + VpcConfig, + NodeRecovery, + InstanceGroups, + ClusterName, + Orchestrator, + Tags, + region +) +SELECT + '{{ VpcConfig }}', + '{{ NodeRecovery }}', + '{{ InstanceGroups }}', + '{{ ClusterName }}', + '{{ Orchestrator }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cluster + props: + - name: VpcConfig + value: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + Subnets: + - '{{ Subnets[0] }}' + - name: NodeRecovery + value: '{{ NodeRecovery }}' + - name: InstanceGroups + value: + - OverrideVpcConfig: null + InstanceCount: '{{ InstanceCount }}' + OnStartDeepHealthChecks: + - '{{ OnStartDeepHealthChecks[0] }}' + InstanceGroupName: '{{ InstanceGroupName }}' + InstanceStorageConfigs: + - {} + CurrentCount: '{{ CurrentCount }}' + LifeCycleConfig: + SourceS3Uri: '{{ SourceS3Uri }}' + OnCreate: '{{ OnCreate }}' + InstanceType: '{{ InstanceType }}' + ThreadsPerCore: '{{ ThreadsPerCore }}' + ExecutionRole: '{{ ExecutionRole }}' + - name: ClusterName + value: '{{ ClusterName }}' + - name: Orchestrator + value: + Eks: + ClusterArn: '{{ ClusterArn }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.clusters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeCluster, +sagemaker:ListTags +``` + +### Create +```json +sagemaker:CreateCluster, +sagemaker:DescribeCluster, +sagemaker:AddTags, +sagemaker:ListTags, +eks:DescribeAccessEntry, +eks:DescribeCluster, +eks:CreateAccessEntry, +eks:DeleteAccessEntry, +eks:AssociateAccessPolicy, +iam:CreateServiceLinkedRole, +iam:PassRole +``` + +### Update +```json +sagemaker:UpdateCluster, +sagemaker:DescribeCluster, +sagemaker:ListTags, +sagemaker:AddTags, +sagemaker:DeleteTags, +eks:DescribeAccessEntry, +eks:DescribeCluster, +eks:CreateAccessEntry, +eks:DeleteAccessEntry, +iam:PassRole +``` + +### List +```json +sagemaker:ListClusters +``` + +### Delete +```json +sagemaker:DeleteCluster, +sagemaker:DescribeCluster, +eks:DescribeAccessEntry, +eks:DeleteAccessEntry +``` diff --git a/website/docs/services/sagemaker/clusters_list_only/index.md b/website/docs/services/sagemaker/clusters_list_only/index.md new file mode 100644 index 0000000..bf35505 --- /dev/null +++ b/website/docs/services/sagemaker/clusters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + + + +
Nameclusters_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Cluster
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the HyperPod Cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +cluster_arn +FROM aws.sagemaker.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + diff --git a/website/docs/services/sagemaker/data_quality_job_definition_tags/index.md b/website/docs/services/sagemaker/data_quality_job_definition_tags/index.md new file mode 100644 index 0000000..583d326 --- /dev/null +++ b/website/docs/services/sagemaker/data_quality_job_definition_tags/index.md @@ -0,0 +1,99 @@ +--- +title: data_quality_job_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_quality_job_definition_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_quality_job_definitions in a region + +## Overview + + + + + + + +
Namedata_quality_job_definition_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::DataQualityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
stringThe time at which the job definition was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_quality_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +data_quality_baseline_config, +data_quality_app_specification, +data_quality_job_input, +data_quality_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +creation_time, +tag_key, +tag_value +FROM aws.sagemaker.data_quality_job_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_quality_job_definition_tags resource, see data_quality_job_definitions + diff --git a/website/docs/services/sagemaker/data_quality_job_definitions/index.md b/website/docs/services/sagemaker/data_quality_job_definitions/index.md new file mode 100644 index 0000000..0a9a192 --- /dev/null +++ b/website/docs/services/sagemaker/data_quality_job_definitions/index.md @@ -0,0 +1,324 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_quality_job_definition resource or lists data_quality_job_definitions in a region + +## Overview + + + + + + + +
Namedata_quality_job_definitions
TypeResource
DescriptionResource Type definition for AWS::SageMaker::DataQualityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
+ +For more information, see AWS::SageMaker::DataQualityJobDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_quality_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +data_quality_baseline_config, +data_quality_app_specification, +data_quality_job_input, +data_quality_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +tags, +creation_time +FROM aws.sagemaker.data_quality_job_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_quality_job_definition. +```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_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_quality_job_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.data_quality_job_definitions ( + DataQualityAppSpecification, + DataQualityJobInput, + DataQualityJobOutputConfig, + JobResources, + RoleArn, + region +) +SELECT +'{{ DataQualityAppSpecification }}', + '{{ DataQualityJobInput }}', + '{{ DataQualityJobOutputConfig }}', + '{{ JobResources }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.data_quality_job_definitions ( + JobDefinitionName, + DataQualityBaselineConfig, + DataQualityAppSpecification, + DataQualityJobInput, + DataQualityJobOutputConfig, + JobResources, + NetworkConfig, + EndpointName, + RoleArn, + StoppingCondition, + Tags, + region +) +SELECT + '{{ JobDefinitionName }}', + '{{ DataQualityBaselineConfig }}', + '{{ DataQualityAppSpecification }}', + '{{ DataQualityJobInput }}', + '{{ DataQualityJobOutputConfig }}', + '{{ JobResources }}', + '{{ NetworkConfig }}', + '{{ EndpointName }}', + '{{ RoleArn }}', + '{{ StoppingCondition }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_quality_job_definition + props: + - name: JobDefinitionName + value: '{{ JobDefinitionName }}' + - name: DataQualityBaselineConfig + value: + BaseliningJobName: '{{ BaseliningJobName }}' + ConstraintsResource: + S3Uri: '{{ S3Uri }}' + StatisticsResource: + S3Uri: null + - name: DataQualityAppSpecification + value: + ContainerArguments: + - '{{ ContainerArguments[0] }}' + ContainerEntrypoint: + - '{{ ContainerEntrypoint[0] }}' + ImageUri: '{{ ImageUri }}' + PostAnalyticsProcessorSourceUri: null + RecordPreprocessorSourceUri: null + Environment: {} + - name: DataQualityJobInput + value: + EndpointInput: + EndpointName: '{{ EndpointName }}' + LocalPath: '{{ LocalPath }}' + S3DataDistributionType: '{{ S3DataDistributionType }}' + S3InputMode: '{{ S3InputMode }}' + ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}' + BatchTransformInput: + DataCapturedDestinationS3Uri: '{{ DataCapturedDestinationS3Uri }}' + DatasetFormat: + Csv: + Header: '{{ Header }}' + Json: + Line: '{{ Line }}' + Parquet: '{{ Parquet }}' + LocalPath: '{{ LocalPath }}' + S3DataDistributionType: '{{ S3DataDistributionType }}' + S3InputMode: '{{ S3InputMode }}' + ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}' + - name: DataQualityJobOutputConfig + value: + KmsKeyId: '{{ KmsKeyId }}' + MonitoringOutputs: + - S3Output: + LocalPath: '{{ LocalPath }}' + S3UploadMode: '{{ S3UploadMode }}' + S3Uri: '{{ S3Uri }}' + - name: JobResources + value: + ClusterConfig: + InstanceCount: '{{ InstanceCount }}' + InstanceType: '{{ InstanceType }}' + VolumeKmsKeyId: '{{ VolumeKmsKeyId }}' + VolumeSizeInGB: '{{ VolumeSizeInGB }}' + - name: NetworkConfig + value: + EnableInterContainerTrafficEncryption: '{{ EnableInterContainerTrafficEncryption }}' + EnableNetworkIsolation: '{{ EnableNetworkIsolation }}' + VpcConfig: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + Subnets: + - '{{ Subnets[0] }}' + - name: EndpointName + value: null + - name: RoleArn + value: '{{ RoleArn }}' + - name: StoppingCondition + value: + MaxRuntimeInSeconds: '{{ MaxRuntimeInSeconds }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.data_quality_job_definitions +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +sagemaker:DeleteDataQualityJobDefinition +``` + +### Read +```json +sagemaker:DescribeDataQualityJobDefinition +``` + +### List +```json +sagemaker:ListDataQualityJobDefinitions, +sagemaker:ListTags +``` diff --git a/website/docs/services/sagemaker/data_quality_job_definitions_list_only/index.md b/website/docs/services/sagemaker/data_quality_job_definitions_list_only/index.md new file mode 100644 index 0000000..34437fb --- /dev/null +++ b/website/docs/services/sagemaker/data_quality_job_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: data_quality_job_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_quality_job_definitions_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_quality_job_definitions in a region or regions, for all properties use data_quality_job_definitions + +## Overview + + + + + + + +
Namedata_quality_job_definitions_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::DataQualityJobDefinition
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_quality_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.data_quality_job_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_quality_job_definitions_list_only resource, see data_quality_job_definitions + diff --git a/website/docs/services/sagemaker/device_fleets/index.md b/website/docs/services/sagemaker/device_fleets/index.md new file mode 100644 index 0000000..4a767a1 --- /dev/null +++ b/website/docs/services/sagemaker/device_fleets/index.md @@ -0,0 +1,211 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a device_fleet resource or lists device_fleets in a region + +## Overview + + + + + + + +
Namedevice_fleets
TypeResource
DescriptionResource schema for AWS::SageMaker::DeviceFleet
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringDescription for the edge device fleet
stringThe name of the edge device fleet
objectS3 bucket and an ecryption key id (if available) to store outputs for the fleet
stringRole associated with the device fleet
arrayAssociate tags with the resource
stringAWS region.
+ +For more information, see AWS::SageMaker::DeviceFleet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual device_fleet. +```sql +SELECT +region, +description, +device_fleet_name, +output_config, +role_arn, +tags +FROM aws.sagemaker.device_fleets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new device_fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.device_fleets ( + DeviceFleetName, + OutputConfig, + RoleArn, + region +) +SELECT +'{{ DeviceFleetName }}', + '{{ OutputConfig }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.device_fleets ( + Description, + DeviceFleetName, + OutputConfig, + RoleArn, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ DeviceFleetName }}', + '{{ OutputConfig }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: device_fleet + props: + - name: Description + value: '{{ Description }}' + - name: DeviceFleetName + value: '{{ DeviceFleetName }}' + - name: OutputConfig + value: + S3OutputLocation: '{{ S3OutputLocation }}' + KmsKeyId: '{{ KmsKeyId }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.device_fleets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the device_fleets resource, the following permissions are required: + +### Create +```json +sagemaker:CreateDeviceFleet, +iam:PassRole +``` + +### Read +```json +sagemaker:DescribeDeviceFleet +``` + +### Update +```json +sagemaker:UpdateDeviceFleet, +iam:PassRole +``` + +### Delete +```json +sagemaker:DeleteDeviceFleet +``` diff --git a/website/docs/services/sagemaker/devices/index.md b/website/docs/services/sagemaker/devices/index.md new file mode 100644 index 0000000..a4ae49e --- /dev/null +++ b/website/docs/services/sagemaker/devices/index.md @@ -0,0 +1,195 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a device resource or lists devices in a region + +## Overview + + + + + + + +
Namedevices
TypeResource
DescriptionResource schema for AWS::SageMaker::Device
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the edge device fleet
objectThe Edge Device you want to register against a device fleet
arrayAssociate tags with the resource
stringAWS region.
+ +For more information, see AWS::SageMaker::Device. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual device. +```sql +SELECT +region, +device_fleet_name, +device, +tags +FROM aws.sagemaker.devices +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new device resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.devices ( + DeviceFleetName, + region +) +SELECT +'{{ DeviceFleetName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.devices ( + DeviceFleetName, + Device, + Tags, + region +) +SELECT + '{{ DeviceFleetName }}', + '{{ Device }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: device + props: + - name: DeviceFleetName + value: '{{ DeviceFleetName }}' + - name: Device + value: + DeviceFleetName: '{{ DeviceFleetName }}' + Device: null + Tags: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Tags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.devices +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the devices resource, the following permissions are required: + +### Create +```json +sagemaker:RegisterDevices +``` + +### Read +```json +sagemaker:DescribeDevice +``` + +### Update +```json +sagemaker:UpdateDevices +``` + +### Delete +```json +sagemaker:DeregisterDevices +``` diff --git a/website/docs/services/sagemaker/endpoint_tags/index.md b/website/docs/services/sagemaker/endpoint_tags/index.md new file mode 100644 index 0000000..3c27a7d --- /dev/null +++ b/website/docs/services/sagemaker/endpoint_tags/index.md @@ -0,0 +1,89 @@ +--- +title: endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for endpoints in a region + +## Overview + + + + + + + +
Nameendpoint_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Endpoint
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectSpecifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies.
stringThe Amazon Resource Name (ARN) of the endpoint.
stringThe name of the endpoint configuration for the SageMaker endpoint. This is a required property.
stringThe name of the SageMaker endpoint. This name must be unique within an AWS Region.
arraySpecifies a list of variant properties that you want to exclude when updating an endpoint.
booleanWhen set to true, retains all variant properties for an endpoint when it is updated.
booleanWhen set to true, retains the deployment configuration during endpoint updates.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all endpoints in a region. +```sql +SELECT +region, +deployment_config, +endpoint_arn, +endpoint_config_name, +endpoint_name, +exclude_retained_variant_properties, +retain_all_variant_properties, +retain_deployment_config, +tag_key, +tag_value +FROM aws.sagemaker.endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the endpoint_tags resource, see endpoints + diff --git a/website/docs/services/sagemaker/endpoints/index.md b/website/docs/services/sagemaker/endpoints/index.md new file mode 100644 index 0000000..dfd29b8 --- /dev/null +++ b/website/docs/services/sagemaker/endpoints/index.md @@ -0,0 +1,263 @@ +--- +title: endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an endpoint resource or lists endpoints in a region + +## Overview + + + + + + + +
Nameendpoints
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Endpoint
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectSpecifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies.
stringThe Amazon Resource Name (ARN) of the endpoint.
stringThe name of the endpoint configuration for the SageMaker endpoint. This is a required property.
stringThe name of the SageMaker endpoint. This name must be unique within an AWS Region.
arraySpecifies a list of variant properties that you want to exclude when updating an endpoint.
booleanWhen set to true, retains all variant properties for an endpoint when it is updated.
booleanWhen set to true, retains the deployment configuration during endpoint updates.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::SageMaker::Endpoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all endpoints in a region. +```sql +SELECT +region, +deployment_config, +endpoint_arn, +endpoint_config_name, +endpoint_name, +exclude_retained_variant_properties, +retain_all_variant_properties, +retain_deployment_config, +tags +FROM aws.sagemaker.endpoints +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual endpoint. +```sql +SELECT +region, +deployment_config, +endpoint_arn, +endpoint_config_name, +endpoint_name, +exclude_retained_variant_properties, +retain_all_variant_properties, +retain_deployment_config, +tags +FROM aws.sagemaker.endpoints +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.endpoints ( + EndpointConfigName, + region +) +SELECT +'{{ EndpointConfigName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.endpoints ( + DeploymentConfig, + EndpointConfigName, + ExcludeRetainedVariantProperties, + RetainAllVariantProperties, + RetainDeploymentConfig, + Tags, + region +) +SELECT + '{{ DeploymentConfig }}', + '{{ EndpointConfigName }}', + '{{ ExcludeRetainedVariantProperties }}', + '{{ RetainAllVariantProperties }}', + '{{ RetainDeploymentConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: endpoint + props: + - name: DeploymentConfig + value: + AutoRollbackConfiguration: + Alarms: + - AlarmName: '{{ AlarmName }}' + BlueGreenUpdatePolicy: + MaximumExecutionTimeoutInSeconds: '{{ MaximumExecutionTimeoutInSeconds }}' + TerminationWaitInSeconds: '{{ TerminationWaitInSeconds }}' + TrafficRoutingConfiguration: + CanarySize: + Type: '{{ Type }}' + Value: '{{ Value }}' + LinearStepSize: null + Type: '{{ Type }}' + WaitIntervalInSeconds: '{{ WaitIntervalInSeconds }}' + RollingUpdatePolicy: + MaximumBatchSize: null + MaximumExecutionTimeoutInSeconds: '{{ MaximumExecutionTimeoutInSeconds }}' + RollbackMaximumBatchSize: null + WaitIntervalInSeconds: '{{ WaitIntervalInSeconds }}' + - name: EndpointConfigName + value: '{{ EndpointConfigName }}' + - name: ExcludeRetainedVariantProperties + value: + - VariantPropertyType: '{{ VariantPropertyType }}' + - name: RetainAllVariantProperties + value: '{{ RetainAllVariantProperties }}' + - name: RetainDeploymentConfig + value: '{{ RetainDeploymentConfig }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.endpoints +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the endpoints resource, the following permissions are required: + +### Create +```json +sagemaker:CreateEndpoint, +sagemaker:DescribeEndpoint, +sagemaker:AddTags +``` + +### Read +```json +sagemaker:DescribeEndpoint, +sagemaker:ListTags +``` + +### Update +```json +sagemaker:UpdateEndpoint, +sagemaker:DescribeEndpoint, +sagemaker:AddTags, +sagemaker:DeleteTags +``` + +### Delete +```json +sagemaker:DeleteEndpoint, +sagemaker:DescribeEndpoint +``` + +### List +```json +sagemaker:ListEndpoints +``` diff --git a/website/docs/services/sagemaker/endpoints_list_only/index.md b/website/docs/services/sagemaker/endpoints_list_only/index.md new file mode 100644 index 0000000..232712e --- /dev/null +++ b/website/docs/services/sagemaker/endpoints_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoints in a region or regions, for all properties use endpoints + +## Overview + + + + + + + +
Nameendpoints_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Endpoint
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the endpoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoints in a region. +```sql +SELECT +region, +endpoint_arn +FROM aws.sagemaker.endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the endpoints_list_only resource, see endpoints + diff --git a/website/docs/services/sagemaker/feature_group_tags/index.md b/website/docs/services/sagemaker/feature_group_tags/index.md new file mode 100644 index 0000000..3dd5540 --- /dev/null +++ b/website/docs/services/sagemaker/feature_group_tags/index.md @@ -0,0 +1,97 @@ +--- +title: feature_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - feature_group_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for feature_groups in a region + +## Overview + + + + + + + +
Namefeature_group_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::FeatureGroup
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Name of the FeatureGroup.
stringThe Record Identifier Feature Name.
stringThe Event Time Feature Name.
arrayAn Array of Feature Definition
object
object
object
stringRole Arn
stringDescription about the FeatureGroup.
stringA timestamp of FeatureGroup creation time.
stringThe status of the feature group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all feature_groups in a region. +```sql +SELECT +region, +feature_group_name, +record_identifier_feature_name, +event_time_feature_name, +feature_definitions, +online_store_config, +offline_store_config, +throughput_config, +role_arn, +description, +creation_time, +feature_group_status, +tag_key, +tag_value +FROM aws.sagemaker.feature_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the feature_group_tags resource, see feature_groups + diff --git a/website/docs/services/sagemaker/feature_groups/index.md b/website/docs/services/sagemaker/feature_groups/index.md new file mode 100644 index 0000000..c5a8121 --- /dev/null +++ b/website/docs/services/sagemaker/feature_groups/index.md @@ -0,0 +1,308 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a feature_group resource or lists feature_groups in a region + +## Overview + + + + + + + +
Namefeature_groups
TypeResource
DescriptionResource Type definition for AWS::SageMaker::FeatureGroup
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Name of the FeatureGroup.
stringThe Record Identifier Feature Name.
stringThe Event Time Feature Name.
arrayAn Array of Feature Definition
object
object
object
stringRole Arn
stringDescription about the FeatureGroup.
stringA timestamp of FeatureGroup creation time.
stringThe status of the feature group.
arrayAn array of key-value pair to apply to this resource.
stringAWS region.
+ +For more information, see AWS::SageMaker::FeatureGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all feature_groups in a region. +```sql +SELECT +region, +feature_group_name, +record_identifier_feature_name, +event_time_feature_name, +feature_definitions, +online_store_config, +offline_store_config, +throughput_config, +role_arn, +description, +creation_time, +feature_group_status, +tags +FROM aws.sagemaker.feature_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual feature_group. +```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_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new feature_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.feature_groups ( + FeatureGroupName, + RecordIdentifierFeatureName, + EventTimeFeatureName, + FeatureDefinitions, + region +) +SELECT +'{{ FeatureGroupName }}', + '{{ RecordIdentifierFeatureName }}', + '{{ EventTimeFeatureName }}', + '{{ FeatureDefinitions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.feature_groups ( + FeatureGroupName, + RecordIdentifierFeatureName, + EventTimeFeatureName, + FeatureDefinitions, + OnlineStoreConfig, + OfflineStoreConfig, + ThroughputConfig, + RoleArn, + Description, + Tags, + region +) +SELECT + '{{ FeatureGroupName }}', + '{{ RecordIdentifierFeatureName }}', + '{{ EventTimeFeatureName }}', + '{{ FeatureDefinitions }}', + '{{ OnlineStoreConfig }}', + '{{ OfflineStoreConfig }}', + '{{ ThroughputConfig }}', + '{{ RoleArn }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: feature_group + props: + - name: FeatureGroupName + value: '{{ FeatureGroupName }}' + - name: RecordIdentifierFeatureName + value: '{{ RecordIdentifierFeatureName }}' + - name: EventTimeFeatureName + value: '{{ EventTimeFeatureName }}' + - name: FeatureDefinitions + value: + - FeatureName: '{{ FeatureName }}' + FeatureType: '{{ FeatureType }}' + - name: OnlineStoreConfig + value: + SecurityConfig: + KmsKeyId: '{{ KmsKeyId }}' + EnableOnlineStore: '{{ EnableOnlineStore }}' + StorageType: '{{ StorageType }}' + TtlDuration: + Unit: '{{ Unit }}' + Value: '{{ Value }}' + - name: OfflineStoreConfig + value: + S3StorageConfig: + S3Uri: '{{ S3Uri }}' + KmsKeyId: null + DisableGlueTableCreation: '{{ DisableGlueTableCreation }}' + DataCatalogConfig: + TableName: '{{ TableName }}' + Catalog: '{{ Catalog }}' + Database: '{{ Database }}' + TableFormat: '{{ TableFormat }}' + - name: ThroughputConfig + value: + ThroughputMode: '{{ ThroughputMode }}' + ProvisionedReadCapacityUnits: '{{ ProvisionedReadCapacityUnits }}' + ProvisionedWriteCapacityUnits: '{{ ProvisionedWriteCapacityUnits }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.feature_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +sagemaker:UpdateFeatureGroup, +sagemaker:DescribeFeatureGroup, +sagemaker:AddTags, +sagemaker:ListTags, +sagemaker:DeleteTags +``` + +### Read +```json +sagemaker:DescribeFeatureGroup, +sagemaker:ListTags +``` + +### Delete +```json +sagemaker:DeleteFeatureGroup, +sagemaker:DescribeFeatureGroup +``` + +### List +```json +sagemaker:ListFeatureGroups +``` diff --git a/website/docs/services/sagemaker/feature_groups_list_only/index.md b/website/docs/services/sagemaker/feature_groups_list_only/index.md new file mode 100644 index 0000000..5758951 --- /dev/null +++ b/website/docs/services/sagemaker/feature_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: feature_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - feature_groups_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists feature_groups in a region or regions, for all properties use feature_groups + +## Overview + + + + + + + +
Namefeature_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::FeatureGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Name of the FeatureGroup.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all feature_groups in a region. +```sql +SELECT +region, +feature_group_name +FROM aws.sagemaker.feature_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the feature_groups_list_only resource, see feature_groups + diff --git a/website/docs/services/sagemaker/image_tags/index.md b/website/docs/services/sagemaker/image_tags/index.md new file mode 100644 index 0000000..7854cca --- /dev/null +++ b/website/docs/services/sagemaker/image_tags/index.md @@ -0,0 +1,85 @@ +--- +title: image_tags +hide_title: false +hide_table_of_contents: false +keywords: + - image_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for images in a region + +## Overview + + + + + + + +
Nameimage_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Image
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the image this version belongs to.
stringThe Amazon Resource Name (ARN) of the parent image.
stringThe Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.
stringThe display name of the image.
stringA description of the image.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all images in a region. +```sql +SELECT +region, +image_name, +image_arn, +image_role_arn, +image_display_name, +image_description, +tag_key, +tag_value +FROM aws.sagemaker.image_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_tags resource, see images + diff --git a/website/docs/services/sagemaker/image_versions/index.md b/website/docs/services/sagemaker/image_versions/index.md new file mode 100644 index 0000000..d28811c --- /dev/null +++ b/website/docs/services/sagemaker/image_versions/index.md @@ -0,0 +1,283 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an image_version resource or lists image_versions in a region + +## Overview + + + + + + + +
Nameimage_versions
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ImageVersion
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the image this version belongs to.
stringThe Amazon Resource Name (ARN) of the parent image.
stringThe Amazon Resource Name (ARN) of the image version.
stringThe registry path of the container image on which this image version is based.
stringThe image to use for the container that will be materialized for the inference component
integerThe version number of the image version.
stringThe alias of the image version.
arrayList of aliases for the image version.
stringThe availability of the image version specified by the maintainer.
stringIndicates SageMaker job type compatibility.
stringThe machine learning framework vended in the image version.
stringThe supported programming language and its version.
stringIndicates CPU or GPU compatibility.
booleanIndicates Horovod compatibility.
stringThe maintainer description of the image version.
stringAWS region.
+ +For more information, see AWS::SageMaker::ImageVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all image_versions in a region. +```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_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual image_version. +```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_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new image_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.image_versions ( + ImageName, + BaseImage, + region +) +SELECT +'{{ ImageName }}', + '{{ BaseImage }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.image_versions ( + ImageName, + BaseImage, + Alias, + Aliases, + VendorGuidance, + JobType, + MLFramework, + ProgrammingLang, + Processor, + Horovod, + ReleaseNotes, + region +) +SELECT + '{{ ImageName }}', + '{{ BaseImage }}', + '{{ Alias }}', + '{{ Aliases }}', + '{{ VendorGuidance }}', + '{{ JobType }}', + '{{ MLFramework }}', + '{{ ProgrammingLang }}', + '{{ Processor }}', + '{{ Horovod }}', + '{{ ReleaseNotes }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: image_version + props: + - name: ImageName + value: '{{ ImageName }}' + - name: BaseImage + value: '{{ BaseImage }}' + - name: Alias + value: '{{ Alias }}' + - name: Aliases + value: + - null + - name: VendorGuidance + value: '{{ VendorGuidance }}' + - name: JobType + value: '{{ JobType }}' + - name: MLFramework + value: '{{ MLFramework }}' + - name: ProgrammingLang + value: '{{ ProgrammingLang }}' + - name: Processor + value: '{{ Processor }}' + - name: Horovod + value: '{{ Horovod }}' + - name: ReleaseNotes + value: '{{ ReleaseNotes }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.image_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the image_versions resource, the following permissions are required: + +### Create +```json +sagemaker:CreateImageVersion, +sagemaker:DescribeImageVersion +``` + +### Read +```json +sagemaker:DescribeImageVersion +``` + +### Update +```json +sagemaker:UpdateImageVersion, +sagemaker:DescribeImageVersion, +sagemaker:ListAliases +``` + +### Delete +```json +sagemaker:DeleteImageVersion, +sagemaker:DescribeImageVersion +``` + +### List +```json +sagemaker:ListImageVersions +``` diff --git a/website/docs/services/sagemaker/image_versions_list_only/index.md b/website/docs/services/sagemaker/image_versions_list_only/index.md new file mode 100644 index 0000000..95bb58c --- /dev/null +++ b/website/docs/services/sagemaker/image_versions_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: image_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - image_versions_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists image_versions in a region or regions, for all properties use image_versions + +## Overview + + + + + + + +
Nameimage_versions_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ImageVersion
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image version.
integerThe version number of the image version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all image_versions in a region. +```sql +SELECT +region, +image_version_arn +FROM aws.sagemaker.image_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_versions_list_only resource, see image_versions + diff --git a/website/docs/services/sagemaker/images/index.md b/website/docs/services/sagemaker/images/index.md new file mode 100644 index 0000000..9bfed29 --- /dev/null +++ b/website/docs/services/sagemaker/images/index.md @@ -0,0 +1,240 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an image resource or lists images in a region + +## Overview + + + + + + + +
Nameimages
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Image
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the image this version belongs to.
stringThe Amazon Resource Name (ARN) of the parent image.
stringThe Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.
stringThe display name of the image.
stringA description of the image.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::SageMaker::Image. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all images in a region. +```sql +SELECT +region, +image_name, +image_arn, +image_role_arn, +image_display_name, +image_description, +tags +FROM aws.sagemaker.images +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual image. +```sql +SELECT +region, +image_name, +image_arn, +image_role_arn, +image_display_name, +image_description, +tags +FROM aws.sagemaker.images +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new image resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.images ( + ImageName, + ImageRoleArn, + region +) +SELECT +'{{ ImageName }}', + '{{ ImageRoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.images ( + ImageName, + ImageRoleArn, + ImageDisplayName, + ImageDescription, + Tags, + region +) +SELECT + '{{ ImageName }}', + '{{ ImageRoleArn }}', + '{{ ImageDisplayName }}', + '{{ ImageDescription }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: image + props: + - name: ImageName + value: '{{ ImageName }}' + - name: ImageRoleArn + value: '{{ ImageRoleArn }}' + - name: ImageDisplayName + value: '{{ ImageDisplayName }}' + - name: ImageDescription + value: '{{ ImageDescription }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.images +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +sagemaker:ListImages +``` diff --git a/website/docs/services/sagemaker/images_list_only/index.md b/website/docs/services/sagemaker/images_list_only/index.md new file mode 100644 index 0000000..98ec9ab --- /dev/null +++ b/website/docs/services/sagemaker/images_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: images_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - images_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists images in a region or regions, for all properties use images + +## Overview + + + + + + + +
Nameimages_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Image
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the parent image.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all images in a region. +```sql +SELECT +region, +image_arn +FROM aws.sagemaker.images_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the images_list_only resource, see images + diff --git a/website/docs/services/sagemaker/index.md b/website/docs/services/sagemaker/index.md new file mode 100644 index 0000000..1884237 --- /dev/null +++ b/website/docs/services/sagemaker/index.md @@ -0,0 +1,105 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The sagemaker service documentation. + +:::info Service Summary + +
+
+total resources: 70
+
+
+ +::: + +## Resources +
+ + +
\ No newline at end of file diff --git a/website/docs/services/sagemaker/inference_component_tags/index.md b/website/docs/services/sagemaker/inference_component_tags/index.md new file mode 100644 index 0000000..ee46d41 --- /dev/null +++ b/website/docs/services/sagemaker/inference_component_tags/index.md @@ -0,0 +1,97 @@ +--- +title: inference_component_tags +hide_title: false +hide_table_of_contents: false +keywords: + - inference_component_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for inference_components in a region + +## Overview + + + + + + + +
Nameinference_component_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceComponent
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the inference component
stringThe name of the inference component
stringThe Amazon Resource Name (ARN) of the endpoint the inference component is associated with
stringThe name of the endpoint used to run the monitoring job.
stringThe name of the endpoint variant the inference component is associated with
stringThe failure reason if the inference component is in a failed state
objectThe specification for the inference component
objectThe runtime config for the inference component
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all inference_components in a region. +```sql +SELECT +region, +inference_component_arn, +inference_component_name, +endpoint_arn, +endpoint_name, +variant_name, +failure_reason, +specification, +runtime_config, +inference_component_status, +creation_time, +last_modified_time, +tag_key, +tag_value +FROM aws.sagemaker.inference_component_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_component_tags resource, see inference_components + diff --git a/website/docs/services/sagemaker/inference_components/index.md b/website/docs/services/sagemaker/inference_components/index.md new file mode 100644 index 0000000..fa7fa11 --- /dev/null +++ b/website/docs/services/sagemaker/inference_components/index.md @@ -0,0 +1,289 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an inference_component resource or lists inference_components in a region + +## Overview + + + + + + + +
Nameinference_components
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceComponent
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the inference component
stringThe name of the inference component
stringThe Amazon Resource Name (ARN) of the endpoint the inference component is associated with
stringThe name of the endpoint used to run the monitoring job.
stringThe name of the endpoint variant the inference component is associated with
stringThe failure reason if the inference component is in a failed state
objectThe specification for the inference component
objectThe runtime config for the inference component
string
string
string
arrayAn array of tags to apply to the resource
stringAWS region.
+ +For more information, see AWS::SageMaker::InferenceComponent. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all inference_components in a region. +```sql +SELECT +region, +inference_component_arn, +inference_component_name, +endpoint_arn, +endpoint_name, +variant_name, +failure_reason, +specification, +runtime_config, +inference_component_status, +creation_time, +last_modified_time, +tags +FROM aws.sagemaker.inference_components +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual inference_component. +```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_components +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new inference_component resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.inference_components ( + EndpointName, + Specification, + region +) +SELECT +'{{ EndpointName }}', + '{{ Specification }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.inference_components ( + InferenceComponentName, + EndpointArn, + EndpointName, + VariantName, + Specification, + RuntimeConfig, + Tags, + region +) +SELECT + '{{ InferenceComponentName }}', + '{{ EndpointArn }}', + '{{ EndpointName }}', + '{{ VariantName }}', + '{{ Specification }}', + '{{ RuntimeConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: inference_component + props: + - name: InferenceComponentName + value: '{{ InferenceComponentName }}' + - name: EndpointArn + value: '{{ EndpointArn }}' + - name: EndpointName + value: '{{ EndpointName }}' + - name: VariantName + value: '{{ VariantName }}' + - name: Specification + value: + ModelName: '{{ ModelName }}' + BaseInferenceComponentName: '{{ BaseInferenceComponentName }}' + Container: + DeployedImage: + SpecifiedImage: '{{ SpecifiedImage }}' + ResolvedImage: null + ResolutionTime: '{{ ResolutionTime }}' + Image: null + ArtifactUrl: '{{ ArtifactUrl }}' + Environment: {} + StartupParameters: + ModelDataDownloadTimeoutInSeconds: '{{ ModelDataDownloadTimeoutInSeconds }}' + ContainerStartupHealthCheckTimeoutInSeconds: null + ComputeResourceRequirements: + NumberOfCpuCoresRequired: null + NumberOfAcceleratorDevicesRequired: null + MinMemoryRequiredInMb: '{{ MinMemoryRequiredInMb }}' + MaxMemoryRequiredInMb: null + - name: RuntimeConfig + value: + CopyCount: '{{ CopyCount }}' + DesiredCopyCount: null + CurrentCopyCount: null + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.inference_components +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +sagemaker:ListInferenceComponents, +sagemaker:DescribeInferenceComponent, +sagemaker:ListTags +``` diff --git a/website/docs/services/sagemaker/inference_components_list_only/index.md b/website/docs/services/sagemaker/inference_components_list_only/index.md new file mode 100644 index 0000000..d48a386 --- /dev/null +++ b/website/docs/services/sagemaker/inference_components_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: inference_components_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - inference_components_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists inference_components in a region or regions, for all properties use inference_components + +## Overview + + + + + + + +
Nameinference_components_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceComponent
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the inference component
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all inference_components in a region. +```sql +SELECT +region, +inference_component_arn +FROM aws.sagemaker.inference_components_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_components_list_only resource, see inference_components + diff --git a/website/docs/services/sagemaker/inference_experiment_tags/index.md b/website/docs/services/sagemaker/inference_experiment_tags/index.md new file mode 100644 index 0000000..443f82a --- /dev/null +++ b/website/docs/services/sagemaker/inference_experiment_tags/index.md @@ -0,0 +1,109 @@ +--- +title: inference_experiment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - inference_experiment_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for inference_experiments in a region + +## Overview + + + + + + + +
Nameinference_experiment_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceExperiment
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the inference experiment.
stringThe name for the inference experiment.
stringThe type of the inference experiment that you want to run.
stringThe description of the inference experiment.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
stringThe name of the endpoint used to run the monitoring job.
objectThe metadata of the endpoint on which the inference experiment ran.
objectThe duration for which you want the inference experiment to run.
stringThe AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
objectThe Amazon S3 location and configuration for storing inference request and response data.
arrayAn array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
objectThe configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.
stringThe timestamp at which you created the inference experiment.
stringThe timestamp at which you last modified the inference experiment.
stringThe status of the inference experiment.
stringThe error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
stringThe desired state of the experiment after starting or stopping operation.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all inference_experiments in a region. +```sql +SELECT +region, +arn, +name, +type, +description, +role_arn, +endpoint_name, +endpoint_metadata, +schedule, +kms_key, +data_storage_config, +model_variants, +shadow_mode_config, +creation_time, +last_modified_time, +status, +status_reason, +desired_state, +tag_key, +tag_value +FROM aws.sagemaker.inference_experiment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_experiment_tags resource, see inference_experiments + diff --git a/website/docs/services/sagemaker/inference_experiments/index.md b/website/docs/services/sagemaker/inference_experiments/index.md new file mode 100644 index 0000000..794c631 --- /dev/null +++ b/website/docs/services/sagemaker/inference_experiments/index.md @@ -0,0 +1,337 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an inference_experiment resource or lists inference_experiments in a region + +## Overview + + + + + + + +
Nameinference_experiments
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceExperiment
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the inference experiment.
stringThe name for the inference experiment.
stringThe type of the inference experiment that you want to run.
stringThe description of the inference experiment.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
stringThe name of the endpoint used to run the monitoring job.
objectThe metadata of the endpoint on which the inference experiment ran.
objectThe duration for which you want the inference experiment to run.
stringThe AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
objectThe Amazon S3 location and configuration for storing inference request and response data.
arrayAn array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
objectThe configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.
arrayAn array of key-value pairs to apply to this resource.
stringThe timestamp at which you created the inference experiment.
stringThe timestamp at which you last modified the inference experiment.
stringThe status of the inference experiment.
stringThe error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
stringThe desired state of the experiment after starting or stopping operation.
stringAWS region.
+ +For more information, see AWS::SageMaker::InferenceExperiment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all inference_experiments in a region. +```sql +SELECT +region, +arn, +name, +type, +description, +role_arn, +endpoint_name, +endpoint_metadata, +schedule, +kms_key, +data_storage_config, +model_variants, +shadow_mode_config, +tags, +creation_time, +last_modified_time, +status, +status_reason, +desired_state +FROM aws.sagemaker.inference_experiments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual inference_experiment. +```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_experiments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new inference_experiment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.inference_experiments ( + Name, + Type, + RoleArn, + EndpointName, + ModelVariants, + region +) +SELECT +'{{ Name }}', + '{{ Type }}', + '{{ RoleArn }}', + '{{ EndpointName }}', + '{{ ModelVariants }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.inference_experiments ( + Name, + Type, + Description, + RoleArn, + EndpointName, + Schedule, + KmsKey, + DataStorageConfig, + ModelVariants, + ShadowModeConfig, + Tags, + StatusReason, + DesiredState, + region +) +SELECT + '{{ Name }}', + '{{ Type }}', + '{{ Description }}', + '{{ RoleArn }}', + '{{ EndpointName }}', + '{{ Schedule }}', + '{{ KmsKey }}', + '{{ DataStorageConfig }}', + '{{ ModelVariants }}', + '{{ ShadowModeConfig }}', + '{{ Tags }}', + '{{ StatusReason }}', + '{{ DesiredState }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: inference_experiment + props: + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: Description + value: '{{ Description }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: EndpointName + value: '{{ EndpointName }}' + - name: Schedule + value: + StartTime: '{{ StartTime }}' + EndTime: '{{ EndTime }}' + - name: KmsKey + value: '{{ KmsKey }}' + - name: DataStorageConfig + value: + Destination: '{{ Destination }}' + KmsKey: '{{ KmsKey }}' + ContentType: + CsvContentTypes: + - '{{ CsvContentTypes[0] }}' + JsonContentTypes: + - '{{ JsonContentTypes[0] }}' + - name: ModelVariants + value: + - ModelName: '{{ ModelName }}' + VariantName: '{{ VariantName }}' + InfrastructureConfig: + InfrastructureType: '{{ InfrastructureType }}' + RealTimeInferenceConfig: + InstanceType: '{{ InstanceType }}' + InstanceCount: '{{ InstanceCount }}' + - name: ShadowModeConfig + value: + SourceModelVariantName: '{{ SourceModelVariantName }}' + ShadowModelVariants: + - ShadowModelVariantName: '{{ ShadowModelVariantName }}' + SamplingPercentage: '{{ SamplingPercentage }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: StatusReason + value: '{{ StatusReason }}' + - name: DesiredState + value: '{{ DesiredState }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.inference_experiments +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +sagemaker:DeleteInferenceExperiment, +sagemaker:DescribeInferenceExperiment, +sagemaker:StopInferenceExperiment, +sagemaker:ListTags +``` + +### List +```json +sagemaker:ListInferenceExperiments +``` + +### 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/website/docs/services/sagemaker/inference_experiments_list_only/index.md b/website/docs/services/sagemaker/inference_experiments_list_only/index.md new file mode 100644 index 0000000..40dbd86 --- /dev/null +++ b/website/docs/services/sagemaker/inference_experiments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: inference_experiments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - inference_experiments_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists inference_experiments in a region or regions, for all properties use inference_experiments + +## Overview + + + + + + + +
Nameinference_experiments_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceExperiment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name for the inference experiment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all inference_experiments in a region. +```sql +SELECT +region, +name +FROM aws.sagemaker.inference_experiments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_experiments_list_only resource, see inference_experiments + diff --git a/website/docs/services/sagemaker/mlflow_tracking_server_tags/index.md b/website/docs/services/sagemaker/mlflow_tracking_server_tags/index.md new file mode 100644 index 0000000..50ff414 --- /dev/null +++ b/website/docs/services/sagemaker/mlflow_tracking_server_tags/index.md @@ -0,0 +1,91 @@ +--- +title: mlflow_tracking_server_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mlflow_tracking_server_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mlflow_tracking_servers in a region + +## Overview + + + + + + + +
Namemlflow_tracking_server_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::MlflowTrackingServer
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the MLFlow Tracking Server.
stringThe Amazon Resource Name (ARN) of the MLFlow Tracking Server.
stringThe size of the MLFlow Tracking Server.
stringThe MLFlow Version used on the MLFlow Tracking Server.
stringThe Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.
stringThe Amazon S3 URI for MLFlow Tracking Server artifacts.
booleanA flag to enable Automatic SageMaker Model Registration.
stringThe start of the time window for maintenance of the MLFlow Tracking Server in UTC time.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mlflow_tracking_servers in a region. +```sql +SELECT +region, +tracking_server_name, +tracking_server_arn, +tracking_server_size, +mlflow_version, +role_arn, +artifact_store_uri, +automatic_model_registration, +weekly_maintenance_window_start, +tag_key, +tag_value +FROM aws.sagemaker.mlflow_tracking_server_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mlflow_tracking_server_tags resource, see mlflow_tracking_servers + diff --git a/website/docs/services/sagemaker/mlflow_tracking_servers/index.md b/website/docs/services/sagemaker/mlflow_tracking_servers/index.md new file mode 100644 index 0000000..6643c5c --- /dev/null +++ b/website/docs/services/sagemaker/mlflow_tracking_servers/index.md @@ -0,0 +1,263 @@ +--- +title: mlflow_tracking_servers +hide_title: false +hide_table_of_contents: false +keywords: + - mlflow_tracking_servers + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mlflow_tracking_server resource or lists mlflow_tracking_servers in a region + +## Overview + + + + + + + +
Namemlflow_tracking_servers
TypeResource
DescriptionResource Type definition for AWS::SageMaker::MlflowTrackingServer
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the MLFlow Tracking Server.
stringThe Amazon Resource Name (ARN) of the MLFlow Tracking Server.
stringThe size of the MLFlow Tracking Server.
stringThe MLFlow Version used on the MLFlow Tracking Server.
stringThe Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.
stringThe Amazon S3 URI for MLFlow Tracking Server artifacts.
booleanA flag to enable Automatic SageMaker Model Registration.
stringThe start of the time window for maintenance of the MLFlow Tracking Server in UTC time.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::SageMaker::MlflowTrackingServer. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mlflow_tracking_servers in a region. +```sql +SELECT +region, +tracking_server_name, +tracking_server_arn, +tracking_server_size, +mlflow_version, +role_arn, +artifact_store_uri, +automatic_model_registration, +weekly_maintenance_window_start, +tags +FROM aws.sagemaker.mlflow_tracking_servers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mlflow_tracking_server. +```sql +SELECT +region, +tracking_server_name, +tracking_server_arn, +tracking_server_size, +mlflow_version, +role_arn, +artifact_store_uri, +automatic_model_registration, +weekly_maintenance_window_start, +tags +FROM aws.sagemaker.mlflow_tracking_servers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mlflow_tracking_server resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.mlflow_tracking_servers ( + TrackingServerName, + RoleArn, + ArtifactStoreUri, + region +) +SELECT +'{{ TrackingServerName }}', + '{{ RoleArn }}', + '{{ ArtifactStoreUri }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.mlflow_tracking_servers ( + TrackingServerName, + TrackingServerSize, + MlflowVersion, + RoleArn, + ArtifactStoreUri, + AutomaticModelRegistration, + WeeklyMaintenanceWindowStart, + Tags, + region +) +SELECT + '{{ TrackingServerName }}', + '{{ TrackingServerSize }}', + '{{ MlflowVersion }}', + '{{ RoleArn }}', + '{{ ArtifactStoreUri }}', + '{{ AutomaticModelRegistration }}', + '{{ WeeklyMaintenanceWindowStart }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mlflow_tracking_server + props: + - name: TrackingServerName + value: '{{ TrackingServerName }}' + - name: TrackingServerSize + value: '{{ TrackingServerSize }}' + - name: MlflowVersion + value: '{{ MlflowVersion }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: ArtifactStoreUri + value: '{{ ArtifactStoreUri }}' + - name: AutomaticModelRegistration + value: '{{ AutomaticModelRegistration }}' + - name: WeeklyMaintenanceWindowStart + value: '{{ WeeklyMaintenanceWindowStart }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.mlflow_tracking_servers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the mlflow_tracking_servers resource, the following permissions are required: + +### Create +```json +sagemaker:CreateMlflowTrackingServer, +sagemaker:DescribeMlflowTrackingServer, +sagemaker:AddTags, +sagemaker:ListTags, +iam:PassRole +``` + +### Read +```json +sagemaker:DescribeMlflowTrackingServer, +sagemaker:ListTags +``` + +### Update +```json +sagemaker:UpdateMlflowTrackingServer, +sagemaker:DescribeMlflowTrackingServer, +sagemaker:ListTags, +sagemaker:AddTags, +sagemaker:DeleteTags, +iam:PassRole +``` + +### Delete +```json +sagemaker:DeleteMlflowTrackingServer, +sagemaker:DescribeMlflowTrackingServer +``` + +### List +```json +sagemaker:ListMlflowTrackingServers +``` diff --git a/website/docs/services/sagemaker/mlflow_tracking_servers_list_only/index.md b/website/docs/services/sagemaker/mlflow_tracking_servers_list_only/index.md new file mode 100644 index 0000000..6c75356 --- /dev/null +++ b/website/docs/services/sagemaker/mlflow_tracking_servers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: mlflow_tracking_servers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mlflow_tracking_servers_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mlflow_tracking_servers in a region or regions, for all properties use mlflow_tracking_servers + +## Overview + + + + + + + +
Namemlflow_tracking_servers_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::MlflowTrackingServer
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the MLFlow Tracking Server.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mlflow_tracking_servers in a region. +```sql +SELECT +region, +tracking_server_name +FROM aws.sagemaker.mlflow_tracking_servers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mlflow_tracking_servers_list_only resource, see mlflow_tracking_servers + diff --git a/website/docs/services/sagemaker/model_bias_job_definition_tags/index.md b/website/docs/services/sagemaker/model_bias_job_definition_tags/index.md new file mode 100644 index 0000000..b51f176 --- /dev/null +++ b/website/docs/services/sagemaker/model_bias_job_definition_tags/index.md @@ -0,0 +1,99 @@ +--- +title: model_bias_job_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_bias_job_definition_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_bias_job_definitions in a region + +## Overview + + + + + + + +
Namemodel_bias_job_definition_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelBiasJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
stringThe time at which the job definition was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_bias_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +model_bias_baseline_config, +model_bias_app_specification, +model_bias_job_input, +model_bias_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +creation_time, +tag_key, +tag_value +FROM aws.sagemaker.model_bias_job_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_bias_job_definition_tags resource, see model_bias_job_definitions + diff --git a/website/docs/services/sagemaker/model_bias_job_definitions/index.md b/website/docs/services/sagemaker/model_bias_job_definitions/index.md new file mode 100644 index 0000000..4640c0f --- /dev/null +++ b/website/docs/services/sagemaker/model_bias_job_definitions/index.md @@ -0,0 +1,319 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a model_bias_job_definition resource or lists model_bias_job_definitions in a region + +## Overview + + + + + + + +
Namemodel_bias_job_definitions
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelBiasJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
+ +For more information, see AWS::SageMaker::ModelBiasJobDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all model_bias_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +model_bias_baseline_config, +model_bias_app_specification, +model_bias_job_input, +model_bias_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +tags, +creation_time +FROM aws.sagemaker.model_bias_job_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual model_bias_job_definition. +```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_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model_bias_job_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.model_bias_job_definitions ( + ModelBiasAppSpecification, + ModelBiasJobInput, + ModelBiasJobOutputConfig, + JobResources, + RoleArn, + region +) +SELECT +'{{ ModelBiasAppSpecification }}', + '{{ ModelBiasJobInput }}', + '{{ ModelBiasJobOutputConfig }}', + '{{ JobResources }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.model_bias_job_definitions ( + JobDefinitionName, + ModelBiasBaselineConfig, + ModelBiasAppSpecification, + ModelBiasJobInput, + ModelBiasJobOutputConfig, + JobResources, + NetworkConfig, + EndpointName, + RoleArn, + StoppingCondition, + Tags, + region +) +SELECT + '{{ JobDefinitionName }}', + '{{ ModelBiasBaselineConfig }}', + '{{ ModelBiasAppSpecification }}', + '{{ ModelBiasJobInput }}', + '{{ ModelBiasJobOutputConfig }}', + '{{ JobResources }}', + '{{ NetworkConfig }}', + '{{ EndpointName }}', + '{{ RoleArn }}', + '{{ StoppingCondition }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: model_bias_job_definition + props: + - name: JobDefinitionName + value: '{{ JobDefinitionName }}' + - name: ModelBiasBaselineConfig + value: + BaseliningJobName: '{{ BaseliningJobName }}' + ConstraintsResource: + S3Uri: '{{ S3Uri }}' + - name: ModelBiasAppSpecification + value: + ImageUri: '{{ ImageUri }}' + ConfigUri: null + Environment: {} + - name: ModelBiasJobInput + value: + EndpointInput: + EndpointName: '{{ EndpointName }}' + LocalPath: '{{ LocalPath }}' + S3DataDistributionType: '{{ S3DataDistributionType }}' + S3InputMode: '{{ S3InputMode }}' + ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}' + BatchTransformInput: + DataCapturedDestinationS3Uri: '{{ DataCapturedDestinationS3Uri }}' + DatasetFormat: + Csv: + Header: '{{ Header }}' + Json: + Line: '{{ Line }}' + Parquet: '{{ Parquet }}' + LocalPath: '{{ LocalPath }}' + S3DataDistributionType: '{{ S3DataDistributionType }}' + S3InputMode: '{{ S3InputMode }}' + ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}' + GroundTruthS3Input: + S3Uri: '{{ S3Uri }}' + - name: ModelBiasJobOutputConfig + value: + KmsKeyId: '{{ KmsKeyId }}' + MonitoringOutputs: + - S3Output: + LocalPath: '{{ LocalPath }}' + S3UploadMode: '{{ S3UploadMode }}' + S3Uri: '{{ S3Uri }}' + - name: JobResources + value: + ClusterConfig: + InstanceCount: '{{ InstanceCount }}' + InstanceType: '{{ InstanceType }}' + VolumeKmsKeyId: '{{ VolumeKmsKeyId }}' + VolumeSizeInGB: '{{ VolumeSizeInGB }}' + - name: NetworkConfig + value: + EnableInterContainerTrafficEncryption: '{{ EnableInterContainerTrafficEncryption }}' + EnableNetworkIsolation: '{{ EnableNetworkIsolation }}' + VpcConfig: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + Subnets: + - '{{ Subnets[0] }}' + - name: EndpointName + value: null + - name: RoleArn + value: '{{ RoleArn }}' + - name: StoppingCondition + value: + MaxRuntimeInSeconds: '{{ MaxRuntimeInSeconds }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.model_bias_job_definitions +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +sagemaker:DeleteModelBiasJobDefinition +``` + +### Read +```json +sagemaker:DescribeModelBiasJobDefinition +``` + +### List +```json +sagemaker:ListModelBiasJobDefinitions, +sagemaker:ListTags +``` diff --git a/website/docs/services/sagemaker/model_bias_job_definitions_list_only/index.md b/website/docs/services/sagemaker/model_bias_job_definitions_list_only/index.md new file mode 100644 index 0000000..bdf179e --- /dev/null +++ b/website/docs/services/sagemaker/model_bias_job_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: model_bias_job_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_bias_job_definitions_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_bias_job_definitions in a region or regions, for all properties use model_bias_job_definitions + +## Overview + + + + + + + +
Namemodel_bias_job_definitions_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelBiasJobDefinition
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_bias_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.model_bias_job_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_bias_job_definitions_list_only resource, see model_bias_job_definitions + diff --git a/website/docs/services/sagemaker/model_explainability_job_definition_tags/index.md b/website/docs/services/sagemaker/model_explainability_job_definition_tags/index.md new file mode 100644 index 0000000..cd6060a --- /dev/null +++ b/website/docs/services/sagemaker/model_explainability_job_definition_tags/index.md @@ -0,0 +1,99 @@ +--- +title: model_explainability_job_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_explainability_job_definition_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_explainability_job_definitions in a region + +## Overview + + + + + + + +
Namemodel_explainability_job_definition_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
stringThe time at which the job definition was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_explainability_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +model_explainability_baseline_config, +model_explainability_app_specification, +model_explainability_job_input, +model_explainability_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +creation_time, +tag_key, +tag_value +FROM aws.sagemaker.model_explainability_job_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_explainability_job_definition_tags resource, see model_explainability_job_definitions + diff --git a/website/docs/services/sagemaker/model_explainability_job_definitions/index.md b/website/docs/services/sagemaker/model_explainability_job_definitions/index.md new file mode 100644 index 0000000..13b1253 --- /dev/null +++ b/website/docs/services/sagemaker/model_explainability_job_definitions/index.md @@ -0,0 +1,317 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a model_explainability_job_definition resource or lists model_explainability_job_definitions in a region + +## Overview + + + + + + + +
Namemodel_explainability_job_definitions
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
+ +For more information, see AWS::SageMaker::ModelExplainabilityJobDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all model_explainability_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +model_explainability_baseline_config, +model_explainability_app_specification, +model_explainability_job_input, +model_explainability_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +tags, +creation_time +FROM aws.sagemaker.model_explainability_job_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual model_explainability_job_definition. +```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_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model_explainability_job_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.model_explainability_job_definitions ( + ModelExplainabilityAppSpecification, + ModelExplainabilityJobInput, + ModelExplainabilityJobOutputConfig, + JobResources, + RoleArn, + region +) +SELECT +'{{ ModelExplainabilityAppSpecification }}', + '{{ ModelExplainabilityJobInput }}', + '{{ ModelExplainabilityJobOutputConfig }}', + '{{ JobResources }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.model_explainability_job_definitions ( + JobDefinitionName, + ModelExplainabilityBaselineConfig, + ModelExplainabilityAppSpecification, + ModelExplainabilityJobInput, + ModelExplainabilityJobOutputConfig, + JobResources, + NetworkConfig, + EndpointName, + RoleArn, + StoppingCondition, + Tags, + region +) +SELECT + '{{ JobDefinitionName }}', + '{{ ModelExplainabilityBaselineConfig }}', + '{{ ModelExplainabilityAppSpecification }}', + '{{ ModelExplainabilityJobInput }}', + '{{ ModelExplainabilityJobOutputConfig }}', + '{{ JobResources }}', + '{{ NetworkConfig }}', + '{{ EndpointName }}', + '{{ RoleArn }}', + '{{ StoppingCondition }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: model_explainability_job_definition + props: + - name: JobDefinitionName + value: '{{ JobDefinitionName }}' + - name: ModelExplainabilityBaselineConfig + value: + BaseliningJobName: '{{ BaseliningJobName }}' + ConstraintsResource: + S3Uri: '{{ S3Uri }}' + - name: ModelExplainabilityAppSpecification + value: + ImageUri: '{{ ImageUri }}' + ConfigUri: null + Environment: {} + - name: ModelExplainabilityJobInput + value: + EndpointInput: + EndpointName: '{{ EndpointName }}' + LocalPath: '{{ LocalPath }}' + S3DataDistributionType: '{{ S3DataDistributionType }}' + S3InputMode: '{{ S3InputMode }}' + ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}' + BatchTransformInput: + DataCapturedDestinationS3Uri: '{{ DataCapturedDestinationS3Uri }}' + DatasetFormat: + Csv: + Header: '{{ Header }}' + Json: + Line: '{{ Line }}' + Parquet: '{{ Parquet }}' + LocalPath: '{{ LocalPath }}' + S3DataDistributionType: '{{ S3DataDistributionType }}' + S3InputMode: '{{ S3InputMode }}' + ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}' + - name: ModelExplainabilityJobOutputConfig + value: + KmsKeyId: '{{ KmsKeyId }}' + MonitoringOutputs: + - S3Output: + LocalPath: '{{ LocalPath }}' + S3UploadMode: '{{ S3UploadMode }}' + S3Uri: '{{ S3Uri }}' + - name: JobResources + value: + ClusterConfig: + InstanceCount: '{{ InstanceCount }}' + InstanceType: '{{ InstanceType }}' + VolumeKmsKeyId: '{{ VolumeKmsKeyId }}' + VolumeSizeInGB: '{{ VolumeSizeInGB }}' + - name: NetworkConfig + value: + EnableInterContainerTrafficEncryption: '{{ EnableInterContainerTrafficEncryption }}' + EnableNetworkIsolation: '{{ EnableNetworkIsolation }}' + VpcConfig: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + Subnets: + - '{{ Subnets[0] }}' + - name: EndpointName + value: null + - name: RoleArn + value: '{{ RoleArn }}' + - name: StoppingCondition + value: + MaxRuntimeInSeconds: '{{ MaxRuntimeInSeconds }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.model_explainability_job_definitions +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +sagemaker:DeleteModelExplainabilityJobDefinition +``` + +### Read +```json +sagemaker:DescribeModelExplainabilityJobDefinition +``` + +### List +```json +sagemaker:ListModelExplainabilityJobDefinitions, +sagemaker:ListTags +``` diff --git a/website/docs/services/sagemaker/model_explainability_job_definitions_list_only/index.md b/website/docs/services/sagemaker/model_explainability_job_definitions_list_only/index.md new file mode 100644 index 0000000..3bc2832 --- /dev/null +++ b/website/docs/services/sagemaker/model_explainability_job_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: model_explainability_job_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_explainability_job_definitions_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_explainability_job_definitions in a region or regions, for all properties use model_explainability_job_definitions + +## Overview + + + + + + + +
Namemodel_explainability_job_definitions_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_explainability_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.model_explainability_job_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_explainability_job_definitions_list_only resource, see model_explainability_job_definitions + diff --git a/website/docs/services/sagemaker/model_package_group_tags/index.md b/website/docs/services/sagemaker/model_package_group_tags/index.md new file mode 100644 index 0000000..1950bc8 --- /dev/null +++ b/website/docs/services/sagemaker/model_package_group_tags/index.md @@ -0,0 +1,87 @@ +--- +title: model_package_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_package_group_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_package_groups in a region + +## Overview + + + + + + + +
Namemodel_package_group_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelPackageGroup
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the model package group.
stringThe name of the model package group.
stringThe description of the model package group.
object
stringThe time at which the model package group was created.
stringThe status of a modelpackage group job.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_package_groups in a region. +```sql +SELECT +region, +model_package_group_arn, +model_package_group_name, +model_package_group_description, +model_package_group_policy, +creation_time, +model_package_group_status, +tag_key, +tag_value +FROM aws.sagemaker.model_package_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_package_group_tags resource, see model_package_groups + diff --git a/website/docs/services/sagemaker/model_package_groups/index.md b/website/docs/services/sagemaker/model_package_groups/index.md new file mode 100644 index 0000000..602aef0 --- /dev/null +++ b/website/docs/services/sagemaker/model_package_groups/index.md @@ -0,0 +1,243 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a model_package_group resource or lists model_package_groups in a region + +## Overview + + + + + + + +
Namemodel_package_groups
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelPackageGroup
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the model package group.
stringThe name of the model package group.
stringThe description of the model package group.
object
stringThe time at which the model package group was created.
stringThe status of a modelpackage group job.
stringAWS region.
+ +For more information, see AWS::SageMaker::ModelPackageGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all model_package_groups in a region. +```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_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual model_package_group. +```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_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model_package_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.model_package_groups ( + ModelPackageGroupName, + region +) +SELECT +'{{ ModelPackageGroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.model_package_groups ( + Tags, + ModelPackageGroupName, + ModelPackageGroupDescription, + ModelPackageGroupPolicy, + region +) +SELECT + '{{ Tags }}', + '{{ ModelPackageGroupName }}', + '{{ ModelPackageGroupDescription }}', + '{{ ModelPackageGroupPolicy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: model_package_group + props: + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: ModelPackageGroupName + value: '{{ ModelPackageGroupName }}' + - name: ModelPackageGroupDescription + value: '{{ ModelPackageGroupDescription }}' + - name: ModelPackageGroupPolicy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.model_package_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +sagemaker:DeleteModelPackageGroup, +sagemaker:DescribeModelPackageGroup, +sagemaker:GetModelPackageGroupPolicy, +sagemaker:DeleteModelPackageGroupPolicy +``` + +### List +```json +sagemaker:ListModelPackageGroups +``` + +### 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/website/docs/services/sagemaker/model_package_groups_list_only/index.md b/website/docs/services/sagemaker/model_package_groups_list_only/index.md new file mode 100644 index 0000000..b3b26a9 --- /dev/null +++ b/website/docs/services/sagemaker/model_package_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: model_package_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_package_groups_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_package_groups in a region or regions, for all properties use model_package_groups + +## Overview + + + + + + + +
Namemodel_package_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelPackageGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the model package group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_package_groups in a region. +```sql +SELECT +region, +model_package_group_arn +FROM aws.sagemaker.model_package_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_package_groups_list_only resource, see model_package_groups + diff --git a/website/docs/services/sagemaker/model_package_tags/index.md b/website/docs/services/sagemaker/model_package_tags/index.md new file mode 100644 index 0000000..688bbc8 --- /dev/null +++ b/website/docs/services/sagemaker/model_package_tags/index.md @@ -0,0 +1,133 @@ +--- +title: model_package_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_package_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_packages in a region + +## Overview + + + + + + + +
Namemodel_package_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelPackage
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of additional Inference Specification objects.
booleanWhether to certify the model package for listing on AWS Marketplace.
stringA unique token that guarantees that the call to this API is idempotent.
objectThe metadata properties associated with the model package versions.
stringThe machine learning domain of the model package you specified.
objectRepresents the drift check baselines that can be used when the model monitor is set using the model package.
objectDetails about inference jobs that can be run with models based on this model package.
objectMetadata properties of the tracking entity, trial, or trial component.
stringThe approval status of the model package.
objectA structure that contains model metrics reports.
stringThe description of the model package.
stringThe name of the model package group.
stringThe name or arn of the model package.
stringThe Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored pointing to single gzip compressed tar archive.
stringIndicates if you want to skip model validation.
objectDetails about the algorithm that was used to create the model package.
stringThe machine learning task your model package accomplishes.
objectSpecifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
stringThe Amazon Resource Name (ARN) of the model package group.
stringA description provided for the model approval.
stringThe time at which the model package was created.
stringThe time at which the model package was last modified.
stringThe current status of the model package.
integerThe version of the model package.
arrayAn array of additional Inference Specification objects.
objectDetails about the current status of the model package.
stringThe URI of the source for the model package.
objectThe model card associated with the model package.
objectAn optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_packages in a region. +```sql +SELECT +region, +additional_inference_specifications, +certify_for_marketplace, +client_token, +customer_metadata_properties, +domain, +drift_check_baselines, +inference_specification, +metadata_properties, +model_approval_status, +model_metrics, +model_package_description, +model_package_group_name, +model_package_name, +sample_payload_url, +skip_model_validation, +source_algorithm_specification, +task, +validation_specification, +model_package_arn, +approval_description, +creation_time, +last_modified_time, +model_package_status, +model_package_version, +additional_inference_specifications_to_add, +model_package_status_details, +source_uri, +model_card, +security_config, +tag_key, +tag_value +FROM aws.sagemaker.model_package_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_package_tags resource, see model_packages + diff --git a/website/docs/services/sagemaker/model_packages/index.md b/website/docs/services/sagemaker/model_packages/index.md new file mode 100644 index 0000000..e64dd80 --- /dev/null +++ b/website/docs/services/sagemaker/model_packages/index.md @@ -0,0 +1,583 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a model_package resource or lists model_packages in a region + +## Overview + + + + + + + +
Namemodel_packages
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelPackage
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of key-value pairs to apply to this resource.
arrayAn array of additional Inference Specification objects.
booleanWhether to certify the model package for listing on AWS Marketplace.
stringA unique token that guarantees that the call to this API is idempotent.
objectThe metadata properties associated with the model package versions.
stringThe machine learning domain of the model package you specified.
objectRepresents the drift check baselines that can be used when the model monitor is set using the model package.
objectDetails about inference jobs that can be run with models based on this model package.
objectMetadata properties of the tracking entity, trial, or trial component.
stringThe approval status of the model package.
objectA structure that contains model metrics reports.
stringThe description of the model package.
stringThe name of the model package group.
stringThe name or arn of the model package.
stringThe Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored pointing to single gzip compressed tar archive.
stringIndicates if you want to skip model validation.
objectDetails about the algorithm that was used to create the model package.
stringThe machine learning task your model package accomplishes.
objectSpecifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
stringThe Amazon Resource Name (ARN) of the model package group.
stringA description provided for the model approval.
stringThe time at which the model package was created.
stringThe time at which the model package was last modified.
stringThe current status of the model package.
integerThe version of the model package.
arrayAn array of additional Inference Specification objects.
objectDetails about the current status of the model package.
stringThe URI of the source for the model package.
objectThe model card associated with the model package.
objectAn optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
stringAWS region.
+ +For more information, see AWS::SageMaker::ModelPackage. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all model_packages in a region. +```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, +source_uri, +model_card, +security_config +FROM aws.sagemaker.model_packages +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual model_package. +```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, +source_uri, +model_card, +security_config +FROM aws.sagemaker.model_packages +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model_package resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.model_packages ( + Tags, + AdditionalInferenceSpecifications, + CertifyForMarketplace, + ClientToken, + CustomerMetadataProperties, + Domain, + DriftCheckBaselines, + InferenceSpecification, + MetadataProperties, + ModelApprovalStatus, + ModelMetrics, + ModelPackageDescription, + ModelPackageGroupName, + ModelPackageName, + SamplePayloadUrl, + SkipModelValidation, + SourceAlgorithmSpecification, + Task, + ValidationSpecification, + ApprovalDescription, + LastModifiedTime, + ModelPackageVersion, + AdditionalInferenceSpecificationsToAdd, + ModelPackageStatusDetails, + SourceUri, + ModelCard, + SecurityConfig, + region +) +SELECT +'{{ Tags }}', + '{{ AdditionalInferenceSpecifications }}', + '{{ CertifyForMarketplace }}', + '{{ ClientToken }}', + '{{ CustomerMetadataProperties }}', + '{{ Domain }}', + '{{ DriftCheckBaselines }}', + '{{ InferenceSpecification }}', + '{{ MetadataProperties }}', + '{{ ModelApprovalStatus }}', + '{{ ModelMetrics }}', + '{{ ModelPackageDescription }}', + '{{ ModelPackageGroupName }}', + '{{ ModelPackageName }}', + '{{ SamplePayloadUrl }}', + '{{ SkipModelValidation }}', + '{{ SourceAlgorithmSpecification }}', + '{{ Task }}', + '{{ ValidationSpecification }}', + '{{ ApprovalDescription }}', + '{{ LastModifiedTime }}', + '{{ ModelPackageVersion }}', + '{{ AdditionalInferenceSpecificationsToAdd }}', + '{{ ModelPackageStatusDetails }}', + '{{ SourceUri }}', + '{{ ModelCard }}', + '{{ SecurityConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.model_packages ( + Tags, + AdditionalInferenceSpecifications, + CertifyForMarketplace, + ClientToken, + CustomerMetadataProperties, + Domain, + DriftCheckBaselines, + InferenceSpecification, + MetadataProperties, + ModelApprovalStatus, + ModelMetrics, + ModelPackageDescription, + ModelPackageGroupName, + ModelPackageName, + SamplePayloadUrl, + SkipModelValidation, + SourceAlgorithmSpecification, + Task, + ValidationSpecification, + ApprovalDescription, + LastModifiedTime, + ModelPackageVersion, + AdditionalInferenceSpecificationsToAdd, + ModelPackageStatusDetails, + SourceUri, + ModelCard, + SecurityConfig, + region +) +SELECT + '{{ Tags }}', + '{{ AdditionalInferenceSpecifications }}', + '{{ CertifyForMarketplace }}', + '{{ ClientToken }}', + '{{ CustomerMetadataProperties }}', + '{{ Domain }}', + '{{ DriftCheckBaselines }}', + '{{ InferenceSpecification }}', + '{{ MetadataProperties }}', + '{{ ModelApprovalStatus }}', + '{{ ModelMetrics }}', + '{{ ModelPackageDescription }}', + '{{ ModelPackageGroupName }}', + '{{ ModelPackageName }}', + '{{ SamplePayloadUrl }}', + '{{ SkipModelValidation }}', + '{{ SourceAlgorithmSpecification }}', + '{{ Task }}', + '{{ ValidationSpecification }}', + '{{ ApprovalDescription }}', + '{{ LastModifiedTime }}', + '{{ ModelPackageVersion }}', + '{{ AdditionalInferenceSpecificationsToAdd }}', + '{{ ModelPackageStatusDetails }}', + '{{ SourceUri }}', + '{{ ModelCard }}', + '{{ SecurityConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: model_package + props: + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: AdditionalInferenceSpecifications + value: + - Containers: + - ContainerHostname: '{{ ContainerHostname }}' + Environment: {} + ModelInput: + DataInputConfig: '{{ DataInputConfig }}' + Image: '{{ Image }}' + ImageDigest: '{{ ImageDigest }}' + ModelDataUrl: '{{ ModelDataUrl }}' + ModelDataSource: + S3DataSource: + S3DataType: '{{ S3DataType }}' + S3Uri: '{{ S3Uri }}' + CompressionType: '{{ CompressionType }}' + ModelAccessConfig: + AcceptEula: '{{ AcceptEula }}' + Framework: '{{ Framework }}' + FrameworkVersion: '{{ FrameworkVersion }}' + NearestModelName: '{{ NearestModelName }}' + Description: '{{ Description }}' + Name: '{{ Name }}' + SupportedContentTypes: + - '{{ SupportedContentTypes[0] }}' + SupportedRealtimeInferenceInstanceTypes: + - '{{ SupportedRealtimeInferenceInstanceTypes[0] }}' + SupportedResponseMIMETypes: + - '{{ SupportedResponseMIMETypes[0] }}' + SupportedTransformInstanceTypes: + - '{{ SupportedTransformInstanceTypes[0] }}' + - name: CertifyForMarketplace + value: '{{ CertifyForMarketplace }}' + - name: ClientToken + value: '{{ ClientToken }}' + - name: CustomerMetadataProperties + value: {} + - name: Domain + value: '{{ Domain }}' + - name: DriftCheckBaselines + value: + Bias: + PostTrainingConstraints: + ContentDigest: '{{ ContentDigest }}' + ContentType: '{{ ContentType }}' + S3Uri: '{{ S3Uri }}' + PreTrainingConstraints: null + ConfigFile: + ContentDigest: '{{ ContentDigest }}' + ContentType: '{{ ContentType }}' + S3Uri: '{{ S3Uri }}' + Explainability: + Constraints: null + ConfigFile: null + ModelDataQuality: + Constraints: null + Statistics: null + ModelQuality: + Constraints: null + Statistics: null + - name: InferenceSpecification + value: + Containers: + - null + SupportedContentTypes: + - null + SupportedRealtimeInferenceInstanceTypes: + - null + SupportedResponseMIMETypes: + - null + SupportedTransformInstanceTypes: + - null + - name: MetadataProperties + value: + CommitId: '{{ CommitId }}' + GeneratedBy: '{{ GeneratedBy }}' + ProjectId: '{{ ProjectId }}' + Repository: '{{ Repository }}' + - name: ModelApprovalStatus + value: '{{ ModelApprovalStatus }}' + - name: ModelMetrics + value: + Bias: + Report: null + PreTrainingReport: null + PostTrainingReport: null + Explainability: + Report: null + ModelDataQuality: + Constraints: null + Statistics: null + ModelQuality: + Constraints: null + Statistics: null + - name: ModelPackageDescription + value: '{{ ModelPackageDescription }}' + - name: ModelPackageGroupName + value: '{{ ModelPackageGroupName }}' + - name: ModelPackageName + value: '{{ ModelPackageName }}' + - name: SamplePayloadUrl + value: '{{ SamplePayloadUrl }}' + - name: SkipModelValidation + value: '{{ SkipModelValidation }}' + - name: SourceAlgorithmSpecification + value: + SourceAlgorithms: + - AlgorithmName: '{{ AlgorithmName }}' + ModelDataUrl: '{{ ModelDataUrl }}' + - name: Task + value: '{{ Task }}' + - name: ValidationSpecification + value: + ValidationProfiles: + - TransformJobDefinition: + Environment: null + BatchStrategy: '{{ BatchStrategy }}' + MaxConcurrentTransforms: '{{ MaxConcurrentTransforms }}' + MaxPayloadInMB: '{{ MaxPayloadInMB }}' + TransformInput: + CompressionType: '{{ CompressionType }}' + ContentType: '{{ ContentType }}' + DataSource: + S3DataSource: + S3DataType: '{{ S3DataType }}' + S3Uri: '{{ S3Uri }}' + SplitType: '{{ SplitType }}' + TransformOutput: + Accept: '{{ Accept }}' + KmsKeyId: '{{ KmsKeyId }}' + S3OutputPath: '{{ S3OutputPath }}' + AssembleWith: '{{ AssembleWith }}' + TransformResources: + InstanceCount: '{{ InstanceCount }}' + InstanceType: '{{ InstanceType }}' + VolumeKmsKeyId: '{{ VolumeKmsKeyId }}' + ProfileName: '{{ ProfileName }}' + ValidationRole: '{{ ValidationRole }}' + - name: ApprovalDescription + value: '{{ ApprovalDescription }}' + - name: LastModifiedTime + value: '{{ LastModifiedTime }}' + - name: ModelPackageVersion + value: '{{ ModelPackageVersion }}' + - name: AdditionalInferenceSpecificationsToAdd + value: null + - name: ModelPackageStatusDetails + value: + ValidationStatuses: + - FailureReason: '{{ FailureReason }}' + Name: '{{ Name }}' + Status: '{{ Status }}' + - name: SourceUri + value: '{{ SourceUri }}' + - name: ModelCard + value: + ModelCardContent: '{{ ModelCardContent }}' + ModelCardStatus: '{{ ModelCardStatus }}' + - name: SecurityConfig + value: + KmsKeyId: '{{ KmsKeyId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.model_packages +WHERE data__Identifier = '' +AND 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, +sagemaker:UpdateModelPackage, +iam:PassRole, +s3:GetObject, +s3:ListBucket, +kms:CreateGrant, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Read +```json +sagemaker:DescribeModelPackage, +sagemaker:ListTags, +kms:DescribeKey, +kms:Decrypt +``` + +### Update +```json +ecr:BatchGetImage, +sagemaker:UpdateModelPackage, +sagemaker:DescribeModelPackage, +sagemaker:ListTags, +sagemaker:AddTags, +sagemaker:DeleteTags, +s3:GetObject, +s3:ListBucket, +kms:CreateGrant, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +sagemaker:DeleteModelPackage, +sagemaker:DescribeModelPackage, +kms:DescribeKey, +kms:Decrypt +``` + +### List +```json +sagemaker:ListModelPackages +``` diff --git a/website/docs/services/sagemaker/model_packages_list_only/index.md b/website/docs/services/sagemaker/model_packages_list_only/index.md new file mode 100644 index 0000000..f7d4754 --- /dev/null +++ b/website/docs/services/sagemaker/model_packages_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: model_packages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_packages_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_packages in a region or regions, for all properties use model_packages + +## Overview + + + + + + + +
Namemodel_packages_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelPackage
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the model package group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_packages in a region. +```sql +SELECT +region, +model_package_arn +FROM aws.sagemaker.model_packages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_packages_list_only resource, see model_packages + diff --git a/website/docs/services/sagemaker/model_quality_job_definition_tags/index.md b/website/docs/services/sagemaker/model_quality_job_definition_tags/index.md new file mode 100644 index 0000000..335cd87 --- /dev/null +++ b/website/docs/services/sagemaker/model_quality_job_definition_tags/index.md @@ -0,0 +1,99 @@ +--- +title: model_quality_job_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_quality_job_definition_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_quality_job_definitions in a region + +## Overview + + + + + + + +
Namemodel_quality_job_definition_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelQualityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
stringThe time at which the job definition was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_quality_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +model_quality_baseline_config, +model_quality_app_specification, +model_quality_job_input, +model_quality_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +creation_time, +tag_key, +tag_value +FROM aws.sagemaker.model_quality_job_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_quality_job_definition_tags resource, see model_quality_job_definitions + diff --git a/website/docs/services/sagemaker/model_quality_job_definitions/index.md b/website/docs/services/sagemaker/model_quality_job_definitions/index.md new file mode 100644 index 0000000..07eccfd --- /dev/null +++ b/website/docs/services/sagemaker/model_quality_job_definitions/index.md @@ -0,0 +1,325 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a model_quality_job_definition resource or lists model_quality_job_definitions in a region + +## Overview + + + + + + + +
Namemodel_quality_job_definitions
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelQualityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
+ +For more information, see AWS::SageMaker::ModelQualityJobDefinition. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all model_quality_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +model_quality_baseline_config, +model_quality_app_specification, +model_quality_job_input, +model_quality_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +tags, +creation_time +FROM aws.sagemaker.model_quality_job_definitions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual model_quality_job_definition. +```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_definitions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model_quality_job_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.model_quality_job_definitions ( + ModelQualityAppSpecification, + ModelQualityJobInput, + ModelQualityJobOutputConfig, + JobResources, + RoleArn, + region +) +SELECT +'{{ ModelQualityAppSpecification }}', + '{{ ModelQualityJobInput }}', + '{{ ModelQualityJobOutputConfig }}', + '{{ JobResources }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.model_quality_job_definitions ( + JobDefinitionName, + ModelQualityBaselineConfig, + ModelQualityAppSpecification, + ModelQualityJobInput, + ModelQualityJobOutputConfig, + JobResources, + NetworkConfig, + EndpointName, + RoleArn, + StoppingCondition, + Tags, + region +) +SELECT + '{{ JobDefinitionName }}', + '{{ ModelQualityBaselineConfig }}', + '{{ ModelQualityAppSpecification }}', + '{{ ModelQualityJobInput }}', + '{{ ModelQualityJobOutputConfig }}', + '{{ JobResources }}', + '{{ NetworkConfig }}', + '{{ EndpointName }}', + '{{ RoleArn }}', + '{{ StoppingCondition }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: model_quality_job_definition + props: + - name: JobDefinitionName + value: '{{ JobDefinitionName }}' + - name: ModelQualityBaselineConfig + value: + BaseliningJobName: '{{ BaseliningJobName }}' + ConstraintsResource: + S3Uri: '{{ S3Uri }}' + - name: ModelQualityAppSpecification + value: + ContainerArguments: + - '{{ ContainerArguments[0] }}' + ContainerEntrypoint: + - '{{ ContainerEntrypoint[0] }}' + ImageUri: '{{ ImageUri }}' + PostAnalyticsProcessorSourceUri: null + RecordPreprocessorSourceUri: null + Environment: {} + ProblemType: '{{ ProblemType }}' + - name: ModelQualityJobInput + value: + EndpointInput: + EndpointName: '{{ EndpointName }}' + LocalPath: '{{ LocalPath }}' + S3DataDistributionType: '{{ S3DataDistributionType }}' + S3InputMode: '{{ S3InputMode }}' + ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}' + BatchTransformInput: + DataCapturedDestinationS3Uri: '{{ DataCapturedDestinationS3Uri }}' + DatasetFormat: + Csv: + Header: '{{ Header }}' + Json: + Line: '{{ Line }}' + Parquet: '{{ Parquet }}' + LocalPath: '{{ LocalPath }}' + S3DataDistributionType: '{{ S3DataDistributionType }}' + S3InputMode: '{{ S3InputMode }}' + ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}' + GroundTruthS3Input: + S3Uri: '{{ S3Uri }}' + - name: ModelQualityJobOutputConfig + value: + KmsKeyId: '{{ KmsKeyId }}' + MonitoringOutputs: + - S3Output: + LocalPath: '{{ LocalPath }}' + S3UploadMode: '{{ S3UploadMode }}' + S3Uri: '{{ S3Uri }}' + - name: JobResources + value: + ClusterConfig: + InstanceCount: '{{ InstanceCount }}' + InstanceType: '{{ InstanceType }}' + VolumeKmsKeyId: '{{ VolumeKmsKeyId }}' + VolumeSizeInGB: '{{ VolumeSizeInGB }}' + - name: NetworkConfig + value: + EnableInterContainerTrafficEncryption: '{{ EnableInterContainerTrafficEncryption }}' + EnableNetworkIsolation: '{{ EnableNetworkIsolation }}' + VpcConfig: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + Subnets: + - '{{ Subnets[0] }}' + - name: EndpointName + value: null + - name: RoleArn + value: '{{ RoleArn }}' + - name: StoppingCondition + value: + MaxRuntimeInSeconds: '{{ MaxRuntimeInSeconds }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.model_quality_job_definitions +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +sagemaker:DeleteModelQualityJobDefinition +``` + +### Read +```json +sagemaker:DescribeModelQualityJobDefinition +``` + +### List +```json +sagemaker:ListModelQualityJobDefinitions, +sagemaker:ListTags +``` diff --git a/website/docs/services/sagemaker/model_quality_job_definitions_list_only/index.md b/website/docs/services/sagemaker/model_quality_job_definitions_list_only/index.md new file mode 100644 index 0000000..8b6b5f9 --- /dev/null +++ b/website/docs/services/sagemaker/model_quality_job_definitions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: model_quality_job_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_quality_job_definitions_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_quality_job_definitions in a region or regions, for all properties use model_quality_job_definitions + +## Overview + + + + + + + +
Namemodel_quality_job_definitions_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelQualityJobDefinition
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_quality_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.model_quality_job_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_quality_job_definitions_list_only resource, see model_quality_job_definitions + diff --git a/website/docs/services/sagemaker/monitoring_schedule_tags/index.md b/website/docs/services/sagemaker/monitoring_schedule_tags/index.md new file mode 100644 index 0000000..94b8eb8 --- /dev/null +++ b/website/docs/services/sagemaker/monitoring_schedule_tags/index.md @@ -0,0 +1,93 @@ +--- +title: monitoring_schedule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - monitoring_schedule_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for monitoring_schedules in a region + +## Overview + + + + + + + +
Namemonitoring_schedule_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::MonitoringSchedule
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the monitoring schedule.
stringThe name of the monitoring schedule.
objectThe configuration object that specifies the monitoring schedule and defines the monitoring job.
stringThe time at which the schedule was created.
stringThe name of the endpoint used to run the monitoring job.
stringContains the reason a monitoring job failed, if it failed.
stringA timestamp that indicates the last time the monitoring job was modified.
objectDescribes metadata on the last execution to run, if there was one.
stringThe status of a schedule job.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all monitoring_schedules in a region. +```sql +SELECT +region, +monitoring_schedule_arn, +monitoring_schedule_name, +monitoring_schedule_config, +creation_time, +endpoint_name, +failure_reason, +last_modified_time, +last_monitoring_execution_summary, +monitoring_schedule_status, +tag_key, +tag_value +FROM aws.sagemaker.monitoring_schedule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the monitoring_schedule_tags resource, see monitoring_schedules + diff --git a/website/docs/services/sagemaker/monitoring_schedules/index.md b/website/docs/services/sagemaker/monitoring_schedules/index.md new file mode 100644 index 0000000..5c9f0b7 --- /dev/null +++ b/website/docs/services/sagemaker/monitoring_schedules/index.md @@ -0,0 +1,325 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a monitoring_schedule resource or lists monitoring_schedules in a region + +## Overview + + + + + + + +
Namemonitoring_schedules
TypeResource
DescriptionResource Type definition for AWS::SageMaker::MonitoringSchedule
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the monitoring schedule.
stringThe name of the monitoring schedule.
objectThe configuration object that specifies the monitoring schedule and defines the monitoring job.
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the schedule was created.
stringThe name of the endpoint used to run the monitoring job.
stringContains the reason a monitoring job failed, if it failed.
stringA timestamp that indicates the last time the monitoring job was modified.
objectDescribes metadata on the last execution to run, if there was one.
stringThe status of a schedule job.
stringAWS region.
+ +For more information, see AWS::SageMaker::MonitoringSchedule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all monitoring_schedules in a region. +```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_schedules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual monitoring_schedule. +```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_schedules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new monitoring_schedule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.monitoring_schedules ( + MonitoringScheduleName, + MonitoringScheduleConfig, + region +) +SELECT +'{{ MonitoringScheduleName }}', + '{{ MonitoringScheduleConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.monitoring_schedules ( + MonitoringScheduleName, + MonitoringScheduleConfig, + Tags, + EndpointName, + FailureReason, + LastMonitoringExecutionSummary, + MonitoringScheduleStatus, + region +) +SELECT + '{{ MonitoringScheduleName }}', + '{{ MonitoringScheduleConfig }}', + '{{ Tags }}', + '{{ EndpointName }}', + '{{ FailureReason }}', + '{{ LastMonitoringExecutionSummary }}', + '{{ MonitoringScheduleStatus }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: monitoring_schedule + props: + - name: MonitoringScheduleName + value: '{{ MonitoringScheduleName }}' + - name: MonitoringScheduleConfig + value: + MonitoringJobDefinition: + BaselineConfig: + ConstraintsResource: + S3Uri: '{{ S3Uri }}' + StatisticsResource: + S3Uri: null + Environment: {} + MonitoringAppSpecification: + ContainerArguments: + - '{{ ContainerArguments[0] }}' + ContainerEntrypoint: + - '{{ ContainerEntrypoint[0] }}' + ImageUri: '{{ ImageUri }}' + PostAnalyticsProcessorSourceUri: null + RecordPreprocessorSourceUri: null + MonitoringInputs: + - EndpointInput: + EndpointName: '{{ EndpointName }}' + LocalPath: '{{ LocalPath }}' + S3DataDistributionType: '{{ S3DataDistributionType }}' + S3InputMode: '{{ S3InputMode }}' + ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}' + BatchTransformInput: + DataCapturedDestinationS3Uri: '{{ DataCapturedDestinationS3Uri }}' + DatasetFormat: + Csv: + Header: '{{ Header }}' + Json: + Line: '{{ Line }}' + Parquet: '{{ Parquet }}' + LocalPath: '{{ LocalPath }}' + S3DataDistributionType: '{{ S3DataDistributionType }}' + S3InputMode: '{{ S3InputMode }}' + ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}' + MonitoringOutputConfig: + KmsKeyId: '{{ KmsKeyId }}' + MonitoringOutputs: + - S3Output: + LocalPath: '{{ LocalPath }}' + S3UploadMode: '{{ S3UploadMode }}' + S3Uri: '{{ S3Uri }}' + MonitoringResources: + ClusterConfig: + InstanceCount: '{{ InstanceCount }}' + InstanceType: '{{ InstanceType }}' + VolumeKmsKeyId: '{{ VolumeKmsKeyId }}' + VolumeSizeInGB: '{{ VolumeSizeInGB }}' + NetworkConfig: + EnableInterContainerTrafficEncryption: '{{ EnableInterContainerTrafficEncryption }}' + EnableNetworkIsolation: '{{ EnableNetworkIsolation }}' + VpcConfig: + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + Subnets: + - '{{ Subnets[0] }}' + RoleArn: '{{ RoleArn }}' + StoppingCondition: + MaxRuntimeInSeconds: '{{ MaxRuntimeInSeconds }}' + MonitoringJobDefinitionName: '{{ MonitoringJobDefinitionName }}' + MonitoringType: '{{ MonitoringType }}' + ScheduleConfig: + ScheduleExpression: '{{ ScheduleExpression }}' + DataAnalysisStartTime: '{{ DataAnalysisStartTime }}' + DataAnalysisEndTime: null + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: EndpointName + value: null + - name: FailureReason + value: '{{ FailureReason }}' + - name: LastMonitoringExecutionSummary + value: + CreationTime: '{{ CreationTime }}' + EndpointName: null + FailureReason: '{{ FailureReason }}' + LastModifiedTime: '{{ LastModifiedTime }}' + MonitoringExecutionStatus: '{{ MonitoringExecutionStatus }}' + MonitoringScheduleName: null + ProcessingJobArn: '{{ ProcessingJobArn }}' + ScheduledTime: '{{ ScheduledTime }}' + - name: MonitoringScheduleStatus + value: '{{ MonitoringScheduleStatus }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.monitoring_schedules +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +sagemaker:DeleteMonitoringSchedule, +sagemaker:DescribeMonitoringSchedule +``` + +### List +```json +sagemaker:ListMonitoringSchedule +``` + +### Read +```json +sagemaker:DescribeMonitoringSchedule +``` + +### Update +```json +sagemaker:UpdateMonitoringSchedule, +sagemaker:DescribeMonitoringSchedule +``` diff --git a/website/docs/services/sagemaker/monitoring_schedules_list_only/index.md b/website/docs/services/sagemaker/monitoring_schedules_list_only/index.md new file mode 100644 index 0000000..335af9f --- /dev/null +++ b/website/docs/services/sagemaker/monitoring_schedules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: monitoring_schedules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - monitoring_schedules_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists monitoring_schedules in a region or regions, for all properties use monitoring_schedules + +## Overview + + + + + + + +
Namemonitoring_schedules_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::MonitoringSchedule
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the monitoring schedule.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all monitoring_schedules in a region. +```sql +SELECT +region, +monitoring_schedule_arn +FROM aws.sagemaker.monitoring_schedules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the monitoring_schedules_list_only resource, see monitoring_schedules + diff --git a/website/docs/services/sagemaker/partner_app_tags/index.md b/website/docs/services/sagemaker/partner_app_tags/index.md new file mode 100644 index 0000000..942a67e --- /dev/null +++ b/website/docs/services/sagemaker/partner_app_tags/index.md @@ -0,0 +1,97 @@ +--- +title: partner_app_tags +hide_title: false +hide_table_of_contents: false +keywords: + - partner_app_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for partner_apps in a region + +## Overview + + + + + + + +
Namepartner_app_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::PartnerApp
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the created PartnerApp.
stringA name for the PartnerApp.
stringThe type of PartnerApp.
stringThe execution role for the user.
stringThe tier of the PartnerApp.
booleanEnables IAM Session based Identity for PartnerApp.
objectA collection of settings that specify the maintenance schedule for the PartnerApp.
stringThe Auth type of PartnerApp.
stringThe AppServerUrl based on app and account-info.
objectA collection of settings that specify the maintenance schedule for the PartnerApp.
stringThe client token for the PartnerApp.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all partner_apps in a region. +```sql +SELECT +region, +arn, +name, +type, +execution_role_arn, +tier, +enable_iam_session_based_identity, +application_config, +auth_type, +base_url, +maintenance_config, +client_token, +tag_key, +tag_value +FROM aws.sagemaker.partner_app_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the partner_app_tags resource, see partner_apps + diff --git a/website/docs/services/sagemaker/partner_apps/index.md b/website/docs/services/sagemaker/partner_apps/index.md new file mode 100644 index 0000000..d579ba6 --- /dev/null +++ b/website/docs/services/sagemaker/partner_apps/index.md @@ -0,0 +1,290 @@ +--- +title: partner_apps +hide_title: false +hide_table_of_contents: false +keywords: + - partner_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a partner_app resource or lists partner_apps in a region + +## Overview + + + + + + + +
Namepartner_apps
TypeResource
DescriptionResource Type definition for AWS::SageMaker::PartnerApp
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the created PartnerApp.
stringA name for the PartnerApp.
stringThe type of PartnerApp.
stringThe execution role for the user.
stringThe tier of the PartnerApp.
booleanEnables IAM Session based Identity for PartnerApp.
objectA collection of settings that specify the maintenance schedule for the PartnerApp.
stringThe Auth type of PartnerApp.
stringThe AppServerUrl based on app and account-info.
objectA collection of settings that specify the maintenance schedule for the PartnerApp.
stringThe client token for the PartnerApp.
arrayA list of tags to apply to the PartnerApp.
stringAWS region.
+ +For more information, see AWS::SageMaker::PartnerApp. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all partner_apps in a region. +```sql +SELECT +region, +arn, +name, +type, +execution_role_arn, +tier, +enable_iam_session_based_identity, +application_config, +auth_type, +base_url, +maintenance_config, +client_token, +tags +FROM aws.sagemaker.partner_apps +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual partner_app. +```sql +SELECT +region, +arn, +name, +type, +execution_role_arn, +tier, +enable_iam_session_based_identity, +application_config, +auth_type, +base_url, +maintenance_config, +client_token, +tags +FROM aws.sagemaker.partner_apps +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new partner_app resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.partner_apps ( + Name, + Type, + ExecutionRoleArn, + Tier, + AuthType, + region +) +SELECT +'{{ Name }}', + '{{ Type }}', + '{{ ExecutionRoleArn }}', + '{{ Tier }}', + '{{ AuthType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.partner_apps ( + Name, + Type, + ExecutionRoleArn, + Tier, + EnableIamSessionBasedIdentity, + ApplicationConfig, + AuthType, + MaintenanceConfig, + ClientToken, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Type }}', + '{{ ExecutionRoleArn }}', + '{{ Tier }}', + '{{ EnableIamSessionBasedIdentity }}', + '{{ ApplicationConfig }}', + '{{ AuthType }}', + '{{ MaintenanceConfig }}', + '{{ ClientToken }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: partner_app + props: + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: ExecutionRoleArn + value: '{{ ExecutionRoleArn }}' + - name: Tier + value: '{{ Tier }}' + - name: EnableIamSessionBasedIdentity + value: '{{ EnableIamSessionBasedIdentity }}' + - name: ApplicationConfig + value: + AdminUsers: + - '{{ AdminUsers[0] }}' + Arguments: {} + - name: AuthType + value: '{{ AuthType }}' + - name: MaintenanceConfig + value: + MaintenanceWindowStart: '{{ MaintenanceWindowStart }}' + - name: ClientToken + value: '{{ ClientToken }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.partner_apps +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the partner_apps resource, the following permissions are required: + +### Create +```json +sagemaker:CreatePartnerApp, +sagemaker:DescribePartnerApp, +sagemaker:AddTags, +sagemaker:ListTags, +iam:PassRole +``` + +### Read +```json +sagemaker:DescribePartnerApp, +sagemaker:ListTags +``` + +### Update +```json +sagemaker:UpdatePartnerApp, +sagemaker:DescribePartnerApp, +sagemaker:AddTags, +sagemaker:ListTags, +sagemaker:DeleteTags +``` + +### Delete +```json +sagemaker:DeletePartnerApp, +sagemaker:DescribePartnerApp, +sagemaker:DeleteTags +``` + +### List +```json +sagemaker:ListPartnerApps, +sagemaker:DescribePartnerApp, +sagemaker:ListTags +``` diff --git a/website/docs/services/sagemaker/partner_apps_list_only/index.md b/website/docs/services/sagemaker/partner_apps_list_only/index.md new file mode 100644 index 0000000..14ee42b --- /dev/null +++ b/website/docs/services/sagemaker/partner_apps_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: partner_apps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - partner_apps_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists partner_apps in a region or regions, for all properties use partner_apps + +## Overview + + + + + + + +
Namepartner_apps_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::PartnerApp
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the created PartnerApp.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all partner_apps in a region. +```sql +SELECT +region, +arn +FROM aws.sagemaker.partner_apps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the partner_apps_list_only resource, see partner_apps + diff --git a/website/docs/services/sagemaker/pipeline_tags/index.md b/website/docs/services/sagemaker/pipeline_tags/index.md new file mode 100644 index 0000000..09f5a73 --- /dev/null +++ b/website/docs/services/sagemaker/pipeline_tags/index.md @@ -0,0 +1,87 @@ +--- +title: pipeline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pipelines in a region + +## Overview + + + + + + + +
Namepipeline_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Pipeline
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Pipeline.
stringThe display name of the Pipeline.
stringThe description of the Pipeline.
object
stringRole Arn
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pipelines in a region. +```sql +SELECT +region, +pipeline_name, +pipeline_display_name, +pipeline_description, +pipeline_definition, +role_arn, +parallelism_configuration, +tag_key, +tag_value +FROM aws.sagemaker.pipeline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipeline_tags resource, see pipelines + diff --git a/website/docs/services/sagemaker/pipelines/index.md b/website/docs/services/sagemaker/pipelines/index.md new file mode 100644 index 0000000..3ae2344 --- /dev/null +++ b/website/docs/services/sagemaker/pipelines/index.md @@ -0,0 +1,255 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a pipeline resource or lists pipelines in a region + +## Overview + + + + + + + +
Namepipelines
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Pipeline
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Pipeline.
stringThe display name of the Pipeline.
stringThe description of the Pipeline.
object
stringRole Arn
array
object
stringAWS region.
+ +For more information, see AWS::SageMaker::Pipeline. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all pipelines in a region. +```sql +SELECT +region, +pipeline_name, +pipeline_display_name, +pipeline_description, +pipeline_definition, +role_arn, +tags, +parallelism_configuration +FROM aws.sagemaker.pipelines +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual pipeline. +```sql +SELECT +region, +pipeline_name, +pipeline_display_name, +pipeline_description, +pipeline_definition, +role_arn, +tags, +parallelism_configuration +FROM aws.sagemaker.pipelines +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.pipelines ( + PipelineName, + PipelineDefinition, + RoleArn, + region +) +SELECT +'{{ PipelineName }}', + '{{ PipelineDefinition }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.pipelines ( + PipelineName, + PipelineDisplayName, + PipelineDescription, + PipelineDefinition, + RoleArn, + Tags, + ParallelismConfiguration, + region +) +SELECT + '{{ PipelineName }}', + '{{ PipelineDisplayName }}', + '{{ PipelineDescription }}', + '{{ PipelineDefinition }}', + '{{ RoleArn }}', + '{{ Tags }}', + '{{ ParallelismConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: pipeline + props: + - name: PipelineName + value: '{{ PipelineName }}' + - name: PipelineDisplayName + value: '{{ PipelineDisplayName }}' + - name: PipelineDescription + value: '{{ PipelineDescription }}' + - name: PipelineDefinition + value: {} + - name: RoleArn + value: '{{ RoleArn }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: ParallelismConfiguration + value: + MaxParallelExecutionSteps: '{{ MaxParallelExecutionSteps }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.pipelines +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +sagemaker:ListPipelines +``` diff --git a/website/docs/services/sagemaker/pipelines_list_only/index.md b/website/docs/services/sagemaker/pipelines_list_only/index.md new file mode 100644 index 0000000..d1cbfc6 --- /dev/null +++ b/website/docs/services/sagemaker/pipelines_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipelines in a region or regions, for all properties use pipelines + +## Overview + + + + + + + +
Namepipelines_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Pipeline
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Pipeline.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipelines in a region. +```sql +SELECT +region, +pipeline_name +FROM aws.sagemaker.pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipelines_list_only resource, see pipelines + diff --git a/website/docs/services/sagemaker/project_tags/index.md b/website/docs/services/sagemaker/project_tags/index.md new file mode 100644 index 0000000..c3f1014 --- /dev/null +++ b/website/docs/services/sagemaker/project_tags/index.md @@ -0,0 +1,91 @@ +--- +title: project_tags +hide_title: false +hide_table_of_contents: false +keywords: + - project_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for projects in a region + +## Overview + + + + + + + +
Nameproject_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Project
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Project.
stringProject Id.
stringThe name of the project.
stringThe description of the project.
stringThe time at which the project was created.
objectInput ServiceCatalog Provisioning Details
objectProvisioned ServiceCatalog Details
stringThe status of a project.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all projects in a region. +```sql +SELECT +region, +project_arn, +project_id, +project_name, +project_description, +creation_time, +service_catalog_provisioning_details, +service_catalog_provisioned_product_details, +project_status, +tag_key, +tag_value +FROM aws.sagemaker.project_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the project_tags resource, see projects + diff --git a/website/docs/services/sagemaker/projects/index.md b/website/docs/services/sagemaker/projects/index.md new file mode 100644 index 0000000..51f986e --- /dev/null +++ b/website/docs/services/sagemaker/projects/index.md @@ -0,0 +1,261 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a project resource or lists projects in a region + +## Overview + + + + + + + +
Nameprojects
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Project
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Project.
stringProject Id.
stringThe name of the project.
stringThe description of the project.
stringThe time at which the project was created.
objectInput ServiceCatalog Provisioning Details
objectProvisioned ServiceCatalog Details
stringThe status of a project.
stringAWS region.
+ +For more information, see AWS::SageMaker::Project. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all projects in a region. +```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.projects +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual project. +```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.projects +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.projects ( + ProjectName, + ServiceCatalogProvisioningDetails, + region +) +SELECT +'{{ ProjectName }}', + '{{ ServiceCatalogProvisioningDetails }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.projects ( + Tags, + ProjectName, + ProjectDescription, + ServiceCatalogProvisioningDetails, + ServiceCatalogProvisionedProductDetails, + region +) +SELECT + '{{ Tags }}', + '{{ ProjectName }}', + '{{ ProjectDescription }}', + '{{ ServiceCatalogProvisioningDetails }}', + '{{ ServiceCatalogProvisionedProductDetails }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: project + props: + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: ProjectName + value: '{{ ProjectName }}' + - name: ProjectDescription + value: '{{ ProjectDescription }}' + - name: ServiceCatalogProvisioningDetails + value: + ProductId: '{{ ProductId }}' + ProvisioningArtifactId: '{{ ProvisioningArtifactId }}' + PathId: '{{ PathId }}' + ProvisioningParameters: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ServiceCatalogProvisionedProductDetails + value: + ProvisionedProductId: null + ProvisionedProductStatusMessage: '{{ ProvisionedProductStatusMessage }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.projects +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +sagemaker:ListProjects +``` diff --git a/website/docs/services/sagemaker/projects_list_only/index.md b/website/docs/services/sagemaker/projects_list_only/index.md new file mode 100644 index 0000000..1651151 --- /dev/null +++ b/website/docs/services/sagemaker/projects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + + + +
Nameprojects_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Project
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Project.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +project_arn +FROM aws.sagemaker.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + diff --git a/website/docs/services/sagemaker/space_tags/index.md b/website/docs/services/sagemaker/space_tags/index.md new file mode 100644 index 0000000..ce17def --- /dev/null +++ b/website/docs/services/sagemaker/space_tags/index.md @@ -0,0 +1,91 @@ +--- +title: space_tags +hide_title: false +hide_table_of_contents: false +keywords: + - space_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for spaces in a region + +## Overview + + + + + + + +
Namespace_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Space
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe space Amazon Resource Name (ARN).
stringThe ID of the associated Domain.
stringA name for the Space.
objectA collection of settings.
object
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all spaces in a region. +```sql +SELECT +region, +space_arn, +domain_id, +space_name, +space_settings, +ownership_settings, +space_sharing_settings, +space_display_name, +url, +tag_key, +tag_value +FROM aws.sagemaker.space_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the space_tags resource, see spaces + diff --git a/website/docs/services/sagemaker/spaces/index.md b/website/docs/services/sagemaker/spaces/index.md new file mode 100644 index 0000000..7cc956f --- /dev/null +++ b/website/docs/services/sagemaker/spaces/index.md @@ -0,0 +1,294 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a space resource or lists spaces in a region + +## Overview + + + + + + + +
Namespaces
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Space
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe space Amazon Resource Name (ARN).
stringThe ID of the associated Domain.
stringA name for the Space.
objectA collection of settings.
arrayA list of tags to apply to the space.
object
object
string
string
stringAWS region.
+ +For more information, see AWS::SageMaker::Space. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all spaces in a region. +```sql +SELECT +region, +space_arn, +domain_id, +space_name, +space_settings, +tags, +ownership_settings, +space_sharing_settings, +space_display_name, +url +FROM aws.sagemaker.spaces +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual space. +```sql +SELECT +region, +space_arn, +domain_id, +space_name, +space_settings, +tags, +ownership_settings, +space_sharing_settings, +space_display_name, +url +FROM aws.sagemaker.spaces +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new space resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.spaces ( + DomainId, + SpaceName, + region +) +SELECT +'{{ DomainId }}', + '{{ SpaceName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.spaces ( + DomainId, + SpaceName, + SpaceSettings, + Tags, + OwnershipSettings, + SpaceSharingSettings, + SpaceDisplayName, + region +) +SELECT + '{{ DomainId }}', + '{{ SpaceName }}', + '{{ SpaceSettings }}', + '{{ Tags }}', + '{{ OwnershipSettings }}', + '{{ SpaceSharingSettings }}', + '{{ SpaceDisplayName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: space + props: + - name: DomainId + value: '{{ DomainId }}' + - name: SpaceName + value: '{{ SpaceName }}' + - name: SpaceSettings + value: + JupyterServerAppSettings: + DefaultResourceSpec: + InstanceType: '{{ InstanceType }}' + SageMakerImageArn: '{{ SageMakerImageArn }}' + SageMakerImageVersionArn: '{{ SageMakerImageVersionArn }}' + LifecycleConfigArn: '{{ LifecycleConfigArn }}' + LifecycleConfigArns: + - '{{ LifecycleConfigArns[0] }}' + KernelGatewayAppSettings: + CustomImages: + - AppImageConfigName: '{{ AppImageConfigName }}' + ImageName: '{{ ImageName }}' + ImageVersionNumber: '{{ ImageVersionNumber }}' + DefaultResourceSpec: null + LifecycleConfigArns: + - null + JupyterLabAppSettings: + DefaultResourceSpec: null + AppLifecycleManagement: + IdleSettings: + IdleTimeoutInMinutes: '{{ IdleTimeoutInMinutes }}' + CodeRepositories: + - RepositoryUrl: '{{ RepositoryUrl }}' + CodeEditorAppSettings: + DefaultResourceSpec: null + AppLifecycleManagement: null + SpaceStorageSettings: + EbsStorageSettings: + EbsVolumeSizeInGb: '{{ EbsVolumeSizeInGb }}' + AppType: '{{ AppType }}' + CustomFileSystems: + - EFSFileSystem: + FileSystemId: '{{ FileSystemId }}' + FSxLustreFileSystem: + FileSystemId: '{{ FileSystemId }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: OwnershipSettings + value: + OwnerUserProfileName: '{{ OwnerUserProfileName }}' + - name: SpaceSharingSettings + value: + SharingType: '{{ SharingType }}' + - name: SpaceDisplayName + value: '{{ SpaceDisplayName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.spaces +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the spaces resource, the following permissions are required: + +### Create +```json +sagemaker:CreateSpace, +sagemaker:DescribeSpace, +sagemaker:ListTags, +sagemaker:AddTags +``` + +### Read +```json +sagemaker:DescribeSpace, +sagemaker:ListTags +``` + +### Update +```json +sagemaker:UpdateSpace, +sagemaker:DescribeSpace, +sagemaker:AddTags, +sagemaker:DeleteTags, +sagemaker:ListTags +``` + +### Delete +```json +sagemaker:DeleteSpace, +sagemaker:DescribeSpace, +sagemaker:DeleteTags +``` + +### List +```json +sagemaker:ListSpaces, +sagemaker:ListTags +``` diff --git a/website/docs/services/sagemaker/spaces_list_only/index.md b/website/docs/services/sagemaker/spaces_list_only/index.md new file mode 100644 index 0000000..61e5692 --- /dev/null +++ b/website/docs/services/sagemaker/spaces_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: spaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - spaces_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists spaces in a region or regions, for all properties use spaces + +## Overview + + + + + + + +
Namespaces_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Space
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the associated Domain.
stringA name for the Space.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all spaces in a region. +```sql +SELECT +region, +domain_id, +space_name +FROM aws.sagemaker.spaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the spaces_list_only resource, see spaces + diff --git a/website/docs/services/sagemaker/studio_lifecycle_config_tags/index.md b/website/docs/services/sagemaker/studio_lifecycle_config_tags/index.md new file mode 100644 index 0000000..a4d2532 --- /dev/null +++ b/website/docs/services/sagemaker/studio_lifecycle_config_tags/index.md @@ -0,0 +1,83 @@ +--- +title: studio_lifecycle_config_tags +hide_title: false +hide_table_of_contents: false +keywords: + - studio_lifecycle_config_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for studio_lifecycle_configs in a region + +## Overview + + + + + + + +
Namestudio_lifecycle_config_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::StudioLifecycleConfig
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Lifecycle Configuration.
stringThe App type that the Lifecycle Configuration is attached to.
stringThe content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.
stringThe name of the Amazon SageMaker Studio Lifecycle Configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all studio_lifecycle_configs in a region. +```sql +SELECT +region, +studio_lifecycle_config_arn, +studio_lifecycle_config_app_type, +studio_lifecycle_config_content, +studio_lifecycle_config_name, +tag_key, +tag_value +FROM aws.sagemaker.studio_lifecycle_config_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studio_lifecycle_config_tags resource, see studio_lifecycle_configs + diff --git a/website/docs/services/sagemaker/studio_lifecycle_configs/index.md b/website/docs/services/sagemaker/studio_lifecycle_configs/index.md new file mode 100644 index 0000000..8d9c4f9 --- /dev/null +++ b/website/docs/services/sagemaker/studio_lifecycle_configs/index.md @@ -0,0 +1,222 @@ +--- +title: studio_lifecycle_configs +hide_title: false +hide_table_of_contents: false +keywords: + - studio_lifecycle_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a studio_lifecycle_config resource or lists studio_lifecycle_configs in a region + +## Overview + + + + + + + +
Namestudio_lifecycle_configs
TypeResource
DescriptionResource Type definition for AWS::SageMaker::StudioLifecycleConfig
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Lifecycle Configuration.
stringThe App type that the Lifecycle Configuration is attached to.
stringThe content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.
stringThe name of the Amazon SageMaker Studio Lifecycle Configuration.
arrayTags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
stringAWS region.
+ +For more information, see AWS::SageMaker::StudioLifecycleConfig. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all studio_lifecycle_configs in a region. +```sql +SELECT +region, +studio_lifecycle_config_arn, +studio_lifecycle_config_app_type, +studio_lifecycle_config_content, +studio_lifecycle_config_name, +tags +FROM aws.sagemaker.studio_lifecycle_configs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual studio_lifecycle_config. +```sql +SELECT +region, +studio_lifecycle_config_arn, +studio_lifecycle_config_app_type, +studio_lifecycle_config_content, +studio_lifecycle_config_name, +tags +FROM aws.sagemaker.studio_lifecycle_configs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new studio_lifecycle_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.studio_lifecycle_configs ( + StudioLifecycleConfigAppType, + StudioLifecycleConfigContent, + StudioLifecycleConfigName, + region +) +SELECT +'{{ StudioLifecycleConfigAppType }}', + '{{ StudioLifecycleConfigContent }}', + '{{ StudioLifecycleConfigName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.studio_lifecycle_configs ( + StudioLifecycleConfigAppType, + StudioLifecycleConfigContent, + StudioLifecycleConfigName, + Tags, + region +) +SELECT + '{{ StudioLifecycleConfigAppType }}', + '{{ StudioLifecycleConfigContent }}', + '{{ StudioLifecycleConfigName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: studio_lifecycle_config + props: + - name: StudioLifecycleConfigAppType + value: '{{ StudioLifecycleConfigAppType }}' + - name: StudioLifecycleConfigContent + value: '{{ StudioLifecycleConfigContent }}' + - name: StudioLifecycleConfigName + value: '{{ StudioLifecycleConfigName }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.studio_lifecycle_configs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the studio_lifecycle_configs resource, the following permissions are required: + +### Create +```json +sagemaker:CreateStudioLifecycleConfig, +sagemaker:DescribeStudioLifecycleConfig, +sagemaker:AddTags, +sagemaker:ListTags +``` + +### Read +```json +sagemaker:DescribeStudioLifecycleConfig, +sagemaker:ListTags +``` + +### Delete +```json +sagemaker:DeleteStudioLifecycleConfig, +sagemaker:DescribeStudioLifecycleConfig, +sagemaker:DeleteTags, +sagemaker:ListTags +``` + +### List +```json +sagemaker:ListStudioLifecycleConfigs, +sagemaker:ListTags +``` diff --git a/website/docs/services/sagemaker/studio_lifecycle_configs_list_only/index.md b/website/docs/services/sagemaker/studio_lifecycle_configs_list_only/index.md new file mode 100644 index 0000000..b6cdac8 --- /dev/null +++ b/website/docs/services/sagemaker/studio_lifecycle_configs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: studio_lifecycle_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - studio_lifecycle_configs_list_only + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists studio_lifecycle_configs in a region or regions, for all properties use studio_lifecycle_configs + +## Overview + + + + + + + +
Namestudio_lifecycle_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::StudioLifecycleConfig
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the Amazon SageMaker Studio Lifecycle Configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all studio_lifecycle_configs in a region. +```sql +SELECT +region, +studio_lifecycle_config_name +FROM aws.sagemaker.studio_lifecycle_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studio_lifecycle_configs_list_only resource, see studio_lifecycle_configs + diff --git a/website/docs/services/sagemaker/user_profile_tags/index.md b/website/docs/services/sagemaker/user_profile_tags/index.md new file mode 100644 index 0000000..9f0d2d7 --- /dev/null +++ b/website/docs/services/sagemaker/user_profile_tags/index.md @@ -0,0 +1,87 @@ +--- +title: user_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_profile_tags + - sagemaker + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for user_profiles in a region + +## Overview + + + + + + + +
Nameuser_profile_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::UserProfile
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe user profile Amazon Resource Name (ARN).
stringThe ID of the associated Domain.
stringA specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
stringThe username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
stringA name for the UserProfile.
objectA collection of settings.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all user_profiles in a region. +```sql +SELECT +region, +user_profile_arn, +domain_id, +single_sign_on_user_identifier, +single_sign_on_user_value, +user_profile_name, +user_settings, +tag_key, +tag_value +FROM aws.sagemaker.user_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_profile_tags resource, see user_profiles + diff --git a/website/docs/services/sagemaker/user_profiles/index.md b/website/docs/services/sagemaker/user_profiles/index.md new file mode 100644 index 0000000..eb2cab3 --- /dev/null +++ b/website/docs/services/sagemaker/user_profiles/index.md @@ -0,0 +1,313 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_profile resource or lists user_profiles in a region + +## Overview + + + + + + + +
Nameuser_profiles
TypeResource
DescriptionResource Type definition for AWS::SageMaker::UserProfile
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe user profile Amazon Resource Name (ARN).
stringThe ID of the associated Domain.
stringA specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
stringThe username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
stringA name for the UserProfile.
objectA collection of settings.
arrayA list of tags to apply to the user profile.
stringAWS region.
+ +For more information, see AWS::SageMaker::UserProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_profiles in a region. +```sql +SELECT +region, +user_profile_arn, +domain_id, +single_sign_on_user_identifier, +single_sign_on_user_value, +user_profile_name, +user_settings, +tags +FROM aws.sagemaker.user_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_profile. +```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_profiles +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.user_profiles ( + DomainId, + UserProfileName, + region +) +SELECT +'{{ DomainId }}', + '{{ UserProfileName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sagemaker.user_profiles ( + DomainId, + SingleSignOnUserIdentifier, + SingleSignOnUserValue, + UserProfileName, + UserSettings, + Tags, + region +) +SELECT + '{{ DomainId }}', + '{{ SingleSignOnUserIdentifier }}', + '{{ SingleSignOnUserValue }}', + '{{ UserProfileName }}', + '{{ UserSettings }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_profile + props: + - name: DomainId + value: '{{ DomainId }}' + - name: SingleSignOnUserIdentifier + value: '{{ SingleSignOnUserIdentifier }}' + - name: SingleSignOnUserValue + value: '{{ SingleSignOnUserValue }}' + - name: UserProfileName + value: '{{ UserProfileName }}' + - name: UserSettings + value: + ExecutionRole: '{{ ExecutionRole }}' + JupyterServerAppSettings: + DefaultResourceSpec: + InstanceType: '{{ InstanceType }}' + SageMakerImageArn: '{{ SageMakerImageArn }}' + SageMakerImageVersionArn: '{{ SageMakerImageVersionArn }}' + LifecycleConfigArn: '{{ LifecycleConfigArn }}' + LifecycleConfigArns: + - '{{ LifecycleConfigArns[0] }}' + KernelGatewayAppSettings: + CustomImages: + - AppImageConfigName: '{{ AppImageConfigName }}' + ImageName: '{{ ImageName }}' + ImageVersionNumber: '{{ ImageVersionNumber }}' + DefaultResourceSpec: null + LifecycleConfigArns: + - null + RStudioServerProAppSettings: + AccessStatus: '{{ AccessStatus }}' + UserGroup: '{{ UserGroup }}' + JupyterLabAppSettings: + DefaultResourceSpec: null + LifecycleConfigArns: + - null + CodeRepositories: + - RepositoryUrl: '{{ RepositoryUrl }}' + CustomImages: + - null + AppLifecycleManagement: + IdleSettings: + LifecycleManagement: '{{ LifecycleManagement }}' + IdleTimeoutInMinutes: '{{ IdleTimeoutInMinutes }}' + MinIdleTimeoutInMinutes: '{{ MinIdleTimeoutInMinutes }}' + MaxIdleTimeoutInMinutes: '{{ MaxIdleTimeoutInMinutes }}' + SpaceStorageSettings: + DefaultEbsStorageSettings: + DefaultEbsVolumeSizeInGb: '{{ DefaultEbsVolumeSizeInGb }}' + MaximumEbsVolumeSizeInGb: null + CodeEditorAppSettings: + DefaultResourceSpec: null + LifecycleConfigArns: + - null + CustomImages: + - null + AppLifecycleManagement: null + StudioWebPortalSettings: + HiddenMlTools: + - '{{ HiddenMlTools[0] }}' + HiddenAppTypes: + - '{{ HiddenAppTypes[0] }}' + DefaultLandingUri: '{{ DefaultLandingUri }}' + StudioWebPortal: '{{ StudioWebPortal }}' + CustomPosixUserConfig: + Uid: '{{ Uid }}' + Gid: '{{ Gid }}' + CustomFileSystemConfigs: + - EFSFileSystemConfig: + FileSystemPath: '{{ FileSystemPath }}' + FileSystemId: '{{ FileSystemId }}' + FSxLustreFileSystemConfig: + FileSystemPath: '{{ FileSystemPath }}' + FileSystemId: '{{ FileSystemId }}' + SecurityGroups: + - '{{ SecurityGroups[0] }}' + SharingSettings: + NotebookOutputOption: '{{ NotebookOutputOption }}' + S3KmsKeyId: '{{ S3KmsKeyId }}' + S3OutputPath: '{{ S3OutputPath }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sagemaker.user_profiles +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +sagemaker:DescribeUserProfile +``` + +### Update +```json +sagemaker:UpdateUserProfile, +sagemaker:DescribeUserProfile, +sagemaker:DescribeImage, +sagemaker:DescribeImageVersion, +iam:PassRole +``` + +### Delete +```json +sagemaker:DeleteUserProfile, +sagemaker:DescribeUserProfile +``` + +### List +```json +sagemaker:ListUserProfiles +``` diff --git a/website/docs/services/sagemaker/user_profiles_list_only/index.md b/website/docs/services/sagemaker/user_profiles_list_only/index.md new file mode 100644 index 0000000..2702a29 --- /dev/null +++ b/website/docs/services/sagemaker/user_profiles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: user_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_profiles_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_profiles in a region or regions, for all properties use user_profiles + +## Overview + + + + + + + +
Nameuser_profiles_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::UserProfile
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the associated Domain.
stringA name for the UserProfile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_profiles in a region. +```sql +SELECT +region, +user_profile_name, +domain_id +FROM aws.sagemaker.user_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_profiles_list_only resource, see user_profiles + diff --git a/website/docs/services/scheduler/index.md b/website/docs/services/scheduler/index.md new file mode 100644 index 0000000..59b7912 --- /dev/null +++ b/website/docs/services/scheduler/index.md @@ -0,0 +1,40 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The scheduler service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/scheduler/schedule_group_tags/index.md b/website/docs/services/scheduler/schedule_group_tags/index.md new file mode 100644 index 0000000..cb8f3d7 --- /dev/null +++ b/website/docs/services/scheduler/schedule_group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: schedule_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - schedule_group_tags + - scheduler + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for schedule_groups in a region + +## Overview + + + + + + + +
Nameschedule_group_tags
TypeResource
DescriptionDefinition of AWS::Scheduler::ScheduleGroup Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the schedule group.
stringThe time at which the schedule group was created.
stringThe time at which the schedule group was last modified.
string
stringSpecifies the state of the schedule group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all schedule_groups in a region. +```sql +SELECT +region, +arn, +creation_date, +last_modification_date, +name, +state, +tag_key, +tag_value +FROM aws.scheduler.schedule_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schedule_group_tags resource, see schedule_groups + diff --git a/website/docs/services/scheduler/schedule_groups/index.md b/website/docs/services/scheduler/schedule_groups/index.md new file mode 100644 index 0000000..7b274c8 --- /dev/null +++ b/website/docs/services/scheduler/schedule_groups/index.md @@ -0,0 +1,226 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a schedule_group resource or lists schedule_groups in a region + +## Overview + + + + + + + +
Nameschedule_groups
TypeResource
DescriptionDefinition of AWS::Scheduler::ScheduleGroup Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the schedule group.
stringThe time at which the schedule group was created.
stringThe time at which the schedule group was last modified.
string
stringSpecifies the state of the schedule group.
arrayThe list of tags to associate with the schedule group.
stringAWS region.
+ +For more information, see AWS::Scheduler::ScheduleGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all schedule_groups in a region. +```sql +SELECT +region, +arn, +creation_date, +last_modification_date, +name, +state, +tags +FROM aws.scheduler.schedule_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual schedule_group. +```sql +SELECT +region, +arn, +creation_date, +last_modification_date, +name, +state, +tags +FROM aws.scheduler.schedule_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new schedule_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.scheduler.schedule_groups ( + Name, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.scheduler.schedule_groups ( + Name, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: schedule_group + props: + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.scheduler.schedule_groups +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +scheduler:GetScheduleGroup, +scheduler:ListTagsForResource +``` + +### Update +```json +scheduler:TagResource, +scheduler:UntagResource, +scheduler:ListTagsForResource, +scheduler:GetScheduleGroup +``` + +### Delete +```json +scheduler:DeleteScheduleGroup, +scheduler:GetScheduleGroup, +scheduler:DeleteSchedule +``` + +### List +```json +scheduler:ListScheduleGroups +``` diff --git a/website/docs/services/scheduler/schedule_groups_list_only/index.md b/website/docs/services/scheduler/schedule_groups_list_only/index.md new file mode 100644 index 0000000..ee3db79 --- /dev/null +++ b/website/docs/services/scheduler/schedule_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: schedule_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schedule_groups_list_only + - scheduler + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schedule_groups in a region or regions, for all properties use schedule_groups + +## Overview + + + + + + + +
Nameschedule_groups_list_only
TypeResource
DescriptionDefinition of AWS::Scheduler::ScheduleGroup Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schedule_groups in a region. +```sql +SELECT +region, +name +FROM aws.scheduler.schedule_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schedule_groups_list_only resource, see schedule_groups + diff --git a/website/docs/services/scheduler/schedules/index.md b/website/docs/services/scheduler/schedules/index.md new file mode 100644 index 0000000..c87df32 --- /dev/null +++ b/website/docs/services/scheduler/schedules/index.md @@ -0,0 +1,326 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a schedule resource or lists schedules in a region + +## Overview + + + + + + + +
Nameschedules
TypeResource
DescriptionDefinition of AWS::Scheduler::Schedule Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the schedule.
stringThe description of the schedule.
stringThe date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify.
objectFlexible time window allows configuration of a window within which a schedule can be invoked
stringThe name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
stringThe ARN for a KMS Key that will be used to encrypt customer data.
string
stringThe scheduling expression.
stringThe timezone in which the scheduling expression is evaluated.
stringThe date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify.
stringSpecifies whether the schedule is enabled or disabled.
objectThe schedule target.
stringAWS region.
+ +For more information, see AWS::Scheduler::Schedule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all schedules in a region. +```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.schedules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual schedule. +```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.schedules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new schedule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.scheduler.schedules ( + FlexibleTimeWindow, + ScheduleExpression, + Target, + region +) +SELECT +'{{ FlexibleTimeWindow }}', + '{{ ScheduleExpression }}', + '{{ Target }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.scheduler.schedules ( + Description, + EndDate, + FlexibleTimeWindow, + GroupName, + KmsKeyArn, + Name, + ScheduleExpression, + ScheduleExpressionTimezone, + StartDate, + State, + Target, + region +) +SELECT + '{{ Description }}', + '{{ EndDate }}', + '{{ FlexibleTimeWindow }}', + '{{ GroupName }}', + '{{ KmsKeyArn }}', + '{{ Name }}', + '{{ ScheduleExpression }}', + '{{ ScheduleExpressionTimezone }}', + '{{ StartDate }}', + '{{ State }}', + '{{ Target }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: schedule + props: + - name: Description + value: '{{ Description }}' + - name: EndDate + value: '{{ EndDate }}' + - name: FlexibleTimeWindow + value: + Mode: '{{ Mode }}' + MaximumWindowInMinutes: null + - name: GroupName + value: '{{ GroupName }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: Name + value: '{{ Name }}' + - name: ScheduleExpression + value: '{{ ScheduleExpression }}' + - name: ScheduleExpressionTimezone + value: '{{ ScheduleExpressionTimezone }}' + - name: StartDate + value: '{{ StartDate }}' + - name: State + value: '{{ State }}' + - name: Target + value: + Arn: '{{ Arn }}' + RoleArn: '{{ RoleArn }}' + DeadLetterConfig: + Arn: '{{ Arn }}' + RetryPolicy: + MaximumEventAgeInSeconds: null + MaximumRetryAttempts: null + Input: '{{ Input }}' + EcsParameters: + TaskDefinitionArn: '{{ TaskDefinitionArn }}' + TaskCount: null + LaunchType: '{{ LaunchType }}' + NetworkConfiguration: + AwsvpcConfiguration: + Subnets: + - '{{ Subnets[0] }}' + SecurityGroups: + - '{{ SecurityGroups[0] }}' + AssignPublicIp: '{{ AssignPublicIp }}' + PlatformVersion: '{{ PlatformVersion }}' + Group: '{{ Group }}' + CapacityProviderStrategy: + - CapacityProvider: '{{ CapacityProvider }}' + Weight: null + Base: null + EnableECSManagedTags: '{{ EnableECSManagedTags }}' + EnableExecuteCommand: '{{ EnableExecuteCommand }}' + PlacementConstraints: + - Type: '{{ Type }}' + Expression: '{{ Expression }}' + PlacementStrategy: + - Type: '{{ Type }}' + Field: '{{ Field }}' + PropagateTags: '{{ PropagateTags }}' + ReferenceId: '{{ ReferenceId }}' + Tags: + - {} + EventBridgeParameters: + DetailType: '{{ DetailType }}' + Source: '{{ Source }}' + KinesisParameters: + PartitionKey: '{{ PartitionKey }}' + SageMakerPipelineParameters: + PipelineParameterList: + - Name: '{{ Name }}' + Value: '{{ Value }}' + SqsParameters: + MessageGroupId: '{{ MessageGroupId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.scheduler.schedules +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the schedules resource, the following permissions are required: + +### Create +```json +scheduler:CreateSchedule, +scheduler:GetSchedule, +iam:PassRole +``` + +### Read +```json +scheduler:GetSchedule +``` + +### Update +```json +scheduler:UpdateSchedule, +scheduler:GetSchedule, +iam:PassRole +``` + +### Delete +```json +scheduler:DeleteSchedule, +scheduler:GetSchedule +``` + +### List +```json +scheduler:ListSchedules +``` diff --git a/website/docs/services/scheduler/schedules_list_only/index.md b/website/docs/services/scheduler/schedules_list_only/index.md new file mode 100644 index 0000000..ebe78ce --- /dev/null +++ b/website/docs/services/scheduler/schedules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: schedules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schedules_list_only + - scheduler + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schedules in a region or regions, for all properties use schedules + +## Overview + + + + + + + +
Nameschedules_list_only
TypeResource
DescriptionDefinition of AWS::Scheduler::Schedule Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schedules in a region. +```sql +SELECT +region, +name +FROM aws.scheduler.schedules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schedules_list_only resource, see schedules + diff --git a/website/docs/services/secretsmanager/index.md b/website/docs/services/secretsmanager/index.md new file mode 100644 index 0000000..b5f6790 --- /dev/null +++ b/website/docs/services/secretsmanager/index.md @@ -0,0 +1,44 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The secretsmanager service documentation. + +:::info Service Summary + +
+
+total resources: 9
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/secretsmanager/resource_policies/index.md b/website/docs/services/secretsmanager/resource_policies/index.md new file mode 100644 index 0000000..5bc8100 --- /dev/null +++ b/website/docs/services/secretsmanager/resource_policies/index.md @@ -0,0 +1,217 @@ +--- +title: resource_policies +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_policy resource or lists resource_policies in a region + +## Overview + + + + + + + +
Nameresource_policies
TypeResource
DescriptionResource Type definition for AWS::SecretsManager::ResourcePolicy
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Arn of the secret.
stringThe ARN or name of the secret to attach the resource-based policy.
objectA JSON-formatted string for an AWS resource-based policy.
booleanSpecifies whether to block resource-based policies that allow broad access to the secret.
stringAWS region.
+ +For more information, see AWS::SecretsManager::ResourcePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_policies in a region. +```sql +SELECT +region, +id, +secret_id, +resource_policy, +block_public_policy +FROM aws.secretsmanager.resource_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_policy. +```sql +SELECT +region, +id, +secret_id, +resource_policy, +block_public_policy +FROM aws.secretsmanager.resource_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.secretsmanager.resource_policies ( + SecretId, + ResourcePolicy, + region +) +SELECT +'{{ SecretId }}', + '{{ ResourcePolicy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.secretsmanager.resource_policies ( + SecretId, + ResourcePolicy, + BlockPublicPolicy, + region +) +SELECT + '{{ SecretId }}', + '{{ ResourcePolicy }}', + '{{ BlockPublicPolicy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_policy + props: + - name: SecretId + value: '{{ SecretId }}' + - name: ResourcePolicy + value: {} + - name: BlockPublicPolicy + value: '{{ BlockPublicPolicy }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.secretsmanager.resource_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +secretsmanager:PutResourcePolicy, +secretsmanager:GetResourcePolicy +``` + +### Read +```json +secretsmanager:GetResourcePolicy +``` + +### Update +```json +secretsmanager:PutResourcePolicy, +secretsmanager:GetResourcePolicy +``` + +### Delete +```json +secretsmanager:DeleteResourcePolicy, +secretsmanager:GetResourcePolicy +``` + +### List +```json +secretsmanager:GetResourcePolicy, +secretsmanager:ListSecrets +``` diff --git a/website/docs/services/secretsmanager/resource_policies_list_only/index.md b/website/docs/services/secretsmanager/resource_policies_list_only/index.md new file mode 100644 index 0000000..30f075a --- /dev/null +++ b/website/docs/services/secretsmanager/resource_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - secretsmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::SecretsManager::ResourcePolicy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Arn of the secret.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +id +FROM aws.secretsmanager.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + diff --git a/website/docs/services/secretsmanager/rotation_schedules/index.md b/website/docs/services/secretsmanager/rotation_schedules/index.md new file mode 100644 index 0000000..eb2e8ef --- /dev/null +++ b/website/docs/services/secretsmanager/rotation_schedules/index.md @@ -0,0 +1,245 @@ +--- +title: rotation_schedules +hide_title: false +hide_table_of_contents: false +keywords: + - rotation_schedules + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a rotation_schedule resource or lists rotation_schedules in a region + +## Overview + + + + + + + +
Namerotation_schedules
TypeResource
DescriptionResource Type definition for AWS::SecretsManager::RotationSchedule
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectCreates a new Lambda rotation function based on one of the Secrets Manager rotation function templates. To use a rotation function that already exists, specify RotationLambdaARN instead.
stringThe ARN or name of the secret to rotate.
stringThe ARN of the secret.
booleanSpecifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
stringThe ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the Ref function.
objectA structure that defines the rotation configuration for this secret.
stringAWS region.
+ +For more information, see AWS::SecretsManager::RotationSchedule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rotation_schedules in a region. +```sql +SELECT +region, +hosted_rotation_lambda, +secret_id, +id, +rotate_immediately_on_update, +rotation_lambda_arn, +rotation_rules +FROM aws.secretsmanager.rotation_schedules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual rotation_schedule. +```sql +SELECT +region, +hosted_rotation_lambda, +secret_id, +id, +rotate_immediately_on_update, +rotation_lambda_arn, +rotation_rules +FROM aws.secretsmanager.rotation_schedules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rotation_schedule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.secretsmanager.rotation_schedules ( + SecretId, + region +) +SELECT +'{{ SecretId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.secretsmanager.rotation_schedules ( + HostedRotationLambda, + SecretId, + RotateImmediatelyOnUpdate, + RotationLambdaARN, + RotationRules, + region +) +SELECT + '{{ HostedRotationLambda }}', + '{{ SecretId }}', + '{{ RotateImmediatelyOnUpdate }}', + '{{ RotationLambdaARN }}', + '{{ RotationRules }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: rotation_schedule + props: + - name: HostedRotationLambda + value: + Runtime: '{{ Runtime }}' + KmsKeyArn: '{{ KmsKeyArn }}' + MasterSecretArn: '{{ MasterSecretArn }}' + RotationLambdaName: '{{ RotationLambdaName }}' + RotationType: '{{ RotationType }}' + ExcludeCharacters: '{{ ExcludeCharacters }}' + VpcSecurityGroupIds: '{{ VpcSecurityGroupIds }}' + MasterSecretKmsKeyArn: '{{ MasterSecretKmsKeyArn }}' + SuperuserSecretArn: '{{ SuperuserSecretArn }}' + SuperuserSecretKmsKeyArn: '{{ SuperuserSecretKmsKeyArn }}' + VpcSubnetIds: '{{ VpcSubnetIds }}' + - name: SecretId + value: '{{ SecretId }}' + - name: RotateImmediatelyOnUpdate + value: '{{ RotateImmediatelyOnUpdate }}' + - name: RotationLambdaARN + value: '{{ RotationLambdaARN }}' + - name: RotationRules + value: + ScheduleExpression: '{{ ScheduleExpression }}' + Duration: '{{ Duration }}' + AutomaticallyAfterDays: '{{ AutomaticallyAfterDays }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.secretsmanager.rotation_schedules +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the rotation_schedules resource, the following permissions are required: + +### Read +```json +secretsmanager:DescribeSecret +``` + +### Create +```json +secretsmanager:RotateSecret, +secretsmanager:DescribeSecret, +lambda:InvokeFunction +``` + +### Update +```json +secretsmanager:RotateSecret, +secretsmanager:DescribeSecret, +lambda:InvokeFunction +``` + +### List +```json +secretsmanager:DescribeSecret, +secretsmanager:ListSecrets +``` + +### Delete +```json +secretsmanager:CancelRotateSecret, +secretsmanager:DescribeSecret +``` diff --git a/website/docs/services/secretsmanager/rotation_schedules_list_only/index.md b/website/docs/services/secretsmanager/rotation_schedules_list_only/index.md new file mode 100644 index 0000000..e436c1d --- /dev/null +++ b/website/docs/services/secretsmanager/rotation_schedules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: rotation_schedules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rotation_schedules_list_only + - secretsmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rotation_schedules in a region or regions, for all properties use rotation_schedules + +## Overview + + + + + + + +
Namerotation_schedules_list_only
TypeResource
DescriptionResource Type definition for AWS::SecretsManager::RotationSchedule
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the secret.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rotation_schedules in a region. +```sql +SELECT +region, +id +FROM aws.secretsmanager.rotation_schedules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rotation_schedules_list_only resource, see rotation_schedules + diff --git a/website/docs/services/secretsmanager/secret_tags/index.md b/website/docs/services/secretsmanager/secret_tags/index.md new file mode 100644 index 0000000..ecb732e --- /dev/null +++ b/website/docs/services/secretsmanager/secret_tags/index.md @@ -0,0 +1,89 @@ +--- +title: secret_tags +hide_title: false +hide_table_of_contents: false +keywords: + - secret_tags + - secretsmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for secrets in a region + +## Overview + + + + + + + +
Namesecret_tags
TypeResource
DescriptionCreates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.
For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).
For RS admin user credentials, see [AWS::Redshift::Cluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html).
To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).
For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).
For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the secret.
stringThe ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different AWS account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
stringThe text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use GenerateSecretString instead. If you omit both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
objectA structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use SecretString instead. If you omit both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
arrayA custom type that specifies a Region and the KmsKeyId for a replica secret.
string
stringThe name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all secrets in a region. +```sql +SELECT +region, +description, +kms_key_id, +secret_string, +generate_secret_string, +replica_regions, +id, +name, +tag_key, +tag_value +FROM aws.secretsmanager.secret_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the secret_tags resource, see secrets + diff --git a/website/docs/services/secretsmanager/secret_target_attachments/index.md b/website/docs/services/secretsmanager/secret_target_attachments/index.md new file mode 100644 index 0000000..393b081 --- /dev/null +++ b/website/docs/services/secretsmanager/secret_target_attachments/index.md @@ -0,0 +1,231 @@ +--- +title: secret_target_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - secret_target_attachments + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a secret_target_attachment resource or lists secret_target_attachments in a region + +## Overview + + + + + + + +
Namesecret_target_attachments
TypeResource
DescriptionResource Type definition for AWS::SecretsManager::SecretTargetAttachment
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringAWS region.
+ +For more information, see AWS::SecretsManager::SecretTargetAttachment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all secret_target_attachments in a region. +```sql +SELECT +region, +id, +secret_id, +target_type, +target_id +FROM aws.secretsmanager.secret_target_attachments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual secret_target_attachment. +```sql +SELECT +region, +id, +secret_id, +target_type, +target_id +FROM aws.secretsmanager.secret_target_attachments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new secret_target_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.secretsmanager.secret_target_attachments ( + SecretId, + TargetType, + TargetId, + region +) +SELECT +'{{ SecretId }}', + '{{ TargetType }}', + '{{ TargetId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.secretsmanager.secret_target_attachments ( + SecretId, + TargetType, + TargetId, + region +) +SELECT + '{{ SecretId }}', + '{{ TargetType }}', + '{{ TargetId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: secret_target_attachment + props: + - name: SecretId + value: '{{ SecretId }}' + - name: TargetType + value: '{{ TargetType }}' + - name: TargetId + value: '{{ TargetId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.secretsmanager.secret_target_attachments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the secret_target_attachments resource, the following permissions are required: + +### Read +```json +secretsmanager:GetSecretValue +``` + +### List +```json +secretsmanager:GetSecretValue, +secretsmanager:ListSecrets +``` + +### Create +```json +secretsmanager:GetSecretValue, +secretsmanager:PutSecretValue, +rds:DescribeDBInstances, +redshift:DescribeClusters, +rds:DescribeDBClusters, +docdb-elastic:GetCluster, +redshift-serverless:ListWorkgroups, +redshift-serverless:GetNamespace +``` + +### Delete +```json +secretsmanager:GetSecretValue, +secretsmanager:PutSecretValue +``` + +### Update +```json +secretsmanager:GetSecretValue, +secretsmanager:PutSecretValue, +rds:DescribeDBInstances, +redshift:DescribeClusters, +rds:DescribeDBClusters, +docdb-elastic:GetCluster, +redshift-serverless:ListWorkgroups, +redshift-serverless:GetNamespace +``` diff --git a/website/docs/services/secretsmanager/secret_target_attachments_list_only/index.md b/website/docs/services/secretsmanager/secret_target_attachments_list_only/index.md new file mode 100644 index 0000000..fc3d4e7 --- /dev/null +++ b/website/docs/services/secretsmanager/secret_target_attachments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: secret_target_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - secret_target_attachments_list_only + - secretsmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists secret_target_attachments in a region or regions, for all properties use secret_target_attachments + +## Overview + + + + + + + +
Namesecret_target_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::SecretsManager::SecretTargetAttachment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all secret_target_attachments in a region. +```sql +SELECT +region, +id +FROM aws.secretsmanager.secret_target_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the secret_target_attachments_list_only resource, see secret_target_attachments + diff --git a/website/docs/services/secretsmanager/secrets/index.md b/website/docs/services/secretsmanager/secrets/index.md new file mode 100644 index 0000000..c485bec --- /dev/null +++ b/website/docs/services/secretsmanager/secrets/index.md @@ -0,0 +1,278 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a secret resource or lists 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.
For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).
For RS admin user credentials, see [AWS::Redshift::Cluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html).
To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).
For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).
For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the secret.
stringThe ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different AWS account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
stringThe text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use GenerateSecretString instead. If you omit both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
objectA structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use SecretString instead. If you omit both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
arrayA custom type that specifies a Region and the KmsKeyId for a replica secret.
string
arrayA list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".
Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret.
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
+ Maximum number of tags per secret: 50
+ Maximum key length: 127 Unicode characters in UTF-8
+ Maximum value length: 255 Unicode characters in UTF-8
+ Tag keys and values are case sensitive.
+ Do not use the aws: prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
+ If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
stringThe name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
stringAWS region.
+ +For more information, see AWS::SecretsManager::Secret. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all secrets in a region. +```sql +SELECT +region, +description, +kms_key_id, +secret_string, +generate_secret_string, +replica_regions, +id, +tags, +name +FROM aws.secretsmanager.secrets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual secret. +```sql +SELECT +region, +description, +kms_key_id, +secret_string, +generate_secret_string, +replica_regions, +id, +tags, +name +FROM aws.secretsmanager.secrets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new secret resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.secretsmanager.secrets ( + Description, + KmsKeyId, + SecretString, + GenerateSecretString, + ReplicaRegions, + Tags, + Name, + region +) +SELECT +'{{ Description }}', + '{{ KmsKeyId }}', + '{{ SecretString }}', + '{{ GenerateSecretString }}', + '{{ ReplicaRegions }}', + '{{ Tags }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.secretsmanager.secrets ( + Description, + KmsKeyId, + SecretString, + GenerateSecretString, + ReplicaRegions, + Tags, + Name, + region +) +SELECT + '{{ Description }}', + '{{ KmsKeyId }}', + '{{ SecretString }}', + '{{ GenerateSecretString }}', + '{{ ReplicaRegions }}', + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: secret + props: + - name: Description + value: '{{ Description }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: SecretString + value: '{{ SecretString }}' + - name: GenerateSecretString + value: + ExcludeUppercase: '{{ ExcludeUppercase }}' + RequireEachIncludedType: '{{ RequireEachIncludedType }}' + IncludeSpace: '{{ IncludeSpace }}' + ExcludeCharacters: '{{ ExcludeCharacters }}' + GenerateStringKey: '{{ GenerateStringKey }}' + PasswordLength: '{{ PasswordLength }}' + ExcludePunctuation: '{{ ExcludePunctuation }}' + ExcludeLowercase: '{{ ExcludeLowercase }}' + SecretStringTemplate: '{{ SecretStringTemplate }}' + ExcludeNumbers: '{{ ExcludeNumbers }}' + - name: ReplicaRegions + value: + - KmsKeyId: '{{ KmsKeyId }}' + Region: '{{ Region }}' + - name: Tags + value: + - Value: '{{ Value }}' + Key: '{{ Key }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.secretsmanager.secrets +WHERE data__Identifier = '' +AND 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, +secretsmanager:ReplicateSecretToRegions +``` + +### Delete +```json +secretsmanager:DeleteSecret, +secretsmanager:DescribeSecret, +secretsmanager:RemoveRegionsFromReplication +``` + +### List +```json +secretsmanager:ListSecrets +``` + +### 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/website/docs/services/secretsmanager/secrets_list_only/index.md b/website/docs/services/secretsmanager/secrets_list_only/index.md new file mode 100644 index 0000000..e05a200 --- /dev/null +++ b/website/docs/services/secretsmanager/secrets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: secrets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - secrets_list_only + - secretsmanager + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists secrets in a region or regions, for all properties use secrets + +## Overview + + + + + + + +
Namesecrets_list_only
TypeResource
DescriptionCreates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.
For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).
For RS admin user credentials, see [AWS::Redshift::Cluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html).
To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).
For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).
For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all secrets in a region. +```sql +SELECT +region, +id +FROM aws.secretsmanager.secrets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the secrets_list_only resource, see secrets + diff --git a/website/docs/services/securityhub/automation_rule_tags/index.md b/website/docs/services/securityhub/automation_rule_tags/index.md new file mode 100644 index 0000000..e43ff3b --- /dev/null +++ b/website/docs/services/securityhub/automation_rule_tags/index.md @@ -0,0 +1,97 @@ +--- +title: automation_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - automation_rule_tags + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for automation_rules in a region + +## Overview + + + + + + + +
Nameautomation_rule_tags
TypeResource
DescriptionThe AWS::SecurityHub::AutomationRule resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringWhether the rule is active after it is created. If this parameter is equal to ENABLED, ASH applies the rule to findings and finding updates after the rule is created.
integerAn integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
stringA description of the rule.
stringThe name of the rule.
stringThe date and time, in UTC and ISO 8601 format.
stringThe date and time, in UTC and ISO 8601 format.
string
booleanSpecifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
arrayOne or more actions to update finding fields if a finding matches the conditions specified in Criteria.
objectA set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all automation_rules in a region. +```sql +SELECT +region, +rule_arn, +rule_status, +rule_order, +description, +rule_name, +created_at, +updated_at, +created_by, +is_terminal, +actions, +criteria, +tag_key, +tag_value +FROM aws.securityhub.automation_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the automation_rule_tags resource, see automation_rules + diff --git a/website/docs/services/securityhub/automation_rules/index.md b/website/docs/services/securityhub/automation_rules/index.md new file mode 100644 index 0000000..cc5fb7e --- /dev/null +++ b/website/docs/services/securityhub/automation_rules/index.md @@ -0,0 +1,371 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an automation_rule resource or lists 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*.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringWhether the rule is active after it is created. If this parameter is equal to ENABLED, ASH applies the rule to findings and finding updates after the rule is created.
integerAn integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
stringA description of the rule.
stringThe name of the rule.
stringThe date and time, in UTC and ISO 8601 format.
stringThe date and time, in UTC and ISO 8601 format.
string
booleanSpecifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
arrayOne or more actions to update finding fields if a finding matches the conditions specified in Criteria.
objectA set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding.
objectUser-defined tags associated with an automation rule.
stringAWS region.
+ +For more information, see AWS::SecurityHub::AutomationRule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all automation_rules in a region. +```sql +SELECT +region, +rule_arn, +rule_status, +rule_order, +description, +rule_name, +created_at, +updated_at, +created_by, +is_terminal, +actions, +criteria, +tags +FROM aws.securityhub.automation_rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual automation_rule. +```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_rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new automation_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.automation_rules ( + RuleOrder, + Description, + RuleName, + Actions, + Criteria, + region +) +SELECT +'{{ RuleOrder }}', + '{{ Description }}', + '{{ RuleName }}', + '{{ Actions }}', + '{{ Criteria }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.automation_rules ( + RuleStatus, + RuleOrder, + Description, + RuleName, + IsTerminal, + Actions, + Criteria, + Tags, + region +) +SELECT + '{{ RuleStatus }}', + '{{ RuleOrder }}', + '{{ Description }}', + '{{ RuleName }}', + '{{ IsTerminal }}', + '{{ Actions }}', + '{{ Criteria }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: automation_rule + props: + - name: RuleStatus + value: '{{ RuleStatus }}' + - name: RuleOrder + value: '{{ RuleOrder }}' + - name: Description + value: '{{ Description }}' + - name: RuleName + value: '{{ RuleName }}' + - name: IsTerminal + value: '{{ IsTerminal }}' + - name: Actions + value: + - Type: '{{ Type }}' + FindingFieldsUpdate: + Types: + - '{{ Types[0] }}' + Severity: + Product: null + Label: '{{ Label }}' + Normalized: '{{ Normalized }}' + Confidence: null + Criticality: null + UserDefinedFields: {} + VerificationState: '{{ VerificationState }}' + RelatedFindings: + - ProductArn: '{{ ProductArn }}' + Id: null + Note: + Text: '{{ Text }}' + UpdatedBy: null + Workflow: + Status: '{{ Status }}' + - name: Criteria + value: + ProductArn: + - Comparison: '{{ Comparison }}' + Value: '{{ Value }}' + AwsAccountId: + - null + Id: + - null + GeneratorId: + - null + Type: + - null + FirstObservedAt: + - DateRange: + Unit: '{{ Unit }}' + Value: null + End: '{{ End }}' + Start: null + LastObservedAt: + - null + CreatedAt: + - null + UpdatedAt: + - null + Confidence: + - Eq: null + Gte: null + Lte: null + Criticality: + - null + Title: + - null + Description: + - null + SourceUrl: + - null + ProductName: + - null + CompanyName: + - null + SeverityLabel: + - null + ResourceType: + - null + ResourceId: + - null + ResourcePartition: + - null + ResourceRegion: + - null + ResourceTags: + - Comparison: '{{ Comparison }}' + Key: null + Value: null + ResourceDetailsOther: + - null + ComplianceStatus: + - null + ComplianceSecurityControlId: + - null + ComplianceAssociatedStandardsId: + - null + VerificationState: + - null + WorkflowStatus: + - null + RecordState: + - null + RelatedFindingsProductArn: + - null + RelatedFindingsId: + - null + NoteText: + - null + NoteUpdatedAt: + - null + NoteUpdatedBy: + - null + UserDefinedFields: + - null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.automation_rules +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +securityhub:ListAutomationRules, +securityhub:BatchGetAutomationRules, +securityhub:ListTagsForResource +``` + +### Update +```json +securityhub:BatchUpdateAutomationRules, +securityhub:TagResource, +securityhub:UntagResource, +securityhub:ListTagsForResource +``` + +### Delete +```json +securityhub:BatchDeleteAutomationRules, +securityhub:BatchGetAutomationRules +``` + +### List +```json +securityhub:ListAutomationRules, +securityhub:ListTagsForResource +``` diff --git a/website/docs/services/securityhub/automation_rules_list_only/index.md b/website/docs/services/securityhub/automation_rules_list_only/index.md new file mode 100644 index 0000000..7a8c559 --- /dev/null +++ b/website/docs/services/securityhub/automation_rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: automation_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - automation_rules_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists automation_rules in a region or regions, for all properties use automation_rules + +## Overview + + + + + + + +
Nameautomation_rules_list_only
TypeResource
DescriptionThe AWS::SecurityHub::AutomationRule resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all automation_rules in a region. +```sql +SELECT +region, +rule_arn +FROM aws.securityhub.automation_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the automation_rules_list_only resource, see automation_rules + diff --git a/website/docs/services/securityhub/configuration_policies/index.md b/website/docs/services/securityhub/configuration_policies/index.md new file mode 100644 index 0000000..6cfe1d9 --- /dev/null +++ b/website/docs/services/securityhub/configuration_policies/index.md @@ -0,0 +1,252 @@ +--- +title: configuration_policies +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_policies + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configuration_policy resource or lists configuration_policies in a region + +## Overview + + + + + + + +
Nameconfiguration_policies
TypeResource
DescriptionThe AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the configuration policy.
stringThe name of the configuration policy.
stringThe description of the configuration policy.
objectAn object that defines how Security Hub is configured.
stringThe universally unique identifier (UUID) of the configuration policy.
stringThe date and time, in UTC and ISO 8601 format.
stringThe date and time, in UTC and ISO 8601 format.
booleanIndicates whether the service that the configuration policy applies to is enabled in the policy.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +For more information, see AWS::SecurityHub::ConfigurationPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configuration_policies in a region. +```sql +SELECT +region, +arn, +name, +description, +configuration_policy, +id, +created_at, +updated_at, +service_enabled, +tags +FROM aws.securityhub.configuration_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual configuration_policy. +```sql +SELECT +region, +arn, +name, +description, +configuration_policy, +id, +created_at, +updated_at, +service_enabled, +tags +FROM aws.securityhub.configuration_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configuration_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.configuration_policies ( + Name, + ConfigurationPolicy, + region +) +SELECT +'{{ Name }}', + '{{ ConfigurationPolicy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.configuration_policies ( + Name, + Description, + ConfigurationPolicy, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ ConfigurationPolicy }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configuration_policy + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: ConfigurationPolicy + value: + SecurityHub: + EnabledStandardIdentifiers: + - '{{ EnabledStandardIdentifiers[0] }}' + ServiceEnabled: '{{ ServiceEnabled }}' + SecurityControlsConfiguration: + DisabledSecurityControlIdentifiers: + - '{{ DisabledSecurityControlIdentifiers[0] }}' + EnabledSecurityControlIdentifiers: + - '{{ EnabledSecurityControlIdentifiers[0] }}' + SecurityControlCustomParameters: + - Parameters: {} + SecurityControlId: '{{ SecurityControlId }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.configuration_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the configuration_policies resource, the following permissions are required: + +### Create +```json +securityhub:CreateConfigurationPolicy, +securityhub:TagResource, +securityhub:ListTagsForResource +``` + +### Read +```json +securityhub:GetConfigurationPolicy, +securityhub:ListTagsForResource +``` + +### Update +```json +securityhub:UpdateConfigurationPolicy, +securityhub:TagResource, +securityhub:UntagResource, +securityhub:ListTagsForResource +``` + +### Delete +```json +securityhub:GetConfigurationPolicy, +securityhub:DeleteConfigurationPolicy +``` + +### List +```json +securityhub:ListConfigurationPolicies, +securityhub:ListTagsForResource +``` diff --git a/website/docs/services/securityhub/configuration_policies_list_only/index.md b/website/docs/services/securityhub/configuration_policies_list_only/index.md new file mode 100644 index 0000000..0d5b516 --- /dev/null +++ b/website/docs/services/securityhub/configuration_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: configuration_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_policies_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_policies in a region or regions, for all properties use configuration_policies + +## Overview + + + + + + + +
Nameconfiguration_policies_list_only
TypeResource
DescriptionThe AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the configuration policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_policies in a region. +```sql +SELECT +region, +arn +FROM aws.securityhub.configuration_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_policies_list_only resource, see configuration_policies + diff --git a/website/docs/services/securityhub/configuration_policy_tags/index.md b/website/docs/services/securityhub/configuration_policy_tags/index.md new file mode 100644 index 0000000..2ba5666 --- /dev/null +++ b/website/docs/services/securityhub/configuration_policy_tags/index.md @@ -0,0 +1,91 @@ +--- +title: configuration_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_policy_tags + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configuration_policies in a region + +## Overview + + + + + + + +
Nameconfiguration_policy_tags
TypeResource
DescriptionThe AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the configuration policy.
stringThe name of the configuration policy.
stringThe description of the configuration policy.
objectAn object that defines how Security Hub is configured.
stringThe universally unique identifier (UUID) of the configuration policy.
stringThe date and time, in UTC and ISO 8601 format.
stringThe date and time, in UTC and ISO 8601 format.
booleanIndicates whether the service that the configuration policy applies to is enabled in the policy.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configuration_policies in a region. +```sql +SELECT +region, +arn, +name, +description, +configuration_policy, +id, +created_at, +updated_at, +service_enabled, +tag_key, +tag_value +FROM aws.securityhub.configuration_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_policy_tags resource, see configuration_policies + diff --git a/website/docs/services/securityhub/delegated_admins/index.md b/website/docs/services/securityhub/delegated_admins/index.md new file mode 100644 index 0000000..2b4612f --- /dev/null +++ b/website/docs/services/securityhub/delegated_admins/index.md @@ -0,0 +1,196 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a delegated_admin resource or lists delegated_admins in a region + +## Overview + + + + + + + +
Namedelegated_admins
TypeResource
DescriptionThe AWS::SecurityHub::DelegatedAdmin resource designates the delegated ASHlong administrator account for an organization. You must enable the integration between ASH and AOlong before you can designate a delegated ASH administrator. Only the management account for an organization can designate the delegated ASH administrator account. For more information, see [Designating the delegated administrator](https://docs.aws.amazon.com/securityhub/latest/userguide/designate-orgs-admin-account.html#designate-admin-instructions) in the *User Guide*.
To change the delegated administrator account, remove the current delegated administrator account, and then designate the new account.
To designate multiple delegated administrators in different organizations and AWS-Regions, we recommend using [mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html).
Tags aren't supported for this resource.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringThe AWS-account identifier of the account to designate as the Security Hub administrator account.
string
stringAWS region.
+ +For more information, see AWS::SecurityHub::DelegatedAdmin. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all delegated_admins in a region. +```sql +SELECT +region, +delegated_admin_identifier, +admin_account_id, +status +FROM aws.securityhub.delegated_admins +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual delegated_admin. +```sql +SELECT +region, +delegated_admin_identifier, +admin_account_id, +status +FROM aws.securityhub.delegated_admins +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new delegated_admin resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.delegated_admins ( + AdminAccountId, + region +) +SELECT +'{{ AdminAccountId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.delegated_admins ( + AdminAccountId, + region +) +SELECT + '{{ AdminAccountId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: delegated_admin + props: + - name: AdminAccountId + value: '{{ AdminAccountId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.delegated_admins +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +securityhub:ListOrganizationAdminAccounts, +organizations:DescribeOrganization +``` + +### Delete +```json +securityhub:DisableOrganizationAdminAccount, +organizations:DescribeOrganization +``` + +### List +```json +securityhub:ListOrganizationAdminAccounts, +organizations:DescribeOrganization +``` diff --git a/website/docs/services/securityhub/delegated_admins_list_only/index.md b/website/docs/services/securityhub/delegated_admins_list_only/index.md new file mode 100644 index 0000000..7a86230 --- /dev/null +++ b/website/docs/services/securityhub/delegated_admins_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: delegated_admins_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - delegated_admins_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists delegated_admins in a region or regions, for all properties use delegated_admins + +## Overview + + + + + + + +
Namedelegated_admins_list_only
TypeResource
DescriptionThe AWS::SecurityHub::DelegatedAdmin resource designates the delegated ASHlong administrator account for an organization. You must enable the integration between ASH and AOlong before you can designate a delegated ASH administrator. Only the management account for an organization can designate the delegated ASH administrator account. For more information, see [Designating the delegated administrator](https://docs.aws.amazon.com/securityhub/latest/userguide/designate-orgs-admin-account.html#designate-admin-instructions) in the *User Guide*.
To change the delegated administrator account, remove the current delegated administrator account, and then designate the new account.
To designate multiple delegated administrators in different organizations and AWS-Regions, we recommend using [mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html).
Tags aren't supported for this resource.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all delegated_admins in a region. +```sql +SELECT +region, +delegated_admin_identifier +FROM aws.securityhub.delegated_admins_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delegated_admins_list_only resource, see delegated_admins + diff --git a/website/docs/services/securityhub/finding_aggregators/index.md b/website/docs/services/securityhub/finding_aggregators/index.md new file mode 100644 index 0000000..9856fc9 --- /dev/null +++ b/website/docs/services/securityhub/finding_aggregators/index.md @@ -0,0 +1,208 @@ +--- +title: finding_aggregators +hide_title: false +hide_table_of_contents: false +keywords: + - finding_aggregators + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a finding_aggregator resource or lists finding_aggregators in a region + +## Overview + + + + + + + +
Namefinding_aggregators
TypeResource
DescriptionThe AWS::SecurityHub::FindingAggregator resource enables cross-Region aggregation. When cross-Region aggregation is enabled, you can aggregate findings, finding updates, insights, control compliance statuses, and security scores from one or more linked Regions to a single aggregation Region. You can then view and manage all of this data from the aggregation Region. For more details about cross-Region aggregation, see [Cross-Region aggregation](https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html) in the *User Guide*
This resource must be created in the Region that you want to designate as your aggregation Region.
Cross-Region aggregation is also a prerequisite for using [central configuration](https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html) in ASH.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringIndicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
The selected option also determines how to use the Regions provided in the Regions list.
The options are as follows:
+ ALL_REGIONS - Aggregates findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
+ ALL_REGIONS_EXCEPT_SPECIFIED - Aggregates findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
+ SPECIFIED_REGIONS - Aggregates findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.
+ NO_REGIONS - Aggregates no data because no Regions are selected as linked Regions.
arrayIf RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.
An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.
string
stringAWS region.
+ +For more information, see AWS::SecurityHub::FindingAggregator. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all finding_aggregators in a region. +```sql +SELECT +region, +finding_aggregator_arn, +region_linking_mode, +regions, +finding_aggregation_region +FROM aws.securityhub.finding_aggregators +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual finding_aggregator. +```sql +SELECT +region, +finding_aggregator_arn, +region_linking_mode, +regions, +finding_aggregation_region +FROM aws.securityhub.finding_aggregators +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new finding_aggregator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.finding_aggregators ( + RegionLinkingMode, + region +) +SELECT +'{{ RegionLinkingMode }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.finding_aggregators ( + RegionLinkingMode, + Regions, + region +) +SELECT + '{{ RegionLinkingMode }}', + '{{ Regions }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: finding_aggregator + props: + - name: RegionLinkingMode + value: '{{ RegionLinkingMode }}' + - name: Regions + value: + - '{{ Regions[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.finding_aggregators +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the finding_aggregators resource, the following permissions are required: + +### Create +```json +securityhub:CreateFindingAggregator +``` + +### Read +```json +securityhub:GetFindingAggregator +``` + +### Update +```json +securityhub:UpdateFindingAggregator +``` + +### Delete +```json +securityhub:DeleteFindingAggregator +``` + +### List +```json +securityhub:ListFindingAggregators +``` diff --git a/website/docs/services/securityhub/finding_aggregators_list_only/index.md b/website/docs/services/securityhub/finding_aggregators_list_only/index.md new file mode 100644 index 0000000..f527d39 --- /dev/null +++ b/website/docs/services/securityhub/finding_aggregators_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: finding_aggregators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - finding_aggregators_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists finding_aggregators in a region or regions, for all properties use finding_aggregators + +## Overview + + + + + + + +
Namefinding_aggregators_list_only
TypeResource
DescriptionThe AWS::SecurityHub::FindingAggregator resource enables cross-Region aggregation. When cross-Region aggregation is enabled, you can aggregate findings, finding updates, insights, control compliance statuses, and security scores from one or more linked Regions to a single aggregation Region. You can then view and manage all of this data from the aggregation Region. For more details about cross-Region aggregation, see [Cross-Region aggregation](https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html) in the *User Guide*
This resource must be created in the Region that you want to designate as your aggregation Region.
Cross-Region aggregation is also a prerequisite for using [central configuration](https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html) in ASH.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all finding_aggregators in a region. +```sql +SELECT +region, +finding_aggregator_arn +FROM aws.securityhub.finding_aggregators_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the finding_aggregators_list_only resource, see finding_aggregators + diff --git a/website/docs/services/securityhub/hub_tags/index.md b/website/docs/services/securityhub/hub_tags/index.md new file mode 100644 index 0000000..0e52d0a --- /dev/null +++ b/website/docs/services/securityhub/hub_tags/index.md @@ -0,0 +1,85 @@ +--- +title: hub_tags +hide_title: false +hide_table_of_contents: false +keywords: + - hub_tags + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for hubs in a region + +## Overview + + + + + + + +
Namehub_tags
TypeResource
DescriptionThe AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringAn ARN is automatically created for the customer.
booleanWhether to enable the security standards that Security Hub has designated as automatically enabled.
stringThis field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
booleanWhether to automatically enable new controls when they are added to standards that are enabled
stringThe date and time when Security Hub was enabled in the account.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all hubs in a region. +```sql +SELECT +region, +arn, +enable_default_standards, +control_finding_generator, +auto_enable_controls, +subscribed_at, +tag_key, +tag_value +FROM aws.securityhub.hub_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hub_tags resource, see hubs + diff --git a/website/docs/services/securityhub/hubs/index.md b/website/docs/services/securityhub/hubs/index.md new file mode 100644 index 0000000..8dae409 --- /dev/null +++ b/website/docs/services/securityhub/hubs/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a hub resource or lists 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.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringAn ARN is automatically created for the customer.
booleanWhether to enable the security standards that Security Hub has designated as automatically enabled.
stringThis field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
booleanWhether to automatically enable new controls when they are added to standards that are enabled
objectA key-value pair to associate with a resource.
stringThe date and time when Security Hub was enabled in the account.
stringAWS region.
+ +For more information, see AWS::SecurityHub::Hub. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all hubs in a region. +```sql +SELECT +region, +arn, +enable_default_standards, +control_finding_generator, +auto_enable_controls, +tags, +subscribed_at +FROM aws.securityhub.hubs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual hub. +```sql +SELECT +region, +arn, +enable_default_standards, +control_finding_generator, +auto_enable_controls, +tags, +subscribed_at +FROM aws.securityhub.hubs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new hub resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.hubs ( + EnableDefaultStandards, + ControlFindingGenerator, + AutoEnableControls, + Tags, + region +) +SELECT +'{{ EnableDefaultStandards }}', + '{{ ControlFindingGenerator }}', + '{{ AutoEnableControls }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.hubs ( + EnableDefaultStandards, + ControlFindingGenerator, + AutoEnableControls, + Tags, + region +) +SELECT + '{{ EnableDefaultStandards }}', + '{{ ControlFindingGenerator }}', + '{{ AutoEnableControls }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: hub + props: + - name: EnableDefaultStandards + value: '{{ EnableDefaultStandards }}' + - name: ControlFindingGenerator + value: '{{ ControlFindingGenerator }}' + - name: AutoEnableControls + value: '{{ AutoEnableControls }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.hubs +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +securityhub:DescribeHub, +securityhub:ListTagsForResource +``` + +### Update +```json +securityhub:DescribeHub, +securityhub:UpdateSecurityHubConfiguration, +securityhub:TagResource, +securityhub:UntagResource, +securityhub:ListTagsForResource +``` + +### Delete +```json +securityhub:DisableSecurityHub +``` + +### List +```json +securityhub:DescribeHub, +securityhub:ListTagsForResource +``` diff --git a/website/docs/services/securityhub/hubs_list_only/index.md b/website/docs/services/securityhub/hubs_list_only/index.md new file mode 100644 index 0000000..0b506b8 --- /dev/null +++ b/website/docs/services/securityhub/hubs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: hubs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hubs_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hubs in a region or regions, for all properties use hubs + +## Overview + + + + + + + +
Namehubs_list_only
TypeResource
DescriptionThe AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAn ARN is automatically created for the customer.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hubs in a region. +```sql +SELECT +region, +arn +FROM aws.securityhub.hubs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hubs_list_only resource, see hubs + diff --git a/website/docs/services/securityhub/index.md b/website/docs/services/securityhub/index.md new file mode 100644 index 0000000..4cd4a12 --- /dev/null +++ b/website/docs/services/securityhub/index.md @@ -0,0 +1,60 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The securityhub service documentation. + +:::info Service Summary + +
+
+total resources: 25
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/securityhub/insights/index.md b/website/docs/services/securityhub/insights/index.md new file mode 100644 index 0000000..af6dcd8 --- /dev/null +++ b/website/docs/services/securityhub/insights/index.md @@ -0,0 +1,433 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an insight resource or lists 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.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ARN of a Security Hub insight
stringThe name of a Security Hub insight
objectOne or more attributes used to filter the findings included in the insight
stringThe grouping attribute for the insight's findings
stringAWS region.
+ +For more information, see AWS::SecurityHub::Insight. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all insights in a region. +```sql +SELECT +region, +insight_arn, +name, +filters, +group_by_attribute +FROM aws.securityhub.insights +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual insight. +```sql +SELECT +region, +insight_arn, +name, +filters, +group_by_attribute +FROM aws.securityhub.insights +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new insight resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.insights ( + Name, + Filters, + GroupByAttribute, + region +) +SELECT +'{{ Name }}', + '{{ Filters }}', + '{{ GroupByAttribute }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.insights ( + Name, + Filters, + GroupByAttribute, + region +) +SELECT + '{{ Name }}', + '{{ Filters }}', + '{{ GroupByAttribute }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: insight + props: + - name: Name + value: '{{ Name }}' + - name: Filters + value: + ProductArn: + - Comparison: '{{ Comparison }}' + Value: '{{ Value }}' + AwsAccountId: + - null + AwsAccountName: + - null + Id: + - null + GeneratorId: + - null + Type: + - null + Region: + - null + FirstObservedAt: + - DateRange: + Unit: '{{ Unit }}' + Value: null + End: '{{ End }}' + Start: null + LastObservedAt: + - null + CreatedAt: + - null + UpdatedAt: + - null + SeverityLabel: + - null + Confidence: + - Eq: null + Gte: null + Lte: null + Criticality: + - null + Title: + - null + Description: + - null + RecommendationText: + - null + SourceUrl: + - null + ProductFields: + - Comparison: '{{ Comparison }}' + Key: null + Value: null + ProductName: + - null + CompanyName: + - null + UserDefinedFields: + - null + MalwareName: + - null + MalwareType: + - null + MalwarePath: + - null + MalwareState: + - null + NetworkDirection: + - null + NetworkProtocol: + - null + NetworkSourceIpV4: + - Cidr: null + NetworkSourceIpV6: + - null + NetworkSourcePort: + - null + NetworkSourceDomain: + - null + NetworkSourceMac: + - null + NetworkDestinationIpV4: + - null + NetworkDestinationIpV6: + - null + NetworkDestinationPort: + - null + NetworkDestinationDomain: + - null + ProcessName: + - null + ProcessPath: + - null + ProcessPid: + - null + ProcessParentPid: + - null + ProcessLaunchedAt: + - null + ProcessTerminatedAt: + - null + ThreatIntelIndicatorType: + - null + ThreatIntelIndicatorValue: + - null + ThreatIntelIndicatorCategory: + - null + ThreatIntelIndicatorLastObservedAt: + - null + ThreatIntelIndicatorSource: + - null + ThreatIntelIndicatorSourceUrl: + - null + ResourceType: + - null + ResourceId: + - null + ResourcePartition: + - null + ResourceRegion: + - null + ResourceTags: + - null + ResourceAwsEc2InstanceType: + - null + ResourceAwsEc2InstanceImageId: + - null + ResourceAwsEc2InstanceIpV4Addresses: + - null + ResourceAwsEc2InstanceIpV6Addresses: + - null + ResourceAwsEc2InstanceKeyName: + - null + ResourceAwsEc2InstanceIamInstanceProfileArn: + - null + ResourceAwsEc2InstanceVpcId: + - null + ResourceAwsEc2InstanceSubnetId: + - null + ResourceAwsEc2InstanceLaunchedAt: + - null + ResourceAwsS3BucketOwnerId: + - null + ResourceAwsS3BucketOwnerName: + - null + ResourceAwsIamAccessKeyStatus: + - null + ResourceAwsIamAccessKeyCreatedAt: + - null + ResourceContainerName: + - null + ResourceContainerImageId: + - null + ResourceContainerImageName: + - null + ResourceContainerLaunchedAt: + - null + ResourceDetailsOther: + - null + ComplianceStatus: + - null + VerificationState: + - null + WorkflowState: + - null + WorkflowStatus: + - null + RecordState: + - null + RelatedFindingsProductArn: + - null + RelatedFindingsId: + - null + ResourceApplicationArn: + - null + ResourceApplicationName: + - null + NoteText: + - null + NoteUpdatedAt: + - null + NoteUpdatedBy: + - null + Sample: + - Value: '{{ Value }}' + ComplianceAssociatedStandardsId: + - null + ComplianceSecurityControlId: + - null + ComplianceSecurityControlParametersName: + - null + ComplianceSecurityControlParametersValue: + - null + FindingProviderFieldsConfidence: + - null + FindingProviderFieldsCriticality: + - null + FindingProviderFieldsRelatedFindingsId: + - null + FindingProviderFieldsRelatedFindingsProductArn: + - null + FindingProviderFieldsSeverityLabel: + - null + FindingProviderFieldsSeverityOriginal: + - null + FindingProviderFieldsTypes: + - null + ResourceAwsIamAccessKeyPrincipalName: + - null + ResourceAwsIamUserUserName: + - null + VulnerabilitiesExploitAvailable: + - null + VulnerabilitiesFixAvailable: + - null + Keyword: + - Value: null + ResourceAwsIamAccessKeyUserName: + - null + SeverityNormalized: + - null + SeverityProduct: + - null + - name: GroupByAttribute + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.insights +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the insights resource, the following permissions are required: + +### Create +```json +securityhub:CreateInsight +``` + +### Read +```json +securityhub:GetInsights +``` + +### Update +```json +securityhub:UpdateInsight +``` + +### Delete +```json +securityhub:GetInsights, +securityhub:DeleteInsight +``` + +### List +```json +securityhub:GetInsights +``` diff --git a/website/docs/services/securityhub/insights_list_only/index.md b/website/docs/services/securityhub/insights_list_only/index.md new file mode 100644 index 0000000..9b5846b --- /dev/null +++ b/website/docs/services/securityhub/insights_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: insights_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - insights_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists insights in a region or regions, for all properties use insights + +## Overview + + + + + + + +
Nameinsights_list_only
TypeResource
DescriptionThe AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of a Security Hub insight
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all insights in a region. +```sql +SELECT +region, +insight_arn +FROM aws.securityhub.insights_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the insights_list_only resource, see insights + diff --git a/website/docs/services/securityhub/organization_configurations/index.md b/website/docs/services/securityhub/organization_configurations/index.md new file mode 100644 index 0000000..59b90ae --- /dev/null +++ b/website/docs/services/securityhub/organization_configurations/index.md @@ -0,0 +1,227 @@ +--- +title: organization_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - organization_configurations + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an organization_configuration resource or lists organization_configurations in a region + +## Overview + + + + + + + +
Nameorganization_configurations
TypeResource
DescriptionThe AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether to automatically enable Security Hub in new member accounts when they join the organization.
stringWhether to automatically enable Security Hub default standards in new member accounts when they join the organization.
stringIndicates whether the organization uses local or central configuration.
stringDescribes whether central configuration could be enabled as the ConfigurationType for the organization.
stringProvides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.
booleanWhether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
stringThe identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
stringAWS region.
+ +For more information, see AWS::SecurityHub::OrganizationConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all organization_configurations in a region. +```sql +SELECT +region, +auto_enable, +auto_enable_standards, +configuration_type, +status, +status_message, +member_account_limit_reached, +organization_configuration_identifier +FROM aws.securityhub.organization_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual organization_configuration. +```sql +SELECT +region, +auto_enable, +auto_enable_standards, +configuration_type, +status, +status_message, +member_account_limit_reached, +organization_configuration_identifier +FROM aws.securityhub.organization_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new organization_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.organization_configurations ( + AutoEnable, + region +) +SELECT +'{{ AutoEnable }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.organization_configurations ( + AutoEnable, + AutoEnableStandards, + ConfigurationType, + region +) +SELECT + '{{ AutoEnable }}', + '{{ AutoEnableStandards }}', + '{{ ConfigurationType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: organization_configuration + props: + - name: AutoEnable + value: '{{ AutoEnable }}' + - name: AutoEnableStandards + value: '{{ AutoEnableStandards }}' + - name: ConfigurationType + value: '{{ ConfigurationType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.organization_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the organization_configurations resource, the following permissions are required: + +### Create +```json +securityhub:UpdateOrganizationConfiguration, +securityhub:DescribeOrganizationConfiguration, +organizations:DescribeOrganization +``` + +### Read +```json +securityhub:DescribeOrganizationConfiguration +``` + +### Update +```json +securityhub:UpdateOrganizationConfiguration, +securityhub:DescribeOrganizationConfiguration, +organizations:DescribeOrganization +``` + +### Delete +```json +securityhub:UpdateOrganizationConfiguration, +securityhub:DescribeOrganizationConfiguration, +securityhub:ListFindingAggregators, +organizations:DescribeOrganization +``` + +### List +```json +securityhub:DescribeOrganizationConfiguration +``` diff --git a/website/docs/services/securityhub/organization_configurations_list_only/index.md b/website/docs/services/securityhub/organization_configurations_list_only/index.md new file mode 100644 index 0000000..b36ceac --- /dev/null +++ b/website/docs/services/securityhub/organization_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: organization_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - organization_configurations_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists organization_configurations in a region or regions, for all properties use organization_configurations + +## Overview + + + + + + + +
Nameorganization_configurations_list_only
TypeResource
DescriptionThe AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all organization_configurations in a region. +```sql +SELECT +region, +organization_configuration_identifier +FROM aws.securityhub.organization_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organization_configurations_list_only resource, see organization_configurations + diff --git a/website/docs/services/securityhub/policy_associations/index.md b/website/docs/services/securityhub/policy_associations/index.md new file mode 100644 index 0000000..5fec3f9 --- /dev/null +++ b/website/docs/services/securityhub/policy_associations/index.md @@ -0,0 +1,231 @@ +--- +title: policy_associations +hide_title: false +hide_table_of_contents: false +keywords: + - policy_associations + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a policy_association resource or lists policy_associations in a region + +## Overview + + + + + + + +
Namepolicy_associations
TypeResource
DescriptionThe AWS::SecurityHub::PolicyAssociation resource represents the AWS Security Hub Central Configuration Policy associations in your Target. Only the AWS Security Hub delegated administrator can create the resouce from the home region.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration
stringThe current status of the association between the specified target and the configuration
stringIndicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent
stringAn explanation for a FAILED value for AssociationStatus
stringThe identifier of the target account, organizational unit, or the root
stringIndicates whether the target is an AWS account, organizational unit, or the organization root
stringThe date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated
stringA unique identifier to indicates if the target has an association
stringAWS region.
+ +For more information, see AWS::SecurityHub::PolicyAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all policy_associations in a region. +```sql +SELECT +region, +configuration_policy_id, +association_status, +association_type, +association_status_message, +target_id, +target_type, +updated_at, +association_identifier +FROM aws.securityhub.policy_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual policy_association. +```sql +SELECT +region, +configuration_policy_id, +association_status, +association_type, +association_status_message, +target_id, +target_type, +updated_at, +association_identifier +FROM aws.securityhub.policy_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new policy_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.policy_associations ( + ConfigurationPolicyId, + TargetId, + TargetType, + region +) +SELECT +'{{ ConfigurationPolicyId }}', + '{{ TargetId }}', + '{{ TargetType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.policy_associations ( + ConfigurationPolicyId, + TargetId, + TargetType, + region +) +SELECT + '{{ ConfigurationPolicyId }}', + '{{ TargetId }}', + '{{ TargetType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: policy_association + props: + - name: ConfigurationPolicyId + value: '{{ ConfigurationPolicyId }}' + - name: TargetId + value: '{{ TargetId }}' + - name: TargetType + value: '{{ TargetType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.policy_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the policy_associations resource, the following permissions are required: + +### Create +```json +securityhub:StartConfigurationPolicyAssociation, +securityhub:GetConfigurationPolicyAssociation +``` + +### Read +```json +securityhub:GetConfigurationPolicyAssociation, +securityhub:GetConfigurationPolicyAssociation +``` + +### Update +```json +securityhub:StartConfigurationPolicyAssociation, +securityhub:GetConfigurationPolicyAssociation +``` + +### Delete +```json +securityhub:StartConfigurationPolicyDisassociation, +securityhub:GetConfigurationPolicyAssociation +``` + +### List +```json +securityhub:ListConfigurationPolicyAssociations +``` diff --git a/website/docs/services/securityhub/policy_associations_list_only/index.md b/website/docs/services/securityhub/policy_associations_list_only/index.md new file mode 100644 index 0000000..d495014 --- /dev/null +++ b/website/docs/services/securityhub/policy_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: policy_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policy_associations_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policy_associations in a region or regions, for all properties use policy_associations + +## Overview + + + + + + + +
Namepolicy_associations_list_only
TypeResource
DescriptionThe AWS::SecurityHub::PolicyAssociation resource represents the AWS Security Hub Central Configuration Policy associations in your Target. Only the AWS Security Hub delegated administrator can create the resouce from the home region.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier to indicates if the target has an association
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policy_associations in a region. +```sql +SELECT +region, +association_identifier +FROM aws.securityhub.policy_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_associations_list_only resource, see policy_associations + diff --git a/website/docs/services/securityhub/product_subscriptions/index.md b/website/docs/services/securityhub/product_subscriptions/index.md new file mode 100644 index 0000000..92eb52c --- /dev/null +++ b/website/docs/services/securityhub/product_subscriptions/index.md @@ -0,0 +1,188 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a product_subscription resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe generic ARN of the product being subscribed to
stringThe ARN of the product subscription for the account
stringAWS region.
+ +For more information, see AWS::SecurityHub::ProductSubscription. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all product_subscriptions in a region. +```sql +SELECT +region, +product_arn, +product_subscription_arn +FROM aws.securityhub.product_subscriptions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual product_subscription. +```sql +SELECT +region, +product_arn, +product_subscription_arn +FROM aws.securityhub.product_subscriptions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new product_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.product_subscriptions ( + ProductArn, + region +) +SELECT +'{{ ProductArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.product_subscriptions ( + ProductArn, + region +) +SELECT + '{{ ProductArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: product_subscription + props: + - name: ProductArn + value: '{{ ProductArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.product_subscriptions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the product_subscriptions resource, the following permissions are required: + +### Create +```json +securityhub:EnableImportFindingsForProduct +``` + +### Read +```json +securityhub:ListEnabledProductsForImport +``` + +### Delete +```json +securityhub:ListEnabledProductsForImport, +securityhub:DisableImportFindingsForProduct +``` + +### List +```json +securityhub:ListEnabledProductsForImport +``` diff --git a/website/docs/services/securityhub/product_subscriptions_list_only/index.md b/website/docs/services/securityhub/product_subscriptions_list_only/index.md new file mode 100644 index 0000000..597d82f --- /dev/null +++ b/website/docs/services/securityhub/product_subscriptions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: product_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - product_subscriptions_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists product_subscriptions in a region or regions, for all properties use product_subscriptions + +## Overview + + + + + + + +
Nameproduct_subscriptions_list_only
TypeResource
DescriptionThe AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the product subscription for the account
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all product_subscriptions in a region. +```sql +SELECT +region, +product_subscription_arn +FROM aws.securityhub.product_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the product_subscriptions_list_only resource, see product_subscriptions + diff --git a/website/docs/services/securityhub/security_controls/index.md b/website/docs/services/securityhub/security_controls/index.md new file mode 100644 index 0000000..21abd61 --- /dev/null +++ b/website/docs/services/securityhub/security_controls/index.md @@ -0,0 +1,227 @@ +--- +title: security_controls +hide_title: false +hide_table_of_contents: false +keywords: + - security_controls + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a security_control resource or lists security_controls in a region + +## Overview + + + + + + + +
Namesecurity_controls
TypeResource
DescriptionA security control in Security Hub describes a security best practice related to a specific resource.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3.
stringThe Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard.
stringThe most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
objectAn object that identifies the name of a control parameter, its current value, and whether it has been customized.
stringAWS region.
+ +For more information, see AWS::SecurityHub::SecurityControl. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all security_controls in a region. +```sql +SELECT +region, +security_control_id, +security_control_arn, +last_update_reason, +parameters +FROM aws.securityhub.security_controls +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual security_control. +```sql +SELECT +region, +security_control_id, +security_control_arn, +last_update_reason, +parameters +FROM aws.securityhub.security_controls +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new security_control resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.security_controls ( + Parameters, + region +) +SELECT +'{{ Parameters }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.security_controls ( + SecurityControlId, + SecurityControlArn, + LastUpdateReason, + Parameters, + region +) +SELECT + '{{ SecurityControlId }}', + '{{ SecurityControlArn }}', + '{{ LastUpdateReason }}', + '{{ Parameters }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: security_control + props: + - name: SecurityControlId + value: '{{ SecurityControlId }}' + - name: SecurityControlArn + value: null + - name: LastUpdateReason + value: '{{ LastUpdateReason }}' + - name: Parameters + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.security_controls +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the security_controls resource, the following permissions are required: + +### Create +```json +securityhub:BatchGetSecurityControls, +securityhub:DescribeStandardsControls, +securityhub:UpdateSecurityControl, +securityhub:UpdateStandardsControl +``` + +### Read +```json +securityhub:BatchGetSecurityControls, +securityhub:DescribeStandardsControls +``` + +### Update +```json +securityhub:BatchGetSecurityControls, +securityhub:DescribeStandardsControls, +securityhub:UpdateSecurityControl, +securityhub:UpdateStandardsControl +``` + +### Delete +```json +securityhub:BatchGetSecurityControls, +securityhub:DescribeStandardsControls, +securityhub:UpdateSecurityControl, +securityhub:UpdateStandardsControl +``` + +### List +```json +securityhub:BatchGetSecurityControls, +securityhub:DescribeStandardsControls, +securityhub:ListSecurityControlDefinitions +``` diff --git a/website/docs/services/securityhub/security_controls_list_only/index.md b/website/docs/services/securityhub/security_controls_list_only/index.md new file mode 100644 index 0000000..6be0168 --- /dev/null +++ b/website/docs/services/securityhub/security_controls_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: security_controls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_controls_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_controls in a region or regions, for all properties use security_controls + +## Overview + + + + + + + +
Namesecurity_controls_list_only
TypeResource
DescriptionA security control in Security Hub describes a security best practice related to a specific resource.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_controls in a region. +```sql +SELECT +region, +security_control_id +FROM aws.securityhub.security_controls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_controls_list_only resource, see security_controls + diff --git a/website/docs/services/securityhub/standards/index.md b/website/docs/services/securityhub/standards/index.md new file mode 100644 index 0000000..56ebd03 --- /dev/null +++ b/website/docs/services/securityhub/standards/index.md @@ -0,0 +1,211 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a standard resource or lists 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.
You must create a separate AWS::SecurityHub::Standard resource for each standard that you want to enable.
For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringThe ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.
arraySpecifies which controls are to be disabled in a standard.
*Maximum*: 100
stringAWS region.
+ +For more information, see AWS::SecurityHub::Standard. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all standards in a region. +```sql +SELECT +region, +standards_subscription_arn, +standards_arn, +disabled_standards_controls +FROM aws.securityhub.standards +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual standard. +```sql +SELECT +region, +standards_subscription_arn, +standards_arn, +disabled_standards_controls +FROM aws.securityhub.standards +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new standard resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.standards ( + StandardsArn, + region +) +SELECT +'{{ StandardsArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securityhub.standards ( + StandardsArn, + DisabledStandardsControls, + region +) +SELECT + '{{ StandardsArn }}', + '{{ DisabledStandardsControls }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: standard + props: + - name: StandardsArn + value: '{{ StandardsArn }}' + - name: DisabledStandardsControls + value: + - StandardsControlArn: '{{ StandardsControlArn }}' + Reason: '{{ Reason }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securityhub.standards +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the standards resource, the following permissions are required: + +### Create +```json +securityhub:GetEnabledStandards, +securityhub:BatchEnableStandards, +securityhub:UpdateStandardsControl +``` + +### Read +```json +securityhub:GetEnabledStandards, +securityhub:DescribeStandardsControls +``` + +### Update +```json +securityhub:GetEnabledStandards, +securityhub:UpdateStandardsControl +``` + +### Delete +```json +securityhub:GetEnabledStandards, +securityhub:BatchDisableStandards +``` + +### List +```json +securityhub:GetEnabledStandards +``` diff --git a/website/docs/services/securityhub/standards_list_only/index.md b/website/docs/services/securityhub/standards_list_only/index.md new file mode 100644 index 0000000..ab0c05f --- /dev/null +++ b/website/docs/services/securityhub/standards_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: standards_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - standards_list_only + - securityhub + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists standards in a region or regions, for all properties use standards + +## Overview + + + + + + + +
Namestandards_list_only
TypeResource
DescriptionThe AWS::SecurityHub::Standard resource specifies the enablement of a security standard. The standard is identified by the StandardsArn property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.
You must create a separate AWS::SecurityHub::Standard resource for each standard that you want to enable.
For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all standards in a region. +```sql +SELECT +region, +standards_subscription_arn +FROM aws.securityhub.standards_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the standards_list_only resource, see standards + diff --git a/website/docs/services/securitylake/data_lake_tags/index.md b/website/docs/services/securitylake/data_lake_tags/index.md new file mode 100644 index 0000000..cc69c24 --- /dev/null +++ b/website/docs/services/securitylake/data_lake_tags/index.md @@ -0,0 +1,87 @@ +--- +title: data_lake_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_lake_tags + - securitylake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_lakes in a region + +## Overview + + + + + + + +
Namedata_lake_tags
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::DataLake
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectProvides encryption details of Amazon Security Lake object.
objectProvides lifecycle details of Amazon Security Lake object.
objectProvides replication details of Amazon Security Lake object.
stringThe Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources.
stringThe Amazon Resource Name (ARN) created by you to provide to the subscriber.
stringThe ARN for the Amazon Security Lake Amazon S3 bucket.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_lakes in a region. +```sql +SELECT +region, +encryption_configuration, +lifecycle_configuration, +replication_configuration, +meta_store_manager_role_arn, +arn, +s3_bucket_arn, +tag_key, +tag_value +FROM aws.securitylake.data_lake_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_lake_tags resource, see data_lakes + diff --git a/website/docs/services/securitylake/data_lakes/index.md b/website/docs/services/securitylake/data_lakes/index.md new file mode 100644 index 0000000..d149937 --- /dev/null +++ b/website/docs/services/securitylake/data_lakes/index.md @@ -0,0 +1,281 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_lake resource or lists data_lakes in a region + +## Overview + + + + + + + +
Namedata_lakes
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::DataLake
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectProvides encryption details of Amazon Security Lake object.
objectProvides lifecycle details of Amazon Security Lake object.
objectProvides replication details of Amazon Security Lake object.
stringThe Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources.
array
stringThe Amazon Resource Name (ARN) created by you to provide to the subscriber.
stringThe ARN for the Amazon Security Lake Amazon S3 bucket.
stringAWS region.
+ +For more information, see AWS::SecurityLake::DataLake. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_lakes in a region. +```sql +SELECT +region, +encryption_configuration, +lifecycle_configuration, +replication_configuration, +meta_store_manager_role_arn, +tags, +arn, +s3_bucket_arn +FROM aws.securitylake.data_lakes +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_lake. +```sql +SELECT +region, +encryption_configuration, +lifecycle_configuration, +replication_configuration, +meta_store_manager_role_arn, +tags, +arn, +s3_bucket_arn +FROM aws.securitylake.data_lakes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_lake resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securitylake.data_lakes ( + EncryptionConfiguration, + LifecycleConfiguration, + ReplicationConfiguration, + MetaStoreManagerRoleArn, + Tags, + region +) +SELECT +'{{ EncryptionConfiguration }}', + '{{ LifecycleConfiguration }}', + '{{ ReplicationConfiguration }}', + '{{ MetaStoreManagerRoleArn }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securitylake.data_lakes ( + EncryptionConfiguration, + LifecycleConfiguration, + ReplicationConfiguration, + MetaStoreManagerRoleArn, + Tags, + region +) +SELECT + '{{ EncryptionConfiguration }}', + '{{ LifecycleConfiguration }}', + '{{ ReplicationConfiguration }}', + '{{ MetaStoreManagerRoleArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_lake + props: + - name: EncryptionConfiguration + value: + KmsKeyId: '{{ KmsKeyId }}' + - name: LifecycleConfiguration + value: + Expiration: + Days: '{{ Days }}' + Transitions: + - Days: '{{ Days }}' + StorageClass: '{{ StorageClass }}' + - name: ReplicationConfiguration + value: + Regions: + - '{{ Regions[0] }}' + RoleArn: '{{ RoleArn }}' + - name: MetaStoreManagerRoleArn + value: '{{ MetaStoreManagerRoleArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securitylake.data_lakes +WHERE data__Identifier = '' +AND 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:* +``` + +### 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* +``` + +### List +```json +securitylake:List* +``` diff --git a/website/docs/services/securitylake/data_lakes_list_only/index.md b/website/docs/services/securitylake/data_lakes_list_only/index.md new file mode 100644 index 0000000..134cc07 --- /dev/null +++ b/website/docs/services/securitylake/data_lakes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: data_lakes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_lakes_list_only + - securitylake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_lakes in a region or regions, for all properties use data_lakes + +## Overview + + + + + + + +
Namedata_lakes_list_only
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::DataLake
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) created by you to provide to the subscriber.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_lakes in a region. +```sql +SELECT +region, +arn +FROM aws.securitylake.data_lakes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_lakes_list_only resource, see data_lakes + diff --git a/website/docs/services/securitylake/index.md b/website/docs/services/securitylake/index.md new file mode 100644 index 0000000..19714ae --- /dev/null +++ b/website/docs/services/securitylake/index.md @@ -0,0 +1,43 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The securitylake service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/securitylake/subscriber_notifications/index.md b/website/docs/services/securitylake/subscriber_notifications/index.md new file mode 100644 index 0000000..e7e8735 --- /dev/null +++ b/website/docs/services/securitylake/subscriber_notifications/index.md @@ -0,0 +1,281 @@ +--- +title: subscriber_notifications +hide_title: false +hide_table_of_contents: false +keywords: + - subscriber_notifications + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a subscriber_notification resource or lists subscriber_notifications in a region + +## Overview + + + + + + + +
Namesubscriber_notifications
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::SubscriberNotification
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
object
stringThe ARN for the subscriber
stringThe endpoint the subscriber should listen to for notifications
stringAWS region.
+ +For more information, see AWS::SecurityLake::SubscriberNotification. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all subscriber_notifications in a region. +```sql +SELECT +region, +notification_configuration, +subscriber_arn, +subscriber_endpoint +FROM aws.securitylake.subscriber_notifications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual subscriber_notification. +```sql +SELECT +region, +notification_configuration, +subscriber_arn, +subscriber_endpoint +FROM aws.securitylake.subscriber_notifications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new subscriber_notification resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securitylake.subscriber_notifications ( + NotificationConfiguration, + SubscriberArn, + region +) +SELECT +'{{ NotificationConfiguration }}', + '{{ SubscriberArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securitylake.subscriber_notifications ( + NotificationConfiguration, + SubscriberArn, + region +) +SELECT + '{{ NotificationConfiguration }}', + '{{ SubscriberArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: subscriber_notification + props: + - name: NotificationConfiguration + value: + HttpsNotificationConfiguration: + AuthorizationApiKeyName: '{{ AuthorizationApiKeyName }}' + AuthorizationApiKeyValue: '{{ AuthorizationApiKeyValue }}' + Endpoint: '{{ Endpoint }}' + HttpMethod: '{{ HttpMethod }}' + TargetRoleArn: '{{ TargetRoleArn }}' + SqsNotificationConfiguration: {} + - name: SubscriberArn + value: '{{ SubscriberArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securitylake.subscriber_notifications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the subscriber_notifications resource, the following permissions are required: + +### Create +```json +securitylake:CreateDataLake, +securitylake:CreateSubscriber, +securitylake:CreateSubscriberNotification, +securitylake:GetSubscriber, +iam:CreateServiceLinkedRole, +iam:PutRolePolicy, +iam:DeleteRolePolicy, +iam:PassRole, +s3:PutBucketNotification, +s3:GetBucketNotification, +events:CreateApiDestination, +events:CreateConnection, +events:CreateRule, +events:UpdateConnection, +events:DeleteConnection, +events:UpdateApiDestination, +events:DeleteApiDestination, +events:ListApiDestinations, +events:ListConnections, +events:PutRule, +events:DescribeRule, +events:DeleteRule, +events:PutTargets, +events:RemoveTargets, +events:ListTargetsByRule, +secretsmanager:CreateSecret, +sqs:CreateQueue, +sqs:GetQueueAttributes, +sqs:GetQueueUrl, +sqs:SetQueueAttributes +``` + +### Read +```json +securitylake:GetSubscriber +``` + +### Update +```json +securitylake:UpdateSubscriberNotification, +securitylake:GetSubscriber, +iam:CreateServiceLinkedRole, +iam:PutRolePolicy, +iam:DeleteRolePolicy, +iam:PassRole, +events:CreateApiDestination, +events:CreateConnection, +events:UpdateConnection, +events:DeleteConnection, +events:UpdateApiDestination, +events:DeleteApiDestination, +events:DeleteRule, +events:ListApiDestinations, +events:ListConnections, +events:PutRule, +events:DescribeRule, +events:DeleteRule, +events:PutTargets, +events:RemoveTargets, +events:ListTargetsByRule, +secretsmanager:CreateSecret, +s3:GetBucketNotificationConfiguration, +s3:PutBucketNotificationConfiguration, +s3:PutBucketNotification, +s3:GetBucketNotification, +sqs:CreateQueue, +sqs:DeleteQueue, +sqs:GetQueueAttributes, +sqs:SetQueueAttributes +``` + +### Delete +```json +securitylake:DeleteSubscriberNotification, +securitylake:GetSubscriber, +iam:DeleteRole, +iam:DeleteRolePolicy, +events:DeleteApiDestination, +events:DeleteConnection, +events:DeleteRule, +events:ListTargetsByRule, +events:DescribeRule, +events:RemoveTargets, +sqs:DeleteQueue +``` + +### List +```json +securitylake:ListSubscribers +``` diff --git a/website/docs/services/securitylake/subscriber_notifications_list_only/index.md b/website/docs/services/securitylake/subscriber_notifications_list_only/index.md new file mode 100644 index 0000000..3a1b012 --- /dev/null +++ b/website/docs/services/securitylake/subscriber_notifications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: subscriber_notifications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subscriber_notifications_list_only + - securitylake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subscriber_notifications in a region or regions, for all properties use subscriber_notifications + +## Overview + + + + + + + +
Namesubscriber_notifications_list_only
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::SubscriberNotification
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN for the subscriber
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subscriber_notifications in a region. +```sql +SELECT +region, +subscriber_arn +FROM aws.securitylake.subscriber_notifications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subscriber_notifications_list_only resource, see subscriber_notifications + diff --git a/website/docs/services/securitylake/subscriber_tags/index.md b/website/docs/services/securitylake/subscriber_tags/index.md new file mode 100644 index 0000000..c8e0c30 --- /dev/null +++ b/website/docs/services/securitylake/subscriber_tags/index.md @@ -0,0 +1,97 @@ +--- +title: subscriber_tags +hide_title: false +hide_table_of_contents: false +keywords: + - subscriber_tags + - securitylake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for subscribers in a region + +## Overview + + + + + + + +
Namesubscriber_tags
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::Subscriber
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon S3 or AWS Lake Formation access type.
stringThe ARN for the data lake.
objectThe AWS identity used to access your data.
stringThe name of your Security Lake subscriber account.
stringThe description for your subscriber account in Security Lake.
arrayThe supported AWS services from which logs and events are collected.
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all subscribers in a region. +```sql +SELECT +region, +access_types, +data_lake_arn, +subscriber_identity, +subscriber_name, +subscriber_description, +sources, +resource_share_arn, +resource_share_name, +subscriber_role_arn, +s3_bucket_arn, +subscriber_arn, +tag_key, +tag_value +FROM aws.securitylake.subscriber_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subscriber_tags resource, see subscribers + diff --git a/website/docs/services/securitylake/subscribers/index.md b/website/docs/services/securitylake/subscribers/index.md new file mode 100644 index 0000000..2321e53 --- /dev/null +++ b/website/docs/services/securitylake/subscribers/index.md @@ -0,0 +1,339 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a subscriber resource or lists subscribers in a region + +## Overview + + + + + + + +
Namesubscribers
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::Subscriber
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon S3 or AWS Lake Formation access type.
stringThe ARN for the data lake.
objectThe AWS identity used to access your data.
stringThe name of your Security Lake subscriber account.
stringThe description for your subscriber account in Security Lake.
arrayAn array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
arrayThe supported AWS services from which logs and events are collected.
string
string
string
string
string
stringAWS region.
+ +For more information, see AWS::SecurityLake::Subscriber. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all subscribers in a region. +```sql +SELECT +region, +access_types, +data_lake_arn, +subscriber_identity, +subscriber_name, +subscriber_description, +tags, +sources, +resource_share_arn, +resource_share_name, +subscriber_role_arn, +s3_bucket_arn, +subscriber_arn +FROM aws.securitylake.subscribers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual subscriber. +```sql +SELECT +region, +access_types, +data_lake_arn, +subscriber_identity, +subscriber_name, +subscriber_description, +tags, +sources, +resource_share_arn, +resource_share_name, +subscriber_role_arn, +s3_bucket_arn, +subscriber_arn +FROM aws.securitylake.subscribers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new subscriber resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.securitylake.subscribers ( + AccessTypes, + DataLakeArn, + SubscriberIdentity, + SubscriberName, + Sources, + region +) +SELECT +'{{ AccessTypes }}', + '{{ DataLakeArn }}', + '{{ SubscriberIdentity }}', + '{{ SubscriberName }}', + '{{ Sources }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.securitylake.subscribers ( + AccessTypes, + DataLakeArn, + SubscriberIdentity, + SubscriberName, + SubscriberDescription, + Tags, + Sources, + region +) +SELECT + '{{ AccessTypes }}', + '{{ DataLakeArn }}', + '{{ SubscriberIdentity }}', + '{{ SubscriberName }}', + '{{ SubscriberDescription }}', + '{{ Tags }}', + '{{ Sources }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: subscriber + props: + - name: AccessTypes + value: + - '{{ AccessTypes[0] }}' + - name: DataLakeArn + value: '{{ DataLakeArn }}' + - name: SubscriberIdentity + value: + ExternalId: '{{ ExternalId }}' + Principal: '{{ Principal }}' + - name: SubscriberName + value: '{{ SubscriberName }}' + - name: SubscriberDescription + value: '{{ SubscriberDescription }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Sources + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.securitylake.subscribers +WHERE data__Identifier = '' +AND 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:ListSubscribers, +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 +``` + +### 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 +``` + +### List +```json +securitylake:ListSubscribers +``` diff --git a/website/docs/services/securitylake/subscribers_list_only/index.md b/website/docs/services/securitylake/subscribers_list_only/index.md new file mode 100644 index 0000000..cf7294f --- /dev/null +++ b/website/docs/services/securitylake/subscribers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: subscribers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subscribers_list_only + - securitylake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subscribers in a region or regions, for all properties use subscribers + +## Overview + + + + + + + +
Namesubscribers_list_only
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::Subscriber
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subscribers in a region. +```sql +SELECT +region, +subscriber_arn +FROM aws.securitylake.subscribers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subscribers_list_only resource, see subscribers + diff --git a/website/docs/services/servicecatalog/cloud_formation_provisioned_products/index.md b/website/docs/services/servicecatalog/cloud_formation_provisioned_products/index.md new file mode 100644 index 0000000..b50e578 --- /dev/null +++ b/website/docs/services/servicecatalog/cloud_formation_provisioned_products/index.md @@ -0,0 +1,287 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a cloud_formation_provisioned_product resource or lists cloud_formation_provisioned_products in a region + +## Overview + + + + + + + +
Namecloud_formation_provisioned_products
TypeResource
DescriptionResource Schema for AWS::ServiceCatalog::CloudFormationProvisionedProduct
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
string
string
string
string
string
string
string
array
object
array
string
string
string
objectList of key-value pair outputs.
stringAWS region.
+ +For more information, see AWS::ServiceCatalog::CloudFormationProvisionedProduct. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual cloud_formation_provisioned_product. +```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_products +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cloud_formation_provisioned_product resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalog.cloud_formation_provisioned_products ( + AcceptLanguage, + NotificationArns, + PathId, + PathName, + ProductId, + ProductName, + ProvisionedProductName, + ProvisioningArtifactId, + ProvisioningArtifactName, + ProvisioningParameters, + ProvisioningPreferences, + Tags, + region +) +SELECT +'{{ AcceptLanguage }}', + '{{ NotificationArns }}', + '{{ PathId }}', + '{{ PathName }}', + '{{ ProductId }}', + '{{ ProductName }}', + '{{ ProvisionedProductName }}', + '{{ ProvisioningArtifactId }}', + '{{ ProvisioningArtifactName }}', + '{{ ProvisioningParameters }}', + '{{ ProvisioningPreferences }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalog.cloud_formation_provisioned_products ( + AcceptLanguage, + NotificationArns, + PathId, + PathName, + ProductId, + ProductName, + ProvisionedProductName, + ProvisioningArtifactId, + ProvisioningArtifactName, + ProvisioningParameters, + ProvisioningPreferences, + Tags, + region +) +SELECT + '{{ AcceptLanguage }}', + '{{ NotificationArns }}', + '{{ PathId }}', + '{{ PathName }}', + '{{ ProductId }}', + '{{ ProductName }}', + '{{ ProvisionedProductName }}', + '{{ ProvisioningArtifactId }}', + '{{ ProvisioningArtifactName }}', + '{{ ProvisioningParameters }}', + '{{ ProvisioningPreferences }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: cloud_formation_provisioned_product + props: + - name: AcceptLanguage + value: '{{ AcceptLanguage }}' + - name: NotificationArns + value: + - '{{ NotificationArns[0] }}' + - name: PathId + value: '{{ PathId }}' + - name: PathName + value: '{{ PathName }}' + - name: ProductId + value: '{{ ProductId }}' + - name: ProductName + value: '{{ ProductName }}' + - name: ProvisionedProductName + value: '{{ ProvisionedProductName }}' + - name: ProvisioningArtifactId + value: '{{ ProvisioningArtifactId }}' + - name: ProvisioningArtifactName + value: '{{ ProvisioningArtifactName }}' + - name: ProvisioningParameters + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ProvisioningPreferences + value: + StackSetAccounts: + - '{{ StackSetAccounts[0] }}' + StackSetFailureToleranceCount: '{{ StackSetFailureToleranceCount }}' + StackSetFailureTolerancePercentage: '{{ StackSetFailureTolerancePercentage }}' + StackSetMaxConcurrencyCount: '{{ StackSetMaxConcurrencyCount }}' + StackSetMaxConcurrencyPercentage: '{{ StackSetMaxConcurrencyPercentage }}' + StackSetOperationType: '{{ StackSetOperationType }}' + StackSetRegions: + - '{{ StackSetRegions[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.servicecatalog.cloud_formation_provisioned_products +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the cloud_formation_provisioned_products resource, the following permissions are required: + +### Create +```json +* +``` + +### Read +```json +* +``` + +### Update +```json +* +``` + +### Delete +```json +* +``` diff --git a/website/docs/services/servicecatalog/index.md b/website/docs/services/servicecatalog/index.md new file mode 100644 index 0000000..c1daf9e --- /dev/null +++ b/website/docs/services/servicecatalog/index.md @@ -0,0 +1,40 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The servicecatalog service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/servicecatalog/service_action_associations/index.md b/website/docs/services/servicecatalog/service_action_associations/index.md new file mode 100644 index 0000000..04e9f40 --- /dev/null +++ b/website/docs/services/servicecatalog/service_action_associations/index.md @@ -0,0 +1,204 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_action_association resource or lists service_action_associations in a region + +## Overview + + + + + + + +
Nameservice_action_associations
TypeResource
DescriptionResource Schema for AWS::ServiceCatalog::ServiceActionAssociation
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +For more information, see AWS::ServiceCatalog::ServiceActionAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all service_action_associations in a region. +```sql +SELECT +region, +product_id, +provisioning_artifact_id, +service_action_id +FROM aws.servicecatalog.service_action_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service_action_association. +```sql +SELECT +region, +product_id, +provisioning_artifact_id, +service_action_id +FROM aws.servicecatalog.service_action_associations +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_action_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalog.service_action_associations ( + ProductId, + ProvisioningArtifactId, + ServiceActionId, + region +) +SELECT +'{{ ProductId }}', + '{{ ProvisioningArtifactId }}', + '{{ ServiceActionId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalog.service_action_associations ( + ProductId, + ProvisioningArtifactId, + ServiceActionId, + region +) +SELECT + '{{ ProductId }}', + '{{ ProvisioningArtifactId }}', + '{{ ServiceActionId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_action_association + props: + - name: ProductId + value: '{{ ProductId }}' + - name: ProvisioningArtifactId + value: '{{ ProvisioningArtifactId }}' + - name: ServiceActionId + value: '{{ ServiceActionId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.servicecatalog.service_action_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the service_action_associations resource, the following permissions are required: + +### Create +```json +servicecatalog:AssociateServiceActionWithProvisioningArtifact, +servicecatalog:ListServiceActionsForProvisioningArtifact +``` + +### Read +```json +servicecatalog:ListServiceActionsForProvisioningArtifact +``` + +### Delete +```json +servicecatalog:DisassociateServiceActionFromProvisioningArtifact, +servicecatalog:ListServiceActionsForProvisioningArtifact +``` + +### List +```json +servicecatalog:ListServiceActionsForProvisioningArtifact +``` diff --git a/website/docs/services/servicecatalog/service_action_associations_list_only/index.md b/website/docs/services/servicecatalog/service_action_associations_list_only/index.md new file mode 100644 index 0000000..439bf4a --- /dev/null +++ b/website/docs/services/servicecatalog/service_action_associations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: service_action_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_action_associations_list_only + - servicecatalog + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_action_associations in a region or regions, for all properties use service_action_associations + +## Overview + + + + + + + +
Nameservice_action_associations_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalog::ServiceActionAssociation
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_action_associations in a region. +```sql +SELECT +region, +product_id, +provisioning_artifact_id, +service_action_id +FROM aws.servicecatalog.service_action_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_action_associations_list_only resource, see service_action_associations + diff --git a/website/docs/services/servicecatalog/service_actions/index.md b/website/docs/services/servicecatalog/service_actions/index.md new file mode 100644 index 0000000..9f70839 --- /dev/null +++ b/website/docs/services/servicecatalog/service_actions/index.md @@ -0,0 +1,235 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_action resource or lists service_actions in a region + +## Overview + + + + + + + +
Nameservice_actions
TypeResource
DescriptionResource Schema for AWS::ServiceCatalog::ServiceAction
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
string
stringAWS region.
+ +For more information, see AWS::ServiceCatalog::ServiceAction. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all service_actions in a region. +```sql +SELECT +region, +accept_language, +name, +definition_type, +definition, +description, +id +FROM aws.servicecatalog.service_actions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service_action. +```sql +SELECT +region, +accept_language, +name, +definition_type, +definition, +description, +id +FROM aws.servicecatalog.service_actions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalog.service_actions ( + Name, + DefinitionType, + Definition, + region +) +SELECT +'{{ Name }}', + '{{ DefinitionType }}', + '{{ Definition }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalog.service_actions ( + AcceptLanguage, + Name, + DefinitionType, + Definition, + Description, + region +) +SELECT + '{{ AcceptLanguage }}', + '{{ Name }}', + '{{ DefinitionType }}', + '{{ Definition }}', + '{{ Description }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_action + props: + - name: AcceptLanguage + value: '{{ AcceptLanguage }}' + - name: Name + value: '{{ Name }}' + - name: DefinitionType + value: '{{ DefinitionType }}' + - name: Definition + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Description + value: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.servicecatalog.service_actions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +servicecatalog:DescribeServiceAction +``` + +### Update +```json +servicecatalog:UpdateServiceAction, +iam:GetRole, +ssm:DescribeDocument +``` + +### Delete +```json +servicecatalog:DeleteServiceAction +``` + +### List +```json +servicecatalog:ListServiceActions +``` diff --git a/website/docs/services/servicecatalog/service_actions_list_only/index.md b/website/docs/services/servicecatalog/service_actions_list_only/index.md new file mode 100644 index 0000000..f4dc658 --- /dev/null +++ b/website/docs/services/servicecatalog/service_actions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: service_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_actions_list_only + - servicecatalog + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_actions in a region or regions, for all properties use service_actions + +## Overview + + + + + + + +
Nameservice_actions_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalog::ServiceAction
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_actions in a region. +```sql +SELECT +region, +id +FROM aws.servicecatalog.service_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_actions_list_only resource, see service_actions + diff --git a/website/docs/services/servicecatalogappregistry/application_tags/index.md b/website/docs/services/servicecatalogappregistry/application_tags/index.md new file mode 100644 index 0000000..98b2e12 --- /dev/null +++ b/website/docs/services/servicecatalogappregistry/application_tags/index.md @@ -0,0 +1,89 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - servicecatalogappregistry + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::Application
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe name of the application.
stringThe description of the application.
stringThe key of the AWS application tag, which is awsApplication. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.
stringThe value of the AWS application tag, which is the identifier of an associated resource. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.
stringThe name of the application.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +id, +arn, +name, +description, +application_tag_key, +application_tag_value, +application_name, +tag_key, +tag_value +FROM aws.servicecatalogappregistry.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/servicecatalogappregistry/applications/index.md b/website/docs/services/servicecatalogappregistry/applications/index.md new file mode 100644 index 0000000..93226cc --- /dev/null +++ b/website/docs/services/servicecatalogappregistry/applications/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::Application
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe name of the application.
stringThe description of the application.
object
stringThe key of the AWS application tag, which is awsApplication. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.
stringThe value of the AWS application tag, which is the identifier of an associated resource. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.
stringThe name of the application.
stringAWS region.
+ +For more information, see AWS::ServiceCatalogAppRegistry::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +id, +arn, +name, +description, +tags, +application_tag_key, +application_tag_value, +application_name +FROM aws.servicecatalogappregistry.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +id, +arn, +name, +description, +tags, +application_tag_key, +application_tag_value, +application_name +FROM aws.servicecatalogappregistry.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalogappregistry.applications ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalogappregistry.applications ( + Name, + Description, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.servicecatalogappregistry.applications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +servicecatalog:CreateApplication, +servicecatalog:TagResource, +iam:CreateServiceLinkedRole +``` + +### Read +```json +servicecatalog:GetApplication +``` + +### Update +```json +servicecatalog:GetApplication, +servicecatalog:ListTagsForResource, +servicecatalog:TagResource, +servicecatalog:UntagResource, +servicecatalog:UpdateApplication, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +servicecatalog:DeleteApplication +``` + +### List +```json +servicecatalog:ListApplications +``` diff --git a/website/docs/services/servicecatalogappregistry/applications_list_only/index.md b/website/docs/services/servicecatalogappregistry/applications_list_only/index.md new file mode 100644 index 0000000..da99627 --- /dev/null +++ b/website/docs/services/servicecatalogappregistry/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - servicecatalogappregistry + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::Application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +id +FROM aws.servicecatalogappregistry.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/servicecatalogappregistry/attribute_group_associations/index.md b/website/docs/services/servicecatalogappregistry/attribute_group_associations/index.md new file mode 100644 index 0000000..fa76be9 --- /dev/null +++ b/website/docs/services/servicecatalogappregistry/attribute_group_associations/index.md @@ -0,0 +1,199 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an attribute_group_association resource or lists attribute_group_associations in a region + +## Overview + + + + + + + +
Nameattribute_group_associations
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name or the Id of the Application.
stringThe name or the Id of the AttributeGroup.
string
string
stringAWS region.
+ +For more information, see AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all attribute_group_associations in a region. +```sql +SELECT +region, +application, +attribute_group, +application_arn, +attribute_group_arn +FROM aws.servicecatalogappregistry.attribute_group_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual attribute_group_association. +```sql +SELECT +region, +application, +attribute_group, +application_arn, +attribute_group_arn +FROM aws.servicecatalogappregistry.attribute_group_associations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new attribute_group_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalogappregistry.attribute_group_associations ( + Application, + AttributeGroup, + region +) +SELECT +'{{ Application }}', + '{{ AttributeGroup }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalogappregistry.attribute_group_associations ( + Application, + AttributeGroup, + region +) +SELECT + '{{ Application }}', + '{{ AttributeGroup }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: attribute_group_association + props: + - name: Application + value: '{{ Application }}' + - name: AttributeGroup + value: '{{ AttributeGroup }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.servicecatalogappregistry.attribute_group_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the attribute_group_associations resource, the following permissions are required: + +### Create +```json +servicecatalog:AssociateAttributeGroup +``` + +### Read +```json +servicecatalog:ListAttributeGroupsForApplication +``` + +### Delete +```json +servicecatalog:DisassociateAttributeGroup +``` + +### List +```json +servicecatalog:ListAttributeGroupsForApplication +``` diff --git a/website/docs/services/servicecatalogappregistry/attribute_group_associations_list_only/index.md b/website/docs/services/servicecatalogappregistry/attribute_group_associations_list_only/index.md new file mode 100644 index 0000000..3d71ba3 --- /dev/null +++ b/website/docs/services/servicecatalogappregistry/attribute_group_associations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: attribute_group_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - attribute_group_associations_list_only + - servicecatalogappregistry + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists attribute_group_associations in a region or regions, for all properties use attribute_group_associations + +## Overview + + + + + + + +
Nameattribute_group_associations_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name or the Id of the Application.
stringThe name or the Id of the AttributeGroup.
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all attribute_group_associations in a region. +```sql +SELECT +region, +application_arn, +attribute_group_arn +FROM aws.servicecatalogappregistry.attribute_group_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the attribute_group_associations_list_only resource, see attribute_group_associations + diff --git a/website/docs/services/servicecatalogappregistry/attribute_group_tags/index.md b/website/docs/services/servicecatalogappregistry/attribute_group_tags/index.md new file mode 100644 index 0000000..301a580 --- /dev/null +++ b/website/docs/services/servicecatalogappregistry/attribute_group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: attribute_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - attribute_group_tags + - servicecatalogappregistry + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for attribute_groups in a region + +## Overview + + + + + + + +
Nameattribute_group_tags
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe name of the attribute group.
stringThe description of the attribute group.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all attribute_groups in a region. +```sql +SELECT +region, +id, +arn, +name, +description, +attributes, +tag_key, +tag_value +FROM aws.servicecatalogappregistry.attribute_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the attribute_group_tags resource, see attribute_groups + diff --git a/website/docs/services/servicecatalogappregistry/attribute_groups/index.md b/website/docs/services/servicecatalogappregistry/attribute_groups/index.md new file mode 100644 index 0000000..3607a65 --- /dev/null +++ b/website/docs/services/servicecatalogappregistry/attribute_groups/index.md @@ -0,0 +1,228 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an attribute_group resource or lists attribute_groups in a region + +## Overview + + + + + + + +
Nameattribute_groups
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe name of the attribute group.
stringThe description of the attribute group.
object
object
stringAWS region.
+ +For more information, see AWS::ServiceCatalogAppRegistry::AttributeGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all attribute_groups in a region. +```sql +SELECT +region, +id, +arn, +name, +description, +attributes, +tags +FROM aws.servicecatalogappregistry.attribute_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual attribute_group. +```sql +SELECT +region, +id, +arn, +name, +description, +attributes, +tags +FROM aws.servicecatalogappregistry.attribute_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new attribute_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalogappregistry.attribute_groups ( + Name, + Attributes, + region +) +SELECT +'{{ Name }}', + '{{ Attributes }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalogappregistry.attribute_groups ( + Name, + Description, + Attributes, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ Attributes }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: attribute_group + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: Attributes + value: {} + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.servicecatalogappregistry.attribute_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the attribute_groups resource, the following permissions are required: + +### Create +```json +servicecatalog:CreateAttributeGroup, +servicecatalog:TagResource +``` + +### Read +```json +servicecatalog:GetAttributeGroup +``` + +### Update +```json +servicecatalog:GetAttributeGroup, +servicecatalog:UpdateAttributeGroup, +servicecatalog:ListTagsForResource, +servicecatalog:TagResource, +servicecatalog:UntagResource +``` + +### Delete +```json +servicecatalog:DeleteAttributeGroup +``` + +### List +```json +servicecatalog:ListAttributeGroups +``` diff --git a/website/docs/services/servicecatalogappregistry/attribute_groups_list_only/index.md b/website/docs/services/servicecatalogappregistry/attribute_groups_list_only/index.md new file mode 100644 index 0000000..607b6e8 --- /dev/null +++ b/website/docs/services/servicecatalogappregistry/attribute_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: attribute_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - attribute_groups_list_only + - servicecatalogappregistry + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists attribute_groups in a region or regions, for all properties use attribute_groups + +## Overview + + + + + + + +
Nameattribute_groups_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all attribute_groups in a region. +```sql +SELECT +region, +id +FROM aws.servicecatalogappregistry.attribute_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the attribute_groups_list_only resource, see attribute_groups + diff --git a/website/docs/services/servicecatalogappregistry/index.md b/website/docs/services/servicecatalogappregistry/index.md new file mode 100644 index 0000000..9b19557 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The servicecatalogappregistry service documentation. + +:::info Service Summary + +
+
+total resources: 10
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/servicecatalogappregistry/resource_associations/index.md b/website/docs/services/servicecatalogappregistry/resource_associations/index.md new file mode 100644 index 0000000..5e2c7aa --- /dev/null +++ b/website/docs/services/servicecatalogappregistry/resource_associations/index.md @@ -0,0 +1,209 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_association resource or lists resource_associations in a region + +## Overview + + + + + + + +
Nameresource_associations
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name or the Id of the Application.
stringThe name or the Id of the Resource.
stringThe type of the CFN Resource for now it's enum CFN_STACK.
string
string
stringAWS region.
+ +For more information, see AWS::ServiceCatalogAppRegistry::ResourceAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_associations in a region. +```sql +SELECT +region, +application, +resource, +resource_type, +application_arn, +resource_arn +FROM aws.servicecatalogappregistry.resource_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_association. +```sql +SELECT +region, +application, +resource, +resource_type, +application_arn, +resource_arn +FROM aws.servicecatalogappregistry.resource_associations +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalogappregistry.resource_associations ( + Application, + Resource, + ResourceType, + region +) +SELECT +'{{ Application }}', + '{{ Resource }}', + '{{ ResourceType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.servicecatalogappregistry.resource_associations ( + Application, + Resource, + ResourceType, + region +) +SELECT + '{{ Application }}', + '{{ Resource }}', + '{{ ResourceType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_association + props: + - name: Application + value: '{{ Application }}' + - name: Resource + value: '{{ Resource }}' + - name: ResourceType + value: '{{ ResourceType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.servicecatalogappregistry.resource_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_associations resource, the following permissions are required: + +### Create +```json +servicecatalog:AssociateResource, +cloudformation:DescribeStacks +``` + +### Read +```json +servicecatalog:ListAssociatedResources +``` + +### Delete +```json +servicecatalog:DisassociateResource +``` + +### List +```json +servicecatalog:ListAssociatedResources +``` diff --git a/website/docs/services/servicecatalogappregistry/resource_associations_list_only/index.md b/website/docs/services/servicecatalogappregistry/resource_associations_list_only/index.md new file mode 100644 index 0000000..f296185 --- /dev/null +++ b/website/docs/services/servicecatalogappregistry/resource_associations_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: resource_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_associations_list_only + - servicecatalogappregistry + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_associations in a region or regions, for all properties use resource_associations + +## Overview + + + + + + + +
Nameresource_associations_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name or the Id of the Application.
stringThe name or the Id of the Resource.
stringThe type of the CFN Resource for now it's enum CFN_STACK.
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_associations in a region. +```sql +SELECT +region, +application_arn, +resource_arn, +resource_type +FROM aws.servicecatalogappregistry.resource_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_associations_list_only resource, see resource_associations + diff --git a/website/docs/services/ses/configuration_set_event_destinations/index.md b/website/docs/services/ses/configuration_set_event_destinations/index.md new file mode 100644 index 0000000..e86c0ca --- /dev/null +++ b/website/docs/services/ses/configuration_set_event_destinations/index.md @@ -0,0 +1,207 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configuration_set_event_destination resource or lists configuration_set_event_destinations in a region + +## Overview + + + + + + + +
Nameconfiguration_set_event_destinations
TypeResource
DescriptionResource Type definition for AWS::SES::ConfigurationSetEventDestination
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringThe name of the configuration set that contains the event destination.
objectThe event destination object.
stringAWS region.
+ +For more information, see AWS::SES::ConfigurationSetEventDestination. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual configuration_set_event_destination. +```sql +SELECT +region, +id, +configuration_set_name, +event_destination +FROM aws.ses.configuration_set_event_destinations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configuration_set_event_destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.configuration_set_event_destinations ( + ConfigurationSetName, + EventDestination, + region +) +SELECT +'{{ ConfigurationSetName }}', + '{{ EventDestination }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.configuration_set_event_destinations ( + ConfigurationSetName, + EventDestination, + region +) +SELECT + '{{ ConfigurationSetName }}', + '{{ EventDestination }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configuration_set_event_destination + props: + - name: ConfigurationSetName + value: '{{ ConfigurationSetName }}' + - name: EventDestination + value: + Name: '{{ Name }}' + Enabled: '{{ Enabled }}' + MatchingEventTypes: + - '{{ MatchingEventTypes[0] }}' + CloudWatchDestination: + DimensionConfigurations: + - DimensionValueSource: '{{ DimensionValueSource }}' + DefaultDimensionValue: '{{ DefaultDimensionValue }}' + DimensionName: '{{ DimensionName }}' + KinesisFirehoseDestination: + IAMRoleARN: '{{ IAMRoleARN }}' + DeliveryStreamARN: '{{ DeliveryStreamARN }}' + SnsDestination: + TopicARN: '{{ TopicARN }}' + EventBridgeDestination: + EventBusArn: '{{ EventBusArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.configuration_set_event_destinations +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +ses:UpdateConfigurationSetEventDestination, +ses:GetConfigurationSetEventDestinations +``` + +### Delete +```json +ses:DeleteConfigurationSetEventDestination +``` + +### Read +```json +ses:GetConfigurationSetEventDestinations, +ses:DescribeConfigurationSet +``` diff --git a/website/docs/services/ses/configuration_sets/index.md b/website/docs/services/ses/configuration_sets/index.md new file mode 100644 index 0000000..61d70dd --- /dev/null +++ b/website/docs/services/ses/configuration_sets/index.md @@ -0,0 +1,267 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configuration_set resource or lists configuration_sets in a region + +## Overview + + + + + + + +
Nameconfiguration_sets
TypeResource
DescriptionResource schema for AWS::SES::ConfigurationSet.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the configuration set.
objectAn object that defines the open and click tracking options for emails that you send using the configuration set.
objectAn object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
objectAn object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
objectAn object that defines whether or not Amazon SES can send email that you send using the configuration set.
objectAn object that contains information about the suppression list preferences for your account.
objectAn object that contains Virtual Deliverability Manager (VDM) settings for this configuration set.
stringAWS region.
+ +For more information, see AWS::SES::ConfigurationSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configuration_sets in a region. +```sql +SELECT +region, +name, +tracking_options, +delivery_options, +reputation_options, +sending_options, +suppression_options, +vdm_options +FROM aws.ses.configuration_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual configuration_set. +```sql +SELECT +region, +name, +tracking_options, +delivery_options, +reputation_options, +sending_options, +suppression_options, +vdm_options +FROM aws.ses.configuration_sets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configuration_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.configuration_sets ( + Name, + TrackingOptions, + DeliveryOptions, + ReputationOptions, + SendingOptions, + SuppressionOptions, + VdmOptions, + region +) +SELECT +'{{ Name }}', + '{{ TrackingOptions }}', + '{{ DeliveryOptions }}', + '{{ ReputationOptions }}', + '{{ SendingOptions }}', + '{{ SuppressionOptions }}', + '{{ VdmOptions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.configuration_sets ( + Name, + TrackingOptions, + DeliveryOptions, + ReputationOptions, + SendingOptions, + SuppressionOptions, + VdmOptions, + region +) +SELECT + '{{ Name }}', + '{{ TrackingOptions }}', + '{{ DeliveryOptions }}', + '{{ ReputationOptions }}', + '{{ SendingOptions }}', + '{{ SuppressionOptions }}', + '{{ VdmOptions }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configuration_set + props: + - name: Name + value: '{{ Name }}' + - name: TrackingOptions + value: + CustomRedirectDomain: '{{ CustomRedirectDomain }}' + HttpsPolicy: '{{ HttpsPolicy }}' + - name: DeliveryOptions + value: + TlsPolicy: '{{ TlsPolicy }}' + SendingPoolName: '{{ SendingPoolName }}' + MaxDeliverySeconds: null + - name: ReputationOptions + value: + ReputationMetricsEnabled: '{{ ReputationMetricsEnabled }}' + - name: SendingOptions + value: + SendingEnabled: '{{ SendingEnabled }}' + - name: SuppressionOptions + value: + SuppressedReasons: + - '{{ SuppressedReasons[0] }}' + - name: VdmOptions + value: + DashboardOptions: + EngagementMetrics: '{{ EngagementMetrics }}' + GuardianOptions: + OptimizedSharedDelivery: '{{ OptimizedSharedDelivery }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.configuration_sets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the configuration_sets resource, the following permissions are required: + +### Create +```json +ses:CreateConfigurationSet +``` + +### Read +```json +ses:GetConfigurationSet, +ses:DescribeConfigurationSet +``` + +### Update +```json +ses:PutConfigurationSetTrackingOptions, +ses:PutConfigurationSetDeliveryOptions, +ses:PutConfigurationSetReputationOptions, +ses:PutConfigurationSetSendingOptions, +ses:PutConfigurationSetSuppressionOptions, +ses:PutConfigurationSetVdmOptions +``` + +### Delete +```json +ses:DeleteConfigurationSet +``` + +### List +```json +ses:ListConfigurationSets +``` diff --git a/website/docs/services/ses/configuration_sets_list_only/index.md b/website/docs/services/ses/configuration_sets_list_only/index.md new file mode 100644 index 0000000..563d615 --- /dev/null +++ b/website/docs/services/ses/configuration_sets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: configuration_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_sets_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_sets in a region or regions, for all properties use configuration_sets + +## Overview + + + + + + + +
Nameconfiguration_sets_list_only
TypeResource
DescriptionResource schema for AWS::SES::ConfigurationSet.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the configuration set.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_sets in a region. +```sql +SELECT +region, +name +FROM aws.ses.configuration_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_sets_list_only resource, see configuration_sets + diff --git a/website/docs/services/ses/contact_list_tags/index.md b/website/docs/services/ses/contact_list_tags/index.md new file mode 100644 index 0000000..aea1b4b --- /dev/null +++ b/website/docs/services/ses/contact_list_tags/index.md @@ -0,0 +1,81 @@ +--- +title: contact_list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - contact_list_tags + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for contact_lists in a region + +## Overview + + + + + + + +
Namecontact_list_tags
TypeResource
DescriptionResource schema for AWS::SES::ContactList.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the contact list.
stringThe description of the contact list.
arrayThe topics associated with the contact list.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all contact_lists in a region. +```sql +SELECT +region, +contact_list_name, +description, +topics, +tag_key, +tag_value +FROM aws.ses.contact_list_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_list_tags resource, see contact_lists + diff --git a/website/docs/services/ses/contact_lists/index.md b/website/docs/services/ses/contact_lists/index.md new file mode 100644 index 0000000..bbaa88a --- /dev/null +++ b/website/docs/services/ses/contact_lists/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a contact_list resource or lists contact_lists in a region + +## Overview + + + + + + + +
Namecontact_lists
TypeResource
DescriptionResource schema for AWS::SES::ContactList.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the contact list.
stringThe description of the contact list.
arrayThe topics associated with the contact list.
arrayThe tags (keys and values) associated with the contact list.
stringAWS region.
+ +For more information, see AWS::SES::ContactList. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all contact_lists in a region. +```sql +SELECT +region, +contact_list_name, +description, +topics, +tags +FROM aws.ses.contact_lists +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual contact_list. +```sql +SELECT +region, +contact_list_name, +description, +topics, +tags +FROM aws.ses.contact_lists +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new contact_list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.contact_lists ( + ContactListName, + Description, + Topics, + Tags, + region +) +SELECT +'{{ ContactListName }}', + '{{ Description }}', + '{{ Topics }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.contact_lists ( + ContactListName, + Description, + Topics, + Tags, + region +) +SELECT + '{{ ContactListName }}', + '{{ Description }}', + '{{ Topics }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: contact_list + props: + - name: ContactListName + value: '{{ ContactListName }}' + - name: Description + value: '{{ Description }}' + - name: Topics + value: + - TopicName: '{{ TopicName }}' + DisplayName: '{{ DisplayName }}' + Description: '{{ Description }}' + DefaultSubscriptionStatus: '{{ DefaultSubscriptionStatus }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.contact_lists +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the contact_lists resource, the following permissions are required: + +### Create +```json +ses:CreateContactList +``` + +### Read +```json +ses:GetContactList +``` + +### Update +```json +ses:UpdateContactList, +ses:UntagResource, +ses:TagResource +``` + +### Delete +```json +ses:DeleteContactList +``` + +### List +```json +ses:ListContactLists +``` diff --git a/website/docs/services/ses/contact_lists_list_only/index.md b/website/docs/services/ses/contact_lists_list_only/index.md new file mode 100644 index 0000000..86bb7ad --- /dev/null +++ b/website/docs/services/ses/contact_lists_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: contact_lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - contact_lists_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists contact_lists in a region or regions, for all properties use contact_lists + +## Overview + + + + + + + +
Namecontact_lists_list_only
TypeResource
DescriptionResource schema for AWS::SES::ContactList.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the contact list.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all contact_lists in a region. +```sql +SELECT +region, +contact_list_name +FROM aws.ses.contact_lists_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_lists_list_only resource, see contact_lists + diff --git a/website/docs/services/ses/dedicated_ip_pools/index.md b/website/docs/services/ses/dedicated_ip_pools/index.md new file mode 100644 index 0000000..e8d9830 --- /dev/null +++ b/website/docs/services/ses/dedicated_ip_pools/index.md @@ -0,0 +1,207 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a dedicated_ip_pool resource or lists dedicated_ip_pools in a region + +## Overview + + + + + + + +
Namededicated_ip_pools
TypeResource
DescriptionResource Type definition for AWS::SES::DedicatedIpPool
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the dedicated IP pool.
stringSpecifies whether the dedicated IP pool is managed or not. The default value is STANDARD.
stringAWS region.
+ +For more information, see AWS::SES::DedicatedIpPool. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all dedicated_ip_pools in a region. +```sql +SELECT +region, +pool_name, +scaling_mode +FROM aws.ses.dedicated_ip_pools +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual dedicated_ip_pool. +```sql +SELECT +region, +pool_name, +scaling_mode +FROM aws.ses.dedicated_ip_pools +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dedicated_ip_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.dedicated_ip_pools ( + PoolName, + ScalingMode, + region +) +SELECT +'{{ PoolName }}', + '{{ ScalingMode }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.dedicated_ip_pools ( + PoolName, + ScalingMode, + region +) +SELECT + '{{ PoolName }}', + '{{ ScalingMode }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: dedicated_ip_pool + props: + - name: PoolName + value: '{{ PoolName }}' + - name: ScalingMode + value: '{{ ScalingMode }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.dedicated_ip_pools +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ses:GetDedicatedIpPool, +ses:GetDedicatedIps +``` + +### Update +```json +ses:PutDedicatedIpPoolScalingAttributes, +ses:GetDedicatedIpPool +``` + +### Delete +```json +ses:DeleteDedicatedIpPool +``` + +### List +```json +ses:ListDedicatedIpPools +``` diff --git a/website/docs/services/ses/dedicated_ip_pools_list_only/index.md b/website/docs/services/ses/dedicated_ip_pools_list_only/index.md new file mode 100644 index 0000000..3c662ef --- /dev/null +++ b/website/docs/services/ses/dedicated_ip_pools_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dedicated_ip_pools_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dedicated_ip_pools_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dedicated_ip_pools in a region or regions, for all properties use dedicated_ip_pools + +## Overview + + + + + + + +
Namededicated_ip_pools_list_only
TypeResource
DescriptionResource Type definition for AWS::SES::DedicatedIpPool
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the dedicated IP pool.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dedicated_ip_pools in a region. +```sql +SELECT +region, +pool_name +FROM aws.ses.dedicated_ip_pools_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dedicated_ip_pools_list_only resource, see dedicated_ip_pools + diff --git a/website/docs/services/ses/email_identities/index.md b/website/docs/services/ses/email_identities/index.md new file mode 100644 index 0000000..8b50208 --- /dev/null +++ b/website/docs/services/ses/email_identities/index.md @@ -0,0 +1,264 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an email_identity resource or lists email_identities in a region + +## Overview + + + + + + + +
Nameemail_identities
TypeResource
DescriptionResource Type definition for AWS::SES::EmailIdentity
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe email address or domain to verify.
objectUsed to associate a configuration set with an email identity.
objectIf your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.
objectUsed to enable or disable DKIM authentication for an email identity.
objectUsed to enable or disable the custom Mail-From domain configuration for an email identity.
objectUsed to enable or disable feedback forwarding for an identity.
string
string
string
string
string
string
stringAWS region.
+ +For more information, see AWS::SES::EmailIdentity. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all email_identities in a region. +```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_identities +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual email_identity. +```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_identities +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new email_identity resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.email_identities ( + EmailIdentity, + region +) +SELECT +'{{ EmailIdentity }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.email_identities ( + EmailIdentity, + ConfigurationSetAttributes, + DkimSigningAttributes, + DkimAttributes, + MailFromAttributes, + FeedbackAttributes, + region +) +SELECT + '{{ EmailIdentity }}', + '{{ ConfigurationSetAttributes }}', + '{{ DkimSigningAttributes }}', + '{{ DkimAttributes }}', + '{{ MailFromAttributes }}', + '{{ FeedbackAttributes }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: email_identity + props: + - name: EmailIdentity + value: '{{ EmailIdentity }}' + - name: ConfigurationSetAttributes + value: + ConfigurationSetName: '{{ ConfigurationSetName }}' + - name: DkimSigningAttributes + value: + DomainSigningSelector: '{{ DomainSigningSelector }}' + DomainSigningPrivateKey: '{{ DomainSigningPrivateKey }}' + NextSigningKeyLength: '{{ NextSigningKeyLength }}' + - name: DkimAttributes + value: + SigningEnabled: '{{ SigningEnabled }}' + - name: MailFromAttributes + value: + MailFromDomain: '{{ MailFromDomain }}' + BehaviorOnMxFailure: '{{ BehaviorOnMxFailure }}' + - name: FeedbackAttributes + value: + EmailForwardingEnabled: '{{ EmailForwardingEnabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.email_identities +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ses:GetEmailIdentity +``` + +### Update +```json +ses:PutEmailIdentityMailFromAttributes, +ses:PutEmailIdentityFeedbackAttributes, +ses:PutEmailIdentityConfigurationSetAttributes, +ses:PutEmailIdentityDkimSigningAttributes, +ses:PutEmailIdentityDkimAttributes, +ses:GetEmailIdentity +``` + +### Delete +```json +ses:DeleteEmailIdentity +``` + +### List +```json +ses:ListEmailIdentities +``` diff --git a/website/docs/services/ses/email_identities_list_only/index.md b/website/docs/services/ses/email_identities_list_only/index.md new file mode 100644 index 0000000..0e2185d --- /dev/null +++ b/website/docs/services/ses/email_identities_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: email_identities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - email_identities_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists email_identities in a region or regions, for all properties use email_identities + +## Overview + + + + + + + +
Nameemail_identities_list_only
TypeResource
DescriptionResource Type definition for AWS::SES::EmailIdentity
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe email address or domain to verify.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all email_identities in a region. +```sql +SELECT +region, +email_identity +FROM aws.ses.email_identities_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the email_identities_list_only resource, see email_identities + diff --git a/website/docs/services/ses/index.md b/website/docs/services/ses/index.md new file mode 100644 index 0000000..fec7704 --- /dev/null +++ b/website/docs/services/ses/index.md @@ -0,0 +1,69 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The ses service documentation. + +:::info Service Summary + +
+
+total resources: 34
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/ses/mail_manager_addon_instance_tags/index.md b/website/docs/services/ses/mail_manager_addon_instance_tags/index.md new file mode 100644 index 0000000..d142ad5 --- /dev/null +++ b/website/docs/services/ses/mail_manager_addon_instance_tags/index.md @@ -0,0 +1,83 @@ +--- +title: mail_manager_addon_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_addon_instance_tags + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mail_manager_addon_instances in a region + +## Overview + + + + + + + +
Namemail_manager_addon_instance_tags
TypeResource
DescriptionDefinition of AWS::SES::MailManagerAddonInstance Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mail_manager_addon_instances in a region. +```sql +SELECT +region, +addon_instance_arn, +addon_instance_id, +addon_name, +addon_subscription_id, +tag_key, +tag_value +FROM aws.ses.mail_manager_addon_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_addon_instance_tags resource, see mail_manager_addon_instances + diff --git a/website/docs/services/ses/mail_manager_addon_instances/index.md b/website/docs/services/ses/mail_manager_addon_instances/index.md new file mode 100644 index 0000000..899c18d --- /dev/null +++ b/website/docs/services/ses/mail_manager_addon_instances/index.md @@ -0,0 +1,220 @@ +--- +title: mail_manager_addon_instances +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_addon_instances + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mail_manager_addon_instance resource or lists mail_manager_addon_instances in a region + +## Overview + + + + + + + +
Namemail_manager_addon_instances
TypeResource
DescriptionDefinition of AWS::SES::MailManagerAddonInstance Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::SES::MailManagerAddonInstance. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mail_manager_addon_instances in a region. +```sql +SELECT +region, +addon_instance_arn, +addon_instance_id, +addon_name, +addon_subscription_id, +tags +FROM aws.ses.mail_manager_addon_instances +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mail_manager_addon_instance. +```sql +SELECT +region, +addon_instance_arn, +addon_instance_id, +addon_name, +addon_subscription_id, +tags +FROM aws.ses.mail_manager_addon_instances +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mail_manager_addon_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_addon_instances ( + AddonSubscriptionId, + region +) +SELECT +'{{ AddonSubscriptionId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_addon_instances ( + AddonSubscriptionId, + Tags, + region +) +SELECT + '{{ AddonSubscriptionId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mail_manager_addon_instance + props: + - name: AddonSubscriptionId + value: '{{ AddonSubscriptionId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.mail_manager_addon_instances +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the mail_manager_addon_instances resource, the following permissions are required: + +### Create +```json +ses:TagResource, +ses:ListTagsForResource, +ses:GetAddonInstance, +ses:CreateAddonInstance +``` + +### Read +```json +ses:ListTagsForResource, +ses:GetAddonInstance +``` + +### Update +```json +ses:TagResource, +ses:UntagResource, +ses:ListTagsForResource, +ses:GetAddonInstance +``` + +### Delete +```json +ses:GetAddonInstance, +ses:DeleteAddonInstance +``` + +### List +```json +ses:ListAddonInstances +``` diff --git a/website/docs/services/ses/mail_manager_addon_instances_list_only/index.md b/website/docs/services/ses/mail_manager_addon_instances_list_only/index.md new file mode 100644 index 0000000..93b0cb6 --- /dev/null +++ b/website/docs/services/ses/mail_manager_addon_instances_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: mail_manager_addon_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_addon_instances_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mail_manager_addon_instances in a region or regions, for all properties use mail_manager_addon_instances + +## Overview + + + + + + + +
Namemail_manager_addon_instances_list_only
TypeResource
DescriptionDefinition of AWS::SES::MailManagerAddonInstance Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mail_manager_addon_instances in a region. +```sql +SELECT +region, +addon_instance_id +FROM aws.ses.mail_manager_addon_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_addon_instances_list_only resource, see mail_manager_addon_instances + diff --git a/website/docs/services/ses/mail_manager_addon_subscription_tags/index.md b/website/docs/services/ses/mail_manager_addon_subscription_tags/index.md new file mode 100644 index 0000000..705383b --- /dev/null +++ b/website/docs/services/ses/mail_manager_addon_subscription_tags/index.md @@ -0,0 +1,81 @@ +--- +title: mail_manager_addon_subscription_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_addon_subscription_tags + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mail_manager_addon_subscriptions in a region + +## Overview + + + + + + + +
Namemail_manager_addon_subscription_tags
TypeResource
DescriptionDefinition of AWS::SES::MailManagerAddonSubscription Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mail_manager_addon_subscriptions in a region. +```sql +SELECT +region, +addon_name, +addon_subscription_arn, +addon_subscription_id, +tag_key, +tag_value +FROM aws.ses.mail_manager_addon_subscription_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_addon_subscription_tags resource, see mail_manager_addon_subscriptions + diff --git a/website/docs/services/ses/mail_manager_addon_subscriptions/index.md b/website/docs/services/ses/mail_manager_addon_subscriptions/index.md new file mode 100644 index 0000000..c0d9493 --- /dev/null +++ b/website/docs/services/ses/mail_manager_addon_subscriptions/index.md @@ -0,0 +1,217 @@ +--- +title: mail_manager_addon_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_addon_subscriptions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mail_manager_addon_subscription resource or lists mail_manager_addon_subscriptions in a region + +## Overview + + + + + + + +
Namemail_manager_addon_subscriptions
TypeResource
DescriptionDefinition of AWS::SES::MailManagerAddonSubscription Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
array
stringAWS region.
+ +For more information, see AWS::SES::MailManagerAddonSubscription. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mail_manager_addon_subscriptions in a region. +```sql +SELECT +region, +addon_name, +addon_subscription_arn, +addon_subscription_id, +tags +FROM aws.ses.mail_manager_addon_subscriptions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mail_manager_addon_subscription. +```sql +SELECT +region, +addon_name, +addon_subscription_arn, +addon_subscription_id, +tags +FROM aws.ses.mail_manager_addon_subscriptions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mail_manager_addon_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_addon_subscriptions ( + AddonName, + region +) +SELECT +'{{ AddonName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_addon_subscriptions ( + AddonName, + Tags, + region +) +SELECT + '{{ AddonName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mail_manager_addon_subscription + props: + - name: AddonName + value: '{{ AddonName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.mail_manager_addon_subscriptions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the mail_manager_addon_subscriptions resource, the following permissions are required: + +### Create +```json +ses:TagResource, +ses:ListTagsForResource, +ses:GetAddonSubscription, +ses:CreateAddonSubscription +``` + +### Read +```json +ses:ListTagsForResource, +ses:GetAddonSubscription +``` + +### Update +```json +ses:TagResource, +ses:UntagResource, +ses:ListTagsForResource, +ses:GetAddonSubscription +``` + +### Delete +```json +ses:GetAddonSubscription, +ses:DeleteAddonSubscription +``` + +### List +```json +ses:ListAddonSubscriptions +``` diff --git a/website/docs/services/ses/mail_manager_addon_subscriptions_list_only/index.md b/website/docs/services/ses/mail_manager_addon_subscriptions_list_only/index.md new file mode 100644 index 0000000..822cca3 --- /dev/null +++ b/website/docs/services/ses/mail_manager_addon_subscriptions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: mail_manager_addon_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_addon_subscriptions_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mail_manager_addon_subscriptions in a region or regions, for all properties use mail_manager_addon_subscriptions + +## Overview + + + + + + + +
Namemail_manager_addon_subscriptions_list_only
TypeResource
DescriptionDefinition of AWS::SES::MailManagerAddonSubscription Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mail_manager_addon_subscriptions in a region. +```sql +SELECT +region, +addon_subscription_id +FROM aws.ses.mail_manager_addon_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_addon_subscriptions_list_only resource, see mail_manager_addon_subscriptions + diff --git a/website/docs/services/ses/mail_manager_archive_tags/index.md b/website/docs/services/ses/mail_manager_archive_tags/index.md new file mode 100644 index 0000000..4071325 --- /dev/null +++ b/website/docs/services/ses/mail_manager_archive_tags/index.md @@ -0,0 +1,87 @@ +--- +title: mail_manager_archive_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_archive_tags + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mail_manager_archives in a region + +## Overview + + + + + + + +
Namemail_manager_archive_tags
TypeResource
DescriptionDefinition of AWS::SES::MailManagerArchive Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
undefined
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mail_manager_archives in a region. +```sql +SELECT +region, +archive_arn, +archive_id, +archive_name, +archive_state, +kms_key_arn, +retention, +tag_key, +tag_value +FROM aws.ses.mail_manager_archive_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_archive_tags resource, see mail_manager_archives + diff --git a/website/docs/services/ses/mail_manager_archives/index.md b/website/docs/services/ses/mail_manager_archives/index.md new file mode 100644 index 0000000..8040e34 --- /dev/null +++ b/website/docs/services/ses/mail_manager_archives/index.md @@ -0,0 +1,244 @@ +--- +title: mail_manager_archives +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_archives + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mail_manager_archive resource or lists mail_manager_archives in a region + +## Overview + + + + + + + +
Namemail_manager_archives
TypeResource
DescriptionDefinition of AWS::SES::MailManagerArchive Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
undefined
array
stringAWS region.
+ +For more information, see AWS::SES::MailManagerArchive. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mail_manager_archives in a region. +```sql +SELECT +region, +archive_arn, +archive_id, +archive_name, +archive_state, +kms_key_arn, +retention, +tags +FROM aws.ses.mail_manager_archives +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mail_manager_archive. +```sql +SELECT +region, +archive_arn, +archive_id, +archive_name, +archive_state, +kms_key_arn, +retention, +tags +FROM aws.ses.mail_manager_archives +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mail_manager_archive resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_archives ( + ArchiveName, + KmsKeyArn, + Retention, + Tags, + region +) +SELECT +'{{ ArchiveName }}', + '{{ KmsKeyArn }}', + '{{ Retention }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_archives ( + ArchiveName, + KmsKeyArn, + Retention, + Tags, + region +) +SELECT + '{{ ArchiveName }}', + '{{ KmsKeyArn }}', + '{{ Retention }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mail_manager_archive + props: + - name: ArchiveName + value: '{{ ArchiveName }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: Retention + value: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.mail_manager_archives +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the mail_manager_archives resource, the following permissions are required: + +### Create +```json +ses:TagResource, +ses:ListTagsForResource, +ses:GetArchive, +ses:CreateArchive, +kms:DescribeKey, +kms:Decrypt, +kms:GenerateDataKey +``` + +### Read +```json +ses:ListTagsForResource, +ses:GetArchive +``` + +### Update +```json +ses:TagResource, +ses:UntagResource, +ses:ListTagsForResource, +ses:GetArchive, +ses:UpdateArchive +``` + +### Delete +```json +ses:GetArchive, +ses:DeleteArchive +``` + +### List +```json +ses:ListArchives +``` diff --git a/website/docs/services/ses/mail_manager_archives_list_only/index.md b/website/docs/services/ses/mail_manager_archives_list_only/index.md new file mode 100644 index 0000000..43bb3df --- /dev/null +++ b/website/docs/services/ses/mail_manager_archives_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: mail_manager_archives_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_archives_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mail_manager_archives in a region or regions, for all properties use mail_manager_archives + +## Overview + + + + + + + +
Namemail_manager_archives_list_only
TypeResource
DescriptionDefinition of AWS::SES::MailManagerArchive Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mail_manager_archives in a region. +```sql +SELECT +region, +archive_id +FROM aws.ses.mail_manager_archives_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_archives_list_only resource, see mail_manager_archives + diff --git a/website/docs/services/ses/mail_manager_ingress_point_tags/index.md b/website/docs/services/ses/mail_manager_ingress_point_tags/index.md new file mode 100644 index 0000000..a2fbf80 --- /dev/null +++ b/website/docs/services/ses/mail_manager_ingress_point_tags/index.md @@ -0,0 +1,95 @@ +--- +title: mail_manager_ingress_point_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_ingress_point_tags + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mail_manager_ingress_points in a region + +## Overview + + + + + + + +
Namemail_manager_ingress_point_tags
TypeResource
DescriptionDefinition of AWS::SES::MailManagerIngressPoint Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mail_manager_ingress_points in a region. +```sql +SELECT +region, +a_record, +traffic_policy_id, +ingress_point_configuration, +ingress_point_arn, +ingress_point_id, +ingress_point_name, +rule_set_id, +status, +status_to_update, +type, +tag_key, +tag_value +FROM aws.ses.mail_manager_ingress_point_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_ingress_point_tags resource, see mail_manager_ingress_points + diff --git a/website/docs/services/ses/mail_manager_ingress_points/index.md b/website/docs/services/ses/mail_manager_ingress_points/index.md new file mode 100644 index 0000000..02fd64e --- /dev/null +++ b/website/docs/services/ses/mail_manager_ingress_points/index.md @@ -0,0 +1,264 @@ +--- +title: mail_manager_ingress_points +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_ingress_points + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mail_manager_ingress_point resource or lists mail_manager_ingress_points in a region + +## Overview + + + + + + + +
Namemail_manager_ingress_points
TypeResource
DescriptionDefinition of AWS::SES::MailManagerIngressPoint Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
string
string
string
string
string
array
string
stringAWS region.
+ +For more information, see AWS::SES::MailManagerIngressPoint. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mail_manager_ingress_points in a region. +```sql +SELECT +region, +a_record, +traffic_policy_id, +ingress_point_configuration, +ingress_point_arn, +ingress_point_id, +ingress_point_name, +rule_set_id, +status, +status_to_update, +tags, +type +FROM aws.ses.mail_manager_ingress_points +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mail_manager_ingress_point. +```sql +SELECT +region, +a_record, +traffic_policy_id, +ingress_point_configuration, +ingress_point_arn, +ingress_point_id, +ingress_point_name, +rule_set_id, +status, +status_to_update, +tags, +type +FROM aws.ses.mail_manager_ingress_points +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mail_manager_ingress_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_ingress_points ( + TrafficPolicyId, + RuleSetId, + Type, + region +) +SELECT +'{{ TrafficPolicyId }}', + '{{ RuleSetId }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_ingress_points ( + TrafficPolicyId, + IngressPointConfiguration, + IngressPointName, + RuleSetId, + StatusToUpdate, + Tags, + Type, + region +) +SELECT + '{{ TrafficPolicyId }}', + '{{ IngressPointConfiguration }}', + '{{ IngressPointName }}', + '{{ RuleSetId }}', + '{{ StatusToUpdate }}', + '{{ Tags }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mail_manager_ingress_point + props: + - name: TrafficPolicyId + value: '{{ TrafficPolicyId }}' + - name: IngressPointConfiguration + value: null + - name: IngressPointName + value: '{{ IngressPointName }}' + - name: RuleSetId + value: '{{ RuleSetId }}' + - name: StatusToUpdate + value: '{{ StatusToUpdate }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.mail_manager_ingress_points +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the mail_manager_ingress_points resource, the following permissions are required: + +### Create +```json +ses:TagResource, +ses:ListTagsForResource, +ses:GetIngressPoint, +ses:CreateIngressPoint, +iam:CreateServiceLinkedRole +``` + +### Read +```json +ses:ListTagsForResource, +ses:GetIngressPoint +``` + +### Update +```json +ses:TagResource, +ses:UntagResource, +ses:ListTagsForResource, +ses:GetIngressPoint, +ses:UpdateIngressPoint +``` + +### Delete +```json +ses:GetIngressPoint, +ses:DeleteIngressPoint +``` + +### List +```json +ses:ListIngressPoints +``` diff --git a/website/docs/services/ses/mail_manager_ingress_points_list_only/index.md b/website/docs/services/ses/mail_manager_ingress_points_list_only/index.md new file mode 100644 index 0000000..0ae4e1e --- /dev/null +++ b/website/docs/services/ses/mail_manager_ingress_points_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: mail_manager_ingress_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_ingress_points_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mail_manager_ingress_points in a region or regions, for all properties use mail_manager_ingress_points + +## Overview + + + + + + + +
Namemail_manager_ingress_points_list_only
TypeResource
DescriptionDefinition of AWS::SES::MailManagerIngressPoint Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mail_manager_ingress_points in a region. +```sql +SELECT +region, +ingress_point_id +FROM aws.ses.mail_manager_ingress_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_ingress_points_list_only resource, see mail_manager_ingress_points + diff --git a/website/docs/services/ses/mail_manager_relay_tags/index.md b/website/docs/services/ses/mail_manager_relay_tags/index.md new file mode 100644 index 0000000..9369303 --- /dev/null +++ b/website/docs/services/ses/mail_manager_relay_tags/index.md @@ -0,0 +1,87 @@ +--- +title: mail_manager_relay_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_relay_tags + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mail_manager_relays in a region + +## Overview + + + + + + + +
Namemail_manager_relay_tags
TypeResource
DescriptionDefinition of AWS::SES::MailManagerRelay Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
undefined
string
string
string
string
number
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mail_manager_relays in a region. +```sql +SELECT +region, +authentication, +relay_arn, +relay_id, +relay_name, +server_name, +server_port, +tag_key, +tag_value +FROM aws.ses.mail_manager_relay_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_relay_tags resource, see mail_manager_relays + diff --git a/website/docs/services/ses/mail_manager_relays/index.md b/website/docs/services/ses/mail_manager_relays/index.md new file mode 100644 index 0000000..0a34030 --- /dev/null +++ b/website/docs/services/ses/mail_manager_relays/index.md @@ -0,0 +1,243 @@ +--- +title: mail_manager_relays +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_relays + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mail_manager_relay resource or lists mail_manager_relays in a region + +## Overview + + + + + + + +
Namemail_manager_relays
TypeResource
DescriptionDefinition of AWS::SES::MailManagerRelay Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
undefined
string
string
string
string
number
array
stringAWS region.
+ +For more information, see AWS::SES::MailManagerRelay. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mail_manager_relays in a region. +```sql +SELECT +region, +authentication, +relay_arn, +relay_id, +relay_name, +server_name, +server_port, +tags +FROM aws.ses.mail_manager_relays +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mail_manager_relay. +```sql +SELECT +region, +authentication, +relay_arn, +relay_id, +relay_name, +server_name, +server_port, +tags +FROM aws.ses.mail_manager_relays +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mail_manager_relay resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_relays ( + Authentication, + ServerName, + ServerPort, + region +) +SELECT +'{{ Authentication }}', + '{{ ServerName }}', + '{{ ServerPort }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_relays ( + Authentication, + RelayName, + ServerName, + ServerPort, + Tags, + region +) +SELECT + '{{ Authentication }}', + '{{ RelayName }}', + '{{ ServerName }}', + '{{ ServerPort }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mail_manager_relay + props: + - name: Authentication + value: null + - name: RelayName + value: '{{ RelayName }}' + - name: ServerName + value: '{{ ServerName }}' + - name: ServerPort + value: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.mail_manager_relays +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the mail_manager_relays resource, the following permissions are required: + +### Create +```json +ses:TagResource, +ses:ListTagsForResource, +ses:GetRelay, +ses:CreateRelay +``` + +### Read +```json +ses:ListTagsForResource, +ses:GetRelay +``` + +### Update +```json +ses:TagResource, +ses:UntagResource, +ses:ListTagsForResource, +ses:GetRelay, +ses:UpdateRelay +``` + +### Delete +```json +ses:GetRelay, +ses:DeleteRelay +``` + +### List +```json +ses:ListRelays +``` diff --git a/website/docs/services/ses/mail_manager_relays_list_only/index.md b/website/docs/services/ses/mail_manager_relays_list_only/index.md new file mode 100644 index 0000000..e5b6568 --- /dev/null +++ b/website/docs/services/ses/mail_manager_relays_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: mail_manager_relays_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_relays_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mail_manager_relays in a region or regions, for all properties use mail_manager_relays + +## Overview + + + + + + + +
Namemail_manager_relays_list_only
TypeResource
DescriptionDefinition of AWS::SES::MailManagerRelay Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mail_manager_relays in a region. +```sql +SELECT +region, +relay_id +FROM aws.ses.mail_manager_relays_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_relays_list_only resource, see mail_manager_relays + diff --git a/website/docs/services/ses/mail_manager_rule_set_tags/index.md b/website/docs/services/ses/mail_manager_rule_set_tags/index.md new file mode 100644 index 0000000..cb623d3 --- /dev/null +++ b/website/docs/services/ses/mail_manager_rule_set_tags/index.md @@ -0,0 +1,83 @@ +--- +title: mail_manager_rule_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_rule_set_tags + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mail_manager_rule_sets in a region + +## Overview + + + + + + + +
Namemail_manager_rule_set_tags
TypeResource
DescriptionDefinition of AWS::SES::MailManagerRuleSet Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mail_manager_rule_sets in a region. +```sql +SELECT +region, +rule_set_arn, +rule_set_id, +rule_set_name, +rules, +tag_key, +tag_value +FROM aws.ses.mail_manager_rule_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_rule_set_tags resource, see mail_manager_rule_sets + diff --git a/website/docs/services/ses/mail_manager_rule_sets/index.md b/website/docs/services/ses/mail_manager_rule_sets/index.md new file mode 100644 index 0000000..1d231af --- /dev/null +++ b/website/docs/services/ses/mail_manager_rule_sets/index.md @@ -0,0 +1,232 @@ +--- +title: mail_manager_rule_sets +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_rule_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mail_manager_rule_set resource or lists mail_manager_rule_sets in a region + +## Overview + + + + + + + +
Namemail_manager_rule_sets
TypeResource
DescriptionDefinition of AWS::SES::MailManagerRuleSet Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
array
stringAWS region.
+ +For more information, see AWS::SES::MailManagerRuleSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mail_manager_rule_sets in a region. +```sql +SELECT +region, +rule_set_arn, +rule_set_id, +rule_set_name, +rules, +tags +FROM aws.ses.mail_manager_rule_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mail_manager_rule_set. +```sql +SELECT +region, +rule_set_arn, +rule_set_id, +rule_set_name, +rules, +tags +FROM aws.ses.mail_manager_rule_sets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mail_manager_rule_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_rule_sets ( + Rules, + region +) +SELECT +'{{ Rules }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_rule_sets ( + RuleSetName, + Rules, + Tags, + region +) +SELECT + '{{ RuleSetName }}', + '{{ Rules }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mail_manager_rule_set + props: + - name: RuleSetName + value: '{{ RuleSetName }}' + - name: Rules + value: + - Name: '{{ Name }}' + Conditions: + - null + Unless: + - null + Actions: + - null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.mail_manager_rule_sets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the mail_manager_rule_sets resource, the following permissions are required: + +### Create +```json +ses:TagResource, +ses:ListTagsForResource, +ses:GetRuleSet, +ses:CreateRuleSet +``` + +### Read +```json +ses:ListTagsForResource, +ses:GetRuleSet +``` + +### Update +```json +ses:TagResource, +ses:UntagResource, +ses:ListTagsForResource, +ses:GetRuleSet, +ses:UpdateRuleSet +``` + +### Delete +```json +ses:GetRuleSet, +ses:DeleteRuleSet +``` + +### List +```json +ses:ListRuleSets +``` diff --git a/website/docs/services/ses/mail_manager_rule_sets_list_only/index.md b/website/docs/services/ses/mail_manager_rule_sets_list_only/index.md new file mode 100644 index 0000000..f0fdc23 --- /dev/null +++ b/website/docs/services/ses/mail_manager_rule_sets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: mail_manager_rule_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_rule_sets_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mail_manager_rule_sets in a region or regions, for all properties use mail_manager_rule_sets + +## Overview + + + + + + + +
Namemail_manager_rule_sets_list_only
TypeResource
DescriptionDefinition of AWS::SES::MailManagerRuleSet Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mail_manager_rule_sets in a region. +```sql +SELECT +region, +rule_set_id +FROM aws.ses.mail_manager_rule_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_rule_sets_list_only resource, see mail_manager_rule_sets + diff --git a/website/docs/services/ses/mail_manager_traffic_policies/index.md b/website/docs/services/ses/mail_manager_traffic_policies/index.md new file mode 100644 index 0000000..73a712c --- /dev/null +++ b/website/docs/services/ses/mail_manager_traffic_policies/index.md @@ -0,0 +1,244 @@ +--- +title: mail_manager_traffic_policies +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_traffic_policies + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a mail_manager_traffic_policy resource or lists mail_manager_traffic_policies in a region + +## Overview + + + + + + + +
Namemail_manager_traffic_policies
TypeResource
DescriptionDefinition of AWS::SES::MailManagerTrafficPolicy Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
number
array
array
string
string
string
stringAWS region.
+ +For more information, see AWS::SES::MailManagerTrafficPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all mail_manager_traffic_policies in a region. +```sql +SELECT +region, +default_action, +max_message_size_bytes, +policy_statements, +tags, +traffic_policy_arn, +traffic_policy_id, +traffic_policy_name +FROM aws.ses.mail_manager_traffic_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual mail_manager_traffic_policy. +```sql +SELECT +region, +default_action, +max_message_size_bytes, +policy_statements, +tags, +traffic_policy_arn, +traffic_policy_id, +traffic_policy_name +FROM aws.ses.mail_manager_traffic_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new mail_manager_traffic_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_traffic_policies ( + DefaultAction, + PolicyStatements, + region +) +SELECT +'{{ DefaultAction }}', + '{{ PolicyStatements }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.mail_manager_traffic_policies ( + DefaultAction, + MaxMessageSizeBytes, + PolicyStatements, + Tags, + TrafficPolicyName, + region +) +SELECT + '{{ DefaultAction }}', + '{{ MaxMessageSizeBytes }}', + '{{ PolicyStatements }}', + '{{ Tags }}', + '{{ TrafficPolicyName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: mail_manager_traffic_policy + props: + - name: DefaultAction + value: '{{ DefaultAction }}' + - name: MaxMessageSizeBytes + value: null + - name: PolicyStatements + value: + - Conditions: + - null + Action: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TrafficPolicyName + value: '{{ TrafficPolicyName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.mail_manager_traffic_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the mail_manager_traffic_policies resource, the following permissions are required: + +### Create +```json +ses:TagResource, +ses:ListTagsForResource, +ses:GetTrafficPolicy, +ses:CreateTrafficPolicy +``` + +### Read +```json +ses:ListTagsForResource, +ses:GetTrafficPolicy +``` + +### Update +```json +ses:TagResource, +ses:UntagResource, +ses:ListTagsForResource, +ses:GetTrafficPolicy, +ses:UpdateTrafficPolicy +``` + +### Delete +```json +ses:GetTrafficPolicy, +ses:DeleteTrafficPolicy +``` + +### List +```json +ses:ListTrafficPolicies +``` diff --git a/website/docs/services/ses/mail_manager_traffic_policies_list_only/index.md b/website/docs/services/ses/mail_manager_traffic_policies_list_only/index.md new file mode 100644 index 0000000..ae1d201 --- /dev/null +++ b/website/docs/services/ses/mail_manager_traffic_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: mail_manager_traffic_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_traffic_policies_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mail_manager_traffic_policies in a region or regions, for all properties use mail_manager_traffic_policies + +## Overview + + + + + + + +
Namemail_manager_traffic_policies_list_only
TypeResource
DescriptionDefinition of AWS::SES::MailManagerTrafficPolicy Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mail_manager_traffic_policies in a region. +```sql +SELECT +region, +traffic_policy_id +FROM aws.ses.mail_manager_traffic_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_traffic_policies_list_only resource, see mail_manager_traffic_policies + diff --git a/website/docs/services/ses/mail_manager_traffic_policy_tags/index.md b/website/docs/services/ses/mail_manager_traffic_policy_tags/index.md new file mode 100644 index 0000000..6750efd --- /dev/null +++ b/website/docs/services/ses/mail_manager_traffic_policy_tags/index.md @@ -0,0 +1,87 @@ +--- +title: mail_manager_traffic_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mail_manager_traffic_policy_tags + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mail_manager_traffic_policies in a region + +## Overview + + + + + + + +
Namemail_manager_traffic_policy_tags
TypeResource
DescriptionDefinition of AWS::SES::MailManagerTrafficPolicy Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
number
array
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mail_manager_traffic_policies in a region. +```sql +SELECT +region, +default_action, +max_message_size_bytes, +policy_statements, +traffic_policy_arn, +traffic_policy_id, +traffic_policy_name, +tag_key, +tag_value +FROM aws.ses.mail_manager_traffic_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mail_manager_traffic_policy_tags resource, see mail_manager_traffic_policies + diff --git a/website/docs/services/ses/templates/index.md b/website/docs/services/ses/templates/index.md new file mode 100644 index 0000000..4593d98 --- /dev/null +++ b/website/docs/services/ses/templates/index.md @@ -0,0 +1,207 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a template resource or lists templates in a region + +## Overview + + + + + + + +
Nametemplates
TypeResource
DescriptionResource Type definition for AWS::SES::Template
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
objectResource Type definition for AWS::SES::Template
stringAWS region.
+ +For more information, see AWS::SES::Template. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all templates in a region. +```sql +SELECT +region, +id, +template +FROM aws.ses.templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual template. +```sql +SELECT +region, +id, +template +FROM aws.ses.templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.templates ( + Template, + region +) +SELECT +'{{ Template }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.templates ( + Template, + region +) +SELECT + '{{ Template }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: template + props: + - name: Template + value: + Template: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.templates +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ses:GetEmailTemplate, +ses:GetTemplate +``` + +### Delete +```json +ses:DeleteEmailTemplate, +ses:DeleteTemplate +``` + +### Update +```json +ses:GetEmailTemplate, +ses:UpdateEmailTemplate, +ses:GetTemplate, +ses:UpdateTemplate +``` + +### List +```json +ses:ListEmailTemplates, +ses:ListTemplates +``` diff --git a/website/docs/services/ses/templates_list_only/index.md b/website/docs/services/ses/templates_list_only/index.md new file mode 100644 index 0000000..a27b9c6 --- /dev/null +++ b/website/docs/services/ses/templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - templates_list_only + - ses + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists templates in a region or regions, for all properties use templates + +## Overview + + + + + + + +
Nametemplates_list_only
TypeResource
DescriptionResource Type definition for AWS::SES::Template
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all templates in a region. +```sql +SELECT +region, +id +FROM aws.ses.templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the templates_list_only resource, see templates + diff --git a/website/docs/services/ses/vdm_attributes/index.md b/website/docs/services/ses/vdm_attributes/index.md new file mode 100644 index 0000000..78bc051 --- /dev/null +++ b/website/docs/services/ses/vdm_attributes/index.md @@ -0,0 +1,192 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a vdm_attribute resource or lists vdm_attributes in a region + +## Overview + + + + + + + +
Namevdm_attributes
TypeResource
DescriptionResource Type definition for AWS::SES::VdmAttributes
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringUnique identifier for this resource
objectPreferences regarding the Dashboard feature.
objectPreferences regarding the Guardian feature.
stringAWS region.
+ +For more information, see AWS::SES::VdmAttributes. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual vdm_attribute. +```sql +SELECT +region, +vdm_attributes_resource_id, +dashboard_attributes, +guardian_attributes +FROM aws.ses.vdm_attributes +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vdm_attribute resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ses.vdm_attributes ( + DashboardAttributes, + GuardianAttributes, + region +) +SELECT +'{{ DashboardAttributes }}', + '{{ GuardianAttributes }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ses.vdm_attributes ( + DashboardAttributes, + GuardianAttributes, + region +) +SELECT + '{{ DashboardAttributes }}', + '{{ GuardianAttributes }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: vdm_attribute + props: + - name: DashboardAttributes + value: + EngagementMetrics: '{{ EngagementMetrics }}' + - name: GuardianAttributes + value: + OptimizedSharedDelivery: '{{ OptimizedSharedDelivery }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ses.vdm_attributes +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the vdm_attributes resource, the following permissions are required: + +### Create +```json +ses:PutAccountVdmAttributes, +ses:GetAccount +``` + +### Read +```json +ses:GetAccount +``` + +### Update +```json +ses:PutAccountVdmAttributes, +ses:GetAccount +``` + +### Delete +```json +ses:PutAccountVdmAttributes, +ses:GetAccount +``` diff --git a/website/docs/services/shield/drt_accesses/index.md b/website/docs/services/shield/drt_accesses/index.md new file mode 100644 index 0000000..7c87d2e --- /dev/null +++ b/website/docs/services/shield/drt_accesses/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a drt_access resource or lists 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.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
arrayAuthorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
stringAuthorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.
stringAWS region.
+ +For more information, see AWS::Shield::DRTAccess. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all drt_accesses in a region. +```sql +SELECT +region, +account_id, +log_bucket_list, +role_arn +FROM aws.shield.drt_accesses +; +``` +Gets all properties from an individual drt_access. +```sql +SELECT +region, +account_id, +log_bucket_list, +role_arn +FROM aws.shield.drt_accesses +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new drt_access resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.shield.drt_accesses ( + RoleArn, + region +) +SELECT +'{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.shield.drt_accesses ( + LogBucketList, + RoleArn, + region +) +SELECT + '{{ LogBucketList }}', + '{{ RoleArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: drt_access + props: + - name: LogBucketList + value: + - '{{ LogBucketList[0] }}' + - name: RoleArn + value: '{{ RoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.shield.drt_accesses +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### 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 +``` + +### List +```json +shield:DescribeDRTAccess +``` diff --git a/website/docs/services/shield/drt_accesses_list_only/index.md b/website/docs/services/shield/drt_accesses_list_only/index.md new file mode 100644 index 0000000..f28273b --- /dev/null +++ b/website/docs/services/shield/drt_accesses_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: drt_accesses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - drt_accesses_list_only + - shield + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists drt_accesses in a region or regions, for all properties use drt_accesses + +## Overview + + + + + + + +
Namedrt_accesses_list_only
TypeResource
DescriptionConfig the role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your AWS account while assisting with attack mitigation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all drt_accesses in a region. +```sql +SELECT +region, +account_id +FROM aws.shield.drt_accesses_list_only +; +``` + + +## Permissions + +For permissions required to operate on the drt_accesses_list_only resource, see drt_accesses + diff --git a/website/docs/services/shield/index.md b/website/docs/services/shield/index.md new file mode 100644 index 0000000..3f8581a --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The shield service documentation. + +:::info Service Summary + +
+
+total resources: 10
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/shield/proactive_engagements/index.md b/website/docs/services/shield/proactive_engagements/index.md new file mode 100644 index 0000000..79ab031 --- /dev/null +++ b/website/docs/services/shield/proactive_engagements/index.md @@ -0,0 +1,222 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a proactive_engagement resource or lists 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.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringIf `ENABLED`, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
If `DISABLED`, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
arrayA list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.
To enable proactive engagement, the contact list must include at least one phone number.
stringAWS region.
+ +For more information, see AWS::Shield::ProactiveEngagement. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all proactive_engagements in a region. +```sql +SELECT +region, +account_id, +proactive_engagement_status, +emergency_contact_list +FROM aws.shield.proactive_engagements +; +``` +Gets all properties from an individual proactive_engagement. +```sql +SELECT +region, +account_id, +proactive_engagement_status, +emergency_contact_list +FROM aws.shield.proactive_engagements +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new proactive_engagement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.shield.proactive_engagements ( + ProactiveEngagementStatus, + EmergencyContactList, + region +) +SELECT +'{{ ProactiveEngagementStatus }}', + '{{ EmergencyContactList }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.shield.proactive_engagements ( + ProactiveEngagementStatus, + EmergencyContactList, + region +) +SELECT + '{{ ProactiveEngagementStatus }}', + '{{ EmergencyContactList }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: proactive_engagement + props: + - name: ProactiveEngagementStatus + value: '{{ ProactiveEngagementStatus }}' + - name: EmergencyContactList + value: + - ContactNotes: '{{ ContactNotes }}' + EmailAddress: '{{ EmailAddress }}' + PhoneNumber: '{{ PhoneNumber }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.shield.proactive_engagements +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### 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 +``` + +### List +```json +shield:DescribeSubscription, +shield:DescribeEmergencyContactSettings +``` diff --git a/website/docs/services/shield/proactive_engagements_list_only/index.md b/website/docs/services/shield/proactive_engagements_list_only/index.md new file mode 100644 index 0000000..ed28a2d --- /dev/null +++ b/website/docs/services/shield/proactive_engagements_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: proactive_engagements_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - proactive_engagements_list_only + - shield + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists proactive_engagements in a region or regions, for all properties use proactive_engagements + +## Overview + + + + + + + +
Nameproactive_engagements_list_only
TypeResource
DescriptionAuthorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all proactive_engagements in a region. +```sql +SELECT +region, +account_id +FROM aws.shield.proactive_engagements_list_only +; +``` + + +## Permissions + +For permissions required to operate on the proactive_engagements_list_only resource, see proactive_engagements + diff --git a/website/docs/services/shield/protection_group_tags/index.md b/website/docs/services/shield/protection_group_tags/index.md new file mode 100644 index 0000000..64d727b --- /dev/null +++ b/website/docs/services/shield/protection_group_tags/index.md @@ -0,0 +1,87 @@ +--- +title: protection_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - protection_group_tags + - shield + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for protection_groups in a region + +## Overview + + + + + + + +
Nameprotection_group_tags
TypeResource
DescriptionA grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
stringThe ARN (Amazon Resource Name) of the protection group.
stringDefines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
* Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
* Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
* Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.
stringThe criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
arrayThe Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set `Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.
stringThe resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all protection_groups in a region. +```sql +SELECT +region, +protection_group_id, +protection_group_arn, +aggregation, +pattern, +members, +resource_type, +tag_key, +tag_value +FROM aws.shield.protection_group_tags +; +``` + + +## Permissions + +For permissions required to operate on the protection_group_tags resource, see protection_groups + diff --git a/website/docs/services/shield/protection_groups/index.md b/website/docs/services/shield/protection_groups/index.md new file mode 100644 index 0000000..6b162ed --- /dev/null +++ b/website/docs/services/shield/protection_groups/index.md @@ -0,0 +1,245 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a protection_group resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
stringThe ARN (Amazon Resource Name) of the protection group.
stringDefines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
* Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
* Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
* Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.
stringThe criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
arrayThe Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set `Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.
stringThe resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.
arrayOne or more tag key-value pairs for the Protection object.
stringAWS region.
+ +For more information, see AWS::Shield::ProtectionGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all protection_groups in a region. +```sql +SELECT +region, +protection_group_id, +protection_group_arn, +aggregation, +pattern, +members, +resource_type, +tags +FROM aws.shield.protection_groups +; +``` +Gets all properties from an individual protection_group. +```sql +SELECT +region, +protection_group_id, +protection_group_arn, +aggregation, +pattern, +members, +resource_type, +tags +FROM aws.shield.protection_groups +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new protection_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.shield.protection_groups ( + ProtectionGroupId, + Aggregation, + Pattern, + region +) +SELECT +'{{ ProtectionGroupId }}', + '{{ Aggregation }}', + '{{ Pattern }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.shield.protection_groups ( + ProtectionGroupId, + Aggregation, + Pattern, + Members, + ResourceType, + Tags, + region +) +SELECT + '{{ ProtectionGroupId }}', + '{{ Aggregation }}', + '{{ Pattern }}', + '{{ Members }}', + '{{ ResourceType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: protection_group + props: + - name: ProtectionGroupId + value: '{{ ProtectionGroupId }}' + - name: Aggregation + value: '{{ Aggregation }}' + - name: Pattern + value: '{{ Pattern }}' + - name: Members + value: + - '{{ Members[0] }}' + - name: ResourceType + value: '{{ ResourceType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.shield.protection_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the protection_groups resource, the following permissions are required: + +### Create +```json +shield:CreateProtectionGroup, +shield:TagResource +``` + +### Delete +```json +shield:DeleteProtectionGroup, +shield:UntagResource +``` + +### Read +```json +shield:DescribeProtectionGroup, +shield:ListTagsForResource +``` + +### Update +```json +shield:UpdateProtectionGroup, +shield:ListTagsForResource, +shield:TagResource, +shield:UntagResource +``` + +### List +```json +shield:ListProtectionGroups +``` diff --git a/website/docs/services/shield/protection_groups_list_only/index.md b/website/docs/services/shield/protection_groups_list_only/index.md new file mode 100644 index 0000000..73f5e85 --- /dev/null +++ b/website/docs/services/shield/protection_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: protection_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - protection_groups_list_only + - shield + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists protection_groups in a region or regions, for all properties use protection_groups + +## Overview + + + + + + + +
Nameprotection_groups_list_only
TypeResource
DescriptionA grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN (Amazon Resource Name) of the protection group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all protection_groups in a region. +```sql +SELECT +region, +protection_group_arn +FROM aws.shield.protection_groups_list_only +; +``` + + +## Permissions + +For permissions required to operate on the protection_groups_list_only resource, see protection_groups + diff --git a/website/docs/services/shield/protection_tags/index.md b/website/docs/services/shield/protection_tags/index.md new file mode 100644 index 0000000..088ceec --- /dev/null +++ b/website/docs/services/shield/protection_tags/index.md @@ -0,0 +1,87 @@ +--- +title: protection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - protection_tags + - shield + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for protections in a region + +## Overview + + + + + + + +
Nameprotection_tags
TypeResource
DescriptionEnables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) of the protection.
stringThe ARN (Amazon Resource Name) of the protection.
stringFriendly name for the Protection.
stringThe ARN (Amazon Resource Name) of the resource to be protected.
arrayThe Amazon Resource Names (ARNs) of the health check to associate with the protection.
objectThe automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all protections in a region. +```sql +SELECT +region, +protection_id, +protection_arn, +name, +resource_arn, +health_check_arns, +application_layer_automatic_response_configuration, +tag_key, +tag_value +FROM aws.shield.protection_tags +; +``` + + +## Permissions + +For permissions required to operate on the protection_tags resource, see protections + diff --git a/website/docs/services/shield/protections/index.md b/website/docs/services/shield/protections/index.md new file mode 100644 index 0000000..1cf8fb7 --- /dev/null +++ b/website/docs/services/shield/protections/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a protection resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) of the protection.
stringThe ARN (Amazon Resource Name) of the protection.
stringFriendly name for the Protection.
stringThe ARN (Amazon Resource Name) of the resource to be protected.
arrayThe Amazon Resource Names (ARNs) of the health check to associate with the protection.
objectThe automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
arrayOne or more tag key-value pairs for the Protection object.
stringAWS region.
+ +For more information, see AWS::Shield::Protection. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all protections in a region. +```sql +SELECT +region, +protection_id, +protection_arn, +name, +resource_arn, +health_check_arns, +application_layer_automatic_response_configuration, +tags +FROM aws.shield.protections +; +``` +Gets all properties from an individual protection. +```sql +SELECT +region, +protection_id, +protection_arn, +name, +resource_arn, +health_check_arns, +application_layer_automatic_response_configuration, +tags +FROM aws.shield.protections +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new protection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.shield.protections ( + Name, + ResourceArn, + region +) +SELECT +'{{ Name }}', + '{{ ResourceArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.shield.protections ( + Name, + ResourceArn, + HealthCheckArns, + ApplicationLayerAutomaticResponseConfiguration, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ ResourceArn }}', + '{{ HealthCheckArns }}', + '{{ ApplicationLayerAutomaticResponseConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: protection + props: + - name: Name + value: '{{ Name }}' + - name: ResourceArn + value: '{{ ResourceArn }}' + - name: HealthCheckArns + value: + - '{{ HealthCheckArns[0] }}' + - name: ApplicationLayerAutomaticResponseConfiguration + value: + Action: {} + Status: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.shield.protections +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### 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 +``` + +### List +```json +shield:ListProtections +``` diff --git a/website/docs/services/shield/protections_list_only/index.md b/website/docs/services/shield/protections_list_only/index.md new file mode 100644 index 0000000..d8b08dc --- /dev/null +++ b/website/docs/services/shield/protections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: protections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - protections_list_only + - shield + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists protections in a region or regions, for all properties use protections + +## Overview + + + + + + + +
Nameprotections_list_only
TypeResource
DescriptionEnables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN (Amazon Resource Name) of the protection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all protections in a region. +```sql +SELECT +region, +protection_arn +FROM aws.shield.protections_list_only +; +``` + + +## Permissions + +For permissions required to operate on the protections_list_only resource, see protections + diff --git a/website/docs/services/signer/index.md b/website/docs/services/signer/index.md new file mode 100644 index 0000000..593e276 --- /dev/null +++ b/website/docs/services/signer/index.md @@ -0,0 +1,40 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The signer service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/signer/profile_permissions/index.md b/website/docs/services/signer/profile_permissions/index.md new file mode 100644 index 0000000..6213ba2 --- /dev/null +++ b/website/docs/services/signer/profile_permissions/index.md @@ -0,0 +1,221 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a profile_permission resource or lists profile_permissions in a region + +## Overview + + + + + + + +
Nameprofile_permissions
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringAWS region.
+ +For more information, see AWS::Signer::ProfilePermission. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all profile_permissions in a region. +```sql +SELECT +region, +profile_name, +profile_version, +action, +principal, +statement_id +FROM aws.signer.profile_permissions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual profile_permission. +```sql +SELECT +region, +profile_name, +profile_version, +action, +principal, +statement_id +FROM aws.signer.profile_permissions +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new profile_permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.signer.profile_permissions ( + ProfileName, + Action, + Principal, + StatementId, + region +) +SELECT +'{{ ProfileName }}', + '{{ Action }}', + '{{ Principal }}', + '{{ StatementId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.signer.profile_permissions ( + ProfileName, + ProfileVersion, + Action, + Principal, + StatementId, + region +) +SELECT + '{{ ProfileName }}', + '{{ ProfileVersion }}', + '{{ Action }}', + '{{ Principal }}', + '{{ StatementId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: profile_permission + props: + - name: ProfileName + value: '{{ ProfileName }}' + - name: ProfileVersion + value: '{{ ProfileVersion }}' + - name: Action + value: '{{ Action }}' + - name: Principal + value: '{{ Principal }}' + - name: StatementId + value: '{{ StatementId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.signer.profile_permissions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the profile_permissions resource, the following permissions are required: + +### Create +```json +signer:AddProfilePermission, +signer:ListProfilePermissions +``` + +### Read +```json +signer:ListProfilePermissions +``` + +### Delete +```json +signer:RemoveProfilePermission, +signer:ListProfilePermissions +``` + +### List +```json +signer:ListProfilePermissions, +signer:GetSigningProfile +``` diff --git a/website/docs/services/signer/profile_permissions_list_only/index.md b/website/docs/services/signer/profile_permissions_list_only/index.md new file mode 100644 index 0000000..55c7087 --- /dev/null +++ b/website/docs/services/signer/profile_permissions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: profile_permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profile_permissions_list_only + - signer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profile_permissions in a region or regions, for all properties use profile_permissions + +## Overview + + + + + + + +
Nameprofile_permissions_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profile_permissions in a region. +```sql +SELECT +region, +statement_id, +profile_name +FROM aws.signer.profile_permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_permissions_list_only resource, see profile_permissions + diff --git a/website/docs/services/signer/signing_profile_tags/index.md b/website/docs/services/signer/signing_profile_tags/index.md new file mode 100644 index 0000000..3bbdee1 --- /dev/null +++ b/website/docs/services/signer/signing_profile_tags/index.md @@ -0,0 +1,87 @@ +--- +title: signing_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - signing_profile_tags + - signer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for signing_profiles in a region + +## Overview + + + + + + + +
Namesigning_profile_tags
TypeResource
DescriptionA signing profile is a signing template that can be used to carry out a pre-defined signing job.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringA name for the signing profile. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name.
stringA version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name.
stringThe Amazon Resource Name (ARN) of the specified signing profile.
stringThe Amazon Resource Name (ARN) of the specified signing profile version.
objectSignature validity period of the profile.
stringThe ID of the target signing platform.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all signing_profiles in a region. +```sql +SELECT +region, +profile_name, +profile_version, +arn, +profile_version_arn, +signature_validity_period, +platform_id, +tag_key, +tag_value +FROM aws.signer.signing_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the signing_profile_tags resource, see signing_profiles + diff --git a/website/docs/services/signer/signing_profiles/index.md b/website/docs/services/signer/signing_profiles/index.md new file mode 100644 index 0000000..7669cb7 --- /dev/null +++ b/website/docs/services/signer/signing_profiles/index.md @@ -0,0 +1,228 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a signing_profile resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA name for the signing profile. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name.
stringA version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name.
stringThe Amazon Resource Name (ARN) of the specified signing profile.
stringThe Amazon Resource Name (ARN) of the specified signing profile version.
objectSignature validity period of the profile.
stringThe ID of the target signing platform.
arrayA list of tags associated with the signing profile.
stringAWS region.
+ +For more information, see AWS::Signer::SigningProfile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all signing_profiles in a region. +```sql +SELECT +region, +profile_name, +profile_version, +arn, +profile_version_arn, +signature_validity_period, +platform_id, +tags +FROM aws.signer.signing_profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual signing_profile. +```sql +SELECT +region, +profile_name, +profile_version, +arn, +profile_version_arn, +signature_validity_period, +platform_id, +tags +FROM aws.signer.signing_profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new signing_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.signer.signing_profiles ( + PlatformId, + region +) +SELECT +'{{ PlatformId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.signer.signing_profiles ( + SignatureValidityPeriod, + PlatformId, + Tags, + region +) +SELECT + '{{ SignatureValidityPeriod }}', + '{{ PlatformId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: signing_profile + props: + - name: SignatureValidityPeriod + value: + Value: '{{ Value }}' + Type: '{{ Type }}' + - name: PlatformId + value: '{{ PlatformId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.signer.signing_profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the signing_profiles resource, the following permissions are required: + +### Create +```json +signer:PutSigningProfile, +signer:TagResource +``` + +### Read +```json +signer:GetSigningProfile +``` + +### Delete +```json +signer:CancelSigningProfile, +signer:GetSigningProfile +``` + +### List +```json +signer:ListSigningProfiles +``` + +### Update +```json +signer:TagResource, +signer:UntagResource, +signer:GetSigningProfile +``` diff --git a/website/docs/services/signer/signing_profiles_list_only/index.md b/website/docs/services/signer/signing_profiles_list_only/index.md new file mode 100644 index 0000000..568849d --- /dev/null +++ b/website/docs/services/signer/signing_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: signing_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - signing_profiles_list_only + - signer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists signing_profiles in a region or regions, for all properties use signing_profiles + +## Overview + + + + + + + +
Namesigning_profiles_list_only
TypeResource
DescriptionA signing profile is a signing template that can be used to carry out a pre-defined signing job.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified signing profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all signing_profiles in a region. +```sql +SELECT +region, +arn +FROM aws.signer.signing_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the signing_profiles_list_only resource, see signing_profiles + diff --git a/website/docs/services/simspaceweaver/index.md b/website/docs/services/simspaceweaver/index.md new file mode 100644 index 0000000..b822d69 --- /dev/null +++ b/website/docs/services/simspaceweaver/index.md @@ -0,0 +1,37 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The simspaceweaver service documentation. + +:::info Service Summary + +
+
+total resources: 2
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/simspaceweaver/simulations/index.md b/website/docs/services/simspaceweaver/simulations/index.md new file mode 100644 index 0000000..7d15233 --- /dev/null +++ b/website/docs/services/simspaceweaver/simulations/index.md @@ -0,0 +1,237 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a simulation resource or lists simulations in a region + +## Overview + + + + + + + +
Namesimulations
TypeResource
DescriptionAWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the simulation.
stringRole ARN.
object
stringJson object with all simulation details
stringThe maximum running time of the simulation.
object
stringAWS region.
+ +For more information, see AWS::SimSpaceWeaver::Simulation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all simulations in a region. +```sql +SELECT +region, +name, +role_arn, +schema_s3_location, +describe_payload, +maximum_duration, +snapshot_s3_location +FROM aws.simspaceweaver.simulations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual simulation. +```sql +SELECT +region, +name, +role_arn, +schema_s3_location, +describe_payload, +maximum_duration, +snapshot_s3_location +FROM aws.simspaceweaver.simulations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new simulation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.simspaceweaver.simulations ( + Name, + RoleArn, + region +) +SELECT +'{{ Name }}', + '{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.simspaceweaver.simulations ( + Name, + RoleArn, + SchemaS3Location, + MaximumDuration, + SnapshotS3Location, + region +) +SELECT + '{{ Name }}', + '{{ RoleArn }}', + '{{ SchemaS3Location }}', + '{{ MaximumDuration }}', + '{{ SnapshotS3Location }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: simulation + props: + - name: Name + value: '{{ Name }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: SchemaS3Location + value: + BucketName: '{{ BucketName }}' + ObjectKey: '{{ ObjectKey }}' + - name: MaximumDuration + value: '{{ MaximumDuration }}' + - name: SnapshotS3Location + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.simspaceweaver.simulations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +simspaceweaver:DescribeSimulation +``` + +### Update +```json +simspaceweaver:StartSimulation, +simspaceweaver:StopSimulation, +simspaceweaver:DeleteSimulation, +simspaceweaver:DescribeSimulation +``` + +### Delete +```json +simspaceweaver:StopSimulation, +simspaceweaver:DeleteSimulation, +simspaceweaver:DescribeSimulation +``` + +### List +```json +simspaceweaver:ListSimulations +``` diff --git a/website/docs/services/simspaceweaver/simulations_list_only/index.md b/website/docs/services/simspaceweaver/simulations_list_only/index.md new file mode 100644 index 0000000..1c1c779 --- /dev/null +++ b/website/docs/services/simspaceweaver/simulations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: simulations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - simulations_list_only + - simspaceweaver + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists simulations in a region or regions, for all properties use simulations + +## Overview + + + + + + + +
Namesimulations_list_only
TypeResource
DescriptionAWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the simulation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all simulations in a region. +```sql +SELECT +region, +name +FROM aws.simspaceweaver.simulations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the simulations_list_only resource, see simulations + diff --git a/website/docs/services/sns/index.md b/website/docs/services/sns/index.md new file mode 100644 index 0000000..5327da3 --- /dev/null +++ b/website/docs/services/sns/index.md @@ -0,0 +1,39 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The sns service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/sns/topic_inline_policies/index.md b/website/docs/services/sns/topic_inline_policies/index.md new file mode 100644 index 0000000..ae1ff90 --- /dev/null +++ b/website/docs/services/sns/topic_inline_policies/index.md @@ -0,0 +1,188 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a topic_inline_policy resource or lists topic_inline_policies in a region + +## Overview + + + + + + + +
Nametopic_inline_policies
TypeResource
DescriptionSchema for AWS::SNS::TopicInlinePolicy
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectA policy document that contains permissions to add to the specified SNS topics.
stringThe Amazon Resource Name (ARN) of the topic to which you want to add the policy.
stringAWS region.
+ +For more information, see AWS::SNS::TopicInlinePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual topic_inline_policy. +```sql +SELECT +region, +policy_document, +topic_arn +FROM aws.sns.topic_inline_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new topic_inline_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sns.topic_inline_policies ( + PolicyDocument, + TopicArn, + region +) +SELECT +'{{ PolicyDocument }}', + '{{ TopicArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sns.topic_inline_policies ( + PolicyDocument, + TopicArn, + region +) +SELECT + '{{ PolicyDocument }}', + '{{ TopicArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: topic_inline_policy + props: + - name: PolicyDocument + value: {} + - name: TopicArn + value: '{{ TopicArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sns.topic_inline_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the topic_inline_policies resource, the following permissions are required: + +### Create +```json +sns:SetTopicAttributes, +sns:GetTopicAttributes +``` + +### Read +```json +sns:GetTopicAttributes +``` + +### Delete +```json +sns:SetTopicAttributes, +sns:GetTopicAttributes +``` + +### Update +```json +sns:SetTopicAttributes, +sns:GetTopicAttributes +``` diff --git a/website/docs/services/sns/topic_tags/index.md b/website/docs/services/sns/topic_tags/index.md new file mode 100644 index 0000000..62111f1 --- /dev/null +++ b/website/docs/services/sns/topic_tags/index.md @@ -0,0 +1,99 @@ +--- +title: topic_tags +hide_title: false +hide_table_of_contents: false +keywords: + - topic_tags + - sns + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for topics in a region + +## Overview + + + + + + + +
Nametopic_tags
TypeResource
DescriptionThe AWS::SNS::Topic resource creates a topic to which notifications can be published.
One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.
The structure of AUTHPARAMS depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
stringThe ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see KeyId in the *API Reference*.
This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
objectThe body of the policy document you want to use for this topic.
You can only add one policy per topic.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
arrayThe SNS subscriptions (endpoints) for this topic.
If you specify the Subscription property in the AWS::SNS::Topic resource and it creates an associated subscription resource, the associated subscription is not deleted when the AWS::SNS::Topic resource is deleted.
booleanSet to true to create a FIFO topic.
booleanEnables content-based deduplication for FIFO topics.
+ By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action.
+ When you set ContentBasedDeduplication to true, SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
objectThe archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.
stringThe name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
string
stringThe signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
stringTracing mode of an SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.
arrayThe DeliveryStatusLogging configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:
+ HTTP
+ Amazon Kinesis Data Firehose
+ AWS Lambda
+ Platform application endpoint
+ Amazon Simple Queue Service

Once configured, log entries are sent to Amazon CloudWatch Logs.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all topics in a region. +```sql +SELECT +region, +display_name, +kms_master_key_id, +data_protection_policy, +subscription, +fifo_topic, +content_based_deduplication, +archive_policy, +topic_name, +topic_arn, +signature_version, +tracing_config, +delivery_status_logging, +tag_key, +tag_value +FROM aws.sns.topic_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topic_tags resource, see topics + diff --git a/website/docs/services/sns/topics/index.md b/website/docs/services/sns/topics/index.md new file mode 100644 index 0000000..aea0ada --- /dev/null +++ b/website/docs/services/sns/topics/index.md @@ -0,0 +1,325 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a topic resource or lists topics in a region + +## Overview + + + + + + + +
Nametopics
TypeResource
DescriptionThe AWS::SNS::Topic resource creates a topic to which notifications can be published.
One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.
The structure of AUTHPARAMS depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
stringThe ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see KeyId in the *API Reference*.
This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
objectThe body of the policy document you want to use for this topic.
You can only add one policy per topic.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
arrayThe SNS subscriptions (endpoints) for this topic.
If you specify the Subscription property in the AWS::SNS::Topic resource and it creates an associated subscription resource, the associated subscription is not deleted when the AWS::SNS::Topic resource is deleted.
booleanSet to true to create a FIFO topic.
booleanEnables content-based deduplication for FIFO topics.
+ By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action.
+ When you set ContentBasedDeduplication to true, SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
objectThe archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.
arrayThe list of tags to add to a new topic.
To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
stringThe name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
string
stringThe signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
stringTracing mode of an SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.
arrayThe DeliveryStatusLogging configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:
+ HTTP
+ Amazon Kinesis Data Firehose
+ AWS Lambda
+ Platform application endpoint
+ Amazon Simple Queue Service

Once configured, log entries are sent to Amazon CloudWatch Logs.
stringAWS region.
+ +For more information, see AWS::SNS::Topic. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all topics in a region. +```sql +SELECT +region, +display_name, +kms_master_key_id, +data_protection_policy, +subscription, +fifo_topic, +content_based_deduplication, +archive_policy, +tags, +topic_name, +topic_arn, +signature_version, +tracing_config, +delivery_status_logging +FROM aws.sns.topics +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual topic. +```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.topics +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new topic resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sns.topics ( + DisplayName, + KmsMasterKeyId, + DataProtectionPolicy, + Subscription, + FifoTopic, + ContentBasedDeduplication, + ArchivePolicy, + Tags, + TopicName, + SignatureVersion, + TracingConfig, + DeliveryStatusLogging, + region +) +SELECT +'{{ DisplayName }}', + '{{ KmsMasterKeyId }}', + '{{ DataProtectionPolicy }}', + '{{ Subscription }}', + '{{ FifoTopic }}', + '{{ ContentBasedDeduplication }}', + '{{ ArchivePolicy }}', + '{{ Tags }}', + '{{ TopicName }}', + '{{ SignatureVersion }}', + '{{ TracingConfig }}', + '{{ DeliveryStatusLogging }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sns.topics ( + DisplayName, + KmsMasterKeyId, + DataProtectionPolicy, + Subscription, + FifoTopic, + ContentBasedDeduplication, + ArchivePolicy, + Tags, + TopicName, + SignatureVersion, + TracingConfig, + DeliveryStatusLogging, + region +) +SELECT + '{{ DisplayName }}', + '{{ KmsMasterKeyId }}', + '{{ DataProtectionPolicy }}', + '{{ Subscription }}', + '{{ FifoTopic }}', + '{{ ContentBasedDeduplication }}', + '{{ ArchivePolicy }}', + '{{ Tags }}', + '{{ TopicName }}', + '{{ SignatureVersion }}', + '{{ TracingConfig }}', + '{{ DeliveryStatusLogging }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: topic + props: + - name: DisplayName + value: '{{ DisplayName }}' + - name: KmsMasterKeyId + value: '{{ KmsMasterKeyId }}' + - name: DataProtectionPolicy + value: {} + - name: Subscription + value: + - Endpoint: '{{ Endpoint }}' + Protocol: '{{ Protocol }}' + - name: FifoTopic + value: '{{ FifoTopic }}' + - name: ContentBasedDeduplication + value: '{{ ContentBasedDeduplication }}' + - name: ArchivePolicy + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TopicName + value: '{{ TopicName }}' + - name: SignatureVersion + value: '{{ SignatureVersion }}' + - name: TracingConfig + value: '{{ TracingConfig }}' + - name: DeliveryStatusLogging + value: + - Protocol: '{{ Protocol }}' + SuccessFeedbackRoleArn: '{{ SuccessFeedbackRoleArn }}' + SuccessFeedbackSampleRate: '{{ SuccessFeedbackSampleRate }}' + FailureFeedbackRoleArn: '{{ FailureFeedbackRoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sns.topics +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +sns:ListTopics +``` diff --git a/website/docs/services/sns/topics_list_only/index.md b/website/docs/services/sns/topics_list_only/index.md new file mode 100644 index 0000000..ae5acb8 --- /dev/null +++ b/website/docs/services/sns/topics_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: topics_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - topics_list_only + - sns + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists topics in a region or regions, for all properties use topics + +## Overview + + + + + + + +
Nametopics_list_only
TypeResource
DescriptionThe AWS::SNS::Topic resource creates a topic to which notifications can be published.
One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.
The structure of AUTHPARAMS depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all topics in a region. +```sql +SELECT +region, +topic_arn +FROM aws.sns.topics_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topics_list_only resource, see topics + diff --git a/website/docs/services/sqs/index.md b/website/docs/services/sqs/index.md new file mode 100644 index 0000000..d166c60 --- /dev/null +++ b/website/docs/services/sqs/index.md @@ -0,0 +1,39 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The sqs service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/sqs/queue_inline_policies/index.md b/website/docs/services/sqs/queue_inline_policies/index.md new file mode 100644 index 0000000..798a00a --- /dev/null +++ b/website/docs/services/sqs/queue_inline_policies/index.md @@ -0,0 +1,191 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a queue_inline_policy resource or lists queue_inline_policies in a region + +## Overview + + + + + + + +
Namequeue_inline_policies
TypeResource
DescriptionSchema for SQS QueueInlinePolicy
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectA policy document that contains permissions to add to the specified SQS queue
stringThe URL of the SQS queue.
stringAWS region.
+ +For more information, see AWS::SQS::QueueInlinePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual queue_inline_policy. +```sql +SELECT +region, +policy_document, +queue +FROM aws.sqs.queue_inline_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new queue_inline_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sqs.queue_inline_policies ( + PolicyDocument, + Queue, + region +) +SELECT +'{{ PolicyDocument }}', + '{{ Queue }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sqs.queue_inline_policies ( + PolicyDocument, + Queue, + region +) +SELECT + '{{ PolicyDocument }}', + '{{ Queue }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: queue_inline_policy + props: + - name: PolicyDocument + value: {} + - name: Queue + value: '{{ Queue }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sqs.queue_inline_policies +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +sqs:GetQueueAttributes, +sqs:GetQueueUrl +``` + +### Delete +```json +sqs:SetQueueAttributes, +sqs:GetQueueAttributes +``` + +### Update +```json +sqs:SetQueueAttributes, +sqs:GetQueueAttributes, +sqs:GetQueueUrl +``` diff --git a/website/docs/services/sqs/queue_tags/index.md b/website/docs/services/sqs/queue_tags/index.md new file mode 100644 index 0000000..6dcb18d --- /dev/null +++ b/website/docs/services/sqs/queue_tags/index.md @@ -0,0 +1,109 @@ +--- +title: queue_tags +hide_title: false +hide_table_of_contents: false +keywords: + - queue_tags + - sqs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for queues in a region + +## Overview + + + + + + + +
Namequeue_tags
TypeResource
DescriptionThe AWS::SQS::Queue resource creates an SQS standard or FIFO queue.
Keep the following caveats in mind:
+ If you don't specify the FifoQueue property, SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*.
+ If you don't provide a value for a property, the queue is created with the default value for the property.
+ If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
+ To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.

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

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

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

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

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

The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
*JSON*
{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }
*YAML*
deadLetterTargetArn : String
maxReceiveCount : Integer
arrayThe tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.
integerThe length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.
Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.
For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.
stringAWS region.
+ +For more information, see AWS::SQS::Queue. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all queues in a region. +```sql +SELECT +region, +queue_url, +arn, +content_based_deduplication, +deduplication_scope, +delay_seconds, +fifo_queue, +fifo_throughput_limit, +kms_data_key_reuse_period_seconds, +kms_master_key_id, +sqs_managed_sse_enabled, +maximum_message_size, +message_retention_period, +queue_name, +receive_message_wait_time_seconds, +redrive_allow_policy, +redrive_policy, +tags, +visibility_timeout +FROM aws.sqs.queues +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual queue. +```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.queues +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sqs.queues ( + ContentBasedDeduplication, + DeduplicationScope, + DelaySeconds, + FifoQueue, + FifoThroughputLimit, + KmsDataKeyReusePeriodSeconds, + KmsMasterKeyId, + SqsManagedSseEnabled, + MaximumMessageSize, + MessageRetentionPeriod, + QueueName, + ReceiveMessageWaitTimeSeconds, + RedriveAllowPolicy, + RedrivePolicy, + Tags, + VisibilityTimeout, + region +) +SELECT +'{{ ContentBasedDeduplication }}', + '{{ DeduplicationScope }}', + '{{ DelaySeconds }}', + '{{ FifoQueue }}', + '{{ FifoThroughputLimit }}', + '{{ KmsDataKeyReusePeriodSeconds }}', + '{{ KmsMasterKeyId }}', + '{{ SqsManagedSseEnabled }}', + '{{ MaximumMessageSize }}', + '{{ MessageRetentionPeriod }}', + '{{ QueueName }}', + '{{ ReceiveMessageWaitTimeSeconds }}', + '{{ RedriveAllowPolicy }}', + '{{ RedrivePolicy }}', + '{{ Tags }}', + '{{ VisibilityTimeout }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sqs.queues ( + ContentBasedDeduplication, + DeduplicationScope, + DelaySeconds, + FifoQueue, + FifoThroughputLimit, + KmsDataKeyReusePeriodSeconds, + KmsMasterKeyId, + SqsManagedSseEnabled, + MaximumMessageSize, + MessageRetentionPeriod, + QueueName, + ReceiveMessageWaitTimeSeconds, + RedriveAllowPolicy, + RedrivePolicy, + Tags, + VisibilityTimeout, + region +) +SELECT + '{{ ContentBasedDeduplication }}', + '{{ DeduplicationScope }}', + '{{ DelaySeconds }}', + '{{ FifoQueue }}', + '{{ FifoThroughputLimit }}', + '{{ KmsDataKeyReusePeriodSeconds }}', + '{{ KmsMasterKeyId }}', + '{{ SqsManagedSseEnabled }}', + '{{ MaximumMessageSize }}', + '{{ MessageRetentionPeriod }}', + '{{ QueueName }}', + '{{ ReceiveMessageWaitTimeSeconds }}', + '{{ RedriveAllowPolicy }}', + '{{ RedrivePolicy }}', + '{{ Tags }}', + '{{ VisibilityTimeout }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: queue + props: + - name: ContentBasedDeduplication + value: '{{ ContentBasedDeduplication }}' + - name: DeduplicationScope + value: '{{ DeduplicationScope }}' + - name: DelaySeconds + value: '{{ DelaySeconds }}' + - name: FifoQueue + value: '{{ FifoQueue }}' + - name: FifoThroughputLimit + value: '{{ FifoThroughputLimit }}' + - name: KmsDataKeyReusePeriodSeconds + value: '{{ KmsDataKeyReusePeriodSeconds }}' + - name: KmsMasterKeyId + value: '{{ KmsMasterKeyId }}' + - name: SqsManagedSseEnabled + value: '{{ SqsManagedSseEnabled }}' + - name: MaximumMessageSize + value: '{{ MaximumMessageSize }}' + - name: MessageRetentionPeriod + value: '{{ MessageRetentionPeriod }}' + - name: QueueName + value: '{{ QueueName }}' + - name: ReceiveMessageWaitTimeSeconds + value: '{{ ReceiveMessageWaitTimeSeconds }}' + - name: RedriveAllowPolicy + value: {} + - name: RedrivePolicy + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VisibilityTimeout + value: '{{ VisibilityTimeout }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sqs.queues +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +sqs:GetQueueAttributes, +sqs:ListQueueTags +``` + +### Update +```json +sqs:SetQueueAttributes, +sqs:GetQueueAttributes, +sqs:ListQueueTags, +sqs:TagQueue, +sqs:UntagQueue +``` + +### Delete +```json +sqs:DeleteQueue, +sqs:GetQueueAttributes +``` + +### List +```json +sqs:ListQueues +``` diff --git a/website/docs/services/sqs/queues_list_only/index.md b/website/docs/services/sqs/queues_list_only/index.md new file mode 100644 index 0000000..e523cbc --- /dev/null +++ b/website/docs/services/sqs/queues_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queues_list_only + - sqs + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queues in a region or regions, for all properties use queues + +## Overview + + + + + + + +
Namequeues_list_only
TypeResource
DescriptionThe AWS::SQS::Queue resource creates an SQS standard or FIFO queue.
Keep the following caveats in mind:
+ If you don't specify the FifoQueue property, SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*.
+ If you don't provide a value for a property, the queue is created with the default value for the property.
+ If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
+ To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.

For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/create-queue-cloudformation.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queues in a region. +```sql +SELECT +region, +queue_url +FROM aws.sqs.queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queues_list_only resource, see queues + diff --git a/website/docs/services/ssm/associations/index.md b/website/docs/services/ssm/associations/index.md new file mode 100644 index 0000000..da159b2 --- /dev/null +++ b/website/docs/services/ssm/associations/index.md @@ -0,0 +1,327 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an association resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the association.
array
stringA Cron or Rate expression that specifies when the association is applied to the target.
string
objectParameter values that the SSM document uses at runtime.
stringThe ID of the instance that the SSM document is associated with.
integer
string
string
arrayThe targets that the SSM document sends commands to.
string
object
integer
stringThe name of the SSM document.
boolean
stringThe version of the SSM document to associate with the target.
stringUnique identifier of the association.
string
stringAWS region.
+ +For more information, see AWS::SSM::Association. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all associations in a region. +```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.associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual association. +```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.associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.associations ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.associations ( + AssociationName, + CalendarNames, + ScheduleExpression, + MaxErrors, + Parameters, + InstanceId, + WaitForSuccessTimeoutSeconds, + MaxConcurrency, + ComplianceSeverity, + Targets, + SyncCompliance, + OutputLocation, + ScheduleOffset, + Name, + ApplyOnlyAtCronInterval, + DocumentVersion, + AutomationTargetParameterName, + region +) +SELECT + '{{ AssociationName }}', + '{{ CalendarNames }}', + '{{ ScheduleExpression }}', + '{{ MaxErrors }}', + '{{ Parameters }}', + '{{ InstanceId }}', + '{{ WaitForSuccessTimeoutSeconds }}', + '{{ MaxConcurrency }}', + '{{ ComplianceSeverity }}', + '{{ Targets }}', + '{{ SyncCompliance }}', + '{{ OutputLocation }}', + '{{ ScheduleOffset }}', + '{{ Name }}', + '{{ ApplyOnlyAtCronInterval }}', + '{{ DocumentVersion }}', + '{{ AutomationTargetParameterName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: association + props: + - name: AssociationName + value: '{{ AssociationName }}' + - name: CalendarNames + value: + - '{{ CalendarNames[0] }}' + - name: ScheduleExpression + value: '{{ ScheduleExpression }}' + - name: MaxErrors + value: '{{ MaxErrors }}' + - name: Parameters + value: {} + - name: InstanceId + value: '{{ InstanceId }}' + - name: WaitForSuccessTimeoutSeconds + value: '{{ WaitForSuccessTimeoutSeconds }}' + - name: MaxConcurrency + value: '{{ MaxConcurrency }}' + - name: ComplianceSeverity + value: '{{ ComplianceSeverity }}' + - name: Targets + value: + - Values: + - '{{ Values[0] }}' + Key: '{{ Key }}' + - name: SyncCompliance + value: '{{ SyncCompliance }}' + - name: OutputLocation + value: + S3Location: + OutputS3KeyPrefix: '{{ OutputS3KeyPrefix }}' + OutputS3Region: '{{ OutputS3Region }}' + OutputS3BucketName: '{{ OutputS3BucketName }}' + - name: ScheduleOffset + value: '{{ ScheduleOffset }}' + - name: Name + value: '{{ Name }}' + - name: ApplyOnlyAtCronInterval + value: '{{ ApplyOnlyAtCronInterval }}' + - name: DocumentVersion + value: '{{ DocumentVersion }}' + - name: AutomationTargetParameterName + value: '{{ AutomationTargetParameterName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssm.associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the associations resource, the following permissions are required: + +### Read +```json +ssm:DescribeAssociation, +resource-groups:GetGroupQuery, +resource-groups:ListGroups, +resource-groups:ListGroupResources +``` + +### Create +```json +ec2:DescribeInstanceStatus, +iam:PassRole, +iam:CreateServiceLinkedRole, +ssm:CreateAssociation, +ssm:DescribeAssociation, +ssm:GetCalendarState +``` + +### Update +```json +iam:PassRole, +ssm:UpdateAssociation, +ssm:GetCalendarState +``` + +### List +```json +ssm:ListAssociations +``` + +### Delete +```json +ssm:DeleteAssociation +``` diff --git a/website/docs/services/ssm/associations_list_only/index.md b/website/docs/services/ssm/associations_list_only/index.md new file mode 100644 index 0000000..a672d4c --- /dev/null +++ b/website/docs/services/ssm/associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - associations_list_only + - ssm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists associations in a region or regions, for all properties use associations + +## Overview + + + + + + + +
Nameassociations_list_only
TypeResource
DescriptionThe AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique identifier of the association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all associations in a region. +```sql +SELECT +region, +association_id +FROM aws.ssm.associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the associations_list_only resource, see associations + diff --git a/website/docs/services/ssm/document_tags/index.md b/website/docs/services/ssm/document_tags/index.md new file mode 100644 index 0000000..f2924fe --- /dev/null +++ b/website/docs/services/ssm/document_tags/index.md @@ -0,0 +1,93 @@ +--- +title: document_tags +hide_title: false +hide_table_of_contents: false +keywords: + - document_tags + - ssm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for documents in a region + +## Overview + + + + + + + +
Namedocument_tags
TypeResource
DescriptionThe AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe content for the Systems Manager document in JSON, YAML or String format.
arrayA list of key and value pairs that describe attachments to a version of a document.
stringA name for the Systems Manager document.
stringAn optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
stringThe type of document to create.
stringSpecify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
stringSpecify a target type to define the kinds of resources the document can run on.
arrayA list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
stringUpdate method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all documents in a region. +```sql +SELECT +region, +content, +attachments, +name, +version_name, +document_type, +document_format, +target_type, +requires, +update_method, +tag_key, +tag_value +FROM aws.ssm.document_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the document_tags resource, see documents + diff --git a/website/docs/services/ssm/documents/index.md b/website/docs/services/ssm/documents/index.md new file mode 100644 index 0000000..c0b3926 --- /dev/null +++ b/website/docs/services/ssm/documents/index.md @@ -0,0 +1,279 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a document resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe content for the Systems Manager document in JSON, YAML or String format.
arrayA list of key and value pairs that describe attachments to a version of a document.
stringA name for the Systems Manager document.
stringAn optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
stringThe type of document to create.
stringSpecify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
stringSpecify a target type to define the kinds of resources the document can run on.
arrayOptional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
arrayA list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
stringUpdate method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
stringAWS region.
+ +For more information, see AWS::SSM::Document. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all documents in a region. +```sql +SELECT +region, +content, +attachments, +name, +version_name, +document_type, +document_format, +target_type, +tags, +requires, +update_method +FROM aws.ssm.documents +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual document. +```sql +SELECT +region, +content, +attachments, +name, +version_name, +document_type, +document_format, +target_type, +tags, +requires, +update_method +FROM aws.ssm.documents +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new document resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.documents ( + Content, + region +) +SELECT +'{{ Content }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.documents ( + Content, + Attachments, + Name, + VersionName, + DocumentType, + DocumentFormat, + TargetType, + Tags, + Requires, + UpdateMethod, + region +) +SELECT + '{{ Content }}', + '{{ Attachments }}', + '{{ Name }}', + '{{ VersionName }}', + '{{ DocumentType }}', + '{{ DocumentFormat }}', + '{{ TargetType }}', + '{{ Tags }}', + '{{ Requires }}', + '{{ UpdateMethod }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: document + props: + - name: Content + value: {} + - name: Attachments + value: + - Key: '{{ Key }}' + Values: + - '{{ Values[0] }}' + Name: '{{ Name }}' + - name: Name + value: '{{ Name }}' + - name: VersionName + value: '{{ VersionName }}' + - name: DocumentType + value: '{{ DocumentType }}' + - name: DocumentFormat + value: '{{ DocumentFormat }}' + - name: TargetType + value: '{{ TargetType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Requires + value: + - Name: '{{ Name }}' + Version: '{{ Version }}' + - name: UpdateMethod + value: '{{ UpdateMethod }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssm.documents +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ssm:ListDocuments +``` diff --git a/website/docs/services/ssm/documents_list_only/index.md b/website/docs/services/ssm/documents_list_only/index.md new file mode 100644 index 0000000..a97ab92 --- /dev/null +++ b/website/docs/services/ssm/documents_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: documents_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - documents_list_only + - ssm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists documents in a region or regions, for all properties use documents + +## Overview + + + + + + + +
Namedocuments_list_only
TypeResource
DescriptionThe AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the Systems Manager document.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all documents in a region. +```sql +SELECT +region, +name +FROM aws.ssm.documents_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the documents_list_only resource, see documents + diff --git a/website/docs/services/ssm/index.md b/website/docs/services/ssm/index.md new file mode 100644 index 0000000..93864f9 --- /dev/null +++ b/website/docs/services/ssm/index.md @@ -0,0 +1,50 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The ssm service documentation. + +:::info Service Summary + +
+
+total resources: 15
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/ssm/parameter_tags/index.md b/website/docs/services/ssm/parameter_tags/index.md new file mode 100644 index 0000000..8fb6c2b --- /dev/null +++ b/website/docs/services/ssm/parameter_tags/index.md @@ -0,0 +1,91 @@ +--- +title: parameter_tags +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_tags + - ssm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for parameters in a region + +## Overview + + + + + + + +
Nameparameter_tags
TypeResource
DescriptionThe AWS::SSM::Parameter resource creates an SSM parameter in SYSlong Parameter Store.
To create an SSM parameter, you must have the IAMlong (IAM) permissions ssm:PutParameter and ssm:AddTagsToResource. On stack creation, CFNlong adds the following three tags to the parameter: aws:cloudformation:stack-name, aws:cloudformation:logical-id, and aws:cloudformation:stack-id, in addition to any custom tags you specify.
To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource and ssm:RemoveTagsFromResource. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.
For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of parameter.
stringThe parameter value.
If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
stringInformation about the parameter.
stringInformation about the policies assigned to a parameter.
[Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*.
stringA regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
stringThe parameter tier.
stringThe data type of the parameter, such as text or aws:ec2:image. The default is text.
stringThe name of the parameter.
The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all parameters in a region. +```sql +SELECT +region, +type, +value, +description, +policies, +allowed_pattern, +tier, +data_type, +name, +tag_key, +tag_value +FROM aws.ssm.parameter_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameter_tags resource, see parameters + diff --git a/website/docs/services/ssm/parameters/index.md b/website/docs/services/ssm/parameters/index.md new file mode 100644 index 0000000..0e069b4 --- /dev/null +++ b/website/docs/services/ssm/parameters/index.md @@ -0,0 +1,257 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a parameter resource or lists parameters in a region + +## Overview + + + + + + + +
Nameparameters
TypeResource
DescriptionThe AWS::SSM::Parameter resource creates an SSM parameter in SYSlong Parameter Store.
To create an SSM parameter, you must have the IAMlong (IAM) permissions ssm:PutParameter and ssm:AddTagsToResource. On stack creation, CFNlong adds the following three tags to the parameter: aws:cloudformation:stack-name, aws:cloudformation:logical-id, and aws:cloudformation:stack-id, in addition to any custom tags you specify.
To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource and ssm:RemoveTagsFromResource. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.
For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of parameter.
stringThe parameter value.
If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
stringInformation about the parameter.
stringInformation about the policies assigned to a parameter.
[Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*.
stringA regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
stringThe parameter tier.
objectOptional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
stringThe data type of the parameter, such as text or aws:ec2:image. The default is text.
stringThe name of the parameter.
The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
stringAWS region.
+ +For more information, see AWS::SSM::Parameter. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all parameters in a region. +```sql +SELECT +region, +type, +value, +description, +policies, +allowed_pattern, +tier, +tags, +data_type, +name +FROM aws.ssm.parameters +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual parameter. +```sql +SELECT +region, +type, +value, +description, +policies, +allowed_pattern, +tier, +tags, +data_type, +name +FROM aws.ssm.parameters +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new parameter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.parameters ( + Type, + Value, + region +) +SELECT +'{{ Type }}', + '{{ Value }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.parameters ( + Type, + Value, + Description, + Policies, + AllowedPattern, + Tier, + Tags, + DataType, + Name, + region +) +SELECT + '{{ Type }}', + '{{ Value }}', + '{{ Description }}', + '{{ Policies }}', + '{{ AllowedPattern }}', + '{{ Tier }}', + '{{ Tags }}', + '{{ DataType }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: parameter + props: + - name: Type + value: '{{ Type }}' + - name: Value + value: '{{ Value }}' + - name: Description + value: '{{ Description }}' + - name: Policies + value: '{{ Policies }}' + - name: AllowedPattern + value: '{{ AllowedPattern }}' + - name: Tier + value: '{{ Tier }}' + - name: Tags + value: {} + - name: DataType + value: '{{ DataType }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssm.parameters +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the parameters resource, the following permissions are required: + +### Create +```json +ssm:PutParameter, +ssm:AddTagsToResource, +ssm:GetParameters +``` + +### Read +```json +ssm:GetParameters +``` + +### Update +```json +ssm:PutParameter, +ssm:AddTagsToResource, +ssm:RemoveTagsFromResource, +ssm:GetParameters +``` + +### Delete +```json +ssm:DeleteParameter +``` + +### List +```json +ssm:DescribeParameters +``` diff --git a/website/docs/services/ssm/parameters_list_only/index.md b/website/docs/services/ssm/parameters_list_only/index.md new file mode 100644 index 0000000..9694f0a --- /dev/null +++ b/website/docs/services/ssm/parameters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: parameters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - parameters_list_only + - ssm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists parameters in a region or regions, for all properties use parameters + +## Overview + + + + + + + +
Nameparameters_list_only
TypeResource
DescriptionThe AWS::SSM::Parameter resource creates an SSM parameter in SYSlong Parameter Store.
To create an SSM parameter, you must have the IAMlong (IAM) permissions ssm:PutParameter and ssm:AddTagsToResource. On stack creation, CFNlong adds the following three tags to the parameter: aws:cloudformation:stack-name, aws:cloudformation:logical-id, and aws:cloudformation:stack-id, in addition to any custom tags you specify.
To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource and ssm:RemoveTagsFromResource. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.
For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the parameter.
The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all parameters in a region. +```sql +SELECT +region, +name +FROM aws.ssm.parameters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameters_list_only resource, see parameters + diff --git a/website/docs/services/ssm/patch_baseline_tags/index.md b/website/docs/services/ssm/patch_baseline_tags/index.md new file mode 100644 index 0000000..b177490 --- /dev/null +++ b/website/docs/services/ssm/patch_baseline_tags/index.md @@ -0,0 +1,103 @@ +--- +title: patch_baseline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - patch_baseline_tags + - ssm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for patch_baselines in a region + +## Overview + + + + + + + +
Namepatch_baseline_tags
TypeResource
DescriptionResource Type definition for AWS::SSM::PatchBaseline
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the patch baseline.
booleanSet the baseline as default baseline. Only registering to default patch baseline is allowed.
stringDefines the operating system the patch baseline applies to. The Default value is WINDOWS.
stringThe description of the patch baseline.
objectA set of rules defining the approval rules for a patch baseline.
arrayInformation about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.
stringThe name of the patch baseline.
arrayA list of explicitly rejected patches for the baseline.
arrayA list of explicitly approved patches for the baseline.
stringThe action for Patch Manager to take on patches included in the RejectedPackages list.
arrayPatchGroups is used to associate instances with a specific patch baseline
stringDefines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.
booleanIndicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
objectA set of global filters used to include patches in the baseline.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all patch_baselines in a region. +```sql +SELECT +region, +id, +default_baseline, +operating_system, +description, +approval_rules, +sources, +name, +rejected_patches, +approved_patches, +rejected_patches_action, +patch_groups, +approved_patches_compliance_level, +approved_patches_enable_non_security, +global_filters, +tag_key, +tag_value +FROM aws.ssm.patch_baseline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the patch_baseline_tags resource, see patch_baselines + diff --git a/website/docs/services/ssm/patch_baselines/index.md b/website/docs/services/ssm/patch_baselines/index.md new file mode 100644 index 0000000..cd1bf84 --- /dev/null +++ b/website/docs/services/ssm/patch_baselines/index.md @@ -0,0 +1,326 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a patch_baseline resource or lists patch_baselines in a region + +## Overview + + + + + + + +
Namepatch_baselines
TypeResource
DescriptionResource Type definition for AWS::SSM::PatchBaseline
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the patch baseline.
booleanSet the baseline as default baseline. Only registering to default patch baseline is allowed.
stringDefines the operating system the patch baseline applies to. The Default value is WINDOWS.
stringThe description of the patch baseline.
objectA set of rules defining the approval rules for a patch baseline.
arrayInformation about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.
stringThe name of the patch baseline.
arrayA list of explicitly rejected patches for the baseline.
arrayA list of explicitly approved patches for the baseline.
stringThe action for Patch Manager to take on patches included in the RejectedPackages list.
arrayPatchGroups is used to associate instances with a specific patch baseline
stringDefines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.
booleanIndicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
objectA set of global filters used to include patches in the baseline.
arrayOptional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways.
stringAWS region.
+ +For more information, see AWS::SSM::PatchBaseline. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all patch_baselines in a region. +```sql +SELECT +region, +id, +default_baseline, +operating_system, +description, +approval_rules, +sources, +name, +rejected_patches, +approved_patches, +rejected_patches_action, +patch_groups, +approved_patches_compliance_level, +approved_patches_enable_non_security, +global_filters, +tags +FROM aws.ssm.patch_baselines +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual patch_baseline. +```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_baselines +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new patch_baseline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.patch_baselines ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.patch_baselines ( + DefaultBaseline, + OperatingSystem, + Description, + ApprovalRules, + Sources, + Name, + RejectedPatches, + ApprovedPatches, + RejectedPatchesAction, + PatchGroups, + ApprovedPatchesComplianceLevel, + ApprovedPatchesEnableNonSecurity, + GlobalFilters, + Tags, + region +) +SELECT + '{{ DefaultBaseline }}', + '{{ OperatingSystem }}', + '{{ Description }}', + '{{ ApprovalRules }}', + '{{ Sources }}', + '{{ Name }}', + '{{ RejectedPatches }}', + '{{ ApprovedPatches }}', + '{{ RejectedPatchesAction }}', + '{{ PatchGroups }}', + '{{ ApprovedPatchesComplianceLevel }}', + '{{ ApprovedPatchesEnableNonSecurity }}', + '{{ GlobalFilters }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: patch_baseline + props: + - name: DefaultBaseline + value: '{{ DefaultBaseline }}' + - name: OperatingSystem + value: '{{ OperatingSystem }}' + - name: Description + value: '{{ Description }}' + - name: ApprovalRules + value: + PatchRules: + - ApproveUntilDate: '{{ ApproveUntilDate }}' + EnableNonSecurity: '{{ EnableNonSecurity }}' + PatchFilterGroup: + PatchFilters: + - Values: + - '{{ Values[0] }}' + Key: '{{ Key }}' + ApproveAfterDays: '{{ ApproveAfterDays }}' + ComplianceLevel: '{{ ComplianceLevel }}' + - name: Sources + value: + - Products: + - '{{ Products[0] }}' + Configuration: '{{ Configuration }}' + Name: '{{ Name }}' + - name: Name + value: '{{ Name }}' + - name: RejectedPatches + value: + - '{{ RejectedPatches[0] }}' + - name: ApprovedPatches + value: + - '{{ ApprovedPatches[0] }}' + - name: RejectedPatchesAction + value: '{{ RejectedPatchesAction }}' + - name: PatchGroups + value: + - '{{ PatchGroups[0] }}' + - name: ApprovedPatchesComplianceLevel + value: '{{ ApprovedPatchesComplianceLevel }}' + - name: ApprovedPatchesEnableNonSecurity + value: '{{ ApprovedPatchesEnableNonSecurity }}' + - name: GlobalFilters + value: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssm.patch_baselines +WHERE data__Identifier = '' +AND 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 +``` + +### Delete +```json +ssm:DeletePatchBaseline, +ssm:GetPatchBaseline, +ssm:DeregisterPatchBaselineForPatchGroup +``` + +### List +```json +ssm:DescribePatchBaselines, +ssm:GetDefaultPatchBaseline, +ssm:GetPatchBaseline, +ssm:ListTagsForResource +``` + +### 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/website/docs/services/ssm/patch_baselines_list_only/index.md b/website/docs/services/ssm/patch_baselines_list_only/index.md new file mode 100644 index 0000000..b3e48c5 --- /dev/null +++ b/website/docs/services/ssm/patch_baselines_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: patch_baselines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - patch_baselines_list_only + - ssm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists patch_baselines in a region or regions, for all properties use patch_baselines + +## Overview + + + + + + + +
Namepatch_baselines_list_only
TypeResource
DescriptionResource Type definition for AWS::SSM::PatchBaseline
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the patch baseline.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all patch_baselines in a region. +```sql +SELECT +region, +id +FROM aws.ssm.patch_baselines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the patch_baselines_list_only resource, see patch_baselines + diff --git a/website/docs/services/ssm/resource_data_syncs/index.md b/website/docs/services/ssm/resource_data_syncs/index.md new file mode 100644 index 0000000..a75b551 --- /dev/null +++ b/website/docs/services/ssm/resource_data_syncs/index.md @@ -0,0 +1,262 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_data_sync resource or lists resource_data_syncs in a region + +## Overview + + + + + + + +
Nameresource_data_syncs
TypeResource
DescriptionResource Type definition for AWS::SSM::ResourceDataSync
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
object
string
string
string
string
string
string
stringAWS region.
+ +For more information, see AWS::SSM::ResourceDataSync. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_data_syncs in a region. +```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_syncs +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_data_sync. +```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_syncs +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_data_sync resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.resource_data_syncs ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.resource_data_syncs ( + S3Destination, + KMSKeyArn, + SyncSource, + BucketName, + BucketRegion, + SyncFormat, + SyncType, + BucketPrefix, + region +) +SELECT + '{{ S3Destination }}', + '{{ KMSKeyArn }}', + '{{ SyncSource }}', + '{{ BucketName }}', + '{{ BucketRegion }}', + '{{ SyncFormat }}', + '{{ SyncType }}', + '{{ BucketPrefix }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_data_sync + props: + - name: S3Destination + value: + KMSKeyArn: '{{ KMSKeyArn }}' + BucketPrefix: '{{ BucketPrefix }}' + BucketName: '{{ BucketName }}' + BucketRegion: '{{ BucketRegion }}' + SyncFormat: '{{ SyncFormat }}' + - name: KMSKeyArn + value: '{{ KMSKeyArn }}' + - name: SyncSource + value: + IncludeFutureRegions: '{{ IncludeFutureRegions }}' + SourceRegions: + - '{{ SourceRegions[0] }}' + SourceType: '{{ SourceType }}' + AwsOrganizationsSource: + OrganizationalUnits: + - '{{ OrganizationalUnits[0] }}' + OrganizationSourceType: '{{ OrganizationSourceType }}' + - name: BucketName + value: '{{ BucketName }}' + - name: BucketRegion + value: '{{ BucketRegion }}' + - name: SyncFormat + value: '{{ SyncFormat }}' + - name: SyncType + value: '{{ SyncType }}' + - name: BucketPrefix + value: '{{ BucketPrefix }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssm.resource_data_syncs +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_data_syncs resource, the following permissions are required: + +### Create +```json +ssm:CreateResourceDataSync, +ssm:ListResourceDataSync +``` + +### Delete +```json +ssm:ListResourceDataSync, +ssm:DeleteResourceDataSync +``` + +### Update +```json +ssm:ListResourceDataSync, +ssm:UpdateResourceDataSync +``` + +### List +```json +ssm:ListResourceDataSync +``` + +### Read +```json +ssm:ListResourceDataSync +``` diff --git a/website/docs/services/ssm/resource_data_syncs_list_only/index.md b/website/docs/services/ssm/resource_data_syncs_list_only/index.md new file mode 100644 index 0000000..114beda --- /dev/null +++ b/website/docs/services/ssm/resource_data_syncs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_data_syncs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_data_syncs_list_only + - ssm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_data_syncs in a region or regions, for all properties use resource_data_syncs + +## Overview + + + + + + + +
Nameresource_data_syncs_list_only
TypeResource
DescriptionResource Type definition for AWS::SSM::ResourceDataSync
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_data_syncs in a region. +```sql +SELECT +region, +sync_name +FROM aws.ssm.resource_data_syncs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_data_syncs_list_only resource, see resource_data_syncs + diff --git a/website/docs/services/ssm/resource_policies/index.md b/website/docs/services/ssm/resource_policies/index.md new file mode 100644 index 0000000..ef1d7ec --- /dev/null +++ b/website/docs/services/ssm/resource_policies/index.md @@ -0,0 +1,211 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_policy resource or lists resource_policies in a region + +## Overview + + + + + + + +
Nameresource_policies
TypeResource
DescriptionResource Type definition for AWS::SSM::ResourcePolicy
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringArn of OpsItemGroup etc.
objectActual policy statement.
stringAn unique identifier within the policies of a resource.
stringA snapshot identifier for the policy over time.
stringAWS region.
+ +For more information, see AWS::SSM::ResourcePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_policies in a region. +```sql +SELECT +region, +resource_arn, +policy, +policy_id, +policy_hash +FROM aws.ssm.resource_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_policy. +```sql +SELECT +region, +resource_arn, +policy, +policy_id, +policy_hash +FROM aws.ssm.resource_policies +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.resource_policies ( + ResourceArn, + Policy, + region +) +SELECT +'{{ ResourceArn }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssm.resource_policies ( + ResourceArn, + Policy, + region +) +SELECT + '{{ ResourceArn }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_policy + props: + - name: ResourceArn + value: '{{ ResourceArn }}' + - name: Policy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssm.resource_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +ssm:PutResourcePolicy +``` + +### Read +```json +ssm:GetResourcePolicies +``` + +### Update +```json +ssm:GetResourcePolicies, +ssm:PutResourcePolicy +``` + +### Delete +```json +ssm:GetResourcePolicies, +ssm:DeleteResourcePolicy +``` + +### List +```json +ssm:GetResourcePolicies +``` diff --git a/website/docs/services/ssm/resource_policies_list_only/index.md b/website/docs/services/ssm/resource_policies_list_only/index.md new file mode 100644 index 0000000..1bc92ed --- /dev/null +++ b/website/docs/services/ssm/resource_policies_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - ssm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::SSM::ResourcePolicy
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringArn of OpsItemGroup etc.
objectActual policy statement.
stringAn unique identifier within the policies of a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +policy_id, +resource_arn +FROM aws.ssm.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + diff --git a/website/docs/services/ssmcontacts/contact_channels/index.md b/website/docs/services/ssmcontacts/contact_channels/index.md new file mode 100644 index 0000000..cb38acc --- /dev/null +++ b/website/docs/services/ssmcontacts/contact_channels/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a contact_channel resource or lists contact_channels in a region + +## Overview + + + + + + + +
Namecontact_channels
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::ContactChannel
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringARN of the contact resource
stringThe device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
stringDevice type, which specify notification channel. Currently supported values: “SMS”, “VOICE”, “EMAIL”, “CHATBOT.
booleanIf you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.
stringThe details that SSM Incident Manager uses when trying to engage the contact channel.
stringThe Amazon Resource Name (ARN) of the engagement to a contact channel.
stringAWS region.
+ +For more information, see AWS::SSMContacts::ContactChannel. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all contact_channels in a region. +```sql +SELECT +region, +contact_id, +channel_name, +channel_type, +defer_activation, +channel_address, +arn +FROM aws.ssmcontacts.contact_channels +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual contact_channel. +```sql +SELECT +region, +contact_id, +channel_name, +channel_type, +defer_activation, +channel_address, +arn +FROM aws.ssmcontacts.contact_channels +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new contact_channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssmcontacts.contact_channels ( + ContactId, + ChannelName, + ChannelType, + DeferActivation, + ChannelAddress, + region +) +SELECT +'{{ ContactId }}', + '{{ ChannelName }}', + '{{ ChannelType }}', + '{{ DeferActivation }}', + '{{ ChannelAddress }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssmcontacts.contact_channels ( + ContactId, + ChannelName, + ChannelType, + DeferActivation, + ChannelAddress, + region +) +SELECT + '{{ ContactId }}', + '{{ ChannelName }}', + '{{ ChannelType }}', + '{{ DeferActivation }}', + '{{ ChannelAddress }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: contact_channel + props: + - name: ContactId + value: '{{ ContactId }}' + - name: ChannelName + value: '{{ ChannelName }}' + - name: ChannelType + value: '{{ ChannelType }}' + - name: DeferActivation + value: '{{ DeferActivation }}' + - name: ChannelAddress + value: '{{ ChannelAddress }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssmcontacts.contact_channels +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +ssm-contacts:GetContactChannel +``` + +### Update +```json +ssm-contacts:UpdateContactChannel, +ssm-contacts:GetContactChannel +``` + +### Delete +```json +ssm-contacts:DeleteContactChannel, +ssm-contacts:GetContactChannel +``` + +### List +```json +ssm-contacts:ListContactChannels +``` diff --git a/website/docs/services/ssmcontacts/contact_channels_list_only/index.md b/website/docs/services/ssmcontacts/contact_channels_list_only/index.md new file mode 100644 index 0000000..01a1f93 --- /dev/null +++ b/website/docs/services/ssmcontacts/contact_channels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: contact_channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - contact_channels_list_only + - ssmcontacts + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists contact_channels in a region or regions, for all properties use contact_channels + +## Overview + + + + + + + +
Namecontact_channels_list_only
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::ContactChannel
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the engagement to a contact channel.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all contact_channels in a region. +```sql +SELECT +region, +arn +FROM aws.ssmcontacts.contact_channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_channels_list_only resource, see contact_channels + diff --git a/website/docs/services/ssmcontacts/contacts/index.md b/website/docs/services/ssmcontacts/contacts/index.md new file mode 100644 index 0000000..cd405f9 --- /dev/null +++ b/website/docs/services/ssmcontacts/contacts/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a contact resource or lists contacts in a region + +## Overview + + + + + + + +
Namecontacts
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::Contact
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringAlias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.
stringName of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.
stringContact type, which specify type of contact. Currently supported values: “PERSONAL”, “SHARED”, “OTHER“.
arrayThe stages that an escalation plan or engagement plan engages contacts and contact methods in.
stringThe Amazon Resource Name (ARN) of the contact.
stringAWS region.
+ +For more information, see AWS::SSMContacts::Contact. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all contacts in a region. +```sql +SELECT +region, +alias, +display_name, +type, +plan, +arn +FROM aws.ssmcontacts.contacts +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual contact. +```sql +SELECT +region, +alias, +display_name, +type, +plan, +arn +FROM aws.ssmcontacts.contacts +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new contact resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssmcontacts.contacts ( + Alias, + DisplayName, + Type, + region +) +SELECT +'{{ Alias }}', + '{{ DisplayName }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssmcontacts.contacts ( + Alias, + DisplayName, + Type, + Plan, + region +) +SELECT + '{{ Alias }}', + '{{ DisplayName }}', + '{{ Type }}', + '{{ Plan }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: contact + props: + - name: Alias + value: '{{ Alias }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: Type + value: '{{ Type }}' + - name: Plan + value: + - DurationInMinutes: '{{ DurationInMinutes }}' + Targets: + - ContactTargetInfo: + ContactId: '{{ ContactId }}' + IsEssential: '{{ IsEssential }}' + ChannelTargetInfo: + ChannelId: '{{ ChannelId }}' + RetryIntervalInMinutes: '{{ RetryIntervalInMinutes }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssmcontacts.contacts +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ssm-contacts:ListContacts +``` diff --git a/website/docs/services/ssmcontacts/contacts_list_only/index.md b/website/docs/services/ssmcontacts/contacts_list_only/index.md new file mode 100644 index 0000000..098493d --- /dev/null +++ b/website/docs/services/ssmcontacts/contacts_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: contacts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - contacts_list_only + - ssmcontacts + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists contacts in a region or regions, for all properties use contacts + +## Overview + + + + + + + +
Namecontacts_list_only
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::Contact
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the contact.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all contacts in a region. +```sql +SELECT +region, +arn +FROM aws.ssmcontacts.contacts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contacts_list_only resource, see contacts + diff --git a/website/docs/services/ssmcontacts/index.md b/website/docs/services/ssmcontacts/index.md new file mode 100644 index 0000000..c32de9b --- /dev/null +++ b/website/docs/services/ssmcontacts/index.md @@ -0,0 +1,43 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The ssmcontacts service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/ssmcontacts/plans/index.md b/website/docs/services/ssmcontacts/plans/index.md new file mode 100644 index 0000000..52ccd9b --- /dev/null +++ b/website/docs/services/ssmcontacts/plans/index.md @@ -0,0 +1,210 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a plan resource or lists plans in a region + +## Overview + + + + + + + +
Nameplans
TypeResource
DescriptionEngagement Plan for a SSM Incident Manager Contact.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringContact ID for the AWS SSM Incident Manager Contact to associate the plan.
arrayThe stages that an escalation plan or engagement plan engages contacts and contact methods in.
arrayRotation Ids to associate with Oncall Contact for engagement.
stringThe Amazon Resource Name (ARN) of the contact.
stringAWS region.
+ +For more information, see AWS::SSMContacts::Plan. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual plan. +```sql +SELECT +region, +contact_id, +stages, +rotation_ids, +arn +FROM aws.ssmcontacts.plans +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssmcontacts.plans ( + ContactId, + Stages, + RotationIds, + region +) +SELECT +'{{ ContactId }}', + '{{ Stages }}', + '{{ RotationIds }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssmcontacts.plans ( + ContactId, + Stages, + RotationIds, + region +) +SELECT + '{{ ContactId }}', + '{{ Stages }}', + '{{ RotationIds }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: plan + props: + - name: ContactId + value: '{{ ContactId }}' + - name: Stages + value: + - DurationInMinutes: '{{ DurationInMinutes }}' + Targets: + - ContactTargetInfo: + ContactId: '{{ ContactId }}' + IsEssential: '{{ IsEssential }}' + ChannelTargetInfo: + ChannelId: '{{ ChannelId }}' + RetryIntervalInMinutes: '{{ RetryIntervalInMinutes }}' + - name: RotationIds + value: + - '{{ RotationIds[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssmcontacts.plans +WHERE data__Identifier = '' +AND 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 +``` + +### 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/website/docs/services/ssmcontacts/rotation_tags/index.md b/website/docs/services/ssmcontacts/rotation_tags/index.md new file mode 100644 index 0000000..fb0d5ed --- /dev/null +++ b/website/docs/services/ssmcontacts/rotation_tags/index.md @@ -0,0 +1,87 @@ +--- +title: rotation_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rotation_tags + - ssmcontacts + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rotations in a region + +## Overview + + + + + + + +
Namerotation_tags
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::Rotation.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the Rotation
arrayMembers of the rotation
stringStart time of the first shift of Oncall Schedule
stringTimeZone Identifier for the Oncall Schedule
objectInformation about when an on-call rotation is in effect and how long the rotation period lasts.
stringThe Amazon Resource Name (ARN) of the rotation.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rotations in a region. +```sql +SELECT +region, +name, +contact_ids, +start_time, +time_zone_id, +recurrence, +arn, +tag_key, +tag_value +FROM aws.ssmcontacts.rotation_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rotation_tags resource, see rotations + diff --git a/website/docs/services/ssmcontacts/rotations/index.md b/website/docs/services/ssmcontacts/rotations/index.md new file mode 100644 index 0000000..f496b43 --- /dev/null +++ b/website/docs/services/ssmcontacts/rotations/index.md @@ -0,0 +1,274 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a rotation resource or lists rotations in a region + +## Overview + + + + + + + +
Namerotations
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::Rotation.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of the Rotation
arrayMembers of the rotation
stringStart time of the first shift of Oncall Schedule
stringTimeZone Identifier for the Oncall Schedule
objectInformation about when an on-call rotation is in effect and how long the rotation period lasts.
array
stringThe Amazon Resource Name (ARN) of the rotation.
stringAWS region.
+ +For more information, see AWS::SSMContacts::Rotation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rotations in a region. +```sql +SELECT +region, +name, +contact_ids, +start_time, +time_zone_id, +recurrence, +tags, +arn +FROM aws.ssmcontacts.rotations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual rotation. +```sql +SELECT +region, +name, +contact_ids, +start_time, +time_zone_id, +recurrence, +tags, +arn +FROM aws.ssmcontacts.rotations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rotation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssmcontacts.rotations ( + Name, + ContactIds, + StartTime, + TimeZoneId, + Recurrence, + region +) +SELECT +'{{ Name }}', + '{{ ContactIds }}', + '{{ StartTime }}', + '{{ TimeZoneId }}', + '{{ Recurrence }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssmcontacts.rotations ( + Name, + ContactIds, + StartTime, + TimeZoneId, + Recurrence, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ ContactIds }}', + '{{ StartTime }}', + '{{ TimeZoneId }}', + '{{ Recurrence }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: rotation + props: + - name: Name + value: '{{ Name }}' + - name: ContactIds + value: + - '{{ ContactIds[0] }}' + - name: StartTime + value: '{{ StartTime }}' + - name: TimeZoneId + value: '{{ TimeZoneId }}' + - name: Recurrence + value: + MonthlySettings: + - DayOfMonth: '{{ DayOfMonth }}' + HandOffTime: '{{ HandOffTime }}' + WeeklySettings: + - DayOfWeek: '{{ DayOfWeek }}' + HandOffTime: null + DailySettings: + - null + NumberOfOnCalls: '{{ NumberOfOnCalls }}' + RecurrenceMultiplier: '{{ RecurrenceMultiplier }}' + ShiftCoverages: + - DayOfWeek: null + CoverageTimes: + - StartTime: null + EndTime: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssmcontacts.rotations +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ssm-contacts:ListRotations, +ssm-contacts:GetRotation, +ssm-contacts:ListTagsForResource +``` diff --git a/website/docs/services/ssmcontacts/rotations_list_only/index.md b/website/docs/services/ssmcontacts/rotations_list_only/index.md new file mode 100644 index 0000000..12f8b18 --- /dev/null +++ b/website/docs/services/ssmcontacts/rotations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: rotations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rotations_list_only + - ssmcontacts + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rotations in a region or regions, for all properties use rotations + +## Overview + + + + + + + +
Namerotations_list_only
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::Rotation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the rotation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rotations in a region. +```sql +SELECT +region, +arn +FROM aws.ssmcontacts.rotations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rotations_list_only resource, see rotations + diff --git a/website/docs/services/ssmincidents/index.md b/website/docs/services/ssmincidents/index.md new file mode 100644 index 0000000..ad26050 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The ssmincidents service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/ssmincidents/replication_set_tags/index.md b/website/docs/services/ssmincidents/replication_set_tags/index.md new file mode 100644 index 0000000..cdd41e5 --- /dev/null +++ b/website/docs/services/ssmincidents/replication_set_tags/index.md @@ -0,0 +1,81 @@ +--- +title: replication_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - replication_set_tags + - ssmincidents + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for replication_sets in a region + +## Overview + + + + + + + +
Namereplication_set_tags
TypeResource
DescriptionResource type definition for AWS::SSMIncidents::ReplicationSet
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the ReplicationSet.
arrayThe ReplicationSet configuration.
booleanConfigures the ReplicationSet deletion protection.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all replication_sets in a region. +```sql +SELECT +region, +arn, +regions, +deletion_protected, +tag_key, +tag_value +FROM aws.ssmincidents.replication_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replication_set_tags resource, see replication_sets + diff --git a/website/docs/services/ssmincidents/replication_sets/index.md b/website/docs/services/ssmincidents/replication_sets/index.md new file mode 100644 index 0000000..a791bf3 --- /dev/null +++ b/website/docs/services/ssmincidents/replication_sets/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a replication_set resource or lists replication_sets in a region + +## Overview + + + + + + + +
Namereplication_sets
TypeResource
DescriptionResource type definition for AWS::SSMIncidents::ReplicationSet
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the ReplicationSet.
arrayThe ReplicationSet configuration.
booleanConfigures the ReplicationSet deletion protection.
arrayThe tags to apply to the replication set.
stringAWS region.
+ +For more information, see AWS::SSMIncidents::ReplicationSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all replication_sets in a region. +```sql +SELECT +region, +arn, +regions, +deletion_protected, +tags +FROM aws.ssmincidents.replication_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual replication_set. +```sql +SELECT +region, +arn, +regions, +deletion_protected, +tags +FROM aws.ssmincidents.replication_sets +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new replication_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssmincidents.replication_sets ( + Regions, + region +) +SELECT +'{{ Regions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssmincidents.replication_sets ( + Regions, + DeletionProtected, + Tags, + region +) +SELECT + '{{ Regions }}', + '{{ DeletionProtected }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: replication_set + props: + - name: Regions + value: + - RegionName: '{{ RegionName }}' + RegionConfiguration: + SseKmsKeyId: '{{ SseKmsKeyId }}' + - name: DeletionProtected + value: '{{ DeletionProtected }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssmincidents.replication_sets +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +ssm-incidents:ListReplicationSets +``` diff --git a/website/docs/services/ssmincidents/replication_sets_list_only/index.md b/website/docs/services/ssmincidents/replication_sets_list_only/index.md new file mode 100644 index 0000000..fb9aeda --- /dev/null +++ b/website/docs/services/ssmincidents/replication_sets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: replication_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - replication_sets_list_only + - ssmincidents + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists replication_sets in a region or regions, for all properties use replication_sets + +## Overview + + + + + + + +
Namereplication_sets_list_only
TypeResource
DescriptionResource type definition for AWS::SSMIncidents::ReplicationSet
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the ReplicationSet.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all replication_sets in a region. +```sql +SELECT +region, +arn +FROM aws.ssmincidents.replication_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replication_sets_list_only resource, see replication_sets + diff --git a/website/docs/services/ssmincidents/response_plan_tags/index.md b/website/docs/services/ssmincidents/response_plan_tags/index.md new file mode 100644 index 0000000..426f936 --- /dev/null +++ b/website/docs/services/ssmincidents/response_plan_tags/index.md @@ -0,0 +1,91 @@ +--- +title: response_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - response_plan_tags + - ssmincidents + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for response_plans in a region + +## Overview + + + + + + + +
Nameresponse_plan_tags
TypeResource
DescriptionResource type definition for AWS::SSMIncidents::ResponsePlan
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the response plan.
stringThe name of the response plan.
stringThe display name of the response plan.
objectThe chat channel configuration.
arrayThe list of engagements to use.
arrayThe list of actions.
arrayThe list of integrations.
objectThe incident template configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all response_plans in a region. +```sql +SELECT +region, +arn, +name, +display_name, +chat_channel, +engagements, +actions, +integrations, +incident_template, +tag_key, +tag_value +FROM aws.ssmincidents.response_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the response_plan_tags resource, see response_plans + diff --git a/website/docs/services/ssmincidents/response_plans/index.md b/website/docs/services/ssmincidents/response_plans/index.md new file mode 100644 index 0000000..8e426e9 --- /dev/null +++ b/website/docs/services/ssmincidents/response_plans/index.md @@ -0,0 +1,302 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a response_plan resource or lists response_plans in a region + +## Overview + + + + + + + +
Nameresponse_plans
TypeResource
DescriptionResource type definition for AWS::SSMIncidents::ResponsePlan
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the response plan.
stringThe name of the response plan.
stringThe display name of the response plan.
objectThe chat channel configuration.
arrayThe list of engagements to use.
arrayThe list of actions.
arrayThe list of integrations.
arrayThe tags to apply to the response plan.
objectThe incident template configuration.
stringAWS region.
+ +For more information, see AWS::SSMIncidents::ResponsePlan. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all response_plans in a region. +```sql +SELECT +region, +arn, +name, +display_name, +chat_channel, +engagements, +actions, +integrations, +tags, +incident_template +FROM aws.ssmincidents.response_plans +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual response_plan. +```sql +SELECT +region, +arn, +name, +display_name, +chat_channel, +engagements, +actions, +integrations, +tags, +incident_template +FROM aws.ssmincidents.response_plans +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new response_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssmincidents.response_plans ( + Name, + IncidentTemplate, + region +) +SELECT +'{{ Name }}', + '{{ IncidentTemplate }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssmincidents.response_plans ( + Name, + DisplayName, + ChatChannel, + Engagements, + Actions, + Integrations, + Tags, + IncidentTemplate, + region +) +SELECT + '{{ Name }}', + '{{ DisplayName }}', + '{{ ChatChannel }}', + '{{ Engagements }}', + '{{ Actions }}', + '{{ Integrations }}', + '{{ Tags }}', + '{{ IncidentTemplate }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: response_plan + props: + - name: Name + value: '{{ Name }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: ChatChannel + value: + ChatbotSns: + - '{{ ChatbotSns[0] }}' + - name: Engagements + value: + - '{{ Engagements[0] }}' + - name: Actions + value: + - SsmAutomation: + RoleArn: '{{ RoleArn }}' + DocumentName: '{{ DocumentName }}' + DocumentVersion: '{{ DocumentVersion }}' + TargetAccount: '{{ TargetAccount }}' + Parameters: + - Key: '{{ Key }}' + Values: + - '{{ Values[0] }}' + DynamicParameters: + - Key: '{{ Key }}' + Value: + Variable: '{{ Variable }}' + - name: Integrations + value: + - PagerDutyConfiguration: + Name: '{{ Name }}' + SecretId: '{{ SecretId }}' + PagerDutyIncidentConfiguration: + ServiceId: '{{ ServiceId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: IncidentTemplate + value: + DedupeString: '{{ DedupeString }}' + Impact: '{{ Impact }}' + NotificationTargets: + - SnsTopicArn: null + Summary: '{{ Summary }}' + Title: '{{ Title }}' + IncidentTags: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssmincidents.response_plans +WHERE data__Identifier = '' +AND 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, +kms:GenerateDataKeyPair, +kms:GenerateDataKeyPairWithoutPlaintext, +kms:GenerateDataKeyWithoutPlaintext +``` + +### 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, +kms:GenerateDataKeyPair, +kms:GenerateDataKeyPairWithoutPlaintext, +kms:GenerateDataKeyWithoutPlaintext +``` + +### Delete +```json +ssm-incidents:DeleteResponsePlan, +ssm-incidents:GetResponsePlan +``` + +### List +```json +ssm-incidents:ListResponsePlans +``` diff --git a/website/docs/services/ssmincidents/response_plans_list_only/index.md b/website/docs/services/ssmincidents/response_plans_list_only/index.md new file mode 100644 index 0000000..1df9d6c --- /dev/null +++ b/website/docs/services/ssmincidents/response_plans_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: response_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - response_plans_list_only + - ssmincidents + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists response_plans in a region or regions, for all properties use response_plans + +## Overview + + + + + + + +
Nameresponse_plans_list_only
TypeResource
DescriptionResource type definition for AWS::SSMIncidents::ResponsePlan
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the response plan.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all response_plans in a region. +```sql +SELECT +region, +arn +FROM aws.ssmincidents.response_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the response_plans_list_only resource, see response_plans + diff --git a/website/docs/services/ssmquicksetup/configuration_manager_tags/index.md b/website/docs/services/ssmquicksetup/configuration_manager_tags/index.md new file mode 100644 index 0000000..0f1bc24 --- /dev/null +++ b/website/docs/services/ssmquicksetup/configuration_manager_tags/index.md @@ -0,0 +1,89 @@ +--- +title: configuration_manager_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_manager_tags + - ssmquicksetup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configuration_managers in a region + +## Overview + + + + + + + +
Nameconfiguration_manager_tags
TypeResource
DescriptionDefinition of AWS::SSMQuickSetup::ConfigurationManager Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configuration_managers in a region. +```sql +SELECT +region, +configuration_definitions, +created_at, +description, +last_modified_at, +manager_arn, +name, +status_summaries, +tag_key, +tag_value +FROM aws.ssmquicksetup.configuration_manager_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_manager_tags resource, see configuration_managers + diff --git a/website/docs/services/ssmquicksetup/configuration_managers/index.md b/website/docs/services/ssmquicksetup/configuration_managers/index.md new file mode 100644 index 0000000..b0e8362 --- /dev/null +++ b/website/docs/services/ssmquicksetup/configuration_managers/index.md @@ -0,0 +1,350 @@ +--- +title: configuration_managers +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_managers + - ssmquicksetup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a configuration_manager resource or lists configuration_managers in a region + +## Overview + + + + + + + +
Nameconfiguration_managers
TypeResource
DescriptionDefinition of AWS::SSMQuickSetup::ConfigurationManager Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
string
string
array
object
stringAWS region.
+ +For more information, see AWS::SSMQuickSetup::ConfigurationManager. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all configuration_managers in a region. +```sql +SELECT +region, +configuration_definitions, +created_at, +description, +last_modified_at, +manager_arn, +name, +status_summaries, +tags +FROM aws.ssmquicksetup.configuration_managers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual configuration_manager. +```sql +SELECT +region, +configuration_definitions, +created_at, +description, +last_modified_at, +manager_arn, +name, +status_summaries, +tags +FROM aws.ssmquicksetup.configuration_managers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configuration_manager resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.ssmquicksetup.configuration_managers ( + ConfigurationDefinitions, + region +) +SELECT +'{{ ConfigurationDefinitions }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.ssmquicksetup.configuration_managers ( + ConfigurationDefinitions, + Description, + Name, + Tags, + region +) +SELECT + '{{ ConfigurationDefinitions }}', + '{{ Description }}', + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: configuration_manager + props: + - name: ConfigurationDefinitions + value: + - Type: '{{ Type }}' + Parameters: {} + TypeVersion: '{{ TypeVersion }}' + LocalDeploymentExecutionRoleName: '{{ LocalDeploymentExecutionRoleName }}' + LocalDeploymentAdministrationRoleArn: '{{ LocalDeploymentAdministrationRoleArn }}' + id: '{{ id }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.ssmquicksetup.configuration_managers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the configuration_managers resource, the following permissions are required: + +### Create +```json +iam:GetRole, +iam:CreateServiceLinkedRole, +iam:ListRoles, +iam:PassRole, +ssm-quicksetup:CreateConfigurationManager, +ssm-quicksetup:GetConfigurationManager, +ssm-quicksetup:TagResource, +ssm-quicksetup:UntagResource, +ssm-quicksetup:UpdateConfigurationManager, +ssm:Describe*, +ssm:Get*, +ssm:List*, +ssm:DeleteAssociation, +ssm:CreateResourceDataSync, +ssm:UpdateResourceDataSync, +ssm:StartAutomationExecution, +ssm:CreateAssociation, +ssm:StartAssociationsOnce, +cloudformation:List*, +cloudformation:Describe*, +cloudformation:CreateStack, +cloudformation:CreateStackInstances, +cloudformation:CreateStackSet, +cloudformation:DeleteStack, +cloudformation:DeleteStackInstances, +cloudformation:DeleteStackSet, +cloudformation:UpdateStack, +cloudformation:UpdateStackSet, +cloudformation:StopStackSetOperation, +cloudformation:GetTemplate, +cloudformation:RollbackStack, +cloudformation:TagResource, +cloudformation:UntagResource, +organizations:Describe*, +organizations:List*, +organizations:RegisterDelegatedAdministrator, +organizations:DeregisterDelegatedAdministrator, +organizations:EnableAWSServiceAccess +``` + +### Read +```json +ssm-quicksetup:GetConfigurationManager, +iam:GetRole, +iam:PassRole, +iam:ListRoles, +ssm:DescribeDocument, +ssm:GetDocument +``` + +### Update +```json +iam:GetRole, +iam:CreateServiceLinkedRole, +iam:ListRoles, +iam:PassRole, +ssm-quicksetup:GetConfigurationManager, +ssm-quicksetup:TagResource, +ssm-quicksetup:UntagResource, +ssm-quicksetup:UpdateConfigurationManager, +ssm-quicksetup:UpdateConfigurationDefinition, +ssm:Describe*, +ssm:Get*, +ssm:List*, +ssm:DeleteAssociation, +ssm:CreateResourceDataSync, +ssm:UpdateResourceDataSync, +ssm:StartAutomationExecution, +ssm:CreateAssociation, +ssm:StartAssociationsOnce, +cloudformation:List*, +cloudformation:Describe*, +cloudformation:CreateStack, +cloudformation:CreateStackInstances, +cloudformation:CreateStackSet, +cloudformation:DeleteStack, +cloudformation:DeleteStackInstances, +cloudformation:DeleteStackSet, +cloudformation:UpdateStack, +cloudformation:UpdateStackSet, +cloudformation:StopStackSetOperation, +cloudformation:GetTemplate, +cloudformation:RollbackStack, +cloudformation:TagResource, +cloudformation:UntagResource, +organizations:Describe*, +organizations:List*, +organizations:RegisterDelegatedAdministrator, +organizations:DeregisterDelegatedAdministrator, +organizations:EnableAWSServiceAccess +``` + +### Delete +```json +ssm-quicksetup:DeleteConfigurationManager, +iam:GetRole, +iam:CreateServiceLinkedRole, +iam:ListRoles, +iam:PassRole, +ssm-quicksetup:GetConfigurationManager, +ssm-quicksetup:ListConfigurationManagers, +ssm-quicksetup:TagResource, +ssm-quicksetup:UntagResource, +ssm-quicksetup:UpdateConfigurationManager, +ssm:Describe*, +ssm:Get*, +ssm:List*, +ssm:DeleteAssociation, +ssm:CreateResourceDataSync, +ssm:UpdateResourceDataSync, +ssm:StartAutomationExecution, +ssm:CreateAssociation, +ssm:StartAssociationsOnce, +cloudformation:List*, +cloudformation:Describe*, +cloudformation:CreateStack, +cloudformation:CreateStackInstances, +cloudformation:CreateStackSet, +cloudformation:DeleteStack, +cloudformation:DeleteStackInstances, +cloudformation:DeleteStackSet, +cloudformation:UpdateStack, +cloudformation:UpdateStackSet, +cloudformation:StopStackSetOperation, +cloudformation:GetTemplate, +cloudformation:RollbackStack, +cloudformation:TagResource, +cloudformation:UntagResource, +organizations:Describe*, +organizations:List*, +organizations:RegisterDelegatedAdministrator, +organizations:DeregisterDelegatedAdministrator, +organizations:EnableAWSServiceAccess +``` + +### List +```json +ssm-quicksetup:ListConfigurationManagers +``` diff --git a/website/docs/services/ssmquicksetup/configuration_managers_list_only/index.md b/website/docs/services/ssmquicksetup/configuration_managers_list_only/index.md new file mode 100644 index 0000000..dcd5865 --- /dev/null +++ b/website/docs/services/ssmquicksetup/configuration_managers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: configuration_managers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_managers_list_only + - ssmquicksetup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_managers in a region or regions, for all properties use configuration_managers + +## Overview + + + + + + + +
Nameconfiguration_managers_list_only
TypeResource
DescriptionDefinition of AWS::SSMQuickSetup::ConfigurationManager Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_managers in a region. +```sql +SELECT +region, +manager_arn +FROM aws.ssmquicksetup.configuration_managers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_managers_list_only resource, see configuration_managers + diff --git a/website/docs/services/ssmquicksetup/index.md b/website/docs/services/ssmquicksetup/index.md new file mode 100644 index 0000000..6d8a4c8 --- /dev/null +++ b/website/docs/services/ssmquicksetup/index.md @@ -0,0 +1,38 @@ +--- +title: ssmquicksetup +hide_title: false +hide_table_of_contents: false +keywords: + - ssmquicksetup + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +The ssmquicksetup service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/sso/application_assignments/index.md b/website/docs/services/sso/application_assignments/index.md new file mode 100644 index 0000000..8409434 --- /dev/null +++ b/website/docs/services/sso/application_assignments/index.md @@ -0,0 +1,203 @@ +--- +title: application_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - application_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application_assignment resource or lists application_assignments in a region + +## Overview + + + + + + + +
Nameapplication_assignments
TypeResource
DescriptionResource Type definition for SSO application access grant to a user or group.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ARN of the application.
stringThe entity type for which the assignment will be created.
stringAn identifier for an object in IAM Identity Center, such as a user or group
stringAWS region.
+ +For more information, see AWS::SSO::ApplicationAssignment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all application_assignments in a region. +```sql +SELECT +region, +application_arn, +principal_type, +principal_id +FROM aws.sso.application_assignments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application_assignment. +```sql +SELECT +region, +application_arn, +principal_type, +principal_id +FROM aws.sso.application_assignments +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application_assignment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sso.application_assignments ( + ApplicationArn, + PrincipalType, + PrincipalId, + region +) +SELECT +'{{ ApplicationArn }}', + '{{ PrincipalType }}', + '{{ PrincipalId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sso.application_assignments ( + ApplicationArn, + PrincipalType, + PrincipalId, + region +) +SELECT + '{{ ApplicationArn }}', + '{{ PrincipalType }}', + '{{ PrincipalId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application_assignment + props: + - name: ApplicationArn + value: '{{ ApplicationArn }}' + - name: PrincipalType + value: '{{ PrincipalType }}' + - name: PrincipalId + value: '{{ PrincipalId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sso.application_assignments +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the application_assignments resource, the following permissions are required: + +### Create +```json +sso:CreateApplicationAssignment, +sso:DescribeApplicationAssignment +``` + +### Read +```json +sso:DescribeApplicationAssignment +``` + +### Delete +```json +sso:DeleteApplicationAssignment +``` + +### List +```json +sso:ListApplicationAssignments +``` diff --git a/website/docs/services/sso/application_assignments_list_only/index.md b/website/docs/services/sso/application_assignments_list_only/index.md new file mode 100644 index 0000000..2278b4e --- /dev/null +++ b/website/docs/services/sso/application_assignments_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: application_assignments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - application_assignments_list_only + - sso + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists application_assignments in a region or regions, for all properties use application_assignments + +## Overview + + + + + + + +
Nameapplication_assignments_list_only
TypeResource
DescriptionResource Type definition for SSO application access grant to a user or group.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ARN of the application.
stringThe entity type for which the assignment will be created.
stringAn identifier for an object in IAM Identity Center, such as a user or group
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all application_assignments in a region. +```sql +SELECT +region, +application_arn, +principal_type, +principal_id +FROM aws.sso.application_assignments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_assignments_list_only resource, see application_assignments + diff --git a/website/docs/services/sso/application_tags/index.md b/website/docs/services/sso/application_tags/index.md new file mode 100644 index 0000000..4c32448 --- /dev/null +++ b/website/docs/services/sso/application_tags/index.md @@ -0,0 +1,89 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - sso + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource Type definition for Identity Center (SSO) Application
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Identity Center (SSO) Application
stringThe description information for the Identity Center (SSO) Application
stringThe ARN of the instance of IAM Identity Center under which the operation will run
stringThe Application ARN that is returned upon creation of the Identity Center (SSO) Application
stringThe ARN of the application provider under which the operation will run
stringSpecifies whether the application is enabled or disabled
objectA structure that describes the options for the portal associated with an application
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +name, +description, +instance_arn, +application_arn, +application_provider_arn, +status, +portal_options, +tag_key, +tag_value +FROM aws.sso.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/sso/applications/index.md b/website/docs/services/sso/applications/index.md new file mode 100644 index 0000000..0b61f1f --- /dev/null +++ b/website/docs/services/sso/applications/index.md @@ -0,0 +1,256 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionResource Type definition for Identity Center (SSO) Application
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Identity Center (SSO) Application
stringThe description information for the Identity Center (SSO) Application
stringThe ARN of the instance of IAM Identity Center under which the operation will run
stringThe Application ARN that is returned upon creation of the Identity Center (SSO) Application
stringThe ARN of the application provider under which the operation will run
stringSpecifies whether the application is enabled or disabled
objectA structure that describes the options for the portal associated with an application
array
stringAWS region.
+ +For more information, see AWS::SSO::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +name, +description, +instance_arn, +application_arn, +application_provider_arn, +status, +portal_options, +tags +FROM aws.sso.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +name, +description, +instance_arn, +application_arn, +application_provider_arn, +status, +portal_options, +tags +FROM aws.sso.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sso.applications ( + Name, + InstanceArn, + ApplicationProviderArn, + region +) +SELECT +'{{ Name }}', + '{{ InstanceArn }}', + '{{ ApplicationProviderArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sso.applications ( + Name, + Description, + InstanceArn, + ApplicationProviderArn, + Status, + PortalOptions, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ InstanceArn }}', + '{{ ApplicationProviderArn }}', + '{{ Status }}', + '{{ PortalOptions }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: ApplicationProviderArn + value: '{{ ApplicationProviderArn }}' + - name: Status + value: '{{ Status }}' + - name: PortalOptions + value: + Visibility: '{{ Visibility }}' + SignInOptions: + Origin: '{{ Origin }}' + ApplicationUrl: '{{ ApplicationUrl }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sso.applications +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +sso:CreateApplication, +sso:DescribeApplication, +sso:TagResource +``` + +### Read +```json +sso:DescribeApplication, +sso:ListTagsForResource +``` + +### Update +```json +sso:UpdateApplication, +sso:TagResource, +sso:UntagResource, +sso:ListTagsForResource, +sso:DescribeApplication +``` + +### Delete +```json +sso:DeleteApplication +``` + +### List +```json +sso:ListApplications +``` diff --git a/website/docs/services/sso/applications_list_only/index.md b/website/docs/services/sso/applications_list_only/index.md new file mode 100644 index 0000000..14b1e69 --- /dev/null +++ b/website/docs/services/sso/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - sso + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource Type definition for Identity Center (SSO) Application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Application ARN that is returned upon creation of the Identity Center (SSO) Application
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_arn +FROM aws.sso.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/sso/assignments/index.md b/website/docs/services/sso/assignments/index.md new file mode 100644 index 0000000..fd2c40a --- /dev/null +++ b/website/docs/services/sso/assignments/index.md @@ -0,0 +1,244 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an assignment resource or lists assignments in a region + +## Overview + + + + + + + +
Nameassignments
TypeResource
DescriptionResource Type definition for SSO assignmet
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe sso instance that the permission set is owned.
stringThe account id to be provisioned.
stringThe type of resource to be provsioned to, only aws account now
stringThe permission set that the assignemt will be assigned
stringThe assignee's type, user/group
stringThe assignee's identifier, user id/group id
stringAWS region.
+ +For more information, see AWS::SSO::Assignment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all assignments in a region. +```sql +SELECT +region, +instance_arn, +target_id, +target_type, +permission_set_arn, +principal_type, +principal_id +FROM aws.sso.assignments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual assignment. +```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' AND data__Identifier = '|||||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new assignment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sso.assignments ( + InstanceArn, + TargetId, + TargetType, + PermissionSetArn, + PrincipalType, + PrincipalId, + region +) +SELECT +'{{ InstanceArn }}', + '{{ TargetId }}', + '{{ TargetType }}', + '{{ PermissionSetArn }}', + '{{ PrincipalType }}', + '{{ PrincipalId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sso.assignments ( + InstanceArn, + TargetId, + TargetType, + PermissionSetArn, + PrincipalType, + PrincipalId, + region +) +SELECT + '{{ InstanceArn }}', + '{{ TargetId }}', + '{{ TargetType }}', + '{{ PermissionSetArn }}', + '{{ PrincipalType }}', + '{{ PrincipalId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: assignment + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: TargetId + value: '{{ TargetId }}' + - name: TargetType + value: '{{ TargetType }}' + - name: PermissionSetArn + value: '{{ PermissionSetArn }}' + - name: PrincipalType + value: '{{ PrincipalType }}' + - name: PrincipalId + value: '{{ PrincipalId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sso.assignments +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +sso:ListAccountAssignments, +iam:GetSAMLProvider, +iam:ListRolePolicies +``` + +### Delete +```json +sso:ListAccountAssignments, +sso:DeleteAccountAssignment, +sso:DescribeAccountAssignmentDeletionStatus, +iam:GetSAMLProvider, +iam:ListRolePolicies +``` + +### List +```json +sso:ListAccountAssignments, +iam:ListRolePolicies +``` diff --git a/website/docs/services/sso/assignments_list_only/index.md b/website/docs/services/sso/assignments_list_only/index.md new file mode 100644 index 0000000..088b848 --- /dev/null +++ b/website/docs/services/sso/assignments_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: assignments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assignments_list_only + - sso + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assignments in a region or regions, for all properties use assignments + +## Overview + + + + + + + +
Nameassignments_list_only
TypeResource
DescriptionResource Type definition for SSO assignmet
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe sso instance that the permission set is owned.
stringThe account id to be provisioned.
stringThe type of resource to be provsioned to, only aws account now
stringThe permission set that the assignemt will be assigned
stringThe assignee's type, user/group
stringThe assignee's identifier, user id/group id
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assignments in a region. +```sql +SELECT +region, +instance_arn, +target_id, +target_type, +permission_set_arn, +principal_type, +principal_id +FROM aws.sso.assignments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assignments_list_only resource, see assignments + diff --git a/website/docs/services/sso/index.md b/website/docs/services/sso/index.md new file mode 100644 index 0000000..67fc09b --- /dev/null +++ b/website/docs/services/sso/index.md @@ -0,0 +1,50 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The sso service documentation. + +:::info Service Summary + +
+
+total resources: 15
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/sso/instance_access_control_attribute_configurations/index.md b/website/docs/services/sso/instance_access_control_attribute_configurations/index.md new file mode 100644 index 0000000..d5ac4aa --- /dev/null +++ b/website/docs/services/sso/instance_access_control_attribute_configurations/index.md @@ -0,0 +1,217 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an instance_access_control_attribute_configuration resource or lists instance_access_control_attribute_configurations in a region + +## Overview + + + + + + + +
Nameinstance_access_control_attribute_configurations
TypeResource
DescriptionResource Type definition for SSO InstanceAccessControlAttributeConfiguration
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ARN of the AWS SSO instance under which the operation will be executed.
objectThe InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead.
array
stringAWS region.
+ +For more information, see AWS::SSO::InstanceAccessControlAttributeConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all instance_access_control_attribute_configurations in a region. +```sql +SELECT +region, +instance_arn, +instance_access_control_attribute_configuration, +access_control_attributes +FROM aws.sso.instance_access_control_attribute_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual instance_access_control_attribute_configuration. +```sql +SELECT +region, +instance_arn, +instance_access_control_attribute_configuration, +access_control_attributes +FROM aws.sso.instance_access_control_attribute_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance_access_control_attribute_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sso.instance_access_control_attribute_configurations ( + InstanceArn, + region +) +SELECT +'{{ InstanceArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sso.instance_access_control_attribute_configurations ( + InstanceArn, + InstanceAccessControlAttributeConfiguration, + AccessControlAttributes, + region +) +SELECT + '{{ InstanceArn }}', + '{{ InstanceAccessControlAttributeConfiguration }}', + '{{ AccessControlAttributes }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: instance_access_control_attribute_configuration + props: + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: InstanceAccessControlAttributeConfiguration + value: + AccessControlAttributes: + - Key: '{{ Key }}' + Value: + Source: + - '{{ Source[0] }}' + - name: AccessControlAttributes + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sso.instance_access_control_attribute_configurations +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +sso:DescribeInstanceAccessControlAttributeConfiguration +``` + +### Update +```json +sso:UpdateInstanceAccessControlAttributeConfiguration, +sso:DescribeInstanceAccessControlAttributeConfiguration +``` + +### Delete +```json +sso:DeleteInstanceAccessControlAttributeConfiguration, +sso:DescribeInstanceAccessControlAttributeConfiguration +``` + +### List +```json +sso:DescribeInstanceAccessControlAttributeConfiguration +``` diff --git a/website/docs/services/sso/instance_access_control_attribute_configurations_list_only/index.md b/website/docs/services/sso/instance_access_control_attribute_configurations_list_only/index.md new file mode 100644 index 0000000..f74bdab --- /dev/null +++ b/website/docs/services/sso/instance_access_control_attribute_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: instance_access_control_attribute_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instance_access_control_attribute_configurations_list_only + - sso + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instance_access_control_attribute_configurations in a region or regions, for all properties use instance_access_control_attribute_configurations + +## Overview + + + + + + + +
Nameinstance_access_control_attribute_configurations_list_only
TypeResource
DescriptionResource Type definition for SSO InstanceAccessControlAttributeConfiguration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the AWS SSO instance under which the operation will be executed.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instance_access_control_attribute_configurations in a region. +```sql +SELECT +region, +instance_arn +FROM aws.sso.instance_access_control_attribute_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_access_control_attribute_configurations_list_only resource, see instance_access_control_attribute_configurations + diff --git a/website/docs/services/sso/instance_tags/index.md b/website/docs/services/sso/instance_tags/index.md new file mode 100644 index 0000000..c11c38a --- /dev/null +++ b/website/docs/services/sso/instance_tags/index.md @@ -0,0 +1,85 @@ +--- +title: instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_tags + - sso + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instances in a region + +## Overview + + + + + + + +
Nameinstance_tags
TypeResource
DescriptionResource Type definition for Identity Center (SSO) Instance
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Identity Center (SSO) Instance
stringThe SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance
stringThe AWS accountId of the owner of the Identity Center (SSO) Instance
stringThe ID of the identity store associated with the created Identity Center (SSO) Instance
stringThe status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instances in a region. +```sql +SELECT +region, +name, +instance_arn, +owner_account_id, +identity_store_id, +status, +tag_key, +tag_value +FROM aws.sso.instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_tags resource, see instances + diff --git a/website/docs/services/sso/instances/index.md b/website/docs/services/sso/instances/index.md new file mode 100644 index 0000000..101208f --- /dev/null +++ b/website/docs/services/sso/instances/index.md @@ -0,0 +1,228 @@ +--- +title: instances +hide_title: false +hide_table_of_contents: false +keywords: + - instances + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an instance resource or lists instances in a region + +## Overview + + + + + + + +
Nameinstances
TypeResource
DescriptionResource Type definition for Identity Center (SSO) Instance
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Identity Center (SSO) Instance
stringThe SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance
stringThe AWS accountId of the owner of the Identity Center (SSO) Instance
stringThe ID of the identity store associated with the created Identity Center (SSO) Instance
stringThe status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active
array
stringAWS region.
+ +For more information, see AWS::SSO::Instance. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all instances in a region. +```sql +SELECT +region, +name, +instance_arn, +owner_account_id, +identity_store_id, +status, +tags +FROM aws.sso.instances +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual instance. +```sql +SELECT +region, +name, +instance_arn, +owner_account_id, +identity_store_id, +status, +tags +FROM aws.sso.instances +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sso.instances ( + Name, + Tags, + region +) +SELECT +'{{ Name }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sso.instances ( + Name, + Tags, + region +) +SELECT + '{{ Name }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: instance + props: + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sso.instances +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the instances resource, the following permissions are required: + +### Create +```json +sso:CreateInstance, +sso:DescribeInstance, +sso:TagResource, +iam:CreateServiceLinkedRole, +sso:TagInstance, +sso:ListTagsForResource +``` + +### Read +```json +sso:DescribeInstance, +sso:ListTagsForResource +``` + +### Update +```json +sso:UpdateInstance, +sso:TagResource, +sso:UntagResource, +sso:ListTagsForResource, +sso:TagInstance, +sso:DescribeInstance +``` + +### Delete +```json +sso:DeleteInstance +``` + +### List +```json +sso:ListInstances +``` diff --git a/website/docs/services/sso/instances_list_only/index.md b/website/docs/services/sso/instances_list_only/index.md new file mode 100644 index 0000000..7b20e54 --- /dev/null +++ b/website/docs/services/sso/instances_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instances_list_only + - sso + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instances in a region or regions, for all properties use instances + +## Overview + + + + + + + +
Nameinstances_list_only
TypeResource
DescriptionResource Type definition for Identity Center (SSO) Instance
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instances in a region. +```sql +SELECT +region, +instance_arn +FROM aws.sso.instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instances_list_only resource, see instances + diff --git a/website/docs/services/sso/permission_set_tags/index.md b/website/docs/services/sso/permission_set_tags/index.md new file mode 100644 index 0000000..d998ad9 --- /dev/null +++ b/website/docs/services/sso/permission_set_tags/index.md @@ -0,0 +1,95 @@ +--- +title: permission_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - permission_set_tags + - sso + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for permission_sets in a region + +## Overview + + + + + + + +
Namepermission_set_tags
TypeResource
DescriptionResource Type definition for SSO PermissionSet
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this permission set.
stringThe permission set that the policy will be attached to
stringThe permission set description.
stringThe sso instance arn that the permission set is owned.
stringThe length of time that a user can be signed in to an AWS account.
stringThe relay state URL that redirect links to any service in the AWS Management Console.
array
objectThe inline policy to put in permission set.
array
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all permission_sets in a region. +```sql +SELECT +region, +name, +permission_set_arn, +description, +instance_arn, +session_duration, +relay_state_type, +managed_policies, +inline_policy, +customer_managed_policy_references, +permissions_boundary, +tag_key, +tag_value +FROM aws.sso.permission_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permission_set_tags resource, see permission_sets + diff --git a/website/docs/services/sso/permission_sets/index.md b/website/docs/services/sso/permission_sets/index.md new file mode 100644 index 0000000..1e46ae5 --- /dev/null +++ b/website/docs/services/sso/permission_sets/index.md @@ -0,0 +1,303 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a permission_set resource or lists permission_sets in a region + +## Overview + + + + + + + +
Namepermission_sets
TypeResource
DescriptionResource Type definition for SSO PermissionSet
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this permission set.
stringThe permission set that the policy will be attached to
stringThe permission set description.
stringThe sso instance arn that the permission set is owned.
stringThe length of time that a user can be signed in to an AWS account.
stringThe relay state URL that redirect links to any service in the AWS Management Console.
array
objectThe inline policy to put in permission set.
array
array
object
stringAWS region.
+ +For more information, see AWS::SSO::PermissionSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all permission_sets in a region. +```sql +SELECT +region, +name, +permission_set_arn, +description, +instance_arn, +session_duration, +relay_state_type, +managed_policies, +inline_policy, +tags, +customer_managed_policy_references, +permissions_boundary +FROM aws.sso.permission_sets +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual permission_set. +```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_sets +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new permission_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.sso.permission_sets ( + Name, + InstanceArn, + region +) +SELECT +'{{ Name }}', + '{{ InstanceArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.sso.permission_sets ( + Name, + Description, + InstanceArn, + SessionDuration, + RelayStateType, + ManagedPolicies, + InlinePolicy, + Tags, + CustomerManagedPolicyReferences, + PermissionsBoundary, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ InstanceArn }}', + '{{ SessionDuration }}', + '{{ RelayStateType }}', + '{{ ManagedPolicies }}', + '{{ InlinePolicy }}', + '{{ Tags }}', + '{{ CustomerManagedPolicyReferences }}', + '{{ PermissionsBoundary }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: permission_set + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: InstanceArn + value: '{{ InstanceArn }}' + - name: SessionDuration + value: '{{ SessionDuration }}' + - name: RelayStateType + value: '{{ RelayStateType }}' + - name: ManagedPolicies + value: + - '{{ ManagedPolicies[0] }}' + - name: InlinePolicy + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CustomerManagedPolicyReferences + value: + - Name: '{{ Name }}' + Path: '{{ Path }}' + - name: PermissionsBoundary + value: + CustomerManagedPolicyReference: null + ManagedPolicyArn: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.sso.permission_sets +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +sso:DescribePermissionSet +``` diff --git a/website/docs/services/sso/permission_sets_list_only/index.md b/website/docs/services/sso/permission_sets_list_only/index.md new file mode 100644 index 0000000..cce5771 --- /dev/null +++ b/website/docs/services/sso/permission_sets_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: permission_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - permission_sets_list_only + - sso + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists permission_sets in a region or regions, for all properties use permission_sets + +## Overview + + + + + + + +
Namepermission_sets_list_only
TypeResource
DescriptionResource Type definition for SSO PermissionSet
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe permission set that the policy will be attached to
stringThe sso instance arn that the permission set is owned.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all permission_sets in a region. +```sql +SELECT +region, +instance_arn, +permission_set_arn +FROM aws.sso.permission_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permission_sets_list_only resource, see permission_sets + diff --git a/website/docs/services/stepfunctions/activities/index.md b/website/docs/services/stepfunctions/activities/index.md new file mode 100644 index 0000000..b3cf968 --- /dev/null +++ b/website/docs/services/stepfunctions/activities/index.md @@ -0,0 +1,222 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an activity resource or lists activities in a region + +## Overview + + + + + + + +
Nameactivities
TypeResource
DescriptionResource schema for Activity
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
array
object
stringAWS region.
+ +For more information, see AWS::StepFunctions::Activity. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all activities in a region. +```sql +SELECT +region, +arn, +name, +tags, +encryption_configuration +FROM aws.stepfunctions.activities +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual activity. +```sql +SELECT +region, +arn, +name, +tags, +encryption_configuration +FROM aws.stepfunctions.activities +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new activity resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.stepfunctions.activities ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.stepfunctions.activities ( + Name, + Tags, + EncryptionConfiguration, + region +) +SELECT + '{{ Name }}', + '{{ Tags }}', + '{{ EncryptionConfiguration }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: activity + props: + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: EncryptionConfiguration + value: + KmsKeyId: '{{ KmsKeyId }}' + KmsDataKeyReusePeriodSeconds: '{{ KmsDataKeyReusePeriodSeconds }}' + Type: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.stepfunctions.activities +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the activities resource, the following permissions are required: + +### Create +```json +states:CreateActivity, +states:TagResource, +kms:DescribeKey +``` + +### Read +```json +states:DescribeActivity, +states:ListTagsForResource +``` + +### Update +```json +states:ListTagsForResource, +states:TagResource, +states:UntagResource +``` + +### Delete +```json +states:DescribeActivity, +states:DeleteActivity +``` + +### List +```json +states:ListActivities +``` diff --git a/website/docs/services/stepfunctions/activities_list_only/index.md b/website/docs/services/stepfunctions/activities_list_only/index.md new file mode 100644 index 0000000..15626b7 --- /dev/null +++ b/website/docs/services/stepfunctions/activities_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: activities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - activities_list_only + - stepfunctions + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists activities in a region or regions, for all properties use activities + +## Overview + + + + + + + +
Nameactivities_list_only
TypeResource
DescriptionResource schema for Activity
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all activities in a region. +```sql +SELECT +region, +arn +FROM aws.stepfunctions.activities_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the activities_list_only resource, see activities + diff --git a/website/docs/services/stepfunctions/activity_tags/index.md b/website/docs/services/stepfunctions/activity_tags/index.md new file mode 100644 index 0000000..b4d83c7 --- /dev/null +++ b/website/docs/services/stepfunctions/activity_tags/index.md @@ -0,0 +1,81 @@ +--- +title: activity_tags +hide_title: false +hide_table_of_contents: false +keywords: + - activity_tags + - stepfunctions + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for activities in a region + +## Overview + + + + + + + +
Nameactivity_tags
TypeResource
DescriptionResource schema for Activity
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all activities in a region. +```sql +SELECT +region, +arn, +name, +encryption_configuration, +tag_key, +tag_value +FROM aws.stepfunctions.activity_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the activity_tags resource, see activities + diff --git a/website/docs/services/stepfunctions/index.md b/website/docs/services/stepfunctions/index.md new file mode 100644 index 0000000..db369b1 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The stepfunctions service documentation. + +:::info Service Summary + +
+
+total resources: 10
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/stepfunctions/state_machine_aliases/index.md b/website/docs/services/stepfunctions/state_machine_aliases/index.md new file mode 100644 index 0000000..3ffb2a6 --- /dev/null +++ b/website/docs/services/stepfunctions/state_machine_aliases/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a state_machine_alias resource or lists state_machine_aliases in a region + +## Overview + + + + + + + +
Namestate_machine_aliases
TypeResource
DescriptionResource schema for StateMachineAlias
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the alias.
stringThe alias name.
stringAn optional description of the alias.
arrayThe routing configuration of the alias. One or two versions can be mapped to an alias to split StartExecution requests of the same state machine.
objectThe settings to enable gradual state machine deployments.
stringAWS region.
+ +For more information, see AWS::StepFunctions::StateMachineAlias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all state_machine_aliases in a region. +```sql +SELECT +region, +arn, +name, +description, +routing_configuration, +deployment_preference +FROM aws.stepfunctions.state_machine_aliases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual state_machine_alias. +```sql +SELECT +region, +arn, +name, +description, +routing_configuration, +deployment_preference +FROM aws.stepfunctions.state_machine_aliases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new state_machine_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.stepfunctions.state_machine_aliases ( + Name, + Description, + RoutingConfiguration, + DeploymentPreference, + region +) +SELECT +'{{ Name }}', + '{{ Description }}', + '{{ RoutingConfiguration }}', + '{{ DeploymentPreference }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.stepfunctions.state_machine_aliases ( + Name, + Description, + RoutingConfiguration, + DeploymentPreference, + region +) +SELECT + '{{ Name }}', + '{{ Description }}', + '{{ RoutingConfiguration }}', + '{{ DeploymentPreference }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: state_machine_alias + props: + - name: Name + value: '{{ Name }}' + - name: Description + value: '{{ Description }}' + - name: RoutingConfiguration + value: + - StateMachineVersionArn: '{{ StateMachineVersionArn }}' + Weight: '{{ Weight }}' + - name: DeploymentPreference + value: + StateMachineVersionArn: '{{ StateMachineVersionArn }}' + Type: '{{ Type }}' + Percentage: '{{ Percentage }}' + Interval: '{{ Interval }}' + Alarms: + - '{{ Alarms[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.stepfunctions.state_machine_aliases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the state_machine_aliases resource, the following permissions are required: + +### Create +```json +states:CreateStateMachineAlias, +states:DescribeStateMachineAlias +``` + +### Read +```json +states:DescribeStateMachineAlias +``` + +### Update +```json +cloudwatch:DescribeAlarms, +states:UpdateStateMachineAlias, +states:DescribeStateMachineAlias +``` + +### Delete +```json +states:DescribeStateMachineAlias, +states:DeleteStateMachineAlias +``` + +### List +```json +states:ListStateMachineAliases +``` diff --git a/website/docs/services/stepfunctions/state_machine_aliases_list_only/index.md b/website/docs/services/stepfunctions/state_machine_aliases_list_only/index.md new file mode 100644 index 0000000..4b1dbb4 --- /dev/null +++ b/website/docs/services/stepfunctions/state_machine_aliases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: state_machine_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine_aliases_list_only + - stepfunctions + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists state_machine_aliases in a region or regions, for all properties use state_machine_aliases + +## Overview + + + + + + + +
Namestate_machine_aliases_list_only
TypeResource
DescriptionResource schema for StateMachineAlias
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the alias.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all state_machine_aliases in a region. +```sql +SELECT +region, +arn +FROM aws.stepfunctions.state_machine_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the state_machine_aliases_list_only resource, see state_machine_aliases + diff --git a/website/docs/services/stepfunctions/state_machine_tags/index.md b/website/docs/services/stepfunctions/state_machine_tags/index.md new file mode 100644 index 0000000..7d5de70 --- /dev/null +++ b/website/docs/services/stepfunctions/state_machine_tags/index.md @@ -0,0 +1,101 @@ +--- +title: state_machine_tags +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine_tags + - stepfunctions + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for state_machines in a region + +## Overview + + + + + + + +
Namestate_machine_tags
TypeResource
DescriptionResource schema for StateMachine
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
object
object
object
object
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all state_machines in a region. +```sql +SELECT +region, +arn, +name, +definition_string, +role_arn, +state_machine_name, +state_machine_type, +state_machine_revision_id, +logging_configuration, +tracing_configuration, +encryption_configuration, +definition_s3_location, +definition_substitutions, +definition, +tag_key, +tag_value +FROM aws.stepfunctions.state_machine_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the state_machine_tags resource, see state_machines + diff --git a/website/docs/services/stepfunctions/state_machine_versions/index.md b/website/docs/services/stepfunctions/state_machine_versions/index.md new file mode 100644 index 0000000..b0730e5 --- /dev/null +++ b/website/docs/services/stepfunctions/state_machine_versions/index.md @@ -0,0 +1,204 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a state_machine_version resource or lists state_machine_versions in a region + +## Overview + + + + + + + +
Namestate_machine_versions
TypeResource
DescriptionResource schema for StateMachineVersion
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringAWS region.
+ +For more information, see AWS::StepFunctions::StateMachineVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
SELECT
+ +## `SELECT` examples +Gets all state_machine_versions in a region. +```sql +SELECT +region, +arn, +state_machine_arn, +state_machine_revision_id, +description +FROM aws.stepfunctions.state_machine_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual state_machine_version. +```sql +SELECT +region, +arn, +state_machine_arn, +state_machine_revision_id, +description +FROM aws.stepfunctions.state_machine_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new state_machine_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.stepfunctions.state_machine_versions ( + StateMachineArn, + region +) +SELECT +'{{ StateMachineArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.stepfunctions.state_machine_versions ( + StateMachineArn, + StateMachineRevisionId, + Description, + region +) +SELECT + '{{ StateMachineArn }}', + '{{ StateMachineRevisionId }}', + '{{ Description }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: state_machine_version + props: + - name: StateMachineArn + value: '{{ StateMachineArn }}' + - name: StateMachineRevisionId + value: '{{ StateMachineRevisionId }}' + - name: Description + value: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.stepfunctions.state_machine_versions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +states:DescribeStateMachine +``` + +### Delete +```json +states:DeleteStateMachineVersion, +states:DescribeStateMachine +``` + +### List +```json +states:ListStateMachineVersions +``` diff --git a/website/docs/services/stepfunctions/state_machine_versions_list_only/index.md b/website/docs/services/stepfunctions/state_machine_versions_list_only/index.md new file mode 100644 index 0000000..81fcde2 --- /dev/null +++ b/website/docs/services/stepfunctions/state_machine_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: state_machine_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine_versions_list_only + - stepfunctions + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists state_machine_versions in a region or regions, for all properties use state_machine_versions + +## Overview + + + + + + + +
Namestate_machine_versions_list_only
TypeResource
DescriptionResource schema for StateMachineVersion
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all state_machine_versions in a region. +```sql +SELECT +region, +arn +FROM aws.stepfunctions.state_machine_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the state_machine_versions_list_only resource, see state_machine_versions + diff --git a/website/docs/services/stepfunctions/state_machines/index.md b/website/docs/services/stepfunctions/state_machines/index.md new file mode 100644 index 0000000..bead3fa --- /dev/null +++ b/website/docs/services/stepfunctions/state_machines/index.md @@ -0,0 +1,302 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a state_machine resource or lists state_machines in a region + +## Overview + + + + + + + +
Namestate_machines
TypeResource
DescriptionResource schema for StateMachine
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
object
object
object
object
object
object
array
stringAWS region.
+ +For more information, see AWS::StepFunctions::StateMachine. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all state_machines in a region. +```sql +SELECT +region, +arn, +name, +definition_string, +role_arn, +state_machine_name, +state_machine_type, +state_machine_revision_id, +logging_configuration, +tracing_configuration, +encryption_configuration, +definition_s3_location, +definition_substitutions, +definition, +tags +FROM aws.stepfunctions.state_machines +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual state_machine. +```sql +SELECT +region, +arn, +name, +definition_string, +role_arn, +state_machine_name, +state_machine_type, +state_machine_revision_id, +logging_configuration, +tracing_configuration, +encryption_configuration, +definition_s3_location, +definition_substitutions, +definition, +tags +FROM aws.stepfunctions.state_machines +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new state_machine resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.stepfunctions.state_machines ( + RoleArn, + region +) +SELECT +'{{ RoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.stepfunctions.state_machines ( + DefinitionString, + RoleArn, + StateMachineName, + StateMachineType, + LoggingConfiguration, + TracingConfiguration, + EncryptionConfiguration, + DefinitionS3Location, + DefinitionSubstitutions, + Definition, + Tags, + region +) +SELECT + '{{ DefinitionString }}', + '{{ RoleArn }}', + '{{ StateMachineName }}', + '{{ StateMachineType }}', + '{{ LoggingConfiguration }}', + '{{ TracingConfiguration }}', + '{{ EncryptionConfiguration }}', + '{{ DefinitionS3Location }}', + '{{ DefinitionSubstitutions }}', + '{{ Definition }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: state_machine + props: + - name: DefinitionString + value: '{{ DefinitionString }}' + - name: RoleArn + value: '{{ RoleArn }}' + - name: StateMachineName + value: '{{ StateMachineName }}' + - name: StateMachineType + value: '{{ StateMachineType }}' + - name: LoggingConfiguration + value: + Level: '{{ Level }}' + IncludeExecutionData: '{{ IncludeExecutionData }}' + Destinations: + - CloudWatchLogsLogGroup: + LogGroupArn: '{{ LogGroupArn }}' + - name: TracingConfiguration + value: + Enabled: '{{ Enabled }}' + - name: EncryptionConfiguration + value: + KmsKeyId: '{{ KmsKeyId }}' + KmsDataKeyReusePeriodSeconds: '{{ KmsDataKeyReusePeriodSeconds }}' + Type: '{{ Type }}' + - name: DefinitionS3Location + value: + Bucket: '{{ Bucket }}' + Key: '{{ Key }}' + Version: '{{ Version }}' + - name: DefinitionSubstitutions + value: {} + - name: Definition + value: {} + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.stepfunctions.state_machines +WHERE data__Identifier = '' +AND 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, +kms:DescribeKey, +kms:GenerateDataKey +``` + +### Read +```json +states:DescribeStateMachine, +states:ListTagsForResource, +kms:Decrypt +``` + +### Update +```json +states:UpdateStateMachine, +states:TagResource, +states:UntagResource, +states:ListTagsForResource, +iam:PassRole, +kms:DescribeKey, +kms:GenerateDataKey +``` + +### Delete +```json +states:DeleteStateMachine, +states:DescribeStateMachine +``` + +### List +```json +states:ListStateMachines +``` diff --git a/website/docs/services/stepfunctions/state_machines_list_only/index.md b/website/docs/services/stepfunctions/state_machines_list_only/index.md new file mode 100644 index 0000000..76c45d0 --- /dev/null +++ b/website/docs/services/stepfunctions/state_machines_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: state_machines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - state_machines_list_only + - stepfunctions + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists state_machines in a region or regions, for all properties use state_machines + +## Overview + + + + + + + +
Namestate_machines_list_only
TypeResource
DescriptionResource schema for StateMachine
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all state_machines in a region. +```sql +SELECT +region, +arn +FROM aws.stepfunctions.state_machines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the state_machines_list_only resource, see state_machines + diff --git a/website/docs/services/supportapp/account_aliases/index.md b/website/docs/services/supportapp/account_aliases/index.md new file mode 100644 index 0000000..e0e5941 --- /dev/null +++ b/website/docs/services/supportapp/account_aliases/index.md @@ -0,0 +1,200 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an account_alias resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringAn account alias associated with a customer's account.
stringUnique identifier representing an alias tied to an account
stringAWS region.
+ +For more information, see AWS::SupportApp::AccountAlias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all account_aliases in a region. +```sql +SELECT +region, +account_alias, +account_alias_resource_id +FROM aws.supportapp.account_aliases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual account_alias. +```sql +SELECT +region, +account_alias, +account_alias_resource_id +FROM aws.supportapp.account_aliases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new account_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.supportapp.account_aliases ( + AccountAlias, + region +) +SELECT +'{{ AccountAlias }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.supportapp.account_aliases ( + AccountAlias, + region +) +SELECT + '{{ AccountAlias }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: account_alias + props: + - name: AccountAlias + value: '{{ AccountAlias }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.supportapp.account_aliases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the account_aliases resource, the following permissions are required: + +### Create +```json +supportapp:PutAccountAlias, +supportapp:GetAccountAlias +``` + +### Read +```json +supportapp:GetAccountAlias +``` + +### Update +```json +supportapp:PutAccountAlias, +supportapp:GetAccountAlias +``` + +### Delete +```json +supportapp:DeleteAccountAlias, +supportapp:GetAccountAlias +``` + +### List +```json +supportapp:GetAccountAlias +``` diff --git a/website/docs/services/supportapp/account_aliases_list_only/index.md b/website/docs/services/supportapp/account_aliases_list_only/index.md new file mode 100644 index 0000000..91ea99b --- /dev/null +++ b/website/docs/services/supportapp/account_aliases_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: account_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - account_aliases_list_only + - supportapp + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists account_aliases in a region or regions, for all properties use account_aliases + +## Overview + + + + + + + +
Nameaccount_aliases_list_only
TypeResource
DescriptionAn AWS Support App resource that creates, updates, reads, and deletes a customer's account alias.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringAn account alias associated with a customer's account.
stringUnique identifier representing an alias tied to an account
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all account_aliases in a region. +```sql +SELECT +region, +account_alias_resource_id +FROM aws.supportapp.account_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the account_aliases_list_only resource, see account_aliases + diff --git a/website/docs/services/supportapp/index.md b/website/docs/services/supportapp/index.md new file mode 100644 index 0000000..0bad67f --- /dev/null +++ b/website/docs/services/supportapp/index.md @@ -0,0 +1,41 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The supportapp service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/supportapp/slack_channel_configurations/index.md b/website/docs/services/supportapp/slack_channel_configurations/index.md new file mode 100644 index 0000000..2f8d6ad --- /dev/null +++ b/website/docs/services/supportapp/slack_channel_configurations/index.md @@ -0,0 +1,252 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a slack_channel_configuration resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe team ID in Slack, which uniquely identifies a workspace.
stringThe channel ID in Slack, which identifies a channel within a workspace.
stringThe channel name in Slack.
booleanWhether to notify when a case is created or reopened.
booleanWhether to notify when a correspondence is added to a case.
booleanWhether to notify when a case is resolved.
stringThe severity level of a support case that a customer wants to get notified for.
stringThe Amazon Resource Name (ARN) of an IAM role that grants the AWS Support App access to perform operations for AWS services.
stringAWS region.
+ +For more information, see AWS::SupportApp::SlackChannelConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all slack_channel_configurations in a region. +```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_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual slack_channel_configuration. +```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_configurations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new slack_channel_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.supportapp.slack_channel_configurations ( + TeamId, + ChannelId, + NotifyOnCaseSeverity, + ChannelRoleArn, + region +) +SELECT +'{{ TeamId }}', + '{{ ChannelId }}', + '{{ NotifyOnCaseSeverity }}', + '{{ ChannelRoleArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.supportapp.slack_channel_configurations ( + TeamId, + ChannelId, + ChannelName, + NotifyOnCreateOrReopenCase, + NotifyOnAddCorrespondenceToCase, + NotifyOnResolveCase, + NotifyOnCaseSeverity, + ChannelRoleArn, + region +) +SELECT + '{{ TeamId }}', + '{{ ChannelId }}', + '{{ ChannelName }}', + '{{ NotifyOnCreateOrReopenCase }}', + '{{ NotifyOnAddCorrespondenceToCase }}', + '{{ NotifyOnResolveCase }}', + '{{ NotifyOnCaseSeverity }}', + '{{ ChannelRoleArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: slack_channel_configuration + props: + - name: TeamId + value: '{{ TeamId }}' + - name: ChannelId + value: '{{ ChannelId }}' + - name: ChannelName + value: '{{ ChannelName }}' + - name: NotifyOnCreateOrReopenCase + value: '{{ NotifyOnCreateOrReopenCase }}' + - name: NotifyOnAddCorrespondenceToCase + value: '{{ NotifyOnAddCorrespondenceToCase }}' + - name: NotifyOnResolveCase + value: '{{ NotifyOnResolveCase }}' + - name: NotifyOnCaseSeverity + value: '{{ NotifyOnCaseSeverity }}' + - name: ChannelRoleArn + value: '{{ ChannelRoleArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.supportapp.slack_channel_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the slack_channel_configurations resource, the following permissions are required: + +### Create +```json +supportapp:CreateSlackChannelConfiguration, +supportapp:ListSlackChannelConfigurations +``` + +### Read +```json +supportapp:ListSlackChannelConfigurations +``` + +### Update +```json +supportapp:UpdateSlackChannelConfiguration, +supportapp:ListSlackChannelConfigurations +``` + +### Delete +```json +supportapp:DeleteSlackChannelConfiguration, +supportapp:ListSlackChannelConfigurations +``` + +### List +```json +supportapp:ListSlackChannelConfigurations +``` diff --git a/website/docs/services/supportapp/slack_channel_configurations_list_only/index.md b/website/docs/services/supportapp/slack_channel_configurations_list_only/index.md new file mode 100644 index 0000000..d5c678b --- /dev/null +++ b/website/docs/services/supportapp/slack_channel_configurations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: slack_channel_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - slack_channel_configurations_list_only + - supportapp + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists slack_channel_configurations in a region or regions, for all properties use slack_channel_configurations + +## Overview + + + + + + + +
Nameslack_channel_configurations_list_only
TypeResource
DescriptionAn AWS Support App resource that creates, updates, lists and deletes Slack channel configurations.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe team ID in Slack, which uniquely identifies a workspace.
stringThe channel ID in Slack, which identifies a channel within a workspace.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all slack_channel_configurations in a region. +```sql +SELECT +region, +team_id, +channel_id +FROM aws.supportapp.slack_channel_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the slack_channel_configurations_list_only resource, see slack_channel_configurations + diff --git a/website/docs/services/supportapp/slack_workspace_configurations/index.md b/website/docs/services/supportapp/slack_workspace_configurations/index.md new file mode 100644 index 0000000..0d07097 --- /dev/null +++ b/website/docs/services/supportapp/slack_workspace_configurations/index.md @@ -0,0 +1,204 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a slack_workspace_configuration resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe team ID in Slack, which uniquely identifies a workspace.
stringAn identifier used to update an existing Slack workspace configuration in AWS CloudFormation.
stringAWS region.
+ +For more information, see AWS::SupportApp::SlackWorkspaceConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all slack_workspace_configurations in a region. +```sql +SELECT +region, +team_id, +version_id +FROM aws.supportapp.slack_workspace_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual slack_workspace_configuration. +```sql +SELECT +region, +team_id, +version_id +FROM aws.supportapp.slack_workspace_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new slack_workspace_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.supportapp.slack_workspace_configurations ( + TeamId, + region +) +SELECT +'{{ TeamId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.supportapp.slack_workspace_configurations ( + TeamId, + VersionId, + region +) +SELECT + '{{ TeamId }}', + '{{ VersionId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: slack_workspace_configuration + props: + - name: TeamId + value: '{{ TeamId }}' + - name: VersionId + value: '{{ VersionId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.supportapp.slack_workspace_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the slack_workspace_configurations resource, the following permissions are required: + +### Create +```json +supportapp:RegisterSlackWorkspaceForOrganization, +supportapp:ListSlackWorkspaceConfigurations +``` + +### Read +```json +supportapp:ListSlackWorkspaceConfigurations +``` + +### Update +```json +supportapp:RegisterSlackWorkspaceForOrganization, +supportapp:ListSlackWorkspaceConfigurations +``` + +### Delete +```json +supportapp:ListSlackWorkspaceConfigurations, +supportapp:DeleteSlackWorkspaceConfiguration +``` + +### List +```json +supportapp:ListSlackWorkspaceConfigurations +``` diff --git a/website/docs/services/supportapp/slack_workspace_configurations_list_only/index.md b/website/docs/services/supportapp/slack_workspace_configurations_list_only/index.md new file mode 100644 index 0000000..d03ce07 --- /dev/null +++ b/website/docs/services/supportapp/slack_workspace_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: slack_workspace_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - slack_workspace_configurations_list_only + - supportapp + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists slack_workspace_configurations in a region or regions, for all properties use slack_workspace_configurations + +## Overview + + + + + + + +
Nameslack_workspace_configurations_list_only
TypeResource
DescriptionAn AWS Support App resource that creates, updates, lists, and deletes Slack workspace configurations.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe team ID in Slack, which uniquely identifies a workspace.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all slack_workspace_configurations in a region. +```sql +SELECT +region, +team_id +FROM aws.supportapp.slack_workspace_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the slack_workspace_configurations_list_only resource, see slack_workspace_configurations + diff --git a/website/docs/services/synthetics/canaries/index.md b/website/docs/services/synthetics/canaries/index.md new file mode 100644 index 0000000..7db37f6 --- /dev/null +++ b/website/docs/services/synthetics/canaries/index.md @@ -0,0 +1,407 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a canary resource or lists canaries in a region + +## Overview + + + + + + + +
Namecanaries
TypeResource
DescriptionResource Type definition for AWS::Synthetics::Canary
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the canary.
stringId of the canary
stringState of the canary
objectProvide the canary script source
stringProvide the s3 bucket output location for test results
objectProvide artifact configuration
objectFrequency to run your canaries
stringLambda Execution role used to run your canaries
stringRuntime version of Synthetics Library
integerRetention period of successful canary runs represented in number of days
integerRetention period of failed canary runs represented in number of days
array
objectProvide VPC Configuration if enabled.
objectProvide canary run configuration
booleanRuns canary if set to True. Default is False
objectVisual reference configuration for visual testing
booleanDeletes associated lambda resources created by Synthetics if set to True. Default is False
arrayList of resources which canary tags should be replicated to.
stringSetting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.
stringAWS region.
+ +For more information, see AWS::Synthetics::Canary. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all canaries in a region. +```sql +SELECT +region, +name, +id, +state, +code, +artifact_s3_location, +artifact_config, +schedule, +execution_role_arn, +runtime_version, +success_retention_period, +failure_retention_period, +tags, +vpc_config, +run_config, +start_canary_after_creation, +visual_reference, +delete_lambda_resources_on_canary_deletion, +resources_to_replicate_tags, +provisioned_resource_cleanup +FROM aws.synthetics.canaries +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual canary. +```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, +resources_to_replicate_tags, +provisioned_resource_cleanup +FROM aws.synthetics.canaries +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new canary resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.synthetics.canaries ( + Name, + Code, + ArtifactS3Location, + Schedule, + ExecutionRoleArn, + RuntimeVersion, + region +) +SELECT +'{{ Name }}', + '{{ Code }}', + '{{ ArtifactS3Location }}', + '{{ Schedule }}', + '{{ ExecutionRoleArn }}', + '{{ RuntimeVersion }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.synthetics.canaries ( + Name, + Code, + ArtifactS3Location, + ArtifactConfig, + Schedule, + ExecutionRoleArn, + RuntimeVersion, + SuccessRetentionPeriod, + FailureRetentionPeriod, + Tags, + VPCConfig, + RunConfig, + StartCanaryAfterCreation, + VisualReference, + DeleteLambdaResourcesOnCanaryDeletion, + ResourcesToReplicateTags, + ProvisionedResourceCleanup, + region +) +SELECT + '{{ Name }}', + '{{ Code }}', + '{{ ArtifactS3Location }}', + '{{ ArtifactConfig }}', + '{{ Schedule }}', + '{{ ExecutionRoleArn }}', + '{{ RuntimeVersion }}', + '{{ SuccessRetentionPeriod }}', + '{{ FailureRetentionPeriod }}', + '{{ Tags }}', + '{{ VPCConfig }}', + '{{ RunConfig }}', + '{{ StartCanaryAfterCreation }}', + '{{ VisualReference }}', + '{{ DeleteLambdaResourcesOnCanaryDeletion }}', + '{{ ResourcesToReplicateTags }}', + '{{ ProvisionedResourceCleanup }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: canary + props: + - name: Name + value: '{{ Name }}' + - name: Code + value: + S3Bucket: '{{ S3Bucket }}' + S3Key: '{{ S3Key }}' + S3ObjectVersion: '{{ S3ObjectVersion }}' + Script: '{{ Script }}' + Handler: '{{ Handler }}' + SourceLocationArn: '{{ SourceLocationArn }}' + - name: ArtifactS3Location + value: '{{ ArtifactS3Location }}' + - name: ArtifactConfig + value: + S3Encryption: + EncryptionMode: '{{ EncryptionMode }}' + KmsKeyArn: '{{ KmsKeyArn }}' + - name: Schedule + value: + Expression: '{{ Expression }}' + DurationInSeconds: '{{ DurationInSeconds }}' + - name: ExecutionRoleArn + value: '{{ ExecutionRoleArn }}' + - name: RuntimeVersion + value: '{{ RuntimeVersion }}' + - name: SuccessRetentionPeriod + value: '{{ SuccessRetentionPeriod }}' + - name: FailureRetentionPeriod + value: '{{ FailureRetentionPeriod }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VPCConfig + value: + VpcId: '{{ VpcId }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + Ipv6AllowedForDualStack: '{{ Ipv6AllowedForDualStack }}' + - name: RunConfig + value: + TimeoutInSeconds: '{{ TimeoutInSeconds }}' + MemoryInMB: '{{ MemoryInMB }}' + ActiveTracing: '{{ ActiveTracing }}' + EnvironmentVariables: {} + - name: StartCanaryAfterCreation + value: '{{ StartCanaryAfterCreation }}' + - name: VisualReference + value: + BaseCanaryRunId: '{{ BaseCanaryRunId }}' + BaseScreenshots: + - ScreenshotName: '{{ ScreenshotName }}' + IgnoreCoordinates: + - '{{ IgnoreCoordinates[0] }}' + - name: DeleteLambdaResourcesOnCanaryDeletion + value: '{{ DeleteLambdaResourcesOnCanaryDeletion }}' + - name: ResourcesToReplicateTags + value: + - '{{ ResourcesToReplicateTags[0] }}' + - name: ProvisionedResourceCleanup + value: '{{ ProvisionedResourceCleanup }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.synthetics.canaries +WHERE data__Identifier = '' +AND 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:UpdateFunctionCode, +lambda:UpdateFunctionConfiguration, +lambda:GetFunctionConfiguration, +lambda:GetLayerVersionByArn, +lambda:GetLayerVersion, +lambda:PublishLayerVersion, +lambda:TagResource, +ec2:DescribeVpcs, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +iam:PassRole +``` + +### 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:UpdateFunctionCode, +lambda:UpdateFunctionConfiguration, +lambda:GetFunctionConfiguration, +lambda:GetLayerVersionByArn, +lambda:GetLayerVersion, +lambda:PublishLayerVersion, +lambda:ListTags, +lambda:TagResource, +lambda:UntagResource, +iam:PassRole, +ec2:DescribeVpcs, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups +``` + +### Read +```json +synthetics:GetCanary, +synthetics:DescribeCanaries, +synthetics:ListTagsForResource, +iam:ListRoles, +s3:ListAllMyBuckets, +s3:GetBucketLocation +``` + +### Delete +```json +synthetics:DeleteCanary, +synthetics:GetCanary, +lambda:DeleteFunction, +lambda:DeleteLayerVersion +``` + +### List +```json +synthetics:DescribeCanaries +``` diff --git a/website/docs/services/synthetics/canaries_list_only/index.md b/website/docs/services/synthetics/canaries_list_only/index.md new file mode 100644 index 0000000..957dc08 --- /dev/null +++ b/website/docs/services/synthetics/canaries_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: canaries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - canaries_list_only + - synthetics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists canaries in a region or regions, for all properties use canaries + +## Overview + + + + + + + +
Namecanaries_list_only
TypeResource
DescriptionResource Type definition for AWS::Synthetics::Canary
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the canary.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all canaries in a region. +```sql +SELECT +region, +name +FROM aws.synthetics.canaries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the canaries_list_only resource, see canaries + diff --git a/website/docs/services/synthetics/canary_tags/index.md b/website/docs/services/synthetics/canary_tags/index.md new file mode 100644 index 0000000..73ba9c7 --- /dev/null +++ b/website/docs/services/synthetics/canary_tags/index.md @@ -0,0 +1,111 @@ +--- +title: canary_tags +hide_title: false +hide_table_of_contents: false +keywords: + - canary_tags + - synthetics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for canaries in a region + +## Overview + + + + + + + +
Namecanary_tags
TypeResource
DescriptionResource Type definition for AWS::Synthetics::Canary
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the canary.
stringId of the canary
stringState of the canary
objectProvide the canary script source
stringProvide the s3 bucket output location for test results
objectProvide artifact configuration
objectFrequency to run your canaries
stringLambda Execution role used to run your canaries
stringRuntime version of Synthetics Library
integerRetention period of successful canary runs represented in number of days
integerRetention period of failed canary runs represented in number of days
objectProvide VPC Configuration if enabled.
objectProvide canary run configuration
booleanRuns canary if set to True. Default is False
objectVisual reference configuration for visual testing
booleanDeletes associated lambda resources created by Synthetics if set to True. Default is False
arrayList of resources which canary tags should be replicated to.
stringSetting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all canaries in a region. +```sql +SELECT +region, +name, +id, +state, +code, +artifact_s3_location, +artifact_config, +schedule, +execution_role_arn, +runtime_version, +success_retention_period, +failure_retention_period, +vpc_config, +run_config, +start_canary_after_creation, +visual_reference, +delete_lambda_resources_on_canary_deletion, +resources_to_replicate_tags, +provisioned_resource_cleanup, +tag_key, +tag_value +FROM aws.synthetics.canary_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the canary_tags resource, see canaries + diff --git a/website/docs/services/synthetics/group_tags/index.md b/website/docs/services/synthetics/group_tags/index.md new file mode 100644 index 0000000..745f5c7 --- /dev/null +++ b/website/docs/services/synthetics/group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - group_tags + - synthetics + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for groups in a region + +## Overview + + + + + + + +
Namegroup_tags
TypeResource
DescriptionResource Type definition for AWS::Synthetics::Group
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of the group.
stringId of the group.
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all groups in a region. +```sql +SELECT +region, +name, +id, +resource_arns, +tag_key, +tag_value +FROM aws.synthetics.group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the group_tags resource, see groups + diff --git a/website/docs/services/synthetics/groups/index.md b/website/docs/services/synthetics/groups/index.md new file mode 100644 index 0000000..c385981 --- /dev/null +++ b/website/docs/services/synthetics/groups/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a group resource or lists groups in a region + +## Overview + + + + + + + +
Namegroups
TypeResource
DescriptionResource Type definition for AWS::Synthetics::Group
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of the group.
stringId of the group.
array
array
stringAWS region.
+ +For more information, see AWS::Synthetics::Group. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all groups in a region. +```sql +SELECT +region, +name, +id, +tags, +resource_arns +FROM aws.synthetics.groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual group. +```sql +SELECT +region, +name, +id, +tags, +resource_arns +FROM aws.synthetics.groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.synthetics.groups ( + Name, + region +) +SELECT +'{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.synthetics.groups ( + Name, + Tags, + ResourceArns, + region +) +SELECT + '{{ Name }}', + '{{ Tags }}', + '{{ ResourceArns }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: group + props: + - name: Name + value: '{{ Name }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: ResourceArns + value: + - '{{ ResourceArns[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.synthetics.groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +synthetics:ListGroups +``` diff --git a/website/docs/services/synthetics/groups_list_only/index.md b/website/docs/services/synthetics/groups_list_only/index.md new file mode 100644 index 0000000..99c4bdb --- /dev/null +++ b/website/docs/services/synthetics/groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - groups_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists groups in a region or regions, for all properties use groups + +## Overview + + + + + + + +
Namegroups_list_only
TypeResource
DescriptionResource Type definition for AWS::Synthetics::Group
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all groups in a region. +```sql +SELECT +region, +name +FROM aws.synthetics.groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the groups_list_only resource, see groups + diff --git a/website/docs/services/synthetics/index.md b/website/docs/services/synthetics/index.md new file mode 100644 index 0000000..5b03f2e --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The synthetics service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/systemsmanagersap/application_tags/index.md b/website/docs/services/systemsmanagersap/application_tags/index.md new file mode 100644 index 0000000..a14b5eb --- /dev/null +++ b/website/docs/services/systemsmanagersap/application_tags/index.md @@ -0,0 +1,91 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - systemsmanagersap + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource schema for AWS::SystemsManagerSAP::Application
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe ARN of the SSM-SAP application
array
array
string
string
stringThe ARN of the SAP HANA database
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_id, +application_type, +arn, +credentials, +instances, +sap_instance_number, +sid, +database_arn, +tag_key, +tag_value +FROM aws.systemsmanagersap.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + diff --git a/website/docs/services/systemsmanagersap/applications/index.md b/website/docs/services/systemsmanagersap/applications/index.md new file mode 100644 index 0000000..76f4af4 --- /dev/null +++ b/website/docs/services/systemsmanagersap/applications/index.md @@ -0,0 +1,263 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an application resource or lists applications in a region + +## Overview + + + + + + + +
Nameapplications
TypeResource
DescriptionResource schema for AWS::SystemsManagerSAP::Application
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe ARN of the SSM-SAP application
array
array
string
string
arrayThe tags of a SystemsManagerSAP application.
stringThe ARN of the SAP HANA database
stringAWS region.
+ +For more information, see AWS::SystemsManagerSAP::Application. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all applications in a region. +```sql +SELECT +region, +application_id, +application_type, +arn, +credentials, +instances, +sap_instance_number, +sid, +tags, +database_arn +FROM aws.systemsmanagersap.applications +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual application. +```sql +SELECT +region, +application_id, +application_type, +arn, +credentials, +instances, +sap_instance_number, +sid, +tags, +database_arn +FROM aws.systemsmanagersap.applications +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.systemsmanagersap.applications ( + ApplicationId, + ApplicationType, + region +) +SELECT +'{{ ApplicationId }}', + '{{ ApplicationType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.systemsmanagersap.applications ( + ApplicationId, + ApplicationType, + Credentials, + Instances, + SapInstanceNumber, + Sid, + Tags, + DatabaseArn, + region +) +SELECT + '{{ ApplicationId }}', + '{{ ApplicationType }}', + '{{ Credentials }}', + '{{ Instances }}', + '{{ SapInstanceNumber }}', + '{{ Sid }}', + '{{ Tags }}', + '{{ DatabaseArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: application + props: + - name: ApplicationId + value: '{{ ApplicationId }}' + - name: ApplicationType + value: '{{ ApplicationType }}' + - name: Credentials + value: + - DatabaseName: '{{ DatabaseName }}' + CredentialType: '{{ CredentialType }}' + SecretId: '{{ SecretId }}' + - name: Instances + value: + - '{{ Instances[0] }}' + - name: SapInstanceNumber + value: '{{ SapInstanceNumber }}' + - name: Sid + value: '{{ Sid }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: DatabaseArn + value: '{{ DatabaseArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.systemsmanagersap.applications +WHERE data__Identifier = '' +AND 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, +iam:CreateServiceLinkedRole +``` + +### 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 +``` + +### List +```json +ssm-sap:ListApplications +``` diff --git a/website/docs/services/systemsmanagersap/applications_list_only/index.md b/website/docs/services/systemsmanagersap/applications_list_only/index.md new file mode 100644 index 0000000..aff31d7 --- /dev/null +++ b/website/docs/services/systemsmanagersap/applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - systemsmanagersap + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource schema for AWS::SystemsManagerSAP::Application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the SSM-SAP application
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +arn +FROM aws.systemsmanagersap.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + diff --git a/website/docs/services/systemsmanagersap/index.md b/website/docs/services/systemsmanagersap/index.md new file mode 100644 index 0000000..acdae4d --- /dev/null +++ b/website/docs/services/systemsmanagersap/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The systemsmanagersap service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/timestream/database_tags/index.md b/website/docs/services/timestream/database_tags/index.md new file mode 100644 index 0000000..c07c6c7 --- /dev/null +++ b/website/docs/services/timestream/database_tags/index.md @@ -0,0 +1,81 @@ +--- +title: database_tags +hide_title: false +hide_table_of_contents: false +keywords: + - database_tags + - timestream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for databases in a region + +## Overview + + + + + + + +
Namedatabase_tags
TypeResource
DescriptionThe AWS::Timestream::Database resource creates a Timestream database.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringThe name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.
stringThe KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all databases in a region. +```sql +SELECT +region, +arn, +database_name, +kms_key_id, +tag_key, +tag_value +FROM aws.timestream.database_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the database_tags resource, see databases + diff --git a/website/docs/services/timestream/databases/index.md b/website/docs/services/timestream/databases/index.md new file mode 100644 index 0000000..6694a02 --- /dev/null +++ b/website/docs/services/timestream/databases/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a database resource or lists databases in a region + +## Overview + + + + + + + +
Namedatabases
TypeResource
DescriptionThe AWS::Timestream::Database resource creates a Timestream database.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringThe name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.
stringThe KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Timestream::Database. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all databases in a region. +```sql +SELECT +region, +arn, +database_name, +kms_key_id, +tags +FROM aws.timestream.databases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual database. +```sql +SELECT +region, +arn, +database_name, +kms_key_id, +tags +FROM aws.timestream.databases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new database resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.timestream.databases ( + DatabaseName, + KmsKeyId, + Tags, + region +) +SELECT +'{{ DatabaseName }}', + '{{ KmsKeyId }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.timestream.databases ( + DatabaseName, + KmsKeyId, + Tags, + region +) +SELECT + '{{ DatabaseName }}', + '{{ KmsKeyId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: database + props: + - name: DatabaseName + value: '{{ DatabaseName }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.timestream.databases +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +timestream:ListDatabases, +timestream:DescribeEndpoints +``` diff --git a/website/docs/services/timestream/databases_list_only/index.md b/website/docs/services/timestream/databases_list_only/index.md new file mode 100644 index 0000000..d1b6cca --- /dev/null +++ b/website/docs/services/timestream/databases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: databases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - databases_list_only + - timestream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists databases in a region or regions, for all properties use databases + +## Overview + + + + + + + +
Namedatabases_list_only
TypeResource
DescriptionThe AWS::Timestream::Database resource creates a Timestream database.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all databases in a region. +```sql +SELECT +region, +database_name +FROM aws.timestream.databases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the databases_list_only resource, see databases + diff --git a/website/docs/services/timestream/index.md b/website/docs/services/timestream/index.md new file mode 100644 index 0000000..47a5533 --- /dev/null +++ b/website/docs/services/timestream/index.md @@ -0,0 +1,47 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The timestream service documentation. + +:::info Service Summary + +
+
+total resources: 12
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/timestream/influxdb_instance_tags/index.md b/website/docs/services/timestream/influxdb_instance_tags/index.md new file mode 100644 index 0000000..8e0603d --- /dev/null +++ b/website/docs/services/timestream/influxdb_instance_tags/index.md @@ -0,0 +1,117 @@ +--- +title: influxdb_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - influxdb_instance_tags + - timestream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for influxdb_instances in a region + +## Overview + + + + + + + +
Nameinfluxdb_instance_tags
TypeResource
DescriptionThe AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe username for the InfluxDB instance.
stringThe password for the InfluxDB instance.
stringThe organization for the InfluxDB instance.
stringThe bucket for the InfluxDB instance.
stringThe compute instance of the InfluxDB instance.
arrayA list of EC2 subnet IDs for this InfluxDB instance.
arrayA list of Amazon EC2 VPC security groups to associate with this InfluxDB instance.
booleanAttach a public IP to the customer ENI.
stringThe storage type of the InfluxDB instance.
integerThe allocated storage for the InfluxDB instance.
stringThe name of an existing InfluxDB parameter group.
objectConfiguration for sending logs to customer account from the InfluxDB instance.
stringStatus of the InfluxDB Instance.
stringThe Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
stringThe unique name that is associated with the InfluxDB instance.
stringThe Availability Zone (AZ) where the InfluxDB instance is created.
stringThe Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
stringThe connection endpoint for the InfluxDB instance.
stringThe Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
stringThe service generated unique identifier for InfluxDB instance.
stringDeployment type of the InfluxDB Instance.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all influxdb_instances in a region. +```sql +SELECT +region, +username, +password, +organization, +bucket, +db_instance_type, +vpc_subnet_ids, +vpc_security_group_ids, +publicly_accessible, +db_storage_type, +allocated_storage, +db_parameter_group_identifier, +log_delivery_configuration, +status, +arn, +name, +availability_zone, +secondary_availability_zone, +endpoint, +influx_auth_parameters_secret_arn, +id, +deployment_type, +tag_key, +tag_value +FROM aws.timestream.influxdb_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the influxdb_instance_tags resource, see influxdb_instances + diff --git a/website/docs/services/timestream/influxdb_instances/index.md b/website/docs/services/timestream/influxdb_instances/index.md new file mode 100644 index 0000000..051fa64 --- /dev/null +++ b/website/docs/services/timestream/influxdb_instances/index.md @@ -0,0 +1,370 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an influxdb_instance resource or lists influxdb_instances in a region + +## Overview + + + + + + + +
Nameinfluxdb_instances
TypeResource
DescriptionThe AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe username for the InfluxDB instance.
stringThe password for the InfluxDB instance.
stringThe organization for the InfluxDB instance.
stringThe bucket for the InfluxDB instance.
stringThe compute instance of the InfluxDB instance.
arrayA list of EC2 subnet IDs for this InfluxDB instance.
arrayA list of Amazon EC2 VPC security groups to associate with this InfluxDB instance.
booleanAttach a public IP to the customer ENI.
stringThe storage type of the InfluxDB instance.
integerThe allocated storage for the InfluxDB instance.
stringThe name of an existing InfluxDB parameter group.
objectConfiguration for sending logs to customer account from the InfluxDB instance.
stringStatus of the InfluxDB Instance.
stringThe Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
stringThe unique name that is associated with the InfluxDB instance.
stringThe Availability Zone (AZ) where the InfluxDB instance is created.
stringThe Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
stringThe connection endpoint for the InfluxDB instance.
stringThe Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
stringThe service generated unique identifier for InfluxDB instance.
stringDeployment type of the InfluxDB Instance.
arrayAn arbitrary set of tags (key-value pairs) for this DB instance.
stringAWS region.
+ +For more information, see AWS::Timestream::InfluxDBInstance. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all influxdb_instances in a region. +```sql +SELECT +region, +username, +password, +organization, +bucket, +db_instance_type, +vpc_subnet_ids, +vpc_security_group_ids, +publicly_accessible, +db_storage_type, +allocated_storage, +db_parameter_group_identifier, +log_delivery_configuration, +status, +arn, +name, +availability_zone, +secondary_availability_zone, +endpoint, +influx_auth_parameters_secret_arn, +id, +deployment_type, +tags +FROM aws.timestream.influxdb_instances +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual influxdb_instance. +```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_instances +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new influxdb_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.timestream.influxdb_instances ( + Username, + Password, + Organization, + Bucket, + DbInstanceType, + VpcSubnetIds, + VpcSecurityGroupIds, + PubliclyAccessible, + DbStorageType, + AllocatedStorage, + DbParameterGroupIdentifier, + LogDeliveryConfiguration, + Name, + DeploymentType, + Tags, + region +) +SELECT +'{{ Username }}', + '{{ Password }}', + '{{ Organization }}', + '{{ Bucket }}', + '{{ DbInstanceType }}', + '{{ VpcSubnetIds }}', + '{{ VpcSecurityGroupIds }}', + '{{ PubliclyAccessible }}', + '{{ DbStorageType }}', + '{{ AllocatedStorage }}', + '{{ DbParameterGroupIdentifier }}', + '{{ LogDeliveryConfiguration }}', + '{{ Name }}', + '{{ DeploymentType }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.timestream.influxdb_instances ( + Username, + Password, + Organization, + Bucket, + DbInstanceType, + VpcSubnetIds, + VpcSecurityGroupIds, + PubliclyAccessible, + DbStorageType, + AllocatedStorage, + DbParameterGroupIdentifier, + LogDeliveryConfiguration, + Name, + DeploymentType, + Tags, + region +) +SELECT + '{{ Username }}', + '{{ Password }}', + '{{ Organization }}', + '{{ Bucket }}', + '{{ DbInstanceType }}', + '{{ VpcSubnetIds }}', + '{{ VpcSecurityGroupIds }}', + '{{ PubliclyAccessible }}', + '{{ DbStorageType }}', + '{{ AllocatedStorage }}', + '{{ DbParameterGroupIdentifier }}', + '{{ LogDeliveryConfiguration }}', + '{{ Name }}', + '{{ DeploymentType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: influxdb_instance + props: + - name: Username + value: '{{ Username }}' + - name: Password + value: '{{ Password }}' + - name: Organization + value: '{{ Organization }}' + - name: Bucket + value: '{{ Bucket }}' + - name: DbInstanceType + value: '{{ DbInstanceType }}' + - name: VpcSubnetIds + value: + - '{{ VpcSubnetIds[0] }}' + - name: VpcSecurityGroupIds + value: + - '{{ VpcSecurityGroupIds[0] }}' + - name: PubliclyAccessible + value: '{{ PubliclyAccessible }}' + - name: DbStorageType + value: '{{ DbStorageType }}' + - name: AllocatedStorage + value: '{{ AllocatedStorage }}' + - name: DbParameterGroupIdentifier + value: '{{ DbParameterGroupIdentifier }}' + - name: LogDeliveryConfiguration + value: + S3Configuration: + BucketName: '{{ BucketName }}' + Enabled: '{{ Enabled }}' + - name: Name + value: '{{ Name }}' + - name: DeploymentType + value: '{{ DeploymentType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.timestream.influxdb_instances +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +timestream-influxdb:ListDbInstances +``` diff --git a/website/docs/services/timestream/influxdb_instances_list_only/index.md b/website/docs/services/timestream/influxdb_instances_list_only/index.md new file mode 100644 index 0000000..7146331 --- /dev/null +++ b/website/docs/services/timestream/influxdb_instances_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: influxdb_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - influxdb_instances_list_only + - timestream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists influxdb_instances in a region or regions, for all properties use influxdb_instances + +## Overview + + + + + + + +
Nameinfluxdb_instances_list_only
TypeResource
DescriptionThe AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe service generated unique identifier for InfluxDB instance.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all influxdb_instances in a region. +```sql +SELECT +region, +id +FROM aws.timestream.influxdb_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the influxdb_instances_list_only resource, see influxdb_instances + diff --git a/website/docs/services/timestream/scheduled_queries/index.md b/website/docs/services/timestream/scheduled_queries/index.md new file mode 100644 index 0000000..a066d84 --- /dev/null +++ b/website/docs/services/timestream/scheduled_queries/index.md @@ -0,0 +1,329 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a scheduled_query resource or lists scheduled_queries in a region + +## Overview + + + + + + + +
Namescheduled_queries
TypeResource
DescriptionThe AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name of the scheduled query that is generated upon creation.
stringThe name of the scheduled query. Scheduled query names must be unique within each Region.
stringThe query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
objectConfiguration for when the scheduled query is executed.
objectNotification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
stringUsing a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request. If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf. After 8 hours, any request with the same ClientToken is treated as a new request.
stringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
objectConfiguration of target store where scheduled query results are written to.
objectConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
stringThe Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
stringThe name of the scheduled query. Scheduled query names must be unique within each Region.
stringThe query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
stringConfiguration for when the scheduled query is executed.
stringNotification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
stringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
stringConfiguration of target store where scheduled query results are written to.
stringConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
stringThe Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
arrayA list of key-value pairs to label the scheduled query.
stringAWS region.
+ +For more information, see AWS::Timestream::ScheduledQuery. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all scheduled_queries in a region. +```sql +SELECT +region, +arn, +scheduled_query_name, +query_string, +schedule_configuration, +notification_configuration, +client_token, +scheduled_query_execution_role_arn, +target_configuration, +error_report_configuration, +kms_key_id, +sq_name, +sq_query_string, +sq_schedule_configuration, +sq_notification_configuration, +sq_scheduled_query_execution_role_arn, +sq_target_configuration, +sq_error_report_configuration, +sq_kms_key_id, +tags +FROM aws.timestream.scheduled_queries +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual scheduled_query. +```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_queries +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scheduled_query resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.timestream.scheduled_queries ( + QueryString, + ScheduleConfiguration, + NotificationConfiguration, + ScheduledQueryExecutionRoleArn, + ErrorReportConfiguration, + region +) +SELECT +'{{ QueryString }}', + '{{ ScheduleConfiguration }}', + '{{ NotificationConfiguration }}', + '{{ ScheduledQueryExecutionRoleArn }}', + '{{ ErrorReportConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.timestream.scheduled_queries ( + ScheduledQueryName, + QueryString, + ScheduleConfiguration, + NotificationConfiguration, + ClientToken, + ScheduledQueryExecutionRoleArn, + TargetConfiguration, + ErrorReportConfiguration, + KmsKeyId, + Tags, + region +) +SELECT + '{{ ScheduledQueryName }}', + '{{ QueryString }}', + '{{ ScheduleConfiguration }}', + '{{ NotificationConfiguration }}', + '{{ ClientToken }}', + '{{ ScheduledQueryExecutionRoleArn }}', + '{{ TargetConfiguration }}', + '{{ ErrorReportConfiguration }}', + '{{ KmsKeyId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: scheduled_query + props: + - name: ScheduledQueryName + value: '{{ ScheduledQueryName }}' + - name: QueryString + value: '{{ QueryString }}' + - name: ScheduleConfiguration + value: + ScheduleExpression: '{{ ScheduleExpression }}' + - name: NotificationConfiguration + value: + SnsConfiguration: + TopicArn: '{{ TopicArn }}' + - name: ClientToken + value: '{{ ClientToken }}' + - name: ScheduledQueryExecutionRoleArn + value: '{{ ScheduledQueryExecutionRoleArn }}' + - name: TargetConfiguration + value: + TimestreamConfiguration: + DatabaseName: '{{ DatabaseName }}' + TableName: '{{ TableName }}' + TimeColumn: '{{ TimeColumn }}' + DimensionMappings: + - Name: '{{ Name }}' + DimensionValueType: '{{ DimensionValueType }}' + MultiMeasureMappings: + TargetMultiMeasureName: '{{ TargetMultiMeasureName }}' + MultiMeasureAttributeMappings: + - SourceColumn: '{{ SourceColumn }}' + MeasureValueType: '{{ MeasureValueType }}' + TargetMultiMeasureAttributeName: '{{ TargetMultiMeasureAttributeName }}' + MixedMeasureMappings: + - MeasureName: '{{ MeasureName }}' + SourceColumn: '{{ SourceColumn }}' + TargetMeasureName: '{{ TargetMeasureName }}' + MeasureValueType: '{{ MeasureValueType }}' + MultiMeasureAttributeMappings: null + MeasureNameColumn: '{{ MeasureNameColumn }}' + - name: ErrorReportConfiguration + value: + S3Configuration: + BucketName: '{{ BucketName }}' + ObjectKeyPrefix: '{{ ObjectKeyPrefix }}' + EncryptionOption: '{{ EncryptionOption }}' + - name: KmsKeyId + value: '{{ KmsKeyId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.timestream.scheduled_queries +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the scheduled_queries resource, the following permissions are required: + +### Create +```json +timestream:CreateScheduledQuery, +timestream:DescribeEndpoints +``` + +### Read +```json +timestream:DescribeScheduledQuery, +timestream:ListTagsForResource, +timestream:DescribeEndpoints +``` + +### Update +```json +timestream:UpdateScheduledQuery, +timestream:TagResource, +timestream:UntagResource, +timestream:DescribeEndpoints +``` + +### Delete +```json +timestream:DeleteScheduledQuery, +timestream:DescribeEndpoints +``` + +### List +```json +timestream:ListScheduledQueries, +timestream:DescribeEndpoints +``` diff --git a/website/docs/services/timestream/scheduled_queries_list_only/index.md b/website/docs/services/timestream/scheduled_queries_list_only/index.md new file mode 100644 index 0000000..e368c81 --- /dev/null +++ b/website/docs/services/timestream/scheduled_queries_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: scheduled_queries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_queries_list_only + - timestream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scheduled_queries in a region or regions, for all properties use scheduled_queries + +## Overview + + + + + + + +
Namescheduled_queries_list_only
TypeResource
DescriptionThe AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAmazon Resource Name of the scheduled query that is generated upon creation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scheduled_queries in a region. +```sql +SELECT +region, +arn +FROM aws.timestream.scheduled_queries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_queries_list_only resource, see scheduled_queries + diff --git a/website/docs/services/timestream/scheduled_query_tags/index.md b/website/docs/services/timestream/scheduled_query_tags/index.md new file mode 100644 index 0000000..7a54a85 --- /dev/null +++ b/website/docs/services/timestream/scheduled_query_tags/index.md @@ -0,0 +1,111 @@ +--- +title: scheduled_query_tags +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_query_tags + - timestream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scheduled_queries in a region + +## Overview + + + + + + + +
Namescheduled_query_tags
TypeResource
DescriptionThe AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name of the scheduled query that is generated upon creation.
stringThe name of the scheduled query. Scheduled query names must be unique within each Region.
stringThe query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
objectConfiguration for when the scheduled query is executed.
objectNotification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
stringUsing a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request. If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf. After 8 hours, any request with the same ClientToken is treated as a new request.
stringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
objectConfiguration of target store where scheduled query results are written to.
objectConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
stringThe Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
stringThe name of the scheduled query. Scheduled query names must be unique within each Region.
stringThe query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
stringConfiguration for when the scheduled query is executed.
stringNotification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
stringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
stringConfiguration of target store where scheduled query results are written to.
stringConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
stringThe Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scheduled_queries in a region. +```sql +SELECT +region, +arn, +scheduled_query_name, +query_string, +schedule_configuration, +notification_configuration, +client_token, +scheduled_query_execution_role_arn, +target_configuration, +error_report_configuration, +kms_key_id, +sq_name, +sq_query_string, +sq_schedule_configuration, +sq_notification_configuration, +sq_scheduled_query_execution_role_arn, +sq_target_configuration, +sq_error_report_configuration, +sq_kms_key_id, +tag_key, +tag_value +FROM aws.timestream.scheduled_query_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_query_tags resource, see scheduled_queries + diff --git a/website/docs/services/timestream/table_tags/index.md b/website/docs/services/timestream/table_tags/index.md new file mode 100644 index 0000000..32d44d3 --- /dev/null +++ b/website/docs/services/timestream/table_tags/index.md @@ -0,0 +1,89 @@ +--- +title: table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - table_tags + - timestream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for tables in a region + +## Overview + + + + + + + +
Nametable_tags
TypeResource
DescriptionThe AWS::Timestream::Table resource creates a Timestream Table.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe table name exposed as a read-only attribute.
stringThe name for the database which the table to be created belongs to.
stringThe name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
objectThe retention duration of the memory store and the magnetic store.
objectA Schema specifies the expected data model of the table.
objectThe properties that determine whether magnetic store writes are enabled.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all tables in a region. +```sql +SELECT +region, +arn, +name, +database_name, +table_name, +retention_properties, +schema, +magnetic_store_write_properties, +tag_key, +tag_value +FROM aws.timestream.table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the table_tags resource, see tables + diff --git a/website/docs/services/timestream/tables/index.md b/website/docs/services/timestream/tables/index.md new file mode 100644 index 0000000..da6072f --- /dev/null +++ b/website/docs/services/timestream/tables/index.md @@ -0,0 +1,272 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a table resource or lists tables in a region + +## Overview + + + + + + + +
Nametables
TypeResource
DescriptionThe AWS::Timestream::Table resource creates a Timestream Table.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe table name exposed as a read-only attribute.
stringThe name for the database which the table to be created belongs to.
stringThe name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
objectThe retention duration of the memory store and the magnetic store.
objectA Schema specifies the expected data model of the table.
objectThe properties that determine whether magnetic store writes are enabled.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::Timestream::Table. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all tables in a region. +```sql +SELECT +region, +arn, +name, +database_name, +table_name, +retention_properties, +schema, +magnetic_store_write_properties, +tags +FROM aws.timestream.tables +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual table. +```sql +SELECT +region, +arn, +name, +database_name, +table_name, +retention_properties, +schema, +magnetic_store_write_properties, +tags +FROM aws.timestream.tables +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.timestream.tables ( + DatabaseName, + region +) +SELECT +'{{ DatabaseName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.timestream.tables ( + DatabaseName, + TableName, + RetentionProperties, + Schema, + MagneticStoreWriteProperties, + Tags, + region +) +SELECT + '{{ DatabaseName }}', + '{{ TableName }}', + '{{ RetentionProperties }}', + '{{ Schema }}', + '{{ MagneticStoreWriteProperties }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: table + props: + - name: DatabaseName + value: '{{ DatabaseName }}' + - name: TableName + value: '{{ TableName }}' + - name: RetentionProperties + value: + MemoryStoreRetentionPeriodInHours: '{{ MemoryStoreRetentionPeriodInHours }}' + MagneticStoreRetentionPeriodInDays: '{{ MagneticStoreRetentionPeriodInDays }}' + - name: Schema + value: + CompositePartitionKey: + - Type: '{{ Type }}' + Name: '{{ Name }}' + EnforcementInRecord: '{{ EnforcementInRecord }}' + - name: MagneticStoreWriteProperties + value: + EnableMagneticStoreWrites: '{{ EnableMagneticStoreWrites }}' + MagneticStoreRejectedDataLocation: + S3Configuration: + BucketName: '{{ BucketName }}' + ObjectKeyPrefix: '{{ ObjectKeyPrefix }}' + EncryptionOption: '{{ EncryptionOption }}' + KmsKeyId: '{{ KmsKeyId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.timestream.tables +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +timestream:ListTables, +timestream:DescribeEndpoints +``` diff --git a/website/docs/services/timestream/tables_list_only/index.md b/website/docs/services/timestream/tables_list_only/index.md new file mode 100644 index 0000000..b45cb86 --- /dev/null +++ b/website/docs/services/timestream/tables_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tables_list_only + - timestream + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tables in a region or regions, for all properties use tables + +## Overview + + + + + + + +
Nametables_list_only
TypeResource
DescriptionThe AWS::Timestream::Table resource creates a Timestream Table.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe table name exposed as a read-only attribute.
stringThe name for the database which the table to be created belongs to.
stringThe name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tables in a region. +```sql +SELECT +region, +database_name, +table_name +FROM aws.timestream.tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tables_list_only resource, see tables + diff --git a/website/docs/services/transfer/agreement_tags/index.md b/website/docs/services/transfer/agreement_tags/index.md new file mode 100644 index 0000000..f9646f3 --- /dev/null +++ b/website/docs/services/transfer/agreement_tags/index.md @@ -0,0 +1,93 @@ +--- +title: agreement_tags +hide_title: false +hide_table_of_contents: false +keywords: + - agreement_tags + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for agreements in a region + +## Overview + + + + + + + +
Nameagreement_tags
TypeResource
DescriptionResource Type definition for AWS::Transfer::Agreement
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA textual description for the agreement.
stringA unique identifier for the server.
stringA unique identifier for the local profile.
stringA unique identifier for the partner profile.
stringSpecifies the base directory for the agreement.
stringSpecifies the access role for the agreement.
stringSpecifies the status of the agreement.
stringA unique identifier for the agreement.
stringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all agreements in a region. +```sql +SELECT +region, +description, +server_id, +local_profile_id, +partner_profile_id, +base_directory, +access_role, +status, +agreement_id, +arn, +tag_key, +tag_value +FROM aws.transfer.agreement_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agreement_tags resource, see agreements + diff --git a/website/docs/services/transfer/agreements/index.md b/website/docs/services/transfer/agreements/index.md new file mode 100644 index 0000000..5434070 --- /dev/null +++ b/website/docs/services/transfer/agreements/index.md @@ -0,0 +1,264 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an agreement resource or lists agreements in a region + +## Overview + + + + + + + +
Nameagreements
TypeResource
DescriptionResource Type definition for AWS::Transfer::Agreement
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA textual description for the agreement.
stringA unique identifier for the server.
stringA unique identifier for the local profile.
stringA unique identifier for the partner profile.
stringSpecifies the base directory for the agreement.
stringSpecifies the access role for the agreement.
stringSpecifies the status of the agreement.
arrayKey-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
stringA unique identifier for the agreement.
stringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
stringAWS region.
+ +For more information, see AWS::Transfer::Agreement. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all agreements in a region. +```sql +SELECT +region, +description, +server_id, +local_profile_id, +partner_profile_id, +base_directory, +access_role, +status, +tags, +agreement_id, +arn +FROM aws.transfer.agreements +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual agreement. +```sql +SELECT +region, +description, +server_id, +local_profile_id, +partner_profile_id, +base_directory, +access_role, +status, +tags, +agreement_id, +arn +FROM aws.transfer.agreements +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new agreement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.agreements ( + ServerId, + LocalProfileId, + PartnerProfileId, + BaseDirectory, + AccessRole, + region +) +SELECT +'{{ ServerId }}', + '{{ LocalProfileId }}', + '{{ PartnerProfileId }}', + '{{ BaseDirectory }}', + '{{ AccessRole }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.agreements ( + Description, + ServerId, + LocalProfileId, + PartnerProfileId, + BaseDirectory, + AccessRole, + Status, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ ServerId }}', + '{{ LocalProfileId }}', + '{{ PartnerProfileId }}', + '{{ BaseDirectory }}', + '{{ AccessRole }}', + '{{ Status }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: agreement + props: + - name: Description + value: '{{ Description }}' + - name: ServerId + value: '{{ ServerId }}' + - name: LocalProfileId + value: '{{ LocalProfileId }}' + - name: PartnerProfileId + value: '{{ PartnerProfileId }}' + - name: BaseDirectory + value: '{{ BaseDirectory }}' + - name: AccessRole + value: '{{ AccessRole }}' + - name: Status + value: '{{ Status }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.transfer.agreements +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the agreements resource, the following permissions are required: + +### Create +```json +transfer:CreateAgreement, +transfer:TagResource, +iam:PassRole +``` + +### Read +```json +transfer:DescribeAgreement +``` + +### Update +```json +transfer:UpdateAgreement, +transfer:UnTagResource, +transfer:TagResource, +iam:PassRole +``` + +### Delete +```json +transfer:DeleteAgreement +``` + +### List +```json +transfer:ListAgreements +``` diff --git a/website/docs/services/transfer/agreements_list_only/index.md b/website/docs/services/transfer/agreements_list_only/index.md new file mode 100644 index 0000000..713c2a3 --- /dev/null +++ b/website/docs/services/transfer/agreements_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: agreements_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - agreements_list_only + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists agreements in a region or regions, for all properties use agreements + +## Overview + + + + + + + +
Nameagreements_list_only
TypeResource
DescriptionResource Type definition for AWS::Transfer::Agreement
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA unique identifier for the server.
stringA unique identifier for the agreement.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all agreements in a region. +```sql +SELECT +region, +agreement_id, +server_id +FROM aws.transfer.agreements_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agreements_list_only resource, see agreements + diff --git a/website/docs/services/transfer/certificate_tags/index.md b/website/docs/services/transfer/certificate_tags/index.md new file mode 100644 index 0000000..baebcd8 --- /dev/null +++ b/website/docs/services/transfer/certificate_tags/index.md @@ -0,0 +1,103 @@ +--- +title: certificate_tags +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_tags + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for certificates in a region + +## Overview + + + + + + + +
Namecertificate_tags
TypeResource
DescriptionResource Type definition for AWS::Transfer::Certificate
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies the usage type for the certificate.
stringSpecifies the certificate body to be imported.
stringSpecifies the certificate chain to be imported.
stringSpecifies the private key for the certificate.
stringSpecifies the active date for the certificate.
stringSpecifies the inactive date for the certificate.
stringA textual description for the certificate.
stringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
stringA unique identifier for the certificate.
stringA status description for the certificate.
stringDescribing the type of certificate. With or without a private key.
stringSpecifies Certificate's serial.
stringSpecifies the not before date for the certificate.
stringSpecifies the not after date for the certificate.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all certificates in a region. +```sql +SELECT +region, +usage, +certificate, +certificate_chain, +private_key, +active_date, +inactive_date, +description, +arn, +certificate_id, +status, +type, +serial, +not_before_date, +not_after_date, +tag_key, +tag_value +FROM aws.transfer.certificate_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_tags resource, see certificates + diff --git a/website/docs/services/transfer/certificates/index.md b/website/docs/services/transfer/certificates/index.md new file mode 100644 index 0000000..0c36c32 --- /dev/null +++ b/website/docs/services/transfer/certificates/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a certificate resource or lists certificates in a region + +## Overview + + + + + + + +
Namecertificates
TypeResource
DescriptionResource Type definition for AWS::Transfer::Certificate
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies the usage type for the certificate.
stringSpecifies the certificate body to be imported.
stringSpecifies the certificate chain to be imported.
stringSpecifies the private key for the certificate.
stringSpecifies the active date for the certificate.
stringSpecifies the inactive date for the certificate.
stringA textual description for the certificate.
arrayKey-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
stringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
stringA unique identifier for the certificate.
stringA status description for the certificate.
stringDescribing the type of certificate. With or without a private key.
stringSpecifies Certificate's serial.
stringSpecifies the not before date for the certificate.
stringSpecifies the not after date for the certificate.
stringAWS region.
+ +For more information, see AWS::Transfer::Certificate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all certificates in a region. +```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.certificates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual certificate. +```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.certificates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.certificates ( + Usage, + Certificate, + region +) +SELECT +'{{ Usage }}', + '{{ Certificate }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.certificates ( + Usage, + Certificate, + CertificateChain, + PrivateKey, + ActiveDate, + InactiveDate, + Description, + Tags, + region +) +SELECT + '{{ Usage }}', + '{{ Certificate }}', + '{{ CertificateChain }}', + '{{ PrivateKey }}', + '{{ ActiveDate }}', + '{{ InactiveDate }}', + '{{ Description }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: certificate + props: + - name: Usage + value: '{{ Usage }}' + - name: Certificate + value: '{{ Certificate }}' + - name: CertificateChain + value: '{{ CertificateChain }}' + - name: PrivateKey + value: '{{ PrivateKey }}' + - name: ActiveDate + value: '{{ ActiveDate }}' + - name: InactiveDate + value: '{{ InactiveDate }}' + - name: Description + value: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.transfer.certificates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the certificates resource, the following permissions are required: + +### Create +```json +transfer:ImportCertificate, +transfer:TagResource +``` + +### Read +```json +transfer:DescribeCertificate +``` + +### Update +```json +transfer:UpdateCertificate, +transfer:UnTagResource, +transfer:TagResource +``` + +### Delete +```json +transfer:DeleteCertificate +``` + +### List +```json +transfer:ListCertificates +``` diff --git a/website/docs/services/transfer/certificates_list_only/index.md b/website/docs/services/transfer/certificates_list_only/index.md new file mode 100644 index 0000000..bec9235 --- /dev/null +++ b/website/docs/services/transfer/certificates_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - certificates_list_only + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists certificates in a region or regions, for all properties use certificates + +## Overview + + + + + + + +
Namecertificates_list_only
TypeResource
DescriptionResource Type definition for AWS::Transfer::Certificate
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringSpecifies the certificate body to be imported.
stringA unique identifier for the certificate.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all certificates in a region. +```sql +SELECT +region, +certificate_id +FROM aws.transfer.certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificates_list_only resource, see certificates + diff --git a/website/docs/services/transfer/connector_tags/index.md b/website/docs/services/transfer/connector_tags/index.md new file mode 100644 index 0000000..1adf347 --- /dev/null +++ b/website/docs/services/transfer/connector_tags/index.md @@ -0,0 +1,93 @@ +--- +title: connector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connector_tags + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connectors in a region + +## Overview + + + + + + + +
Nameconnector_tags
TypeResource
DescriptionResource Type definition for AWS::Transfer::Connector
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies the access role for the connector.
objectConfiguration for an AS2 connector.
objectConfiguration for an SFTP connector.
stringSpecifies the unique Amazon Resource Name (ARN) for the connector.
stringA unique identifier for the connector.
stringSpecifies the logging role for the connector.
arrayThe list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
stringURL for Connector
stringSecurity policy for SFTP Connector
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connectors in a region. +```sql +SELECT +region, +access_role, +as2_config, +sftp_config, +arn, +connector_id, +logging_role, +service_managed_egress_ip_addresses, +url, +security_policy_name, +tag_key, +tag_value +FROM aws.transfer.connector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connector_tags resource, see connectors + diff --git a/website/docs/services/transfer/connectors/index.md b/website/docs/services/transfer/connectors/index.md new file mode 100644 index 0000000..f403454 --- /dev/null +++ b/website/docs/services/transfer/connectors/index.md @@ -0,0 +1,266 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connector resource or lists connectors in a region + +## Overview + + + + + + + +
Nameconnectors
TypeResource
DescriptionResource Type definition for AWS::Transfer::Connector
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies the access role for the connector.
objectConfiguration for an AS2 connector.
objectConfiguration for an SFTP connector.
stringSpecifies the unique Amazon Resource Name (ARN) for the connector.
stringA unique identifier for the connector.
stringSpecifies the logging role for the connector.
arrayThe list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
arrayKey-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
stringURL for Connector
stringSecurity policy for SFTP Connector
stringAWS region.
+ +For more information, see AWS::Transfer::Connector. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all connectors in a region. +```sql +SELECT +region, +access_role, +as2_config, +sftp_config, +arn, +connector_id, +logging_role, +service_managed_egress_ip_addresses, +tags, +url, +security_policy_name +FROM aws.transfer.connectors +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual connector. +```sql +SELECT +region, +access_role, +as2_config, +sftp_config, +arn, +connector_id, +logging_role, +service_managed_egress_ip_addresses, +tags, +url, +security_policy_name +FROM aws.transfer.connectors +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.connectors ( + AccessRole, + Url, + region +) +SELECT +'{{ AccessRole }}', + '{{ Url }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.connectors ( + AccessRole, + As2Config, + SftpConfig, + LoggingRole, + Tags, + Url, + SecurityPolicyName, + region +) +SELECT + '{{ AccessRole }}', + '{{ As2Config }}', + '{{ SftpConfig }}', + '{{ LoggingRole }}', + '{{ Tags }}', + '{{ Url }}', + '{{ SecurityPolicyName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connector + props: + - name: AccessRole + value: '{{ AccessRole }}' + - name: As2Config + value: + LocalProfileId: '{{ LocalProfileId }}' + PartnerProfileId: '{{ PartnerProfileId }}' + MessageSubject: '{{ MessageSubject }}' + Compression: '{{ Compression }}' + EncryptionAlgorithm: '{{ EncryptionAlgorithm }}' + SigningAlgorithm: '{{ SigningAlgorithm }}' + MdnSigningAlgorithm: '{{ MdnSigningAlgorithm }}' + MdnResponse: '{{ MdnResponse }}' + BasicAuthSecretId: '{{ BasicAuthSecretId }}' + - name: SftpConfig + value: + UserSecretId: '{{ UserSecretId }}' + TrustedHostKeys: + - '{{ TrustedHostKeys[0] }}' + - name: LoggingRole + value: '{{ LoggingRole }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Url + value: '{{ Url }}' + - name: SecurityPolicyName + value: '{{ SecurityPolicyName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.transfer.connectors +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +```json +transfer:CreateConnector, +transfer:TagResource, +iam:PassRole +``` + +### Read +```json +transfer:DescribeConnector +``` + +### Update +```json +transfer:UpdateConnector, +transfer:UnTagResource, +transfer:TagResource, +iam:PassRole +``` + +### Delete +```json +transfer:DeleteConnector +``` + +### List +```json +transfer:ListConnectors +``` diff --git a/website/docs/services/transfer/connectors_list_only/index.md b/website/docs/services/transfer/connectors_list_only/index.md new file mode 100644 index 0000000..e458575 --- /dev/null +++ b/website/docs/services/transfer/connectors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connectors_list_only + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connectors in a region or regions, for all properties use connectors + +## Overview + + + + + + + +
Nameconnectors_list_only
TypeResource
DescriptionResource Type definition for AWS::Transfer::Connector
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for the connector.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connectors in a region. +```sql +SELECT +region, +connector_id +FROM aws.transfer.connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connectors_list_only resource, see connectors + diff --git a/website/docs/services/transfer/index.md b/website/docs/services/transfer/index.md new file mode 100644 index 0000000..995acd7 --- /dev/null +++ b/website/docs/services/transfer/index.md @@ -0,0 +1,57 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The transfer service documentation. + +:::info Service Summary + +
+
+total resources: 22
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/transfer/profile_tags/index.md b/website/docs/services/transfer/profile_tags/index.md new file mode 100644 index 0000000..84026e6 --- /dev/null +++ b/website/docs/services/transfer/profile_tags/index.md @@ -0,0 +1,85 @@ +--- +title: profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profile_tags + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profiles in a region + +## Overview + + + + + + + +
Nameprofile_tags
TypeResource
DescriptionResource Type definition for AWS::Transfer::Profile
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringAS2 identifier agreed with a trading partner.
stringEnum specifying whether the profile is local or associated with a trading partner.
arrayList of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.
stringSpecifies the unique Amazon Resource Name (ARN) for the profile.
stringA unique identifier for the profile
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profiles in a region. +```sql +SELECT +region, +as2_id, +profile_type, +certificate_ids, +arn, +profile_id, +tag_key, +tag_value +FROM aws.transfer.profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_tags resource, see profiles + diff --git a/website/docs/services/transfer/profiles/index.md b/website/docs/services/transfer/profiles/index.md new file mode 100644 index 0000000..61a2a2f --- /dev/null +++ b/website/docs/services/transfer/profiles/index.md @@ -0,0 +1,229 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a profile resource or lists profiles in a region + +## Overview + + + + + + + +
Nameprofiles
TypeResource
DescriptionResource Type definition for AWS::Transfer::Profile
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringAS2 identifier agreed with a trading partner.
stringEnum specifying whether the profile is local or associated with a trading partner.
arrayAn array of key-value pairs to apply to this resource.
arrayList of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.
stringSpecifies the unique Amazon Resource Name (ARN) for the profile.
stringA unique identifier for the profile
stringAWS region.
+ +For more information, see AWS::Transfer::Profile. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all profiles in a region. +```sql +SELECT +region, +as2_id, +profile_type, +tags, +certificate_ids, +arn, +profile_id +FROM aws.transfer.profiles +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual profile. +```sql +SELECT +region, +as2_id, +profile_type, +tags, +certificate_ids, +arn, +profile_id +FROM aws.transfer.profiles +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.profiles ( + As2Id, + ProfileType, + region +) +SELECT +'{{ As2Id }}', + '{{ ProfileType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.profiles ( + As2Id, + ProfileType, + Tags, + CertificateIds, + region +) +SELECT + '{{ As2Id }}', + '{{ ProfileType }}', + '{{ Tags }}', + '{{ CertificateIds }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: profile + props: + - name: As2Id + value: '{{ As2Id }}' + - name: ProfileType + value: '{{ ProfileType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CertificateIds + value: + - '{{ CertificateIds[0] }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.transfer.profiles +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the profiles resource, the following permissions are required: + +### Create +```json +transfer:CreateProfile, +transfer:TagResource +``` + +### Read +```json +transfer:DescribeProfile +``` + +### Update +```json +transfer:UpdateProfile, +transfer:UnTagResource, +transfer:TagResource +``` + +### Delete +```json +transfer:DeleteProfile +``` + +### List +```json +transfer:ListProfiles +``` diff --git a/website/docs/services/transfer/profiles_list_only/index.md b/website/docs/services/transfer/profiles_list_only/index.md new file mode 100644 index 0000000..fb48c34 --- /dev/null +++ b/website/docs/services/transfer/profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profiles_list_only + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profiles in a region or regions, for all properties use profiles + +## Overview + + + + + + + +
Nameprofiles_list_only
TypeResource
DescriptionResource Type definition for AWS::Transfer::Profile
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for the profile
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profiles in a region. +```sql +SELECT +region, +profile_id +FROM aws.transfer.profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiles_list_only resource, see profiles + diff --git a/website/docs/services/transfer/public_keys/index.md b/website/docs/services/transfer/public_keys/index.md new file mode 100644 index 0000000..66a9adc --- /dev/null +++ b/website/docs/services/transfer/public_keys/index.md @@ -0,0 +1,63 @@ +--- +title: public_keys +hide_title: false +hide_table_of_contents: false +keywords: + - public_keys + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Imports or deletes a public key for a user + +## Overview + + + + + + + +
Namepublic_keys
TypeResource
Descriptionpublic_keys
Id
+ +## Fields +SELECT operation not supported for this resource. + +## Methods + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
+ + + + + + diff --git a/website/docs/services/transfer/server_tags/index.md b/website/docs/services/transfer/server_tags/index.md new file mode 100644 index 0000000..85fae5e --- /dev/null +++ b/website/docs/services/transfer/server_tags/index.md @@ -0,0 +1,113 @@ +--- +title: server_tags +hide_title: false +hide_table_of_contents: false +keywords: + - server_tags + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for servers in a region + +## Overview + + + + + + + +
Nameserver_tags
TypeResource
DescriptionDefinition of AWS::Transfer::Server Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayThe list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs. These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
string
string
object
string
object
string
string
string
string
object
array
object
string
string
string
array
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all servers in a region. +```sql +SELECT +region, +arn, +as2_service_managed_egress_ip_addresses, +certificate, +domain, +endpoint_details, +endpoint_type, +identity_provider_details, +identity_provider_type, +logging_role, +post_authentication_login_banner, +pre_authentication_login_banner, +protocol_details, +protocols, +s3_storage_options, +security_policy_name, +server_id, +state, +structured_log_destinations, +workflow_details, +tag_key, +tag_value +FROM aws.transfer.server_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the server_tags resource, see servers + diff --git a/website/docs/services/transfer/servers/index.md b/website/docs/services/transfer/servers/index.md new file mode 100644 index 0000000..ed9f022 --- /dev/null +++ b/website/docs/services/transfer/servers/index.md @@ -0,0 +1,425 @@ +--- +title: servers +hide_title: false +hide_table_of_contents: false +keywords: + - servers + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a server resource or lists servers in a region + +## Overview + + + + + + + +
Nameservers
TypeResource
DescriptionDefinition of AWS::Transfer::Server Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayThe list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs. These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
string
string
object
string
object
string
string
string
string
object
array
object
string
string
string
array
array
object
stringAWS region.
+ +For more information, see AWS::Transfer::Server. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
DELETE
INSERT
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all servers in a region. +```sql +SELECT +region, +arn, +as2_service_managed_egress_ip_addresses, +certificate, +domain, +endpoint_details, +endpoint_type, +identity_provider_details, +identity_provider_type, +logging_role, +post_authentication_login_banner, +pre_authentication_login_banner, +protocol_details, +protocols, +s3_storage_options, +security_policy_name, +server_id, +state, +structured_log_destinations, +tags, +workflow_details +FROM aws.transfer.servers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual server. +```sql +SELECT +region, +arn, +as2_service_managed_egress_ip_addresses, +certificate, +domain, +endpoint_details, +endpoint_type, +identity_provider_details, +identity_provider_type, +logging_role, +post_authentication_login_banner, +pre_authentication_login_banner, +protocol_details, +protocols, +s3_storage_options, +security_policy_name, +server_id, +state, +structured_log_destinations, +tags, +workflow_details +FROM aws.transfer.servers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new server resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.servers ( + Certificate, + Domain, + EndpointDetails, + EndpointType, + IdentityProviderDetails, + IdentityProviderType, + LoggingRole, + PostAuthenticationLoginBanner, + PreAuthenticationLoginBanner, + ProtocolDetails, + Protocols, + S3StorageOptions, + SecurityPolicyName, + StructuredLogDestinations, + Tags, + WorkflowDetails, + region +) +SELECT +'{{ Certificate }}', + '{{ Domain }}', + '{{ EndpointDetails }}', + '{{ EndpointType }}', + '{{ IdentityProviderDetails }}', + '{{ IdentityProviderType }}', + '{{ LoggingRole }}', + '{{ PostAuthenticationLoginBanner }}', + '{{ PreAuthenticationLoginBanner }}', + '{{ ProtocolDetails }}', + '{{ Protocols }}', + '{{ S3StorageOptions }}', + '{{ SecurityPolicyName }}', + '{{ StructuredLogDestinations }}', + '{{ Tags }}', + '{{ WorkflowDetails }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.servers ( + Certificate, + Domain, + EndpointDetails, + EndpointType, + IdentityProviderDetails, + IdentityProviderType, + LoggingRole, + PostAuthenticationLoginBanner, + PreAuthenticationLoginBanner, + ProtocolDetails, + Protocols, + S3StorageOptions, + SecurityPolicyName, + StructuredLogDestinations, + Tags, + WorkflowDetails, + region +) +SELECT + '{{ Certificate }}', + '{{ Domain }}', + '{{ EndpointDetails }}', + '{{ EndpointType }}', + '{{ IdentityProviderDetails }}', + '{{ IdentityProviderType }}', + '{{ LoggingRole }}', + '{{ PostAuthenticationLoginBanner }}', + '{{ PreAuthenticationLoginBanner }}', + '{{ ProtocolDetails }}', + '{{ Protocols }}', + '{{ S3StorageOptions }}', + '{{ SecurityPolicyName }}', + '{{ StructuredLogDestinations }}', + '{{ Tags }}', + '{{ WorkflowDetails }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: server + props: + - name: Certificate + value: '{{ Certificate }}' + - name: Domain + value: '{{ Domain }}' + - name: EndpointDetails + value: + AddressAllocationIds: + - '{{ AddressAllocationIds[0] }}' + SubnetIds: + - '{{ SubnetIds[0] }}' + VpcEndpointId: '{{ VpcEndpointId }}' + VpcId: '{{ VpcId }}' + SecurityGroupIds: + - '{{ SecurityGroupIds[0] }}' + - name: EndpointType + value: '{{ EndpointType }}' + - name: IdentityProviderDetails + value: + Url: '{{ Url }}' + InvocationRole: '{{ InvocationRole }}' + DirectoryId: '{{ DirectoryId }}' + Function: '{{ Function }}' + SftpAuthenticationMethods: '{{ SftpAuthenticationMethods }}' + - name: IdentityProviderType + value: '{{ IdentityProviderType }}' + - name: LoggingRole + value: '{{ LoggingRole }}' + - name: PostAuthenticationLoginBanner + value: '{{ PostAuthenticationLoginBanner }}' + - name: PreAuthenticationLoginBanner + value: '{{ PreAuthenticationLoginBanner }}' + - name: ProtocolDetails + value: + PassiveIp: '{{ PassiveIp }}' + TlsSessionResumptionMode: '{{ TlsSessionResumptionMode }}' + SetStatOption: '{{ SetStatOption }}' + As2Transports: + - '{{ As2Transports[0] }}' + - name: Protocols + value: + - '{{ Protocols[0] }}' + - name: S3StorageOptions + value: + DirectoryListingOptimization: '{{ DirectoryListingOptimization }}' + - name: SecurityPolicyName + value: '{{ SecurityPolicyName }}' + - name: StructuredLogDestinations + value: + - '{{ StructuredLogDestinations[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: WorkflowDetails + value: + OnUpload: + - WorkflowId: '{{ WorkflowId }}' + ExecutionRole: '{{ ExecutionRole }}' + OnPartialUpload: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.transfer.servers +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the servers resource, the following permissions are required: + +### Create +```json +apigateway:GET, +ds:AuthorizeApplication, +ds:DescribeDirectories, +ec2:AssociateAddress, +ec2:CreateVpcEndpoint, +ec2:DescribeAddresses, +ec2:DescribeNetworkInterfaces, +ec2:DescribeVpcEndpoints, +iam:PassRole, +logs:CreateLogDelivery, +logs:DeleteLogDelivery, +logs:DescribeLogGroups, +logs:DescribeResourcePolicies, +logs:GetLogDelivery, +logs:ListLogDeliveries, +logs:PutResourcePolicy, +logs:UpdateLogDelivery, +transfer:CreateServer, +transfer:DescribeServer, +transfer:StartServer, +transfer:StopServer, +transfer:TagResource, +transfer:UpdateServer +``` + +### Read +```json +ec2:DescribeVpcEndpoints, +transfer:DescribeServer +``` + +### Update +```json +apigateway:GET, +ec2:AssociateAddress, +ec2:CreateVpcEndpoint, +ec2:DeleteVpcEndpoints, +ec2:DescribeAddresses, +ec2:DescribeNetworkInterfaces, +ec2:DescribeVpcEndpoints, +ec2:DisassociateAddress, +ec2:ModifyVpcEndpoint, +iam:PassRole, +logs:CreateLogDelivery, +logs:DeleteLogDelivery, +logs:DescribeLogGroups, +logs:DescribeResourcePolicies, +logs:GetLogDelivery, +logs:ListLogDeliveries, +logs:PutResourcePolicy, +logs:UpdateLogDelivery, +transfer:DescribeServer, +transfer:StartServer, +transfer:StopServer, +transfer:TagResource, +transfer:UnTagResource, +transfer:UpdateServer +``` + +### Delete +```json +ds:DescribeDirectories, +ds:UnauthorizeApplication, +ec2:DeleteVpcEndpoints, +ec2:DescribeAddresses, +ec2:DescribeNetworkInterfaces, +ec2:DescribeVpcEndpoints, +ec2:DisassociateAddress, +logs:DeleteLogDelivery, +logs:GetLogDelivery, +logs:ListLogDeliveries, +transfer:DeleteServer +``` + +### List +```json +transfer:ListServers +``` diff --git a/website/docs/services/transfer/servers_list_only/index.md b/website/docs/services/transfer/servers_list_only/index.md new file mode 100644 index 0000000..22bdaea --- /dev/null +++ b/website/docs/services/transfer/servers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: servers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - servers_list_only + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists servers in a region or regions, for all properties use servers + +## Overview + + + + + + + +
Nameservers_list_only
TypeResource
DescriptionDefinition of AWS::Transfer::Server Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all servers in a region. +```sql +SELECT +region, +arn +FROM aws.transfer.servers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the servers_list_only resource, see servers + diff --git a/website/docs/services/transfer/user_tags/index.md b/website/docs/services/transfer/user_tags/index.md new file mode 100644 index 0000000..2042603 --- /dev/null +++ b/website/docs/services/transfer/user_tags/index.md @@ -0,0 +1,95 @@ +--- +title: user_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_tags + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for users in a region + +## Overview + + + + + + + +
Nameuser_tags
TypeResource
DescriptionDefinition of AWS::Transfer::User Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
object
string
string
arrayThis represents the SSH User Public Keys for CloudFormation resource
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all users in a region. +```sql +SELECT +region, +arn, +home_directory, +home_directory_mappings, +home_directory_type, +policy, +posix_profile, +role, +server_id, +ssh_public_keys, +user_name, +tag_key, +tag_value +FROM aws.transfer.user_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_tags resource, see users + diff --git a/website/docs/services/transfer/users/index.md b/website/docs/services/transfer/users/index.md new file mode 100644 index 0000000..57541a1 --- /dev/null +++ b/website/docs/services/transfer/users/index.md @@ -0,0 +1,284 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a user resource or lists users in a region + +## Overview + + + + + + + +
Nameusers
TypeResource
DescriptionDefinition of AWS::Transfer::User Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
object
string
string
arrayThis represents the SSH User Public Keys for CloudFormation resource
array
string
stringAWS region.
+ +For more information, see AWS::Transfer::User. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all users in a region. +```sql +SELECT +region, +arn, +home_directory, +home_directory_mappings, +home_directory_type, +policy, +posix_profile, +role, +server_id, +ssh_public_keys, +tags, +user_name +FROM aws.transfer.users +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user. +```sql +SELECT +region, +arn, +home_directory, +home_directory_mappings, +home_directory_type, +policy, +posix_profile, +role, +server_id, +ssh_public_keys, +tags, +user_name +FROM aws.transfer.users +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.users ( + Role, + ServerId, + UserName, + region +) +SELECT +'{{ Role }}', + '{{ ServerId }}', + '{{ UserName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.users ( + HomeDirectory, + HomeDirectoryMappings, + HomeDirectoryType, + Policy, + PosixProfile, + Role, + ServerId, + SshPublicKeys, + Tags, + UserName, + region +) +SELECT + '{{ HomeDirectory }}', + '{{ HomeDirectoryMappings }}', + '{{ HomeDirectoryType }}', + '{{ Policy }}', + '{{ PosixProfile }}', + '{{ Role }}', + '{{ ServerId }}', + '{{ SshPublicKeys }}', + '{{ Tags }}', + '{{ UserName }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user + props: + - name: HomeDirectory + value: '{{ HomeDirectory }}' + - name: HomeDirectoryMappings + value: + - Entry: '{{ Entry }}' + Target: '{{ Target }}' + Type: '{{ Type }}' + - name: HomeDirectoryType + value: '{{ HomeDirectoryType }}' + - name: Policy + value: '{{ Policy }}' + - name: PosixProfile + value: + Uid: null + Gid: null + SecondaryGids: + - null + - name: Role + value: '{{ Role }}' + - name: ServerId + value: '{{ ServerId }}' + - name: SshPublicKeys + value: + - '{{ SshPublicKeys[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: UserName + value: '{{ UserName }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.transfer.users +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the users resource, the following permissions are required: + +### Create +```json +iam:PassRole, +transfer:CreateUser, +transfer:DescribeUser, +transfer:ImportSshPublicKey, +transfer:TagResource +``` + +### Read +```json +transfer:DescribeUser +``` + +### Update +```json +iam:PassRole, +transfer:DeleteSshPublicKey, +transfer:DescribeUser, +transfer:ImportSshPublicKey, +transfer:TagResource, +transfer:UnTagResource, +transfer:UpdateUser +``` + +### Delete +```json +transfer:DeleteUser +``` + +### List +```json +transfer:ListUsers +``` diff --git a/website/docs/services/transfer/users_list_only/index.md b/website/docs/services/transfer/users_list_only/index.md new file mode 100644 index 0000000..1f6df16 --- /dev/null +++ b/website/docs/services/transfer/users_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - users_list_only + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists users in a region or regions, for all properties use users + +## Overview + + + + + + + +
Nameusers_list_only
TypeResource
DescriptionDefinition of AWS::Transfer::User Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all users in a region. +```sql +SELECT +region, +arn +FROM aws.transfer.users_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the users_list_only resource, see users + diff --git a/website/docs/services/transfer/workflow_tags/index.md b/website/docs/services/transfer/workflow_tags/index.md new file mode 100644 index 0000000..96c7a03 --- /dev/null +++ b/website/docs/services/transfer/workflow_tags/index.md @@ -0,0 +1,85 @@ +--- +title: workflow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workflow_tags + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workflows in a region + +## Overview + + + + + + + +
Nameworkflow_tags
TypeResource
DescriptionResource Type definition for AWS::Transfer::Workflow
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arraySpecifies the steps (actions) to take if any errors are encountered during execution of the workflow.
arraySpecifies the details for the steps that are in the specified workflow.
stringA textual description for the workflow.
stringA unique identifier for the workflow.
stringSpecifies the unique Amazon Resource Name (ARN) for the workflow.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workflows in a region. +```sql +SELECT +region, +on_exception_steps, +steps, +description, +workflow_id, +arn, +tag_key, +tag_value +FROM aws.transfer.workflow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflow_tags resource, see workflows + diff --git a/website/docs/services/transfer/workflows/index.md b/website/docs/services/transfer/workflows/index.md new file mode 100644 index 0000000..86b0717 --- /dev/null +++ b/website/docs/services/transfer/workflows/index.md @@ -0,0 +1,259 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a workflow resource or lists workflows in a region + +## Overview + + + + + + + +
Nameworkflows
TypeResource
DescriptionResource Type definition for AWS::Transfer::Workflow
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arraySpecifies the steps (actions) to take if any errors are encountered during execution of the workflow.
arraySpecifies the details for the steps that are in the specified workflow.
arrayKey-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
stringA textual description for the workflow.
stringA unique identifier for the workflow.
stringSpecifies the unique Amazon Resource Name (ARN) for the workflow.
stringAWS region.
+ +For more information, see AWS::Transfer::Workflow. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all workflows in a region. +```sql +SELECT +region, +on_exception_steps, +steps, +tags, +description, +workflow_id, +arn +FROM aws.transfer.workflows +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual workflow. +```sql +SELECT +region, +on_exception_steps, +steps, +tags, +description, +workflow_id, +arn +FROM aws.transfer.workflows +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workflow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.workflows ( + Steps, + region +) +SELECT +'{{ Steps }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.transfer.workflows ( + OnExceptionSteps, + Steps, + Tags, + Description, + region +) +SELECT + '{{ OnExceptionSteps }}', + '{{ Steps }}', + '{{ Tags }}', + '{{ Description }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: workflow + props: + - name: OnExceptionSteps + value: + - CopyStepDetails: + DestinationFileLocation: + S3FileLocation: + Bucket: '{{ Bucket }}' + Key: '{{ Key }}' + Name: '{{ Name }}' + OverwriteExisting: '{{ OverwriteExisting }}' + SourceFileLocation: '{{ SourceFileLocation }}' + CustomStepDetails: + Name: '{{ Name }}' + Target: '{{ Target }}' + TimeoutSeconds: '{{ TimeoutSeconds }}' + SourceFileLocation: '{{ SourceFileLocation }}' + DecryptStepDetails: + DestinationFileLocation: + S3FileLocation: null + EfsFileLocation: + FileSystemId: '{{ FileSystemId }}' + Path: '{{ Path }}' + Name: '{{ Name }}' + Type: '{{ Type }}' + OverwriteExisting: '{{ OverwriteExisting }}' + SourceFileLocation: '{{ SourceFileLocation }}' + DeleteStepDetails: + Name: '{{ Name }}' + SourceFileLocation: '{{ SourceFileLocation }}' + TagStepDetails: + Name: '{{ Name }}' + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + SourceFileLocation: '{{ SourceFileLocation }}' + Type: '{{ Type }}' + - name: Steps + value: + - null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Description + value: '{{ Description }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.transfer.workflows +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the workflows resource, the following permissions are required: + +### Create +```json +transfer:CreateWorkflow, +transfer:TagResource +``` + +### Read +```json +transfer:DescribeWorkflow +``` + +### Delete +```json +transfer:DeleteWorkflow +``` + +### List +```json +transfer:ListWorkflows +``` + +### Update +```json +transfer:UnTagResource, +transfer:TagResource +``` diff --git a/website/docs/services/transfer/workflows_list_only/index.md b/website/docs/services/transfer/workflows_list_only/index.md new file mode 100644 index 0000000..abe8971 --- /dev/null +++ b/website/docs/services/transfer/workflows_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: workflows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workflows_list_only + - transfer + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workflows in a region or regions, for all properties use workflows + +## Overview + + + + + + + +
Nameworkflows_list_only
TypeResource
DescriptionResource Type definition for AWS::Transfer::Workflow
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA unique identifier for the workflow.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workflows in a region. +```sql +SELECT +region, +workflow_id +FROM aws.transfer.workflows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflows_list_only resource, see workflows + diff --git a/website/docs/services/verifiedpermissions/identity_sources/index.md b/website/docs/services/verifiedpermissions/identity_sources/index.md new file mode 100644 index 0000000..6f24d01 --- /dev/null +++ b/website/docs/services/verifiedpermissions/identity_sources/index.md @@ -0,0 +1,230 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an identity_source resource or lists identity_sources in a region + +## Overview + + + + + + + +
Nameidentity_sources
TypeResource
DescriptionDefinition of AWS::VerifiedPermissions::IdentitySource Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
undefined
object
string
string
string
stringAWS region.
+ +For more information, see AWS::VerifiedPermissions::IdentitySource. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all identity_sources in a region. +```sql +SELECT +region, +configuration, +details, +identity_source_id, +policy_store_id, +principal_entity_type +FROM aws.verifiedpermissions.identity_sources +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual identity_source. +```sql +SELECT +region, +configuration, +details, +identity_source_id, +policy_store_id, +principal_entity_type +FROM aws.verifiedpermissions.identity_sources +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new identity_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.verifiedpermissions.identity_sources ( + Configuration, + PolicyStoreId, + region +) +SELECT +'{{ Configuration }}', + '{{ PolicyStoreId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.verifiedpermissions.identity_sources ( + Configuration, + PolicyStoreId, + PrincipalEntityType, + region +) +SELECT + '{{ Configuration }}', + '{{ PolicyStoreId }}', + '{{ PrincipalEntityType }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: identity_source + props: + - name: Configuration + value: null + - name: PolicyStoreId + value: '{{ PolicyStoreId }}' + - name: PrincipalEntityType + value: '{{ PrincipalEntityType }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.verifiedpermissions.identity_sources +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +verifiedpermissions:ListIdentitySources, +verifiedpermissions:GetIdentitySource, +cognito-idp:DescribeUserPool, +cognito-idp:ListUserPoolClients +``` diff --git a/website/docs/services/verifiedpermissions/identity_sources_list_only/index.md b/website/docs/services/verifiedpermissions/identity_sources_list_only/index.md new file mode 100644 index 0000000..5c367ef --- /dev/null +++ b/website/docs/services/verifiedpermissions/identity_sources_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: identity_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_sources_list_only + - verifiedpermissions + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_sources in a region or regions, for all properties use identity_sources + +## Overview + + + + + + + +
Nameidentity_sources_list_only
TypeResource
DescriptionDefinition of AWS::VerifiedPermissions::IdentitySource Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_sources in a region. +```sql +SELECT +region, +identity_source_id, +policy_store_id +FROM aws.verifiedpermissions.identity_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_sources_list_only resource, see identity_sources + diff --git a/website/docs/services/verifiedpermissions/index.md b/website/docs/services/verifiedpermissions/index.md new file mode 100644 index 0000000..cd1b803 --- /dev/null +++ b/website/docs/services/verifiedpermissions/index.md @@ -0,0 +1,43 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The verifiedpermissions service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/verifiedpermissions/policies/index.md b/website/docs/services/verifiedpermissions/policies/index.md new file mode 100644 index 0000000..3223734 --- /dev/null +++ b/website/docs/services/verifiedpermissions/policies/index.md @@ -0,0 +1,213 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a policy resource or lists policies in a region + +## Overview + + + + + + + +
Namepolicies
TypeResource
DescriptionDefinition of AWS::VerifiedPermissions::Policy Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
undefined
string
string
string
stringAWS region.
+ +For more information, see AWS::VerifiedPermissions::Policy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all policies in a region. +```sql +SELECT +region, +definition, +policy_id, +policy_store_id, +policy_type +FROM aws.verifiedpermissions.policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual policy. +```sql +SELECT +region, +definition, +policy_id, +policy_store_id, +policy_type +FROM aws.verifiedpermissions.policies +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.verifiedpermissions.policies ( + Definition, + PolicyStoreId, + region +) +SELECT +'{{ Definition }}', + '{{ PolicyStoreId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.verifiedpermissions.policies ( + Definition, + PolicyStoreId, + region +) +SELECT + '{{ Definition }}', + '{{ PolicyStoreId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: policy + props: + - name: Definition + value: null + - name: PolicyStoreId + value: '{{ PolicyStoreId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.verifiedpermissions.policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the policies resource, the following permissions are required: + +### Create +```json +verifiedpermissions:CreatePolicy, +verifiedpermissions:GetPolicy +``` + +### Read +```json +verifiedpermissions:GetPolicy +``` + +### Update +```json +verifiedpermissions:UpdatePolicy, +verifiedpermissions:GetPolicy +``` + +### Delete +```json +verifiedpermissions:DeletePolicy, +verifiedpermissions:GetPolicy +``` + +### List +```json +verifiedpermissions:ListPolicies, +verifiedpermissions:GetPolicy +``` diff --git a/website/docs/services/verifiedpermissions/policies_list_only/index.md b/website/docs/services/verifiedpermissions/policies_list_only/index.md new file mode 100644 index 0000000..7cb92a3 --- /dev/null +++ b/website/docs/services/verifiedpermissions/policies_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policies_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policies in a region or regions, for all properties use policies + +## Overview + + + + + + + +
Namepolicies_list_only
TypeResource
DescriptionDefinition of AWS::VerifiedPermissions::Policy Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policies in a region. +```sql +SELECT +region, +policy_id, +policy_store_id +FROM aws.verifiedpermissions.policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policies_list_only resource, see policies + diff --git a/website/docs/services/verifiedpermissions/policy_stores/index.md b/website/docs/services/verifiedpermissions/policy_stores/index.md new file mode 100644 index 0000000..42b40bc --- /dev/null +++ b/website/docs/services/verifiedpermissions/policy_stores/index.md @@ -0,0 +1,225 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a policy_store resource or lists 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
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
object
stringAWS region.
+ +For more information, see AWS::VerifiedPermissions::PolicyStore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all policy_stores in a region. +```sql +SELECT +region, +arn, +description, +policy_store_id, +validation_settings, +schema +FROM aws.verifiedpermissions.policy_stores +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual policy_store. +```sql +SELECT +region, +arn, +description, +policy_store_id, +validation_settings, +schema +FROM aws.verifiedpermissions.policy_stores +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new policy_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.verifiedpermissions.policy_stores ( + ValidationSettings, + region +) +SELECT +'{{ ValidationSettings }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.verifiedpermissions.policy_stores ( + Description, + ValidationSettings, + Schema, + region +) +SELECT + '{{ Description }}', + '{{ ValidationSettings }}', + '{{ Schema }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: policy_store + props: + - name: Description + value: '{{ Description }}' + - name: ValidationSettings + value: + Mode: '{{ Mode }}' + - name: Schema + value: + CedarJson: '{{ CedarJson }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.verifiedpermissions.policy_stores +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +verifiedpermissions:GetPolicyStore, +verifiedpermissions:GetSchema +``` + +### Update +```json +verifiedpermissions:UpdatePolicyStore, +verifiedpermissions:GetPolicyStore, +verifiedpermissions:GetSchema, +verifiedpermissions:PutSchema +``` + +### Delete +```json +verifiedpermissions:DeletePolicyStore, +verifiedpermissions:GetPolicyStore +``` + +### List +```json +verifiedpermissions:ListPolicyStores, +verifiedpermissions:GetPolicyStore, +verifiedpermissions:GetSchema +``` diff --git a/website/docs/services/verifiedpermissions/policy_stores_list_only/index.md b/website/docs/services/verifiedpermissions/policy_stores_list_only/index.md new file mode 100644 index 0000000..0963c38 --- /dev/null +++ b/website/docs/services/verifiedpermissions/policy_stores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: policy_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policy_stores_list_only + - verifiedpermissions + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policy_stores in a region or regions, for all properties use policy_stores + +## Overview + + + + + + + +
Namepolicy_stores_list_only
TypeResource
DescriptionRepresents a policy store that you can place schema, policies, and policy templates in to validate authorization requests
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policy_stores in a region. +```sql +SELECT +region, +policy_store_id +FROM aws.verifiedpermissions.policy_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_stores_list_only resource, see policy_stores + diff --git a/website/docs/services/verifiedpermissions/policy_templates/index.md b/website/docs/services/verifiedpermissions/policy_templates/index.md new file mode 100644 index 0000000..a2e3d77 --- /dev/null +++ b/website/docs/services/verifiedpermissions/policy_templates/index.md @@ -0,0 +1,217 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a policy_template resource or lists policy_templates in a region + +## Overview + + + + + + + +
Namepolicy_templates
TypeResource
DescriptionDefinition of AWS::VerifiedPermissions::PolicyTemplate Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringAWS region.
+ +For more information, see AWS::VerifiedPermissions::PolicyTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all policy_templates in a region. +```sql +SELECT +region, +description, +policy_store_id, +policy_template_id, +statement +FROM aws.verifiedpermissions.policy_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual policy_template. +```sql +SELECT +region, +description, +policy_store_id, +policy_template_id, +statement +FROM aws.verifiedpermissions.policy_templates +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new policy_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.verifiedpermissions.policy_templates ( + PolicyStoreId, + Statement, + region +) +SELECT +'{{ PolicyStoreId }}', + '{{ Statement }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.verifiedpermissions.policy_templates ( + Description, + PolicyStoreId, + Statement, + region +) +SELECT + '{{ Description }}', + '{{ PolicyStoreId }}', + '{{ Statement }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: policy_template + props: + - name: Description + value: '{{ Description }}' + - name: PolicyStoreId + value: '{{ PolicyStoreId }}' + - name: Statement + value: '{{ Statement }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.verifiedpermissions.policy_templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the policy_templates resource, the following permissions are required: + +### Create +```json +verifiedpermissions:CreatePolicyTemplate, +verifiedpermissions:GetPolicyTemplate +``` + +### Read +```json +verifiedpermissions:GetPolicyTemplate +``` + +### Update +```json +verifiedpermissions:UpdatePolicyTemplate, +verifiedpermissions:GetPolicyTemplate +``` + +### Delete +```json +verifiedpermissions:DeletePolicyTemplate, +verifiedpermissions:GetPolicyTemplate +``` + +### List +```json +verifiedpermissions:ListPolicyTemplates, +verifiedpermissions:GetPolicyTemplate +``` diff --git a/website/docs/services/verifiedpermissions/policy_templates_list_only/index.md b/website/docs/services/verifiedpermissions/policy_templates_list_only/index.md new file mode 100644 index 0000000..cdc59b4 --- /dev/null +++ b/website/docs/services/verifiedpermissions/policy_templates_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: policy_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policy_templates_list_only + - verifiedpermissions + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policy_templates in a region or regions, for all properties use policy_templates + +## Overview + + + + + + + +
Namepolicy_templates_list_only
TypeResource
DescriptionDefinition of AWS::VerifiedPermissions::PolicyTemplate Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policy_templates in a region. +```sql +SELECT +region, +policy_store_id, +policy_template_id +FROM aws.verifiedpermissions.policy_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_templates_list_only resource, see policy_templates + diff --git a/website/docs/services/voiceid/domain_tags/index.md b/website/docs/services/voiceid/domain_tags/index.md new file mode 100644 index 0000000..eeecfc0 --- /dev/null +++ b/website/docs/services/voiceid/domain_tags/index.md @@ -0,0 +1,83 @@ +--- +title: domain_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_tags + - voiceid + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domains in a region + +## Overview + + + + + + + +
Namedomain_tags
TypeResource
DescriptionThe AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domains in a region. +```sql +SELECT +region, +description, +domain_id, +name, +server_side_encryption_configuration, +tag_key, +tag_value +FROM aws.voiceid.domain_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_tags resource, see domains + diff --git a/website/docs/services/voiceid/domains/index.md b/website/docs/services/voiceid/domains/index.md new file mode 100644 index 0000000..7e3b227 --- /dev/null +++ b/website/docs/services/voiceid/domains/index.md @@ -0,0 +1,241 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a domain resource or lists domains in a region + +## Overview + + + + + + + +
Namedomains
TypeResource
DescriptionThe AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
array
stringAWS region.
+ +For more information, see AWS::VoiceID::Domain. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all domains in a region. +```sql +SELECT +region, +description, +domain_id, +name, +server_side_encryption_configuration, +tags +FROM aws.voiceid.domains +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual domain. +```sql +SELECT +region, +description, +domain_id, +name, +server_side_encryption_configuration, +tags +FROM aws.voiceid.domains +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.voiceid.domains ( + Name, + ServerSideEncryptionConfiguration, + region +) +SELECT +'{{ Name }}', + '{{ ServerSideEncryptionConfiguration }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.voiceid.domains ( + Description, + Name, + ServerSideEncryptionConfiguration, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ ServerSideEncryptionConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: domain + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: ServerSideEncryptionConfiguration + value: + KmsKeyId: '{{ KmsKeyId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.voiceid.domains +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +voiceid:ListDomains, +kms:Decrypt +``` diff --git a/website/docs/services/voiceid/domains_list_only/index.md b/website/docs/services/voiceid/domains_list_only/index.md new file mode 100644 index 0000000..256b541 --- /dev/null +++ b/website/docs/services/voiceid/domains_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domains_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domains in a region or regions, for all properties use domains + +## Overview + + + + + + + +
Namedomains_list_only
TypeResource
DescriptionThe AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domains in a region. +```sql +SELECT +region, +domain_id +FROM aws.voiceid.domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domains_list_only resource, see domains + diff --git a/website/docs/services/voiceid/index.md b/website/docs/services/voiceid/index.md new file mode 100644 index 0000000..01c6c88 --- /dev/null +++ b/website/docs/services/voiceid/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The voiceid service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/vpclattice/access_log_subscription_tags/index.md b/website/docs/services/vpclattice/access_log_subscription_tags/index.md new file mode 100644 index 0000000..992dfcf --- /dev/null +++ b/website/docs/services/vpclattice/access_log_subscription_tags/index.md @@ -0,0 +1,89 @@ +--- +title: access_log_subscription_tags +hide_title: false +hide_table_of_contents: false +keywords: + - access_log_subscription_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for access_log_subscriptions in a region + +## Overview + + + + + + + +
Nameaccess_log_subscription_tags
TypeResource
DescriptionEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all access_log_subscriptions in a region. +```sql +SELECT +region, +arn, +destination_arn, +id, +resource_arn, +resource_id, +resource_identifier, +service_network_log_type, +tag_key, +tag_value +FROM aws.vpclattice.access_log_subscription_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_log_subscription_tags resource, see access_log_subscriptions + diff --git a/website/docs/services/vpclattice/access_log_subscriptions/index.md b/website/docs/services/vpclattice/access_log_subscriptions/index.md new file mode 100644 index 0000000..28a6467 --- /dev/null +++ b/website/docs/services/vpclattice/access_log_subscriptions/index.md @@ -0,0 +1,281 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an access_log_subscription resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::VpcLattice::AccessLogSubscription. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all access_log_subscriptions in a region. +```sql +SELECT +region, +arn, +destination_arn, +id, +resource_arn, +resource_id, +resource_identifier, +service_network_log_type, +tags +FROM aws.vpclattice.access_log_subscriptions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual access_log_subscription. +```sql +SELECT +region, +arn, +destination_arn, +id, +resource_arn, +resource_id, +resource_identifier, +service_network_log_type, +tags +FROM aws.vpclattice.access_log_subscriptions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new access_log_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.access_log_subscriptions ( + DestinationArn, + region +) +SELECT +'{{ DestinationArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.access_log_subscriptions ( + DestinationArn, + ResourceIdentifier, + ServiceNetworkLogType, + Tags, + region +) +SELECT + '{{ DestinationArn }}', + '{{ ResourceIdentifier }}', + '{{ ServiceNetworkLogType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: access_log_subscription + props: + - name: DestinationArn + value: '{{ DestinationArn }}' + - name: ResourceIdentifier + value: '{{ ResourceIdentifier }}' + - name: ServiceNetworkLogType + value: '{{ ServiceNetworkLogType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.access_log_subscriptions +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +vpc-lattice:GetAccessLogSubscription, +vpc-lattice:ListTagsForResource, +logs:GetLogDelivery +``` + +### Update +```json +vpc-lattice:GetAccessLogSubscription, +vpc-lattice:UpdateAccessLogSubscription, +vpc-lattice:ListTagsForResource, +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 +``` + +### List +```json +vpc-lattice:ListAccessLogSubscriptions +``` diff --git a/website/docs/services/vpclattice/access_log_subscriptions_list_only/index.md b/website/docs/services/vpclattice/access_log_subscriptions_list_only/index.md new file mode 100644 index 0000000..5bd01b0 --- /dev/null +++ b/website/docs/services/vpclattice/access_log_subscriptions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_log_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_log_subscriptions_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_log_subscriptions in a region or regions, for all properties use access_log_subscriptions + +## Overview + + + + + + + +
Nameaccess_log_subscriptions_list_only
TypeResource
DescriptionEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_log_subscriptions in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.access_log_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_log_subscriptions_list_only resource, see access_log_subscriptions + diff --git a/website/docs/services/vpclattice/auth_policies/index.md b/website/docs/services/vpclattice/auth_policies/index.md new file mode 100644 index 0000000..a27fd5f --- /dev/null +++ b/website/docs/services/vpclattice/auth_policies/index.md @@ -0,0 +1,190 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an auth_policy resource or lists auth_policies in a region + +## Overview + + + + + + + +
Nameauth_policies
TypeResource
DescriptionCreates or updates the auth policy.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
object
string
stringAWS region.
+ +For more information, see AWS::VpcLattice::AuthPolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual auth_policy. +```sql +SELECT +region, +resource_identifier, +policy, +state +FROM aws.vpclattice.auth_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new auth_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.auth_policies ( + ResourceIdentifier, + Policy, + region +) +SELECT +'{{ ResourceIdentifier }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.auth_policies ( + ResourceIdentifier, + Policy, + region +) +SELECT + '{{ ResourceIdentifier }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: auth_policy + props: + - name: ResourceIdentifier + value: '{{ ResourceIdentifier }}' + - name: Policy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.auth_policies +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +vpc-lattice:GetAuthPolicy +``` + +### Update +```json +vpc-lattice:GetAuthPolicy, +vpc-lattice:PutAuthPolicy +``` + +### Delete +```json +vpc-lattice:GetAuthPolicy, +vpc-lattice:DeleteAuthPolicy +``` diff --git a/website/docs/services/vpclattice/index.md b/website/docs/services/vpclattice/index.md new file mode 100644 index 0000000..b368bda --- /dev/null +++ b/website/docs/services/vpclattice/index.md @@ -0,0 +1,70 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The vpclattice service documentation. + +:::info Service Summary + +
+
+total resources: 35
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/vpclattice/listener_tags/index.md b/website/docs/services/vpclattice/listener_tags/index.md new file mode 100644 index 0000000..1120f23 --- /dev/null +++ b/website/docs/services/vpclattice/listener_tags/index.md @@ -0,0 +1,93 @@ +--- +title: listener_tags +hide_title: false +hide_table_of_contents: false +keywords: + - listener_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for listeners in a region + +## Overview + + + + + + + +
Namelistener_tags
TypeResource
DescriptionCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
integer
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all listeners in a region. +```sql +SELECT +region, +arn, +default_action, +id, +name, +port, +protocol, +service_arn, +service_id, +service_identifier, +tag_key, +tag_value +FROM aws.vpclattice.listener_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the listener_tags resource, see listeners + diff --git a/website/docs/services/vpclattice/listeners/index.md b/website/docs/services/vpclattice/listeners/index.md new file mode 100644 index 0000000..5ba0e65 --- /dev/null +++ b/website/docs/services/vpclattice/listeners/index.md @@ -0,0 +1,259 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a listener resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
integer
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::VpcLattice::Listener. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all listeners in a region. +```sql +SELECT +region, +arn, +default_action, +id, +name, +port, +protocol, +service_arn, +service_id, +service_identifier, +tags +FROM aws.vpclattice.listeners +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual listener. +```sql +SELECT +region, +arn, +default_action, +id, +name, +port, +protocol, +service_arn, +service_id, +service_identifier, +tags +FROM aws.vpclattice.listeners +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new listener resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.listeners ( + DefaultAction, + Protocol, + region +) +SELECT +'{{ DefaultAction }}', + '{{ Protocol }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.listeners ( + DefaultAction, + Name, + Port, + Protocol, + ServiceIdentifier, + Tags, + region +) +SELECT + '{{ DefaultAction }}', + '{{ Name }}', + '{{ Port }}', + '{{ Protocol }}', + '{{ ServiceIdentifier }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: listener + props: + - name: DefaultAction + value: + Forward: + TargetGroups: + - TargetGroupIdentifier: '{{ TargetGroupIdentifier }}' + Weight: '{{ Weight }}' + FixedResponse: + StatusCode: '{{ StatusCode }}' + - name: Name + value: '{{ Name }}' + - name: Port + value: '{{ Port }}' + - name: Protocol + value: '{{ Protocol }}' + - name: ServiceIdentifier + value: '{{ ServiceIdentifier }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.listeners +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +vpc-lattice:ListListeners +``` diff --git a/website/docs/services/vpclattice/listeners_list_only/index.md b/website/docs/services/vpclattice/listeners_list_only/index.md new file mode 100644 index 0000000..cc65652 --- /dev/null +++ b/website/docs/services/vpclattice/listeners_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: listeners_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - listeners_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists listeners in a region or regions, for all properties use listeners + +## Overview + + + + + + + +
Namelisteners_list_only
TypeResource
DescriptionCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all listeners in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.listeners_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the listeners_list_only resource, see listeners + diff --git a/website/docs/services/vpclattice/resource_configuration_tags/index.md b/website/docs/services/vpclattice/resource_configuration_tags/index.md new file mode 100644 index 0000000..c4061a1 --- /dev/null +++ b/website/docs/services/vpclattice/resource_configuration_tags/index.md @@ -0,0 +1,97 @@ +--- +title: resource_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resource_configuration_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resource_configurations in a region + +## Overview + + + + + + + +
Nameresource_configuration_tags
TypeResource
DescriptionVpcLattice ResourceConfiguration CFN resource
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
string
string
array
object
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resource_configurations in a region. +```sql +SELECT +region, +allow_association_to_sharable_service_network, +protocol_type, +resource_configuration_type, +port_ranges, +resource_configuration_definition, +id, +resource_gateway_id, +arn, +resource_configuration_auth_type, +resource_configuration_group_id, +name, +tag_key, +tag_value +FROM aws.vpclattice.resource_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_configuration_tags resource, see resource_configurations + diff --git a/website/docs/services/vpclattice/resource_configurations/index.md b/website/docs/services/vpclattice/resource_configurations/index.md new file mode 100644 index 0000000..1a9638d --- /dev/null +++ b/website/docs/services/vpclattice/resource_configurations/index.md @@ -0,0 +1,278 @@ +--- +title: resource_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - resource_configurations + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_configuration resource or lists resource_configurations in a region + +## Overview + + + + + + + +
Nameresource_configurations
TypeResource
DescriptionVpcLattice ResourceConfiguration CFN resource
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
string
string
array
object
string
string
string
string
string
array
string
stringAWS region.
+ +For more information, see AWS::VpcLattice::ResourceConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_configurations in a region. +```sql +SELECT +region, +allow_association_to_sharable_service_network, +protocol_type, +resource_configuration_type, +port_ranges, +resource_configuration_definition, +id, +resource_gateway_id, +arn, +resource_configuration_auth_type, +resource_configuration_group_id, +tags, +name +FROM aws.vpclattice.resource_configurations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_configuration. +```sql +SELECT +region, +allow_association_to_sharable_service_network, +protocol_type, +resource_configuration_type, +port_ranges, +resource_configuration_definition, +id, +resource_gateway_id, +arn, +resource_configuration_auth_type, +resource_configuration_group_id, +tags, +name +FROM aws.vpclattice.resource_configurations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.resource_configurations ( + , + region +) +SELECT +'{{ }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.resource_configurations ( + AllowAssociationToSharableServiceNetwork, + ProtocolType, + ResourceConfigurationType, + PortRanges, + ResourceConfigurationDefinition, + ResourceGatewayId, + ResourceConfigurationAuthType, + ResourceConfigurationGroupId, + Tags, + Name, + region +) +SELECT + '{{ AllowAssociationToSharableServiceNetwork }}', + '{{ ProtocolType }}', + '{{ ResourceConfigurationType }}', + '{{ PortRanges }}', + '{{ ResourceConfigurationDefinition }}', + '{{ ResourceGatewayId }}', + '{{ ResourceConfigurationAuthType }}', + '{{ ResourceConfigurationGroupId }}', + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_configuration + props: + - name: AllowAssociationToSharableServiceNetwork + value: '{{ AllowAssociationToSharableServiceNetwork }}' + - name: ProtocolType + value: '{{ ProtocolType }}' + - name: ResourceConfigurationType + value: '{{ ResourceConfigurationType }}' + - name: PortRanges + value: + - '{{ PortRanges[0] }}' + - name: ResourceConfigurationDefinition + value: {} + - name: ResourceGatewayId + value: '{{ ResourceGatewayId }}' + - name: ResourceConfigurationAuthType + value: '{{ ResourceConfigurationAuthType }}' + - name: ResourceConfigurationGroupId + value: '{{ ResourceConfigurationGroupId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.resource_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_configurations resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetResourceConfiguration, +vpc-lattice:ListTagsForResource +``` + +### Create +```json +ec2:DescribeSubnets, +vpc-lattice:CreateResourceConfiguration, +vpc-lattice:GetResourceConfiguration, +vpc-lattice:TagResource, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +ec2:DescribeSubnets, +vpc-lattice:TagResource, +vpc-lattice:UntagResource, +vpc-lattice:ListTagsForResource, +vpc-lattice:UpdateResourceConfiguration, +vpc-lattice:GetResourceConfiguration +``` + +### List +```json +vpc-lattice:ListResourceConfigurations +``` + +### Delete +```json +vpc-lattice:DeleteResourceConfiguration, +vpc-lattice:GetResourceConfiguration, +vpc-lattice:UntagResource +``` diff --git a/website/docs/services/vpclattice/resource_configurations_list_only/index.md b/website/docs/services/vpclattice/resource_configurations_list_only/index.md new file mode 100644 index 0000000..026005b --- /dev/null +++ b/website/docs/services/vpclattice/resource_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_configurations_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_configurations in a region or regions, for all properties use resource_configurations + +## Overview + + + + + + + +
Nameresource_configurations_list_only
TypeResource
DescriptionVpcLattice ResourceConfiguration CFN resource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.resource_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_configurations_list_only resource, see resource_configurations + diff --git a/website/docs/services/vpclattice/resource_gateway_tags/index.md b/website/docs/services/vpclattice/resource_gateway_tags/index.md new file mode 100644 index 0000000..8cc2c9e --- /dev/null +++ b/website/docs/services/vpclattice/resource_gateway_tags/index.md @@ -0,0 +1,89 @@ +--- +title: resource_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resource_gateway_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resource_gateways in a region + +## Overview + + + + + + + +
Nameresource_gateway_tags
TypeResource
DescriptionCreates a resource gateway for a service.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
arrayThe ID of one or more subnets in which to create an endpoint network interface.
arrayThe ID of one or more security groups to associate with the endpoint network interface.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resource_gateways in a region. +```sql +SELECT +region, +ip_address_type, +vpc_identifier, +id, +arn, +subnet_ids, +security_group_ids, +name, +tag_key, +tag_value +FROM aws.vpclattice.resource_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_gateway_tags resource, see resource_gateways + diff --git a/website/docs/services/vpclattice/resource_gateways/index.md b/website/docs/services/vpclattice/resource_gateways/index.md new file mode 100644 index 0000000..dd48f3d --- /dev/null +++ b/website/docs/services/vpclattice/resource_gateways/index.md @@ -0,0 +1,264 @@ +--- +title: resource_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - resource_gateways + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_gateway resource or lists resource_gateways in a region + +## Overview + + + + + + + +
Nameresource_gateways
TypeResource
DescriptionCreates a resource gateway for a service.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
arrayThe ID of one or more subnets in which to create an endpoint network interface.
arrayThe ID of one or more security groups to associate with the endpoint network interface.
array
string
stringAWS region.
+ +For more information, see AWS::VpcLattice::ResourceGateway. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_gateways in a region. +```sql +SELECT +region, +ip_address_type, +vpc_identifier, +id, +arn, +subnet_ids, +security_group_ids, +tags, +name +FROM aws.vpclattice.resource_gateways +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_gateway. +```sql +SELECT +region, +ip_address_type, +vpc_identifier, +id, +arn, +subnet_ids, +security_group_ids, +tags, +name +FROM aws.vpclattice.resource_gateways +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.resource_gateways ( + IpAddressType, + VpcIdentifier, + SubnetIds, + SecurityGroupIds, + Tags, + Name, + region +) +SELECT +'{{ IpAddressType }}', + '{{ VpcIdentifier }}', + '{{ SubnetIds }}', + '{{ SecurityGroupIds }}', + '{{ Tags }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.resource_gateways ( + IpAddressType, + VpcIdentifier, + SubnetIds, + SecurityGroupIds, + Tags, + Name, + region +) +SELECT + '{{ IpAddressType }}', + '{{ VpcIdentifier }}', + '{{ SubnetIds }}', + '{{ SecurityGroupIds }}', + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_gateway + props: + - name: IpAddressType + value: '{{ IpAddressType }}' + - name: VpcIdentifier + value: '{{ VpcIdentifier }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.resource_gateways +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_gateways resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetResourceGateway, +vpc-lattice:ListTagsForResource +``` + +### Create +```json +vpc-lattice:CreateResourceGateway, +vpc-lattice:GetResourceGateway, +vpc-lattice:TagResource, +vpc-lattice:ListTagsForResource, +ec2:DescribeVpcs, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups +``` + +### Update +```json +vpc-lattice:UpdateResourceGateway, +vpc-lattice:GetResourceGateway, +vpc-lattice:TagResource, +vpc-lattice:UntagResource, +vpc-lattice:ListTagsForResource, +ec2:DescribeVpcs, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups +``` + +### List +```json +vpc-lattice:ListResourceGateways +``` + +### Delete +```json +vpc-lattice:DeleteResourceGateway, +vpc-lattice:GetResourceGateway +``` diff --git a/website/docs/services/vpclattice/resource_gateways_list_only/index.md b/website/docs/services/vpclattice/resource_gateways_list_only/index.md new file mode 100644 index 0000000..8918ac0 --- /dev/null +++ b/website/docs/services/vpclattice/resource_gateways_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_gateways_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_gateways in a region or regions, for all properties use resource_gateways + +## Overview + + + + + + + +
Nameresource_gateways_list_only
TypeResource
DescriptionCreates a resource gateway for a service.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_gateways in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.resource_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_gateways_list_only resource, see resource_gateways + diff --git a/website/docs/services/vpclattice/resource_policies/index.md b/website/docs/services/vpclattice/resource_policies/index.md new file mode 100644 index 0000000..ba763e5 --- /dev/null +++ b/website/docs/services/vpclattice/resource_policies/index.md @@ -0,0 +1,188 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_policy resource or lists 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.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
object
stringAWS region.
+ +For more information, see AWS::VpcLattice::ResourcePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual resource_policy. +```sql +SELECT +region, +resource_arn, +policy +FROM aws.vpclattice.resource_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.resource_policies ( + ResourceArn, + Policy, + region +) +SELECT +'{{ ResourceArn }}', + '{{ Policy }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.resource_policies ( + ResourceArn, + Policy, + region +) +SELECT + '{{ ResourceArn }}', + '{{ Policy }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_policy + props: + - name: ResourceArn + value: '{{ ResourceArn }}' + - name: Policy + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.resource_policies +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +vpc-lattice:GetResourcePolicy +``` + +### Update +```json +vpc-lattice:GetResourcePolicy, +vpc-lattice:PutResourcePolicy +``` + +### Delete +```json +vpc-lattice:GetResourcePolicy, +vpc-lattice:DeleteResourcePolicy +``` diff --git a/website/docs/services/vpclattice/rule_tags/index.md b/website/docs/services/vpclattice/rule_tags/index.md new file mode 100644 index 0000000..56eb9a6 --- /dev/null +++ b/website/docs/services/vpclattice/rule_tags/index.md @@ -0,0 +1,91 @@ +--- +title: rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rule_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rules in a region + +## Overview + + + + + + + +
Namerule_tags
TypeResource
DescriptionCreates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
object
string
integer
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rules in a region. +```sql +SELECT +region, +action, +arn, +id, +listener_identifier, +match, +name, +priority, +service_identifier, +tag_key, +tag_value +FROM aws.vpclattice.rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_tags resource, see rules + diff --git a/website/docs/services/vpclattice/rules/index.md b/website/docs/services/vpclattice/rules/index.md new file mode 100644 index 0000000..9a3c53a --- /dev/null +++ b/website/docs/services/vpclattice/rules/index.md @@ -0,0 +1,277 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a rule resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
object
string
integer
string
array
stringAWS region.
+ +For more information, see AWS::VpcLattice::Rule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rules in a region. +```sql +SELECT +region, +action, +arn, +id, +listener_identifier, +match, +name, +priority, +service_identifier, +tags +FROM aws.vpclattice.rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual rule. +```sql +SELECT +region, +action, +arn, +id, +listener_identifier, +match, +name, +priority, +service_identifier, +tags +FROM aws.vpclattice.rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.rules ( + Action, + Match, + Priority, + region +) +SELECT +'{{ Action }}', + '{{ Match }}', + '{{ Priority }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.rules ( + Action, + ListenerIdentifier, + Match, + Name, + Priority, + ServiceIdentifier, + Tags, + region +) +SELECT + '{{ Action }}', + '{{ ListenerIdentifier }}', + '{{ Match }}', + '{{ Name }}', + '{{ Priority }}', + '{{ ServiceIdentifier }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: rule + props: + - name: Action + value: + Forward: + TargetGroups: + - TargetGroupIdentifier: '{{ TargetGroupIdentifier }}' + Weight: '{{ Weight }}' + FixedResponse: + StatusCode: '{{ StatusCode }}' + - name: ListenerIdentifier + value: '{{ ListenerIdentifier }}' + - name: Match + value: + HttpMatch: + Method: '{{ Method }}' + PathMatch: + Match: + Exact: '{{ Exact }}' + Prefix: '{{ Prefix }}' + CaseSensitive: '{{ CaseSensitive }}' + HeaderMatches: + - Name: '{{ Name }}' + Match: + Exact: '{{ Exact }}' + Prefix: '{{ Prefix }}' + Contains: '{{ Contains }}' + CaseSensitive: '{{ CaseSensitive }}' + - name: Name + value: '{{ Name }}' + - name: Priority + value: '{{ Priority }}' + - name: ServiceIdentifier + value: '{{ ServiceIdentifier }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.rules +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +vpc-lattice:GetRule, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +vpc-lattice:UpdateRule, +vpc-lattice:GetRule, +vpc-lattice:TagResource, +vpc-lattice:UntagResource, +vpc-lattice:ListTagsForResource +``` + +### Delete +```json +vpc-lattice:DeleteRule, +vpc-lattice:UntagResource +``` + +### List +```json +vpc-lattice:ListRules +``` diff --git a/website/docs/services/vpclattice/rules_list_only/index.md b/website/docs/services/vpclattice/rules_list_only/index.md new file mode 100644 index 0000000..645be49 --- /dev/null +++ b/website/docs/services/vpclattice/rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rules_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rules in a region or regions, for all properties use rules + +## Overview + + + + + + + +
Namerules_list_only
TypeResource
DescriptionCreates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rules in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rules_list_only resource, see rules + diff --git a/website/docs/services/vpclattice/service_network_resource_association_tags/index.md b/website/docs/services/vpclattice/service_network_resource_association_tags/index.md new file mode 100644 index 0000000..424bb21 --- /dev/null +++ b/website/docs/services/vpclattice/service_network_resource_association_tags/index.md @@ -0,0 +1,83 @@ +--- +title: service_network_resource_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_resource_association_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_network_resource_associations in a region + +## Overview + + + + + + + +
Nameservice_network_resource_association_tags
TypeResource
DescriptionVpcLattice ServiceNetworkResourceAssociation CFN resource
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_network_resource_associations in a region. +```sql +SELECT +region, +id, +arn, +resource_configuration_id, +service_network_id, +tag_key, +tag_value +FROM aws.vpclattice.service_network_resource_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_resource_association_tags resource, see service_network_resource_associations + diff --git a/website/docs/services/vpclattice/service_network_resource_associations/index.md b/website/docs/services/vpclattice/service_network_resource_associations/index.md new file mode 100644 index 0000000..7719b31 --- /dev/null +++ b/website/docs/services/vpclattice/service_network_resource_associations/index.md @@ -0,0 +1,229 @@ +--- +title: service_network_resource_associations +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_resource_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_network_resource_association resource or lists service_network_resource_associations in a region + +## Overview + + + + + + + +
Nameservice_network_resource_associations
TypeResource
DescriptionVpcLattice ServiceNetworkResourceAssociation CFN resource
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::VpcLattice::ServiceNetworkResourceAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all service_network_resource_associations in a region. +```sql +SELECT +region, +id, +arn, +resource_configuration_id, +service_network_id, +tags +FROM aws.vpclattice.service_network_resource_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service_network_resource_association. +```sql +SELECT +region, +id, +arn, +resource_configuration_id, +service_network_id, +tags +FROM aws.vpclattice.service_network_resource_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_network_resource_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.service_network_resource_associations ( + ResourceConfigurationId, + ServiceNetworkId, + Tags, + region +) +SELECT +'{{ ResourceConfigurationId }}', + '{{ ServiceNetworkId }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.service_network_resource_associations ( + ResourceConfigurationId, + ServiceNetworkId, + Tags, + region +) +SELECT + '{{ ResourceConfigurationId }}', + '{{ ServiceNetworkId }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_network_resource_association + props: + - name: ResourceConfigurationId + value: '{{ ResourceConfigurationId }}' + - name: ServiceNetworkId + value: '{{ ServiceNetworkId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.service_network_resource_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the service_network_resource_associations resource, the following permissions are required: + +### Create +```json +vpc-lattice:CreateServiceNetworkResourceAssociation, +vpc-lattice:GetServiceNetworkResourceAssociation, +vpc-lattice:TagResource, +vpc-lattice:ListTagsForResource +``` + +### Read +```json +vpc-lattice:GetServiceNetworkResourceAssociation, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +vpc-lattice:TagResource, +vpc-lattice:UntagResource, +vpc-lattice:GetServiceNetworkResourceAssociation, +vpc-lattice:ListTagsForResource +``` + +### Delete +```json +vpc-lattice:DeleteServiceNetworkResourceAssociation, +vpc-lattice:GetServiceNetworkResourceAssociation, +vpc-lattice:UntagResource +``` + +### List +```json +vpc-lattice:ListServiceNetworkResourceAssociations +``` diff --git a/website/docs/services/vpclattice/service_network_resource_associations_list_only/index.md b/website/docs/services/vpclattice/service_network_resource_associations_list_only/index.md new file mode 100644 index 0000000..0b3699d --- /dev/null +++ b/website/docs/services/vpclattice/service_network_resource_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: service_network_resource_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_resource_associations_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_network_resource_associations in a region or regions, for all properties use service_network_resource_associations + +## Overview + + + + + + + +
Nameservice_network_resource_associations_list_only
TypeResource
DescriptionVpcLattice ServiceNetworkResourceAssociation CFN resource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_network_resource_associations in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.service_network_resource_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_resource_associations_list_only resource, see service_network_resource_associations + diff --git a/website/docs/services/vpclattice/service_network_service_association_tags/index.md b/website/docs/services/vpclattice/service_network_service_association_tags/index.md new file mode 100644 index 0000000..3ef74cd --- /dev/null +++ b/website/docs/services/vpclattice/service_network_service_association_tags/index.md @@ -0,0 +1,101 @@ +--- +title: service_network_service_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_service_association_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_network_service_associations in a region + +## Overview + + + + + + + +
Nameservice_network_service_association_tags
TypeResource
DescriptionAssociates a service with a service network.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_network_service_associations in a region. +```sql +SELECT +region, +arn, +created_at, +dns_entry, +id, +service_network_arn, +service_network_id, +service_network_identifier, +service_network_name, +service_arn, +service_id, +service_identifier, +service_name, +status, +tag_key, +tag_value +FROM aws.vpclattice.service_network_service_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_service_association_tags resource, see service_network_service_associations + diff --git a/website/docs/services/vpclattice/service_network_service_associations/index.md b/website/docs/services/vpclattice/service_network_service_associations/index.md new file mode 100644 index 0000000..207d678 --- /dev/null +++ b/website/docs/services/vpclattice/service_network_service_associations/index.md @@ -0,0 +1,264 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_network_service_association resource or lists service_network_service_associations in a region + +## Overview + + + + + + + +
Nameservice_network_service_associations
TypeResource
DescriptionAssociates a service with a service network.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
string
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::VpcLattice::ServiceNetworkServiceAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all service_network_service_associations in a region. +```sql +SELECT +region, +arn, +created_at, +dns_entry, +id, +service_network_arn, +service_network_id, +service_network_identifier, +service_network_name, +service_arn, +service_id, +service_identifier, +service_name, +status, +tags +FROM aws.vpclattice.service_network_service_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service_network_service_association. +```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_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_network_service_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.service_network_service_associations ( + DnsEntry, + ServiceNetworkIdentifier, + ServiceIdentifier, + Tags, + region +) +SELECT +'{{ DnsEntry }}', + '{{ ServiceNetworkIdentifier }}', + '{{ ServiceIdentifier }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.service_network_service_associations ( + DnsEntry, + ServiceNetworkIdentifier, + ServiceIdentifier, + Tags, + region +) +SELECT + '{{ DnsEntry }}', + '{{ ServiceNetworkIdentifier }}', + '{{ ServiceIdentifier }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_network_service_association + props: + - name: DnsEntry + value: + DomainName: '{{ DomainName }}' + HostedZoneId: '{{ HostedZoneId }}' + - name: ServiceNetworkIdentifier + value: '{{ ServiceNetworkIdentifier }}' + - name: ServiceIdentifier + value: '{{ ServiceIdentifier }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.service_network_service_associations +WHERE data__Identifier = '' +AND 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 +``` + +### 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, +vpc-lattice:UntagResource +``` + +### List +```json +vpc-lattice:ListServiceNetworkServiceAssociations +``` diff --git a/website/docs/services/vpclattice/service_network_service_associations_list_only/index.md b/website/docs/services/vpclattice/service_network_service_associations_list_only/index.md new file mode 100644 index 0000000..09aae07 --- /dev/null +++ b/website/docs/services/vpclattice/service_network_service_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: service_network_service_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_service_associations_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_network_service_associations in a region or regions, for all properties use service_network_service_associations + +## Overview + + + + + + + +
Nameservice_network_service_associations_list_only
TypeResource
DescriptionAssociates a service with a service network.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_network_service_associations in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.service_network_service_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_service_associations_list_only resource, see service_network_service_associations + diff --git a/website/docs/services/vpclattice/service_network_tags/index.md b/website/docs/services/vpclattice/service_network_tags/index.md new file mode 100644 index 0000000..277a834 --- /dev/null +++ b/website/docs/services/vpclattice/service_network_tags/index.md @@ -0,0 +1,89 @@ +--- +title: service_network_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_networks in a region + +## Overview + + + + + + + +
Nameservice_network_tags
TypeResource
DescriptionA service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_networks in a region. +```sql +SELECT +region, +arn, +created_at, +id, +last_updated_at, +name, +auth_type, +sharing_config, +tag_key, +tag_value +FROM aws.vpclattice.service_network_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_tags resource, see service_networks + diff --git a/website/docs/services/vpclattice/service_network_vpc_association_tags/index.md b/website/docs/services/vpclattice/service_network_vpc_association_tags/index.md new file mode 100644 index 0000000..0c2953d --- /dev/null +++ b/website/docs/services/vpclattice/service_network_vpc_association_tags/index.md @@ -0,0 +1,97 @@ +--- +title: service_network_vpc_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_vpc_association_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_network_vpc_associations in a region + +## Overview + + + + + + + +
Nameservice_network_vpc_association_tags
TypeResource
DescriptionAssociates a VPC with a service network.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_network_vpc_associations in a region. +```sql +SELECT +region, +arn, +created_at, +security_group_ids, +id, +service_network_arn, +service_network_id, +service_network_identifier, +service_network_name, +status, +vpc_id, +vpc_identifier, +tag_key, +tag_value +FROM aws.vpclattice.service_network_vpc_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_vpc_association_tags resource, see service_network_vpc_associations + diff --git a/website/docs/services/vpclattice/service_network_vpc_associations/index.md b/website/docs/services/vpclattice/service_network_vpc_associations/index.md new file mode 100644 index 0000000..b02a3ea --- /dev/null +++ b/website/docs/services/vpclattice/service_network_vpc_associations/index.md @@ -0,0 +1,262 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_network_vpc_association resource or lists service_network_vpc_associations in a region + +## Overview + + + + + + + +
Nameservice_network_vpc_associations
TypeResource
DescriptionAssociates a VPC with a service network.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
string
string
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::VpcLattice::ServiceNetworkVpcAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all service_network_vpc_associations in a region. +```sql +SELECT +region, +arn, +created_at, +security_group_ids, +id, +service_network_arn, +service_network_id, +service_network_identifier, +service_network_name, +status, +vpc_id, +vpc_identifier, +tags +FROM aws.vpclattice.service_network_vpc_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service_network_vpc_association. +```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_associations +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_network_vpc_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.service_network_vpc_associations ( + SecurityGroupIds, + ServiceNetworkIdentifier, + VpcIdentifier, + Tags, + region +) +SELECT +'{{ SecurityGroupIds }}', + '{{ ServiceNetworkIdentifier }}', + '{{ VpcIdentifier }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.service_network_vpc_associations ( + SecurityGroupIds, + ServiceNetworkIdentifier, + VpcIdentifier, + Tags, + region +) +SELECT + '{{ SecurityGroupIds }}', + '{{ ServiceNetworkIdentifier }}', + '{{ VpcIdentifier }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_network_vpc_association + props: + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: ServiceNetworkIdentifier + value: '{{ ServiceNetworkIdentifier }}' + - name: VpcIdentifier + value: '{{ VpcIdentifier }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.service_network_vpc_associations +WHERE data__Identifier = '' +AND 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 +``` + +### 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, +vpc-lattice:UntagResource +``` + +### List +```json +vpc-lattice:ListServiceNetworkVpcAssociations +``` diff --git a/website/docs/services/vpclattice/service_network_vpc_associations_list_only/index.md b/website/docs/services/vpclattice/service_network_vpc_associations_list_only/index.md new file mode 100644 index 0000000..ab59e86 --- /dev/null +++ b/website/docs/services/vpclattice/service_network_vpc_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: service_network_vpc_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_vpc_associations_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_network_vpc_associations in a region or regions, for all properties use service_network_vpc_associations + +## Overview + + + + + + + +
Nameservice_network_vpc_associations_list_only
TypeResource
DescriptionAssociates a VPC with a service network.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_network_vpc_associations in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.service_network_vpc_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_vpc_associations_list_only resource, see service_network_vpc_associations + diff --git a/website/docs/services/vpclattice/service_networks/index.md b/website/docs/services/vpclattice/service_networks/index.md new file mode 100644 index 0000000..4c36ed3 --- /dev/null +++ b/website/docs/services/vpclattice/service_networks/index.md @@ -0,0 +1,246 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service_network resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
object
stringAWS region.
+ +For more information, see AWS::VpcLattice::ServiceNetwork. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all service_networks in a region. +```sql +SELECT +region, +arn, +created_at, +id, +last_updated_at, +name, +auth_type, +tags, +sharing_config +FROM aws.vpclattice.service_networks +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service_network. +```sql +SELECT +region, +arn, +created_at, +id, +last_updated_at, +name, +auth_type, +tags, +sharing_config +FROM aws.vpclattice.service_networks +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_network resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.service_networks ( + Name, + AuthType, + Tags, + SharingConfig, + region +) +SELECT +'{{ Name }}', + '{{ AuthType }}', + '{{ Tags }}', + '{{ SharingConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.service_networks ( + Name, + AuthType, + Tags, + SharingConfig, + region +) +SELECT + '{{ Name }}', + '{{ AuthType }}', + '{{ Tags }}', + '{{ SharingConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service_network + props: + - name: Name + value: '{{ Name }}' + - name: AuthType + value: '{{ AuthType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: SharingConfig + value: + enabled: '{{ enabled }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.service_networks +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +vpc-lattice:GetServiceNetwork, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +vpc-lattice:GetServiceNetwork, +vpc-lattice:UpdateServiceNetwork, +vpc-lattice:TagResource, +vpc-lattice:UntagResource, +vpc-lattice:ListTagsForResource +``` + +### Delete +```json +vpc-lattice:DeleteServiceNetwork, +vpc-lattice:UntagResource +``` + +### List +```json +vpc-lattice:ListServiceNetworks +``` diff --git a/website/docs/services/vpclattice/service_networks_list_only/index.md b/website/docs/services/vpclattice/service_networks_list_only/index.md new file mode 100644 index 0000000..dd133db --- /dev/null +++ b/website/docs/services/vpclattice/service_networks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: service_networks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_networks_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_networks in a region or regions, for all properties use service_networks + +## Overview + + + + + + + +
Nameservice_networks_list_only
TypeResource
DescriptionA service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_networks in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.service_networks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_networks_list_only resource, see service_networks + diff --git a/website/docs/services/vpclattice/service_tags/index.md b/website/docs/services/vpclattice/service_tags/index.md new file mode 100644 index 0000000..0718f39 --- /dev/null +++ b/website/docs/services/vpclattice/service_tags/index.md @@ -0,0 +1,95 @@ +--- +title: service_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for services in a region + +## Overview + + + + + + + +
Nameservice_tags
TypeResource
DescriptionA service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all services in a region. +```sql +SELECT +region, +arn, +auth_type, +created_at, +dns_entry, +id, +last_updated_at, +name, +status, +certificate_arn, +custom_domain_name, +tag_key, +tag_value +FROM aws.vpclattice.service_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_tags resource, see services + diff --git a/website/docs/services/vpclattice/services/index.md b/website/docs/services/vpclattice/services/index.md new file mode 100644 index 0000000..e10f826 --- /dev/null +++ b/website/docs/services/vpclattice/services/index.md @@ -0,0 +1,271 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a service resource or lists 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).
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
string
string
string
string
string
array
stringAWS region.
+ +For more information, see AWS::VpcLattice::Service. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all services in a region. +```sql +SELECT +region, +arn, +auth_type, +created_at, +dns_entry, +id, +last_updated_at, +name, +status, +certificate_arn, +custom_domain_name, +tags +FROM aws.vpclattice.services +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual service. +```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.services +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.services ( + AuthType, + DnsEntry, + Name, + CertificateArn, + CustomDomainName, + Tags, + region +) +SELECT +'{{ AuthType }}', + '{{ DnsEntry }}', + '{{ Name }}', + '{{ CertificateArn }}', + '{{ CustomDomainName }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.services ( + AuthType, + DnsEntry, + Name, + CertificateArn, + CustomDomainName, + Tags, + region +) +SELECT + '{{ AuthType }}', + '{{ DnsEntry }}', + '{{ Name }}', + '{{ CertificateArn }}', + '{{ CustomDomainName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: service + props: + - name: AuthType + value: '{{ AuthType }}' + - name: DnsEntry + value: + DomainName: '{{ DomainName }}' + HostedZoneId: '{{ HostedZoneId }}' + - name: Name + value: '{{ Name }}' + - name: CertificateArn + value: '{{ CertificateArn }}' + - name: CustomDomainName + value: '{{ CustomDomainName }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.services +WHERE data__Identifier = '' +AND 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 +``` + +### 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, +vpc-lattice:UntagResource +``` + +### List +```json +vpc-lattice:ListServices +``` diff --git a/website/docs/services/vpclattice/services_list_only/index.md b/website/docs/services/vpclattice/services_list_only/index.md new file mode 100644 index 0000000..ac48188 --- /dev/null +++ b/website/docs/services/vpclattice/services_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: services_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - services_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists services in a region or regions, for all properties use services + +## Overview + + + + + + + +
Nameservices_list_only
TypeResource
DescriptionA service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all services in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.services_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the services_list_only resource, see services + diff --git a/website/docs/services/vpclattice/target_group_tags/index.md b/website/docs/services/vpclattice/target_group_tags/index.md new file mode 100644 index 0000000..54beb0c --- /dev/null +++ b/website/docs/services/vpclattice/target_group_tags/index.md @@ -0,0 +1,93 @@ +--- +title: target_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - target_group_tags + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for target_groups in a region + +## Overview + + + + + + + +
Nametarget_group_tags
TypeResource
DescriptionA target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
string
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all target_groups in a region. +```sql +SELECT +region, +arn, +config, +created_at, +id, +last_updated_at, +name, +status, +type, +targets, +tag_key, +tag_value +FROM aws.vpclattice.target_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the target_group_tags resource, see target_groups + diff --git a/website/docs/services/vpclattice/target_groups/index.md b/website/docs/services/vpclattice/target_groups/index.md new file mode 100644 index 0000000..a13384c --- /dev/null +++ b/website/docs/services/vpclattice/target_groups/index.md @@ -0,0 +1,294 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a target_group resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
string
string
string
string
array
array
stringAWS region.
+ +For more information, see AWS::VpcLattice::TargetGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all target_groups in a region. +```sql +SELECT +region, +arn, +config, +created_at, +id, +last_updated_at, +name, +status, +type, +targets, +tags +FROM aws.vpclattice.target_groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual target_group. +```sql +SELECT +region, +arn, +config, +created_at, +id, +last_updated_at, +name, +status, +type, +targets, +tags +FROM aws.vpclattice.target_groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new target_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.target_groups ( + Type, + region +) +SELECT +'{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.vpclattice.target_groups ( + Config, + Name, + Type, + Targets, + Tags, + region +) +SELECT + '{{ Config }}', + '{{ Name }}', + '{{ Type }}', + '{{ Targets }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: target_group + props: + - name: Config + value: + Port: '{{ Port }}' + Protocol: '{{ Protocol }}' + ProtocolVersion: '{{ ProtocolVersion }}' + IpAddressType: '{{ IpAddressType }}' + LambdaEventStructureVersion: '{{ LambdaEventStructureVersion }}' + VpcIdentifier: '{{ VpcIdentifier }}' + HealthCheck: + Enabled: '{{ Enabled }}' + Protocol: '{{ Protocol }}' + ProtocolVersion: '{{ ProtocolVersion }}' + Port: '{{ Port }}' + Path: '{{ Path }}' + HealthCheckIntervalSeconds: '{{ HealthCheckIntervalSeconds }}' + HealthCheckTimeoutSeconds: '{{ HealthCheckTimeoutSeconds }}' + HealthyThresholdCount: '{{ HealthyThresholdCount }}' + UnhealthyThresholdCount: '{{ UnhealthyThresholdCount }}' + Matcher: + HttpCode: '{{ HttpCode }}' + - name: Name + value: '{{ Name }}' + - name: Type + value: '{{ Type }}' + - name: Targets + value: + - Id: '{{ Id }}' + Port: '{{ Port }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.vpclattice.target_groups +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +vpc-lattice:ListTargetGroups +``` diff --git a/website/docs/services/vpclattice/target_groups_list_only/index.md b/website/docs/services/vpclattice/target_groups_list_only/index.md new file mode 100644 index 0000000..2e96764 --- /dev/null +++ b/website/docs/services/vpclattice/target_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: target_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - target_groups_list_only + - vpclattice + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists target_groups in a region or regions, for all properties use target_groups + +## Overview + + + + + + + +
Nametarget_groups_list_only
TypeResource
DescriptionA target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all target_groups in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.target_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the target_groups_list_only resource, see target_groups + diff --git a/website/docs/services/wafv2/index.md b/website/docs/services/wafv2/index.md new file mode 100644 index 0000000..979b22b --- /dev/null +++ b/website/docs/services/wafv2/index.md @@ -0,0 +1,50 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The wafv2 service documentation. + +:::info Service Summary + +
+
+total resources: 15
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/wafv2/ip_set_tags/index.md b/website/docs/services/wafv2/ip_set_tags/index.md new file mode 100644 index 0000000..cec062d --- /dev/null +++ b/website/docs/services/wafv2/ip_set_tags/index.md @@ -0,0 +1,89 @@ +--- +title: ip_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ip_set_tags + - wafv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ip_sets in a region + +## Overview + + + + + + + +
Nameip_set_tags
TypeResource
DescriptionContains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
stringType of addresses in the IPSet, use IPV4 for IPV4 IP addresses, IPV6 for IPV6 address.
arrayList of IPAddresses.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ip_sets in a region. +```sql +SELECT +region, +arn, +description, +name, +id, +scope, +ip_address_version, +addresses, +tag_key, +tag_value +FROM aws.wafv2.ip_set_tags +; +``` + + +## Permissions + +For permissions required to operate on the ip_set_tags resource, see ip_sets + diff --git a/website/docs/services/wafv2/ip_sets/index.md b/website/docs/services/wafv2/ip_sets/index.md new file mode 100644 index 0000000..8084792 --- /dev/null +++ b/website/docs/services/wafv2/ip_sets/index.md @@ -0,0 +1,250 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ip_set resource or lists 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
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
stringType of addresses in the IPSet, use IPV4 for IPV4 IP addresses, IPV6 for IPV6 address.
arrayList of IPAddresses.
array
stringAWS region.
+ +For more information, see AWS::WAFv2::IPSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ip_sets in a region. +```sql +SELECT +region, +arn, +description, +name, +id, +scope, +ip_address_version, +addresses, +tags +FROM aws.wafv2.ip_sets +; +``` +Gets all properties from an individual ip_set. +```sql +SELECT +region, +arn, +description, +name, +id, +scope, +ip_address_version, +addresses, +tags +FROM aws.wafv2.ip_sets +WHERE data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ip_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.ip_sets ( + Scope, + IPAddressVersion, + Addresses, + region +) +SELECT +'{{ Scope }}', + '{{ IPAddressVersion }}', + '{{ Addresses }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.ip_sets ( + Description, + Name, + Scope, + IPAddressVersion, + Addresses, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ Scope }}', + '{{ IPAddressVersion }}', + '{{ Addresses }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ip_set + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Scope + value: '{{ Scope }}' + - name: IPAddressVersion + value: '{{ IPAddressVersion }}' + - name: Addresses + value: + - '{{ Addresses[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wafv2.ip_sets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ip_sets resource, the following permissions are required: + +### Create +```json +wafv2:CreateIPSet, +wafv2:GetIPSet, +wafv2:ListTagsForResource +``` + +### Delete +```json +wafv2:DeleteIPSet, +wafv2:GetIPSet +``` + +### Read +```json +wafv2:GetIPSet, +wafv2:ListTagsForResource +``` + +### Update +```json +wafv2:UpdateIPSet, +wafv2:GetIPSet, +wafv2:ListTagsForResource, +wafv2:TagResource, +wafv2:UntagResource +``` + +### List +```json +wafv2:listIPSets +``` diff --git a/website/docs/services/wafv2/ip_sets_list_only/index.md b/website/docs/services/wafv2/ip_sets_list_only/index.md new file mode 100644 index 0000000..bad3bbe --- /dev/null +++ b/website/docs/services/wafv2/ip_sets_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: ip_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ip_sets_list_only + - wafv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ip_sets in a region or regions, for all properties use ip_sets + +## Overview + + + + + + + +
Nameip_sets_list_only
TypeResource
DescriptionContains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ip_sets in a region. +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.ip_sets_list_only +; +``` + + +## Permissions + +For permissions required to operate on the ip_sets_list_only resource, see ip_sets + diff --git a/website/docs/services/wafv2/logging_configurations/index.md b/website/docs/services/wafv2/logging_configurations/index.md new file mode 100644 index 0000000..dcf6ea3 --- /dev/null +++ b/website/docs/services/wafv2/logging_configurations/index.md @@ -0,0 +1,290 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a logging_configuration resource or lists logging_configurations in a region + +## Overview + + + + + + + +
Namelogging_configurations
TypeResource
DescriptionA WAFv2 Logging Configuration Resource Provider
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
arrayThe Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.
arrayThe parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.
booleanIndicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
objectFiltering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
stringAWS region.
+ +For more information, see AWS::WAFv2::LoggingConfiguration. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all logging_configurations in a region. +```sql +SELECT +region, +resource_arn, +log_destination_configs, +redacted_fields, +managed_by_firewall_manager, +logging_filter +FROM aws.wafv2.logging_configurations +; +``` +Gets all properties from an individual logging_configuration. +```sql +SELECT +region, +resource_arn, +log_destination_configs, +redacted_fields, +managed_by_firewall_manager, +logging_filter +FROM aws.wafv2.logging_configurations +WHERE data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new logging_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.logging_configurations ( + ResourceArn, + LogDestinationConfigs, + region +) +SELECT +'{{ ResourceArn }}', + '{{ LogDestinationConfigs }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.logging_configurations ( + ResourceArn, + LogDestinationConfigs, + RedactedFields, + LoggingFilter, + region +) +SELECT + '{{ ResourceArn }}', + '{{ LogDestinationConfigs }}', + '{{ RedactedFields }}', + '{{ LoggingFilter }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: logging_configuration + props: + - name: ResourceArn + value: '{{ ResourceArn }}' + - name: LogDestinationConfigs + value: + - '{{ LogDestinationConfigs[0] }}' + - name: RedactedFields + value: + - SingleHeader: + Name: '{{ Name }}' + SingleQueryArgument: + Name: '{{ Name }}' + AllQueryArguments: {} + UriPath: {} + QueryString: {} + Body: + OversizeHandling: '{{ OversizeHandling }}' + Method: {} + JsonBody: + MatchPattern: + All: {} + IncludedPaths: + - '{{ IncludedPaths[0] }}' + MatchScope: '{{ MatchScope }}' + InvalidFallbackBehavior: '{{ InvalidFallbackBehavior }}' + OversizeHandling: null + Headers: + MatchPattern: + All: {} + IncludedHeaders: + - '{{ IncludedHeaders[0] }}' + ExcludedHeaders: + - '{{ ExcludedHeaders[0] }}' + MatchScope: '{{ MatchScope }}' + OversizeHandling: null + Cookies: + MatchPattern: + All: {} + IncludedCookies: + - '{{ IncludedCookies[0] }}' + ExcludedCookies: + - '{{ ExcludedCookies[0] }}' + MatchScope: null + OversizeHandling: null + JA3Fingerprint: + FallbackBehavior: '{{ FallbackBehavior }}' + - name: LoggingFilter + value: + DefaultBehavior: '{{ DefaultBehavior }}' + Filters: + - Behavior: '{{ Behavior }}' + Conditions: + - ActionCondition: + Action: '{{ Action }}' + LabelNameCondition: + LabelName: '{{ LabelName }}' + Requirement: '{{ Requirement }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wafv2.logging_configurations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### 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 +``` + +### List +```json +wafv2:ListLoggingConfigurations +``` diff --git a/website/docs/services/wafv2/logging_configurations_list_only/index.md b/website/docs/services/wafv2/logging_configurations_list_only/index.md new file mode 100644 index 0000000..2825b47 --- /dev/null +++ b/website/docs/services/wafv2/logging_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: logging_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configurations_list_only + - wafv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists logging_configurations in a region or regions, for all properties use logging_configurations + +## Overview + + + + + + + +
Namelogging_configurations_list_only
TypeResource
DescriptionA WAFv2 Logging Configuration Resource Provider
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all logging_configurations in a region. +```sql +SELECT +region, +resource_arn +FROM aws.wafv2.logging_configurations_list_only +; +``` + + +## Permissions + +For permissions required to operate on the logging_configurations_list_only resource, see logging_configurations + diff --git a/website/docs/services/wafv2/regex_pattern_set_tags/index.md b/website/docs/services/wafv2/regex_pattern_set_tags/index.md new file mode 100644 index 0000000..e579235 --- /dev/null +++ b/website/docs/services/wafv2/regex_pattern_set_tags/index.md @@ -0,0 +1,87 @@ +--- +title: regex_pattern_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - regex_pattern_set_tags + - wafv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for regex_pattern_sets in a region + +## Overview + + + + + + + +
Nameregex_pattern_set_tags
TypeResource
DescriptionContains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions .
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringARN of the WAF entity.
stringDescription of the entity.
stringName of the RegexPatternSet.
stringId of the RegexPatternSet
array
stringUse CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all regex_pattern_sets in a region. +```sql +SELECT +region, +arn, +description, +name, +id, +regular_expression_list, +scope, +tag_key, +tag_value +FROM aws.wafv2.regex_pattern_set_tags +; +``` + + +## Permissions + +For permissions required to operate on the regex_pattern_set_tags resource, see regex_pattern_sets + diff --git a/website/docs/services/wafv2/regex_pattern_sets/index.md b/website/docs/services/wafv2/regex_pattern_sets/index.md new file mode 100644 index 0000000..153143c --- /dev/null +++ b/website/docs/services/wafv2/regex_pattern_sets/index.md @@ -0,0 +1,241 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a regex_pattern_set resource or lists 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 .
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringARN of the WAF entity.
stringDescription of the entity.
stringName of the RegexPatternSet.
stringId of the RegexPatternSet
array
stringUse CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
array
stringAWS region.
+ +For more information, see AWS::WAFv2::RegexPatternSet. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all regex_pattern_sets in a region. +```sql +SELECT +region, +arn, +description, +name, +id, +regular_expression_list, +scope, +tags +FROM aws.wafv2.regex_pattern_sets +; +``` +Gets all properties from an individual regex_pattern_set. +```sql +SELECT +region, +arn, +description, +name, +id, +regular_expression_list, +scope, +tags +FROM aws.wafv2.regex_pattern_sets +WHERE data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new regex_pattern_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.regex_pattern_sets ( + RegularExpressionList, + Scope, + region +) +SELECT +'{{ RegularExpressionList }}', + '{{ Scope }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.regex_pattern_sets ( + Description, + Name, + RegularExpressionList, + Scope, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ Name }}', + '{{ RegularExpressionList }}', + '{{ Scope }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: regex_pattern_set + props: + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: RegularExpressionList + value: + - '{{ RegularExpressionList[0] }}' + - name: Scope + value: '{{ Scope }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wafv2.regex_pattern_sets +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the regex_pattern_sets resource, the following permissions are required: + +### Create +```json +wafv2:CreateRegexPatternSet, +wafv2:GetRegexPatternSet, +wafv2:ListTagsForResource +``` + +### Delete +```json +wafv2:DeleteRegexPatternSet, +wafv2:GetRegexPatternSet +``` + +### Read +```json +wafv2:GetRegexPatternSet, +wafv2:ListTagsForResource +``` + +### Update +```json +wafv2:UpdateRegexPatternSet, +wafv2:GetRegexPatternSet, +wafv2:ListTagsForResource, +wafv2:TagResource, +wafv2:UntagResource +``` + +### List +```json +wafv2:listRegexPatternSets +``` diff --git a/website/docs/services/wafv2/regex_pattern_sets_list_only/index.md b/website/docs/services/wafv2/regex_pattern_sets_list_only/index.md new file mode 100644 index 0000000..6aca4eb --- /dev/null +++ b/website/docs/services/wafv2/regex_pattern_sets_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: regex_pattern_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - regex_pattern_sets_list_only + - wafv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists regex_pattern_sets in a region or regions, for all properties use regex_pattern_sets + +## Overview + + + + + + + +
Nameregex_pattern_sets_list_only
TypeResource
DescriptionContains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions .
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringName of the RegexPatternSet.
stringId of the RegexPatternSet
stringUse CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all regex_pattern_sets in a region. +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.regex_pattern_sets_list_only +; +``` + + +## Permissions + +For permissions required to operate on the regex_pattern_sets_list_only resource, see regex_pattern_sets + diff --git a/website/docs/services/wafv2/rule_group_tags/index.md b/website/docs/services/wafv2/rule_group_tags/index.md new file mode 100644 index 0000000..ca69a50 --- /dev/null +++ b/website/docs/services/wafv2/rule_group_tags/index.md @@ -0,0 +1,99 @@ +--- +title: rule_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rule_group_tags + - wafv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rule_groups in a region + +## Overview + + + + + + + +
Namerule_group_tags
TypeResource
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
arrayCollection of Rules.
objectVisibility Metric of the WebACL.
stringName of the Label.
objectCustom response key and body map.
arrayCollection of Available Labels.
arrayCollection of Consumed Labels.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rule_groups in a region. +```sql +SELECT +region, +arn, +capacity, +description, +name, +id, +scope, +rules, +visibility_config, +label_namespace, +custom_response_bodies, +available_labels, +consumed_labels, +tag_key, +tag_value +FROM aws.wafv2.rule_group_tags +; +``` + + +## Permissions + +For permissions required to operate on the rule_group_tags resource, see rule_groups + diff --git a/website/docs/services/wafv2/rule_groups/index.md b/website/docs/services/wafv2/rule_groups/index.md new file mode 100644 index 0000000..2493923 --- /dev/null +++ b/website/docs/services/wafv2/rule_groups/index.md @@ -0,0 +1,510 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a rule_group resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
arrayCollection of Rules.
objectVisibility Metric of the WebACL.
array
stringName of the Label.
objectCustom response key and body map.
arrayCollection of Available Labels.
arrayCollection of Consumed Labels.
stringAWS region.
+ +For more information, see AWS::WAFv2::RuleGroup. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all rule_groups in a region. +```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_groups +; +``` +Gets all properties from an individual rule_group. +```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_groups +WHERE data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new rule_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.rule_groups ( + Capacity, + Scope, + VisibilityConfig, + region +) +SELECT +'{{ Capacity }}', + '{{ Scope }}', + '{{ VisibilityConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.rule_groups ( + Capacity, + Description, + Name, + Scope, + Rules, + VisibilityConfig, + Tags, + CustomResponseBodies, + AvailableLabels, + ConsumedLabels, + region +) +SELECT + '{{ Capacity }}', + '{{ Description }}', + '{{ Name }}', + '{{ Scope }}', + '{{ Rules }}', + '{{ VisibilityConfig }}', + '{{ Tags }}', + '{{ CustomResponseBodies }}', + '{{ AvailableLabels }}', + '{{ ConsumedLabels }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: rule_group + props: + - name: Capacity + value: '{{ Capacity }}' + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Scope + value: '{{ Scope }}' + - name: Rules + value: + - Name: null + Priority: '{{ Priority }}' + Statement: + ByteMatchStatement: + SearchString: '{{ SearchString }}' + SearchStringBase64: '{{ SearchStringBase64 }}' + FieldToMatch: + SingleHeader: + Name: '{{ Name }}' + SingleQueryArgument: + Name: '{{ Name }}' + AllQueryArguments: {} + UriPath: {} + QueryString: {} + Body: + OversizeHandling: '{{ OversizeHandling }}' + Method: {} + JsonBody: + MatchPattern: + All: {} + IncludedPaths: + - '{{ IncludedPaths[0] }}' + MatchScope: '{{ MatchScope }}' + InvalidFallbackBehavior: '{{ InvalidFallbackBehavior }}' + OversizeHandling: null + Headers: + MatchPattern: + All: {} + IncludedHeaders: + - '{{ IncludedHeaders[0] }}' + ExcludedHeaders: + - '{{ ExcludedHeaders[0] }}' + MatchScope: '{{ MatchScope }}' + OversizeHandling: null + Cookies: + MatchPattern: + All: {} + IncludedCookies: + - '{{ IncludedCookies[0] }}' + ExcludedCookies: + - '{{ ExcludedCookies[0] }}' + MatchScope: null + OversizeHandling: null + JA3Fingerprint: + FallbackBehavior: '{{ FallbackBehavior }}' + TextTransformations: + - Priority: '{{ Priority }}' + Type: '{{ Type }}' + PositionalConstraint: '{{ PositionalConstraint }}' + SqliMatchStatement: + FieldToMatch: null + TextTransformations: + - null + SensitivityLevel: '{{ SensitivityLevel }}' + XssMatchStatement: + FieldToMatch: null + TextTransformations: + - null + SizeConstraintStatement: + FieldToMatch: null + ComparisonOperator: '{{ ComparisonOperator }}' + Size: null + TextTransformations: + - null + GeoMatchStatement: + CountryCodes: + - '{{ CountryCodes[0] }}' + ForwardedIPConfig: + HeaderName: '{{ HeaderName }}' + FallbackBehavior: '{{ FallbackBehavior }}' + RuleGroupReferenceStatement: + Arn: '{{ Arn }}' + ExcludedRules: + - Name: null + RuleActionOverrides: + - Name: null + ActionToUse: + Allow: + CustomRequestHandling: + InsertHeaders: + - Name: '{{ Name }}' + Value: '{{ Value }}' + Block: + CustomResponse: + ResponseCode: '{{ ResponseCode }}' + CustomResponseBodyKey: '{{ CustomResponseBodyKey }}' + ResponseHeaders: + - null + Count: + CustomRequestHandling: null + Captcha: + CustomRequestHandling: null + Challenge: + CustomRequestHandling: null + IPSetReferenceStatement: + Arn: null + IPSetForwardedIPConfig: + HeaderName: '{{ HeaderName }}' + FallbackBehavior: '{{ FallbackBehavior }}' + Position: '{{ Position }}' + RegexPatternSetReferenceStatement: + Arn: null + FieldToMatch: null + TextTransformations: + - null + ManagedRuleGroupStatement: + Name: null + VendorName: '{{ VendorName }}' + Version: '{{ Version }}' + ExcludedRules: + - null + ScopeDownStatement: null + ManagedRuleGroupConfigs: + - LoginPath: '{{ LoginPath }}' + PayloadType: '{{ PayloadType }}' + UsernameField: + Identifier: '{{ Identifier }}' + PasswordField: null + AWSManagedRulesBotControlRuleSet: + InspectionLevel: '{{ InspectionLevel }}' + EnableMachineLearning: '{{ EnableMachineLearning }}' + AWSManagedRulesATPRuleSet: + LoginPath: '{{ LoginPath }}' + EnableRegexInPath: '{{ EnableRegexInPath }}' + RequestInspection: + PayloadType: '{{ PayloadType }}' + UsernameField: null + PasswordField: null + ResponseInspection: + StatusCode: + SuccessCodes: + - '{{ SuccessCodes[0] }}' + FailureCodes: + - '{{ FailureCodes[0] }}' + Header: + Name: '{{ Name }}' + SuccessValues: + - '{{ SuccessValues[0] }}' + FailureValues: + - '{{ FailureValues[0] }}' + BodyContains: + SuccessStrings: + - '{{ SuccessStrings[0] }}' + FailureStrings: + - '{{ FailureStrings[0] }}' + Json: + Identifier: '{{ Identifier }}' + SuccessValues: + - '{{ SuccessValues[0] }}' + FailureValues: + - '{{ FailureValues[0] }}' + AWSManagedRulesACFPRuleSet: + CreationPath: '{{ CreationPath }}' + RegistrationPagePath: '{{ RegistrationPagePath }}' + RequestInspection: + PayloadType: '{{ PayloadType }}' + UsernameField: null + PasswordField: null + EmailField: null + PhoneNumberFields: + - null + AddressFields: + - null + ResponseInspection: null + EnableRegexInPath: '{{ EnableRegexInPath }}' + RuleActionOverrides: + - null + RateBasedStatement: + Limit: '{{ Limit }}' + EvaluationWindowSec: '{{ EvaluationWindowSec }}' + AggregateKeyType: '{{ AggregateKeyType }}' + CustomKeys: + - Cookie: + Name: '{{ Name }}' + TextTransformations: + - null + ForwardedIP: {} + Header: + Name: '{{ Name }}' + TextTransformations: + - null + HTTPMethod: {} + IP: {} + LabelNamespace: + Namespace: '{{ Namespace }}' + QueryArgument: + Name: '{{ Name }}' + TextTransformations: + - null + QueryString: + TextTransformations: + - null + UriPath: + TextTransformations: + - null + ScopeDownStatement: null + ForwardedIPConfig: null + AndStatement: + Statements: + - null + OrStatement: + Statements: + - null + NotStatement: + Statement: null + LabelMatchStatement: + Scope: '{{ Scope }}' + Key: '{{ Key }}' + RegexMatchStatement: + RegexString: '{{ RegexString }}' + FieldToMatch: null + TextTransformations: + - null + Action: null + OverrideAction: + Count: {} + None: {} + RuleLabels: + - Name: '{{ Name }}' + VisibilityConfig: + SampledRequestsEnabled: '{{ SampledRequestsEnabled }}' + CloudWatchMetricsEnabled: '{{ CloudWatchMetricsEnabled }}' + MetricName: '{{ MetricName }}' + CaptchaConfig: + ImmunityTimeProperty: + ImmunityTime: '{{ ImmunityTime }}' + ChallengeConfig: + ImmunityTimeProperty: null + - name: VisibilityConfig + value: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CustomResponseBodies + value: {} + - name: AvailableLabels + value: + - Name: null + - name: ConsumedLabels + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wafv2.rule_groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the rule_groups resource, the following permissions are required: + +### Create +```json +wafv2:CreateRuleGroup, +wafv2:GetRuleGroup, +wafv2:ListTagsForResource +``` + +### Delete +```json +wafv2:DeleteRuleGroup, +wafv2:GetRuleGroup +``` + +### Read +```json +wafv2:GetRuleGroup, +wafv2:ListTagsForResource +``` + +### Update +```json +wafv2:TagResource, +wafv2:UntagResource, +wafv2:UpdateRuleGroup, +wafv2:GetRuleGroup, +wafv2:ListTagsForResource +``` + +### List +```json +wafv2:listRuleGroups +``` diff --git a/website/docs/services/wafv2/rule_groups_list_only/index.md b/website/docs/services/wafv2/rule_groups_list_only/index.md new file mode 100644 index 0000000..10cc529 --- /dev/null +++ b/website/docs/services/wafv2/rule_groups_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: rule_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups_list_only + - wafv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rule_groups in a region or regions, for all properties use rule_groups + +## Overview + + + + + + + +
Namerule_groups_list_only
TypeResource
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rule_groups in a region. +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.rule_groups_list_only +; +``` + + +## Permissions + +For permissions required to operate on the rule_groups_list_only resource, see rule_groups + diff --git a/website/docs/services/wafv2/web_acl_tags/index.md b/website/docs/services/wafv2/web_acl_tags/index.md new file mode 100644 index 0000000..6d3c414 --- /dev/null +++ b/website/docs/services/wafv2/web_acl_tags/index.md @@ -0,0 +1,105 @@ +--- +title: web_acl_tags +hide_title: false +hide_table_of_contents: false +keywords: + - web_acl_tags + - wafv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for web_acls in a region + +## Overview + + + + + + + +
Nameweb_acl_tags
TypeResource
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
objectDefault Action WebACL will take against ingress traffic when there is no matching Rule.
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
arrayCollection of Rules.
objectVisibility Metric of the WebACL.
stringName of the Label.
objectCustom response key and body map.
object
object
arrayList of domains to accept in web request tokens, in addition to the domain of the protected resource.
objectAssociationConfig for body inspection
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all web_acls in a region. +```sql +SELECT +region, +arn, +capacity, +default_action, +description, +name, +id, +scope, +rules, +visibility_config, +label_namespace, +custom_response_bodies, +captcha_config, +challenge_config, +token_domains, +association_config, +tag_key, +tag_value +FROM aws.wafv2.web_acl_tags +; +``` + + +## Permissions + +For permissions required to operate on the web_acl_tags resource, see web_acls + diff --git a/website/docs/services/wafv2/web_acls/index.md b/website/docs/services/wafv2/web_acls/index.md new file mode 100644 index 0000000..3fb144a --- /dev/null +++ b/website/docs/services/wafv2/web_acls/index.md @@ -0,0 +1,529 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a web_acl resource or lists 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.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
objectDefault Action WebACL will take against ingress traffic when there is no matching Rule.
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
arrayCollection of Rules.
objectVisibility Metric of the WebACL.
array
stringName of the Label.
objectCustom response key and body map.
object
object
arrayList of domains to accept in web request tokens, in addition to the domain of the protected resource.
objectAssociationConfig for body inspection
stringAWS region.
+ +For more information, see AWS::WAFv2::WebACL. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all web_acls in a region. +```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_acls +; +``` +Gets all properties from an individual web_acl. +```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_acls +WHERE data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new web_acl resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.web_acls ( + DefaultAction, + Scope, + VisibilityConfig, + region +) +SELECT +'{{ DefaultAction }}', + '{{ Scope }}', + '{{ VisibilityConfig }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.web_acls ( + DefaultAction, + Description, + Name, + Scope, + Rules, + VisibilityConfig, + Tags, + CustomResponseBodies, + CaptchaConfig, + ChallengeConfig, + TokenDomains, + AssociationConfig, + region +) +SELECT + '{{ DefaultAction }}', + '{{ Description }}', + '{{ Name }}', + '{{ Scope }}', + '{{ Rules }}', + '{{ VisibilityConfig }}', + '{{ Tags }}', + '{{ CustomResponseBodies }}', + '{{ CaptchaConfig }}', + '{{ ChallengeConfig }}', + '{{ TokenDomains }}', + '{{ AssociationConfig }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: web_acl + props: + - name: DefaultAction + value: + Allow: + CustomRequestHandling: + InsertHeaders: + - Name: '{{ Name }}' + Value: '{{ Value }}' + Block: + CustomResponse: + ResponseCode: '{{ ResponseCode }}' + CustomResponseBodyKey: '{{ CustomResponseBodyKey }}' + ResponseHeaders: + - null + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Scope + value: '{{ Scope }}' + - name: Rules + value: + - Name: null + Priority: '{{ Priority }}' + Statement: + ByteMatchStatement: + SearchString: '{{ SearchString }}' + SearchStringBase64: '{{ SearchStringBase64 }}' + FieldToMatch: + SingleHeader: + Name: '{{ Name }}' + SingleQueryArgument: + Name: '{{ Name }}' + AllQueryArguments: {} + UriPath: {} + QueryString: {} + Body: + OversizeHandling: '{{ OversizeHandling }}' + Method: {} + JsonBody: + MatchPattern: + All: {} + IncludedPaths: + - '{{ IncludedPaths[0] }}' + MatchScope: '{{ MatchScope }}' + InvalidFallbackBehavior: '{{ InvalidFallbackBehavior }}' + OversizeHandling: null + Headers: + MatchPattern: + All: {} + IncludedHeaders: + - '{{ IncludedHeaders[0] }}' + ExcludedHeaders: + - '{{ ExcludedHeaders[0] }}' + MatchScope: '{{ MatchScope }}' + OversizeHandling: null + Cookies: + MatchPattern: + All: {} + IncludedCookies: + - '{{ IncludedCookies[0] }}' + ExcludedCookies: + - '{{ ExcludedCookies[0] }}' + MatchScope: null + OversizeHandling: null + JA3Fingerprint: + FallbackBehavior: '{{ FallbackBehavior }}' + TextTransformations: + - Priority: '{{ Priority }}' + Type: '{{ Type }}' + PositionalConstraint: '{{ PositionalConstraint }}' + SqliMatchStatement: + FieldToMatch: null + TextTransformations: + - null + SensitivityLevel: '{{ SensitivityLevel }}' + XssMatchStatement: + FieldToMatch: null + TextTransformations: + - null + SizeConstraintStatement: + FieldToMatch: null + ComparisonOperator: '{{ ComparisonOperator }}' + Size: null + TextTransformations: + - null + GeoMatchStatement: + CountryCodes: + - '{{ CountryCodes[0] }}' + ForwardedIPConfig: + HeaderName: '{{ HeaderName }}' + FallbackBehavior: '{{ FallbackBehavior }}' + RuleGroupReferenceStatement: + Arn: '{{ Arn }}' + ExcludedRules: + - Name: null + RuleActionOverrides: + - Name: null + ActionToUse: + Allow: null + Block: null + Count: + CustomRequestHandling: null + Captcha: + CustomRequestHandling: null + Challenge: + CustomRequestHandling: null + IPSetReferenceStatement: + Arn: null + IPSetForwardedIPConfig: + HeaderName: '{{ HeaderName }}' + FallbackBehavior: '{{ FallbackBehavior }}' + Position: '{{ Position }}' + RegexPatternSetReferenceStatement: + Arn: null + FieldToMatch: null + TextTransformations: + - null + ManagedRuleGroupStatement: + Name: null + VendorName: '{{ VendorName }}' + Version: '{{ Version }}' + ExcludedRules: + - null + ScopeDownStatement: null + ManagedRuleGroupConfigs: + - LoginPath: '{{ LoginPath }}' + PayloadType: '{{ PayloadType }}' + UsernameField: + Identifier: '{{ Identifier }}' + PasswordField: null + AWSManagedRulesBotControlRuleSet: + InspectionLevel: '{{ InspectionLevel }}' + EnableMachineLearning: '{{ EnableMachineLearning }}' + AWSManagedRulesATPRuleSet: + LoginPath: '{{ LoginPath }}' + EnableRegexInPath: '{{ EnableRegexInPath }}' + RequestInspection: + PayloadType: '{{ PayloadType }}' + UsernameField: null + PasswordField: null + ResponseInspection: + StatusCode: + SuccessCodes: + - '{{ SuccessCodes[0] }}' + FailureCodes: + - '{{ FailureCodes[0] }}' + Header: + Name: '{{ Name }}' + SuccessValues: + - '{{ SuccessValues[0] }}' + FailureValues: + - '{{ FailureValues[0] }}' + BodyContains: + SuccessStrings: + - '{{ SuccessStrings[0] }}' + FailureStrings: + - '{{ FailureStrings[0] }}' + Json: + Identifier: '{{ Identifier }}' + SuccessValues: + - '{{ SuccessValues[0] }}' + FailureValues: + - '{{ FailureValues[0] }}' + AWSManagedRulesACFPRuleSet: + CreationPath: '{{ CreationPath }}' + RegistrationPagePath: '{{ RegistrationPagePath }}' + RequestInspection: + PayloadType: '{{ PayloadType }}' + UsernameField: null + PasswordField: null + EmailField: null + PhoneNumberFields: + - null + AddressFields: + - null + ResponseInspection: null + EnableRegexInPath: '{{ EnableRegexInPath }}' + RuleActionOverrides: + - null + RateBasedStatement: + Limit: '{{ Limit }}' + EvaluationWindowSec: '{{ EvaluationWindowSec }}' + AggregateKeyType: '{{ AggregateKeyType }}' + CustomKeys: + - Cookie: + Name: '{{ Name }}' + TextTransformations: + - null + ForwardedIP: {} + Header: + Name: '{{ Name }}' + TextTransformations: + - null + HTTPMethod: {} + IP: {} + LabelNamespace: + Namespace: '{{ Namespace }}' + QueryArgument: + Name: '{{ Name }}' + TextTransformations: + - null + QueryString: + TextTransformations: + - null + UriPath: + TextTransformations: + - null + ScopeDownStatement: null + ForwardedIPConfig: null + AndStatement: + Statements: + - null + OrStatement: + Statements: + - null + NotStatement: + Statement: null + LabelMatchStatement: + Scope: '{{ Scope }}' + Key: '{{ Key }}' + RegexMatchStatement: + RegexString: '{{ RegexString }}' + FieldToMatch: null + TextTransformations: + - null + Action: null + OverrideAction: + Count: {} + None: {} + RuleLabels: + - Name: '{{ Name }}' + VisibilityConfig: + SampledRequestsEnabled: '{{ SampledRequestsEnabled }}' + CloudWatchMetricsEnabled: '{{ CloudWatchMetricsEnabled }}' + MetricName: '{{ MetricName }}' + CaptchaConfig: + ImmunityTimeProperty: + ImmunityTime: '{{ ImmunityTime }}' + ChallengeConfig: + ImmunityTimeProperty: null + - name: VisibilityConfig + value: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: CustomResponseBodies + value: {} + - name: CaptchaConfig + value: null + - name: ChallengeConfig + value: null + - name: TokenDomains + value: + - '{{ TokenDomains[0] }}' + - name: AssociationConfig + value: + RequestBody: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wafv2.web_acls +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the web_acls resource, the following permissions are required: + +### Create +```json +wafv2:CreateWebACL, +wafv2:GetWebACL, +wafv2:ListTagsForResource +``` + +### Delete +```json +wafv2:DeleteWebACL, +wafv2:GetWebACL +``` + +### Read +```json +wafv2:GetWebACL, +wafv2:ListTagsForResource +``` + +### Update +```json +wafv2:UpdateWebACL, +wafv2:GetWebACL, +wafv2:ListTagsForResource, +wafv2:TagResource, +wafv2:UntagResource +``` + +### List +```json +wafv2:listWebACLs +``` diff --git a/website/docs/services/wafv2/web_acls_list_only/index.md b/website/docs/services/wafv2/web_acls_list_only/index.md new file mode 100644 index 0000000..2acae75 --- /dev/null +++ b/website/docs/services/wafv2/web_acls_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: web_acls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - web_acls_list_only + - wafv2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists web_acls in a region or regions, for all properties use web_acls + +## Overview + + + + + + + +
Nameweb_acls_list_only
TypeResource
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all web_acls in a region. +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.web_acls_list_only +; +``` + + +## Permissions + +For permissions required to operate on the web_acls_list_only resource, see web_acls + diff --git a/website/docs/services/wafv2/webacl_associations/index.md b/website/docs/services/wafv2/webacl_associations/index.md new file mode 100644 index 0000000..53c1903 --- /dev/null +++ b/website/docs/services/wafv2/webacl_associations/index.md @@ -0,0 +1,249 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a webacl_association resource or lists webacl_associations in a region + +## Overview + + + + + + + +
Namewebacl_associations
TypeResource
DescriptionAssociates WebACL to Application Load Balancer, CloudFront or API Gateway.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +For more information, see AWS::WAFv2::WebACLAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual webacl_association. +```sql +SELECT +region, +resource_arn, +web_acl_arn +FROM aws.wafv2.webacl_associations +WHERE data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new webacl_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.webacl_associations ( + ResourceArn, + WebACLArn, + region +) +SELECT +'{{ ResourceArn }}', + '{{ WebACLArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wafv2.webacl_associations ( + ResourceArn, + WebACLArn, + region +) +SELECT + '{{ ResourceArn }}', + '{{ WebACLArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: webacl_association + props: + - name: ResourceArn + value: '{{ ResourceArn }}' + - name: WebACLArn + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wafv2.webacl_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## 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 +``` + +### 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/website/docs/services/wisdom/ai_agent_tags/index.md b/website/docs/services/wisdom/ai_agent_tags/index.md new file mode 100644 index 0000000..f1bd50d --- /dev/null +++ b/website/docs/services/wisdom/ai_agent_tags/index.md @@ -0,0 +1,93 @@ +--- +title: ai_agent_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ai_agent_tags + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ai_agents in a region + +## Overview + + + + + + + +
Nameai_agent_tags
TypeResource
DescriptionDefinition of AWS::Wisdom::AIAgent Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
undefined
string
string
string
number
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ai_agents in a region. +```sql +SELECT +region, +a_iagent_id, +a_iagent_arn, +assistant_id, +assistant_arn, +configuration, +description, +name, +type, +modified_time_seconds, +tag_key, +tag_value +FROM aws.wisdom.ai_agent_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ai_agent_tags resource, see ai_agents + diff --git a/website/docs/services/wisdom/ai_agent_versions/index.md b/website/docs/services/wisdom/ai_agent_versions/index.md new file mode 100644 index 0000000..e25da97 --- /dev/null +++ b/website/docs/services/wisdom/ai_agent_versions/index.md @@ -0,0 +1,224 @@ +--- +title: ai_agent_versions +hide_title: false +hide_table_of_contents: false +keywords: + - ai_agent_versions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ai_agent_version resource or lists ai_agent_versions in a region + +## Overview + + + + + + + +
Nameai_agent_versions
TypeResource
DescriptionDefinition of AWS::Wisdom::AIAgentVersion Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
number
number
stringAWS region.
+ +For more information, see AWS::Wisdom::AIAgentVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ai_agent_versions in a region. +```sql +SELECT +region, +a_iagent_arn, +assistant_arn, +a_iagent_id, +assistant_id, +a_iagent_version_id, +version_number, +modified_time_seconds +FROM aws.wisdom.ai_agent_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ai_agent_version. +```sql +SELECT +region, +a_iagent_arn, +assistant_arn, +a_iagent_id, +assistant_id, +a_iagent_version_id, +version_number, +modified_time_seconds +FROM aws.wisdom.ai_agent_versions +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ai_agent_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_agent_versions ( + AIAgentId, + AssistantId, + region +) +SELECT +'{{ AIAgentId }}', + '{{ AssistantId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_agent_versions ( + AIAgentId, + AssistantId, + ModifiedTimeSeconds, + region +) +SELECT + '{{ AIAgentId }}', + '{{ AssistantId }}', + '{{ ModifiedTimeSeconds }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ai_agent_version + props: + - name: AIAgentId + value: '{{ AIAgentId }}' + - name: AssistantId + value: '{{ AssistantId }}' + - name: ModifiedTimeSeconds + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.ai_agent_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ai_agent_versions resource, the following permissions are required: + +### Create +```json +wisdom:CreateAIAgentVersion +``` + +### Read +```json +wisdom:GetAIAgent, +wisdom:GetAIAgentVersion +``` + +### Update +```json +wisdom:GetAIAgent, +wisdom:GetAIAgentVersion +``` + +### Delete +```json +wisdom:DeleteAIAgentVersion +``` + +### List +```json +wisdom:ListAIAgentVersions +``` diff --git a/website/docs/services/wisdom/ai_agent_versions_list_only/index.md b/website/docs/services/wisdom/ai_agent_versions_list_only/index.md new file mode 100644 index 0000000..7b94ea0 --- /dev/null +++ b/website/docs/services/wisdom/ai_agent_versions_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: ai_agent_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ai_agent_versions_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ai_agent_versions in a region or regions, for all properties use ai_agent_versions + +## Overview + + + + + + + +
Nameai_agent_versions_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::AIAgentVersion Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
number
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ai_agent_versions in a region. +```sql +SELECT +region, +assistant_id, +a_iagent_id, +version_number +FROM aws.wisdom.ai_agent_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ai_agent_versions_list_only resource, see ai_agent_versions + diff --git a/website/docs/services/wisdom/ai_agents/index.md b/website/docs/services/wisdom/ai_agents/index.md new file mode 100644 index 0000000..da7bc96 --- /dev/null +++ b/website/docs/services/wisdom/ai_agents/index.md @@ -0,0 +1,246 @@ +--- +title: ai_agents +hide_title: false +hide_table_of_contents: false +keywords: + - ai_agents + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ai_agent resource or lists ai_agents in a region + +## Overview + + + + + + + +
Nameai_agents
TypeResource
DescriptionDefinition of AWS::Wisdom::AIAgent Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
undefined
string
string
object
string
number
stringAWS region.
+ +For more information, see AWS::Wisdom::AIAgent. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ai_agents in a region. +```sql +SELECT +region, +a_iagent_id, +a_iagent_arn, +assistant_id, +assistant_arn, +configuration, +description, +name, +tags, +type, +modified_time_seconds +FROM aws.wisdom.ai_agents +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ai_agent. +```sql +SELECT +region, +a_iagent_id, +a_iagent_arn, +assistant_id, +assistant_arn, +configuration, +description, +name, +tags, +type, +modified_time_seconds +FROM aws.wisdom.ai_agents +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ai_agent resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_agents ( + AssistantId, + Configuration, + Type, + region +) +SELECT +'{{ AssistantId }}', + '{{ Configuration }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_agents ( + AssistantId, + Configuration, + Description, + Name, + Tags, + Type, + region +) +SELECT + '{{ AssistantId }}', + '{{ Configuration }}', + '{{ Description }}', + '{{ Name }}', + '{{ Tags }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ai_agent + props: + - name: AssistantId + value: '{{ AssistantId }}' + - name: Configuration + value: null + - name: Description + value: '{{ Description }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: {} + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.ai_agents +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ai_agents resource, the following permissions are required: + +### Create +```json +wisdom:CreateAIAgent, +wisdom:TagResource +``` + +### Read +```json +wisdom:GetAIAgent +``` + +### Update +```json +wisdom:UpdateAIAgent +``` + +### Delete +```json +wisdom:DeleteAIAgent +``` + +### List +```json +wisdom:ListAIAgents +``` diff --git a/website/docs/services/wisdom/ai_agents_list_only/index.md b/website/docs/services/wisdom/ai_agents_list_only/index.md new file mode 100644 index 0000000..88de49d --- /dev/null +++ b/website/docs/services/wisdom/ai_agents_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: ai_agents_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ai_agents_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ai_agents in a region or regions, for all properties use ai_agents + +## Overview + + + + + + + +
Nameai_agents_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::AIAgent Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ai_agents in a region. +```sql +SELECT +region, +a_iagent_id, +assistant_id +FROM aws.wisdom.ai_agents_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ai_agents_list_only resource, see ai_agents + diff --git a/website/docs/services/wisdom/ai_guardrail_tags/index.md b/website/docs/services/wisdom/ai_guardrail_tags/index.md new file mode 100644 index 0000000..815aacd --- /dev/null +++ b/website/docs/services/wisdom/ai_guardrail_tags/index.md @@ -0,0 +1,101 @@ +--- +title: ai_guardrail_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ai_guardrail_tags + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ai_guardrails in a region + +## Overview + + + + + + + +
Nameai_guardrail_tags
TypeResource
DescriptionDefinition of AWS::Wisdom::AIGuardrail Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringMessaging for when violations are detected in text
stringMessaging for when violations are detected in text
stringDescription of the guardrail or its version
objectTopic policy config for a guardrail.
objectContent policy config for a guardrail.
objectWord policy config for a guardrail.
objectSensitive information policy config for a guardrail.
objectContextual grounding policy config for a guardrail.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ai_guardrails in a region. +```sql +SELECT +region, +assistant_id, +assistant_arn, +a_iguardrail_arn, +a_iguardrail_id, +name, +blocked_input_messaging, +blocked_outputs_messaging, +description, +topic_policy_config, +content_policy_config, +word_policy_config, +sensitive_information_policy_config, +contextual_grounding_policy_config, +tag_key, +tag_value +FROM aws.wisdom.ai_guardrail_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ai_guardrail_tags resource, see ai_guardrails + diff --git a/website/docs/services/wisdom/ai_guardrail_versions/index.md b/website/docs/services/wisdom/ai_guardrail_versions/index.md new file mode 100644 index 0000000..d3c84dc --- /dev/null +++ b/website/docs/services/wisdom/ai_guardrail_versions/index.md @@ -0,0 +1,224 @@ +--- +title: ai_guardrail_versions +hide_title: false +hide_table_of_contents: false +keywords: + - ai_guardrail_versions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ai_guardrail_version resource or lists ai_guardrail_versions in a region + +## Overview + + + + + + + +
Nameai_guardrail_versions
TypeResource
DescriptionDefinition of AWS::Wisdom::AIGuardrailVersion Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
number
number
stringAWS region.
+ +For more information, see AWS::Wisdom::AIGuardrailVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ai_guardrail_versions in a region. +```sql +SELECT +region, +a_iguardrail_arn, +assistant_arn, +a_iguardrail_id, +assistant_id, +a_iguardrail_version_id, +version_number, +modified_time_seconds +FROM aws.wisdom.ai_guardrail_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ai_guardrail_version. +```sql +SELECT +region, +a_iguardrail_arn, +assistant_arn, +a_iguardrail_id, +assistant_id, +a_iguardrail_version_id, +version_number, +modified_time_seconds +FROM aws.wisdom.ai_guardrail_versions +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ai_guardrail_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_guardrail_versions ( + AIGuardrailId, + AssistantId, + region +) +SELECT +'{{ AIGuardrailId }}', + '{{ AssistantId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_guardrail_versions ( + AIGuardrailId, + AssistantId, + ModifiedTimeSeconds, + region +) +SELECT + '{{ AIGuardrailId }}', + '{{ AssistantId }}', + '{{ ModifiedTimeSeconds }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ai_guardrail_version + props: + - name: AIGuardrailId + value: '{{ AIGuardrailId }}' + - name: AssistantId + value: '{{ AssistantId }}' + - name: ModifiedTimeSeconds + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.ai_guardrail_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ai_guardrail_versions resource, the following permissions are required: + +### Create +```json +wisdom:CreateAIGuardrailVersion +``` + +### Read +```json +wisdom:GetAIGuardrail, +wisdom:GetAIGuardrailVersion +``` + +### Update +```json +wisdom:GetAIGuardrail, +wisdom:GetAIGuardrailVersion +``` + +### Delete +```json +wisdom:DeleteAIGuardrailVersion +``` + +### List +```json +wisdom:ListAIGuardrailVersions +``` diff --git a/website/docs/services/wisdom/ai_guardrail_versions_list_only/index.md b/website/docs/services/wisdom/ai_guardrail_versions_list_only/index.md new file mode 100644 index 0000000..89a0894 --- /dev/null +++ b/website/docs/services/wisdom/ai_guardrail_versions_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: ai_guardrail_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ai_guardrail_versions_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ai_guardrail_versions in a region or regions, for all properties use ai_guardrail_versions + +## Overview + + + + + + + +
Nameai_guardrail_versions_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::AIGuardrailVersion Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
number
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ai_guardrail_versions in a region. +```sql +SELECT +region, +assistant_id, +a_iguardrail_id, +version_number +FROM aws.wisdom.ai_guardrail_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ai_guardrail_versions_list_only resource, see ai_guardrail_versions + diff --git a/website/docs/services/wisdom/ai_guardrails/index.md b/website/docs/services/wisdom/ai_guardrails/index.md new file mode 100644 index 0000000..a78c73a --- /dev/null +++ b/website/docs/services/wisdom/ai_guardrails/index.md @@ -0,0 +1,303 @@ +--- +title: ai_guardrails +hide_title: false +hide_table_of_contents: false +keywords: + - ai_guardrails + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ai_guardrail resource or lists ai_guardrails in a region + +## Overview + + + + + + + +
Nameai_guardrails
TypeResource
DescriptionDefinition of AWS::Wisdom::AIGuardrail Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringMessaging for when violations are detected in text
stringMessaging for when violations are detected in text
stringDescription of the guardrail or its version
objectTopic policy config for a guardrail.
objectContent policy config for a guardrail.
objectWord policy config for a guardrail.
objectSensitive information policy config for a guardrail.
objectContextual grounding policy config for a guardrail.
object
stringAWS region.
+ +For more information, see AWS::Wisdom::AIGuardrail. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ai_guardrails in a region. +```sql +SELECT +region, +assistant_id, +assistant_arn, +a_iguardrail_arn, +a_iguardrail_id, +name, +blocked_input_messaging, +blocked_outputs_messaging, +description, +topic_policy_config, +content_policy_config, +word_policy_config, +sensitive_information_policy_config, +contextual_grounding_policy_config, +tags +FROM aws.wisdom.ai_guardrails +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ai_guardrail. +```sql +SELECT +region, +assistant_id, +assistant_arn, +a_iguardrail_arn, +a_iguardrail_id, +name, +blocked_input_messaging, +blocked_outputs_messaging, +description, +topic_policy_config, +content_policy_config, +word_policy_config, +sensitive_information_policy_config, +contextual_grounding_policy_config, +tags +FROM aws.wisdom.ai_guardrails +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ai_guardrail resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_guardrails ( + AssistantId, + BlockedInputMessaging, + BlockedOutputsMessaging, + region +) +SELECT +'{{ AssistantId }}', + '{{ BlockedInputMessaging }}', + '{{ BlockedOutputsMessaging }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_guardrails ( + AssistantId, + Name, + BlockedInputMessaging, + BlockedOutputsMessaging, + Description, + TopicPolicyConfig, + ContentPolicyConfig, + WordPolicyConfig, + SensitiveInformationPolicyConfig, + ContextualGroundingPolicyConfig, + Tags, + region +) +SELECT + '{{ AssistantId }}', + '{{ Name }}', + '{{ BlockedInputMessaging }}', + '{{ BlockedOutputsMessaging }}', + '{{ Description }}', + '{{ TopicPolicyConfig }}', + '{{ ContentPolicyConfig }}', + '{{ WordPolicyConfig }}', + '{{ SensitiveInformationPolicyConfig }}', + '{{ ContextualGroundingPolicyConfig }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ai_guardrail + props: + - name: AssistantId + value: '{{ AssistantId }}' + - name: Name + value: '{{ Name }}' + - name: BlockedInputMessaging + value: '{{ BlockedInputMessaging }}' + - name: BlockedOutputsMessaging + value: '{{ BlockedOutputsMessaging }}' + - name: Description + value: '{{ Description }}' + - name: TopicPolicyConfig + value: + TopicsConfig: + - Name: '{{ Name }}' + Definition: '{{ Definition }}' + Examples: + - '{{ Examples[0] }}' + Type: '{{ Type }}' + - name: ContentPolicyConfig + value: + FiltersConfig: + - Type: '{{ Type }}' + InputStrength: '{{ InputStrength }}' + OutputStrength: null + - name: WordPolicyConfig + value: + WordsConfig: + - Text: '{{ Text }}' + ManagedWordListsConfig: + - Type: '{{ Type }}' + - name: SensitiveInformationPolicyConfig + value: + PiiEntitiesConfig: + - Type: '{{ Type }}' + Action: '{{ Action }}' + RegexesConfig: + - Name: '{{ Name }}' + Description: '{{ Description }}' + Pattern: '{{ Pattern }}' + Action: null + - name: ContextualGroundingPolicyConfig + value: + FiltersConfig: + - Type: '{{ Type }}' + Threshold: null + - name: Tags + value: {} + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.ai_guardrails +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ai_guardrails resource, the following permissions are required: + +### Create +```json +wisdom:CreateAIGuardrail, +wisdom:TagResource +``` + +### Read +```json +wisdom:GetAIGuardrail +``` + +### Update +```json +wisdom:UpdateAIGuardrail +``` + +### Delete +```json +wisdom:DeleteAIGuardrail +``` + +### List +```json +wisdom:ListAIGuardrails +``` diff --git a/website/docs/services/wisdom/ai_guardrails_list_only/index.md b/website/docs/services/wisdom/ai_guardrails_list_only/index.md new file mode 100644 index 0000000..ad3de9d --- /dev/null +++ b/website/docs/services/wisdom/ai_guardrails_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: ai_guardrails_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ai_guardrails_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ai_guardrails in a region or regions, for all properties use ai_guardrails + +## Overview + + + + + + + +
Nameai_guardrails_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::AIGuardrail Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ai_guardrails in a region. +```sql +SELECT +region, +a_iguardrail_id, +assistant_id +FROM aws.wisdom.ai_guardrails_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ai_guardrails_list_only resource, see ai_guardrails + diff --git a/website/docs/services/wisdom/ai_prompt_tags/index.md b/website/docs/services/wisdom/ai_prompt_tags/index.md new file mode 100644 index 0000000..3123dda --- /dev/null +++ b/website/docs/services/wisdom/ai_prompt_tags/index.md @@ -0,0 +1,99 @@ +--- +title: ai_prompt_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ai_prompt_tags + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ai_prompts in a region + +## Overview + + + + + + + +
Nameai_prompt_tags
TypeResource
DescriptionDefinition of AWS::Wisdom::AIPrompt Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
object
string
string
number
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ai_prompts in a region. +```sql +SELECT +region, +a_iprompt_id, +a_iprompt_arn, +api_format, +assistant_id, +assistant_arn, +description, +model_id, +name, +template_configuration, +template_type, +type, +modified_time_seconds, +tag_key, +tag_value +FROM aws.wisdom.ai_prompt_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ai_prompt_tags resource, see ai_prompts + diff --git a/website/docs/services/wisdom/ai_prompt_versions/index.md b/website/docs/services/wisdom/ai_prompt_versions/index.md new file mode 100644 index 0000000..453103f --- /dev/null +++ b/website/docs/services/wisdom/ai_prompt_versions/index.md @@ -0,0 +1,224 @@ +--- +title: ai_prompt_versions +hide_title: false +hide_table_of_contents: false +keywords: + - ai_prompt_versions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ai_prompt_version resource or lists ai_prompt_versions in a region + +## Overview + + + + + + + +
Nameai_prompt_versions
TypeResource
DescriptionDefinition of AWS::Wisdom::AIPromptVersion Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
number
number
stringAWS region.
+ +For more information, see AWS::Wisdom::AIPromptVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ai_prompt_versions in a region. +```sql +SELECT +region, +a_iprompt_arn, +assistant_arn, +a_iprompt_id, +assistant_id, +a_iprompt_version_id, +version_number, +modified_time_seconds +FROM aws.wisdom.ai_prompt_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ai_prompt_version. +```sql +SELECT +region, +a_iprompt_arn, +assistant_arn, +a_iprompt_id, +assistant_id, +a_iprompt_version_id, +version_number, +modified_time_seconds +FROM aws.wisdom.ai_prompt_versions +WHERE region = 'us-east-1' AND data__Identifier = '||'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ai_prompt_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_prompt_versions ( + AIPromptId, + AssistantId, + region +) +SELECT +'{{ AIPromptId }}', + '{{ AssistantId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_prompt_versions ( + AIPromptId, + AssistantId, + ModifiedTimeSeconds, + region +) +SELECT + '{{ AIPromptId }}', + '{{ AssistantId }}', + '{{ ModifiedTimeSeconds }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ai_prompt_version + props: + - name: AIPromptId + value: '{{ AIPromptId }}' + - name: AssistantId + value: '{{ AssistantId }}' + - name: ModifiedTimeSeconds + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.ai_prompt_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ai_prompt_versions resource, the following permissions are required: + +### Create +```json +wisdom:CreateAIPromptVersion +``` + +### Read +```json +wisdom:GetAIPrompt, +wisdom:GetAIPromptVersion +``` + +### Update +```json +wisdom:GetAIPrompt, +wisdom:GetAIPromptVersion +``` + +### Delete +```json +wisdom:DeleteAIPromptVersion +``` + +### List +```json +wisdom:ListAIPromptVersions +``` diff --git a/website/docs/services/wisdom/ai_prompt_versions_list_only/index.md b/website/docs/services/wisdom/ai_prompt_versions_list_only/index.md new file mode 100644 index 0000000..0a26239 --- /dev/null +++ b/website/docs/services/wisdom/ai_prompt_versions_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: ai_prompt_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ai_prompt_versions_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ai_prompt_versions in a region or regions, for all properties use ai_prompt_versions + +## Overview + + + + + + + +
Nameai_prompt_versions_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::AIPromptVersion Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
number
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ai_prompt_versions in a region. +```sql +SELECT +region, +assistant_id, +a_iprompt_id, +version_number +FROM aws.wisdom.ai_prompt_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ai_prompt_versions_list_only resource, see ai_prompt_versions + diff --git a/website/docs/services/wisdom/ai_prompts/index.md b/website/docs/services/wisdom/ai_prompts/index.md new file mode 100644 index 0000000..791c55f --- /dev/null +++ b/website/docs/services/wisdom/ai_prompts/index.md @@ -0,0 +1,271 @@ +--- +title: ai_prompts +hide_title: false +hide_table_of_contents: false +keywords: + - ai_prompts + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ai_prompt resource or lists ai_prompts in a region + +## Overview + + + + + + + +
Nameai_prompts
TypeResource
DescriptionDefinition of AWS::Wisdom::AIPrompt Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
object
object
string
string
number
stringAWS region.
+ +For more information, see AWS::Wisdom::AIPrompt. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ai_prompts in a region. +```sql +SELECT +region, +a_iprompt_id, +a_iprompt_arn, +api_format, +assistant_id, +assistant_arn, +description, +model_id, +name, +tags, +template_configuration, +template_type, +type, +modified_time_seconds +FROM aws.wisdom.ai_prompts +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ai_prompt. +```sql +SELECT +region, +a_iprompt_id, +a_iprompt_arn, +api_format, +assistant_id, +assistant_arn, +description, +model_id, +name, +tags, +template_configuration, +template_type, +type, +modified_time_seconds +FROM aws.wisdom.ai_prompts +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ai_prompt resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_prompts ( + ApiFormat, + ModelId, + TemplateConfiguration, + TemplateType, + Type, + region +) +SELECT +'{{ ApiFormat }}', + '{{ ModelId }}', + '{{ TemplateConfiguration }}', + '{{ TemplateType }}', + '{{ Type }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.ai_prompts ( + ApiFormat, + AssistantId, + Description, + ModelId, + Name, + Tags, + TemplateConfiguration, + TemplateType, + Type, + region +) +SELECT + '{{ ApiFormat }}', + '{{ AssistantId }}', + '{{ Description }}', + '{{ ModelId }}', + '{{ Name }}', + '{{ Tags }}', + '{{ TemplateConfiguration }}', + '{{ TemplateType }}', + '{{ Type }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ai_prompt + props: + - name: ApiFormat + value: '{{ ApiFormat }}' + - name: AssistantId + value: '{{ AssistantId }}' + - name: Description + value: '{{ Description }}' + - name: ModelId + value: '{{ ModelId }}' + - name: Name + value: '{{ Name }}' + - name: Tags + value: {} + - name: TemplateConfiguration + value: {} + - name: TemplateType + value: '{{ TemplateType }}' + - name: Type + value: '{{ Type }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.ai_prompts +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ai_prompts resource, the following permissions are required: + +### Create +```json +wisdom:CreateAIPrompt, +wisdom:TagResource +``` + +### Read +```json +wisdom:GetAIPrompt +``` + +### Update +```json +wisdom:UpdateAIPrompt +``` + +### Delete +```json +wisdom:DeleteAIPrompt +``` + +### List +```json +wisdom:ListAIPrompts +``` diff --git a/website/docs/services/wisdom/ai_prompts_list_only/index.md b/website/docs/services/wisdom/ai_prompts_list_only/index.md new file mode 100644 index 0000000..5b62837 --- /dev/null +++ b/website/docs/services/wisdom/ai_prompts_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: ai_prompts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ai_prompts_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ai_prompts in a region or regions, for all properties use ai_prompts + +## Overview + + + + + + + +
Nameai_prompts_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::AIPrompt Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ai_prompts in a region. +```sql +SELECT +region, +a_iprompt_id, +assistant_id +FROM aws.wisdom.ai_prompts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ai_prompts_list_only resource, see ai_prompts + diff --git a/website/docs/services/wisdom/assistant_association_tags/index.md b/website/docs/services/wisdom/assistant_association_tags/index.md new file mode 100644 index 0000000..99462e8 --- /dev/null +++ b/website/docs/services/wisdom/assistant_association_tags/index.md @@ -0,0 +1,87 @@ +--- +title: assistant_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - assistant_association_tags + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for assistant_associations in a region + +## Overview + + + + + + + +
Nameassistant_association_tags
TypeResource
DescriptionDefinition of AWS::Wisdom::AssistantAssociation Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all assistant_associations in a region. +```sql +SELECT +region, +assistant_association_arn, +assistant_arn, +assistant_association_id, +assistant_id, +association, +association_type, +tag_key, +tag_value +FROM aws.wisdom.assistant_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assistant_association_tags resource, see assistant_associations + diff --git a/website/docs/services/wisdom/assistant_associations/index.md b/website/docs/services/wisdom/assistant_associations/index.md new file mode 100644 index 0000000..a59d56f --- /dev/null +++ b/website/docs/services/wisdom/assistant_associations/index.md @@ -0,0 +1,232 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an assistant_association resource or lists assistant_associations in a region + +## Overview + + + + + + + +
Nameassistant_associations
TypeResource
DescriptionDefinition of AWS::Wisdom::AssistantAssociation Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
string
array
stringAWS region.
+ +For more information, see AWS::Wisdom::AssistantAssociation. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all assistant_associations in a region. +```sql +SELECT +region, +assistant_association_arn, +assistant_arn, +assistant_association_id, +assistant_id, +association, +association_type, +tags +FROM aws.wisdom.assistant_associations +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual assistant_association. +```sql +SELECT +region, +assistant_association_arn, +assistant_arn, +assistant_association_id, +assistant_id, +association, +association_type, +tags +FROM aws.wisdom.assistant_associations +WHERE region = 'us-east-1' AND data__Identifier = '|'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new assistant_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.assistant_associations ( + AssistantId, + Association, + AssociationType, + region +) +SELECT +'{{ AssistantId }}', + '{{ Association }}', + '{{ AssociationType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.assistant_associations ( + AssistantId, + Association, + AssociationType, + Tags, + region +) +SELECT + '{{ AssistantId }}', + '{{ Association }}', + '{{ AssociationType }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: assistant_association + props: + - name: AssistantId + value: '{{ AssistantId }}' + - name: Association + value: + KnowledgeBaseId: '{{ KnowledgeBaseId }}' + - name: AssociationType + value: '{{ AssociationType }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.assistant_associations +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the assistant_associations resource, the following permissions are required: + +### Create +```json +wisdom:CreateAssistantAssociation, +wisdom:TagResource +``` + +### Update +```json +wisdom:GetAssistantAssociation +``` + +### Read +```json +wisdom:GetAssistantAssociation +``` + +### List +```json +wisdom:ListAssistantAssociations +``` + +### Delete +```json +wisdom:DeleteAssistantAssociation +``` diff --git a/website/docs/services/wisdom/assistant_associations_list_only/index.md b/website/docs/services/wisdom/assistant_associations_list_only/index.md new file mode 100644 index 0000000..9306f3e --- /dev/null +++ b/website/docs/services/wisdom/assistant_associations_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: assistant_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assistant_associations_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assistant_associations in a region or regions, for all properties use assistant_associations + +## Overview + + + + + + + +
Nameassistant_associations_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::AssistantAssociation Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assistant_associations in a region. +```sql +SELECT +region, +assistant_association_id, +assistant_id +FROM aws.wisdom.assistant_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assistant_associations_list_only resource, see assistant_associations + diff --git a/website/docs/services/wisdom/assistant_tags/index.md b/website/docs/services/wisdom/assistant_tags/index.md new file mode 100644 index 0000000..6ee18ef --- /dev/null +++ b/website/docs/services/wisdom/assistant_tags/index.md @@ -0,0 +1,87 @@ +--- +title: assistant_tags +hide_title: false +hide_table_of_contents: false +keywords: + - assistant_tags + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for assistants in a region + +## Overview + + + + + + + +
Nameassistant_tags
TypeResource
DescriptionDefinition of AWS::Wisdom::Assistant Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all assistants in a region. +```sql +SELECT +region, +type, +description, +assistant_arn, +assistant_id, +server_side_encryption_configuration, +name, +tag_key, +tag_value +FROM aws.wisdom.assistant_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assistant_tags resource, see assistants + diff --git a/website/docs/services/wisdom/assistants/index.md b/website/docs/services/wisdom/assistants/index.md new file mode 100644 index 0000000..f0176c4 --- /dev/null +++ b/website/docs/services/wisdom/assistants/index.md @@ -0,0 +1,236 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an assistant resource or lists assistants in a region + +## Overview + + + + + + + +
Nameassistants
TypeResource
DescriptionDefinition of AWS::Wisdom::Assistant Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
array
string
stringAWS region.
+ +For more information, see AWS::Wisdom::Assistant. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all assistants in a region. +```sql +SELECT +region, +type, +description, +assistant_arn, +assistant_id, +server_side_encryption_configuration, +tags, +name +FROM aws.wisdom.assistants +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual assistant. +```sql +SELECT +region, +type, +description, +assistant_arn, +assistant_id, +server_side_encryption_configuration, +tags, +name +FROM aws.wisdom.assistants +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new assistant resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.assistants ( + Type, + Name, + region +) +SELECT +'{{ Type }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.assistants ( + Type, + Description, + ServerSideEncryptionConfiguration, + Tags, + Name, + region +) +SELECT + '{{ Type }}', + '{{ Description }}', + '{{ ServerSideEncryptionConfiguration }}', + '{{ Tags }}', + '{{ Name }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: assistant + props: + - name: Type + value: '{{ Type }}' + - name: Description + value: '{{ Description }}' + - name: ServerSideEncryptionConfiguration + value: + KmsKeyId: '{{ KmsKeyId }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: Name + value: '{{ Name }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.assistants +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +wisdom:GetAssistant +``` + +### Read +```json +wisdom:GetAssistant +``` + +### List +```json +wisdom:ListAssistants +``` + +### Delete +```json +wisdom:DeleteAssistant +``` diff --git a/website/docs/services/wisdom/assistants_list_only/index.md b/website/docs/services/wisdom/assistants_list_only/index.md new file mode 100644 index 0000000..7727489 --- /dev/null +++ b/website/docs/services/wisdom/assistants_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: assistants_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assistants_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assistants in a region or regions, for all properties use assistants + +## Overview + + + + + + + +
Nameassistants_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::Assistant Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assistants in a region. +```sql +SELECT +region, +assistant_id +FROM aws.wisdom.assistants_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assistants_list_only resource, see assistants + diff --git a/website/docs/services/wisdom/index.md b/website/docs/services/wisdom/index.md new file mode 100644 index 0000000..6e6c843 --- /dev/null +++ b/website/docs/services/wisdom/index.md @@ -0,0 +1,64 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The wisdom service documentation. + +:::info Service Summary + +
+
+total resources: 29
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/wisdom/knowledge_base_tags/index.md b/website/docs/services/wisdom/knowledge_base_tags/index.md new file mode 100644 index 0000000..c84f3e5 --- /dev/null +++ b/website/docs/services/wisdom/knowledge_base_tags/index.md @@ -0,0 +1,93 @@ +--- +title: knowledge_base_tags +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_base_tags + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for knowledge_bases in a region + +## Overview + + + + + + + +
Nameknowledge_base_tags
TypeResource
DescriptionDefinition of AWS::Wisdom::KnowledgeBase Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
object
undefined
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all knowledge_bases in a region. +```sql +SELECT +region, +description, +knowledge_base_arn, +knowledge_base_id, +knowledge_base_type, +name, +rendering_configuration, +server_side_encryption_configuration, +source_configuration, +vector_ingestion_configuration, +tag_key, +tag_value +FROM aws.wisdom.knowledge_base_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the knowledge_base_tags resource, see knowledge_bases + diff --git a/website/docs/services/wisdom/knowledge_bases/index.md b/website/docs/services/wisdom/knowledge_bases/index.md new file mode 100644 index 0000000..ce1a632 --- /dev/null +++ b/website/docs/services/wisdom/knowledge_bases/index.md @@ -0,0 +1,288 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a knowledge_base resource or lists knowledge_bases in a region + +## Overview + + + + + + + +
Nameknowledge_bases
TypeResource
DescriptionDefinition of AWS::Wisdom::KnowledgeBase Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
object
undefined
object
array
stringAWS region.
+ +For more information, see AWS::Wisdom::KnowledgeBase. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all knowledge_bases in a region. +```sql +SELECT +region, +description, +knowledge_base_arn, +knowledge_base_id, +knowledge_base_type, +name, +rendering_configuration, +server_side_encryption_configuration, +source_configuration, +vector_ingestion_configuration, +tags +FROM aws.wisdom.knowledge_bases +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual knowledge_base. +```sql +SELECT +region, +description, +knowledge_base_arn, +knowledge_base_id, +knowledge_base_type, +name, +rendering_configuration, +server_side_encryption_configuration, +source_configuration, +vector_ingestion_configuration, +tags +FROM aws.wisdom.knowledge_bases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new knowledge_base resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.knowledge_bases ( + KnowledgeBaseType, + Name, + region +) +SELECT +'{{ KnowledgeBaseType }}', + '{{ Name }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.knowledge_bases ( + Description, + KnowledgeBaseType, + Name, + RenderingConfiguration, + ServerSideEncryptionConfiguration, + SourceConfiguration, + VectorIngestionConfiguration, + Tags, + region +) +SELECT + '{{ Description }}', + '{{ KnowledgeBaseType }}', + '{{ Name }}', + '{{ RenderingConfiguration }}', + '{{ ServerSideEncryptionConfiguration }}', + '{{ SourceConfiguration }}', + '{{ VectorIngestionConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: knowledge_base + props: + - name: Description + value: '{{ Description }}' + - name: KnowledgeBaseType + value: '{{ KnowledgeBaseType }}' + - name: Name + value: '{{ Name }}' + - name: RenderingConfiguration + value: + TemplateUri: '{{ TemplateUri }}' + - name: ServerSideEncryptionConfiguration + value: + KmsKeyId: '{{ KmsKeyId }}' + - name: SourceConfiguration + value: null + - name: VectorIngestionConfiguration + value: + ChunkingConfiguration: + ChunkingStrategy: '{{ ChunkingStrategy }}' + FixedSizeChunkingConfiguration: + MaxTokens: null + OverlapPercentage: null + HierarchicalChunkingConfiguration: + LevelConfigurations: + - MaxTokens: null + OverlapTokens: null + SemanticChunkingConfiguration: + MaxTokens: null + BufferSize: null + BreakpointPercentileThreshold: null + ParsingConfiguration: + ParsingStrategy: '{{ ParsingStrategy }}' + BedrockFoundationModelConfiguration: + ModelArn: '{{ ModelArn }}' + ParsingPrompt: + ParsingPromptText: '{{ ParsingPromptText }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.knowledge_bases +WHERE data__Identifier = '' +AND 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 +``` + +### Update +```json +wisdom:GetKnowledgeBase +``` + +### Delete +```json +appflow:DeleteFlow, +appflow:StopFlow, +app-integrations:DeleteDataIntegrationAssociation, +wisdom:DeleteKnowledgeBase +``` + +### List +```json +wisdom:ListKnowledgeBases +``` + +### Read +```json +wisdom:GetKnowledgeBase +``` diff --git a/website/docs/services/wisdom/knowledge_bases_list_only/index.md b/website/docs/services/wisdom/knowledge_bases_list_only/index.md new file mode 100644 index 0000000..167647f --- /dev/null +++ b/website/docs/services/wisdom/knowledge_bases_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: knowledge_bases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_bases_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists knowledge_bases in a region or regions, for all properties use knowledge_bases + +## Overview + + + + + + + +
Nameknowledge_bases_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::KnowledgeBase Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all knowledge_bases in a region. +```sql +SELECT +region, +knowledge_base_id +FROM aws.wisdom.knowledge_bases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the knowledge_bases_list_only resource, see knowledge_bases + diff --git a/website/docs/services/wisdom/message_template_tags/index.md b/website/docs/services/wisdom/message_template_tags/index.md new file mode 100644 index 0000000..52c5b48 --- /dev/null +++ b/website/docs/services/wisdom/message_template_tags/index.md @@ -0,0 +1,97 @@ +--- +title: message_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - message_template_tags + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for message_templates in a region + +## Overview + + + + + + + +
Namemessage_template_tags
TypeResource
DescriptionDefinition of AWS::Wisdom::MessageTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the knowledge base to which the message template belongs.
stringThe unique identifier of the message template.
stringThe Amazon Resource Name (ARN) of the message template.
stringThe name of the message template.
stringThe channel subtype this message template applies to.
objectThe content of the message template.
stringThe description of the message template.
stringThe language code value for the language in which the message template is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
objectThe configuration information of the user groups that the message template is accessible to.
objectAn object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
stringThe content SHA256 of the message template.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all message_templates in a region. +```sql +SELECT +region, +knowledge_base_arn, +message_template_id, +message_template_arn, +name, +channel_subtype, +content, +description, +language, +grouping_configuration, +default_attributes, +message_template_content_sha256, +tag_key, +tag_value +FROM aws.wisdom.message_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the message_template_tags resource, see message_templates + diff --git a/website/docs/services/wisdom/message_template_versions/index.md b/website/docs/services/wisdom/message_template_versions/index.md new file mode 100644 index 0000000..7762205 --- /dev/null +++ b/website/docs/services/wisdom/message_template_versions/index.md @@ -0,0 +1,208 @@ +--- +title: message_template_versions +hide_title: false +hide_table_of_contents: false +keywords: + - message_template_versions + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a message_template_version resource or lists message_template_versions in a region + +## Overview + + + + + + + +
Namemessage_template_versions
TypeResource
DescriptionA version for the specified customer-managed message template within the specified knowledge base.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe unqualified Amazon Resource Name (ARN) of the message template.
stringThe unqualified Amazon Resource Name (ARN) of the message template version.
stringThe content SHA256 of the message template.
numberCurrent version number of the message template.
stringAWS region.
+ +For more information, see AWS::Wisdom::MessageTemplateVersion. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all message_template_versions in a region. +```sql +SELECT +region, +message_template_arn, +message_template_version_arn, +message_template_content_sha256, +message_template_version_number +FROM aws.wisdom.message_template_versions +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual message_template_version. +```sql +SELECT +region, +message_template_arn, +message_template_version_arn, +message_template_content_sha256, +message_template_version_number +FROM aws.wisdom.message_template_versions +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new message_template_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.message_template_versions ( + MessageTemplateArn, + region +) +SELECT +'{{ MessageTemplateArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.message_template_versions ( + MessageTemplateArn, + MessageTemplateContentSha256, + region +) +SELECT + '{{ MessageTemplateArn }}', + '{{ MessageTemplateContentSha256 }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: message_template_version + props: + - name: MessageTemplateArn + value: '{{ MessageTemplateArn }}' + - name: MessageTemplateContentSha256 + value: '{{ MessageTemplateContentSha256 }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.message_template_versions +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the message_template_versions resource, the following permissions are required: + +### Create +```json +wisdom:CreateMessageTemplateVersion, +wisdom:ListMessageTemplateVersions +``` + +### Delete +```json +wisdom:DeleteMessageTemplate +``` + +### Update +```json +wisdom:CreateMessageTemplateVersion +``` + +### List +```json +wisdom:ListMessageTemplateVersions +``` + +### Read +```json +wisdom:GetMessageTemplate +``` diff --git a/website/docs/services/wisdom/message_template_versions_list_only/index.md b/website/docs/services/wisdom/message_template_versions_list_only/index.md new file mode 100644 index 0000000..33038cb --- /dev/null +++ b/website/docs/services/wisdom/message_template_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: message_template_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - message_template_versions_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists message_template_versions in a region or regions, for all properties use message_template_versions + +## Overview + + + + + + + +
Namemessage_template_versions_list_only
TypeResource
DescriptionA version for the specified customer-managed message template within the specified knowledge base.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unqualified Amazon Resource Name (ARN) of the message template version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all message_template_versions in a region. +```sql +SELECT +region, +message_template_version_arn +FROM aws.wisdom.message_template_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the message_template_versions_list_only resource, see message_template_versions + diff --git a/website/docs/services/wisdom/message_templates/index.md b/website/docs/services/wisdom/message_templates/index.md new file mode 100644 index 0000000..77e22bb --- /dev/null +++ b/website/docs/services/wisdom/message_templates/index.md @@ -0,0 +1,361 @@ +--- +title: message_templates +hide_title: false +hide_table_of_contents: false +keywords: + - message_templates + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a message_template resource or lists message_templates in a region + +## Overview + + + + + + + +
Namemessage_templates
TypeResource
DescriptionDefinition of AWS::Wisdom::MessageTemplate Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the knowledge base to which the message template belongs.
stringThe unique identifier of the message template.
stringThe Amazon Resource Name (ARN) of the message template.
stringThe name of the message template.
stringThe channel subtype this message template applies to.
objectThe content of the message template.
stringThe description of the message template.
stringThe language code value for the language in which the message template is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
objectThe configuration information of the user groups that the message template is accessible to.
objectAn object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
stringThe content SHA256 of the message template.
arrayThe tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
stringAWS region.
+ +For more information, see AWS::Wisdom::MessageTemplate. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all message_templates in a region. +```sql +SELECT +region, +knowledge_base_arn, +message_template_id, +message_template_arn, +name, +channel_subtype, +content, +description, +language, +grouping_configuration, +default_attributes, +message_template_content_sha256, +tags +FROM aws.wisdom.message_templates +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual message_template. +```sql +SELECT +region, +knowledge_base_arn, +message_template_id, +message_template_arn, +name, +channel_subtype, +content, +description, +language, +grouping_configuration, +default_attributes, +message_template_content_sha256, +tags +FROM aws.wisdom.message_templates +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new message_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.message_templates ( + KnowledgeBaseArn, + Name, + ChannelSubtype, + Content, + region +) +SELECT +'{{ KnowledgeBaseArn }}', + '{{ Name }}', + '{{ ChannelSubtype }}', + '{{ Content }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.wisdom.message_templates ( + KnowledgeBaseArn, + Name, + ChannelSubtype, + Content, + Description, + Language, + GroupingConfiguration, + DefaultAttributes, + Tags, + region +) +SELECT + '{{ KnowledgeBaseArn }}', + '{{ Name }}', + '{{ ChannelSubtype }}', + '{{ Content }}', + '{{ Description }}', + '{{ Language }}', + '{{ GroupingConfiguration }}', + '{{ DefaultAttributes }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: message_template + props: + - name: KnowledgeBaseArn + value: '{{ KnowledgeBaseArn }}' + - name: Name + value: '{{ Name }}' + - name: ChannelSubtype + value: '{{ ChannelSubtype }}' + - name: Content + value: + EmailMessageTemplateContent: + Subject: '{{ Subject }}' + Body: + PlainText: + Content: '{{ Content }}' + Html: null + Headers: + - Name: '{{ Name }}' + Value: '{{ Value }}' + SmsMessageTemplateContent: + Body: + PlainText: null + - name: Description + value: '{{ Description }}' + - name: Language + value: '{{ Language }}' + - name: GroupingConfiguration + value: + Criteria: '{{ Criteria }}' + Values: + - '{{ Values[0] }}' + - name: DefaultAttributes + value: + SystemAttributes: + Name: '{{ Name }}' + CustomerEndpoint: + Address: '{{ Address }}' + SystemEndpoint: null + AgentAttributes: + FirstName: '{{ FirstName }}' + LastName: '{{ LastName }}' + CustomerProfileAttributes: + ProfileId: '{{ ProfileId }}' + ProfileARN: '{{ ProfileARN }}' + FirstName: '{{ FirstName }}' + MiddleName: '{{ MiddleName }}' + LastName: '{{ LastName }}' + AccountNumber: '{{ AccountNumber }}' + EmailAddress: '{{ EmailAddress }}' + PhoneNumber: '{{ PhoneNumber }}' + AdditionalInformation: '{{ AdditionalInformation }}' + PartyType: '{{ PartyType }}' + BusinessName: '{{ BusinessName }}' + BirthDate: '{{ BirthDate }}' + Gender: '{{ Gender }}' + MobilePhoneNumber: '{{ MobilePhoneNumber }}' + HomePhoneNumber: '{{ HomePhoneNumber }}' + BusinessPhoneNumber: '{{ BusinessPhoneNumber }}' + BusinessEmailAddress: '{{ BusinessEmailAddress }}' + Address1: '{{ Address1 }}' + Address2: '{{ Address2 }}' + Address3: '{{ Address3 }}' + Address4: '{{ Address4 }}' + City: '{{ City }}' + County: '{{ County }}' + Country: '{{ Country }}' + PostalCode: '{{ PostalCode }}' + Province: '{{ Province }}' + State: '{{ State }}' + ShippingAddress1: '{{ ShippingAddress1 }}' + ShippingAddress2: '{{ ShippingAddress2 }}' + ShippingAddress3: '{{ ShippingAddress3 }}' + ShippingAddress4: '{{ ShippingAddress4 }}' + ShippingCity: '{{ ShippingCity }}' + ShippingCounty: '{{ ShippingCounty }}' + ShippingCountry: '{{ ShippingCountry }}' + ShippingPostalCode: '{{ ShippingPostalCode }}' + ShippingProvince: '{{ ShippingProvince }}' + ShippingState: '{{ ShippingState }}' + MailingAddress1: '{{ MailingAddress1 }}' + MailingAddress2: '{{ MailingAddress2 }}' + MailingAddress3: '{{ MailingAddress3 }}' + MailingAddress4: '{{ MailingAddress4 }}' + MailingCity: '{{ MailingCity }}' + MailingCounty: '{{ MailingCounty }}' + MailingCountry: '{{ MailingCountry }}' + MailingPostalCode: '{{ MailingPostalCode }}' + MailingProvince: '{{ MailingProvince }}' + MailingState: '{{ MailingState }}' + BillingAddress1: '{{ BillingAddress1 }}' + BillingAddress2: '{{ BillingAddress2 }}' + BillingAddress3: '{{ BillingAddress3 }}' + BillingAddress4: '{{ BillingAddress4 }}' + BillingCity: '{{ BillingCity }}' + BillingCounty: '{{ BillingCounty }}' + BillingCountry: '{{ BillingCountry }}' + BillingPostalCode: '{{ BillingPostalCode }}' + BillingProvince: '{{ BillingProvince }}' + BillingState: '{{ BillingState }}' + Custom: {} + CustomAttributes: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.wisdom.message_templates +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the message_templates resource, the following permissions are required: + +### Create +```json +wisdom:CreateMessageTemplate, +wisdom:GetMessageTemplate, +wisdom:TagResource, +connect:SearchRoutingProfiles, +connect:DescribeRoutingProfile +``` + +### Update +```json +wisdom:UpdateMessageTemplate, +wisdom:UpdateMessageTemplateMetadata, +wisdom:GetMessageTemplate, +wisdom:TagResource, +wisdom:UntagResource, +connect:SearchRoutingProfiles, +connect:DescribeRoutingProfile +``` + +### Delete +```json +wisdom:DeleteMessageTemplate, +wisdom:UntagResource +``` + +### List +```json +wisdom:ListMessageTemplates +``` + +### Read +```json +wisdom:GetMessageTemplate +``` diff --git a/website/docs/services/wisdom/message_templates_list_only/index.md b/website/docs/services/wisdom/message_templates_list_only/index.md new file mode 100644 index 0000000..5d3ebf3 --- /dev/null +++ b/website/docs/services/wisdom/message_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: message_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - message_templates_list_only + - wisdom + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists message_templates in a region or regions, for all properties use message_templates + +## Overview + + + + + + + +
Namemessage_templates_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::MessageTemplate Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the message template.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all message_templates in a region. +```sql +SELECT +region, +message_template_arn +FROM aws.wisdom.message_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the message_templates_list_only resource, see message_templates + diff --git a/website/docs/services/workspaces/connection_aliases/index.md b/website/docs/services/workspaces/connection_aliases/index.md new file mode 100644 index 0000000..b773a3d --- /dev/null +++ b/website/docs/services/workspaces/connection_aliases/index.md @@ -0,0 +1,181 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a connection_alias resource or lists connection_aliases in a region + +## Overview + + + + + + + +
Nameconnection_aliases
TypeResource
DescriptionResource Type definition for AWS::WorkSpaces::ConnectionAlias
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
array
stringAWS region.
+ +For more information, see AWS::WorkSpaces::ConnectionAlias. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
SELECT
+ +## `SELECT` examples + +Gets all properties from an individual connection_alias. +```sql +SELECT +region, +associations, +alias_id, +connection_string, +connection_alias_state, +tags +FROM aws.workspaces.connection_aliases +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connection_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspaces.connection_aliases ( + ConnectionString, + region +) +SELECT +'{{ ConnectionString }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspaces.connection_aliases ( + ConnectionString, + Tags, + region +) +SELECT + '{{ ConnectionString }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: connection_alias + props: + - name: ConnectionString + value: '{{ ConnectionString }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspaces.connection_aliases +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the connection_aliases resource, the following permissions are required: + +### Create +```json +workspaces:CreateConnectionAlias +``` + +### Read +```json +workspaces:DescribeConnectionAliases +``` + +### Delete +```json +workspaces:DeleteConnectionAlias +``` diff --git a/website/docs/services/workspaces/index.md b/website/docs/services/workspaces/index.md new file mode 100644 index 0000000..a9d05e6 --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The workspaces service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/workspaces/workspaces_pool_tags/index.md b/website/docs/services/workspaces/workspaces_pool_tags/index.md new file mode 100644 index 0000000..8bcfd3c --- /dev/null +++ b/website/docs/services/workspaces/workspaces_pool_tags/index.md @@ -0,0 +1,95 @@ +--- +title: workspaces_pool_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces_pool_tags + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workspaces_pools in a region + +## Overview + + + + + + + +
Nameworkspaces_pool_tags
TypeResource
DescriptionResource Type definition for AWS::WorkSpaces::WorkspacesPool
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workspaces_pools in a region. +```sql +SELECT +region, +pool_id, +pool_arn, +capacity, +pool_name, +description, +created_at, +bundle_id, +directory_id, +application_settings, +timeout_settings, +tag_key, +tag_value +FROM aws.workspaces.workspaces_pool_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspaces_pool_tags resource, see workspaces_pools + diff --git a/website/docs/services/workspaces/workspaces_pools/index.md b/website/docs/services/workspaces/workspaces_pools/index.md new file mode 100644 index 0000000..a820a59 --- /dev/null +++ b/website/docs/services/workspaces/workspaces_pools/index.md @@ -0,0 +1,268 @@ +--- +title: workspaces_pools +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces_pools + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a workspaces_pool resource or lists workspaces_pools in a region + +## Overview + + + + + + + +
Nameworkspaces_pools
TypeResource
DescriptionResource Type definition for AWS::WorkSpaces::WorkspacesPool
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
object
object
array
stringAWS region.
+ +For more information, see AWS::WorkSpaces::WorkspacesPool. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all workspaces_pools in a region. +```sql +SELECT +region, +pool_id, +pool_arn, +capacity, +pool_name, +description, +created_at, +bundle_id, +directory_id, +application_settings, +timeout_settings, +tags +FROM aws.workspaces.workspaces_pools +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual workspaces_pool. +```sql +SELECT +region, +pool_id, +pool_arn, +capacity, +pool_name, +description, +created_at, +bundle_id, +directory_id, +application_settings, +timeout_settings, +tags +FROM aws.workspaces.workspaces_pools +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workspaces_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspaces.workspaces_pools ( + Capacity, + PoolName, + BundleId, + DirectoryId, + region +) +SELECT +'{{ Capacity }}', + '{{ PoolName }}', + '{{ BundleId }}', + '{{ DirectoryId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspaces.workspaces_pools ( + Capacity, + PoolName, + Description, + BundleId, + DirectoryId, + ApplicationSettings, + TimeoutSettings, + Tags, + region +) +SELECT + '{{ Capacity }}', + '{{ PoolName }}', + '{{ Description }}', + '{{ BundleId }}', + '{{ DirectoryId }}', + '{{ ApplicationSettings }}', + '{{ TimeoutSettings }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: workspaces_pool + props: + - name: Capacity + value: + DesiredUserSessions: '{{ DesiredUserSessions }}' + - name: PoolName + value: '{{ PoolName }}' + - name: Description + value: '{{ Description }}' + - name: BundleId + value: '{{ BundleId }}' + - name: DirectoryId + value: '{{ DirectoryId }}' + - name: ApplicationSettings + value: + Status: '{{ Status }}' + SettingsGroup: '{{ SettingsGroup }}' + - name: TimeoutSettings + value: + DisconnectTimeoutInSeconds: '{{ DisconnectTimeoutInSeconds }}' + IdleDisconnectTimeoutInSeconds: '{{ IdleDisconnectTimeoutInSeconds }}' + MaxUserDurationInSeconds: '{{ MaxUserDurationInSeconds }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspaces.workspaces_pools +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the workspaces_pools resource, the following permissions are required: + +### Create +```json +workspaces:CreateWorkspacesPool, +workspaces:DescribeWorkspacesPools +``` + +### Read +```json +workspaces:DescribeWorkspacesPools +``` + +### Update +```json +workspaces:UpdateWorkspacesPool +``` + +### Delete +```json +workspaces:DescribeWorkspacesPools, +workspaces:TerminateWorkspacesPool +``` + +### List +```json +workspaces:DescribeWorkspacesPools +``` diff --git a/website/docs/services/workspaces/workspaces_pools_list_only/index.md b/website/docs/services/workspaces/workspaces_pools_list_only/index.md new file mode 100644 index 0000000..3580c24 --- /dev/null +++ b/website/docs/services/workspaces/workspaces_pools_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: workspaces_pools_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces_pools_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workspaces_pools in a region or regions, for all properties use workspaces_pools + +## Overview + + + + + + + +
Nameworkspaces_pools_list_only
TypeResource
DescriptionResource Type definition for AWS::WorkSpaces::WorkspacesPool
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workspaces_pools in a region. +```sql +SELECT +region, +pool_id +FROM aws.workspaces.workspaces_pools_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspaces_pools_list_only resource, see workspaces_pools + diff --git a/website/docs/services/workspacesthinclient/environment_tags/index.md b/website/docs/services/workspacesthinclient/environment_tags/index.md new file mode 100644 index 0000000..ff09965 --- /dev/null +++ b/website/docs/services/workspacesthinclient/environment_tags/index.md @@ -0,0 +1,113 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - workspacesthinclient + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + + + +
Nameenvironment_tags
TypeResource
DescriptionResource type definition for AWS::WorkSpacesThinClient::Environment.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier of the environment.
stringThe name of the environment.
stringThe Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
stringThe URL for the identity provider login (only for environments that use AppStream 2.0).
stringThe type of VDI.
stringActivation code for devices associated with environment.
integerNumber of devices registered to the environment.
stringAn option to define if software updates should be applied within a maintenance window.
objectA specification for a time window to apply software updates.
stringAn option to define which software updates to apply.
stringThe ID of the software set to apply.
stringThe ID of the software set that is pending to be installed.
stringThe version of the software set that is pending to be installed.
stringDescribes if the software currently installed on all devices in the environment is a supported version.
stringThe timestamp in unix epoch format when environment was created.
stringThe timestamp in unix epoch format when environment was last updated.
stringThe environment ARN.
stringThe Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
arrayAn array of key-value pairs to apply to the newly created devices for this environment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +id, +name, +desktop_arn, +desktop_endpoint, +desktop_type, +activation_code, +registered_devices_count, +software_set_update_schedule, +maintenance_window, +software_set_update_mode, +desired_software_set_id, +pending_software_set_id, +pending_software_set_version, +software_set_compliance_status, +created_at, +updated_at, +arn, +kms_key_arn, +device_creation_tags, +tag_key, +tag_value +FROM aws.workspacesthinclient.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + diff --git a/website/docs/services/workspacesthinclient/environments/index.md b/website/docs/services/workspacesthinclient/environments/index.md new file mode 100644 index 0000000..6d4bd28 --- /dev/null +++ b/website/docs/services/workspacesthinclient/environments/index.md @@ -0,0 +1,324 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an environment resource or lists environments in a region + +## Overview + + + + + + + +
Nameenvironments
TypeResource
DescriptionResource type definition for AWS::WorkSpacesThinClient::Environment.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier of the environment.
stringThe name of the environment.
stringThe Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
stringThe URL for the identity provider login (only for environments that use AppStream 2.0).
stringThe type of VDI.
stringActivation code for devices associated with environment.
integerNumber of devices registered to the environment.
stringAn option to define if software updates should be applied within a maintenance window.
objectA specification for a time window to apply software updates.
stringAn option to define which software updates to apply.
stringThe ID of the software set to apply.
stringThe ID of the software set that is pending to be installed.
stringThe version of the software set that is pending to be installed.
stringDescribes if the software currently installed on all devices in the environment is a supported version.
stringThe timestamp in unix epoch format when environment was created.
stringThe timestamp in unix epoch format when environment was last updated.
stringThe environment ARN.
stringThe Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
arrayAn array of key-value pairs to apply to this resource.
arrayAn array of key-value pairs to apply to the newly created devices for this environment.
stringAWS region.
+ +For more information, see AWS::WorkSpacesThinClient::Environment. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all environments in a region. +```sql +SELECT +region, +id, +name, +desktop_arn, +desktop_endpoint, +desktop_type, +activation_code, +registered_devices_count, +software_set_update_schedule, +maintenance_window, +software_set_update_mode, +desired_software_set_id, +pending_software_set_id, +pending_software_set_version, +software_set_compliance_status, +created_at, +updated_at, +arn, +kms_key_arn, +tags, +device_creation_tags +FROM aws.workspacesthinclient.environments +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual environment. +```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, +device_creation_tags +FROM aws.workspacesthinclient.environments +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesthinclient.environments ( + DesktopArn, + region +) +SELECT +'{{ DesktopArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesthinclient.environments ( + Name, + DesktopArn, + DesktopEndpoint, + SoftwareSetUpdateSchedule, + MaintenanceWindow, + SoftwareSetUpdateMode, + DesiredSoftwareSetId, + KmsKeyArn, + Tags, + DeviceCreationTags, + region +) +SELECT + '{{ Name }}', + '{{ DesktopArn }}', + '{{ DesktopEndpoint }}', + '{{ SoftwareSetUpdateSchedule }}', + '{{ MaintenanceWindow }}', + '{{ SoftwareSetUpdateMode }}', + '{{ DesiredSoftwareSetId }}', + '{{ KmsKeyArn }}', + '{{ Tags }}', + '{{ DeviceCreationTags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: environment + props: + - name: Name + value: '{{ Name }}' + - name: DesktopArn + value: '{{ DesktopArn }}' + - name: DesktopEndpoint + value: '{{ DesktopEndpoint }}' + - name: SoftwareSetUpdateSchedule + value: '{{ SoftwareSetUpdateSchedule }}' + - name: MaintenanceWindow + value: + Type: '{{ Type }}' + StartTimeHour: '{{ StartTimeHour }}' + StartTimeMinute: '{{ StartTimeMinute }}' + EndTimeHour: null + EndTimeMinute: null + DaysOfTheWeek: + - '{{ DaysOfTheWeek[0] }}' + ApplyTimeOf: '{{ ApplyTimeOf }}' + - name: SoftwareSetUpdateMode + value: '{{ SoftwareSetUpdateMode }}' + - name: DesiredSoftwareSetId + value: '{{ DesiredSoftwareSetId }}' + - name: KmsKeyArn + value: '{{ KmsKeyArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: DeviceCreationTags + value: + - null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspacesthinclient.environments +WHERE data__Identifier = '' +AND 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 +``` + +### Read +```json +thinclient:GetEnvironment, +thinclient:ListTagsForResource, +kms:Decrypt +``` + +### Update +```json +appstream:DescribeStacks, +workspaces:DescribeWorkspaceDirectories, +workspaces-web:GetPortal, +workspaces-web:GetUserSettings, +thinclient:UpdateEnvironment, +thinclient:ListTagsForResource, +thinclient:TagResource, +thinclient:UntagResource, +kms:Decrypt, +kms:GenerateDataKey +``` + +### Delete +```json +thinclient:DeleteEnvironment, +thinclient:UntagResource, +kms:Decrypt, +kms:RetireGrant +``` + +### List +```json +thinclient:ListEnvironments, +thinclient:ListTagsForResource, +kms:Decrypt +``` diff --git a/website/docs/services/workspacesthinclient/environments_list_only/index.md b/website/docs/services/workspacesthinclient/environments_list_only/index.md new file mode 100644 index 0000000..7bf1d30 --- /dev/null +++ b/website/docs/services/workspacesthinclient/environments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionResource type definition for AWS::WorkSpacesThinClient::Environment.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique identifier of the environment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +id +FROM aws.workspacesthinclient.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + diff --git a/website/docs/services/workspacesthinclient/index.md b/website/docs/services/workspacesthinclient/index.md new file mode 100644 index 0000000..0994b30 --- /dev/null +++ b/website/docs/services/workspacesthinclient/index.md @@ -0,0 +1,38 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The workspacesthinclient service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/workspacesweb/browser_settings/index.md b/website/docs/services/workspacesweb/browser_settings/index.md new file mode 100644 index 0000000..927aa01 --- /dev/null +++ b/website/docs/services/workspacesweb/browser_settings/index.md @@ -0,0 +1,258 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a browser_setting resource or lists browser_settings in a region + +## Overview + + + + + + + +
Namebrowser_settings
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::BrowserSettings Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
array
stringAWS region.
+ +For more information, see AWS::WorkSpacesWeb::BrowserSettings. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all browser_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +browser_policy, +browser_settings_arn, +customer_managed_key, +tags +FROM aws.workspacesweb.browser_settings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual browser_setting. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +browser_policy, +browser_settings_arn, +customer_managed_key, +tags +FROM aws.workspacesweb.browser_settings +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new browser_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.browser_settings ( + AdditionalEncryptionContext, + BrowserPolicy, + CustomerManagedKey, + Tags, + region +) +SELECT +'{{ AdditionalEncryptionContext }}', + '{{ BrowserPolicy }}', + '{{ CustomerManagedKey }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.browser_settings ( + AdditionalEncryptionContext, + BrowserPolicy, + CustomerManagedKey, + Tags, + region +) +SELECT + '{{ AdditionalEncryptionContext }}', + '{{ BrowserPolicy }}', + '{{ CustomerManagedKey }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: browser_setting + props: + - name: AdditionalEncryptionContext + value: {} + - name: BrowserPolicy + value: '{{ BrowserPolicy }}' + - name: CustomerManagedKey + value: '{{ CustomerManagedKey }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspacesweb.browser_settings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the browser_settings resource, the following permissions are required: + +### Create +```json +workspaces-web:CreateBrowserSettings, +workspaces-web:GetBrowserSettings, +workspaces-web:ListTagsForResource, +workspaces-web:TagResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt, +kms:GenerateDataKeyWithoutPlaintext, +kms:ReEncryptTo, +kms:ReEncryptFrom +``` + +### 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 +``` + +### List +```json +workspaces-web:ListBrowserSettings +``` diff --git a/website/docs/services/workspacesweb/browser_settings_list_only/index.md b/website/docs/services/workspacesweb/browser_settings_list_only/index.md new file mode 100644 index 0000000..1446c7a --- /dev/null +++ b/website/docs/services/workspacesweb/browser_settings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: browser_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - browser_settings_list_only + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists browser_settings in a region or regions, for all properties use browser_settings + +## Overview + + + + + + + +
Namebrowser_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::BrowserSettings Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all browser_settings in a region. +```sql +SELECT +region, +browser_settings_arn +FROM aws.workspacesweb.browser_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the browser_settings_list_only resource, see browser_settings + diff --git a/website/docs/services/workspacesweb/browser_settings_tags/index.md b/website/docs/services/workspacesweb/browser_settings_tags/index.md new file mode 100644 index 0000000..195a4c2 --- /dev/null +++ b/website/docs/services/workspacesweb/browser_settings_tags/index.md @@ -0,0 +1,85 @@ +--- +title: browser_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - browser_settings_tags + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for browser_settings in a region + +## Overview + + + + + + + +
Namebrowser_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::BrowserSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all browser_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +browser_policy, +browser_settings_arn, +customer_managed_key, +tag_key, +tag_value +FROM aws.workspacesweb.browser_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the browser_settings_tags resource, see browser_settings + diff --git a/website/docs/services/workspacesweb/data_protection_settings/index.md b/website/docs/services/workspacesweb/data_protection_settings/index.md new file mode 100644 index 0000000..3a5d962 --- /dev/null +++ b/website/docs/services/workspacesweb/data_protection_settings/index.md @@ -0,0 +1,300 @@ +--- +title: data_protection_settings +hide_title: false +hide_table_of_contents: false +keywords: + - data_protection_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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a data_protection_setting resource or lists data_protection_settings in a region + +## Overview + + + + + + + +
Namedata_protection_settings
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::DataProtectionSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
string
string
object
array
stringAWS region.
+ +For more information, see AWS::WorkSpacesWeb::DataProtectionSettings. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all data_protection_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +creation_date, +customer_managed_key, +data_protection_settings_arn, +description, +display_name, +inline_redaction_configuration, +tags +FROM aws.workspacesweb.data_protection_settings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual data_protection_setting. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +creation_date, +customer_managed_key, +data_protection_settings_arn, +description, +display_name, +inline_redaction_configuration, +tags +FROM aws.workspacesweb.data_protection_settings +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new data_protection_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.data_protection_settings ( + AdditionalEncryptionContext, + CustomerManagedKey, + Description, + DisplayName, + InlineRedactionConfiguration, + Tags, + region +) +SELECT +'{{ AdditionalEncryptionContext }}', + '{{ CustomerManagedKey }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ InlineRedactionConfiguration }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.data_protection_settings ( + AdditionalEncryptionContext, + CustomerManagedKey, + Description, + DisplayName, + InlineRedactionConfiguration, + Tags, + region +) +SELECT + '{{ AdditionalEncryptionContext }}', + '{{ CustomerManagedKey }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ InlineRedactionConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: data_protection_setting + props: + - name: AdditionalEncryptionContext + value: {} + - name: CustomerManagedKey + value: '{{ CustomerManagedKey }}' + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: InlineRedactionConfiguration + value: + InlineRedactionPatterns: + - BuiltInPatternId: '{{ BuiltInPatternId }}' + CustomPattern: + PatternName: '{{ PatternName }}' + PatternRegex: '{{ PatternRegex }}' + PatternDescription: '{{ PatternDescription }}' + KeywordRegex: '{{ KeywordRegex }}' + RedactionPlaceHolder: + RedactionPlaceHolderType: '{{ RedactionPlaceHolderType }}' + RedactionPlaceHolderText: '{{ RedactionPlaceHolderText }}' + EnforcedUrls: + - '{{ EnforcedUrls[0] }}' + ExemptUrls: + - '{{ ExemptUrls[0] }}' + ConfidenceLevel: null + GlobalEnforcedUrls: + - '{{ GlobalEnforcedUrls[0] }}' + GlobalExemptUrls: + - '{{ GlobalExemptUrls[0] }}' + GlobalConfidenceLevel: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspacesweb.data_protection_settings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the data_protection_settings resource, the following permissions are required: + +### Create +```json +workspaces-web:CreateDataProtectionSettings, +workspaces-web:GetDataProtectionSettings, +workspaces-web:ListDataProtectionSettings, +workspaces-web:ListTagsForResource, +workspaces-web:TagResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt, +kms:GenerateDataKeyWithoutPlaintext, +kms:ReEncryptTo, +kms:ReEncryptFrom +``` + +### Read +```json +workspaces-web:GetDataProtectionSettings, +workspaces-web:ListDataProtectionSettings, +workspaces-web:ListTagsForResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Update +```json +workspaces-web:UpdateDataProtectionSettings, +workspaces-web:GetDataProtectionSettings, +workspaces-web:ListDataProtectionSettings, +workspaces-web:TagResource, +workspaces-web:UntagResource, +workspaces-web:ListTagsForResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +workspaces-web:GetDataProtectionSettings, +workspaces-web:ListDataProtectionSettings, +workspaces-web:DeleteDataProtectionSettings, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### List +```json +workspaces-web:ListDataProtectionSettings, +kms:Decrypt, +kms:DescribeKey +``` diff --git a/website/docs/services/workspacesweb/data_protection_settings_list_only/index.md b/website/docs/services/workspacesweb/data_protection_settings_list_only/index.md new file mode 100644 index 0000000..aa62d59 --- /dev/null +++ b/website/docs/services/workspacesweb/data_protection_settings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: data_protection_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_protection_settings_list_only + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_protection_settings in a region or regions, for all properties use data_protection_settings + +## Overview + + + + + + + +
Namedata_protection_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::DataProtectionSettings Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_protection_settings in a region. +```sql +SELECT +region, +data_protection_settings_arn +FROM aws.workspacesweb.data_protection_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_protection_settings_list_only resource, see data_protection_settings + diff --git a/website/docs/services/workspacesweb/data_protection_settings_tags/index.md b/website/docs/services/workspacesweb/data_protection_settings_tags/index.md new file mode 100644 index 0000000..800b584 --- /dev/null +++ b/website/docs/services/workspacesweb/data_protection_settings_tags/index.md @@ -0,0 +1,91 @@ +--- +title: data_protection_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_protection_settings_tags + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_protection_settings in a region + +## Overview + + + + + + + +
Namedata_protection_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::DataProtectionSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_protection_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +creation_date, +customer_managed_key, +data_protection_settings_arn, +description, +display_name, +inline_redaction_configuration, +tag_key, +tag_value +FROM aws.workspacesweb.data_protection_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_protection_settings_tags resource, see data_protection_settings + diff --git a/website/docs/services/workspacesweb/identity_provider_tags/index.md b/website/docs/services/workspacesweb/identity_provider_tags/index.md new file mode 100644 index 0000000..747db27 --- /dev/null +++ b/website/docs/services/workspacesweb/identity_provider_tags/index.md @@ -0,0 +1,85 @@ +--- +title: identity_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - identity_provider_tags + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for identity_providers in a region + +## Overview + + + + + + + +
Nameidentity_provider_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::IdentityProvider Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all identity_providers in a region. +```sql +SELECT +region, +identity_provider_arn, +identity_provider_details, +identity_provider_name, +identity_provider_type, +portal_arn, +tag_key, +tag_value +FROM aws.workspacesweb.identity_provider_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_provider_tags resource, see identity_providers + diff --git a/website/docs/services/workspacesweb/identity_providers/index.md b/website/docs/services/workspacesweb/identity_providers/index.md new file mode 100644 index 0000000..5972184 --- /dev/null +++ b/website/docs/services/workspacesweb/identity_providers/index.md @@ -0,0 +1,242 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an identity_provider resource or lists identity_providers in a region + +## Overview + + + + + + + +
Nameidentity_providers
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::IdentityProvider Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
string
array
stringAWS region.
+ +For more information, see AWS::WorkSpacesWeb::IdentityProvider. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all identity_providers in a region. +```sql +SELECT +region, +identity_provider_arn, +identity_provider_details, +identity_provider_name, +identity_provider_type, +portal_arn, +tags +FROM aws.workspacesweb.identity_providers +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual identity_provider. +```sql +SELECT +region, +identity_provider_arn, +identity_provider_details, +identity_provider_name, +identity_provider_type, +portal_arn, +tags +FROM aws.workspacesweb.identity_providers +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new identity_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.identity_providers ( + IdentityProviderDetails, + IdentityProviderName, + IdentityProviderType, + region +) +SELECT +'{{ IdentityProviderDetails }}', + '{{ IdentityProviderName }}', + '{{ IdentityProviderType }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.identity_providers ( + IdentityProviderDetails, + IdentityProviderName, + IdentityProviderType, + PortalArn, + Tags, + region +) +SELECT + '{{ IdentityProviderDetails }}', + '{{ IdentityProviderName }}', + '{{ IdentityProviderType }}', + '{{ PortalArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: identity_provider + props: + - name: IdentityProviderDetails + value: {} + - name: IdentityProviderName + value: '{{ IdentityProviderName }}' + - name: IdentityProviderType + value: '{{ IdentityProviderType }}' + - name: PortalArn + value: '{{ PortalArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspacesweb.identity_providers +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +workspaces-web:ListIdentityProviders +``` diff --git a/website/docs/services/workspacesweb/identity_providers_list_only/index.md b/website/docs/services/workspacesweb/identity_providers_list_only/index.md new file mode 100644 index 0000000..446b81d --- /dev/null +++ b/website/docs/services/workspacesweb/identity_providers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: identity_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_providers_list_only + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_providers in a region or regions, for all properties use identity_providers + +## Overview + + + + + + + +
Nameidentity_providers_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::IdentityProvider Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_providers in a region. +```sql +SELECT +region, +identity_provider_arn +FROM aws.workspacesweb.identity_providers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_providers_list_only resource, see identity_providers + diff --git a/website/docs/services/workspacesweb/index.md b/website/docs/services/workspacesweb/index.md new file mode 100644 index 0000000..f095848 --- /dev/null +++ b/website/docs/services/workspacesweb/index.md @@ -0,0 +1,62 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +The workspacesweb service documentation. + +:::info Service Summary + +
+
+total resources: 27
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/workspacesweb/ip_access_settings/index.md b/website/docs/services/workspacesweb/ip_access_settings/index.md new file mode 100644 index 0000000..09297f3 --- /dev/null +++ b/website/docs/services/workspacesweb/ip_access_settings/index.md @@ -0,0 +1,273 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an ip_access_setting resource or lists ip_access_settings in a region + +## Overview + + + + + + + +
Nameip_access_settings
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
string
string
array
array
stringAWS region.
+ +For more information, see AWS::WorkSpacesWeb::IpAccessSettings. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all ip_access_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +creation_date, +customer_managed_key, +description, +display_name, +ip_access_settings_arn, +ip_rules, +tags +FROM aws.workspacesweb.ip_access_settings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual ip_access_setting. +```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 region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ip_access_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.ip_access_settings ( + IpRules, + region +) +SELECT +'{{ IpRules }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.ip_access_settings ( + AdditionalEncryptionContext, + CustomerManagedKey, + Description, + DisplayName, + IpRules, + Tags, + region +) +SELECT + '{{ AdditionalEncryptionContext }}', + '{{ CustomerManagedKey }}', + '{{ Description }}', + '{{ DisplayName }}', + '{{ IpRules }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: ip_access_setting + props: + - name: AdditionalEncryptionContext + value: {} + - name: CustomerManagedKey + value: '{{ CustomerManagedKey }}' + - name: Description + value: '{{ Description }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: IpRules + value: + - IpRange: '{{ IpRange }}' + Description: '{{ Description }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspacesweb.ip_access_settings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the ip_access_settings resource, the following permissions are required: + +### Create +```json +workspaces-web:CreateIpAccessSettings, +workspaces-web:GetIpAccessSettings, +workspaces-web:ListIpAccessSettings, +workspaces-web:ListTagsForResource, +workspaces-web:TagResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt, +kms:GenerateDataKeyWithoutPlaintext, +kms:ReEncryptTo, +kms:ReEncryptFrom +``` + +### 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 +``` + +### List +```json +workspaces-web:ListIpAccessSettings +``` diff --git a/website/docs/services/workspacesweb/ip_access_settings_list_only/index.md b/website/docs/services/workspacesweb/ip_access_settings_list_only/index.md new file mode 100644 index 0000000..681c937 --- /dev/null +++ b/website/docs/services/workspacesweb/ip_access_settings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: ip_access_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ip_access_settings_list_only + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ip_access_settings in a region or regions, for all properties use ip_access_settings + +## Overview + + + + + + + +
Nameip_access_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ip_access_settings in a region. +```sql +SELECT +region, +ip_access_settings_arn +FROM aws.workspacesweb.ip_access_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ip_access_settings_list_only resource, see ip_access_settings + diff --git a/website/docs/services/workspacesweb/ip_access_settings_tags/index.md b/website/docs/services/workspacesweb/ip_access_settings_tags/index.md new file mode 100644 index 0000000..5dbf72c --- /dev/null +++ b/website/docs/services/workspacesweb/ip_access_settings_tags/index.md @@ -0,0 +1,91 @@ +--- +title: ip_access_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ip_access_settings_tags + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ip_access_settings in a region + +## Overview + + + + + + + +
Nameip_access_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ip_access_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +creation_date, +customer_managed_key, +description, +display_name, +ip_access_settings_arn, +ip_rules, +tag_key, +tag_value +FROM aws.workspacesweb.ip_access_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ip_access_settings_tags resource, see ip_access_settings + diff --git a/website/docs/services/workspacesweb/network_settings/index.md b/website/docs/services/workspacesweb/network_settings/index.md new file mode 100644 index 0000000..43eaff4 --- /dev/null +++ b/website/docs/services/workspacesweb/network_settings/index.md @@ -0,0 +1,239 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a network_setting resource or lists network_settings in a region + +## Overview + + + + + + + +
Namenetwork_settings
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::NetworkSettings Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
array
string
array
array
array
string
stringAWS region.
+ +For more information, see AWS::WorkSpacesWeb::NetworkSettings. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all network_settings in a region. +```sql +SELECT +region, +associated_portal_arns, +network_settings_arn, +security_group_ids, +subnet_ids, +tags, +vpc_id +FROM aws.workspacesweb.network_settings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual network_setting. +```sql +SELECT +region, +associated_portal_arns, +network_settings_arn, +security_group_ids, +subnet_ids, +tags, +vpc_id +FROM aws.workspacesweb.network_settings +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.network_settings ( + SecurityGroupIds, + SubnetIds, + VpcId, + region +) +SELECT +'{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ VpcId }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.network_settings ( + SecurityGroupIds, + SubnetIds, + Tags, + VpcId, + region +) +SELECT + '{{ SecurityGroupIds }}', + '{{ SubnetIds }}', + '{{ Tags }}', + '{{ VpcId }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: network_setting + props: + - name: SecurityGroupIds + value: + - '{{ SecurityGroupIds[0] }}' + - name: SubnetIds + value: + - '{{ SubnetIds[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: VpcId + value: '{{ VpcId }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspacesweb.network_settings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the network_settings resource, the following permissions are required: + +### Create +```json +workspaces-web:CreateNetworkSettings, +workspaces-web:GetNetworkSettings, +workspaces-web:ListTagsForResource, +workspaces-web:TagResource +``` + +### 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 +``` + +### List +```json +workspaces-web:ListNetworkSettings +``` diff --git a/website/docs/services/workspacesweb/network_settings_list_only/index.md b/website/docs/services/workspacesweb/network_settings_list_only/index.md new file mode 100644 index 0000000..2419486 --- /dev/null +++ b/website/docs/services/workspacesweb/network_settings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_settings_list_only + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_settings in a region or regions, for all properties use network_settings + +## Overview + + + + + + + +
Namenetwork_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::NetworkSettings Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_settings in a region. +```sql +SELECT +region, +network_settings_arn +FROM aws.workspacesweb.network_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_settings_list_only resource, see network_settings + diff --git a/website/docs/services/workspacesweb/network_settings_tags/index.md b/website/docs/services/workspacesweb/network_settings_tags/index.md new file mode 100644 index 0000000..7824b58 --- /dev/null +++ b/website/docs/services/workspacesweb/network_settings_tags/index.md @@ -0,0 +1,85 @@ +--- +title: network_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_settings_tags + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_settings in a region + +## Overview + + + + + + + +
Namenetwork_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::NetworkSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
array
string
array
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_settings in a region. +```sql +SELECT +region, +associated_portal_arns, +network_settings_arn, +security_group_ids, +subnet_ids, +vpc_id, +tag_key, +tag_value +FROM aws.workspacesweb.network_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_settings_tags resource, see network_settings + diff --git a/website/docs/services/workspacesweb/portal_tags/index.md b/website/docs/services/workspacesweb/portal_tags/index.md new file mode 100644 index 0000000..4c6e5b6 --- /dev/null +++ b/website/docs/services/workspacesweb/portal_tags/index.md @@ -0,0 +1,117 @@ +--- +title: portal_tags +hide_title: false +hide_table_of_contents: false +keywords: + - portal_tags + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for portals in a region + +## Overview + + + + + + + +
Nameportal_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
string
string
string
number
string
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all portals in a region. +```sql +SELECT +region, +additional_encryption_context, +authentication_type, +browser_settings_arn, +browser_type, +creation_date, +customer_managed_key, +data_protection_settings_arn, +display_name, +instance_type, +ip_access_settings_arn, +max_concurrent_sessions, +network_settings_arn, +portal_arn, +portal_endpoint, +portal_status, +renderer_type, +service_provider_saml_metadata, +status_reason, +trust_store_arn, +user_access_logging_settings_arn, +user_settings_arn, +tag_key, +tag_value +FROM aws.workspacesweb.portal_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the portal_tags resource, see portals + diff --git a/website/docs/services/workspacesweb/portals/index.md b/website/docs/services/workspacesweb/portals/index.md new file mode 100644 index 0000000..51736bb --- /dev/null +++ b/website/docs/services/workspacesweb/portals/index.md @@ -0,0 +1,415 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a portal resource or lists portals in a region + +## Overview + + + + + + + +
Nameportals
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
string
string
string
number
string
string
string
string
string
string
string
array
string
string
string
stringAWS region.
+ +For more information, see AWS::WorkSpacesWeb::Portal. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all portals in a region. +```sql +SELECT +region, +additional_encryption_context, +authentication_type, +browser_settings_arn, +browser_type, +creation_date, +customer_managed_key, +data_protection_settings_arn, +display_name, +instance_type, +ip_access_settings_arn, +max_concurrent_sessions, +network_settings_arn, +portal_arn, +portal_endpoint, +portal_status, +renderer_type, +service_provider_saml_metadata, +status_reason, +tags, +trust_store_arn, +user_access_logging_settings_arn, +user_settings_arn +FROM aws.workspacesweb.portals +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual portal. +```sql +SELECT +region, +additional_encryption_context, +authentication_type, +browser_settings_arn, +browser_type, +creation_date, +customer_managed_key, +data_protection_settings_arn, +display_name, +instance_type, +ip_access_settings_arn, +max_concurrent_sessions, +network_settings_arn, +portal_arn, +portal_endpoint, +portal_status, +renderer_type, +service_provider_saml_metadata, +status_reason, +tags, +trust_store_arn, +user_access_logging_settings_arn, +user_settings_arn +FROM aws.workspacesweb.portals +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new portal resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.portals ( + AdditionalEncryptionContext, + AuthenticationType, + BrowserSettingsArn, + CustomerManagedKey, + DataProtectionSettingsArn, + DisplayName, + InstanceType, + IpAccessSettingsArn, + MaxConcurrentSessions, + NetworkSettingsArn, + Tags, + TrustStoreArn, + UserAccessLoggingSettingsArn, + UserSettingsArn, + region +) +SELECT +'{{ AdditionalEncryptionContext }}', + '{{ AuthenticationType }}', + '{{ BrowserSettingsArn }}', + '{{ CustomerManagedKey }}', + '{{ DataProtectionSettingsArn }}', + '{{ DisplayName }}', + '{{ InstanceType }}', + '{{ IpAccessSettingsArn }}', + '{{ MaxConcurrentSessions }}', + '{{ NetworkSettingsArn }}', + '{{ Tags }}', + '{{ TrustStoreArn }}', + '{{ UserAccessLoggingSettingsArn }}', + '{{ UserSettingsArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.portals ( + AdditionalEncryptionContext, + AuthenticationType, + BrowserSettingsArn, + CustomerManagedKey, + DataProtectionSettingsArn, + DisplayName, + InstanceType, + IpAccessSettingsArn, + MaxConcurrentSessions, + NetworkSettingsArn, + Tags, + TrustStoreArn, + UserAccessLoggingSettingsArn, + UserSettingsArn, + region +) +SELECT + '{{ AdditionalEncryptionContext }}', + '{{ AuthenticationType }}', + '{{ BrowserSettingsArn }}', + '{{ CustomerManagedKey }}', + '{{ DataProtectionSettingsArn }}', + '{{ DisplayName }}', + '{{ InstanceType }}', + '{{ IpAccessSettingsArn }}', + '{{ MaxConcurrentSessions }}', + '{{ NetworkSettingsArn }}', + '{{ Tags }}', + '{{ TrustStoreArn }}', + '{{ UserAccessLoggingSettingsArn }}', + '{{ UserSettingsArn }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: portal + props: + - name: AdditionalEncryptionContext + value: {} + - name: AuthenticationType + value: '{{ AuthenticationType }}' + - name: BrowserSettingsArn + value: '{{ BrowserSettingsArn }}' + - name: CustomerManagedKey + value: '{{ CustomerManagedKey }}' + - name: DataProtectionSettingsArn + value: '{{ DataProtectionSettingsArn }}' + - name: DisplayName + value: '{{ DisplayName }}' + - name: InstanceType + value: '{{ InstanceType }}' + - name: IpAccessSettingsArn + value: '{{ IpAccessSettingsArn }}' + - name: MaxConcurrentSessions + value: null + - name: NetworkSettingsArn + value: '{{ NetworkSettingsArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: TrustStoreArn + value: '{{ TrustStoreArn }}' + - name: UserAccessLoggingSettingsArn + value: '{{ UserAccessLoggingSettingsArn }}' + - name: UserSettingsArn + value: '{{ UserSettingsArn }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspacesweb.portals +WHERE data__Identifier = '' +AND 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:AssociateBrowserSettings, +workspaces-web:AssociateIpAccessSettings, +workspaces-web:AssociateNetworkSettings, +workspaces-web:AssociateTrustStore, +workspaces-web:AssociateUserAccessLoggingSettings, +workspaces-web:AssociateUserSettings, +workspaces-web:AssociateDataProtectionSettings, +workspaces-web:List*, +workspaces-web:TagResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt, +kms:GenerateDataKeyWithoutPlaintext, +kms:ReEncryptTo, +kms:ReEncryptFrom, +ec2:CreateNetworkInterface, +ec2:CreateNetworkInterfacePermission, +ec2:DeleteNetworkInterface, +ec2:DeleteNetworkInterfacePermission, +ec2:ModifyNetworkInterfaceAttribute, +kinesis:PutRecord, +kinesis:PutRecords, +kinesis:Describe*, +sso:CreateManagedApplicationInstance, +sso:Describe* +``` + +### Read +```json +workspaces-web:GetPortal*, +workspaces-web:List*, +kms:Decrypt, +kms:DescribeKey +``` + +### Update +```json +workspaces-web:GetPortal*, +workspaces-web:UpdatePortal, +workspaces-web:AssociateBrowserSettings, +workspaces-web:AssociateIpAccessSettings, +workspaces-web:AssociateNetworkSettings, +workspaces-web:AssociateTrustStore, +workspaces-web:AssociateUserAccessLoggingSettings, +workspaces-web:AssociateUserSettings, +workspaces-web:AssociateDataProtectionSettings, +workspaces-web:DisassociateBrowserSettings, +workspaces-web:DisassociateIpAccessSettings, +workspaces-web:DisassociateNetworkSettings, +workspaces-web:DisassociateTrustStore, +workspaces-web:DisassociateUserAccessLoggingSettings, +workspaces-web:DisassociateUserSettings, +workspaces-web:DisassociateDataProtectionSettings, +workspaces-web:List*, +workspaces-web:TagResource, +workspaces-web:UntagResource, +kms:CreateGrant, +kms:Encrypt, +kms:GenerateDataKey, +kms:Decrypt, +kms:DescribeKey, +ec2:CreateNetworkInterface, +ec2:CreateNetworkInterfacePermission, +ec2:DeleteNetworkInterface, +ec2:DeleteNetworkInterfacePermission, +ec2:ModifyNetworkInterfaceAttribute, +kinesis:PutRecord, +kinesis:PutRecords, +kinesis:Describe*, +sso:CreateManagedApplicationInstance, +sso:DeleteManagedApplicationInstance, +sso:Describe*, +sso:GetApplicationInstance, +sso:List* +``` + +### 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, +workspaces-web:DisassociateDataProtectionSettings, +kms:Decrypt, +kms:DescribeKey, +sso:DeleteManagedApplicationInstance +``` + +### List +```json +workspaces-web:List*, +kms:Decrypt, +kms:DescribeKey +``` diff --git a/website/docs/services/workspacesweb/portals_list_only/index.md b/website/docs/services/workspacesweb/portals_list_only/index.md new file mode 100644 index 0000000..b99a4ea --- /dev/null +++ b/website/docs/services/workspacesweb/portals_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: portals_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - portals_list_only + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists portals in a region or regions, for all properties use portals + +## Overview + + + + + + + +
Nameportals_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all portals in a region. +```sql +SELECT +region, +portal_arn +FROM aws.workspacesweb.portals_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the portals_list_only resource, see portals + diff --git a/website/docs/services/workspacesweb/trust_store_tags/index.md b/website/docs/services/workspacesweb/trust_store_tags/index.md new file mode 100644 index 0000000..0488f31 --- /dev/null +++ b/website/docs/services/workspacesweb/trust_store_tags/index.md @@ -0,0 +1,81 @@ +--- +title: trust_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - trust_store_tags + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for trust_stores in a region + +## Overview + + + + + + + +
Nametrust_store_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::TrustStore Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
array
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all trust_stores in a region. +```sql +SELECT +region, +associated_portal_arns, +certificate_list, +trust_store_arn, +tag_key, +tag_value +FROM aws.workspacesweb.trust_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_store_tags resource, see trust_stores + diff --git a/website/docs/services/workspacesweb/trust_stores/index.md b/website/docs/services/workspacesweb/trust_stores/index.md new file mode 100644 index 0000000..9a2849d --- /dev/null +++ b/website/docs/services/workspacesweb/trust_stores/index.md @@ -0,0 +1,227 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a trust_store resource or lists trust_stores in a region + +## Overview + + + + + + + +
Nametrust_stores
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::TrustStore Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
array
array
array
string
stringAWS region.
+ +For more information, see AWS::WorkSpacesWeb::TrustStore. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all trust_stores in a region. +```sql +SELECT +region, +associated_portal_arns, +certificate_list, +tags, +trust_store_arn +FROM aws.workspacesweb.trust_stores +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual trust_store. +```sql +SELECT +region, +associated_portal_arns, +certificate_list, +tags, +trust_store_arn +FROM aws.workspacesweb.trust_stores +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new trust_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.trust_stores ( + CertificateList, + region +) +SELECT +'{{ CertificateList }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.trust_stores ( + CertificateList, + Tags, + region +) +SELECT + '{{ CertificateList }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: trust_store + props: + - name: CertificateList + value: + - '{{ CertificateList[0] }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspacesweb.trust_stores +WHERE data__Identifier = '' +AND 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 +``` + +### 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 +``` + +### List +```json +workspaces-web:ListTrustStores, +workspaces-web:ListTrustStoreCertificates +``` diff --git a/website/docs/services/workspacesweb/trust_stores_list_only/index.md b/website/docs/services/workspacesweb/trust_stores_list_only/index.md new file mode 100644 index 0000000..b34fb59 --- /dev/null +++ b/website/docs/services/workspacesweb/trust_stores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: trust_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trust_stores_list_only + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trust_stores in a region or regions, for all properties use trust_stores + +## Overview + + + + + + + +
Nametrust_stores_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::TrustStore Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trust_stores in a region. +```sql +SELECT +region, +trust_store_arn +FROM aws.workspacesweb.trust_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_stores_list_only resource, see trust_stores + diff --git a/website/docs/services/workspacesweb/user_access_logging_settings/index.md b/website/docs/services/workspacesweb/user_access_logging_settings/index.md new file mode 100644 index 0000000..ac5b030 --- /dev/null +++ b/website/docs/services/workspacesweb/user_access_logging_settings/index.md @@ -0,0 +1,220 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_access_logging_setting resource or lists user_access_logging_settings in a region + +## Overview + + + + + + + +
Nameuser_access_logging_settings
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
array
stringKinesis stream ARN to which log events are published.
array
string
stringAWS region.
+ +For more information, see AWS::WorkSpacesWeb::UserAccessLoggingSettings. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_access_logging_settings in a region. +```sql +SELECT +region, +associated_portal_arns, +kinesis_stream_arn, +tags, +user_access_logging_settings_arn +FROM aws.workspacesweb.user_access_logging_settings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_access_logging_setting. +```sql +SELECT +region, +associated_portal_arns, +kinesis_stream_arn, +tags, +user_access_logging_settings_arn +FROM aws.workspacesweb.user_access_logging_settings +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_access_logging_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.user_access_logging_settings ( + KinesisStreamArn, + region +) +SELECT +'{{ KinesisStreamArn }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.user_access_logging_settings ( + KinesisStreamArn, + Tags, + region +) +SELECT + '{{ KinesisStreamArn }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_access_logging_setting + props: + - name: KinesisStreamArn + value: '{{ KinesisStreamArn }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspacesweb.user_access_logging_settings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the user_access_logging_settings resource, the following permissions are required: + +### Create +```json +workspaces-web:CreateUserAccessLoggingSettings, +workspaces-web:GetUserAccessLoggingSettings, +workspaces-web:ListTagsForResource, +workspaces-web:TagResource +``` + +### 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 +``` + +### List +```json +workspaces-web:ListUserAccessLoggingSettings +``` diff --git a/website/docs/services/workspacesweb/user_access_logging_settings_list_only/index.md b/website/docs/services/workspacesweb/user_access_logging_settings_list_only/index.md new file mode 100644 index 0000000..313f85f --- /dev/null +++ b/website/docs/services/workspacesweb/user_access_logging_settings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: user_access_logging_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_access_logging_settings_list_only + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_access_logging_settings in a region or regions, for all properties use user_access_logging_settings + +## Overview + + + + + + + +
Nameuser_access_logging_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_access_logging_settings in a region. +```sql +SELECT +region, +user_access_logging_settings_arn +FROM aws.workspacesweb.user_access_logging_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_access_logging_settings_list_only resource, see user_access_logging_settings + diff --git a/website/docs/services/workspacesweb/user_access_logging_settings_tags/index.md b/website/docs/services/workspacesweb/user_access_logging_settings_tags/index.md new file mode 100644 index 0000000..410b3fc --- /dev/null +++ b/website/docs/services/workspacesweb/user_access_logging_settings_tags/index.md @@ -0,0 +1,81 @@ +--- +title: user_access_logging_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_access_logging_settings_tags + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for user_access_logging_settings in a region + +## Overview + + + + + + + +
Nameuser_access_logging_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
array
stringKinesis stream ARN to which log events are published.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all user_access_logging_settings in a region. +```sql +SELECT +region, +associated_portal_arns, +kinesis_stream_arn, +user_access_logging_settings_arn, +tag_key, +tag_value +FROM aws.workspacesweb.user_access_logging_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_access_logging_settings_tags resource, see user_access_logging_settings + diff --git a/website/docs/services/workspacesweb/user_settings/index.md b/website/docs/services/workspacesweb/user_settings/index.md new file mode 100644 index 0000000..a8d48a2 --- /dev/null +++ b/website/docs/services/workspacesweb/user_settings/index.md @@ -0,0 +1,324 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets an user_setting resource or lists user_settings in a region + +## Overview + + + + + + + +
Nameuser_settings
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::UserSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
array
object
string
string
number
string
number
string
string
array
string
string
string
stringAWS region.
+ +For more information, see AWS::WorkSpacesWeb::UserSettings. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all user_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +cookie_synchronization_configuration, +copy_allowed, +customer_managed_key, +disconnect_timeout_in_minutes, +download_allowed, +idle_disconnect_timeout_in_minutes, +paste_allowed, +print_allowed, +tags, +upload_allowed, +user_settings_arn, +deep_link_allowed +FROM aws.workspacesweb.user_settings +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual user_setting. +```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, +deep_link_allowed +FROM aws.workspacesweb.user_settings +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.user_settings ( + CopyAllowed, + DownloadAllowed, + PasteAllowed, + PrintAllowed, + UploadAllowed, + region +) +SELECT +'{{ CopyAllowed }}', + '{{ DownloadAllowed }}', + '{{ PasteAllowed }}', + '{{ PrintAllowed }}', + '{{ UploadAllowed }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.workspacesweb.user_settings ( + AdditionalEncryptionContext, + CookieSynchronizationConfiguration, + CopyAllowed, + CustomerManagedKey, + DisconnectTimeoutInMinutes, + DownloadAllowed, + IdleDisconnectTimeoutInMinutes, + PasteAllowed, + PrintAllowed, + Tags, + UploadAllowed, + DeepLinkAllowed, + region +) +SELECT + '{{ AdditionalEncryptionContext }}', + '{{ CookieSynchronizationConfiguration }}', + '{{ CopyAllowed }}', + '{{ CustomerManagedKey }}', + '{{ DisconnectTimeoutInMinutes }}', + '{{ DownloadAllowed }}', + '{{ IdleDisconnectTimeoutInMinutes }}', + '{{ PasteAllowed }}', + '{{ PrintAllowed }}', + '{{ Tags }}', + '{{ UploadAllowed }}', + '{{ DeepLinkAllowed }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: user_setting + props: + - name: AdditionalEncryptionContext + value: {} + - name: CookieSynchronizationConfiguration + value: + Allowlist: + - Domain: '{{ Domain }}' + Name: '{{ Name }}' + Path: '{{ Path }}' + Blocklist: + - null + - name: CopyAllowed + value: '{{ CopyAllowed }}' + - name: CustomerManagedKey + value: '{{ CustomerManagedKey }}' + - name: DisconnectTimeoutInMinutes + value: null + - name: DownloadAllowed + value: null + - name: IdleDisconnectTimeoutInMinutes + value: null + - name: PasteAllowed + value: null + - name: PrintAllowed + value: null + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: UploadAllowed + value: null + - name: DeepLinkAllowed + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.workspacesweb.user_settings +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the user_settings resource, the following permissions are required: + +### Create +```json +workspaces-web:CreateUserSettings, +workspaces-web:GetUserSettings, +workspaces-web:ListTagsForResource, +workspaces-web:TagResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt, +kms:GenerateDataKeyWithoutPlaintext, +kms:ReEncryptTo, +kms:ReEncryptFrom +``` + +### 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 +``` + +### List +```json +workspaces-web:ListUserSettings, +kms:CreateGrant, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` diff --git a/website/docs/services/workspacesweb/user_settings_list_only/index.md b/website/docs/services/workspacesweb/user_settings_list_only/index.md new file mode 100644 index 0000000..da02198 --- /dev/null +++ b/website/docs/services/workspacesweb/user_settings_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: user_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_settings_list_only + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_settings in a region or regions, for all properties use user_settings + +## Overview + + + + + + + +
Nameuser_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::UserSettings Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_settings in a region. +```sql +SELECT +region, +user_settings_arn +FROM aws.workspacesweb.user_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_settings_list_only resource, see user_settings + diff --git a/website/docs/services/workspacesweb/user_settings_tags/index.md b/website/docs/services/workspacesweb/user_settings_tags/index.md new file mode 100644 index 0000000..9b61afd --- /dev/null +++ b/website/docs/services/workspacesweb/user_settings_tags/index.md @@ -0,0 +1,101 @@ +--- +title: user_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_settings_tags + - workspacesweb + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for user_settings in a region + +## Overview + + + + + + + +
Nameuser_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::UserSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
array
object
string
string
number
string
number
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all user_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +cookie_synchronization_configuration, +copy_allowed, +customer_managed_key, +disconnect_timeout_in_minutes, +download_allowed, +idle_disconnect_timeout_in_minutes, +paste_allowed, +print_allowed, +upload_allowed, +user_settings_arn, +deep_link_allowed, +tag_key, +tag_value +FROM aws.workspacesweb.user_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_settings_tags resource, see user_settings + diff --git a/website/docs/services/xray/group_tags/index.md b/website/docs/services/xray/group_tags/index.md new file mode 100644 index 0000000..f459d21 --- /dev/null +++ b/website/docs/services/xray/group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - group_tags + - xray + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for groups in a region + +## Overview + + + + + + + + +
Namegroup_tags
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay Group resource parameters.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe filter expression defining criteria by which to group traces.
stringThe case-sensitive name of the new group. Names must be unique.
stringThe ARN of the group that was generated on creation.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all groups in a region. +```sql +SELECT +region, +filter_expression, +group_name, +group_arn, +insights_configuration, +tag_key, +tag_value +FROM aws.xray.group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the group_tags resource, see groups + diff --git a/website/docs/services/xray/groups/index.md b/website/docs/services/xray/groups/index.md new file mode 100644 index 0000000..3d2572a --- /dev/null +++ b/website/docs/services/xray/groups/index.md @@ -0,0 +1,228 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a group resource or lists groups in a region + +## Overview + + + + + + + +
Namegroups
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay Group resource parameters.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe filter expression defining criteria by which to group traces.
stringThe case-sensitive name of the new group. Names must be unique.
stringThe ARN of the group that was generated on creation.
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::XRay::Group. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all groups in a region. +```sql +SELECT +region, +filter_expression, +group_name, +group_arn, +insights_configuration, +tags +FROM aws.xray.groups +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual group. +```sql +SELECT +region, +filter_expression, +group_name, +group_arn, +insights_configuration, +tags +FROM aws.xray.groups +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.xray.groups ( + GroupName, + region +) +SELECT +'{{ GroupName }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.xray.groups ( + FilterExpression, + GroupName, + InsightsConfiguration, + Tags, + region +) +SELECT + '{{ FilterExpression }}', + '{{ GroupName }}', + '{{ InsightsConfiguration }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: group + props: + - name: FilterExpression + value: '{{ FilterExpression }}' + - name: GroupName + value: '{{ GroupName }}' + - name: InsightsConfiguration + value: + InsightsEnabled: '{{ InsightsEnabled }}' + NotificationsEnabled: '{{ NotificationsEnabled }}' + - name: Tags + value: + - Key: '{{ Key }}' + Value: '{{ Value }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.xray.groups +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +```json +xray:CreateGroup, +xray:TagResource +``` + +### Read +```json +xray:GetGroup, +xray:ListTagsForResource +``` + +### Update +```json +xray:UpdateGroup, +xray:TagResource, +xray:UntagResource, +xray:ListTagsForResource +``` + +### Delete +```json +xray:DeleteGroup +``` + +### List +```json +xray:GetGroups, +xray:ListTagsForResource +``` diff --git a/website/docs/services/xray/groups_list_only/index.md b/website/docs/services/xray/groups_list_only/index.md new file mode 100644 index 0000000..f3eb907 --- /dev/null +++ b/website/docs/services/xray/groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - groups_list_only + - 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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists groups in a region or regions, for all properties use groups + +## Overview + + + + + + + +
Namegroups_list_only
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay Group resource parameters.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the group that was generated on creation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all groups in a region. +```sql +SELECT +region, +group_arn +FROM aws.xray.groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the groups_list_only resource, see groups + diff --git a/website/docs/services/xray/index.md b/website/docs/services/xray/index.md new file mode 100644 index 0000000..c5e298f --- /dev/null +++ b/website/docs/services/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/stackql-aws-provider-featured-image.png +--- + +The xray service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources + \ No newline at end of file diff --git a/website/docs/services/xray/resource_policies/index.md b/website/docs/services/xray/resource_policies/index.md new file mode 100644 index 0000000..522a514 --- /dev/null +++ b/website/docs/services/xray/resource_policies/index.md @@ -0,0 +1,212 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a resource_policy resource or lists resource_policies in a region + +## Overview + + + + + + + +
Nameresource_policies
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the resource policy. Must be unique within a specific AWS account.
stringThe resource policy document, which can be up to 5kb in size.
booleanA flag to indicate whether to bypass the resource policy lockout safety check
stringAWS region.
+ +For more information, see AWS::XRay::ResourcePolicy. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all resource_policies in a region. +```sql +SELECT +region, +policy_name, +policy_document, +bypass_policy_lockout_check +FROM aws.xray.resource_policies +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual resource_policy. +```sql +SELECT +region, +policy_name, +policy_document, +bypass_policy_lockout_check +FROM aws.xray.resource_policies +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.xray.resource_policies ( + PolicyName, + PolicyDocument, + region +) +SELECT +'{{ PolicyName }}', + '{{ PolicyDocument }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.xray.resource_policies ( + PolicyName, + PolicyDocument, + BypassPolicyLockoutCheck, + region +) +SELECT + '{{ PolicyName }}', + '{{ PolicyDocument }}', + '{{ BypassPolicyLockoutCheck }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: resource_policy + props: + - name: PolicyName + value: '{{ PolicyName }}' + - name: PolicyDocument + value: '{{ PolicyDocument }}' + - name: BypassPolicyLockoutCheck + value: '{{ BypassPolicyLockoutCheck }}' + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.xray.resource_policies +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +xray:PutResourcePolicy, +xray:ListResourcePolicies +``` + +### Read +```json +xray:ListResourcePolicies +``` + +### Update +```json +xray:PutResourcePolicy, +xray:ListResourcePolicies +``` + +### Delete +```json +xray:DeleteResourcePolicy +``` + +### List +```json +xray:ListResourcePolicies +``` diff --git a/website/docs/services/xray/resource_policies_list_only/index.md b/website/docs/services/xray/resource_policies_list_only/index.md new file mode 100644 index 0000000..6c91a91 --- /dev/null +++ b/website/docs/services/xray/resource_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - xray + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the resource policy. Must be unique within a specific AWS account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +policy_name +FROM aws.xray.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + diff --git a/website/docs/services/xray/sampling_rule_tags/index.md b/website/docs/services/xray/sampling_rule_tags/index.md new file mode 100644 index 0000000..edbda0f --- /dev/null +++ b/website/docs/services/xray/sampling_rule_tags/index.md @@ -0,0 +1,85 @@ +--- +title: sampling_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - sampling_rule_tags + - xray + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sampling_rules in a region + +## Overview + + + + + + + +
Namesampling_rule_tags
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
object
object
stringThe ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
stringThe ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sampling_rules in a region. +```sql +SELECT +region, +sampling_rule, +sampling_rule_record, +sampling_rule_update, +rule_arn, +rule_name, +tag_key, +tag_value +FROM aws.xray.sampling_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sampling_rule_tags resource, see sampling_rules + diff --git a/website/docs/services/xray/sampling_rules/index.md b/website/docs/services/xray/sampling_rules/index.md new file mode 100644 index 0000000..182423a --- /dev/null +++ b/website/docs/services/xray/sampling_rules/index.md @@ -0,0 +1,261 @@ +--- +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/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes or gets a sampling_rule resource or lists sampling_rules in a region + +## Overview + + + + + + + +
Namesampling_rules
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
object
object
stringThe ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
stringThe ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +For more information, see AWS::XRay::SamplingRule. + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
INSERT
DELETE
UPDATE
SELECT
SELECT
+ +## `SELECT` examples +Gets all sampling_rules in a region. +```sql +SELECT +region, +sampling_rule, +sampling_rule_record, +sampling_rule_update, +rule_arn, +rule_name, +tags +FROM aws.xray.sampling_rules +WHERE region = 'us-east-1'; +``` +Gets all properties from an individual sampling_rule. +```sql +SELECT +region, +sampling_rule, +sampling_rule_record, +sampling_rule_update, +rule_arn, +rule_name, +tags +FROM aws.xray.sampling_rules +WHERE region = 'us-east-1' AND data__Identifier = ''; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new sampling_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). + + + + +```sql +/*+ create */ +INSERT INTO aws.xray.sampling_rules ( + SamplingRule, + SamplingRuleRecord, + SamplingRuleUpdate, + RuleName, + Tags, + region +) +SELECT +'{{ SamplingRule }}', + '{{ SamplingRuleRecord }}', + '{{ SamplingRuleUpdate }}', + '{{ RuleName }}', + '{{ Tags }}', +'{{ region }}'; +``` + + + +```sql +/*+ create */ +INSERT INTO aws.xray.sampling_rules ( + SamplingRule, + SamplingRuleRecord, + SamplingRuleUpdate, + RuleName, + Tags, + region +) +SELECT + '{{ SamplingRule }}', + '{{ SamplingRuleRecord }}', + '{{ SamplingRuleUpdate }}', + '{{ RuleName }}', + '{{ Tags }}', + '{{ region }}'; +``` + + + +```yaml +version: 1 +name: stack name +description: stack description +providers: + - aws +globals: + - name: region + value: '{{ vars.AWS_REGION }}' +resources: + - name: sampling_rule + props: + - name: SamplingRule + value: + SamplingRule: null + SamplingRuleRecord: + CreatedAt: '{{ CreatedAt }}' + ModifiedAt: '{{ ModifiedAt }}' + SamplingRule: null + SamplingRuleUpdate: + Attributes: {} + FixedRate: null + Host: '{{ Host }}' + HTTPMethod: '{{ HTTPMethod }}' + Priority: '{{ Priority }}' + ReservoirSize: '{{ ReservoirSize }}' + ResourceARN: '{{ ResourceARN }}' + RuleARN: '{{ RuleARN }}' + RuleName: '{{ RuleName }}' + ServiceName: '{{ ServiceName }}' + ServiceType: '{{ ServiceType }}' + URLPath: '{{ URLPath }}' + RuleName: null + Tags: + - Key: '{{ Key }}' + Value: '{{ Value }}' + - name: SamplingRuleRecord + value: null + - name: SamplingRuleUpdate + value: null + - name: RuleName + value: null + - name: Tags + value: null + +``` + + + +## `DELETE` example + +```sql +/*+ delete */ +DELETE FROM aws.xray.sampling_rules +WHERE data__Identifier = '' +AND region = 'us-east-1'; +``` + +## Permissions + +To operate on the sampling_rules resource, the following permissions are required: + +### Create +```json +xray:CreateSamplingRule, +xray:TagResource +``` + +### Read +```json +xray:GetSamplingRules, +xray:ListTagsForResource +``` + +### Update +```json +xray:UpdateSamplingRule, +xray:TagResource, +xray:UntagResource, +xray:ListTagsForResource +``` + +### Delete +```json +xray:DeleteSamplingRule +``` + +### List +```json +xray:GetSamplingRules, +xray:ListTagsForResource +``` diff --git a/website/docs/services/xray/sampling_rules_list_only/index.md b/website/docs/services/xray/sampling_rules_list_only/index.md new file mode 100644 index 0000000..1e147f7 --- /dev/null +++ b/website/docs/services/xray/sampling_rules_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: sampling_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sampling_rules_list_only + - xray + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/stackql-aws-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sampling_rules in a region or regions, for all properties use sampling_rules + +## Overview + + + + + + + +
Namesampling_rules_list_only
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
stringAWS region.
+ +## Methods + + + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sampling_rules in a region. +```sql +SELECT +region, +rule_arn +FROM aws.xray.sampling_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sampling_rules_list_only resource, see sampling_rules + diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js new file mode 100644 index 0000000..3bcca20 --- /dev/null +++ b/website/docusaurus.config.js @@ -0,0 +1,232 @@ +// @ts-check +// `@type` JSDoc annotations allow editor autocompletion and type checking +// (when paired with `@ts-check`). +// There are various equivalent ways to declare your Docusaurus config. +// See: https://docusaurus.io/docs/api/docusaurus-config + +import {themes as prismThemes} from 'prism-react-renderer'; + +// Provider configuration - change these for different providers +const providerName = "aws"; +const providerTitle = "AWS"; + +const providerDropDownListItems = [ + { + label: 'AWS', + to: '/providers/aws', + }, + { + label: 'Azure', + to: '/providers/azure', + }, + { + label: 'Google', + to: '/providers/google', + }, + { + label: 'Databricks', + to: '/providers/databricks', + }, + { + label: 'Snowflake', + to: '/providers/snowflake', + }, + { + label: 'Confluent', + to: '/providers/confluent', + }, + { + label: 'Okta', + to: '/providers/okta', + }, + { + label: 'GitHub', + to: '/providers/github', + }, + { + label: 'OpenAI', + to: '/providers/openai', + }, + { + label: '... More', + to: '/providers', + }, +]; + +const footerStackQLItems = [ + { + label: 'Documentation', + to: '/stackqldocs', + }, + { + label: 'Install', + to: '/install', + }, + { + label: 'Contact us', + to: '/contact-us', + }, +]; + +const footerMoreItems = [ + { + label: 'Providers', + to: '/providers', + }, + { + label: 'stackql-deploy', + to: '/stackql-deploy', + }, + { + label: 'Blog', + to: '/blog', + }, + { + label: 'Tutorials', + to: '/tutorials', + }, +]; + +// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) + +/** @type {import('@docusaurus/types').Config} */ +const config = { + title: `StackQL ${providerTitle} Provider`, + tagline: `Query and Provision ${providerTitle} Resources using StackQL`, + favicon: 'img/favicon.ico', + staticDirectories: ['static'], + // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future + future: { + v4: true, // Improve compatibility with the upcoming Docusaurus v4 + }, + + // Set the production url of your site here + url: `https://${providerName}-provider.stackql.io`, + // Set the // pathname under which your site is served + // For GitHub pages deployment, it is often '//' + baseUrl: '/', + + // GitHub pages deployment config. + // If you aren't using GitHub pages, you don't need these. + organizationName: 'stackql', // Usually your GitHub org/user name. + projectName: `stackql-provider-${providerName}`, // Usually your repo name. + + onBrokenLinks: 'warn', + onBrokenMarkdownLinks: 'warn', + + // Even if you don't use internationalization, you can use this field to set + // useful metadata like html lang. For example, if your site is Chinese, you + // may want to replace "en" with "zh-Hans". + i18n: { + defaultLocale: 'en', + locales: ['en'], + }, + + presets: [ + [ + 'classic', + /** @type {import('@docusaurus/preset-classic').Options} */ + ({ + docs: { + sidebarPath: './sidebars.js', + // Please change this to your repo. + // Remove this to remove the "edit this page" links. + // editUrl: 'https://github.com/stackql/stackql-deploy/tree/main/website/', + routeBasePath: '/', // Set the docs to be the root of the site + }, + theme: { + customCss: './src/css/custom.css', + }, + }), + ], + ], + + themeConfig: + /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ + ({ + // Replace with your project's social card + image: 'img/stackql-cover.png', + navbar: { + logo: { + alt: 'StackQL Registry', + href: '/providers', + src: 'img/stackql-registry-logo.svg', + srcDark: 'img/stackql-registry-logo-white.svg', + }, + items: [ + { + to: '/install', + position: 'left', + label: 'Install', + }, + { + to: '/stackql-deploy', + position: 'left', + label: 'stackql-deploy', + }, + { + to: '/providers', + type: 'dropdown', + label: 'Providers', + position: 'left', + items: providerDropDownListItems, + }, + { + type: 'dropdown', + label: 'More', + position: 'left', + items: [ + { + to: '/stackqldocs', + label: 'StackQL Docs', + }, + { + to: '/blog', + label: 'Blog', + }, + { + to: '/tutorials', + label: 'Tutorials', + }, + ], + }, + { + href: 'https://github.com/stackql/stackql', + position: 'right', + className: 'header-github-link', + 'aria-label': 'GitHub repository', + }, + ], + }, + footer: { + style: 'dark', + logo: { + alt: 'StackQL', + href: '/providers', + src: 'img/stackql-registry-logo.svg', + srcDark: 'img/stackql-registry-logo-white.svg', + }, + links: [ + { + title: 'StackQL', + items: footerStackQLItems, + }, + { + title: 'More', + items: footerMoreItems, + }, + ], + copyright: `© ${new Date().getFullYear()} StackQL Studios`, + }, + colorMode: { + // using user system preferences, instead of the hardcoded defaultMode + respectPrefersColorScheme: true, + }, + prism: { + theme: prismThemes.nightOwl, + darkTheme: prismThemes.dracula, + }, + }), +}; + +export default config; diff --git a/website/package.json b/website/package.json new file mode 100644 index 0000000..8f57f6c --- /dev/null +++ b/website/package.json @@ -0,0 +1,51 @@ +{ + "name": "website", + "version": "0.0.0", + "private": true, + "scripts": { + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids" + }, + "dependencies": { + "@docusaurus/core": "3.8.1", + "@docusaurus/preset-classic": "3.8.1", + "@emotion/react": "^11.14.0", + "@emotion/styled": "^11.14.1", + "@iconify/react": "^6.0.0", + "@mdx-js/react": "^3.0.0", + "@mui/icons-material": "^7.3.1", + "@mui/material": "^7.3.1", + "clipboard": "^2.0.11", + "clsx": "^2.0.0", + "prism-react-renderer": "^2.3.0", + "react": "^19.0.0", + "react-dom": "^19.0.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "3.8.1", + "@docusaurus/types": "3.8.1" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 3 chrome version", + "last 3 firefox version", + "last 5 safari version" + ] + }, + "engines": { + "node": ">=18.0" + }, + "license": "MIT" +} diff --git a/website/sidebars.js b/website/sidebars.js new file mode 100644 index 0000000..72e3166 --- /dev/null +++ b/website/sidebars.js @@ -0,0 +1,43 @@ +// @ts-check + +// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) + +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + + @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} + */ + +import config from './docusaurus.config'; + +const providerTitle = config.title.replace(/^StackQL /, '').replace(/ Provider$/, ''); + + const sidebars = { + mainSidebar: [ + { + type: 'link', + label: 'All Providers', + href: '/providers', + }, + { + type: 'category', + label: `${providerTitle} Provider`, + link: {type: 'doc', id: 'provider-intro'}, + items: [ + { + type: 'autogenerated', + dirName: 'services', + } + ] + }, + ], +}; + +export default sidebars; diff --git a/website/src/components/CopyableCode/CopyableCode.js b/website/src/components/CopyableCode/CopyableCode.js new file mode 100644 index 0000000..8115f33 --- /dev/null +++ b/website/src/components/CopyableCode/CopyableCode.js @@ -0,0 +1,29 @@ +import React, { useState } from 'react'; +import Clipboard from 'clipboard'; + +const CopyableCode = ({ code }) => { + const [isCopied, setIsCopied] = useState(false); + + const handleCopy = () => { + const clipboard = new Clipboard('.copyable-code', { + text: () => code, + }); + + clipboard.on('success', function() { + setIsCopied(true); + window.setTimeout(() => setIsCopied(false), 2000); + clipboard.destroy(); + }); + }; + + return ( + + + {code} + + {isCopied ? Copied! : null} + + ); +}; + +export default CopyableCode; diff --git a/website/src/components/HomepageFeatures/index.js b/website/src/components/HomepageFeatures/index.js new file mode 100644 index 0000000..acc7621 --- /dev/null +++ b/website/src/components/HomepageFeatures/index.js @@ -0,0 +1,64 @@ +import clsx from 'clsx'; +import Heading from '@theme/Heading'; +import styles from './styles.module.css'; + +const FeatureList = [ + { + title: 'Easy to Use', + Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default, + description: ( + <> + Docusaurus was designed from the ground up to be easily installed and + used to get your website up and running quickly. + + ), + }, + { + title: 'Focus on What Matters', + Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default, + description: ( + <> + Docusaurus lets you focus on your docs, and we'll do the chores. Go + ahead and move your docs into the docs directory. + + ), + }, + { + title: 'Powered by React', + Svg: require('@site/static/img/undraw_docusaurus_react.svg').default, + description: ( + <> + Extend or customize your website layout by reusing React. Docusaurus can + be extended while reusing the same header and footer. + + ), + }, +]; + +function Feature({Svg, title, description}) { + return ( +
+
+ +
+
+ {title} +

{description}

+
+
+ ); +} + +export default function HomepageFeatures() { + return ( +
+
+
+ {FeatureList.map((props, idx) => ( + + ))} +
+
+
+ ); +} diff --git a/website/src/components/HomepageFeatures/styles.module.css b/website/src/components/HomepageFeatures/styles.module.css new file mode 100644 index 0000000..b248eb2 --- /dev/null +++ b/website/src/components/HomepageFeatures/styles.module.css @@ -0,0 +1,11 @@ +.features { + display: flex; + align-items: center; + padding: 2rem 0; + width: 100%; +} + +.featureSvg { + height: 200px; + width: 200px; +} diff --git a/website/src/css/custom.css b/website/src/css/custom.css new file mode 100644 index 0000000..ce0b531 --- /dev/null +++ b/website/src/css/custom.css @@ -0,0 +1,259 @@ +@import url('https://fonts.googleapis.com/css2?family=Montserrat:wght@400;500;700&display=swap'); + +/* +* Brand Colour +*/ +:root { + --gamma-blue: #0f4c81; + --gamma-medium-blue: #6c83aa; + /* Blues */ + --gamma-dark-blue: #004165; + --gamma-light-blue: #b5bfd4; + --code-blue: #00f; + /* Grey scale */ + --default-text: #2e3940; + --secondary-text: #718096; + --black: #000; + --white: #fff; + --grey-1: #f5f6f7; + --grey-2: #ebedef; + /* Dark Mode Blacks */ + --dark-1: #606264; + --dark-2: #404244; + --black-2: #090909; + --light-black: #111; + /* Colours */ + --default-green: #00af91; + --secondary-green: #43af43; + --default-red: #e94560; + --default-red-2: #fc91a2; + --default-blue: #2e3940; + --default-light-blue: #bfc2ff; + --default-blue-2: #1a1a2e; + --secondary-blue: #16213e; + --gamma-dark: #030760; +} + +:root { + /* infima styling */ + --ifm-font-family-base: 'Montserrat', sans-serif; + --ifm-font-size-base: 16px; + --ifm-code-font-size: 95%; + --ifm-background-color: var(--white); + --ifm-color-primary: var(--gamma-dark-blue); + --ifm-code-color: var(--code-blue); + --ifm-color-content: #2d3748; + --ifm-dropdown-link-color: var(--ifm-menu-color); + --ifm-navbar-link-color: var(--ifm-menu-color); + --ifm-menu-color-background-active: var(--ifm-color-emphasis-200); +} + +[data-theme='dark'] { + --ifm-font-base-color: #dee0f2; + --ifm-color-content: var(--ifm-font-base-color); + --ifm-navbar-link-hover-color: var(--gamma-light-blue); + --ifm-link-color: var(--gamma-light-blue); + --ifm-menu-color-active: var(--gamma-light-blue); + --ifm-color-primary: var(--white); + --ifm-background-color: var(--black); + --ifm-footer-background-color: var(--black-2); + --ifm-navbar-background-color: var(--black); + --ifm-menu-color-background-active: #21243d; + --ifm-code-color: var(--white); +} + +/* +* copyable code +*/ +.copyable-code-container code { + cursor: pointer; + position: relative; +} + +/* +* github +*/ + .header-github-link:before { + content: ''; + width: 140px; + height: 28px; + display: flex; + background-image: url("https://img.shields.io/github/stars/stackql/stackql?logo=github&style=social"); + background-repeat: no-repeat; + background-position: center; + background-size: contain; +} + +.header-github-link:hover { + opacity: 0.6; +} + +/* +* footer +*/ +:root .footer--dark { + background-color: transparent; + --ifm-footer-color: var(--secondary-text); + --ifm-footer-link-color: var(--secondary-text); + --ifm-footer-title-color: var(--black-2); +} +:root .footer .footerLogoLink_src-theme-Footer- { + opacity: 1; +} +:root .footer .divider { + background-color: rgba(0, 0, 0, 0.12); +} +:root .footer .container { + background-color: var(--grey-1); +} +:root a code { + color: var(--ifm-code-color); +} + +html[data-theme='dark'] .footer--dark { + --ifm-footer-background-color: transparent; + --ifm-footer-color: #bdbdbd; + --ifm-footer-link-color: #bdbdbd; + --ifm-footer-title-color: var(--white); +} +html[data-theme='dark'] .footer .divider { + background-color: var(--secondary-blue); +} +html[data-theme='dark'] .footer .container { + background-color: var(--black-2); +} + +.footer__items { + font-weight: 400; + line-height: 1.43; + font-size: 0.875rem; +} +.footer__items .footer__link-item:hover { + text-decoration: none; +} +.footer__title { + font-weight: 700; + margin-bottom: 0; + line-height: 1.43; + font-size: 0.875rem; +} +.footer { + padding-bottom: 0; +} +.footer .container { + margin: 0 auto; + padding: 56px 80px; + max-width: 850px; + border-radius: 17px; +} +.divider { + width: 100%; + margin: 40px 0px; + border: none; + height: 1px; + flex-shrink: 0; +} +.footer__subtitle { + font-weight: 500; + line-height: 1.57; + font-size: 0.875rem; +} +.footer__logo { + margin-top: 0; +} + +.footerSocialIcon { + font-size: 24px; + margin: 0 12px; +} + + .footerSocialIconButton { + padding: 0; + color: 'rgba(255,255,255,.6)'; + } + + .footerSocialIconButton:hover { + background: 'transparent'; + color: 'rgba(255,255,255,.6)'; + } + + .footer__items { + list-style-type: none; + margin: 0; + padding: 0; + } + +/* +* custom styles +*/ +code { + font-weight: bold; +} +table { + display: block; + max-width: -moz-fit-content; + max-width: fit-content; + margin: 0 auto; + overflow-x: auto; + white-space: nowrap; +} + +/* +* nav bar +*/ + +.navbar__item { + font-weight: 700; +} +.navbar__link { + font-weight: 700; +} + +/* +* doc field headings +*/ + +:root .docFieldHeading { + color: #0000FF; +} + +html[data-theme='dark'] .docFieldHeading { + color: #FFFFFF; +} + +/* +* vhs image +*/ + +.vhsImage { + max-width: 60%; /* Reduce width to 80% of container */ + display: block; /* Ensure it's a block element for margin auto to work */ + margin: 40px auto; /* Add 40px space above/below and center horizontally */ + transform: scale(0.9); /* Make it 90% of original size */ + transform-origin: center; /* Scale from center */ +} + +/* Add more space before and after the image container */ +img[class="vhsImage"] { + margin-top: 40px; + margin-bottom: 40px; +} + +/* If the image is inside a container, you might need this */ +.vhsImage-container, +div:has(> .vhsImage) { + margin: 40px 0; +} + +/* provider doc column */ +.providerDocColumn { + width: calc(50% - var(--ifm-spacing-horizontal)); + float: left; + padding-left: var(--ifm-list-margin); +} + +@media screen and (max-width: 600px) { + .providerDocColumn { + width: 100%; + } + } \ No newline at end of file diff --git a/website/src/pages/blog.js b/website/src/pages/blog.js new file mode 100644 index 0000000..e435012 --- /dev/null +++ b/website/src/pages/blog.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Blog() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/contact-us.js b/website/src/pages/contact-us.js new file mode 100644 index 0000000..b6850d8 --- /dev/null +++ b/website/src/pages/contact-us.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function ConactUs() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/install.js b/website/src/pages/install.js new file mode 100644 index 0000000..341a4bb --- /dev/null +++ b/website/src/pages/install.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Install() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/providers/aws.js b/website/src/pages/providers/aws.js new file mode 100644 index 0000000..780099a --- /dev/null +++ b/website/src/pages/providers/aws.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Registry() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/providers/azure.js b/website/src/pages/providers/azure.js new file mode 100644 index 0000000..467f77a --- /dev/null +++ b/website/src/pages/providers/azure.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Registry() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/providers/confluent.js b/website/src/pages/providers/confluent.js new file mode 100644 index 0000000..e886aaf --- /dev/null +++ b/website/src/pages/providers/confluent.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Registry() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/providers/databricks.js b/website/src/pages/providers/databricks.js new file mode 100644 index 0000000..a04b603 --- /dev/null +++ b/website/src/pages/providers/databricks.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Registry() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/providers/github.js b/website/src/pages/providers/github.js new file mode 100644 index 0000000..b425c6c --- /dev/null +++ b/website/src/pages/providers/github.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Registry() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/providers/google.js b/website/src/pages/providers/google.js new file mode 100644 index 0000000..01fe8b7 --- /dev/null +++ b/website/src/pages/providers/google.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Registry() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/providers/index.js b/website/src/pages/providers/index.js new file mode 100644 index 0000000..9afaa02 --- /dev/null +++ b/website/src/pages/providers/index.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Providers() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/providers/okta.js b/website/src/pages/providers/okta.js new file mode 100644 index 0000000..cdddc72 --- /dev/null +++ b/website/src/pages/providers/okta.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Registry() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/providers/openai.js b/website/src/pages/providers/openai.js new file mode 100644 index 0000000..9884c84 --- /dev/null +++ b/website/src/pages/providers/openai.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Registry() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/providers/snowflake.js b/website/src/pages/providers/snowflake.js new file mode 100644 index 0000000..7b3ec43 --- /dev/null +++ b/website/src/pages/providers/snowflake.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Registry() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/stackql-deploy.js b/website/src/pages/stackql-deploy.js new file mode 100644 index 0000000..95e18b3 --- /dev/null +++ b/website/src/pages/stackql-deploy.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Deploy() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/stackqldocs.js b/website/src/pages/stackqldocs.js new file mode 100644 index 0000000..7182d93 --- /dev/null +++ b/website/src/pages/stackqldocs.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function StackQLDocs() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/pages/tutorials.js b/website/src/pages/tutorials.js new file mode 100644 index 0000000..2bb5f07 --- /dev/null +++ b/website/src/pages/tutorials.js @@ -0,0 +1,10 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; + +export default function Tutorials() { + return ( + + + + ); +}; \ No newline at end of file diff --git a/website/src/theme/Footer/Copyright/index.tsx b/website/src/theme/Footer/Copyright/index.tsx new file mode 100644 index 0000000..ab1657d --- /dev/null +++ b/website/src/theme/Footer/Copyright/index.tsx @@ -0,0 +1,20 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import React from 'react'; +import type {Props} from '@theme/Footer/Copyright'; + +export default function FooterCopyright({copyright}: Props): JSX.Element { + return ( +
+ ); +} diff --git a/website/src/theme/Footer/Layout/index.tsx b/website/src/theme/Footer/Layout/index.tsx new file mode 100644 index 0000000..bb22f31 --- /dev/null +++ b/website/src/theme/Footer/Layout/index.tsx @@ -0,0 +1,34 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import React from 'react'; +import clsx from 'clsx'; +import type {Props} from '@theme/Footer/Layout'; + +export default function FooterLayout({ + style, + links, + logo, + copyright, +}: Props): JSX.Element { + return ( +
+
+ {links} + {(logo || copyright) && ( +
+ {logo &&
{logo}
} + {copyright} +
+ )} +
+
+ ); +} diff --git a/website/src/theme/Footer/LinkItem/index.tsx b/website/src/theme/Footer/LinkItem/index.tsx new file mode 100644 index 0000000..44e1517 --- /dev/null +++ b/website/src/theme/Footer/LinkItem/index.tsx @@ -0,0 +1,36 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import React from 'react'; + +import Link from '@docusaurus/Link'; +import useBaseUrl from '@docusaurus/useBaseUrl'; +import isInternalUrl from '@docusaurus/isInternalUrl'; +import IconExternalLink from '@theme/Icon/ExternalLink'; +import type {Props} from '@theme/Footer/LinkItem'; + +export default function FooterLinkItem({item}: Props): JSX.Element { + const {to, href, label, prependBaseUrlToHref, ...props} = item; + const toUrl = useBaseUrl(to); + const normalizedHref = useBaseUrl(href, {forcePrependBaseUrl: true}); + + return ( + + {label} + {href && !isInternalUrl(href) && } + + ); +} diff --git a/website/src/theme/Footer/Links/MultiColumn/index.tsx b/website/src/theme/Footer/Links/MultiColumn/index.tsx new file mode 100644 index 0000000..2239e8c --- /dev/null +++ b/website/src/theme/Footer/Links/MultiColumn/index.tsx @@ -0,0 +1,51 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import React from 'react'; +import LinkItem from '@theme/Footer/LinkItem'; +import type {Props} from '@theme/Footer/Links/MultiColumn'; + +type ColumnType = Props['columns'][number]; +type ColumnItemType = ColumnType['items'][number]; + +function ColumnLinkItem({item}: {item: ColumnItemType}) { + return item.html ? ( +
  • + ) : ( +
  • + +
  • + ); +} + +function Column({column}: {column: ColumnType}) { + return ( +
    +
    {column.title}
    +
      + {column.items.map((item, i) => ( + + ))} +
    +
    + ); +} + +export default function FooterLinksMultiColumn({columns}: Props): JSX.Element { + return ( +
    + {columns.map((column, i) => ( + + ))} +
    + ); +} diff --git a/website/src/theme/Footer/Links/Simple/index.tsx b/website/src/theme/Footer/Links/Simple/index.tsx new file mode 100644 index 0000000..e14b77f --- /dev/null +++ b/website/src/theme/Footer/Links/Simple/index.tsx @@ -0,0 +1,42 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import React from 'react'; +import LinkItem from '@theme/Footer/LinkItem'; +import type {Props} from '@theme/Footer/Links/Simple'; + +function Separator() { + return ·; +} + +function SimpleLinkItem({item}: {item: Props['links'][number]}) { + return item.html ? ( + + ) : ( + + ); +} + +export default function FooterLinksSimple({links}: Props): JSX.Element { + return ( +
    +
    + {links.map((item, i) => ( + + + {links.length !== i + 1 && } + + ))} +
    +
    + ); +} diff --git a/website/src/theme/Footer/Links/index.tsx b/website/src/theme/Footer/Links/index.tsx new file mode 100644 index 0000000..a4b0f33 --- /dev/null +++ b/website/src/theme/Footer/Links/index.tsx @@ -0,0 +1,21 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import React from 'react'; + +import {isMultiColumnFooterLinks} from '@docusaurus/theme-common'; +import FooterLinksMultiColumn from '@theme/Footer/Links/MultiColumn'; +import FooterLinksSimple from '@theme/Footer/Links/Simple'; +import type {Props} from '@theme/Footer/Links'; + +export default function FooterLinks({links}: Props): JSX.Element { + return isMultiColumnFooterLinks(links) ? ( + + ) : ( + + ); +} diff --git a/website/src/theme/Footer/Logo/index.tsx b/website/src/theme/Footer/Logo/index.tsx new file mode 100644 index 0000000..ebd8e9f --- /dev/null +++ b/website/src/theme/Footer/Logo/index.tsx @@ -0,0 +1,46 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import React from 'react'; +import clsx from 'clsx'; +import Link from '@docusaurus/Link'; +import {useBaseUrlUtils} from '@docusaurus/useBaseUrl'; +import ThemedImage from '@theme/ThemedImage'; +import type {Props} from '@theme/Footer/Logo'; + +import styles from './styles.module.css'; + +function LogoImage({logo}: Props) { + const {withBaseUrl} = useBaseUrlUtils(); + const sources = { + light: withBaseUrl(logo.src), + dark: withBaseUrl(logo.srcDark ?? logo.src), + }; + return ( + + ); +} + +export default function FooterLogo({logo}: Props): JSX.Element { + return logo.href ? ( + + + + ) : ( + + ); +} diff --git a/website/src/theme/Footer/Logo/styles.module.css b/website/src/theme/Footer/Logo/styles.module.css new file mode 100644 index 0000000..16b1a2e --- /dev/null +++ b/website/src/theme/Footer/Logo/styles.module.css @@ -0,0 +1,16 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +.footerLogoLink { + opacity: 0.5; + transition: opacity var(--ifm-transition-fast) + var(--ifm-transition-timing-default); +} + +.footerLogoLink:hover { + opacity: 1; +} diff --git a/website/src/theme/Footer/index.tsx b/website/src/theme/Footer/index.tsx new file mode 100644 index 0000000..99ba9d5 --- /dev/null +++ b/website/src/theme/Footer/index.tsx @@ -0,0 +1,262 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import React from 'react'; +import clsx from 'clsx'; + +import Link from '@docusaurus/Link'; +import {FooterLinkItem, useThemeConfig} from '@docusaurus/theme-common'; +import useBaseUrl from '@docusaurus/useBaseUrl'; +import isInternalUrl from '@docusaurus/isInternalUrl'; +import styles from './styles.module.css'; +import ThemedImage, {Props as ThemedImageProps} from '@theme/ThemedImage'; +import IconExternalLink from '@theme/Icon/ExternalLink'; +import { IconButton } from '@mui/material'; +import { useColorMode } from '@docusaurus/theme-common'; + +import { Icon } from '@iconify/react'; + +// add for responsive logo image +import { useWindowSize } from '@docusaurus/theme-common'; + +// Custom styles to fix the spacing issue +const socialIconsContainerStyle: React.CSSProperties = { + display: 'flex', + justifyContent: 'center', + alignItems: 'center', + flexWrap: 'wrap', // Allow wrapping on small screens + margin: '16px 0', +}; + +const iconButtonStyle = { + padding: '12px', // Ensure buttons have enough clickable area +}; + +function FooterLink({ + to, + href, + label, + prependBaseUrlToHref, + ...props +}: FooterLinkItem) { + const toUrl = useBaseUrl(to); + const normalizedHref = useBaseUrl(href, {forcePrependBaseUrl: true}); + + return ( + + {href && !isInternalUrl(href) ? ( + + {label} + + + ) : ( + label + )} + + ); +} + +const FooterLogo = ({ + sources, + alt, + width, + height, + logo, +}: Pick & { logo: any }) => { + // Get window width for responsiveness + const windowSize = useWindowSize(); + + // Set threshold for mobile view (e.g., 768px) + const isMobile = windowSize === 'mobile' ? true : false; + + const getMobileLogoPath = (path: string) => path?.replace('.svg', '-mobile.svg'); + + // Choose appropriate image sources based on screen size + // const responsiveSources = { + // light: useBaseUrl(isMobile ? getMobileLogoPath(logo.src) : logo.src), + // dark: useBaseUrl(isMobile ? getMobileLogoPath(logo.srcDark || logo.src) : (logo.srcDark || logo.src)), + // }; + const responsiveSources = { + light: useBaseUrl(isMobile ? getMobileLogoPath(logo?.src) : logo?.src), + dark: useBaseUrl(isMobile ? getMobileLogoPath(logo?.srcDark || logo?.src) : (logo?.srcDark || logo?.src)), + }; + + return ( + + ); +} + +function Footer(): JSX.Element | null { + const socialLinks = { + linkedin: "https://www.linkedin.com/company/stackql", + twitter: "https://twitter.com/stackql", + github: "https://github.com/stackql", + discord: "https://discord.com/invite/xVXZ9d5NxN", + slack: "https://join.slack.com/t/stackqlcommunity/shared_invite/zt-1cbdq9s5v-CkY65IMAesCgFqjN6FU6hg", + }; + + const {colorMode} = useColorMode(); + + const {footer} = useThemeConfig(); + + const {copyright, links = [], logo = { src: '' }} = footer || {}; + const sources = { + light: useBaseUrl(logo.src), + dark: useBaseUrl(logo.srcDark || logo.src), + }; + + if (!footer) { + return null; + } + + return ( +
    +
    + {links && links.length > 0 && ( +
    +
    + {logo && (logo.src || logo.srcDark) && ( +
    + {logo.href ? ( + + + + ) : ( + + )} +
    + )} +

    + A new approach to querying and
    + provisioning cloud services. +

    +
    + {links.map((linkItem, i) => ( +
    + {linkItem.title != null ? ( +

    {linkItem.title}

    + ) : null} + {linkItem.items != null && + Array.isArray(linkItem.items) && + linkItem.items.length > 0 ? ( +
      + {linkItem.items.map((item, key) => + item.html ? ( +
    • + ) : ( +
    • + +
    • + ), + )} +
    + ) : null} +
    + ))} +
    + )} +
    + {(logo || copyright) && ( + <> +
    + {copyright ? ( +
    + ) : null} +
    + {/* Social Icons Container with Fixed Spacing */} +
    + + + + + + + + + + + + + + + +
    + + )} +
    +
    + ); +} + +export default Footer; \ No newline at end of file diff --git a/website/src/theme/Footer/styles.module.css b/website/src/theme/Footer/styles.module.css new file mode 100644 index 0000000..92e3c3b --- /dev/null +++ b/website/src/theme/Footer/styles.module.css @@ -0,0 +1,16 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +.footerLogoLink { + opacity: 1; + transition: opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default); +} + +.footerLogoLink:hover { + opacity: 0.5; +} + diff --git a/website/src/theme/Logo/index.d.ts b/website/src/theme/Logo/index.d.ts new file mode 100644 index 0000000..786099f --- /dev/null +++ b/website/src/theme/Logo/index.d.ts @@ -0,0 +1,9 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ +import { type ReactNode } from 'react'; +import type { Props } from '@theme/Logo'; +export default function Logo(props: Props): ReactNode; diff --git a/website/src/theme/Logo/index.js b/website/src/theme/Logo/index.js new file mode 100644 index 0000000..d0b73e2 --- /dev/null +++ b/website/src/theme/Logo/index.js @@ -0,0 +1,76 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ +import React from 'react'; +import Link from '@docusaurus/Link'; +import useBaseUrl from '@docusaurus/useBaseUrl'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import {useThemeConfig, useWindowSize} from '@docusaurus/theme-common'; +import ThemedImage from '@theme/ThemedImage'; +function LogoThemedImage({logo, alt, imageClassName}) { +// Add window size detection + const windowSize = useWindowSize(); + + // Determine if on mobile + const isMobile = windowSize === 'mobile'; + + // Function to generate mobile logo path + const getMobileLogoPath = (path) => path?.replace('.svg', '-mobile.svg'); + + // Get appropriate logo sources based on device + const sources = { + light: useBaseUrl(isMobile ? getMobileLogoPath(logo.src) : logo.src), + dark: useBaseUrl(isMobile ? getMobileLogoPath(logo.srcDark || logo.src) : (logo.srcDark || logo.src)), + }; + const themedImage = ( + + ); + // Is this extra div really necessary? + // introduced in https://github.com/facebook/docusaurus/pull/5666 + return imageClassName ? ( +
    {themedImage}
    + ) : ( + themedImage + ); +} +export default function Logo(props) { + const { + siteConfig: {title}, + } = useDocusaurusContext(); + const { + navbar: {title: navbarTitle, logo}, + } = useThemeConfig(); + const {imageClassName, titleClassName, ...propsRest} = props; + const logoLink = useBaseUrl(logo?.href || '/'); + // If visible title is shown, fallback alt text should be + // an empty string to mark the logo as decorative. + const fallbackAlt = navbarTitle ? '' : title; + // Use logo alt text if provided (including empty string), + // and provide a sensible fallback otherwise. + const alt = logo?.alt ?? fallbackAlt; + return ( + + {logo && ( + + )} + {navbarTitle != null && {navbarTitle}} + + ); +} diff --git a/website/static/.nojekyll b/website/static/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/website/static/CNAME b/website/static/CNAME new file mode 100644 index 0000000..1f7a4f5 --- /dev/null +++ b/website/static/CNAME @@ -0,0 +1 @@ +snowflake-provider.stackql.io diff --git a/website/static/img/favicon-16x16.png b/website/static/img/favicon-16x16.png new file mode 100644 index 0000000000000000000000000000000000000000..178c10711387dbff479e5b5d2fa6966ee4c540b3 GIT binary patch literal 872 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!63?wyl`GbKJOS+@4BLl<6e(pbstU$g(vPY0F z14ES>14Ba#1H&(%P{RubhEf9thF1v;3|2E37{m+a>`T@Ck7(s%#9%Yz)b6 zEUj(~%4`hFZgfv+@}!4j(%Kk>69%8&fnd8=5}8HhV3VAOj~!%Id6uvf0LMZL({z7J5Jn4?O3fA z(dm@fq!`j>n9#2h+U}Uxq#V@r|NsBS>FYRvfhblIG z%v{JRkdTy?FmZ|#)1@^$MnRiSH1GyH_;`i+$(;xaVBy|i+;LJ{bM=YUr&g`Z&d54> zs)&JgOKHj1FHd<(c(3+6abyaLk~*fgYgyVev1wt~xD*&8U0tQ4t*hDH)zigYCp4^{ zy}Nz+^zHrY=kGW3=w4OnkPuMdkr7eRvWzJ}AxQgFOju}`nH5_KXMjSOR~X|H2G$N{ zOUb0I0WqhJ9?Cy&nOiTJ zTUc4xd$I_#u!2j2$>9`c<;@`qr*B+2apcSqnIr6{8$1?x=`p+#7cBYYWI7dS1%s!n KpUXO@geCwPM^2Og literal 0 HcmV?d00001 diff --git a/website/static/img/favicon-32x32.png b/website/static/img/favicon-32x32.png new file mode 100644 index 0000000000000000000000000000000000000000..f1efee03ab3cbef83577a5b041c102fb9d599fe9 GIT binary patch literal 1533 zcmZ`%dpwj`82(Uchjz8tNl{ZFmeHsPT{ap&cO%BNW*f$kA~Tv{#wFkR$X!?>*DfpD zg?2C%)-|lz&@Rm)^HUl>>qo6?|Gm1Jn#EF=Z|v|ogA&UV76l*2-;#} zO>{;PC*7On&`c~&`W=N0{^kzm5LBL~AokuUZPKir9Uv%N8-n0i2wFiYcnX5p1PGd@ zLXg>Y2*NT7YEB)6AlYOmd$Q#i4~|8^l^B2kX+%eZOW}YM2>|>rgVvFkKeu4u86+*( z5gm7sxY(fHE37zP*| z5W)qven8h1(R4wy$cQ!>*+)hQo`_o@u=4|Ij)=rn@&K(t&C z0}qr3ny&F?{#oiyF<5(8$1};qFB5AI3_X!;_Q1?PvwKi<`$>mAyKv{JSbJ7s@5r0$ zzqVNh=Ni#62F7RB*VpG4K9)6fyGQ-Jha88sgNebpuV)vg=NF5sI!R$Sb~#_M4#_X9 ze75*;xmwWY6L(MBJ<*ACqon5f%)7;Ri%aECgiP<%YWO+sWxUKhluVhu*=%eSZJ!$JZ8Fc+SJGi-PXmn~`*DEO?xvai( zU~y^L)GrfHNo8hKw04gyEw2iMqj*Zn{vT6WS(VRv##UCv5{V@FPQwmTOjKS~*MLYY zUK6iLghNxHsK(eg!t!z%CNayyv&}P>>Q$w}hZD;22tjbBVhU z3idc7=h@(Z7joz{qUVMjJBv660Cf_w`xN342uvsl-W|z#B(op=ulg)!M;8>KusccBM) zmW_j@{KTejs8nzI3-e7i;f%)TO@9a)Tg!r}35qEx-i0v)=4)^-PLF}vqL7x5l61A4{~;w+ zA&q2hA5uwlqt4_Ne2Xp0%Ptxfsify#(@6m!5eP-s$Cgxb$?x zt!nOgiSfR9dj69@N(HCu@!XK3^(c?#&slo-D&lBiVBOMNh2dywKlzDlRyxa+GsQdN z(J?3JqP3A)RB#pxnoi)(s;>WCk0#mm7lzpaCR3!J?me2Qbdsn_Y^tuT%8V(S6|gn6yDX7}v<=ZnWH_twmRL zH8OGPJpnl|@j-qNti4Yt64&$5C)Z+Gda!)GS#&d62pt9J0O0@uPcX(C8j%SH%?O5O zhQ@k?17-xmkrr^_KZ2lO-vB@E{|jt$O?y#+dpOyHM-?TM=rmJ#&?_JtOGn~E3o7ytz75d- literal 0 HcmV?d00001 diff --git a/website/static/img/favicon.ico b/website/static/img/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..0145fbfbd5b887d60a9edca52036888a7d3cbd0d GIT binary patch literal 15086 zcmeHOX>?Ro5^l#CJ@aSAIdc>o(20nsFerM|;|!ysqXS})Eri8ELVyHF!X5}DguahO z!j6P}7eqlpQG~DvVMq2o5SAn?VF?KkLK3po)K{-xr#s#0yoLtCIrKS|`}*bGcfVV= zs&3t?YK!F&%cGWh^(@@_S-yS2VtLDAvH1DfzCU5HoaTE^aEt$U{k_F9f**K^pW!Z+ zAST?GPffjX_g7i1k1>6yl$xrPwvFka59kQLBb6!52Xuh3#WTh?n11It2mbz~vZ^uM zUQyAJr22)D>J{Vz>OiVTJ5muopgx^R#SAE6oT-d6l<6_df!javy;&+YrbKlQAT6*C zY0aJ`t!Z`N(5KZ%^940~hP1ZzNc9dT#(aY**oHqs4T;TFA^tkvCQtKtf2*9-q$+7G zo+pL1P%4S%P@CoQkm}c!wC2w-=1Pp+;3?+t*_)&WM;Ec&MDsj~RcI5^Dl^{=>_*GH zR{g_y4YXgBbqHx4-)H0poslFk=zgZ1o{6P&KJp8bc2L6r@@!wO~gZw<` z{CAZ92Tp#f>-(4?{|}u0GJg0szz_Qw{DDXNqx`Fqx&!;FcyCeuReWck*|#ahZzZks zf8FB8xZ^t1qo3pZ(WH=n@-x8U-99m_`Lp!H*l?N`)trX6_&ZrKk2~Ef&EjXQle_+# zZe(4e%=4#d)8g?oHLL**ZCcGVKY{u9Z)+$&=Q;@Y93eq~l+$_vgR)xi@$|t7*v>ohh!(i_#zK?3MjBi=W>+ z_VZWh#O`%eRB+3V0T(&fGHCy=i|MQA02&eST)F%l+N?SyE*e9**;k$V7v9RFl!IGn z`Gj6HrhQ$JOVc`L62HNdQSEBe_oKSnjCw*5li4(&iATfg9zpTk@D z(VWO8v}@%&%Fevt)W4{(fX*lHqg69vXhQHCVkaupF)#6BeIX|!18dSEtvwyt@-yY- zTyw%vkav?#?MZ>$6C25^jM=|}SiwWNJ(zoDF~mkkKgLe9=4?V?|%44`pAuQ3js zze>+T25;j->kC$3E@te;2Xo50kS24S-t$A&F+O)W^q1?~#qaPQ%wrgz>1Ou%n11_d zmgqGz)PNzF&K=uBlS2RH*5>Ma%F`k<2`oG3PwXeilH=z_=0#e{a_h1VKEQAA1n-7D zof7sQZTx1e$c2I7R&I{iDa_S)zHAGf#aza=e}#S=--A*QZKL9%LgN*@Mk8g-o%;C_ zKV<5YDs0nh&^N3bXOni@$2Nl>xMY6JgJ}^T(4N%`oowCu1z+41{Dw}CYWFfN9o>yi z?pe>a>82e!F0y(3p|39MFLJ2s6848V{hQG4Rr6hJQ*ludt(qR=Q~btykNf;p@hj4f z>~P{2aOYgR!h6FKn$LR!@Hwu%G4BxpHE6-$*0Lwx%+5kL`={_$zR1x}6MKs-bMZHB zLw*c>o7nj+T0PrJ=_e05$tiUAdd7L$xuWdetlJ&~cU+rVv}8mu9ovyW`8Tuem~nB7 z_vYlCYw5d@U1(I>mxS-==Qw}4_6EQ7uSS!*y(9Z*#@Q28Qe12wx1^+4e51`vCeqaK z_ucwNShF$z`-kY~>HV9iAV1gM9~ao04{iK`zP7fr`$leY8}`pEe#Q~O)%^q56f^#oBmT>2$7#dDIN=F!xwlKDd$n8an1fmVGhd;vdlDAX;^7_HKdV)~ zP8qx@(*i%v4Qp8EP5WnM-r+J2llakZDEkP&AZzT-7F0M^HSw>-?s||j7mS|X>ji$V z-dpaNZfsz=&-zY&e1qKt9&hKuHcjSFIR4PkZT#VZ zz^^pYLOJ*1E8X%|7H;c#2mT9w*H$OFTEqE4W1DCbX|&q?=JK0M%u4-;6M)S!NhU(J;qYV6=bB{|5-z6OjB zxudXF$iZhYHDs#Fb4ZZ7hoJZL+5yZF_Ovn)hSlq zTmw<0`g9@{@`>(KATQu63Te#yB=0j`lRqK9uEN`pis}izXEWAu-2MgFjSqjX#`lM_ zKBTZ*ah-=1&-#v(g1+4@m2lrorUb?m$n-}8_cdJn*9W zhkw1`fECX&|BN;f-Q zF4eeqV*>}q|BQ1&kcG(Z_hEeI^?e<`63o9H$LIzROm@Hiw!FLf!D5)0e#^m*g0q1XkpyE}uCr&mw+(a_nvB3+c4oS`q zxy1C72Pk1?tW&%YIkNb!^(Fq9aVA+}*~r(OIl7Zp#7AOg$e-Er zDR>{=i#Rc2{Tsd>E%8>p=0UGRK^!w-#$ZZ6ae#9eMVt@dSo-P1v}TTyc&RZrkrBK6 zIj_I{8Jnztf8e8$k2)dwC_PtxDK$xA^jHV<(=k`!b*f9q(WD;SD)D73PTJuedOja> zH!=URIDlbD<0oa#$F{GM^+tYTT7+vJ%=*bwEQ3!;9R2ix&GPJ3j;$MUUT?<7+`xlL zA#c;V`NQc_%28b&IG35i^RvGb^Jk2}J*E4*oHHFqSI(W}^(qz_PTIbbMsvM^$fJq* z%ez>%riM2l4N;5bYj;! z&O3#OO|kQ|g7J}inAxWh?c{ot>??X*19GOvcC4nwBZ4W;9&fKIwJLL?n$g}hi=_4g zs6 zpVu3?dE^0iulh=CYkBoJ;QQ=;{scYP{=+o$c^ePoBVGZ!4;x%z4v61_y#lg{wKe3= zzRrBl?X}18(TDdm_$cM|cf8Nmq8rVn9@AouL^>BP%e;fa!BXhOZY)8QpcWZSw?uq}8-x>@$ z%yp&-5|=@oQZN9=T_lW+SXV?_#4aW=)n`3SQi$WUdRg}c;g5Pl0jxh9gQ}Qb)PL&| z9>`~(nDsn%4ci&`T|SQ{szH4V)qo!4HL(suk4#ZaR3^uh=JD9IFm@tG4Xk=3=AK4l zFeb)EoC0A9KPG#ef`4mP_M-+x2C4AC<18yTn6jOz@eS4G<6NdZTWehBaa@688c|L8 zjGwMG_w!!H@w=XgcKh_-lH8t-s8Ihb=`V5(KhgC)`aReCqLU%$k6P@fCFhO$3fwpR zPF&;6V4Rm+bh%68EG-y*BF+}Cvmdic>MW*l4VA_|7JS9Eb2O>l!FdO@JWgjATYu;! zY9(j(ZX~sRs43gIVh+vXT0i*d@b^#cOO$gHYTn>83x0?G_zu4Tgt{EmAftvEK2Pk& zf0bHO`0zKcXG%R1p3@xrGY?QV03T=f%K386fPV;|40A)xAZmF~3yd?Q@YR?<>pn1{ zHU{Sj)b*i$2>bWcd z#4qdST4Ms7GFSe;@XWF8(kM&o^by}LM?M^%b$8vl;T`v9{kbT=AN1BXv(Bloz+-Hi idZ}*BG9ZWU=|ep>kDR{)sjz@F_7mD$@4z~t@Bab!?d6{U literal 0 HcmV?d00001 diff --git a/website/static/img/stackql-aws-provider-featured-image.png b/website/static/img/stackql-aws-provider-featured-image.png new file mode 100644 index 0000000000000000000000000000000000000000..efbdac70106439b5b051d844d3f72ccd749159cf GIT binary patch literal 36181 zcmeFYi8qvQA3xqEMbamxg;1$vDU~&h2_a-RV~ZhM_Uy}8%2rt`4cV8n&0xkdWSx*D zYnEZ`$(D5t#$aa5_x60A@Av%vhTnOdsT| zJT^FT(0l=>r@Cr-)bmA4Xh;2$yW zr3Tk8dy|X3e3R!c1wZ7{=F*r-=7^$#Q!GbKg;2NE95`Z@V_ndpJ_PqzvA$p zdH7#(_+N4O|HWQF(uTQ$I1XRtDUA@N*Yj%~)nU!bgW1k~>yt@|i8i2mEy{$`L7s9X z+XsP@=PK&y$IKh-OG@DQe&4xybA9~}ewm=rbugmXvo#u4<7tOBD#|4kS#&KAm$;Ug zNm6^Imi@~4{zVx-G-igPkO@_GS&n8G8UQib{FI)Dc8qCb$Yw?ME*4Tc2=*qKwL5 zcT)GlS0(x`y$IJ?=cQkKw1iAfcJHg-O>Lm8`={0Y_8M;tegoHs_REimpu)-`P_0i) zuIL+dmm#Qb%q!#b7Njv;7iT?>bg{#mDo4BH`bW0OeT7D)?kr?oNMI9p6~F&5jgPhGQv zG}?X^c#${wF>jg}%n7mMm2od)yMMwv@EHnL^4!%7S7~@M{e?Pz|HIw*@cQ;Wh+WuRT9w~RAuF@UYZ_BBQ-ksP0~L1WLA8K_@YkaKv8`XVE)u8^kPHd zivmawb+xHrEJa19?Dg^eAAC;)eNF-R{K%23_x3ZWt8fh7&M?2Hvc$aF6o-PAc+P81 zLxaCM-@{}6Vzt9vpy7lP^Y*(6?uCpQV;LIFu*5!5C&|171^JeMbgMx9G*a^F-;h{) z$4X*roQ)@Q6^wC)ZhGOD)n9AuvCT73>EZ9Ds_FD&yxyJyi1|_VaMHK=*Xm4beBBn4 zK3i?j8toBzKVWaqceUTbb+vFY99%@+m}OQX1orA&$0}Q$hC6W4Q){1|raK2(`siB~ zFIL&d@knR8i`S9Ix>h%O`NFc4^UwVUpWhz5aOa@&fRrP&N?_K{a;BnTMSo;o#qSV3 zK8REdb(nz!N0@W!J2ZJWwnnZ-a$><~%|#14j^z>dogeBdy|@)=B0PktRkzTo72c3i zuw+Z%^}*(A^R$AxK?Srb>)Bg%GpSvxe$`Ad;!4!0*Tpf923@LX>-nPV1C_8yS$0T< z70zk+%ubZU9Qw;@lzGTvs0CPNBr9ZPY%hQ7X%2a3Enqkw%8po`siW(0rYQYq^<_Ub zz!9?6L%v@KCFAB{=miAk{vE#6II_9HYPYORj*-*Z~TEBYF?bkHYIHMJ{?>Ae!#qA=(}QNeb_ zMdpFk2H#h%#D|A0=##K`!+sQQeP}SmpP(IL_a1f)4J$znf{bZj#!=(X>R{UVCEAh$ z^Osxg8Yl3$gKOUeO9~4+1bzr<5~SFUOkI`{CME`anYywFvc`z;lMRBjb%Q{wE>*M@}#}d3bS20|*@~+C0VuoI1jNgS>tR=X8$+ud@J#U^{ z8YX`}2%!iL#Qdk`JW9dZPX@}DFJ7%%aKLXO_==n~!UtT~N;GqYU#7BACptpSNv{`K z5H0%m3vzL8gl3GSW)y0|GH4Id1hW_ZZCc~h zQ=gBn|Js1f)opk3u2oG>9j+ZJtfWHHfyY#Jf(bmhVJKeqz!o2NOUxnDBN}we)FXFcBC9u(*Tru5hwxyD zvW|cIE0K)0xGWwQyQwsHyaN<{L)zyaDjVC;3#M&bi9USeCqLR2n4sHol0p{_AJvJG z@6N3L1z$b7^lx3u9;#bk#FKed9h~RYi@m2kz0jlicg)xRa_O+|+#+o&F-o$tuP!-8 zpht?U?WT**?AZ2xauhI|zmY$(rbTsa?Ih$xMg9D|M=mD8wzMKL7whX4czuU2H)Z~K zG4>*PR=28Wifr;F(5>hp)f?g++7_F2WmQS;zx$D5B%E_=%`P%9u*9Nns<-xcrUYToKNKKM<&@|lffmp43s+w#s%}-(tD91wJ;Flw%7Q+qW zWlgX@asu+--GeM~P6PukOI64HB^1;-{La_o|7nr03|vP_C-Xcze>WLnGMy8rncw+? zRt1_eZ9i4mBq&Y*`vBx3l&?A8DIH>9uaX%SraX@IFucvcL>pd}o@aFH3iHZ%Xf}&- zs?8%3`mq%s(-i&39zw8u0ei4KClKkcaAdtaPV{Hv%eS2Wy<-U$Ti6|GoJ)I#apS9_ z82gQ-;#R^N-tqeGTt2W#ITNXnQu^KCyCF_<6V17fHfYt9_6b}#E(T48>g3iw9c1-+ z=)CdWN|!!V%xFolH+93IggG(Z=D6>#QhU*!E{nY#s&LWzVd~C$+(ZEu*_4coz5e|e zum@kss-EmYFpichXYk2yx~x>Kge)bPmp%d6p1dyJGE9f8<^ z?G6B6Xv)oLMe$%lDU=7H(9Xxgrv?!U`#FUA$XG6JXR4iVQ`Eew(ysxTT?5 zs$3=)vJBB9rCWVvo>Lys0v%W9smgc2PMa93bh7SAm99ETS=r~G!dSYN^Luuo~0tc`CKo7T-1dwltEa!#M;uhVyP?i0E`P9x=G zI49Gz;XB1%?Jf18_#7$Mfev70tx#1^1~nh&jXKJjbFVY;7=bFy}W_sc`@Al6=X;t49DoBMyGFNtCi>M)NL;n!Ga2$GZ(7b$`fw&i=RHPc zL|3;|;iIbo?5l}=3u7pPGvk+OwXvwovRqPoX*TxP{?58}AJ_wqWi9$wc*-`?y77JB zp2kIdGpeuy^V#5@kHIuou{!ljiE*_JRZuFtHH& zo+4yITly{ZWu8;(<`jM_QB)kq-pluVZH)hXkc`4Um|c`k4&cmm}!D)01m^1?!wUR|)^ZmrqXQ6DB;}sAdre{uk$mT5l(J6&*-xFaLvI zJko^%bfe`}atISlRdh;F*ee#0EBXg<31rH%Q(}(qSHo{s!W%voBGJPpBmBn`*=`#( zz{;NAq|pa~CbXR*$57#wqnCdb`E>Rx0HJ(Ve+^FsGit1K1NnlR9jgMiU?j4(3tLWR z+GHJ-SRN^G0`bSN&h#Q0j?o#Iv6{Ogh8+(L$zZJ3c7-=AZB1w~s}|J`#_fAj96%y- zkB`j2QhJ z?ltvX?i0o4)l-eTP8wLD;QXf-Fa;!>Qz%f+pDh9Wy#|I!06<6)#UJ9tAy~2?*lwSkh zYG40fNwkk!4q>JT3uP6KJvRJQ6%amncI_-qeVxymH@UCu12d@OWX6O{>6DzcsBvjM zV;UY}gHdFD_M`dkB29m8wjfio#`3k(!hu297#e-@|Kb^`o|-D<7PN0H805ZL`4#q8 z{_~4_Rl8l=Z@g@#(pCj3-bH!IL58j}=w5Gt7qPW1Ar4ehrzY5Q?(CufdNF64Nn#rZ zfaeCwRV8@IsKIZVNkhC>JUs1>fUdqmQEzd*!wL>6f!u~%m$yi6@Pd&;tGW`mr#e?Mz zPHv;^#hX5r~G!ueV6M~{)lvH zU81>?;o$Zwo^ z^3N!VrZ+GmlF5Er%dQ^gm?Jnw!&GM?Ua5W(%2HaE? z_BRG>JBmY8^G(%!f!ICBY=3qwC+sVyeZIR?bJ=Xc?rW=Du3cY%`vxPZXR7{GAo|?! zJmM(?)|mR~X}s=pynr3+znXyUyR?wNnzfEDEfLx1r-DyQk7=PNRhuh+6iA9Z-4E(F zKG-fZ8r-fWIFFb{vXybZ_PelFX$g+UH8vo2k7_Ag2RG)km={rdKfepHp+BBqyf~)1 z$iV^J)4M3OTF5du&&HHvLf+@a#nq!b|K;=L5wM%Zuo5SOqe=PSf*V%TtVBH=I22pi z*kgd&QS{t_5fxYUf}GrxITXMQPY^3m)_JDg1~Q{49K2W=UHkiu7F^VM$KvSl4xhZs z+CIm@R_ZCKSr^X?S^M0#g^R~WeaWk^8aGmvJjF56K?zv=r-Pi~%ig4$=Ndq3QR*U$Uk> z+x5!h?*Ji zLXK0Tn}(YlHPhD3jSAw|=-EOrHgCxu&p)4*fG5*uin6?ZXP_su9cu{8*-b-^OL=TE zEY{y&|GTRnU0Cv+(AS`3mV3_Ae>twzQkvp_a6tUtf-Z2MG$$JtZXaxOhL;R=^z~5- zMA{5zzAS|cQ6Tq;59Di@r-4$>?-j~p&2y|c0g{%u!S;$R3y_<}BNuNr9?Q-@xXJZg zcy-WAB6Q}D6(=_Izq6|<=jW0*5CN*u{5I+SDyHjz{fH2cfXEY9ph3?1B!4L|cL88XvolxiV>!Ep?6$?G7 zCX9Wba4;EdQJ1vFkgidqLq&{t3Y3qrD*r3In11#6a`M2t$`)nWnJntgE91&mb$%qr z!rXbPzDywEhUQEwk(?M_vf;R&oiEa+nSf6HNR>VKY?UzTq3%aPyeOIpDE9OeAr9Dy zmRx$`F~W*B9Quw8=t&r|+C8~1^f)7&i?S9H+B z@kX#XQM30Qxb`L?u`A0-M%YJmr)PIV0)0uHDXNWe$wz%XWZU)t{iwXqliCIv5;hvE z3Pxxaw8drIdsw=#-MX}^&qRAgW%8_Q#O8~OT#Xf)7*EbWw>-T!Ye8j2yke^Ucg*>Y ziE0`wC)tcE!>levWk?V=6AK?0OV;@tG4@=>3C0^}204ZB4)2L!Y2fCF`GCQVShtv0f z!ifKGVN5DAtgBj^Onc0d2*n@U(vXYJBq1*8CaU>IfT0)Tt=onzC2|56sQFQ_!z{BxQnN0ZVA@YU113jg$L=9Q7OPwzxH zgzdwNUL&x4G0n}&@Hlh6UAH&(hH3C-`eUK8wrQHzx@o~psW`ph z^tO0irB_n($I({~-)>j284e}oq6Z;vHSiF;N-QVkJhUf`WEUA(!Fz-OU|P2QZ^{Mh z5fHTk4YdNis~Wx5Z>q|qOH#+zC*R3zC3OD$NiN{ZWVSf3p|TDhdoBCH@27{!WGQrp%3J ze)F6zv>m=C*rqp=dw>974-%E~*RapDz=o9ws7>Fe_$BV|3V#CqzbBBVo$2c8;;i~p zUKF0cb^zxP>>9bav9_k=ax!Hh~uEHNi?OSK!SL78-ug z;6OX?s^y>RM?uj%tEc+}LVPOV9#syyyTNG55^P}HG7Jp>wAy@+)%1p;qc$S3@TU##tjA z*FWMu*bLIru9wm8Eb-ANf0Irfu@%y8HEVp1EHSO?m3EzaK3+w_HaA}%$2nIQ$*LXI z%!>w<iO1HkWX5x@VL(y<-T5^q#%EsxXVY}~et(_NSPVSuX@nSfA zSqE`2KXON=+6*h?8yG9?GU4KmKZvEsuK%@if1VUtF%ZA{umdi2Z}^<*%xsB_rJW38 zyVI)g08FM{TpbDBPa~jA1&LlS+2o{J4X(k;6*ItnC(}b-OBKRph+OjEHc?{?F0RYL zoN!LL`QxF~5lkkW4@Etfd)#+lifAlw7rZzbFW*VplKMN>2*X>_6F?J&_Q%9HPGt!| zy43nixC5;~>>Tl|e(ofWPv+w@N(5N>$w_iCr0|XD6fgdCV`n-xGa-i68`tiBiN^(L z;okdfE(4QATXZpbO=!CPYal@G8-i8-i#g58eLvDi%x=H_*UI|$@vPHQFVj7k(90YW z+-7l^do@(5t#2XlFOS2Ao!@x(rQTC-+PX^G(;eo!xLr2hz<$J5*;@Yt7_#X@>-+1s zR`GC)p_!1*2BK?nM#4}JqEEue1NWYS)N5D!?Wp|tqx*p0Mn{#PpdvKGQ9y_su0Jv0#0wj1jZ2d zInrF3$HhnW)xFOGD?S;12WNxGa^v6~;@r71;YQjc4Au5Qv>V+A;Rid|N#@__5;e+l zQzj7rG9q6TQ|b0tA*m`vpH2H0+FrY7G3cfBCVH=)W~Qh2*Z4WkdAzMxe&q~a4(&E6 z*Q9%G{L}uCmB`Z-YdJFZ`99em_x2_C#&RZIURIyg;COrr+nBucI?&`et}s$}Qty`N zS?;q6^tLkyH~MO2B z*EEYEyfe1_u!NV7?rIFK9;jzl6%9hlqd{Kudm1^=Tx+O;q{85-wQ+aqzV&cvMx9H6 z%()Stm(srTt@16=8{mn*IF3rM$8nCeG z>`vj$FfQRSM}FX^5}b#};&CxyU{+WGprIJ!OOXj=|6h0vzsdNpSS6c=j;s7$EV~PN zM2lnIM8GJyQ3VugI{dotX?v@ARAG)YZ=+z(sTKB35#RC^OW6I;IVYFx!h z&hn;$3|oMpU7+76S1QWjMm4DwbO~TZNxbt${x?xa>L@?&50f`(Yjk-yd3sK;uBcZ0 zsWlT(YWUKJ!1zMCdO&IAj?>MV(v2ByGcR81cJic!_x6+b*zPme&P4!DM*` zTRtWhyo_09X{hP@VbtXB82w2xXGiqzsq*rVCs$H+xNort*;(tEDSTt2-9MA)W-i%r zT}<{KSh0l^^l<3h1FjjQ;)$gY#_Yixj?#lW{Wc2E=WJJAjxs`iMGdHu9M17F?#$pW z|4fyhwZYF&=SL2jF-K751xXMoalY5kVsCRvkXCTa(77qXhGwt)))~kPjfnLEep=C> z;+dTvx_HFeKE(t2YHgxsaG$yaa^ahJ)!0B6&LjWwuGKJvoT@r6;k7XTtw_mY^hGpFK5BRCY9q};QVYxG|Kdj(}!mxTY_49N^0t@VYpW?k3^ z^dwpW*Mt%3m{`MWQb^0J>BAD8>W4hG`b!@yBc zIe5eXX>1K^Q1qDnRT*Wxe>JB)PS>{Q&DGoyb{1C@_iXt4f!T|?ab>;63V+`e$zop+ z7+LVtX2k6qbLlaqmNeNu5;xWgda z%9fQ6u^f}gCTRJTo>0|g1kHZ+2q|a{Tl%UcDW*s47CM;Lg8Cy%6?JPFY-hHW!kh)-<8X=aoZeuE#9J`->!#WIc3^kh+#ABz_755LNO|4?^zCKSC1 z-k2!}Y4J!FO)b}_&L-@jN6+gQJ-?Yo5BVc-Nhf_%=@}!3TiFp;|K%*{{OZGR@qA}1 zYJq||)lkN2g331E?}?5;56)$Ha4}wq|HJ0k2l0D}MOrfUw=4Gq8WwfmOx6cDH_zCk z9*b5~mfOZH*X;Ze{Zgz-bMtMvgWqb={&sEUc=6xtB1tH^utvVT#cS3fPb{L}%1D%q zywxxA(}m+yv>~zBNi2WQHq;;FDvK$q%X_{4CLiMIlEmNtQVpsWA;C&*-W?5j?=!~N zH%2qMnR_BZfs&pPvcpNYA0v37^*xZsT6z^HG0mD0VVO6z@MU}f0f7Dxw9#JxyB~jG z?36T(vXektGH6hKPBnrNV1{oWj88UYh7WpFxsIPr!(Sy+cfA^z(jN|tmzDAq^(;6^ z+^ZT8mewro(2>%*{Wn!^3^hoH*ZmFyygbxS%E@HfGJv7&Jla@y=%_a7UQH~Q`>xrV zEj(Bm6l(e`_^vrvK?HYvYT!Zka1H7}KQBkKT$V!w)PbZ3E4HZBUs+yxDQ8R^^fDeh zh<|(RWqi+oI_6>j%Y`rqURl=bT&e+LnXm5wh>JP9Zyw@Y&D;?mF4PZ?2s`q_zN1KJ zJhK78#de$f>fHR|czaea$IcJ8_V^(4#-PagAN@?t9wNe9UYZzf0oWp~gksB?C&*4D zovrL~Y*um6hj-cnMwo&M)Ctex`8BQudc8uTiM>p|_2L_Ze$zWn6;OkH_p>U*$DDcXalgL|MDamuaD` z*h{sHeTKGX9a!LYSpz0FP0vGng7}@q6Mvap8`+OV_Y#2vc&Tm%Sw3^oyF0JT(`+ z+N93>XH`|s&hAy7%$2;dCJIiasIl_`&%LjrpY$KSk8>~YGVllGWoH)~DM#>GI_`VR zwV(%{{qqe{i;pnLGq3D?OV~ZD15M^cU`G0*NKaeEcr$tTQo(x(7Y#31I%bz>3bI@~ zWKY^@4NAL7u2qvXx#{r&2AiC>{hbuE^mATp=1FyWCIE7^qNT_bDC?I~^8+2U? z<6P|;HFWKFNTk~jOWcYt_xJ+G8fS$LtuwmZSKFM$D-MC#8$UOaaktBOzex4813vR6Hq2ySaX@K)7!h)Gr+oB@m)ml}XgrCRKLVP9+c`Ng$2w#=7yXT-GK z*VVP9P5U4~&&cQ#+3QieefYl5nyw$%N*uqh2F&SupQA}4@PYe2SeP3~p1d*4S|6cd z=->p4300IB&<%g>tqTwCMTBQ)4=OjiEoW$Rw{4%@qcq)2ZRGRyms;o*_&QI~C3xi7 zSw}oxsu4vq#yYRVW@9p@;F+O|qSM-~kC#0610dyQIHwzu8`AB=r{dSB9$_y7heW@0ZQ4fh~RCW#nw zYubkA6l6V*RDIWwQ1YzC;MvjPus-}oT6H^@kx0;T@*^g?FeEr|KSxvHb#(qwo%Hk5 ztV1?!x;wP6R;_9+a8oaMW!p-3=f%LcoXL$uf$=(KKyRbzb`E$uG_(@P25yrQn#G{h zwb2S8LF=UW`_Od@Muq%g7%8mb3C?pWF@ujBd=+X4k$lTDQ4)M3J^BkLQaN&T>QQj- zM=5Ea^#^GW{2Y}D)}+AW-~4HCj?Jm}QKJeE)8-qM)mHjGXliO)V06 z_TZoMf3LtcCUDw<%-U}cwT8zokm`*JlRB4su+5(Vnvd;c=U6tfzL4Y{W$e{p^9a3} zXTJSywIOSSDy)?K{@n;UnRLm`!9R4%K;!lIY=D|po%d^J310Oj84Ta{92*2| zh)qiG>I4Rp=SQUfWWI3$B1|Fh%*QU%Wi4*?3lAWYT6xr4jqWXX8Se;a;}Q3_e4Nm4 zQf@;Xik~+Ev5VjN1L;{I(5F4AQUGVl&)Hb$F?a3lE(^Kz;Z)>1zJzu6ni{ChSq&+0 zC7_9tsPXJOSDw|CHn>u!8azr$Z==TKzG`cwZ47rcWe&^$tz#APrJV@yJ(t=19zfSi zg^%V7hgieR_+#Vs!6bN3Fa)ruJ5fipto0MONNiQjIo~zi<6B%ZOJ5HF3Jl}DV3G*8 zlskN5h|&aG-9|{>)&)g+Iz7!0{7p|19mz z7S4)%_+<+6Hf-4P+KyE{&Du-jvcEL@{1wR8Kd)&fmWC-$;%K?7cjbv(-}vK%E`O%m z4N<-X$WfT5!9P~2xb1_?!p*wM2#KOo*yy?rM6nwLuWM$BId_*uaxH#!#TXK)ADkz0 z9ctM??-ta6u13t~v}ct;CK;~?#rj~tZ}Mg_LFqX88Ns`L{w!njP~=P%$&apx%+lE? zFyim7xd?X^2vHDS(9=~i0C1u-qK#;!`#hc`K^%4`&KZxkHgon?xljr^TFQX-htZ-iazu~{$`LS#aZHTMlV~bEP1S7_pk@J9xX3 z@a_uNv;|VH1;|Y9u=4I<^kH8DpC8rrVAJQ3ae6U0h3LU-zHDmX1ls{I)WWT!NoRl% z48*qZ<9C~aM}J!JkiQr`zk3-8yjCnMss~0rCNFsG0cUhIvOoYZ(H3gcLf4FsL(wp) zL(K}yzlVp62HfAy52Qfc$93K6!RwmJ928J#H{)fxlpFCX(Y*G~v+caN5JY-hpmX}2 z-Jr72Mi|OD60ZoqqeV zVX1*LPC97BS#W|n1W`AmOiTcdDXJErxK+Ul6m5rQw2RlyZ>59T&!?aRv3!u5L=hkY z1RDi{WDH^3vN6-jE|N7;Op26H_W_ZoDNSY&_pO!=&;lm)M%KeSzlQB@)t}d1X*g6w z97&Av#?N4a+rbhjX{F)pi)BpMU!&sHBDTKt=!b_2J@2X#$`<+xG+Y_I66M|X1k`nK zvNOD{x}aJ)=~o)T7UlgooND{xd&;uz99PcxC)E2#(CewoUylZh^no(6B>2B|h6cZd zI&xwpKR4WraQvaabQWV|ebIgwmY&bH{Oydyx3T1SKR{CL@aF#-hT^2i9(CHC+G-Pe zvCDs)(Nnj7AVZHLCBz=Q_v+A3fH1;Qw;a~W{>M-B0oe0B3}XxH`bGHJIVcIm%g6{`ZeE{vB6if^}(mYXOEiw7W=YtZsr z-v`pdZCk<%(w{^lL|U%v_GXgnThd2vhmPqzko-Q0^{4cN%_b=PKxMsx(8be|dwAMKZZ<^Sti8`LV806XZm|JkBoy6=(`2Pu+NHux9AjRfbn_h ziiRp)j-q4qGUXj!kj=Q|R1-C?sQ*lTnRuiG>VZ?p3^+tq1*!jY+pLKHS%1;zblsE! z`!Ta&MIoVsXyl*DT9c6$`L-d1Fjq8N%)mgloLEaAxP|l(BtF>=I5xyO8_s8ud4#jj z5|AhuzZ?omIvT87nIZ4TV$OQ80X{1PBw$ywV5viWZM0{i*=WOpB))-KJ1naK5MZuz z_<>nP*BGvSv#H%zf|(FZ2q+ltqGhye>(d*z(D~=0W=!N-k&S|j3?@(AIJM=KS!VI${XQ+JcL?T z!>LOGOW^~0rn^bReo({kKFIbyNTTAFPRcsxR9CXD!bJZoUm(G`vpCIsK%C8_H#Zlv zVS5#Vv)9DNQuIu+r)*|#B~7qu8P0P*{!uYz+uv(3O#QI|OI#f(cmoQciu0$c6?T># zzbtRqvejj<<9&uXY7;b}n{z zzaRUPC$sW%$IoCM?#(mdqmq~pC}; z5T%@qzU`*){Uriq+qmW#@R9P2lZTuDdyMZ`cLId{-(j;MuyF(8v7HfrpvG*fA4{4C z9w{?|AKY1m{v+{^@0Hk0OtQN`=5VHZO7^eCPFjnFhCzG4t^C(f!ES}GYx7Apj~6vA z5z<@1bhQPz;l{KMX?SXi-=oOukXVnvW(QZcY(_ZCkb>?MxS!drhZYbqV1cuhe~wO3 z1mMQF$gN)+wX&4t<)xSYH&^P9`t8ZWCcKogxN6%Q%(9F+imbXCO&!yu*Fwc)9G7Fi z<#VFO)I_za28`yx*s~4m0-kk%$$B}@1{HKlPu129wil$mG2*}If)12w?KG8 z;Gfl|*Xe8r2;8q3JG}2(};E(gY);V|0X` zsu4lA$OgD5nCh7r<*=uedbvx`KIG1ZCLnf}Y>TiNKOoF0c6+HH{V)^v6^Nc)VB<5I zwFQs>{eUp@!K;iYn1MOU)uBCCoaWcMC%YZ|Z{ zi6XFQaHWyTuF802xuyqQrtI%TS;pE_gFI1A78>hVJ6gX-6L7Bw+lNgHiCU)e2ZYTY zEp|Q(=??F_AFdLOUvv)@3B-VJg0r4j0#lINaOIUrL|ODGPK8_Z%K8>$ z?`)mf>^p<{+^jB5bN@WY_tvm6Cr#&DJXP(=)hpz41?Tq-e|%n^lT2>8%wpP4*nL(6 zbfpE5Ka=tHkU1}UD%Q#c1NIl7$ zhBNxtp?6a+>`(nD0wNKBe&n(j4fTi&V7raTdKrWT@#8sRS3vf1IzISY$X~2l49uS* zu^17t!=PLa6Ivg#)x`_g=Ji&h_s#Bj?nNV;E;J`eVf?K_I*XA-{)zD>5&AzpG)@y> ze$PG!;rdmsNha$WeI~@F%3WIfCu&X=2^K&^P>jJ3|q z^z+Z5Hx0T7FVzIjOV|B&E8uC&`kf(!vPxslQ9@YKM75`5bX$X*Z)FX?u{%6UV006B z8SP7i@uAyhgEta6mL-Wg)q^_g7yT-{`iF|E+v)Dk3Ba)$Vm#j-Fi59c)A+vAO)&q; z^ErXettxR7?Ye;w;=cP~U=iH+unFeEefGkdSh-5qQjNdUD-h^NRbttR8Pq9J@Z}`T>XjDPGAS{sI!M|^@@j~bxZrVg)N~8|x zUS`u%;P5*?(8knR7vN|_6O7I+;vA{>Rc-i$Nv>{7%U9&QoMi~!!iQNH8*${N`6Yt( z2#4^)&;3_JUs9RtamZ8Js!ytmwwloc-{y{76EIN6AoA|ivq_i`7#?<%>hS*TXRrM) z87Z|)x2(>2%6<{~Vkx7z^i=lCh%gij3|EBMduqnr;}W10rNR9$=|vIZvyAAJJ43G?M$kn*ofAXmztMXQ?WJYqYv!Bx@DNH=XjP{pPq3}EtqroS zwCK*7`xwj^;1!F|dduVT2gnOR*x4nq;DGvOz@}Z7T%g^ig60(Ye8t~@WX1U>k04Bu zy`@=Gyq|has$Aqdo6UUH@qQsHs&)ymn}&xFgV{=%ig)JXR7SbfpoU_{t%9HPtJ%%G z{lFaOyoy|i;NBFOV@CwuJ6jBRP3P@ZO-(@BOSwp$79RgMJ|Tiz&(1g)*?r|?w=j>> z4ULfm8G>8@iThUyTNO}l*$?P!9Md*mLEoEiXBr6Z0tV{|bGOTT%eTiX1H1+pXm5dP z(vwnapIqRu$S*ebS+6+t_KpXeG?OIQfn1ZZ|QdN&n zdH*Va^UM_)C*@yWj!QZj!kLh%5eXA6kQqcdX-1tqU3T`BRODS#IoRNyqpyilla>3g zxNQxnzYkWk#XE)XId)n3>P5`G{2N-Im99?welA-a-7fO&Znd?DmO6$^5lvb@%7 zrNiCJ@o?>v75h6Pfa#IqS&v`g957N&0GCxJ0OvlRPj{uoA(MzZ{)iuW(u_vY4AUk3J7*vC(;lP^q0PH0qfN@WZ+Bb#wlvw@;OZl` zX{X(3uM7TZAY1O}WpBBaChce&$18;ePgz0u`yV+B&;)izxNhktpfxq{7`vE!Shdcw z{gD@A(>bnY2)yWy@W+sQ)qy1?W}pD^tzM$WX>FB3r`U^}5K*G?b-X09a%FVyePaDz@p{kuI$a2-lhE+a?yXW9KrvSmpZLbH4pCJe!stnoRjdK8=@) zIWQf)87p#&BV=}Mg!b&$|=M% z5_)GO3Zuq%I2@iKLg&u|RXDHx1&jITocqm*Y34mywa8UTWkAuBy?OrQw?97&dnpBY z$7Q&Qk>dk|rDuu6d7r6K2Oy_qJ<*4p?g(z?h7>--*=IlqcVSMYAqLDL3O<_W7b#+w zw+2CV_I%kLe9$`LVLS@rzAzfuVj6t!GV?OH4buK6qxLe82?tl!3iugeS*^P|k7&79 zZ7<=wB$28F)8#DH&q#1{;d4#fRP-^-y;QXX|N9dnX^hcY!SvUzU1}#xijn|9DyhWB zJ=*m1Yb|MUv2(E93ot3(a)1VzlKtC-!ih|CkV0FI4s zr$yBLUX3Z;0?r00e%|u{wkHsfea^u%6oY7$0n03BQ92U)Oo8t47D#k{ z%Wfkx0;#8VzV@C5$H&O08@3XLI2FsGK!y-}3;ZZ{!z#zBVl%PjOv;9BkHJUENk5FG=vsSaU!_`YpCcSl5`Af>5k{b04 zA}kmle9}_&znL1pYcK42J$;QJWX;kd=_x*b%Heqdk{{ZX|DR#ClYw&)rW#_W*;E0d z>V!X-g@=Pvyv9b8$7n$MgNJ}-MKsSEOT=XXumO&7YyTldxQkMwJgXypC=jbQ!vR)* z(F5Hc!XQo=UT}8Jg}P1*9|8{3hj{J3;inZq`${etgWew-2jbUei#lsz;I|{Qx)74C zhPM6w?^27pwL;(oNZ(BZLFeOQKl9ItY6e#vwo#7SSyPenD_m+6g9i=8L!2V9%kQuV zzP!$V;wieyLEQ1kHbspkv!x3iCtF)C2X`pT8a{x!p~AF9!Kkn}MbnhL<>cJl-F)}8 zgwz)aY4->hxXtYZ}2ABnCs+)$J% z=T`*(kcVt~AAm9gI&H~HRNF{>Fnr{!b|afs`-Pd?2HJ#Z<0(kAs_3f+k7l~zcjY5r z-a45YT|~`aPRwJglBji9MCFgJe?1V|H$?qOX~aQzI;0EXBT;AYVoRZ-mRa4Y&e~)A zHt;*9_EOFf@BmPrqZ3algt6Mu5&wVMJM(|2{x|NEq^2yDN!cS|>}3d{O}3C_>}!}X zn363FA}K;D`xY89i;=N2gvw5~VaQA+`!d-D@8`9el?_Xa9&3DN>1k3^-5uj!+J?#dg|xIFdZT8&Y<$T>O+&^NbQ?qlQllt&Z7 zd}0Bkh^8h@BMaJ7ygMU@Z_8~N#y8aWn-}}{iu2Z!xZBabJYxiA^7@P1cgARTsx!GiyIP^)>#iisU9pN5J56 z?L=EZqzn^!tp4W-sW!pX|0e|k1oqleCo9|sn;ep4tT1;W5b08HMxXNBxVSRayYNJH zD?ktMfME;vs*DGFZYF4+24Xj1JV7_8eX3DHxPR&0AanmjYJU75zKE95aVhE_y^RCq zFPR8rNx_<0O#t$vQV}VP{Y&H3Kt79T`S&z>zRUxUaXR^&J%TvbICG2TrjB_6&>@l zQpaYm2=X@-mRp~E1Cf3o84r~)F}D6z$NxO8DJ^C3?BWKh=}A$9fvJK}gVWLT=DdLE zqND+0bCz2KZ(BYRzvzeYqLj)E^U1EsZ_hCjY?{g1BOjDow&ULQ4{B@wycrt$gmf8x z1Bh$cvq}R5s;(I8RReC%3h#6Cy1)$~Y_Mkx7_=-sk2{*bR{;gjD&Q864miO;;_lXm zJjU9q59RD_Z{-o@^E!$vRl913!9$EDYQ|=$M1RQXwXI(S+>q{l%9`eWTtM-l-nOl& z&K7>7fwuSSE6_YZ4;;2M-gdbwwn#bSQuO)>m(=B^59WOz&ydA?huC$!dGGy|0aUw# zV$Z$hwSJ#hCT)0q#plP5RpvIi96>~uY*@JYQMO!Au*|9ctr#{&RLIe`{;6$j*gWC) z8S;Q8^f;}`o#=O^AV*z!x!e)CY)10gDz6+lZ)aFiOAqcmP?K?PI~O(eqGBs+3NJuC z%qoKg14V}Q2&P7h_h}HOqchbbLNEtFs&jEzFDF0Y>UV#1NzI*vv~Ag};7Rw!>=S?D z2U!I0s>$U+1(?#=K|F%~GQ;hl5mv5=A!G%S(d$6UGLl(+JTk`+-%GE%FP`=A$(rhn zr_D#7xC0j)=g4a`7ah|fTfqx8RUYFxiI)8o6LZAs@?t}KamVYg`9Y?aLq2!h5x*m< zPR0o90z%Sf8^>0Edhtf}>1+eqN+0R-UaKQogAS8X;7_jOZ$sWwcUF=qtYM*FR2`PW z)#n*;=U+-%Exn@8?$G{JyrC0cY`Uqw3F>`nMKJ{^E@6IEIgDjaGR8SzXEf4iB*me{ z{tF@I4WNlE6W?FTv-71G;r)rS{_U?~7sfU&ZkZCyicZZrS~o^PkUo&#Pk}Qv#)m*R99TP?e zob^nd=Z3Hdun%PO_=Vjixecov)1H;?=CHv}Q9`pK-9U|!P+U)`|I=*+vjc3Ub>o8@{*PO{0B`#G&L|SJE}Yc<*vLCb z?G*eKbOZ^m7A93=T+oE5;o;6fur zdAm)i*^3YI%6FW`l+?Ykx2e3IxmVV{9Cx-x)JO&jJeuOXq0Vy;T~g7u1=MNVdf9|P zuZhNsuQU%kh-t^>U$BAkl4-BhWT%@I%TM&r?TI2o+#V&rFTP>i^U-{%!ymMjy&*{8 zxv}{GcR^K|=D&(cLL|%Xe2rIG@&ziq6-fz1!na1Zb_e^=Ck}S~?~QLFM#??{CN4CP zj(-yBTwHr*Ia*0C0ZjGtSg{VTt`R?=V_*&(gkottMLy^lbHHQv6qy3iFq{s}RA)?& zk>4*oB;$1RtAfQB^snnaK55grWeMdpWVvp~IGwXkj1LQM^MDFt7E;1C2&*eTfqzBt&Hx{*nF@ zZ$KzR8qZ6I;Y|Q43eKB-ZfK=hoV7hP;iGym1AMXa@ze+)=G%3zSEV0#@RfTBW^FrG zSxBniaL*I(m6|m^&+pTT{<{i4W3u|h-WZHEUu82@(J?~H7e0jB$mu>c z%KZcA7w>h+)wK|W+sP{;cHGNrHA}i`Yw`C@dF{_@;BCrFVtX_@fIT}x{iiWa0?+Zm z9<~(~RWTh)*qzY@IqlIK#TV+Mvr8K^H%dv{Ih9`Bb*zA16^<-H>?vZbp$JPbQa;-) zu)MieGrG*%iBSJ1RkKPnxK&u{kN3?|NHEK8&tzxi3{V?hf8P@YIHOq_&F;3o`=l`T zGid-oE7cBgcwwgMSL--6g8@n47`JTEsS?2Yv!{{=kx>uLlMe(6Gt|fHh0^hp`C)$I@mG=s}w%-mVUDI!5>2EO6M=CX^?mYl>1d#-wxfK4};V8^~bFxzl zu)Q?#4;yBspkTMJ$Q!f`Rwo^ExRvaB`uGH^%)kO03xN?mloD1)M86)iu zz@Q9-_H$YddxXMJu@h6^O_o^~fZx!u=R3p#7{bfc=DDyYXcN5%LD({X*q!BA88HlC z)~R@Oe-l-*8ZsAng+6~dLjByYv3N6snZB*OmD{GCqDiqyyL!?xxOb2A2jgqV)rEI0 zX$hGK@a{~EQ?$8pZ_C~lde!!X!O-F0L=IP_Pa`Q9qFMc--aEAN%N`Z#Q?=13;O!)r2lJ^_D^y)U(lJ{o*)5gVn~72H*8heUHAit37MBN6CRnKRGVG%=R~?klCa<1sxBhhY2)! z#bG^u^^)&}avFM-AX(GuN&RvWUw0yC(kh2Hpyt>XAW^IDOTr$yW zhOTw1=C(XM5DP|<_6@)q9uZ?W_wo0OIYFF7HLi`? z2Re7MhH{9DEdt8!zthGvdmJ_JUQXH!CdDz}g`cICIZlWwu-1sz7;wv4nj=r#TJ3ZrkC zGpn)s_2m!j17CJ`N5T%zI=A*`LxO`xO|ky4dcx{=juYqWo@=Lqi9PqNSUpq0wPub< zp+U%8kO=&XpaFZ#xTRP}c4_>?C5`g@BU`!T$^7i{I}#_qJnfrkx{#ygjY zGps8;7L_TSM2x|PzNu(*7AmMj{873x!V{3F<@61nv3u8IYp|6tKa%zb5_z=b)Vr8N zPzqUm03&}lH3{>qa`h-Ehgv1Y57A#e7M$wjmU{jAuqpq^47WfuM3huO3TgTCjpcFF zA71{#SPi$M9gnCgZwydJg#^LW#{;#o!Lb>_{MP4<`VRv(gm4Gl-%SI`GAEXY*>7fI z>wOe{_an+Q?x5O&Nw@FW@9spBi8~5=5ZB^p%NkU=Vd3EMoUqwYplvD87@)U4=Ro~I zI9v$91QuxzW1w^M=^b(vvCneO0Z$n?Cz8t_iPP7khvYmq7S;FKV`dZH>Mn4qea>0t zNgkuF4EEJJ00279brc(uiP^a_^Pbm*VqCzd78L zO=f{P7=Y>_Hi8@kr(~XiQ82h{sFW7tH z9%gz826a2T>U2lRAnS9Z zKJbp0IlMp*Hruj)H1k7`4gng7irLtNg_ovmhiNKRVGWy40mh!fpx2l(d$XmjCRh&_?sg6IY8IK7jQ=%02ucdL>DZ@it18TSD@}Lj`P>=3lRK#37r#4Kt-a8@bNevuI=~x?(#eS_Lh7Z$P7p7DJ6f$6yS^h4 z+k}(o&6sK&Q#)+ab{wH6elH)>%V0lSE(gB8D`OO|Yh$|6IM!?J0qp+4) zYJ$)ueekV@kRY7H_4h@{;yb77+^$(XV)~tD9p`f*ux_o|55U>?bLxgd zgGYM~+CYY|ml9Pbf%(}6VY`DpUQIS~Tm7_Oy=c?m+L=O&p#86nEUK_1oPBNgcILOP z`fTMcz#;(v832cJXw1TrV6=RC#M~Z|Qqv_%`jP2qGrr#mVT)^(&?5JQ47!q)#f!r-^?W1B$h`oH0I7<_c?cJ}~i}XBS%Xv2J?TIM!6V zP%|cK?^}D%G;XdLQ~x@a&BZ(I;nSPoTj|>cAQ9;OfZPZP)itlZH$$U9@AP3od(Xrx zqd|AjmMz9m%FDZIvPB88trmLi{gIh8TP=e~SG)(XDfoxIs&kzPsa?ki9j3+601M}v zEI_E;(7C@iy&-A)4HdeTlQ7&GcGU$eHF=oURd=$XUhFNX8lXeXjbUqP!y5e_Lm1aW z_F1}SPn!w!+qcVxA8)hs9S;7!{AsMAa!vm}g>v%<%EI7-yaZ+HvYoHZ5OUb9D?_;) zP`j25*#|axm=Od+c+zf%CmjlM_8)uY-FU_}xABn`y^r-WBimGt$CnbO3@ZEC);1cZPDKTf zg8f#4IV7KsR3lRMEx-6vCX5K9b&s($@mchJL5{t_&fxVI!3Pu@%;&zh2I@SRyD<}a zIWmxunP|MV*fK?&etZw6JfozsS*bY!sDu|1gS9OIg3|)PCt~b9iqg{BL-~k(Tkbhd zUzZrLtM-UH;IMGwsX{yH07D}6N8u09AsqLyIn()4vgg&L+dZ4#Unm!)z2`cQ3%!-- z{`4ozX{K6N`%~gkb-2ZtCSmaPf() z)H;6&p*j~n0k*JE_m~5BN<)NO_bKIVxL|L=Qh+J#K&NoolxBNkEAJrQxNWOXEhj-6 z>b9&KW@lzQWS6B9%Vr&}J2_3W%)5oZZHCwE0bt%BhoC)V)yo7|0 z2>3r|%#!C8=Bnv7uE?;8v!UIN8Jp`J$x{MT8~bY;{sSkoNX~>zAzmbaa^hUMbP}$0 zQ_7&StLSc{EWdw&%w}Mnfxu2W`}C;Presw?Wc7f&SAK1@DpkI+Y#V0EI z^kHm~H!P1h7$njDlP9XAi*QYvWq5)oS8_qG7L~6GdPd#+8EL-h8+GI=hU4^DMR4)i zx66&g!fTGl6zbx|>mahYp>UM@m*&eg=!zke;i+2tSg88KmXHu50tsjf&D=S9+VA$py8prtZ$lWT9} z^TpxgawPBkmY0>FiH;rShzNWpNX5K9L?!Hx0BK(TCU)ADPDOh4P}OO$BSq;tg95zY zavp!ZriMXG{bm6IlT~UHmmoi)2sE9rOqc~n49fiih$3bWCj-9R;sMe zdG3?}s+O^<0jyFr@A3?i5P!emC_I6(a%SYf=GhN$#`5IqOBd9ZcQJ{(5jt}DzgQ6L z*t*;bO%w!>&I5+xW`dw9nU7y+tenVxwVL2C!~7$x%b{vmW6v`lwb^^W!m&5yz-}~J zHFfTHC2q)V{4yBh0Sko%L&G1Ig=OD0$8AT`rTo7x07kAO^Np z7z?~t3Y!F`3pcPj#WoF%bOW@YH9(WwE_Sf953Q&1+)0Xu)2zYtUEt&t1E2|-0XNW8 zbjv|50dTl1NkM+Q?XoTnxDzF-@M1s*y>B5|mEJ>r=p=Ms?<1$;W?Xc7BbM3Y;@e~< zDRBRHy-2{s%QaFsQFQdmEvM@>SZQbWW4@yU;t(*H&570WF>?3fCgicYcSzG@h=6yP z0MsUIX5FdLeAC1@N{qJ(!RulPd-?I(TxyVg6oX#}b4cV6?)P+LiJC*YC$ih}_ix~1 z(NKKY0$74=;h*V^W0@F37A9dESJ%@U4CpwyaGv+W^yvV0>r1*w)n@Aj!$_A4Q$TU- zutRRuNl|fD2QfOJir7XDG#4~(UqdqCu3ZsO95nkGC=Hga@dDijOTT5ssDgG>$m5yq zQ|3Z$64y90_Vy%Fjc*3AXPO!$B*vEm$L8%n(KC;|Yqs}{L&XxMekL8VVeR(lEPm91 z#z?VRs0!H~Bg7EuH&Z$c&(|Gd624${&M_|V<8Nl8C1HK!Huxg?&5_HqU0^a__vzZF znwvo4y<3=f>4V}~b!TI@NF+(cg4G2wZEFH`hBUi3nEZ~v&(LsR%B@_Max~G?Re#vD-8S>a*`!v)pT_B> z48R93i8ayD65U44XxN_OPiedJIPU2parcM%{GQ#8-Ws=G0oTPTMG{9~g44z6Kypk( zF%&M>29#l5SLlr~auw8=m}V0Fn9WOB)S@Io#Gn9o0c!^V7^fQ-|N1BO{#@M(HcODi z`a)9jQBtCjR^+(LQ*fu`i9YV=61PA2BEvR~$&Y;tnoEDo$)jpt6 zV1P)Qu68)gx}Y8{`YGmFh%EjfmaN`D4Ze4nT=quQ1dM%KY&>%+7xGTNNs9fh?FqsK zoFo(^+$4Bm#xw-h|5gih7>fQ_*3V?f-j|=`?PN^An6Z!e$s*G4Srve;TR8N;(n#Mv zX#F$3&aZl@%14C&x3fKZJCK#>+T?*GYV!4daX(X}vQFDEtY$*`rCL2C1}Y$V!aCxr zXFAB7d_y`)1?1P>zJ(ROMX+${=QcyRC4!1-x+uagXYj4|K_~!Nyem$qY$+DH@#-;` z$2}oCRN@LS@kQB1D;#VkBkk9LtG>=Tabe{*r;j%NdIxB7HjpfH*w6JgA3VLW{^t z=$}uH=Yeg!Ex(>?Pf(mtxs(1&dAECD&A9(Dqjj+c0bE(LuAh&^+mwJh}OcNHX@7*nlx~2YKt>Jf-EeZ@& z*+g&hJuSqv8=p_!=1qcQo=V03guTV6HgQ0pb{OG=AM;M6ynA;?%OMRw}8lSm0Nv&?Nym z>tf9l7$388XUGT1$|JpK1?g|qYU9kxe2l_3O#$j>ocgM9tjs1_JpcuOeaF96gcoNr zXj5^ku->4S4vOfAyz7^KqaG|r{bf&VB*UnM5nwj+(B)v|GBA$hZngw7UhlNr{w3| zU!@fc$wv&9Min7HnzBynS90zYAM6pW99AbC-NSSD*k`RwMl>Xcm{R{h_%VVY?Bigi zHLpG<7*_1rd0Y$O0*F=rrX^QaGI}O)GdtUXlpW>uW1;6gPE}s7KYCU9A};FWC9xn+ zj|bhfq&_*|xHi#hleT>(@)uSv+t5{niOEV_>JUx>b+4e204ddL7QTskqR0e)b&>-r z!kKT89*_6T@HuVXAgdl)lvxT!GY>TtdLNYu)EAG+NcaC*hGUq%<6Vb@smeyj>DZZW zNHF4zIr&*}P8P4xEG=-#$*k=&UY*@L&tK2j*8A%yn>!q4ddJ<0VUp6Dpa%69TsNrz zh%s3%<6C*=$|>h%njU=CU{nMVds92L%1e~r5Wp4+h14gF8%k4g;mdUWBQqxBv?x?eTwPJ zP-YL$XJH@GRFKnPnv656qGndN0y^7Mo?=rqxr@q3T22Y3Wc7++R;Bc?o;rK0Ek|kI z6y7`ETk2l^P<2UR2qFfd3OTGr=&j)dJsXJZ{n8-!B~ogy;H@`sD*ifu2c=d8EUgLf z8eE%sJ;-eSw!LxfNa$dz4TCBaWJ+)6zR4bx7kT2yr=rtvI@S|Kn1oZQOyeUEGtcSA@8IGFJuCK$WXZwd5O9l#F7FVwX6qhBx)ap}3clU5 z`&~_mCu;fX7rii3MU=EBZ~|;^kOT2I&vSB5B8agjj7nf)gUfJbaM$|cvTQAhK%F>R(LL)$@oS3NDlYt9zsOWFWye# z-M&?a-6(Jvg4oH)u-_=39h$!&BviDZe!D2-j$-Nwsqd}pdKvOU$DUleH-k4iGqg3jOfI8Byh7g1wId$X5c>5ARnIYMY9yh%n7lBiuG6uF%=4nYR z#?R4uCGt&bq^}N-bDFR^(*pkTXUQ}!3-mS;n3|;%X|U2&A-!5W6*v^zRS}eu$4+&{ zQi{FcwWJ)%Y1{Rb%-@GoVv_3SY>AMyE{yWV5q^QrSzkrOa2L+rf(W9hbhJQSA)i!V z{ZbE04rbwsvIXv1Srz|6xj39JCR!Bqp>lDP{_Z_YlvNP(4WrP3C1{8&%vZO+ z8*UfoOhTwESS%vv^b4SJz8g2wm|z zH(mI|4j|yd>}5Yb0m!7b8m_sOLgY~|*BeaFM=`qa({c)<Ykki-F zpgV%ZbCtK7gh&PtU4tA&26(WE8#Vsj_Y=L|K0jC)MdRmCpf7&RXs+Wh{>}$I=^N5a z?iM9q=RaPgaT-DgZ>u|xa4M?JxDxeV5Wa$h^<{!PJUhAQYmLFzzaeh=raLP2BW%F* zwfShu%AUNbUUNS?(>3#NzIEp~Z6~5{Q0`GiWGY;>*UjRXCA5+oPM^bnU?vu@x(D5b z(wEoH5?eenx^~f(%oSggP22mp|*U;Ozji;s|D(jk5& zb@G-gj!vLR$o|vp_WAwM)SA!pIewkyhTj61-d@bnbXD@OeE&-img;oGBFIiPpo3a@>sS>7{NnwoX589uiP5-6XY3qIOrSCeUJA0YyT5{V~c6p;t-{veH(}ilk z2cMK8@Tk6hdN68$?YoLkY1|*#w1Pcbqwn$q^dVNJ?!W~dBA6%&J1fS{3&l{z?FObv zegVWc_De_VWmW~4C~jlX@E-rm*pr_6OAjPfzf^4w1))A*^ilM+8!6A=gLV4ekB~VV z)Z06d!KLE4^a-=e*dL@1W=G9qBnZ!fCrDw4lz=6B9bdbu##&Fs(T@Y39rx&^-#nY| z!$)I87+ZPj+pmuieMcWbv<^x0a~;Hc{9Pzn20-5wJt8UVo;zrU0;cLiOol;IX2dUa z!7HCn#d()WlVrV&6x6n0$WPWGhffG2uF^hx_NTY1(4(~`x-d%e*#0)$WNxB<9J$di zL+4r&heu8QZz$0!ARTYTUBm@@m2{MqJ~*4kaQwe-%qIoYDVY_(h6i>5zDbCN*%OBYIdOyj!b{J1Nf2XEt9@g7bt3P;S3Ch@b~=A*F&r&d&fbL~F$)_(*Vbei9dfuP8Ei+ebd5{#XU(EWN(Y-pZBdwdjCcH znZQSrA`K#l_Bz*N${`ky)*Hu0ZRpK5!9xPOgIvtQQuzJPp1(iRHr~C^Qf%$>izapj zX}X$M#{++~&1SEHGFPY_^x(@))K2_%krjbWWK`nh!85SZ=|7P|7`@j)_Fk%-lD0zF z#K7DKyYct54=2IWMTP-@NWsxV5_U04>FTsgm%Iv1O61Obkt*d-Z^P{$r-l=A4}PG! zGBXWyb=-ZnxDv^dqlDNW|99QMc$r`ZmPl!5O~gb89*N^+b)SuI!re4fR9pI}FI`xazbs?>}agvn-fa0bUz(U?8U{W77FM8gN(i!3sQIS|9UyG=nC(Ni>F+QBzGqX zUH0>?>o*<|Q2Jbv}_D{mTh;X=s*(?kp|q2!p-If}D&1kE4V= zz=4`h@=K&RQ@eZi<{36id(KSl@AC{2hhAGsK0x}L{6_F||A%4@@5{Y?oQQ3JB0}q| zo>XS(EWU3njFB))6f;FC2e&IDmV7x0?1a zHed^J;kn+rb8uX$+291HQf;bVLksSUFpBM(lFj-v%5s1RHl2KR0M}vEg@Llyr-cWa zpC6cuiC7nsRm6@p(xO=YazF2?;u)Xjld=<;^!r)Hi(U>3#bt8e13yj~fz~xHvct9a z+i^EsQ9Rd_BrNZ*x6wN%HF=M{$|JA`lVZ&;s&BWzQQ7PD&-=5p;2XgN*1^by$XlDa`q&ST%cZb1?DX`H@Ns zK}6_r5dw>KofB>L4qEgv72QMcjNigHNWl?Q<=~mmI;`f>+{sY7my(N*3m;pOr-IA@ zZn+A3LyY)nDt)bLP?|Ps{)hXk_9m~cBv-$1V6`$6Dz}!RIhT%F)+T0+uAOGOgny79 zV7Nz}Zv(*znJyJhPtrga{U{E+d5-$b11$|J_Ts-naxEuF9G{6ta}VKecE^UqrQUsV zFtziY=dj|?{Di1TKNI+B6f91R7p7GxtQ)%sZ`o_aZM8LWFu42i+FvF>M*t>iT(7D_!+0BVK?y@ikAUH9qwpp52D3-t5_Elc*P4GWGtJ zwneYK71XD5#12kgyGXQN*hMnyJdw%CK&du)F0H^lq|mk!)+fP6miR}O{gHAG_sz?n zG)P_C$IURP3m-`Z(`&gwqC|c2t%{SU|8mD&dw6=%;;I!dm9XbG2J7a*tZIs3a(%0$ z{z2*|>lIGs3$8{^@6YWNhAEC#sGJg<2{F8wO5U>GkSDJ2XjeEVR<_U2z!QsJe5^~B z_`aBSEeC%o{_oft%KIa9g1>?dBgzVfRD+#Qb{jx*0b9NCnikf%QX0o&cJzO5G0~K&!SQ&iIul2PG0`I{?F4H7R0v7TSwZ8=HmbnaGDnO znps=#A047-D4e{0h`2l>!Op_}XRrglBB*EsmFc@6~6CG(N38WZKc+2%!8HhkkH`LQOA^Q#JQ1GdfD)0f8K#Dsl0 zlPAFZpfXR&sOO*GtxCWCLAZB_E^jHL_irDm<-J>Y`7^|@L6a9gqx9SSc#|}}@AoYv z+bh=!>G(VBwyQ5GC-3O^hn1zJK4v{i2Dtdjn@x!*qH(J-ozC>wU z)jyy%4o-7k-@_+*#NRQL`flNCRw%C@>1Vg<*Y6LPF;rGtwIv>DIoI_g@siD%bQA+g zL{gV!g>FF(`&EHCaeb)z>AJfQV8myXcgkJqtLp*Llhx1QYGk31ZO7HRy5vor)<16X z?D8dwAalA|vN+Q;#C_+nzw}eakxFw*77Oe{#aD@Jn2g8!0iSj-qj_9-8m%+Fs*M)) z`5%E^q(TlF9Q=xc(Mq$z%M11zJ1BnZ`((evTfQo*-et`mf7lxL;5oyX6DzXv*e$#6U8!M7&QGUJ>MatYtz(4Z|TW&CiaK=HH+!bH!uDD zk_eycpeY3Jl(mN2!wid8TU5`+9fnqswVotLJcoe0W_=Y9>H|3UFmn}YYz4}-!YAZ+ zsmDE+^vr_8v%~(mO&(#s{B!)c*|FB^R29lE?y!LNt3$)Vw&dG_u`I@PEHh`S-X-&rIgu-INdFSG!Mq$P+Hniy?3Ql7w(R(&1OL7C+&h#p>y}mv5{6uHB{wS zYus#}JAIyGcZlWvUFJsX#XPr~Fm89z-ypp0HGx;>&I0pnM*W){I^%bv)(esgj5PXZ zcG^2$PuoK1j8941huZ#)Ym!Gjcthz77VXE{daPzYcY6oh&D$}nF15<)PAnJ(RhSjQ z@GmyluXr)U;dAg*{9~Hu8aGh@EAlfTd+OH{m=Zs+rVAA7w^M6>k34mZzTQ&G?|78j z@YR!?pBMxD;Cj*a?0jXXb@n9vhR?sn_4N32bqzvPk$W32ECo>w8t_y67GsW>(I9&{ znb(r682MeZeo({%oK<-Nbz@+L*WI|P(Q_^Zo-vhy-}&U(EKQ7i)LB8_u207V-UX9f zjtc~S?QD4p_7S=kzfaVN@f7_xBl{Hubo%1{uxI16 zPWiJYTpyRqg3;1lDc(!d^^jqV8AZA>3b+Ij^$K6R+AJ&lI#u~(C8@ScscS{{QKypJ z^AP+e2(p?YOFwoOW}=9Tu`iYRFk-Qq+J{0+3fyGmBs_gTQvl}CUSE!%atsdhwOOg_ zSflQD6ah=H{BH>cm(5cRs@pw#M-#6VDzaI9(bCSSA&c=o0CUz1Xn%m~6M6BS7`CBu zj+OOtXor`#d9~rJ`RhlCm<u1I!xM;Zxs}P33($9Ixy>aIRQ~n z@oo~UT1M7pmDRZYwjsRE?=_`wDRCt*%s1H2COAP}ZPq`Gr|I8jK2z#kO&LIRYJ^E$ zVj`oZ4_k@#y7|)d6^HxEBQ#i{DidAp7V)bT6ETZ5I2^|J*dcfnMv7gxC=#kRE1qN2 znJ8$7%#9^R_`#$2Ncs=#N-m!A@ZN}z-i0NO-*_^ZeS`jsQCE;7StcoXSF5>bdI+5r z|HSPJY`g-F+W%>n^N#KkpPkcE=R9|fxoq2KP-S2~LQZt_DEogoEYo|N#vr1*CNyK; z=fbP!N|Cb18*kxa63p@)=2VkoH%)m+u}#uzKl;py^`Ko4iSR$N6C@;NCcto_wcdvs z>2STD6cHvo!WB~4?p}uqj;+Iz;K2hSZKLFJ40@eAa7Zlzfea1^{ayO#{(GZ0dn)RL z-q>3WvVwQO`}Sr_gbt9pJ*aqfxLkvbn_|G@f@amylVc#nTv(yk*jsm~l&%v_oPEXYLg;EyX_oG!p!|j6T8u;ibqBy4laB$`++KPP)-KyuFu?uV?1dxflE6x^~N=F zH9~76sdj(L8;%$K3mMrFMVjaK8eIS4t%`hh+A-p*xV*N=^h~Kg#?I^G`=0)-)qCEB zGZmVGnSmH?DZ`CI4+El*SDdG)>%Tj3_2AlTqj$mgp_dGFuO|on;c_|8C-LxG%xe(- z{kRHzjO1K>d(Kh&jO8wlqNe#=5h)i+m8|Py)PAjvv_8xv`EOzcP`=@V6X^;z+o3MP z2Cy@>+y>{kt!Mgv-zCZpY0FZktG@ytu25Q?-G-5=FqE{xmeB`X?L~>Baihk2lS(^kQjT+24a=c;7YAS|Dl7*a)XATP1SoJ0)XEkCt*> z6hMIRW-s3Bk1N6LkP3(mQ6fJy2BPKfrCeKCkak9A0OcK4N^y5)AkUNjF7mrFN^Og0 zV>A2_UD-xRdO?Vt`1IQGrQymxJzoBMWsGT)KXd8UEiorxeU6?DE6!gzaRIu9ZR19Teji3M2&wa!{az8?Z? zz}y=4zn98H>{{un4{Y=V!eNd?0K2(ka)C>|pTyDI8@A;B1cLGCYsRfn62D=rMUiYj z1pi*_r?62|mkN(kN{U>%jF4-EyZ(jGG3NJY5KYn>3pP&R1^2<*|DpJa82c#onF^*D~^F)K~v>wT|0>o{DM9SRV(sS*LUP+y(#B0 za}M05n>z2^nY>SWSZ(qLq#p?lyC<1zO$arV8l7Q0g{8E|kzyoZnBGpv%?YY*n2J7e}LtdgoNpqz1BnFSW5OG;uzJ{2bqoRSuU7c&_97zX-W%Vet37>>YKkpC^n|2BvJ?Uw)F%)tr1&*}f_x41yx SlHkD->1r9?D!$OYPZVv{kD_Y(*7STf_=&joR9(y{VNT_Kc{JXeo-u z9wjAaBKAu1K0e>yd%VZ{|NGZ_eE)FpM0oD|ey;nv&g(qSJCXXjT9+9)7#SECET^IRzl3_BKb<~7)xKKc z=_I1=f~;G1gO9AfXO=pYsvgdAAp5miqkgPPrj7-aIh3_z_0v>mYNy;TUI50%AhlhJ z3qAq-a8vuF=xrr zO}k#Am1!&K9PdPiEQlC3G2$ZHe-6e*3}=p?U?INyoAIE07-Xl2^F@zfgXKVWn5kV1 z`%r>aqv8H`5G$^LJIh*m8d|gwFhQU8>LH(E=n(jR@|hYn-nuXmds(WlqhR; zs$;H5QsOti2eEb)II-f2BC(Bpa^P&OIQY=Clf~<{DPl6}soqiP0bJRxo5$%z_@VUV zz$l6`%|k{~ng3JGW_;+Avu)1!doN}Hai~suv zNs9{VHRp^O*??~cs(}Ci3uOoyI-_w)wBPyK^61ruks6g;!y0S-kpvZ3-pTD zNaA73vPg#=)2N80|G}(NbIha26*7nKOtd7evw!7+y?Lq$n#c|N{!Q9zgSW^-X~#7M zI{LBvd41WG{#e7Q+-5EQ5(GyMon(#~As2NLh8SE3ViXZ4@tx!FK z2yU6Tzp;W+ta!0sJ}<*)^J{TCdShiqC)uL;^`A$`T=fR{#%#jStl>^^?ThNfpeq&2 zjHtYgH$P3aUb9$X_y2A741XmA)&Or^Rk8_Gr0FDdZ@$odXsvYGguy!+c8>k=+#L1W zMU>d7_t7Zx1Q%bB?Md!_kM5=9!V(8jQ4uVAz=8y(mIAKjN83NhVB`NgMd-XZbWXfk zp?O`n^UFelctc%a9Lr4?TD-L^jTf=r)&u!-)kWg9yS>!0%>n8^^<-4t}6h#(4;x~cGRnEfi~ zVI{ig$^cRD;6|){C7gg}e(!UGar=9yLYCcr#u?MZ#$`@eGVk?2ELIv}V^><~XdJ9b z;sdfiBfwtq->O8xit&{BzH{m0(?1-<%?!AbvqeHgFW!#ulEGK1FUdeywOkJ7+KCY+;Y5iHl)<#%2PU`+3a3W&?HZ=Xyk){?EBY~ zw9f>n{J!ELF7MwqST#Uj2;MF67XqI1oa>k9e#JL`+L8Ti3Djb%sGmV<&vor$c>Vi8 z^X$QSOmU{+4pTU-!Db1wB*9*+>uFSWt1Fa%q_Mr<`7( z!As&9uZg$U_}&jz6;qp(XwKn4wcfqoiA!Qc3rYRi9ZqvrPoeK0RIkl~C3c#YjV5zH z(XOfZHRYmN9kO>jA|l}y8Cp40{mBak20KY!80p{rB@~scyZ){C8&+%E-I*LSOIeFh z(5$YX5E{38U=TwYyI8L4Al~%zMU|vDu6;(lSwu&9DQ_c zk_#U9?|+$h7ufpUs{FYxj5)iv~8)ps4eNWnK-BHJ4g&QG3Q`sg8ZpMlLm*F^b&m5f_y=-<7)0> zI(DAz7}9&K?jRrgc^yJPj0=D6?B0}cB%W&I`;-2uy@i~woip2{ zsmkJt9IBLma2Cw$%$YDL8mp8Uo zh2NFqfkL(>ql9r*Y&IHW^b$%+CATeB5~S0*avr6drJ%qa@ZG8%dFgzmqaaRe>u1^@ zlPhd0EZaXhFpCM$4UL|jaI(SdP6MOdqVS39TMa2WTZY?DL=52D?K1(c1QzPQIcG>R z+jxG#L`yxw*myjHdYd)i8D*L|5yHs>M^iGF)!m`f86kr{mb$1=$m3`);%dB>iIY_C zZ~h;OtCJ!_x!A_p?m3exF4sN&A5o0;k(=Ve_L>KyE*%d2MI5AZkh z?<@5l`T+YD+)6^F(M;j9Pv>V2|4oJr-TkO1PKSfy0*0nzQHyf<+?|@_GM#uASLJ0f z7UNE#6}=c+h7@E%^k#oS5%<9Mv)ln`cB?6B$4AbY65UWprFX@|EFL`5(2RZ>d13DN z*#KMW_@JO!L^zpDo2;sey2F79AhTl{&eA95VJhI+I-mTP%x`L@-0+_s=>_y=^yBLS z?>#Ca%+x^A6zt=>5m~mW!)q(Dh4#)QiDVZje_DO8+kjK7R%RsT0pxl@wyW>@fRON% z&@mtxr|o8s_!^-`XCxo4)s3ocN-YwugMyN?g478H;YrzSD0SW z6kwO%dG~bbB6c*`IC*EthPSEet*a%T^nWV)gu`k`U-Q9E6<9q}C3$X=%65NR|13>O zxm9U|Gk>0m7WnW0A53qe6!W-EdL?g>QWK)R7D$##S8Pg|Up{0q$1KpKooR!({N>KD zUquT%76G3OrafGH;qyhyYoVqFy&yQmlZ`D6Jk25{JeC%AlA6AMt*@lb|lg72#DOt zQn6mumoF5Zhqt7IinxVUf*0~QPYmZk(62sjwdL>Xba7X}{D-Sgo9dq-U-{iJH#CL7 zh6RYyS2RI=;@HlcCriL=zqEJ76_=gxR*@&y%!uVl;yw;6pX#^ zdFeyr=MIF>jFKKRqXnBC7}l<2)MnqD%H1Snyfm8eV~fr1R@hM7o%nRG_%XG$^`jY= zBem_QAe*ExNv@E~GfXOn+Dmn{9GLjdmmRy7afjXqDdA-O3%~}fNCeHuhzSPCN%(5r z5QUl_^`&@E!}gc#QDtQzqP-J`kVO0&@SVd|X-uDG{ecyhQor1u(4AA#xA{2Kc31jC z>8z+-$k~m$XPQ0Yg9Cf8Mzo;M} zn!^3ic&g`~Kuj>iBgh>Y94>P3>c5&9>tK;oF4`w{pm^DuE1oE3nF=IYL;L2?%kj!q z`;8npMqt>*CdLC!OeMy74-Xwbs#6a8vs9=z9u5PE;x1h~IFd0BA$$SZWbnW!#By72 zYAIRv>VRBnobWF(jhRMHHgx`_WMr|X69fP^m7aTlR5)gwT<)Qx?%9_5Nul2;mp^+u zWD+IIF$?w`2^+zyI;kEmIxY2W5{Iu_xVYT=VFqtQ*X$yF%C}*f>Fbk zZaK_*A5LboZq~G)IWI=jG-|NSh_kAwDRpPP^vL0~$?yC;7SBZ6!DPei0`61g=&u~07F%~7PG6Dy@V1kk83^7IK{6VNoWOE zK0ECq*BktC9r4IRR0BM?$E{WO&8tDR^{Ct|`3i0&y5IxRJD1~)x!^Uj(~NSkt0Jv8 zVC3MCp2yBB_`_&6cg|ONC0b-Kw2>{bCs9syL%rWfgt!>qjIlOu;0DmvDUd7TcCOe- z(M1C$<3JlVuMJWxYU66csOuIX?=UawUeXGf&;LHwBoa3VzC*rcOu0HGoCtrG3c%_w?Y%co}2x-bbX$1yj_+%mOnrpRt5=wBW? zyfQI3ljY-kV{jN+R8^I?#R(h1TuP`ENa~=jRW%QGCWs3sSI$s7v|>;!dkZQ|s;09( z1GUKQpC7Ituc|Cq*{|%)KB#78jxoJJt7G21Z>|qTpGm&fL>7(c$L$Y2o%eu1 zBDN`5k%YM`%gmQ&cHv}ud(h`_vHcwAwX1J-Yb?9w^oH(2Wb%~%Wx)fo6CI%5gLe8#Ip6IprV4x}HO6{P1C zCBf^;vjiXRsqSy*9anr^6v81P{GEz!q_)~n6GVmoM5@+WGRA#;*2#a%i8E}ze2x9> z9)^gH9s;Gx1=2}uy1GQ3=3sxy#U?MU-@2Ej16!#-8Rag|%r2cad2o07UaooG2|uu% z_@iVo?p8eEvx&Yze7P_le<=LnyTmJFzuMY1W|5?r>AlKgG)DkTuE^tqV>%Z=1(ck+DyCgc8>;t->TlYIG zwwZFozi)-Opv$}K!WN!WmbGZirc|-0vsTPni&d@ReAnDdYqiapX<3`2xTVdaU(cB= zw`o;TiyAi|EO6VUZfToo4XlC)B4PsoWC8T2PHP21MV!P|0q)9vp0Tqb147QYkC+U> zU$Kn!W??ormxN$TcBEw&Z&D-t4(Q%|2~pw=f4yh>0esiW*yjovWl?&NLw{x5-{gC1R- zBI?-Jw;^r+gYt$t0bmRuadZD8B7JNx_~j~4o8vhkl(Jp|KY^M&^~d-0c1e}O0VQ@} z%{;o01h(waLX}&H*C&@Xwo<@Q+oit%(;>t2IUmZ&QznLvdP!Uz8>&h<3R3mAmcf)i zGqTg%2A3y-CZudexQFiE7h*g7Hcmtb_U=|+Vq#A6ZQ)x$S< z9S^ef5O21Mz}Ew7zFE{K+L3ISALWQ_u3O;ez_cFb**iVTpAE2tadAgB)cKCs(C?SE zY<;cSS~Yc|KP6OOI!j2QwQn?ctD06C-6x$c(YsF7eRoC$QEr~06(KWUqunDopPz ziL}TITg}cT?M?ms?W(&`$*$Sg)j zbAdgt3T84(h-+_rtCS;Y*VyK#+;9@?Lkwd*Kq#c!hjAJ`1V$({^Ur+b0%Gp=|U5KRAD1)E02J{)ePt`vd4@o^nVg#b0 zS3XOSY5+Yh;LUkQrj$QJEmQojO8v_NyAIBY$#4kFDM}`>X@Uk~FHRd6v&^$EXo3u+ z183$(^%6(28f63H=fjdSqy$v95_gN3xSNAHvX?g69ruD(g)oZxvp&(`zB z-1&`qDtRiyNA&>hz4ZavgAld3-U0Op>-|09GDsuwrJgV`uRIW+`6P%>RBV^X4DS_rG#c&vjhh?F)3KIVLTF1YU!zGzm zv4hojMPr2XTB8b?w9A+>G$@t0m>6) zLz>i}cf9YAz=$s&kJu42Db`~=0|}D4ZZrJn{`JB$*jJdiDCPr*^kdYc=jaLU!-0SB zk5Pilm7x*{Tg{HC${NJn%ASepXouG!1~dycvcgM_{g6R3db|ZIKwOHRRkLv&7Cv=q zj#{}j;^M2$TPi7>#AfB${mWBf62RM1`Wk=s=$=>MRkjL~oc#@=6X9f=9a_TRMm$fp zt7spxi?;y=1WtbY8oHpq$TE)Von~&)rM6xHj9K=0%s{`4a=Br1f1v0V!r+PmfFpOA z=;@wSw}0oQ7Eeb<7YlREeDgaTo+J0BR0RN=&oa;w3VxMYoKMFG1;n`pYKWihKsE>O zxf7J|k-vonO@X48yUf^e!)>%oBB_fc$Cm_`;W4^ZSG&J5dYv3gPNS%0Bly!&h#T!t zPF{G`?4ia;`BS}D<3i5ajyb$-f7=a*8oNl@R!1L{MJ9oE*^1mG&)xFUsmW#S?B$uI zrvPm6Fwl@3xAknX&jEqV0Ggx`?VNV|W2obAvqZ=4$w=egX(bjFv}|nqM*2D4fIJFV zCQlK&(T4uRZKW{}2IC{ZB8NR-<@oXXlux^lBW+G!rkEiD@7muk@e{cW6oLJ&I6auv zJy=fEoeqLvQb#5g3!4ARmF6Svj=}SIKxUN|Z-VXxMXjF9IdvX|P(F*ej!y;aJ>8w~vY5F<@f8E}ROlTwGbQ;JULe3k zkr6yi%T#;NK(tgD|1zi&?GBVPHsTEIo50SPz(h0KBNRZ(#7FBn5M+NUa9*m(d$eL- zt+xN_v2X0Fu5g6Eb(l|jy_-t|-PL?<`z^`S-UbgcVYO~dI1&~Rvh=kyQ_}1}R@BW+ zd(N+{<)2VpN>nmF@Fbb=YJW+5S?S_oc>}D@1Z-~)c;kO1%g+WCF&}2Fy7|M?Z`LVT zR^#4zfm;AS!`xEgY4U6|Ztoksg74^F&0Bm+ZRZ7+e_M|QHg(rFzL0jqOASr!#nfJ2 z>)dFcP*ZZqdAgszX<;=gV(T}1M2Eh-@e2NCn$Ky(F~`m8Q5S$Dg~U~;5uScvROE6g zlZDS_f{n4!>!ozO8se?L>fook?oV?5{@b3^cE`!1_YR7i8=(J4?g^8qb@{%M#@!|E z^Nz@XF9|+yC+m5Y!{G|9!9&qZUpwi$YEafnfCxuP0o1MP}BWJ|qJ;Vwdn=u9Ukzl4+pvO>cM|yV0(# zoBEmOp!;y>V;t46=VI=0*O}T-Yyxz@iLzxpVl1zEtpm-|JjV-2FGub8y-TJ3Dv)#n z3Odx!{Wh7&j*tEcnQXg8U zAyu%`<)4;#+V^-=1>G0yhXo7jqR^clLxT>nS!bK$7sQMf|vx?=dnY*XCi7! zMd*aLr$hSd(9F+(<+GDCZ6$9EiIgec&@qUG4u*}$@_ep#^t4L!ic6i|LvVB%`zou) zqjY2>C=((F=Fxy_A24MnU~6UFWC`F8DZ z4kCSmDhtA5{D9kddGN8o?x0}?!KY1G*gK~fx3S$L0MKC)4M09HVm6){5=(1?_)&NF z8Ob#bVjhlV*Ja_`c==;Wfu z{Vn{|_1Wx({gZZC3>R?`jxSZ%Uma6(dNZ18q)F(Xqk>qie}&!CkYh2)?;Wces#~~J zq%{aOK56$Jk>zOz5nYQ7GEtC$X4kC5B^uu_t_@URg9g5=CWl%YdFq#ZOuc=M(Jlw;9mRd$a+_Ks|-L!w*on z<-xDba;n1+R$?tD56kIKWdJ+=(tlS2KuHPW&v=`cjUV=$|B836*W4bz?F6LarQur6 zLAS3KZA0fPUS3LXSc$W*-fg?LlHkRpn~*o78y_(rT4@m*Xkjty*#rod5~oHK)eZNA zyAE!Tl$St1C^(J0iSJPwhOkKurYE5=5@IH3sp$DT6KbvF!aW~()=)|?Rd)D}aG(m+ z-HT1rT9kE?+!8%#-q*-)xnD~*6P7<&`FuU2_0TMh9q&xk+D-tgmR{o_X z3?VKq6nsq1NWGrrp+0tBWOuprj^PNC2$ST`DE&&|u93-VF$5FxDo6}MHH4zz&R{+H z5m#R$jdMCX_Adi_iS%n7sZJ6O3;kv3(t`61jx>>9;>^J8D6E)`f?wp5gPY)lB!#c zmTt*DYS;UvV8W+)?pUiGCG8{{8r{NOCC5vYkzq`MPdt3bUB9~Oz!n=Jg^A8`MzXkk zGhZqIi>kBm69Pw@J>+K&Rz6+@ZEcr%mH2eh2_o1nxh13Snv4E3cG^Z+tB9!V z1}hg)&ijYJ&b{ocEC0)e+L67efqQhs^2uha>ukm8JQI_?MwwFIOZWWYrbfm8 zpklqU>b}sSBi2EMuICcuEYp!1u}6z36>-B|Y4cKJjMf%`pQ?_^54F~|jc)H~u=UO-brNm z_@-?kGJ8-f?hARKQ!V)%@y$*--8JJz^CH&P=IEs9OzHBOb;mJOc{k)i|FlB#%Zi9_baH+J(Z0X;1nILv-JrYR;MW)4-tLfbc+_2Z2plUg2*G5~$uIC02Ro#)dTPhZZ<+w%k2W z2;$x?R=I=ywok23Uonq*;CvJ(@kSXjy?O>xq!aI>_Gwxosphx`pR}R0X(3S&t4WH& zbA=#Q2p$rOoiRxl%=GqXRHimL-pZOyZxgYqdffEyPpT8uzNpYEJ~hi~>qxm{WYG<} zf$iy8u8r4BI4rj6S#Q~1{Ey7p+Vg%)Q3WVcHPZg=;TWBhqB$afuDeJyg2)U{xvueIr!b+xxbqGYx&#bcxsAtAH!R=NL&y045K=b^HzYQ?|R{J|^z^eG$+0V2S5 zx=^}$-i;-P-*rGyBj%KwY5Na9fG{3LvjdO?3QY1noAwBk;#>yF!npRL1ui4=j%|~=o%cPq7T&OzzcQ-KDXn-+VR3uZr@E2wy>pm`yp1(p za`U0C{(G70SgAIcbxo;-;9e!tRVSV<+M09w7j5Y2(t(gj=*|x*$H+JI_sg}~gQaJ* zhssjLS!0%KO?(<%XYVc<0;Q#yw8h`03I`f-Z_DSHx$^hm=%;K`tg!5uoN$Mz+hss9 z-<~LpQ*yz1u);ag4UoKB?mxi`SUAQX>1|wl*c0Q0dhVt`jPjlz!KB;&zS_3DYWudlW$RDXi{SBZ z4Ub<35u}qYWU=ayh?akftqz|i@zTEbi0h>qoQ0g~5nm}84jbVAeo|Az$X27D)qmtR z0+kju{Ss_Fp?PXTv3!Lnfe|Z%{~f^PA8GiG$B$n|orTYJh7A6?8*DN0p&~&XEnYVD zyM^hj?Ty)A9FI!Re^oOv=2+mh#g1C(bHzhXU+&`4j}bdzJQK~ByP5ZS53MOcfwF`z z$n6L??*A=yaso15Pk~D_sphd5*-ZdSRADM4hMh_D6e!>g!&I2j%{TVK~iq(zp zBd@1cc{Bl2KulVyAp#|st2B3V{}~>lqhW7|rxxTTTi{^=TmXqs;I!FF3>FBDXG=IN zDY71ifs!);7Itn1@8{57Jh}KiBHP!pYPDQbuLLJ2b&ZH0%WhCqG3Yq$ zH#3KpbQyNm3?g;xH2yN zUn#>XtdBoWpZw_fi-%g~nn90~hNCRE>+{G!@EY8A8Y!BwjGp$GA8ADrO*mDpJGeOj z)uScpsiRQ|muFvc)s;%yrxQoF>l5EUdoFx%yHn9`;h*d){rtW00 z#ddC52(sr%227qHXKC8)aFO4!@ofm9Fe4`3!k{3WSOPl-0C?t|6n_f zW*ozP+*nBFMo+lLgC`sg?pmoe{Tr`T>Qk%)j8#sC*q*6niy+ST`sIAX#AvUHr)*Y- zug>V47BTEM8Qp}B0)8s1C3F>E0D-fE8GeS)7Ydby#=94ovo==8ryBP--?&8ZMBA-d z2a=k+Ej=*BcC1=AeSc+>z!Q5phy0HF?HlxT!7Oi&G?`$hrn1%4BnNj;>==1(b+YPs zDiU2D4M2@Mg?H`>5{7Sy)E8#IYI=STF>)Qf`Mt(EjSDkOIdBo&=HrR+>^+L;0+nd_glzf2%$!XMXU0+>?NoH$|c$NE1N-B)Tcv%|6&R zE0ha}pcz-LN^w+Y`*(ib;^!Te3O}|aSX5zO6r2w)%m{K)^cv`$$9j|}{m1Xh_}mds zDbAjTWJbE%dttk5rsN(*Ft5ZDEmDljk#!#-MRP~nNnQk!X>XSWD%_-tTi*rztJ&eX zE)Xa|uL+!>!v}21f8n!R9nLHBSNVp4+LS!I;b>e|I--0;{3KGMBhyFzzM^L~;4lR6$dCf=;P z1(2BYyej3TR?+s!9MvI!E#lE+?VTiH7ctU@y5m+ECfzOe!wk@zyAMY?r8t&lOqR49 z#2f1llw^ZE``T)CFP#+zV~nPA-KG0@J>u>>uCetTh&x|dXJIREjBQBS>h@1-Vmhlf z<+#k#Qo;YN%qvF1q)Lk0la%O0$e%*pp&o5C54Hi26Ju`Jk9SVzp|!%zh<3`f6Ez{Q*g1_kD8q16%Hw z78^xP$4xa@#9nw6s@m1ERO>Vu2Y3U_V^_#cYLwDvRkZ=*mTrw5Il)F|*M z322-O`>mS`H<(=qMPR}rpXVBl3zAQky5r?Yx|`y~WYT-UYvSv1iEJ5=_&t|sm1?Z{ zV9yiOP}&y&7s~O*%@poCU>0gVB4ZVzvCDqN+!JHC7Bh-HgRzGK@PgrT)L5!hJUq ze5NWdEzPauKFSB!S$-E`!41HzD;)3_57lKif=1w-PZ;n0ofjFzj+B+JD!ARPb4G`^ zM6FpA$iCP+W_noAQA8SGlk2&$#vpQFj=ikBlPRz3ex?Ip=XkDXuNqHj zztQ&i%)_=40AeFiwi~zs1M@XDsmC`mGBo4A>R|u1n)hP7O7uDY#Ge?x4cJwCd=Xc* z&-M5D?*GlnXR~PO<-BzX5?UrXiz0lHNprS_%zCY{fx}H&*k6V%HeLfgheoV%qVh?R zE>qh4hZ>>6*7DSda@`o@l?s0>5NwHLJE+7VM;U|j4A4<@p`B3Wq25!{94Cy?bgs>! zghA_H8OrVsnvI}K=?oYBO#=D3Z3aw|%(uadT@1+O%A}z${jc*r-1D~qF9l$oc_AIn z@xqCZ`)Dsr_uGaNd*mdPpq-$*EgUbgqoaVC#;GGeUJheecEfPziFTi2)lO7)Q?mL_ zQzXl9&}wM81o`Sqyb`II`=v%OvY0t)CC(L0ff~x4DqVB~zDT|$mq$j2-p33yk+@ohmb?9cZId3X`AJ2o%dw=hRY;I zjI5eB-fWJu+_8;x;pPW8%3;xjQL)ZfqQWv=O~)>s>%;8-#7wHHj$Rg!I9T|G?_WT% zm!B_Jm3KBXYhC{{cjT@uC+X9!dnYN zDsL@j*zEvTMDc-`hVIJihhm5{|DP1M@#c+-2dF@5b1VwMhIc`V%a`on##?T-Bkg8t zk}sHc*kCJReXC9-<*P)1;1W5!Ijj@0{WY>(B%F_<+S+sZ*VbPMt*Vq+Do9h1qZ$Rs zlHP`|b?j7`aU3FYmR$R1xUHD~I*i<@|f*fMCY>f*7nsP0tw+*P6Ak1 z(4&BhW|}w4HTpAT#LApSns zJm9GEsPx!!C4nfZhxFx1dQW~=_tj9!YsGVCXQsQ}5eeM_SfWL@+P|6S5_`n^RbKmZ z@b-wi=q_>`52d)29U0qWXWIn$t+ra0zi11WZ$&@Ig&-Gff9W86pH2gX5!qs`|CZcP zKocVJC=0e{jB2rr_ht;5_ZT&c;jn<$4k5M|$*E>h^;QQ$dd9~4IuNh`&R1ntN_{-) z%n0d@isz2nRcC)@ai5C)C8uo4cMa6|A!#<6W}K}CeLa>!{UacFG2Z4YP#Ml)UD6@e zzAxrkmouhQOtd+`@P+RSeIwY772sCyA&y-(bB06{ zMV3Sm3u&wR{4#$<_1lVo@+07cfxRm@5y1b0s?}nwUF5A- zVZZMh@ckid&mO}gOFD>hw0Ii5GtTve}!F%909R@DZZW)Al~Ss zLqG!F^A>52yl#P{hsJkF>+CSlT4C{D^l^C|@1(?%x5`I(DQ2QKxG;+X;GK&|8&}!U zKUBFX6YWvvhikFCN~&Uk{VYx&RTpDx$)S{`tRCH!!)2*(31Dy02M9xQ5-Iof`CesQ zGPi&MZP2;a4O*3b7;g2`u_XOI#iZ*S;D{^!!Ld8Y%|X{AN4-fdZi*VwfN9XvOs0(! z8*au>$Cz~E3Y20|$QMvlrH}f}K*AAgw-Sgn67tYknFwafFxr6{KxI6w<=570Ah9}A zGtgP6rPDH|;5=Zh^fpu6O`!%z{fPRDP}YoA1FY)QU2g{xy){xa4tFb%gVa5Z*J zLIJAjzupsUD*HP4GtKyu7%;xi|G`U+aa^agDwtf0C{0PhdBx8^K$L50i8>=+OrDXz zy;h5mY;?oE*PC4O_|LP{B$D(Ad%6+wp;W#I>lI5Z9Rbcxh?Z2B1RO1ShJ&+Uwx%|x zO|#Qr?i{UzXkgNqInsxaHn7pt?pvcTEQa9j!!=v_M&~nwLTSbV*J8(7H`@L)sXP@z z@7ErfKV$;5(Cny4CnF(su<_T2M6TD^O%4mjYiw&IDS3Za>(-Lel;RggV%rJl{~>n% zlS1)}?3b$M*kk6i6f#Bf@}!flc6mj6rENY|;a@Ge->JCNzA^|1{#oYZAk^B_eZist zaU~f`IH}Yd@cLCThTFzu%Mo+7T6*TF2mQiKt*~aBlDOttqg`iCNV;hUm0++?a>4Ufc*+k-YeCy_SZwrc*d6!gmhpM+dAdrWb zLq=oks$c7fOmO|Ntlj(#xQ}|Qn_8YBqm;KKuscT`wgKZgzY|WI+`}b;7y4!&WW*75~0y9=(THyV4n z$&RZN&76QiH+PLqR}G!yzJvhuDj`evwFI55RzDiLW(0|7jkY<;ij7yE_LcToHIE^9 zifTV%Xwp2EAw=aOqIb_ltA*4*i0@k4S{g&9gkBL><5(@R`^mJGeZDsDjs3mfPDCyi zo8G@Vf^$dAiSksg*F(*K@=ZF&b9d&P8laZ>&;93Qh1L7|ImO<-72S1%O!X2@ zzeK1rOo z4xDkn^QaVP7vwV67g`J@>OY(9eiv|>Z;E{iVPOEyy8t(~IhYu_qL-Z!@T6b%alF#i zzLcuw*Cd8ldaN)82KHQ~VYg>m5)Dm7Y0bO=-@gGK=J+T5SFKL`J_Q`-V$gqoeEM&C zyK!Z(yOy)cErur%lAYpJvCjA|3*gQf-Z8=he|Ad;Q(VS&5)ay!J{A$KjP_JLWbltV zUTEPYJDK5zWYVW&tM@U<|7DT!ofU8jkl|gL#dd7%@zITf*m%|Hy}m{H6~N#7N1*WA zS}@%&mdx&0UiTk@o9@odb!fapNxaTVqRyay;{8GgeFt3^7pumnZa% zg=H=VwBu*!K~05wLl+O$wiy_{n*d?WPRKL6+n(W5bGWN%*xJIw!0_PRnR^Sh2%}{g z>W)9K?kBE)PuXps+0Vp5sJZ|B%bUQTZCY)f3)Y`bMR6Ni*Le|;f!h-+zy~t`5B{2} zGV~1rnG481lNVS4pYZ>gnIbT=rN178q5YvAX9R zng_$8e5bQ&4rV_NJytt3^J^ef}lzEczQKCd47n?1|SHn@C4?>Q_j=IlyiY@=?c z$2Hr)D;$BA67g#N!9j#(ztIg}4rzH((JI=Dpk!ybrGIGPp*!iBaV3i>gH=(^H*4wu zE_g8Ll07Eby6vUnSw9s`kVo0o^LF~gdHrU^Qb6=6&lgt-w#{>`lHzkJxtzn-h~%-sj(VPdX*@e_qGWPsH;dLmStP2H& z$7XY~-7o9Z(4Cwj6;JuB_~t?XZOl92ub*hE3w*V#y3~1rl_Nf!*it`bhAGVLbT*;X zsRiRYl^!JnQ9JBg<03FN%yN3tVzqfRxU8-tiT_r_jMBEfQt|}G655(2b{SLWc)itr zPvL8u-O}H^p*Cj@;4q9p^vL*X?@!&6(tb$>)6 z*fXzIjO-MX`dPR6Y`sH<1MgdcvXZYw=Q&mZ>Qu96lPI>P$Hiz2`b3I~eW79b=YW+qwMA{a7G}^Z4DC z66fwN%Uk|#z-~{GM$b?`Vxo2EiqEnUbUP-pQr2ZFc zICsQ8vH2Ib^H#1n;-x?wQYD%|y+7m1GY!7om&t2dE36~7W7pgd?aN{{JA0a9rsz?e`?sC#tQWNJp>D`P3seJGG2a&jPF{1>U%_nJ4MN`$lIxz%)!{<{Y~Dn{RAo z<~ZC{(rPEtxp1zr_KX6C0+KSp1qDaLO3xr&LuUYM-PJ4($wd)J(E z@+@U@j#ziK%>bzvLx9HJVvmW0h!{K^5v!zMIXFbsUBZvcupg9Z#43XI80$`Y?7Y>Xz``L(m3?Z_!+ zj9F8dTw|HoI&y=HaKBhhE{-YDR-VZ(x3RVw+fsF?Zwk7`@srW@Q%|nCY4w#B4`e(+hmXE9v7U>q|!HxPfJrYj!HQK;-R;%&4btPUn^F%({!2 z)t9F%PASZ}+uti*Dq>!NW940HpQ9`*>9*$a_`5&dJ91vnjYiDJL9|AH?^%I^c97Od z{c?yq;e^iO_BSj%8t%%IMDCuhv@-%BJ>y<+sI%?J`K3Nyx|dj&hG_E2tH{?zmQ=8Z zcwk;$cZs}EU-NvD%^4?iGs@pWDXzx+NnQNg5?@z}e|{ci#O}_W{iWc`p%7>KytOc= z7jFaHUcr?IEe%MWba=PYXx2%krx+7vFJ=LyM+5)2AL zGXG!gefL+A{r`VED@SIIa^32k-JxlY+@sXAVVWsuE*y6`0m%e6t=l~+@3fq$IRa5h z1-F%gr75W?DyRvmIS>&yDxa(O_k6zR`#*f&KXN#SbDfLV>vcWW^Kk_&K21!mij%5} zGI-==o9hO~hT*nATeeQ8%;4;nDnSOtc}$XjW-T;j)2L%3g$=Pu0Iv>XIC#<;5O5Q! zV!p!N4|JwQsG^b4R^N0P7s_7`m-Zc=n=XG45M6Z?sh<8bTq8=9z3l|8fF;f-bUrAf z8Wa6+nDsU1HY0w?6LHVFrmt8>8>ykHy5}G zsxq$ykfM=0TV3rqLLe}AXJ!!=$$^mu8*@Vpl&!9v2R#H1YcV6yn^KYzbco}q#97;~ zk(*uz&d#d|pCF=uI$7z#{B*RRJw6_>X4?A}xulf^i!>PrQ8&zZo(_uSZ4s(4Zq2z(f_e4rJ z!2QcksCV>dh1(%#$n~tBKMI!N5#)kGB8KGIIi&ortX=p;1}mVRMa*G7j(RJCwYg!! zp$h9flD*wTTEua%lV~Avh;H38t&Ile zq?)hMH<0Te?|ECQUsLRDD9O?AubDebv0|*=@4I~1bkp-VOPO*l+Mj@D%c7No*V|KE z@|__ybzJu%?4oH^)K~^}YMI%_QOoaqs>fO00RE?!oJZ`GZ$hy%vFyyWcHA(hueoht zX&Et8q2PGqh|OH452IFAom_9ILg{&Q*z6*F_osb-hm1aKp)6gBf6p<8b%@f)PReNT zJ-GF`ThncL18a&@()D9@XuFJT`CQ0+3~ba^cHE5k^$Md%6szxB(cZO?C?PT@e3Mtu z_$u|`k9Nm0Jq1&b6@|oBb9O?3EGfk7ZT++H_ieY`y{rpx;l1nwI!YSNIjc=c3fJ+U zp4D$8j;pd0>=7*GpuY&|w6A8R0Tbmyip8JGU%#q{>iAl-`iOOr8im5|l3-(9KZxlC z(!SMs6XxYunuHJYR7~%v!xZwJTana z@{X;MFLc^%|9e=Tx_nA#dsGr_BNN{%ayMj~rI>Xi)TklHH9Vx3K?K<_{YZ1vupV!n z{_j~~QrMTi(_2$F&#tf+=>}$^o1GYc!!OB4);9;rvgo0IIY_S4aL#qYr_GFEkw*8| z$K1?F9#S593)R5%{b^{tnEmS)YwD`S^!vN$R@3T&?Cr{M`wd%eGkt`kmJ~|Pb%O_N zF%XgS^sbqKt+LcK1GDk^zmWqU{#4x|XwoC(*QHnsbBfz<4B#A1&Niu5W}SbM)jHUg zy#AbYk`?NkJk8b8F!wOYx@WF~En!m5<1@F&{k_zaGmCztVH#4usr+b=UyAj?)#p{? zcoVUfr3NZ28vTYFwQ@aqJPN-Rd2=LSX65zHy5|0mFw>f2r&;wQygT=QdC#U2QjLVD zLng~t8~$Bs%TdoT{y%^SPrNg{x_o7}Ew16G2JvGib*Czc73ntlcS=tCF4eqLBu8K0 zRM2Wd>4_c4hG&HDgeC)zVJWmi3R1#%$&h**y06E;!b>a9s|!qH?@hm~0@-1Y)dG=hnYHs2L&M6na9aj#L> zgi-vb)4~zii5E)lgo8`sV~3iR&r;ltC&4m|H9`SPq9u#wZ+9g+7#f0zVbPkN?N6=C2fLD_d^K&f2x*BS^XFKXeuen4h9|aUl49fp zf*u5)r;FP_@CO=pPfXs#eRyY*CT3g_5H2}>C#5rIVvAVYE+w%73z$KR+Q_v#T;_gb zM34<<-mSmh&~XZvoVLXmw_N&8;k#R9reSaJWmvEz&B z$uvIAvGnaAnH&Cb7n8kquJ;amyUB$z4Dw2YMfhqhb{#L`w!mJyZ}%D~+6HoSS!g2m z(`ljn*l&>VRcFW2Qk+=M^Ly-8{=g^Pk_|cHR|>7Qve|lM{Vt}q=lB_m%zw!BX-E?| zzyJ!!yQwrqMY-s(>91w-w7dT}u{f}ETQBMwCH^*q?=Ij2Cd^0IP>TQIMf!g7d26v> zZe;Ja+-IC*6>aIru1N2dN^w9IDimHa{%CD$Hk$VU-MEc^S?+(w!S;Ck(Sva(sKt4p z7bu)N0BTVd6_CrG2ZXqd*@?HXc~f`9@7G4=If(z8EWK;TOPsx>?3I{Ih9}2-1N|W! zCU2irHQ%i0s-qRFX}t8NwDWdzoXhxN?~6+K$^o2f!%g}tT}o_{Z|mUSnnY(Ow+^Cw zkVLzInewXu;zgC(tq`rf2t6eIw%iP|6|uI?l9L5r2ivXqU~IqxN-Q)x+?*nlfSFjB zAV(PWp26pb1`m`!4PIL>;y{|{I)3dD<_Rzly($E671|o>(f#Z%5Q~Tq&lUxxuj_$k zi?XZl2#qW*ca?vBt>bOcJt0jE`r;jLdfq+x2Pl6&uO`hdo>IT~L~G!kjGDMMc^*N6 zx+cWl!>>`x)^ajY;p4p1>DkFUym#f5fxe7wYfH5Mb)ZA(`_y51_trw9nno}E2x9d0 z0!hsxU+7?*gnO;y5vfAUCSdw@gOA4wS=i3SouIem0TnJzMK6Du4%t4vn|A;cmYjH} zti{XPv1Z5MFG_$%r(+6h$T4^A-^-uA$Bbs@b_Q+EzjLH-HMP{5TjE0g_;)7G=Y8Lo z2bx5-n&-wRN-;qRwB!o5xH9;42&{s)Is?J&2^(xrua&eS77MHSV$!`HV|<*v>o(R2 zR=B}6(35lujeepNiL0(~wz_)D=FHd|7nF>*pAJWT%}tJz7fdZbl*~idT>5)eMNB^i zrjHo?uKh>i%+TC=@cGP*)QMRBdqqbl9qU2JSwU;Tzc&n%Sz9CW8ee4P^n2EN1)#N? zO)-6kb^r+PuF%x8)|t)RxfXq}=LitcPdZjK`Sdg=W~V^6HLwzUZ_&X}mx0YeJ+5`h zG>~JfKMGpq)88cpf_tRs4TIzeQcga=3x|~KRx*;zy!whOu!P%LC`uo3%cD*utqdaF zM!?{XCNR_P;z0u9ceof4#lJhn%rDq}%N_hyBycSAwtgDRiDA!gDZBX7Zj%3O9{E#~ zLcdHlINhrkASrakcLh|G9-fxxlpu0u99LB3SyKRb6uG>($Z`m>vp|%xXcjAV+ zu}A^a0;dp>B^qWJrrW_YN*fq0rieR zaExTZ_s;$%c;LDyOv}3HW2~-gx~!P3$9n_$hUkb91PGfpddF-;MC%&7B=0&F7O)b%#hrMmi{FK9?@p%l^_*XGOt|3V)`ltPAkK|98ROl5oL_=jOfeP0H zV&;Jk@{$GHMD6cDPrz)?cL04J_wEf*eIh{1i^gzjIVgBOPU5Vc9OUKo=#b-_7)1@rC5HE^ zWa_PXorztDR_SgX`%(~3GnqT$BTOFS5-;wKZVoJnCM!{9h--evw5#G?Q;Lq$LHCjF zVrV|OKHwrHt#xt>mX?Uxt!;ebV+cPD-4F1YeMZZl^fD8`-hXC%Fs7GhN05(M>%CTl z>nxwY@@zQpy+mOzQPmjPy>QRxg$|?Z&GUpK+cu?(1L3;b;(_EpRWq|}J)^-5KdWUsr3r2dbBC9%78aGde6xc6dU)_mUur(1Pf zon&61cx>uR-c=7ziO$sv=`Syy-^v2T^c&;^*DR~F%+p@hGk)ndl=x%tlSl+0Ov`Zepsszt! zTV1Ii>Hl=xl*qK_bU5!<^j9|xw$2{*u9=4@e>M84xNA06kF+Gn+vpTwsri^CX8uvN zP@WAL37fx+0bHXPKfaz>Lj|_#+ts?7pYZu=Q0ALj*Tw;O`%a@(LLC!^@r)2FanalC zl~g;OJ~!BVJI^k&=EByfp}y5buICA`LSEX(`w={$!*Dr8)dcFv!kf9Y99T}d#@MoG z@%|oq+r)#c71!0lH^U10&8x847|in7fcT?PM&zg;3^({SwDm}Fx`K(}P_5JkwQQu4Q0^=c< zebib)Oja|7%kV$%!~LC&(O|~tC1~CAn}5+qGQ+y->~BTHH%jd#Pt9{8?%!_vD-!w= z3UfQ4HPzoiVR=5F1VOVP@}|Z+J!S}7U{CX~k>@cD%S0tv&$elDu^T~(L#CfT+^0_% z3#`uC={Wa+|N!71Gu5AL+#do`Iq)R2b@AU+Y!#v&c0GpB<( z%Q|~%w>FVw4gN!8U!$Oct(9?FODk|>Ie3J9GvAH@D9&O`rvTy7y-;)(ta}PkGFC9r z%S$~rDfFa>W2?ItcF%xM$}2G5kh50)H1LaeBBqNOX5;eB4qAl2ay5cS-)-jpdX0@V zjf$PckecbgpYFN~vMLLXa`yPh26a&EuF}oe*ybVs2aJUt6VLfUau9o^Xk(i~7+vrK z_|H8quPKVuJ(;A14nbDbH7;$AAK}Oh$$tQfRAxRyvLIr;uj!D`c@z=Dc)1ABFH|ie zy>WNz!A!cKf$L8nA22wq&u@^Z+_)WC^u?o2Is6VZxO-A}x$=`nvPMvZeidr{O4+@O zL}blG>`Y(HfQDxHURv7azI8^g|g&`wFcncgW2pkUoX=9x77_KsNWt?@T+??`M2B_K9xNI+2}E~@U3 zbo2~;YO{1iOJZ^XDm|0qhrS@?HxXjlsFL=Ns`>f~MFuhRAH6j*^_!vr(rzoy8{UMD z*$JAB6Oqk^$ImCn=**tcoSm!Rd#D^xVEoIC>2)V0rcfFhHhc|tvwdo!wFzHsVy%nn=Ptwzt2$g1m&PWGnv@Gai`7MYx|;G|X$u9C zZmX#pk6l>3i_f}5!E@q^cUS=%=&wI#yRe0Ns#o=40C@R1n(5!`@wNYSdZWtL-mqn3 z6)O$F&4bJhf8xbr3oh<_CS?_;0^OO@!&U=br7+)a-iPN+>~SI(V*&Umr3T`n4V;}by5=TMW5i>NO(`Cjp!NdXi*X8^WE!HnPGS2t${@k4fEzmu$z*DlO_1ndwKWZZnm48 zqJzgtD#D=fj+`S$jbft-Mg+fGa2xzvS&pSP?wr%or~)0^_6t70FU4|~tJn|4H`bVR zcC4jOh+mFMnH8Ie@N+)fAih8;m`u8$2KqNXQ~@X<$;0pgFgCJJ4(C=WXOah^;5*h0wk>%DOUn}oPHzmR=3bavm7zuE zuaS|U!t0EW)fMAG1k5;w-?h@A8QT~By>-~0V9Vut@6ugfoZ{pVz9M5-ExMqOzH*&W zvmvn>D<}R#DktTT${QB=(5iUv8b;lT}sDYIDRPP<8SV)OH@+ zHngj{K6Mv@tgt~4;$3rPmH$p`la@%tk|W-NFP-d~iQHLM$|@q)^FL$3Q*UQTlJF^j zTy_LroK59jdJ1Bzzm`9_(^mA}D}alba07%&t&VJo9)>Jb%w|DgcY3fhHlJ7Lmc2Ic z+Z>r)7Sd{}HP!rU&9_-v_|Un$B--~mcopE8enY1QNh-$~#1$(}>Km8easwpkfm!*2&3LH=ikTjJUo=I9@;is`zt-p$ygt6;`;k@`AmDAKDQDuv>c)e z7|KM+liS^xUBAt9-VtTFK9<|qVGYgAmI*b|N0MNQu(H|I<_3=k)SY@S!A>`O_?>g} zkAJ3kGL`=03e+eAp90b-L|lmIct@(c%Ev;!(2fBz^BfSIN9pF& zhR&5gXmc*9Ai_OwWb>L>mFr-*ZmmEdVgI%mHPM1U^8ISZMzU{n9_XXNbg{jIZdO{u zS7NV--x$&+vZ5!n{muG=Z_oJgWK`k=t?NUm2XwK@AWJ0Q&zz4(l!=Waqv$O7w;zV} zgEfq@4P$64XM81Ds5L&&sL;2dW5ST1gEql4bv-dDyeGcbTyp5= za|LV!N%&8r5$U`ng49mJ=;jY!H?s}%iEj>1xK#`^v~e-sJa{u(ak$xVr|O7AAfi%{ zzYs$bQGdc8w~xKONdL9D+AY`(i-Z#dESJDFVdg}EW6D2}$)&H(Em*mD`e?fNzRHM= z=b4iMxovG*Pag5mPsO=4#MoGeG2+6b!(H4{_yfB&TGPJ46I;cKC9kWZ!G@J|abH$e z+bILFx>2aP`Wh{Z(?T+^G4nLrovOk(nvt3mBL2kha?`u-HXd7S4Ep>`&C_i=f8$hq z%ks+r{)`#=GkfJU#} zhUFqgPi06;Rgu78XWf4|Z~L}~x{!{+6OW9EqA)MU_M2hR{d}!h){WS8bb+1}=RDEx z07MI}p_cYYu+0%@v?E68iy0FzUq%OYGiMOz8uwVsb9`;i8At)FHxsGy-)=De zIlg6Uj8>|!w6%h4Z_?>=gAVH+LZt84R$U~E_MP7{5TS(>AaG5~0DUGoT>ftB?oMnB zf|tfB-4md09k4IRYsIkobik{Thpt>YIq691 zAU3=kE?~PyQ-XRnHJ-A!Q!Xp!H`*H!Ub)a>`s7&;x?Yf9YHkKOpGCK-t#ekpn>-(V z@AVKmOz!Vke^7XRu4bULOa+a=++q8V{}XcSDZ(LUXjU5=ZtsEqWNeiEloUGCep$a| z6&66v=Csm!J=i|)hD6EyOHKk|vn<7(1-~g&GH~$ImV1i*%8)lLR)q44uFr9^)7Q&K zH*LAC-@lj{F9^1MUHO`V{-Jrfcm8&*Kdalb$44$$$Dc?k&SWFkO;kMvo2DQl%uQE^8SzRNEX+jlKA&C~L7YPdAeg=2KH+(F18I zvIZ+53CH;Xp*>1>ay9Ar@FY-{!T7u=0TMjw1bJ3xY*FmJ(QhdR#O60Q(w0Ej@1qf` z1^IgTwV466qLJ8K`W!Gt%CKr9j~mr|{Pi14I^BIG@$y1X=KU$J3msTol2UebCvfeK z|JY^OrPTsuG)%{pM)Se+J@1lAO4=oTTPo+OJ|3@KtgfRQ9g!6~MQc~eNfpO8NpV{sAoTPlnGB{SWj6{pjtNGD*0z;i>Ii_SaC<>y4on;(!r)U*R)0yEhw6g5=TIS9$iSIs35ndk@EyPi z9i(fhFbcG+4`XMrV$~MGIUtLQ@Rqxnx@^^qzLTazOI^jP+bchlLc@*G&%Qb^!YapL z<6kDm`i;-p`p>Hhao6X74w}RZyi`qov1_dTf!A7bXGK+(5))&#>6YlRx_;k3GPSLt zgh`XK1y_uR?=ZA%e1QGa=j~%=y9~`-2aoW8NT` z<_tOgMiJP!vI0Q$@4w;Mf8T@>`s&s~76gM>wlhYbL|q12qkeOY8@k&HcEiUp=DTCr zBc1_vL@YBcdw+g9QL$|Ug~jDdq4ChJzJ+xwH4^+|h5lA4mO zfl=Y@s&lc6SNF{f+x11w;Zj5V{*>4Ww{w;@Kf5IbaTo~$WC`b1lAJs}_?5XPC{p>7 z+_g7S${kzN6~zP1i5W%;np`<4g>bKk*4Zp;rnt7}*0g@s-k61g=W>?f+E?mj6d$7c z_p=?zu`$RDq&TO9;9g7HZ|P6*5GthBhDv`@?8&2T1inEy=-Q@ELHmG~Bc=$lAgiT9 zxI+2DsaY%I#a}~nc2Q$g+VLu5&Ccdu+}`wUm1{6ZJr)KA9fhHZwGYZb?3Z zwnbTk7B^OCILJi>m|OF%o!X*L^w^yg+#_RQiXJ>B>tlIG;>1NDOC}cOMq7=HJJF^| zdC*KLOe;Q~F>qfF{6PI5BWRFuXW%wtV-w%uvay6U9_Yu%ddkfMCbj|fr*fwGOV-+C ze0=jxtf6%>ArgpK+0WlWIkD_QdYq6mO~d&F43i;G4RiC!$(*U6L!h`s!W&7VMA>fl77_zwghPDjDA&}+x_UJz?ryO7`|tA8!b#RWH{5g!tBSH* z7^duYoU=JQ?I}T?W%;oD+5FJ_n5#*ZL8*_N$#DIER}D%I4=IEI}u+g(BD?jBdJS=!8r z9?D^=K0VuvLQG65`pE0aWGxhv!`;`b1V%r3>DTc9xzy47tzdM=%_NJN)~+2tOT4yH znZ!ogb4M39zu3nuP^IbjmYN}HQ{pK(8!d_+HAd&p^`3FdpYV~j9@vx)n=IXPAsZNR z@iP*sCQ2bvkk56?lS1BR1@CP6z8Iyx)G9usTHE&vbz?_w2qG;}cUkMpmy+8Who8_( zo!264YY#u6LHO_8_6`k2vKe)&hFcwGD3WqT?3fbN!7n%BqdWLX?s2p@B9JeklR?uZiu#3B^*?2w+87B!OD^;qX zo@;^t)h&U`J>fk)cPxZrC?_l)_W2%}96piCBn4-hxuX?KqpZ+F`yUc69sExq9b3gr zi&PP*VlF-m8}k<1vjw#0@7ZItGJ?QFeWp*7)E1>S0d3EdqqfH%m>>tfx^-n0%uzmF=CHFk|{Cnfd0oDkR=Jog;TTt7BU3m`1^>1PLBp?miv{l`{VlpRT z&L6Dm?~&Cn&C!S1qIWks146msZbh`gfAgT3(^l;$wCsV0-v0@qAB?UIpM%|DPc5?<@cB$N!Br|MzbEcQO3mjQf8V!+#gU|L==Iy+j~Z Y#5x*y>S=)4?+3-TD|S|u7G9742QxT=#{d8T literal 0 HcmV?d00001 diff --git a/website/static/img/stackql-registry-logo-mobile.svg b/website/static/img/stackql-registry-logo-mobile.svg new file mode 100644 index 0000000..1de09ec --- /dev/null +++ b/website/static/img/stackql-registry-logo-mobile.svg @@ -0,0 +1,3 @@ + + + diff --git a/website/static/img/stackql-registry-logo-white-mobile.svg b/website/static/img/stackql-registry-logo-white-mobile.svg new file mode 100644 index 0000000..88c628e --- /dev/null +++ b/website/static/img/stackql-registry-logo-white-mobile.svg @@ -0,0 +1,3 @@ + + + diff --git a/website/static/img/stackql-registry-logo-white.svg b/website/static/img/stackql-registry-logo-white.svg new file mode 100644 index 0000000..9b98a38 --- /dev/null +++ b/website/static/img/stackql-registry-logo-white.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/website/static/img/stackql-registry-logo.svg b/website/static/img/stackql-registry-logo.svg new file mode 100644 index 0000000..6e34cb9 --- /dev/null +++ b/website/static/img/stackql-registry-logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/website/yarn.lock b/website/yarn.lock new file mode 100644 index 0000000..13a8418 --- /dev/null +++ b/website/yarn.lock @@ -0,0 +1,9087 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@algolia/abtesting@1.3.0": + version "1.3.0" + resolved "https://registry.yarnpkg.com/@algolia/abtesting/-/abtesting-1.3.0.tgz#3fade769bf5b03244baaee8034b83e2b49f8e86c" + integrity sha512-KqPVLdVNfoJzX5BKNGM9bsW8saHeyax8kmPFXul5gejrSPN3qss7PgsFH5mMem7oR8tvjvNkia97ljEYPYCN8Q== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/autocomplete-core@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.17.9.tgz#83374c47dc72482aa45d6b953e89377047f0dcdc" + integrity sha512-O7BxrpLDPJWWHv/DLA9DRFWs+iY1uOJZkqUwjS5HSZAGcl0hIVCQ97LTLewiZmZ402JYUrun+8NqFP+hCknlbQ== + dependencies: + "@algolia/autocomplete-plugin-algolia-insights" "1.17.9" + "@algolia/autocomplete-shared" "1.17.9" + +"@algolia/autocomplete-plugin-algolia-insights@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.17.9.tgz#74c86024d09d09e8bfa3dd90b844b77d9f9947b6" + integrity sha512-u1fEHkCbWF92DBeB/KHeMacsjsoI0wFhjZtlCq2ddZbAehshbZST6Hs0Avkc0s+4UyBGbMDnSuXHLuvRWK5iDQ== + dependencies: + "@algolia/autocomplete-shared" "1.17.9" + +"@algolia/autocomplete-preset-algolia@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.17.9.tgz#911f3250544eb8ea4096fcfb268f156b085321b5" + integrity sha512-Na1OuceSJeg8j7ZWn5ssMu/Ax3amtOwk76u4h5J4eK2Nx2KB5qt0Z4cOapCsxot9VcEN11ADV5aUSlQF4RhGjQ== + dependencies: + "@algolia/autocomplete-shared" "1.17.9" + +"@algolia/autocomplete-shared@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.17.9.tgz#5f38868f7cb1d54b014b17a10fc4f7e79d427fa8" + integrity sha512-iDf05JDQ7I0b7JEA/9IektxN/80a2MZ1ToohfmNS3rfeuQnIKI3IJlIafD0xu4StbtQTghx9T3Maa97ytkXenQ== + +"@algolia/client-abtesting@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-abtesting/-/client-abtesting-5.37.0.tgz#37df3674ccc37dfb0aa4cbfea42002bb136fb909" + integrity sha512-Dp2Zq+x9qQFnuiQhVe91EeaaPxWBhzwQ6QnznZQnH9C1/ei3dvtmAFfFeaTxM6FzfJXDLvVnaQagTYFTQz3R5g== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/client-analytics@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-5.37.0.tgz#6fb4d748e1af43d8bc9f955d73d98205ce1c1ee5" + integrity sha512-wyXODDOluKogTuZxRII6mtqhAq4+qUR3zIUJEKTiHLe8HMZFxfUEI4NO2qSu04noXZHbv/sRVdQQqzKh12SZuQ== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/client-common@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.37.0.tgz#f7ca097c4bae44e4ea365ee8f420693d0005c98e" + integrity sha512-GylIFlPvLy9OMgFG8JkonIagv3zF+Dx3H401Uo2KpmfMVBBJiGfAb9oYfXtplpRMZnZPxF5FnkWaI/NpVJMC+g== + +"@algolia/client-insights@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-insights/-/client-insights-5.37.0.tgz#f4f4011fc89bc0b2dfc384acc3c6fb38f633f4ec" + integrity sha512-T63afO2O69XHKw2+F7mfRoIbmXWGzgpZxgOFAdP3fR4laid7pWBt20P4eJ+Zn23wXS5kC9P2K7Bo3+rVjqnYiw== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/client-personalization@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-5.37.0.tgz#c1688db681623b189f353599815a118033ceebb5" + integrity sha512-1zOIXM98O9zD8bYDCJiUJRC/qNUydGHK/zRK+WbLXrW1SqLFRXECsKZa5KoG166+o5q5upk96qguOtE8FTXDWQ== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/client-query-suggestions@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-query-suggestions/-/client-query-suggestions-5.37.0.tgz#fa514df8d36fb548258c712f3ba6f97eb84ebb87" + integrity sha512-31Nr2xOLBCYVal+OMZn1rp1H4lPs1914Tfr3a34wU/nsWJ+TB3vWjfkUUuuYhWoWBEArwuRzt3YNLn0F/KRVkg== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/client-search@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-5.37.0.tgz#38c7110d96fbbbda7b7fb0578a18b8cad3c25af2" + integrity sha512-DAFVUvEg+u7jUs6BZiVz9zdaUebYULPiQ4LM2R4n8Nujzyj7BZzGr2DCd85ip4p/cx7nAZWKM8pLcGtkTRTdsg== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/events@^4.0.1": + version "4.0.1" + resolved "https://registry.yarnpkg.com/@algolia/events/-/events-4.0.1.tgz#fd39e7477e7bc703d7f893b556f676c032af3950" + integrity sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ== + +"@algolia/ingestion@1.37.0": + version "1.37.0" + resolved "https://registry.yarnpkg.com/@algolia/ingestion/-/ingestion-1.37.0.tgz#bb6016e656c68014050814abf130e103f977794e" + integrity sha512-pkCepBRRdcdd7dTLbFddnu886NyyxmhgqiRcHHaDunvX03Ij4WzvouWrQq7B7iYBjkMQrLS8wQqSP0REfA4W8g== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/monitoring@1.37.0": + version "1.37.0" + resolved "https://registry.yarnpkg.com/@algolia/monitoring/-/monitoring-1.37.0.tgz#6d20c220d648db8faea45679350f1516917cc13d" + integrity sha512-fNw7pVdyZAAQQCJf1cc/ih4fwrRdQSgKwgor4gchsI/Q/ss9inmC6bl/69jvoRSzgZS9BX4elwHKdo0EfTli3w== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/recommend@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-5.37.0.tgz#dd5e814f30bbb92395902e120fdb28a120b91341" + integrity sha512-U+FL5gzN2ldx3TYfQO5OAta2TBuIdabEdFwD5UVfWPsZE5nvOKkc/6BBqP54Z/adW/34c5ZrvvZhlhNTZujJXQ== + dependencies: + "@algolia/client-common" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +"@algolia/requester-browser-xhr@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.37.0.tgz#8851ab846d8005055c36a59422161ebe1594ae48" + integrity sha512-Ao8GZo8WgWFABrU7iq+JAftXV0t+UcOtCDL4mzHHZ+rQeTTf1TZssr4d0vIuoqkVNnKt9iyZ7T4lQff4ydcTrw== + dependencies: + "@algolia/client-common" "5.37.0" + +"@algolia/requester-fetch@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/requester-fetch/-/requester-fetch-5.37.0.tgz#93602fdc9a59b41ecd53768c53c11cddb0db846a" + integrity sha512-H7OJOXrFg5dLcGJ22uxx8eiFId0aB9b0UBhoOi4SMSuDBe6vjJJ/LeZyY25zPaSvkXNBN3vAM+ad6M0h6ha3AA== + dependencies: + "@algolia/client-common" "5.37.0" + +"@algolia/requester-node-http@5.37.0": + version "5.37.0" + resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-5.37.0.tgz#83da1b52f3ee86f262a5d4b2a88a74db665211c2" + integrity sha512-npZ9aeag4SGTx677eqPL3rkSPlQrnzx/8wNrl1P7GpWq9w/eTmRbOq+wKrJ2r78idlY0MMgmY/mld2tq6dc44g== + dependencies: + "@algolia/client-common" "5.37.0" + +"@babel/code-frame@^7.0.0", "@babel/code-frame@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.27.1.tgz#200f715e66d52a23b221a9435534a91cc13ad5be" + integrity sha512-cjQ7ZlQ0Mv3b47hABuTevyTuYN4i+loJKGeV9flcCgIK37cCXRh+L1bd3iBHlynerhQ7BhCkn2BPbQUL+rGqFg== + dependencies: + "@babel/helper-validator-identifier" "^7.27.1" + js-tokens "^4.0.0" + picocolors "^1.1.1" + +"@babel/compat-data@^7.27.2", "@babel/compat-data@^7.27.7", "@babel/compat-data@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.28.4.tgz#96fdf1af1b8859c8474ab39c295312bfb7c24b04" + integrity sha512-YsmSKC29MJwf0gF8Rjjrg5LQCmyh+j/nD8/eP7f+BeoQTKYqs9RoWbjGOdy0+1Ekr68RJZMUOPVQaQisnIo4Rw== + +"@babel/core@^7.21.3", "@babel/core@^7.25.9": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.4.tgz#12a550b8794452df4c8b084f95003bce1742d496" + integrity sha512-2BCOP7TN8M+gVDj7/ht3hsaO/B/n5oDbiAyyvnRlNOs+u1o+JWNYTQrmpuNp1/Wq2gcFrI01JAW+paEKDMx/CA== + dependencies: + "@babel/code-frame" "^7.27.1" + "@babel/generator" "^7.28.3" + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-module-transforms" "^7.28.3" + "@babel/helpers" "^7.28.4" + "@babel/parser" "^7.28.4" + "@babel/template" "^7.27.2" + "@babel/traverse" "^7.28.4" + "@babel/types" "^7.28.4" + "@jridgewell/remapping" "^2.3.5" + convert-source-map "^2.0.0" + debug "^4.1.0" + gensync "^1.0.0-beta.2" + json5 "^2.2.3" + semver "^6.3.1" + +"@babel/generator@^7.25.9", "@babel/generator@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.28.3.tgz#9626c1741c650cbac39121694a0f2d7451b8ef3e" + integrity sha512-3lSpxGgvnmZznmBkCRnVREPUFJv2wrv9iAoFDvADJc0ypmdOxdUtcLeBgBJ6zE0PMeTKnxeQzyk0xTBq4Ep7zw== + dependencies: + "@babel/parser" "^7.28.3" + "@babel/types" "^7.28.2" + "@jridgewell/gen-mapping" "^0.3.12" + "@jridgewell/trace-mapping" "^0.3.28" + jsesc "^3.0.2" + +"@babel/helper-annotate-as-pure@^7.27.1", "@babel/helper-annotate-as-pure@^7.27.3": + version "7.27.3" + resolved "https://registry.yarnpkg.com/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.3.tgz#f31fd86b915fc4daf1f3ac6976c59be7084ed9c5" + integrity sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg== + dependencies: + "@babel/types" "^7.27.3" + +"@babel/helper-compilation-targets@^7.27.1", "@babel/helper-compilation-targets@^7.27.2": + version "7.27.2" + resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.27.2.tgz#46a0f6efab808d51d29ce96858dd10ce8732733d" + integrity sha512-2+1thGUUWWjLTYTHZWK1n8Yga0ijBz1XAhUXcKy81rd5g6yh7hGqMp45v7cadSbEHc9G3OTv45SyneRN3ps4DQ== + dependencies: + "@babel/compat-data" "^7.27.2" + "@babel/helper-validator-option" "^7.27.1" + browserslist "^4.24.0" + lru-cache "^5.1.1" + semver "^6.3.1" + +"@babel/helper-create-class-features-plugin@^7.27.1", "@babel/helper-create-class-features-plugin@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.28.3.tgz#3e747434ea007910c320c4d39a6b46f20f371d46" + integrity sha512-V9f6ZFIYSLNEbuGA/92uOvYsGCJNsuA8ESZ4ldc09bWk/j8H8TKiPw8Mk1eG6olpnO0ALHJmYfZvF4MEE4gajg== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.3" + "@babel/helper-member-expression-to-functions" "^7.27.1" + "@babel/helper-optimise-call-expression" "^7.27.1" + "@babel/helper-replace-supers" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + "@babel/traverse" "^7.28.3" + semver "^6.3.1" + +"@babel/helper-create-regexp-features-plugin@^7.18.6", "@babel/helper-create-regexp-features-plugin@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.27.1.tgz#05b0882d97ba1d4d03519e4bce615d70afa18c53" + integrity sha512-uVDC72XVf8UbrH5qQTc18Agb8emwjTiZrQE11Nv3CuBEZmVvTwwE9CBUEvHku06gQCAyYf8Nv6ja1IN+6LMbxQ== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.1" + regexpu-core "^6.2.0" + semver "^6.3.1" + +"@babel/helper-define-polyfill-provider@^0.6.5": + version "0.6.5" + resolved "https://registry.yarnpkg.com/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.5.tgz#742ccf1cb003c07b48859fc9fa2c1bbe40e5f753" + integrity sha512-uJnGFcPsWQK8fvjgGP5LZUZZsYGIoPeRjSF5PGwrelYgq7Q15/Ft9NGFp1zglwgIv//W0uG4BevRuSJRyylZPg== + dependencies: + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-plugin-utils" "^7.27.1" + debug "^4.4.1" + lodash.debounce "^4.0.8" + resolve "^1.22.10" + +"@babel/helper-globals@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/helper-globals/-/helper-globals-7.28.0.tgz#b9430df2aa4e17bc28665eadeae8aa1d985e6674" + integrity sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw== + +"@babel/helper-member-expression-to-functions@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.27.1.tgz#ea1211276be93e798ce19037da6f06fbb994fa44" + integrity sha512-E5chM8eWjTp/aNoVpcbfM7mLxu9XGLWYise2eBKGQomAk/Mb4XoxyqXTZbuTohbsl8EKqdlMhnDI2CCLfcs9wA== + dependencies: + "@babel/traverse" "^7.27.1" + "@babel/types" "^7.27.1" + +"@babel/helper-module-imports@^7.16.7", "@babel/helper-module-imports@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-module-imports/-/helper-module-imports-7.27.1.tgz#7ef769a323e2655e126673bb6d2d6913bbead204" + integrity sha512-0gSFWUPNXNopqtIPQvlD5WgXYI5GY2kP2cCvoT8kczjbfcfuIljTbcWrulD1CIPIX2gt1wghbDy08yE1p+/r3w== + dependencies: + "@babel/traverse" "^7.27.1" + "@babel/types" "^7.27.1" + +"@babel/helper-module-transforms@^7.27.1", "@babel/helper-module-transforms@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.28.3.tgz#a2b37d3da3b2344fe085dab234426f2b9a2fa5f6" + integrity sha512-gytXUbs8k2sXS9PnQptz5o0QnpLL51SwASIORY6XaBKF88nsOT0Zw9szLqlSGQDP/4TljBAD5y98p2U1fqkdsw== + dependencies: + "@babel/helper-module-imports" "^7.27.1" + "@babel/helper-validator-identifier" "^7.27.1" + "@babel/traverse" "^7.28.3" + +"@babel/helper-optimise-call-expression@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.27.1.tgz#c65221b61a643f3e62705e5dd2b5f115e35f9200" + integrity sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw== + dependencies: + "@babel/types" "^7.27.1" + +"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.18.6", "@babel/helper-plugin-utils@^7.27.1", "@babel/helper-plugin-utils@^7.8.0": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.27.1.tgz#ddb2f876534ff8013e6c2b299bf4d39b3c51d44c" + integrity sha512-1gn1Up5YXka3YYAHGKpbideQ5Yjf1tDa9qYcgysz+cNCXukyLl6DjPXhD3VRwSb8c0J9tA4b2+rHEZtc6R0tlw== + +"@babel/helper-remap-async-to-generator@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.27.1.tgz#4601d5c7ce2eb2aea58328d43725523fcd362ce6" + integrity sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-wrap-function" "^7.27.1" + "@babel/traverse" "^7.27.1" + +"@babel/helper-replace-supers@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-replace-supers/-/helper-replace-supers-7.27.1.tgz#b1ed2d634ce3bdb730e4b52de30f8cccfd692bc0" + integrity sha512-7EHz6qDZc8RYS5ElPoShMheWvEgERonFCs7IAonWLLUTXW59DP14bCZt89/GKyreYn8g3S83m21FelHKbeDCKA== + dependencies: + "@babel/helper-member-expression-to-functions" "^7.27.1" + "@babel/helper-optimise-call-expression" "^7.27.1" + "@babel/traverse" "^7.27.1" + +"@babel/helper-skip-transparent-expression-wrappers@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.27.1.tgz#62bb91b3abba8c7f1fec0252d9dbea11b3ee7a56" + integrity sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg== + dependencies: + "@babel/traverse" "^7.27.1" + "@babel/types" "^7.27.1" + +"@babel/helper-string-parser@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz#54da796097ab19ce67ed9f88b47bb2ec49367687" + integrity sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA== + +"@babel/helper-validator-identifier@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.27.1.tgz#a7054dcc145a967dd4dc8fee845a57c1316c9df8" + integrity sha512-D2hP9eA+Sqx1kBZgzxZh0y1trbuU+JoDkiEwqhQ36nodYqJwyEIhPSdMNd7lOm/4io72luTPWH20Yda0xOuUow== + +"@babel/helper-validator-option@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz#fa52f5b1e7db1ab049445b421c4471303897702f" + integrity sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg== + +"@babel/helper-wrap-function@^7.27.1": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-wrap-function/-/helper-wrap-function-7.28.3.tgz#fe4872092bc1438ffd0ce579e6f699609f9d0a7a" + integrity sha512-zdf983tNfLZFletc0RRXYrHrucBEg95NIFMkn6K9dbeMYnsgHaSBGcQqdsCSStG2PYwRre0Qc2NNSCXbG+xc6g== + dependencies: + "@babel/template" "^7.27.2" + "@babel/traverse" "^7.28.3" + "@babel/types" "^7.28.2" + +"@babel/helpers@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.4.tgz#fe07274742e95bdf7cf1443593eeb8926ab63827" + integrity sha512-HFN59MmQXGHVyYadKLVumYsA9dBFun/ldYxipEjzA4196jpLZd8UjEEBLkbEkvfYreDqJhZxYAWFPtrfhNpj4w== + dependencies: + "@babel/template" "^7.27.2" + "@babel/types" "^7.28.4" + +"@babel/parser@^7.27.2", "@babel/parser@^7.28.3", "@babel/parser@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.4.tgz#da25d4643532890932cc03f7705fe19637e03fa8" + integrity sha512-yZbBqeM6TkpP9du/I2pUZnJsRMGGvOuIrhjzC1AwHwW+6he4mni6Bp/m8ijn0iOuZuPI2BfkCoSRunpyjnrQKg== + dependencies: + "@babel/types" "^7.28.4" + +"@babel/plugin-bugfix-firefox-class-in-computed-class-key@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.27.1.tgz#61dd8a8e61f7eb568268d1b5f129da3eee364bf9" + integrity sha512-QPG3C9cCVRQLxAVwmefEmwdTanECuUBMQZ/ym5kiw3XKCGA7qkuQLcjWWHcrD/GKbn/WmJwaezfuuAOcyKlRPA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/traverse" "^7.27.1" + +"@babel/plugin-bugfix-safari-class-field-initializer-scope@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-safari-class-field-initializer-scope/-/plugin-bugfix-safari-class-field-initializer-scope-7.27.1.tgz#43f70a6d7efd52370eefbdf55ae03d91b293856d" + integrity sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.27.1.tgz#beb623bd573b8b6f3047bd04c32506adc3e58a72" + integrity sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.27.1.tgz#e134a5479eb2ba9c02714e8c1ebf1ec9076124fd" + integrity sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + "@babel/plugin-transform-optional-chaining" "^7.27.1" + +"@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.28.3.tgz#373f6e2de0016f73caf8f27004f61d167743742a" + integrity sha512-b6YTX108evsvE4YgWyQ921ZAFFQm3Bn+CA3+ZXlNVnPhx+UfsVURoPjfGAPCjBgrqo30yX/C2nZGX96DxvR9Iw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/traverse" "^7.28.3" + +"@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2": + version "7.21.0-placeholder-for-preset-env.2" + resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz#7844f9289546efa9febac2de4cfe358a050bd703" + integrity sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w== + +"@babel/plugin-syntax-dynamic-import@^7.8.3": + version "7.8.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.8.3.tgz#62bf98b2da3cd21d626154fc96ee5b3cb68eacb3" + integrity sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-import-assertions@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.27.1.tgz#88894aefd2b03b5ee6ad1562a7c8e1587496aecd" + integrity sha512-UT/Jrhw57xg4ILHLFnzFpPDlMbcdEicaAtjPQpbj9wa8T4r5KVWCimHcL/460g8Ht0DMxDyjsLgiWSkVjnwPFg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-syntax-import-attributes@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.27.1.tgz#34c017d54496f9b11b61474e7ea3dfd5563ffe07" + integrity sha512-oFT0FrKHgF53f4vOsZGi2Hh3I35PfSmVs4IBFLFj4dnafP+hIWDLg3VyKmUHfLoLHlyxY4C7DGtmHuJgn+IGww== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-syntax-jsx@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.27.1.tgz#2f9beb5eff30fa507c5532d107daac7b888fa34c" + integrity sha512-y8YTNIeKoyhGd9O0Jiyzyyqk8gdjnumGTQPsz0xOZOQ2RmkVJeZ1vmmfIvFEKqucBG6axJGBZDE/7iI5suUI/w== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-syntax-typescript@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.27.1.tgz#5147d29066a793450f220c63fa3a9431b7e6dd18" + integrity sha512-xfYCBMxveHrRMnAWl1ZlPXOZjzkN82THFvLhQhFXFt81Z5HnN+EtUkZhv/zcKpmT3fzmWZB0ywiBrbC3vogbwQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-syntax-unicode-sets-regex@^7.18.6": + version "7.18.6" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz#d49a3b3e6b52e5be6740022317580234a6a47357" + integrity sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.18.6" + "@babel/helper-plugin-utils" "^7.18.6" + +"@babel/plugin-transform-arrow-functions@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.27.1.tgz#6e2061067ba3ab0266d834a9f94811196f2aba9a" + integrity sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-async-generator-functions@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.28.0.tgz#1276e6c7285ab2cd1eccb0bc7356b7a69ff842c2" + integrity sha512-BEOdvX4+M765icNPZeidyADIvQ1m1gmunXufXxvRESy/jNNyfovIqUyE7MVgGBjWktCoJlzvFA1To2O4ymIO3Q== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-remap-async-to-generator" "^7.27.1" + "@babel/traverse" "^7.28.0" + +"@babel/plugin-transform-async-to-generator@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.27.1.tgz#9a93893b9379b39466c74474f55af03de78c66e7" + integrity sha512-NREkZsZVJS4xmTr8qzE5y8AfIPqsdQfRuUiLRTEzb7Qii8iFWCyDKaUV2c0rCuh4ljDZ98ALHP/PetiBV2nddA== + dependencies: + "@babel/helper-module-imports" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-remap-async-to-generator" "^7.27.1" + +"@babel/plugin-transform-block-scoped-functions@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.27.1.tgz#558a9d6e24cf72802dd3b62a4b51e0d62c0f57f9" + integrity sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-block-scoping@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.28.4.tgz#e19ac4ddb8b7858bac1fd5c1be98a994d9726410" + integrity sha512-1yxmvN0MJHOhPVmAsmoW5liWwoILobu/d/ShymZmj867bAdxGbehIrew1DuLpw2Ukv+qDSSPQdYW1dLNE7t11A== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-class-properties@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.27.1.tgz#dd40a6a370dfd49d32362ae206ddaf2bb082a925" + integrity sha512-D0VcalChDMtuRvJIu3U/fwWjf8ZMykz5iZsg77Nuj821vCKI3zCyRLwRdWbsuJ/uRwZhZ002QtCqIkwC/ZkvbA== + dependencies: + "@babel/helper-create-class-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-class-static-block@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.28.3.tgz#d1b8e69b54c9993bc558203e1f49bfc979bfd852" + integrity sha512-LtPXlBbRoc4Njl/oh1CeD/3jC+atytbnf/UqLoqTDcEYGUPj022+rvfkbDYieUrSj3CaV4yHDByPE+T2HwfsJg== + dependencies: + "@babel/helper-create-class-features-plugin" "^7.28.3" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-classes@^7.28.3": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-classes/-/plugin-transform-classes-7.28.4.tgz#75d66175486788c56728a73424d67cbc7473495c" + integrity sha512-cFOlhIYPBv/iBoc+KS3M6et2XPtbT2HiCRfBXWtfpc9OAyostldxIf9YAYB6ypURBBbx+Qv6nyrLzASfJe+hBA== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.3" + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-globals" "^7.28.0" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-replace-supers" "^7.27.1" + "@babel/traverse" "^7.28.4" + +"@babel/plugin-transform-computed-properties@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.27.1.tgz#81662e78bf5e734a97982c2b7f0a793288ef3caa" + integrity sha512-lj9PGWvMTVksbWiDT2tW68zGS/cyo4AkZ/QTp0sQT0mjPopCmrSkzxeXkznjqBxzDI6TclZhOJbBmbBLjuOZUw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/template" "^7.27.1" + +"@babel/plugin-transform-destructuring@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.28.0.tgz#0f156588f69c596089b7d5b06f5af83d9aa7f97a" + integrity sha512-v1nrSMBiKcodhsyJ4Gf+Z0U/yawmJDBOTpEB3mcQY52r9RIyPneGyAS/yM6seP/8I+mWI3elOMtT5dB8GJVs+A== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/traverse" "^7.28.0" + +"@babel/plugin-transform-dotall-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.27.1.tgz#aa6821de864c528b1fecf286f0a174e38e826f4d" + integrity sha512-gEbkDVGRvjj7+T1ivxrfgygpT7GUd4vmODtYpbs0gZATdkX8/iSnOtZSxiZnsgm1YjTgjI6VKBGSJJevkrclzw== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-duplicate-keys@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.27.1.tgz#f1fbf628ece18e12e7b32b175940e68358f546d1" + integrity sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-duplicate-named-capturing-groups-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.27.1.tgz#5043854ca620a94149372e69030ff8cb6a9eb0ec" + integrity sha512-hkGcueTEzuhB30B3eJCbCYeCaaEQOmQR0AdvzpD4LoN0GXMWzzGSuRrxR2xTnCrvNbVwK9N6/jQ92GSLfiZWoQ== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-dynamic-import@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.27.1.tgz#4c78f35552ac0e06aa1f6e3c573d67695e8af5a4" + integrity sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-explicit-resource-management@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.28.0.tgz#45be6211b778dbf4b9d54c4e8a2b42fa72e09a1a" + integrity sha512-K8nhUcn3f6iB+P3gwCv/no7OdzOZQcKchW6N389V6PD8NUWKZHzndOd9sPDVbMoBsbmjMqlB4L9fm+fEFNVlwQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" + +"@babel/plugin-transform-exponentiation-operator@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.27.1.tgz#fc497b12d8277e559747f5a3ed868dd8064f83e1" + integrity sha512-uspvXnhHvGKf2r4VVtBpeFnuDWsJLQ6MF6lGJLC89jBR1uoVeqM416AZtTuhTezOfgHicpJQmoD5YUakO/YmXQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-export-namespace-from@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.27.1.tgz#71ca69d3471edd6daa711cf4dfc3400415df9c23" + integrity sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-for-of@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.27.1.tgz#bc24f7080e9ff721b63a70ac7b2564ca15b6c40a" + integrity sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + +"@babel/plugin-transform-function-name@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.27.1.tgz#4d0bf307720e4dce6d7c30fcb1fd6ca77bdeb3a7" + integrity sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ== + dependencies: + "@babel/helper-compilation-targets" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/traverse" "^7.27.1" + +"@babel/plugin-transform-json-strings@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.27.1.tgz#a2e0ce6ef256376bd527f290da023983527a4f4c" + integrity sha512-6WVLVJiTjqcQauBhn1LkICsR2H+zm62I3h9faTDKt1qP4jn2o72tSvqMwtGFKGTpojce0gJs+76eZ2uCHRZh0Q== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-literals@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-literals/-/plugin-transform-literals-7.27.1.tgz#baaefa4d10a1d4206f9dcdda50d7d5827bb70b24" + integrity sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-logical-assignment-operators@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.27.1.tgz#890cb20e0270e0e5bebe3f025b434841c32d5baa" + integrity sha512-SJvDs5dXxiae4FbSL1aBJlG4wvl594N6YEVVn9e3JGulwioy6z3oPjx/sQBO3Y4NwUu5HNix6KJ3wBZoewcdbw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-member-expression-literals@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.27.1.tgz#37b88ba594d852418e99536f5612f795f23aeaf9" + integrity sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-modules-amd@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.27.1.tgz#a4145f9d87c2291fe2d05f994b65dba4e3e7196f" + integrity sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA== + dependencies: + "@babel/helper-module-transforms" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-modules-commonjs@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.27.1.tgz#8e44ed37c2787ecc23bdc367f49977476614e832" + integrity sha512-OJguuwlTYlN0gBZFRPqwOGNWssZjfIUdS7HMYtN8c1KmwpwHFBwTeFZrg9XZa+DFTitWOW5iTAG7tyCUPsCCyw== + dependencies: + "@babel/helper-module-transforms" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-modules-systemjs@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.27.1.tgz#00e05b61863070d0f3292a00126c16c0e024c4ed" + integrity sha512-w5N1XzsRbc0PQStASMksmUeqECuzKuTJer7kFagK8AXgpCMkeDMO5S+aaFb7A51ZYDF7XI34qsTX+fkHiIm5yA== + dependencies: + "@babel/helper-module-transforms" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-validator-identifier" "^7.27.1" + "@babel/traverse" "^7.27.1" + +"@babel/plugin-transform-modules-umd@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.27.1.tgz#63f2cf4f6dc15debc12f694e44714863d34cd334" + integrity sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w== + dependencies: + "@babel/helper-module-transforms" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-named-capturing-groups-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.27.1.tgz#f32b8f7818d8fc0cc46ee20a8ef75f071af976e1" + integrity sha512-SstR5JYy8ddZvD6MhV0tM/j16Qds4mIpJTOd1Yu9J9pJjH93bxHECF7pgtc28XvkzTD6Pxcm/0Z73Hvk7kb3Ng== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-new-target@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.27.1.tgz#259c43939728cad1706ac17351b7e6a7bea1abeb" + integrity sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-nullish-coalescing-operator@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.27.1.tgz#4f9d3153bf6782d73dd42785a9d22d03197bc91d" + integrity sha512-aGZh6xMo6q9vq1JGcw58lZ1Z0+i0xB2x0XaauNIUXd6O1xXc3RwoWEBlsTQrY4KQ9Jf0s5rgD6SiNkaUdJegTA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-numeric-separator@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.27.1.tgz#614e0b15cc800e5997dadd9bd6ea524ed6c819c6" + integrity sha512-fdPKAcujuvEChxDBJ5c+0BTaS6revLV7CJL08e4m3de8qJfNIuCc2nc7XJYOjBoTMJeqSmwXJ0ypE14RCjLwaw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-object-rest-spread@^7.28.0": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.28.4.tgz#9ee1ceca80b3e6c4bac9247b2149e36958f7f98d" + integrity sha512-373KA2HQzKhQCYiRVIRr+3MjpCObqzDlyrM6u4I201wL8Mp2wHf7uB8GhDwis03k2ti8Zr65Zyyqs1xOxUF/Ew== + dependencies: + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" + "@babel/plugin-transform-parameters" "^7.27.7" + "@babel/traverse" "^7.28.4" + +"@babel/plugin-transform-object-super@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.27.1.tgz#1c932cd27bf3874c43a5cac4f43ebf970c9871b5" + integrity sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-replace-supers" "^7.27.1" + +"@babel/plugin-transform-optional-catch-binding@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.27.1.tgz#84c7341ebde35ccd36b137e9e45866825072a30c" + integrity sha512-txEAEKzYrHEX4xSZN4kJ+OfKXFVSWKB2ZxM9dpcE3wT7smwkNmXo5ORRlVzMVdJbD+Q8ILTgSD7959uj+3Dm3Q== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-optional-chaining@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.27.1.tgz#874ce3c4f06b7780592e946026eb76a32830454f" + integrity sha512-BQmKPPIuc8EkZgNKsv0X4bPmOoayeu4F1YCwx2/CfmDSXDbp7GnzlUH+/ul5VGfRg1AoFPsrIThlEBj2xb4CAg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + +"@babel/plugin-transform-parameters@^7.27.7": + version "7.27.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.7.tgz#1fd2febb7c74e7d21cf3b05f7aebc907940af53a" + integrity sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-private-methods@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.27.1.tgz#fdacbab1c5ed81ec70dfdbb8b213d65da148b6af" + integrity sha512-10FVt+X55AjRAYI9BrdISN9/AQWHqldOeZDUoLyif1Kn05a56xVBXb8ZouL8pZ9jem8QpXaOt8TS7RHUIS+GPA== + dependencies: + "@babel/helper-create-class-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-private-property-in-object@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.27.1.tgz#4dbbef283b5b2f01a21e81e299f76e35f900fb11" + integrity sha512-5J+IhqTi1XPa0DXF83jYOaARrX+41gOewWbkPyjMNRDqgOCqdffGh8L3f/Ek5utaEBZExjSAzcyjmV9SSAWObQ== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-create-class-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-property-literals@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.27.1.tgz#07eafd618800591e88073a0af1b940d9a42c6424" + integrity sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-react-constant-elements@^7.21.3": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-constant-elements/-/plugin-transform-react-constant-elements-7.27.1.tgz#6c6b50424e749a6e48afd14cf7b92f98cb9383f9" + integrity sha512-edoidOjl/ZxvYo4lSBOQGDSyToYVkTAwyVoa2tkuYTSmjrB1+uAedoL5iROVLXkxH+vRgA7uP4tMg2pUJpZ3Ug== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-react-display-name@^7.27.1": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.28.0.tgz#6f20a7295fea7df42eb42fed8f896813f5b934de" + integrity sha512-D6Eujc2zMxKjfa4Zxl4GHMsmhKKZ9VpcqIchJLvwTxad9zWIYulwYItBovpDOoNLISpcZSXoDJ5gaGbQUDqViA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-react-jsx-development@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-jsx-development/-/plugin-transform-react-jsx-development-7.27.1.tgz#47ff95940e20a3a70e68ad3d4fcb657b647f6c98" + integrity sha512-ykDdF5yI4f1WrAolLqeF3hmYU12j9ntLQl/AOG1HAS21jxyg1Q0/J/tpREuYLfatGdGmXp/3yS0ZA76kOlVq9Q== + dependencies: + "@babel/plugin-transform-react-jsx" "^7.27.1" + +"@babel/plugin-transform-react-jsx@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.27.1.tgz#1023bc94b78b0a2d68c82b5e96aed573bcfb9db0" + integrity sha512-2KH4LWGSrJIkVf5tSiBFYuXDAoWRq2MMwgivCf+93dd0GQi8RXLjKA/0EvRnVV5G0hrHczsquXuD01L8s6dmBw== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-module-imports" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/plugin-syntax-jsx" "^7.27.1" + "@babel/types" "^7.27.1" + +"@babel/plugin-transform-react-pure-annotations@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.27.1.tgz#339f1ce355eae242e0649f232b1c68907c02e879" + integrity sha512-JfuinvDOsD9FVMTHpzA/pBLisxpv1aSf+OIV8lgH3MuWrks19R27e6a6DipIg4aX1Zm9Wpb04p8wljfKrVSnPA== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-regenerator@^7.28.3": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.28.4.tgz#9d3fa3bebb48ddd0091ce5729139cd99c67cea51" + integrity sha512-+ZEdQlBoRg9m2NnzvEeLgtvBMO4tkFBw5SQIUgLICgTrumLoU7lr+Oghi6km2PFj+dbUt2u1oby2w3BDO9YQnA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-regexp-modifiers@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.27.1.tgz#df9ba5577c974e3f1449888b70b76169998a6d09" + integrity sha512-TtEciroaiODtXvLZv4rmfMhkCv8jx3wgKpL68PuiPh2M4fvz5jhsA7697N1gMvkvr/JTF13DrFYyEbY9U7cVPA== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-reserved-words@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.27.1.tgz#40fba4878ccbd1c56605a4479a3a891ac0274bb4" + integrity sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-runtime@^7.25.9": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.28.3.tgz#f5990a1b2d2bde950ed493915e0719841c8d0eaa" + integrity sha512-Y6ab1kGqZ0u42Zv/4a7l0l72n9DKP/MKoKWaUSBylrhNZO2prYuqFOLbn5aW5SIFXwSH93yfjbgllL8lxuGKLg== + dependencies: + "@babel/helper-module-imports" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + babel-plugin-polyfill-corejs2 "^0.4.14" + babel-plugin-polyfill-corejs3 "^0.13.0" + babel-plugin-polyfill-regenerator "^0.6.5" + semver "^6.3.1" + +"@babel/plugin-transform-shorthand-properties@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.27.1.tgz#532abdacdec87bfee1e0ef8e2fcdee543fe32b90" + integrity sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-spread@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-spread/-/plugin-transform-spread-7.27.1.tgz#1a264d5fc12750918f50e3fe3e24e437178abb08" + integrity sha512-kpb3HUqaILBJcRFVhFUs6Trdd4mkrzcGXss+6/mxUd273PfbWqSDHRzMT2234gIg2QYfAjvXLSquP1xECSg09Q== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + +"@babel/plugin-transform-sticky-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.27.1.tgz#18984935d9d2296843a491d78a014939f7dcd280" + integrity sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-template-literals@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.27.1.tgz#1a0eb35d8bb3e6efc06c9fd40eb0bcef548328b8" + integrity sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-typeof-symbol@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.27.1.tgz#70e966bb492e03509cf37eafa6dcc3051f844369" + integrity sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-typescript@^7.27.1": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.28.0.tgz#796cbd249ab56c18168b49e3e1d341b72af04a6b" + integrity sha512-4AEiDEBPIZvLQaWlc9liCavE0xRM0dNca41WtBeM3jgFptfUOSG9z0uteLhq6+3rq+WB6jIvUwKDTpXEHPJ2Vg== + dependencies: + "@babel/helper-annotate-as-pure" "^7.27.3" + "@babel/helper-create-class-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-skip-transparent-expression-wrappers" "^7.27.1" + "@babel/plugin-syntax-typescript" "^7.27.1" + +"@babel/plugin-transform-unicode-escapes@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.27.1.tgz#3e3143f8438aef842de28816ece58780190cf806" + integrity sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-unicode-property-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.27.1.tgz#bdfe2d3170c78c5691a3c3be934c8c0087525956" + integrity sha512-uW20S39PnaTImxp39O5qFlHLS9LJEmANjMG7SxIhap8rCHqu0Ik+tLEPX5DKmHn6CsWQ7j3lix2tFOa5YtL12Q== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-unicode-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.27.1.tgz#25948f5c395db15f609028e370667ed8bae9af97" + integrity sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/plugin-transform-unicode-sets-regex@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.27.1.tgz#6ab706d10f801b5c72da8bb2548561fa04193cd1" + integrity sha512-EtkOujbc4cgvb0mlpQefi4NTPBzhSIevblFevACNLUspmrALgmEBdL/XfnyyITfd8fKBZrZys92zOWcik7j9Tw== + dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.27.1" + "@babel/helper-plugin-utils" "^7.27.1" + +"@babel/preset-env@^7.20.2", "@babel/preset-env@^7.25.9": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/preset-env/-/preset-env-7.28.3.tgz#2b18d9aff9e69643789057ae4b942b1654f88187" + integrity sha512-ROiDcM+GbYVPYBOeCR6uBXKkQpBExLl8k9HO1ygXEyds39j+vCCsjmj7S8GOniZQlEs81QlkdJZe76IpLSiqpg== + dependencies: + "@babel/compat-data" "^7.28.0" + "@babel/helper-compilation-targets" "^7.27.2" + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-validator-option" "^7.27.1" + "@babel/plugin-bugfix-firefox-class-in-computed-class-key" "^7.27.1" + "@babel/plugin-bugfix-safari-class-field-initializer-scope" "^7.27.1" + "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression" "^7.27.1" + "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining" "^7.27.1" + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly" "^7.28.3" + "@babel/plugin-proposal-private-property-in-object" "7.21.0-placeholder-for-preset-env.2" + "@babel/plugin-syntax-import-assertions" "^7.27.1" + "@babel/plugin-syntax-import-attributes" "^7.27.1" + "@babel/plugin-syntax-unicode-sets-regex" "^7.18.6" + "@babel/plugin-transform-arrow-functions" "^7.27.1" + "@babel/plugin-transform-async-generator-functions" "^7.28.0" + "@babel/plugin-transform-async-to-generator" "^7.27.1" + "@babel/plugin-transform-block-scoped-functions" "^7.27.1" + "@babel/plugin-transform-block-scoping" "^7.28.0" + "@babel/plugin-transform-class-properties" "^7.27.1" + "@babel/plugin-transform-class-static-block" "^7.28.3" + "@babel/plugin-transform-classes" "^7.28.3" + "@babel/plugin-transform-computed-properties" "^7.27.1" + "@babel/plugin-transform-destructuring" "^7.28.0" + "@babel/plugin-transform-dotall-regex" "^7.27.1" + "@babel/plugin-transform-duplicate-keys" "^7.27.1" + "@babel/plugin-transform-duplicate-named-capturing-groups-regex" "^7.27.1" + "@babel/plugin-transform-dynamic-import" "^7.27.1" + "@babel/plugin-transform-explicit-resource-management" "^7.28.0" + "@babel/plugin-transform-exponentiation-operator" "^7.27.1" + "@babel/plugin-transform-export-namespace-from" "^7.27.1" + "@babel/plugin-transform-for-of" "^7.27.1" + "@babel/plugin-transform-function-name" "^7.27.1" + "@babel/plugin-transform-json-strings" "^7.27.1" + "@babel/plugin-transform-literals" "^7.27.1" + "@babel/plugin-transform-logical-assignment-operators" "^7.27.1" + "@babel/plugin-transform-member-expression-literals" "^7.27.1" + "@babel/plugin-transform-modules-amd" "^7.27.1" + "@babel/plugin-transform-modules-commonjs" "^7.27.1" + "@babel/plugin-transform-modules-systemjs" "^7.27.1" + "@babel/plugin-transform-modules-umd" "^7.27.1" + "@babel/plugin-transform-named-capturing-groups-regex" "^7.27.1" + "@babel/plugin-transform-new-target" "^7.27.1" + "@babel/plugin-transform-nullish-coalescing-operator" "^7.27.1" + "@babel/plugin-transform-numeric-separator" "^7.27.1" + "@babel/plugin-transform-object-rest-spread" "^7.28.0" + "@babel/plugin-transform-object-super" "^7.27.1" + "@babel/plugin-transform-optional-catch-binding" "^7.27.1" + "@babel/plugin-transform-optional-chaining" "^7.27.1" + "@babel/plugin-transform-parameters" "^7.27.7" + "@babel/plugin-transform-private-methods" "^7.27.1" + "@babel/plugin-transform-private-property-in-object" "^7.27.1" + "@babel/plugin-transform-property-literals" "^7.27.1" + "@babel/plugin-transform-regenerator" "^7.28.3" + "@babel/plugin-transform-regexp-modifiers" "^7.27.1" + "@babel/plugin-transform-reserved-words" "^7.27.1" + "@babel/plugin-transform-shorthand-properties" "^7.27.1" + "@babel/plugin-transform-spread" "^7.27.1" + "@babel/plugin-transform-sticky-regex" "^7.27.1" + "@babel/plugin-transform-template-literals" "^7.27.1" + "@babel/plugin-transform-typeof-symbol" "^7.27.1" + "@babel/plugin-transform-unicode-escapes" "^7.27.1" + "@babel/plugin-transform-unicode-property-regex" "^7.27.1" + "@babel/plugin-transform-unicode-regex" "^7.27.1" + "@babel/plugin-transform-unicode-sets-regex" "^7.27.1" + "@babel/preset-modules" "0.1.6-no-external-plugins" + babel-plugin-polyfill-corejs2 "^0.4.14" + babel-plugin-polyfill-corejs3 "^0.13.0" + babel-plugin-polyfill-regenerator "^0.6.5" + core-js-compat "^3.43.0" + semver "^6.3.1" + +"@babel/preset-modules@0.1.6-no-external-plugins": + version "0.1.6-no-external-plugins" + resolved "https://registry.yarnpkg.com/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz#ccb88a2c49c817236861fee7826080573b8a923a" + integrity sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA== + dependencies: + "@babel/helper-plugin-utils" "^7.0.0" + "@babel/types" "^7.4.4" + esutils "^2.0.2" + +"@babel/preset-react@^7.18.6", "@babel/preset-react@^7.25.9": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/preset-react/-/preset-react-7.27.1.tgz#86ea0a5ca3984663f744be2fd26cb6747c3fd0ec" + integrity sha512-oJHWh2gLhU9dW9HHr42q0cI0/iHHXTLGe39qvpAZZzagHy0MzYLCnCVV0symeRvzmjHyVU7mw2K06E6u/JwbhA== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-validator-option" "^7.27.1" + "@babel/plugin-transform-react-display-name" "^7.27.1" + "@babel/plugin-transform-react-jsx" "^7.27.1" + "@babel/plugin-transform-react-jsx-development" "^7.27.1" + "@babel/plugin-transform-react-pure-annotations" "^7.27.1" + +"@babel/preset-typescript@^7.21.0", "@babel/preset-typescript@^7.25.9": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/preset-typescript/-/preset-typescript-7.27.1.tgz#190742a6428d282306648a55b0529b561484f912" + integrity sha512-l7WfQfX0WK4M0v2RudjuQK4u99BS6yLHYEmdtVPP7lKV013zr9DygFuWNlnbvQ9LR+LS0Egz/XAvGx5U9MX0fQ== + dependencies: + "@babel/helper-plugin-utils" "^7.27.1" + "@babel/helper-validator-option" "^7.27.1" + "@babel/plugin-syntax-jsx" "^7.27.1" + "@babel/plugin-transform-modules-commonjs" "^7.27.1" + "@babel/plugin-transform-typescript" "^7.27.1" + +"@babel/runtime-corejs3@^7.25.9": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/runtime-corejs3/-/runtime-corejs3-7.28.4.tgz#c25be39c7997ce2f130d70b9baecb8ed94df93fa" + integrity sha512-h7iEYiW4HebClDEhtvFObtPmIvrd1SSfpI9EhOeKk4CtIK/ngBWFpuhCzhdmRKtg71ylcue+9I6dv54XYO1epQ== + dependencies: + core-js-pure "^3.43.0" + +"@babel/runtime@^7.1.2", "@babel/runtime@^7.10.3", "@babel/runtime@^7.12.13", "@babel/runtime@^7.12.5", "@babel/runtime@^7.18.3", "@babel/runtime@^7.25.9", "@babel/runtime@^7.28.3", "@babel/runtime@^7.5.5", "@babel/runtime@^7.8.7": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.28.4.tgz#a70226016fabe25c5783b2f22d3e1c9bc5ca3326" + integrity sha512-Q/N6JNWvIvPnLDvjlE1OUBLPQHH6l3CltCEsHIujp45zQUSSh8K+gHnaEX45yAT1nyngnINhvWtzN+Nb9D8RAQ== + +"@babel/template@^7.27.1", "@babel/template@^7.27.2": + version "7.27.2" + resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.27.2.tgz#fa78ceed3c4e7b63ebf6cb39e5852fca45f6809d" + integrity sha512-LPDZ85aEJyYSd18/DkjNh4/y1ntkE5KwUHWTiqgRxruuZL2F1yuHligVHLvcHY2vMHXttKFpJn6LwfI7cw7ODw== + dependencies: + "@babel/code-frame" "^7.27.1" + "@babel/parser" "^7.27.2" + "@babel/types" "^7.27.1" + +"@babel/traverse@^7.25.9", "@babel/traverse@^7.27.1", "@babel/traverse@^7.28.0", "@babel/traverse@^7.28.3", "@babel/traverse@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.4.tgz#8d456101b96ab175d487249f60680221692b958b" + integrity sha512-YEzuboP2qvQavAcjgQNVgsvHIDv6ZpwXvcvjmyySP2DIMuByS/6ioU5G9pYrWHM6T2YDfc7xga9iNzYOs12CFQ== + dependencies: + "@babel/code-frame" "^7.27.1" + "@babel/generator" "^7.28.3" + "@babel/helper-globals" "^7.28.0" + "@babel/parser" "^7.28.4" + "@babel/template" "^7.27.2" + "@babel/types" "^7.28.4" + debug "^4.3.1" + +"@babel/types@^7.21.3", "@babel/types@^7.27.1", "@babel/types@^7.27.3", "@babel/types@^7.28.2", "@babel/types@^7.28.4", "@babel/types@^7.4.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.28.4.tgz#0a4e618f4c60a7cd6c11cb2d48060e4dbe38ac3a" + integrity sha512-bkFqkLhh3pMBUQQkpVgWDWq/lqzc2678eUyDlTBhRqhCHFguYYGM0Efga7tYk4TogG/3x0EEl66/OQ+WGbWB/Q== + dependencies: + "@babel/helper-string-parser" "^7.27.1" + "@babel/helper-validator-identifier" "^7.27.1" + +"@colors/colors@1.5.0": + version "1.5.0" + resolved "https://registry.yarnpkg.com/@colors/colors/-/colors-1.5.0.tgz#bb504579c1cae923e6576a4f5da43d25f97bdbd9" + integrity sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ== + +"@csstools/cascade-layer-name-parser@^2.0.5": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz#43f962bebead0052a9fed1a2deeb11f85efcbc72" + integrity sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A== + +"@csstools/color-helpers@^5.1.0": + version "5.1.0" + resolved "https://registry.yarnpkg.com/@csstools/color-helpers/-/color-helpers-5.1.0.tgz#106c54c808cabfd1ab4c602d8505ee584c2996ef" + integrity sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA== + +"@csstools/css-calc@^2.1.4": + version "2.1.4" + resolved "https://registry.yarnpkg.com/@csstools/css-calc/-/css-calc-2.1.4.tgz#8473f63e2fcd6e459838dd412401d5948f224c65" + integrity sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ== + +"@csstools/css-color-parser@^3.1.0": + version "3.1.0" + resolved "https://registry.yarnpkg.com/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz#4e386af3a99dd36c46fef013cfe4c1c341eed6f0" + integrity sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA== + dependencies: + "@csstools/color-helpers" "^5.1.0" + "@csstools/css-calc" "^2.1.4" + +"@csstools/css-parser-algorithms@^3.0.5": + version "3.0.5" + resolved "https://registry.yarnpkg.com/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz#5755370a9a29abaec5515b43c8b3f2cf9c2e3076" + integrity sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ== + +"@csstools/css-tokenizer@^3.0.4": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz#333fedabc3fd1a8e5d0100013731cf19e6a8c5d3" + integrity sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw== + +"@csstools/media-query-list-parser@^4.0.3": + version "4.0.3" + resolved "https://registry.yarnpkg.com/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz#7aec77bcb89c2da80ef207e73f474ef9e1b3cdf1" + integrity sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ== + +"@csstools/postcss-alpha-function@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-alpha-function/-/postcss-alpha-function-1.0.0.tgz#8764fbbf25a5f1e106fb623ae632e01a220a6fc2" + integrity sha512-r2L8KNg5Wriq5n8IUQcjzy2Rh37J5YjzP9iOyHZL5fxdWYHB08vqykHQa4wAzN/tXwDuCHnhQDGCtxfS76xn7g== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-cascade-layers@^5.0.2": + version "5.0.2" + resolved "https://registry.yarnpkg.com/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.2.tgz#dd2c70db3867b88975f2922da3bfbae7d7a2cae7" + integrity sha512-nWBE08nhO8uWl6kSAeCx4im7QfVko3zLrtgWZY4/bP87zrSPpSyN/3W3TDqz1jJuH+kbKOHXg5rJnK+ZVYcFFg== + dependencies: + "@csstools/selector-specificity" "^5.0.0" + postcss-selector-parser "^7.0.0" + +"@csstools/postcss-color-function-display-p3-linear@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-function-display-p3-linear/-/postcss-color-function-display-p3-linear-1.0.0.tgz#27395b62a5d9a108eefcc0eb463247a15f4269a1" + integrity sha512-7q+OuUqfowRrP84m/Jl0wv3pfCQyUTCW5MxDIux+/yty5IkUUHOTigCjrC0Fjy3OT0ncGLudHbfLWmP7E1arNA== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-color-function@^4.0.11": + version "4.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-function/-/postcss-color-function-4.0.11.tgz#03c34a51dc00943a6674294fb1163e7af9e87ffd" + integrity sha512-AtH22zLHTLm64HLdpv5EedT/zmYTm1MtdQbQhRZXxEB6iYtS6SrS1jLX3TcmUWMFzpumK/OVylCm3HcLms4slw== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-color-mix-function@^3.0.11": + version "3.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.11.tgz#6db0a1c749fabaf2bf978b37044700d1c1b09fc2" + integrity sha512-cQpXBelpTx0YhScZM5Ve0jDCA4RzwFc7oNafzZOGgCHt/GQVYiU8Vevz9QJcwy/W0Pyi/BneY+KMjz23lI9r+Q== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-color-mix-variadic-function-arguments@^1.0.1": + version "1.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-color-mix-variadic-function-arguments/-/postcss-color-mix-variadic-function-arguments-1.0.1.tgz#2dd9d66ded0d41cd7b2c13a1188f03e894c17d7e" + integrity sha512-c7hyBtbF+jlHIcUGVdWY06bHICgguV9ypfcELU3eU3W/9fiz2dxM8PqxQk2ndXYTzLnwPvNNqu1yCmQ++N6Dcg== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-content-alt-text@^2.0.7": + version "2.0.7" + resolved "https://registry.yarnpkg.com/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.7.tgz#ac0a263e8acb0be99cdcfc0b1792c62141825747" + integrity sha512-cq/zWaEkpcg3RttJ5+GdNwk26NwxY5KgqgtNL777Fdd28AVGHxuBvqmK4Jq4oKhW1NX4M2LbgYAVVN0NZ+/XYQ== + dependencies: + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-exponential-functions@^2.0.9": + version "2.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.9.tgz#fc03d1272888cb77e64cc1a7d8a33016e4f05c69" + integrity sha512-abg2W/PI3HXwS/CZshSa79kNWNZHdJPMBXeZNyPQFbbj8sKO3jXxOt/wF7juJVjyDTc6JrvaUZYFcSBZBhaxjw== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-font-format-keywords@^4.0.0": + version "4.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-font-format-keywords/-/postcss-font-format-keywords-4.0.0.tgz#6730836eb0153ff4f3840416cc2322f129c086e6" + integrity sha512-usBzw9aCRDvchpok6C+4TXC57btc4bJtmKQWOHQxOVKen1ZfVqBUuCZ/wuqdX5GHsD0NRSr9XTP+5ID1ZZQBXw== + dependencies: + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +"@csstools/postcss-gamut-mapping@^2.0.11": + version "2.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-gamut-mapping/-/postcss-gamut-mapping-2.0.11.tgz#be0e34c9f0142852cccfc02b917511f0d677db8b" + integrity sha512-fCpCUgZNE2piVJKC76zFsgVW1apF6dpYsqGyH8SIeCcM4pTEsRTWTLCaJIMKFEundsCKwY1rwfhtrio04RJ4Dw== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-gradients-interpolation-method@^5.0.11": + version "5.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.11.tgz#f1c5c431a44ed9655cb408aea8666ed2c5250490" + integrity sha512-8M3mcNTL3cGIJXDnvrJ2oWEcKi3zyw7NeYheFKePUlBmLYm1gkw9Rr/BA7lFONrOPeQA3yeMPldrrws6lqHrug== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-hwb-function@^4.0.11": + version "4.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.11.tgz#4bb173f1c8c2361bf46a842a948ee687471ae4ea" + integrity sha512-9meZbsVWTZkWsSBazQips3cHUOT29a/UAwFz0AMEXukvpIGGDR9+GMl3nIckWO5sPImsadu4F5Zy+zjt8QgCdA== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-ic-unit@^4.0.3": + version "4.0.3" + resolved "https://registry.yarnpkg.com/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.3.tgz#ba0375e9d346e6e5a42dc8c2cb1133b2262f9ffa" + integrity sha512-RtYYm2qUIu9vAaHB0cC8rQGlOCQAUgEc2tMr7ewlGXYipBQKjoWmyVArqsk7SEr8N3tErq6P6UOJT3amaVof5Q== + dependencies: + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +"@csstools/postcss-initial@^2.0.1": + version "2.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-initial/-/postcss-initial-2.0.1.tgz#c385bd9d8ad31ad159edd7992069e97ceea4d09a" + integrity sha512-L1wLVMSAZ4wovznquK0xmC7QSctzO4D0Is590bxpGqhqjboLXYA16dWZpfwImkdOgACdQ9PqXsuRroW6qPlEsg== + +"@csstools/postcss-is-pseudo-class@^5.0.3": + version "5.0.3" + resolved "https://registry.yarnpkg.com/@csstools/postcss-is-pseudo-class/-/postcss-is-pseudo-class-5.0.3.tgz#d34e850bcad4013c2ed7abe948bfa0448aa8eb74" + integrity sha512-jS/TY4SpG4gszAtIg7Qnf3AS2pjcUM5SzxpApOrlndMeGhIbaTzWBzzP/IApXoNWEW7OhcjkRT48jnAUIFXhAQ== + dependencies: + "@csstools/selector-specificity" "^5.0.0" + postcss-selector-parser "^7.0.0" + +"@csstools/postcss-light-dark-function@^2.0.10": + version "2.0.10" + resolved "https://registry.yarnpkg.com/@csstools/postcss-light-dark-function/-/postcss-light-dark-function-2.0.10.tgz#b606f13d1f81efd297763c6ad1ac515c3ca4165b" + integrity sha512-g7Lwb294lSoNnyrwcqoooh9fTAp47rRNo+ILg7SLRSMU3K9ePIwRt566sNx+pehiCelv4E1ICaU1EwLQuyF2qw== + dependencies: + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-logical-float-and-clear@^3.0.0": + version "3.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-float-and-clear/-/postcss-logical-float-and-clear-3.0.0.tgz#62617564182cf86ab5d4e7485433ad91e4c58571" + integrity sha512-SEmaHMszwakI2rqKRJgE+8rpotFfne1ZS6bZqBoQIicFyV+xT1UF42eORPxJkVJVrH9C0ctUgwMSn3BLOIZldQ== + +"@csstools/postcss-logical-overflow@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-overflow/-/postcss-logical-overflow-2.0.0.tgz#c6de7c5f04e3d4233731a847f6c62819bcbcfa1d" + integrity sha512-spzR1MInxPuXKEX2csMamshR4LRaSZ3UXVaRGjeQxl70ySxOhMpP2252RAFsg8QyyBXBzuVOOdx1+bVO5bPIzA== + +"@csstools/postcss-logical-overscroll-behavior@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-overscroll-behavior/-/postcss-logical-overscroll-behavior-2.0.0.tgz#43c03eaecdf34055ef53bfab691db6dc97a53d37" + integrity sha512-e/webMjoGOSYfqLunyzByZj5KKe5oyVg/YSbie99VEaSDE2kimFm0q1f6t/6Jo+VVCQ/jbe2Xy+uX+C4xzWs4w== + +"@csstools/postcss-logical-resize@^3.0.0": + version "3.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-resize/-/postcss-logical-resize-3.0.0.tgz#4df0eeb1a61d7bd85395e56a5cce350b5dbfdca6" + integrity sha512-DFbHQOFW/+I+MY4Ycd/QN6Dg4Hcbb50elIJCfnwkRTCX05G11SwViI5BbBlg9iHRl4ytB7pmY5ieAFk3ws7yyg== + dependencies: + postcss-value-parser "^4.2.0" + +"@csstools/postcss-logical-viewport-units@^3.0.4": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@csstools/postcss-logical-viewport-units/-/postcss-logical-viewport-units-3.0.4.tgz#016d98a8b7b5f969e58eb8413447eb801add16fc" + integrity sha512-q+eHV1haXA4w9xBwZLKjVKAWn3W2CMqmpNpZUk5kRprvSiBEGMgrNH3/sJZ8UA3JgyHaOt3jwT9uFa4wLX4EqQ== + dependencies: + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-media-minmax@^2.0.9": + version "2.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.9.tgz#184252d5b93155ae526689328af6bdf3fc113987" + integrity sha512-af9Qw3uS3JhYLnCbqtZ9crTvvkR+0Se+bBqSr7ykAnl9yKhk6895z9rf+2F4dClIDJWxgn0iZZ1PSdkhrbs2ig== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" + +"@csstools/postcss-media-queries-aspect-ratio-number-values@^3.0.5": + version "3.0.5" + resolved "https://registry.yarnpkg.com/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.5.tgz#f485c31ec13d6b0fb5c528a3474334a40eff5f11" + integrity sha512-zhAe31xaaXOY2Px8IYfoVTB3wglbJUVigGphFLj6exb7cjZRH9A6adyE22XfFK3P2PzwRk0VDeTJmaxpluyrDg== + dependencies: + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" + +"@csstools/postcss-nested-calc@^4.0.0": + version "4.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-nested-calc/-/postcss-nested-calc-4.0.0.tgz#754e10edc6958d664c11cde917f44ba144141c62" + integrity sha512-jMYDdqrQQxE7k9+KjstC3NbsmC063n1FTPLCgCRS2/qHUbHM0mNy9pIn4QIiQGs9I/Bg98vMqw7mJXBxa0N88A== + dependencies: + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +"@csstools/postcss-normalize-display-values@^4.0.0": + version "4.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-normalize-display-values/-/postcss-normalize-display-values-4.0.0.tgz#ecdde2daf4e192e5da0c6fd933b6d8aff32f2a36" + integrity sha512-HlEoG0IDRoHXzXnkV4in47dzsxdsjdz6+j7MLjaACABX2NfvjFS6XVAnpaDyGesz9gK2SC7MbNwdCHusObKJ9Q== + dependencies: + postcss-value-parser "^4.2.0" + +"@csstools/postcss-oklab-function@^4.0.11": + version "4.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-oklab-function/-/postcss-oklab-function-4.0.11.tgz#d69242a9b027dda731bd79db7293bc938bb6df97" + integrity sha512-9f03ZGxZ2VmSCrM4SDXlAYP+Xpu4VFzemfQUQFL9OYxAbpvDy0FjDipZ0i8So1pgs8VIbQI0bNjFWgfdpGw8ig== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-progressive-custom-properties@^4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-progressive-custom-properties/-/postcss-progressive-custom-properties-4.2.0.tgz#7f15349c2cd108478d28e1503c660d4037925030" + integrity sha512-fWCXRasX17N1NCPTCuwC3FJDV+Wc031f16cFuuMEfIsYJ1q5ABCa59W0C6VeMGqjNv6ldf37vvwXXAeaZjD9PA== + dependencies: + postcss-value-parser "^4.2.0" + +"@csstools/postcss-random-function@^2.0.1": + version "2.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-random-function/-/postcss-random-function-2.0.1.tgz#3191f32fe72936e361dadf7dbfb55a0209e2691e" + integrity sha512-q+FQaNiRBhnoSNo+GzqGOIBKoHQ43lYz0ICrV+UudfWnEF6ksS6DsBIJSISKQT2Bvu3g4k6r7t0zYrk5pDlo8w== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-relative-color-syntax@^3.0.11": + version "3.0.11" + resolved "https://registry.yarnpkg.com/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.11.tgz#d81d59ff123fa5f3e4a0493b1e2b0585353bb541" + integrity sha512-oQ5fZvkcBrWR+k6arHXk0F8FlkmD4IxM+rcGDLWrF2f31tWyEM3lSraeWAV0f7BGH6LIrqmyU3+Qo/1acfoJng== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +"@csstools/postcss-scope-pseudo-class@^4.0.1": + version "4.0.1" + resolved "https://registry.yarnpkg.com/@csstools/postcss-scope-pseudo-class/-/postcss-scope-pseudo-class-4.0.1.tgz#9fe60e9d6d91d58fb5fc6c768a40f6e47e89a235" + integrity sha512-IMi9FwtH6LMNuLea1bjVMQAsUhFxJnyLSgOp/cpv5hrzWmrUYU5fm0EguNDIIOHUqzXode8F/1qkC/tEo/qN8Q== + dependencies: + postcss-selector-parser "^7.0.0" + +"@csstools/postcss-sign-functions@^1.1.4": + version "1.1.4" + resolved "https://registry.yarnpkg.com/@csstools/postcss-sign-functions/-/postcss-sign-functions-1.1.4.tgz#a9ac56954014ae4c513475b3f1b3e3424a1e0c12" + integrity sha512-P97h1XqRPcfcJndFdG95Gv/6ZzxUBBISem0IDqPZ7WMvc/wlO+yU0c5D/OCpZ5TJoTt63Ok3knGk64N+o6L2Pg== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-stepped-value-functions@^4.0.9": + version "4.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.9.tgz#36036f1a0e5e5ee2308e72f3c9cb433567c387b9" + integrity sha512-h9btycWrsex4dNLeQfyU3y3w40LMQooJWFMm/SK9lrKguHDcFl4VMkncKKoXi2z5rM9YGWbUQABI8BT2UydIcA== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-text-decoration-shorthand@^4.0.3": + version "4.0.3" + resolved "https://registry.yarnpkg.com/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.3.tgz#fae1b70f07d1b7beb4c841c86d69e41ecc6f743c" + integrity sha512-KSkGgZfx0kQjRIYnpsD7X2Om9BUXX/Kii77VBifQW9Ih929hK0KNjVngHDH0bFB9GmfWcR9vJYJJRvw/NQjkrA== + dependencies: + "@csstools/color-helpers" "^5.1.0" + postcss-value-parser "^4.2.0" + +"@csstools/postcss-trigonometric-functions@^4.0.9": + version "4.0.9" + resolved "https://registry.yarnpkg.com/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.9.tgz#3f94ed2e319b57f2c59720b64e4d0a8a6fb8c3b2" + integrity sha512-Hnh5zJUdpNrJqK9v1/E3BbrQhaDTj5YiX7P61TOvUhoDHnUmsNNxcDAgkQ32RrcWx9GVUvfUNPcUkn8R3vIX6A== + dependencies: + "@csstools/css-calc" "^2.1.4" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + +"@csstools/postcss-unset-value@^4.0.0": + version "4.0.0" + resolved "https://registry.yarnpkg.com/@csstools/postcss-unset-value/-/postcss-unset-value-4.0.0.tgz#7caa981a34196d06a737754864baf77d64de4bba" + integrity sha512-cBz3tOCI5Fw6NIFEwU3RiwK6mn3nKegjpJuzCndoGq3BZPkUjnsq7uQmIeMNeMbMk7YD2MfKcgCpZwX5jyXqCA== + +"@csstools/selector-resolve-nested@^3.1.0": + version "3.1.0" + resolved "https://registry.yarnpkg.com/@csstools/selector-resolve-nested/-/selector-resolve-nested-3.1.0.tgz#848c6f44cb65e3733e478319b9342b7aa436fac7" + integrity sha512-mf1LEW0tJLKfWyvn5KdDrhpxHyuxpbNwTIwOYLIvsTffeyOf85j5oIzfG0yosxDgx/sswlqBnESYUcQH0vgZ0g== + +"@csstools/selector-specificity@^5.0.0": + version "5.0.0" + resolved "https://registry.yarnpkg.com/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz#037817b574262134cabd68fc4ec1a454f168407b" + integrity sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw== + +"@csstools/utilities@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@csstools/utilities/-/utilities-2.0.0.tgz#f7ff0fee38c9ffb5646d47b6906e0bc8868bde60" + integrity sha512-5VdOr0Z71u+Yp3ozOx8T11N703wIFGVRgOWbOZMKgglPJsWA54MRIoMNVMa7shUToIhx5J8vX4sOZgD2XiihiQ== + +"@discoveryjs/json-ext@0.5.7": + version "0.5.7" + resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70" + integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw== + +"@docsearch/css@3.9.0": + version "3.9.0" + resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.9.0.tgz#3bc29c96bf024350d73b0cfb7c2a7b71bf251cd5" + integrity sha512-cQbnVbq0rrBwNAKegIac/t6a8nWoUAn8frnkLFW6YARaRmAQr5/Eoe6Ln2fqkUCZ40KpdrKbpSAmgrkviOxuWA== + +"@docsearch/react@^3.9.0": + version "3.9.0" + resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-3.9.0.tgz#d0842b700c3ee26696786f3c8ae9f10c1a3f0db3" + integrity sha512-mb5FOZYZIkRQ6s/NWnM98k879vu5pscWqTLubLFBO87igYYT4VzVazh4h5o/zCvTIZgEt3PvsCOMOswOUo9yHQ== + dependencies: + "@algolia/autocomplete-core" "1.17.9" + "@algolia/autocomplete-preset-algolia" "1.17.9" + "@docsearch/css" "3.9.0" + algoliasearch "^5.14.2" + +"@docusaurus/babel@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/babel/-/babel-3.8.1.tgz#db329ac047184214e08e2dbc809832c696c18506" + integrity sha512-3brkJrml8vUbn9aeoZUlJfsI/GqyFcDgQJwQkmBtclJgWDEQBKKeagZfOgx0WfUQhagL1sQLNW0iBdxnI863Uw== + dependencies: + "@babel/core" "^7.25.9" + "@babel/generator" "^7.25.9" + "@babel/plugin-syntax-dynamic-import" "^7.8.3" + "@babel/plugin-transform-runtime" "^7.25.9" + "@babel/preset-env" "^7.25.9" + "@babel/preset-react" "^7.25.9" + "@babel/preset-typescript" "^7.25.9" + "@babel/runtime" "^7.25.9" + "@babel/runtime-corejs3" "^7.25.9" + "@babel/traverse" "^7.25.9" + "@docusaurus/logger" "3.8.1" + "@docusaurus/utils" "3.8.1" + babel-plugin-dynamic-import-node "^2.3.3" + fs-extra "^11.1.1" + tslib "^2.6.0" + +"@docusaurus/bundler@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/bundler/-/bundler-3.8.1.tgz#e2b11d615f09a6e470774bb36441b8d06736b94c" + integrity sha512-/z4V0FRoQ0GuSLToNjOSGsk6m2lQUG4FRn8goOVoZSRsTrU8YR2aJacX5K3RG18EaX9b+52pN4m1sL3MQZVsQA== + dependencies: + "@babel/core" "^7.25.9" + "@docusaurus/babel" "3.8.1" + "@docusaurus/cssnano-preset" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + babel-loader "^9.2.1" + clean-css "^5.3.3" + copy-webpack-plugin "^11.0.0" + css-loader "^6.11.0" + css-minimizer-webpack-plugin "^5.0.1" + cssnano "^6.1.2" + file-loader "^6.2.0" + html-minifier-terser "^7.2.0" + mini-css-extract-plugin "^2.9.2" + null-loader "^4.0.1" + postcss "^8.5.4" + postcss-loader "^7.3.4" + postcss-preset-env "^10.2.1" + terser-webpack-plugin "^5.3.9" + tslib "^2.6.0" + url-loader "^4.1.1" + webpack "^5.95.0" + webpackbar "^6.0.1" + +"@docusaurus/core@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-3.8.1.tgz#c22e47c16a22cb7d245306c64bc54083838ff3db" + integrity sha512-ENB01IyQSqI2FLtOzqSI3qxG2B/jP4gQPahl2C3XReiLebcVh5B5cB9KYFvdoOqOWPyr5gXK4sjgTKv7peXCrA== + dependencies: + "@docusaurus/babel" "3.8.1" + "@docusaurus/bundler" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + boxen "^6.2.1" + chalk "^4.1.2" + chokidar "^3.5.3" + cli-table3 "^0.6.3" + combine-promises "^1.1.0" + commander "^5.1.0" + core-js "^3.31.1" + detect-port "^1.5.1" + escape-html "^1.0.3" + eta "^2.2.0" + eval "^0.1.8" + execa "5.1.1" + fs-extra "^11.1.1" + html-tags "^3.3.1" + html-webpack-plugin "^5.6.0" + leven "^3.1.0" + lodash "^4.17.21" + open "^8.4.0" + p-map "^4.0.0" + prompts "^2.4.2" + react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" + react-loadable "npm:@docusaurus/react-loadable@6.0.0" + react-loadable-ssr-addon-v5-slorber "^1.0.1" + react-router "^5.3.4" + react-router-config "^5.1.1" + react-router-dom "^5.3.4" + semver "^7.5.4" + serve-handler "^6.1.6" + tinypool "^1.0.2" + tslib "^2.6.0" + update-notifier "^6.0.2" + webpack "^5.95.0" + webpack-bundle-analyzer "^4.10.2" + webpack-dev-server "^4.15.2" + webpack-merge "^6.0.1" + +"@docusaurus/cssnano-preset@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-3.8.1.tgz#bd55026251a6ab8e2194839a2042458ef9880c44" + integrity sha512-G7WyR2N6SpyUotqhGznERBK+x84uyhfMQM2MmDLs88bw4Flom6TY46HzkRkSEzaP9j80MbTN8naiL1fR17WQug== + dependencies: + cssnano-preset-advanced "^6.1.2" + postcss "^8.5.4" + postcss-sort-media-queries "^5.2.0" + tslib "^2.6.0" + +"@docusaurus/logger@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-3.8.1.tgz#45321b2e2e14695d0dbd8b4104ea7b0fbaa98700" + integrity sha512-2wjeGDhKcExEmjX8k1N/MRDiPKXGF2Pg+df/bDDPnnJWHXnVEZxXj80d6jcxp1Gpnksl0hF8t/ZQw9elqj2+ww== + dependencies: + chalk "^4.1.2" + tslib "^2.6.0" + +"@docusaurus/mdx-loader@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-3.8.1.tgz#74309b3614bbcef1d55fb13e6cc339b7fb000b5f" + integrity sha512-DZRhagSFRcEq1cUtBMo4TKxSNo/W6/s44yhr8X+eoXqCLycFQUylebOMPseHi5tc4fkGJqwqpWJLz6JStU9L4w== + dependencies: + "@docusaurus/logger" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + "@mdx-js/mdx" "^3.0.0" + "@slorber/remark-comment" "^1.0.0" + escape-html "^1.0.3" + estree-util-value-to-estree "^3.0.1" + file-loader "^6.2.0" + fs-extra "^11.1.1" + image-size "^2.0.2" + mdast-util-mdx "^3.0.0" + mdast-util-to-string "^4.0.0" + rehype-raw "^7.0.0" + remark-directive "^3.0.0" + remark-emoji "^4.0.0" + remark-frontmatter "^5.0.0" + remark-gfm "^4.0.0" + stringify-object "^3.3.0" + tslib "^2.6.0" + unified "^11.0.3" + unist-util-visit "^5.0.0" + url-loader "^4.1.1" + vfile "^6.0.1" + webpack "^5.88.1" + +"@docusaurus/module-type-aliases@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-3.8.1.tgz#454de577bd7f50b5eae16db0f76b49ca5e4e281a" + integrity sha512-6xhvAJiXzsaq3JdosS7wbRt/PwEPWHr9eM4YNYqVlbgG1hSK3uQDXTVvQktasp3VO6BmfYWPozueLWuj4gB+vg== + dependencies: + "@docusaurus/types" "3.8.1" + "@types/history" "^4.7.11" + "@types/react" "*" + "@types/react-router-config" "*" + "@types/react-router-dom" "*" + react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" + react-loadable "npm:@docusaurus/react-loadable@6.0.0" + +"@docusaurus/plugin-content-blog@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.8.1.tgz#88d842b562b04cf59df900d9f6984b086f821525" + integrity sha512-vNTpMmlvNP9n3hGEcgPaXyvTljanAKIUkuG9URQ1DeuDup0OR7Ltvoc8yrmH+iMZJbcQGhUJF+WjHLwuk8HSdw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/theme-common" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + cheerio "1.0.0-rc.12" + feed "^4.2.2" + fs-extra "^11.1.1" + lodash "^4.17.21" + schema-dts "^1.1.2" + srcset "^4.0.0" + tslib "^2.6.0" + unist-util-visit "^5.0.0" + utility-types "^3.10.0" + webpack "^5.88.1" + +"@docusaurus/plugin-content-docs@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.8.1.tgz#40686a206abb6373bee5638de100a2c312f112a4" + integrity sha512-oByRkSZzeGNQByCMaX+kif5Nl2vmtj2IHQI2fWjCfCootsdKZDPFLonhIp5s3IGJO7PLUfe0POyw0Xh/RrGXJA== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/module-type-aliases" "3.8.1" + "@docusaurus/theme-common" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + "@types/react-router-config" "^5.0.7" + combine-promises "^1.1.0" + fs-extra "^11.1.1" + js-yaml "^4.1.0" + lodash "^4.17.21" + schema-dts "^1.1.2" + tslib "^2.6.0" + utility-types "^3.10.0" + webpack "^5.88.1" + +"@docusaurus/plugin-content-pages@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.8.1.tgz#41b684dbd15390b7bb6a627f78bf81b6324511ac" + integrity sha512-a+V6MS2cIu37E/m7nDJn3dcxpvXb6TvgdNI22vJX8iUTp8eoMoPa0VArEbWvCxMY/xdC26WzNv4wZ6y0iIni/w== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + fs-extra "^11.1.1" + tslib "^2.6.0" + webpack "^5.88.1" + +"@docusaurus/plugin-css-cascade-layers@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.8.1.tgz#cb414b4a82aa60fc64ef2a435ad0105e142a6c71" + integrity sha512-VQ47xRxfNKjHS5ItzaVXpxeTm7/wJLFMOPo1BkmoMG4Cuz4nuI+Hs62+RMk1OqVog68Swz66xVPK8g9XTrBKRw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + tslib "^2.6.0" + +"@docusaurus/plugin-debug@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-3.8.1.tgz#45b107e46b627caaae66995f53197ace78af3491" + integrity sha512-nT3lN7TV5bi5hKMB7FK8gCffFTBSsBsAfV84/v293qAmnHOyg1nr9okEw8AiwcO3bl9vije5nsUvP0aRl2lpaw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + fs-extra "^11.1.1" + react-json-view-lite "^2.3.0" + tslib "^2.6.0" + +"@docusaurus/plugin-google-analytics@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.8.1.tgz#64a302e62fe5cb6e007367c964feeef7b056764a" + integrity sha512-Hrb/PurOJsmwHAsfMDH6oVpahkEGsx7F8CWMjyP/dw1qjqmdS9rcV1nYCGlM8nOtD3Wk/eaThzUB5TSZsGz+7Q== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + tslib "^2.6.0" + +"@docusaurus/plugin-google-gtag@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.8.1.tgz#8c76f8a1d96448f2f0f7b10e6bde451c40672b95" + integrity sha512-tKE8j1cEZCh8KZa4aa80zpSTxsC2/ZYqjx6AAfd8uA8VHZVw79+7OTEP2PoWi0uL5/1Is0LF5Vwxd+1fz5HlKg== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + "@types/gtag.js" "^0.0.12" + tslib "^2.6.0" + +"@docusaurus/plugin-google-tag-manager@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.8.1.tgz#88241ffd06369f4a4d5fb982ff3ac2777561ae37" + integrity sha512-iqe3XKITBquZq+6UAXdb1vI0fPY5iIOitVjPQ581R1ZKpHr0qe+V6gVOrrcOHixPDD/BUKdYwkxFjpNiEN+vBw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + tslib "^2.6.0" + +"@docusaurus/plugin-sitemap@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.8.1.tgz#3aebd39186dc30e53023f1aab44625bc0bdac892" + integrity sha512-+9YV/7VLbGTq8qNkjiugIelmfUEVkTyLe6X8bWq7K5qPvGXAjno27QAfFq63mYfFFbJc7z+pudL63acprbqGzw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + fs-extra "^11.1.1" + sitemap "^7.1.1" + tslib "^2.6.0" + +"@docusaurus/plugin-svgr@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-svgr/-/plugin-svgr-3.8.1.tgz#6f340be8eae418a2cce540d8ece096ffd9c9b6ab" + integrity sha512-rW0LWMDsdlsgowVwqiMb/7tANDodpy1wWPwCcamvhY7OECReN3feoFwLjd/U4tKjNY3encj0AJSTxJA+Fpe+Gw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + "@svgr/core" "8.1.0" + "@svgr/webpack" "^8.1.0" + tslib "^2.6.0" + webpack "^5.88.1" + +"@docusaurus/preset-classic@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-3.8.1.tgz#bb79fd12f3211363720c569a526c7e24d3aa966b" + integrity sha512-yJSjYNHXD8POMGc2mKQuj3ApPrN+eG0rO1UPgSx7jySpYU+n4WjBikbrA2ue5ad9A7aouEtMWUoiSRXTH/g7KQ== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/plugin-content-blog" "3.8.1" + "@docusaurus/plugin-content-docs" "3.8.1" + "@docusaurus/plugin-content-pages" "3.8.1" + "@docusaurus/plugin-css-cascade-layers" "3.8.1" + "@docusaurus/plugin-debug" "3.8.1" + "@docusaurus/plugin-google-analytics" "3.8.1" + "@docusaurus/plugin-google-gtag" "3.8.1" + "@docusaurus/plugin-google-tag-manager" "3.8.1" + "@docusaurus/plugin-sitemap" "3.8.1" + "@docusaurus/plugin-svgr" "3.8.1" + "@docusaurus/theme-classic" "3.8.1" + "@docusaurus/theme-common" "3.8.1" + "@docusaurus/theme-search-algolia" "3.8.1" + "@docusaurus/types" "3.8.1" + +"@docusaurus/theme-classic@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-3.8.1.tgz#1e45c66d89ded359225fcd29bf3258d9205765c1" + integrity sha512-bqDUCNqXeYypMCsE1VcTXSI1QuO4KXfx8Cvl6rYfY0bhhqN6d2WZlRkyLg/p6pm+DzvanqHOyYlqdPyP0iz+iw== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/module-type-aliases" "3.8.1" + "@docusaurus/plugin-content-blog" "3.8.1" + "@docusaurus/plugin-content-docs" "3.8.1" + "@docusaurus/plugin-content-pages" "3.8.1" + "@docusaurus/theme-common" "3.8.1" + "@docusaurus/theme-translations" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + "@mdx-js/react" "^3.0.0" + clsx "^2.0.0" + copy-text-to-clipboard "^3.2.0" + infima "0.2.0-alpha.45" + lodash "^4.17.21" + nprogress "^0.2.0" + postcss "^8.5.4" + prism-react-renderer "^2.3.0" + prismjs "^1.29.0" + react-router-dom "^5.3.4" + rtlcss "^4.1.0" + tslib "^2.6.0" + utility-types "^3.10.0" + +"@docusaurus/theme-common@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-3.8.1.tgz#17c23316fbe3ee3f7e707c7298cb59a0fff38b4b" + integrity sha512-UswMOyTnPEVRvN5Qzbo+l8k4xrd5fTFu2VPPfD6FcW/6qUtVLmJTQCktbAL3KJ0BVXGm5aJXz/ZrzqFuZERGPw== + dependencies: + "@docusaurus/mdx-loader" "3.8.1" + "@docusaurus/module-type-aliases" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@types/history" "^4.7.11" + "@types/react" "*" + "@types/react-router-config" "*" + clsx "^2.0.0" + parse-numeric-range "^1.3.0" + prism-react-renderer "^2.3.0" + tslib "^2.6.0" + utility-types "^3.10.0" + +"@docusaurus/theme-search-algolia@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.8.1.tgz#3aa3d99c35cc2d4b709fcddd4df875a9b536e29b" + integrity sha512-NBFH5rZVQRAQM087aYSRKQ9yGEK9eHd+xOxQjqNpxMiV85OhJDD4ZGz6YJIod26Fbooy54UWVdzNU0TFeUUUzQ== + dependencies: + "@docsearch/react" "^3.9.0" + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/plugin-content-docs" "3.8.1" + "@docusaurus/theme-common" "3.8.1" + "@docusaurus/theme-translations" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + algoliasearch "^5.17.1" + algoliasearch-helper "^3.22.6" + clsx "^2.0.0" + eta "^2.2.0" + fs-extra "^11.1.1" + lodash "^4.17.21" + tslib "^2.6.0" + utility-types "^3.10.0" + +"@docusaurus/theme-translations@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-translations/-/theme-translations-3.8.1.tgz#4b1d76973eb53861e167c7723485e059ba4ffd0a" + integrity sha512-OTp6eebuMcf2rJt4bqnvuwmm3NVXfzfYejL+u/Y1qwKhZPrjPoKWfk1CbOP5xH5ZOPkiAsx4dHdQBRJszK3z2g== + dependencies: + fs-extra "^11.1.1" + tslib "^2.6.0" + +"@docusaurus/types@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.8.1.tgz#83ab66c345464e003b576a49f78897482061fc26" + integrity sha512-ZPdW5AB+pBjiVrcLuw3dOS6BFlrG0XkS2lDGsj8TizcnREQg3J8cjsgfDviszOk4CweNfwo1AEELJkYaMUuOPg== + dependencies: + "@mdx-js/mdx" "^3.0.0" + "@types/history" "^4.7.11" + "@types/react" "*" + commander "^5.1.0" + joi "^17.9.2" + react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" + utility-types "^3.10.0" + webpack "^5.95.0" + webpack-merge "^5.9.0" + +"@docusaurus/utils-common@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-3.8.1.tgz#c369b8c3041afb7dcd595d4172beb1cc1015c85f" + integrity sha512-zTZiDlvpvoJIrQEEd71c154DkcriBecm4z94OzEE9kz7ikS3J+iSlABhFXM45mZ0eN5pVqqr7cs60+ZlYLewtg== + dependencies: + "@docusaurus/types" "3.8.1" + tslib "^2.6.0" + +"@docusaurus/utils-validation@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-3.8.1.tgz#0499c0d151a4098a0963237057993282cfbd538e" + integrity sha512-gs5bXIccxzEbyVecvxg6upTwaUbfa0KMmTj7HhHzc016AGyxH2o73k1/aOD0IFrdCsfJNt37MqNI47s2MgRZMA== + dependencies: + "@docusaurus/logger" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + fs-extra "^11.2.0" + joi "^17.9.2" + js-yaml "^4.1.0" + lodash "^4.17.21" + tslib "^2.6.0" + +"@docusaurus/utils@3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.8.1.tgz#2ac1e734106e2f73dbd0f6a8824d525f9064e9f0" + integrity sha512-P1ml0nvOmEFdmu0smSXOqTS1sxU5tqvnc0dA4MTKV39kye+bhQnjkIKEE18fNOvxjyB86k8esoCIFM3x4RykOQ== + dependencies: + "@docusaurus/logger" "3.8.1" + "@docusaurus/types" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + escape-string-regexp "^4.0.0" + execa "5.1.1" + file-loader "^6.2.0" + fs-extra "^11.1.1" + github-slugger "^1.5.0" + globby "^11.1.0" + gray-matter "^4.0.3" + jiti "^1.20.0" + js-yaml "^4.1.0" + lodash "^4.17.21" + micromatch "^4.0.5" + p-queue "^6.6.2" + prompts "^2.4.2" + resolve-pathname "^3.0.0" + tslib "^2.6.0" + url-loader "^4.1.1" + utility-types "^3.10.0" + webpack "^5.88.1" + +"@emotion/babel-plugin@^11.13.5": + version "11.13.5" + resolved "https://registry.yarnpkg.com/@emotion/babel-plugin/-/babel-plugin-11.13.5.tgz#eab8d65dbded74e0ecfd28dc218e75607c4e7bc0" + integrity sha512-pxHCpT2ex+0q+HH91/zsdHkw/lXd468DIN2zvfvLtPKLLMo6gQj7oLObq8PhkrxOZb/gGCq03S3Z7PDhS8pduQ== + dependencies: + "@babel/helper-module-imports" "^7.16.7" + "@babel/runtime" "^7.18.3" + "@emotion/hash" "^0.9.2" + "@emotion/memoize" "^0.9.0" + "@emotion/serialize" "^1.3.3" + babel-plugin-macros "^3.1.0" + convert-source-map "^1.5.0" + escape-string-regexp "^4.0.0" + find-root "^1.1.0" + source-map "^0.5.7" + stylis "4.2.0" + +"@emotion/cache@^11.14.0": + version "11.14.0" + resolved "https://registry.yarnpkg.com/@emotion/cache/-/cache-11.14.0.tgz#ee44b26986eeb93c8be82bb92f1f7a9b21b2ed76" + integrity sha512-L/B1lc/TViYk4DcpGxtAVbx0ZyiKM5ktoIyafGkH6zg/tj+mA+NE//aPYKG0k8kCHSHVJrpLpcAlOBEXQ3SavA== + dependencies: + "@emotion/memoize" "^0.9.0" + "@emotion/sheet" "^1.4.0" + "@emotion/utils" "^1.4.2" + "@emotion/weak-memoize" "^0.4.0" + stylis "4.2.0" + +"@emotion/hash@^0.9.2": + version "0.9.2" + resolved "https://registry.yarnpkg.com/@emotion/hash/-/hash-0.9.2.tgz#ff9221b9f58b4dfe61e619a7788734bd63f6898b" + integrity sha512-MyqliTZGuOm3+5ZRSaaBGP3USLw6+EGykkwZns2EPC5g8jJ4z9OrdZY9apkl3+UP9+sdz76YYkwCKP5gh8iY3g== + +"@emotion/is-prop-valid@^1.3.0": + version "1.4.0" + resolved "https://registry.yarnpkg.com/@emotion/is-prop-valid/-/is-prop-valid-1.4.0.tgz#e9ad47adff0b5c94c72db3669ce46de33edf28c0" + integrity sha512-QgD4fyscGcbbKwJmqNvUMSE02OsHUa+lAWKdEUIJKgqe5IwRSKd7+KhibEWdaKwgjLj0DRSHA9biAIqGBk05lw== + dependencies: + "@emotion/memoize" "^0.9.0" + +"@emotion/memoize@^0.9.0": + version "0.9.0" + resolved "https://registry.yarnpkg.com/@emotion/memoize/-/memoize-0.9.0.tgz#745969d649977776b43fc7648c556aaa462b4102" + integrity sha512-30FAj7/EoJ5mwVPOWhAyCX+FPfMDrVecJAM+Iw9NRoSl4BBAQeqj4cApHHUXOVvIPgLVDsCFoz/hGD+5QQD1GQ== + +"@emotion/react@^11.14.0": + version "11.14.0" + resolved "https://registry.yarnpkg.com/@emotion/react/-/react-11.14.0.tgz#cfaae35ebc67dd9ef4ea2e9acc6cd29e157dd05d" + integrity sha512-O000MLDBDdk/EohJPFUqvnp4qnHeYkVP5B0xEG0D/L7cOKP9kefu2DXn8dj74cQfsEzUqh+sr1RzFqiL1o+PpA== + dependencies: + "@babel/runtime" "^7.18.3" + "@emotion/babel-plugin" "^11.13.5" + "@emotion/cache" "^11.14.0" + "@emotion/serialize" "^1.3.3" + "@emotion/use-insertion-effect-with-fallbacks" "^1.2.0" + "@emotion/utils" "^1.4.2" + "@emotion/weak-memoize" "^0.4.0" + hoist-non-react-statics "^3.3.1" + +"@emotion/serialize@^1.3.3": + version "1.3.3" + resolved "https://registry.yarnpkg.com/@emotion/serialize/-/serialize-1.3.3.tgz#d291531005f17d704d0463a032fe679f376509e8" + integrity sha512-EISGqt7sSNWHGI76hC7x1CksiXPahbxEOrC5RjmFRJTqLyEK9/9hZvBbiYn70dw4wuwMKiEMCUlR6ZXTSWQqxA== + dependencies: + "@emotion/hash" "^0.9.2" + "@emotion/memoize" "^0.9.0" + "@emotion/unitless" "^0.10.0" + "@emotion/utils" "^1.4.2" + csstype "^3.0.2" + +"@emotion/sheet@^1.4.0": + version "1.4.0" + resolved "https://registry.yarnpkg.com/@emotion/sheet/-/sheet-1.4.0.tgz#c9299c34d248bc26e82563735f78953d2efca83c" + integrity sha512-fTBW9/8r2w3dXWYM4HCB1Rdp8NLibOw2+XELH5m5+AkWiL/KqYX6dc0kKYlaYyKjrQ6ds33MCdMPEwgs2z1rqg== + +"@emotion/styled@^11.14.1": + version "11.14.1" + resolved "https://registry.yarnpkg.com/@emotion/styled/-/styled-11.14.1.tgz#8c34bed2948e83e1980370305614c20955aacd1c" + integrity sha512-qEEJt42DuToa3gurlH4Qqc1kVpNq8wO8cJtDzU46TjlzWjDlsVyevtYCRijVq3SrHsROS+gVQ8Fnea108GnKzw== + dependencies: + "@babel/runtime" "^7.18.3" + "@emotion/babel-plugin" "^11.13.5" + "@emotion/is-prop-valid" "^1.3.0" + "@emotion/serialize" "^1.3.3" + "@emotion/use-insertion-effect-with-fallbacks" "^1.2.0" + "@emotion/utils" "^1.4.2" + +"@emotion/unitless@^0.10.0": + version "0.10.0" + resolved "https://registry.yarnpkg.com/@emotion/unitless/-/unitless-0.10.0.tgz#2af2f7c7e5150f497bdabd848ce7b218a27cf745" + integrity sha512-dFoMUuQA20zvtVTuxZww6OHoJYgrzfKM1t52mVySDJnMSEa08ruEvdYQbhvyu6soU+NeLVd3yKfTfT0NeV6qGg== + +"@emotion/use-insertion-effect-with-fallbacks@^1.2.0": + version "1.2.0" + resolved "https://registry.yarnpkg.com/@emotion/use-insertion-effect-with-fallbacks/-/use-insertion-effect-with-fallbacks-1.2.0.tgz#8a8cb77b590e09affb960f4ff1e9a89e532738bf" + integrity sha512-yJMtVdH59sxi/aVJBpk9FQq+OR8ll5GT8oWd57UpeaKEVGab41JWaCFA7FRLoMLloOZF/c/wsPoe+bfGmRKgDg== + +"@emotion/utils@^1.4.2": + version "1.4.2" + resolved "https://registry.yarnpkg.com/@emotion/utils/-/utils-1.4.2.tgz#6df6c45881fcb1c412d6688a311a98b7f59c1b52" + integrity sha512-3vLclRofFziIa3J2wDh9jjbkUz9qk5Vi3IZ/FSTKViB0k+ef0fPV7dYrUIugbgupYDx7v9ud/SjrtEP8Y4xLoA== + +"@emotion/weak-memoize@^0.4.0": + version "0.4.0" + resolved "https://registry.yarnpkg.com/@emotion/weak-memoize/-/weak-memoize-0.4.0.tgz#5e13fac887f08c44f76b0ccaf3370eb00fec9bb6" + integrity sha512-snKqtPW01tN0ui7yu9rGv69aJXr/a/Ywvl11sUjNtEcRc+ng/mQriFL0wLXMef74iHa/EkftbDzU9F8iFbH+zg== + +"@hapi/hoek@^9.0.0", "@hapi/hoek@^9.3.0": + version "9.3.0" + resolved "https://registry.yarnpkg.com/@hapi/hoek/-/hoek-9.3.0.tgz#8368869dcb735be2e7f5cb7647de78e167a251fb" + integrity sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ== + +"@hapi/topo@^5.1.0": + version "5.1.0" + resolved "https://registry.yarnpkg.com/@hapi/topo/-/topo-5.1.0.tgz#dc448e332c6c6e37a4dc02fd84ba8d44b9afb012" + integrity sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg== + dependencies: + "@hapi/hoek" "^9.0.0" + +"@iconify/react@^6.0.0": + version "6.0.2" + resolved "https://registry.yarnpkg.com/@iconify/react/-/react-6.0.2.tgz#b6d9bd0e13f9cb85b3a7fddbc70bbf71f5da1d33" + integrity sha512-SMmC2sactfpJD427WJEDN6PMyznTFMhByK9yLW0gOTtnjzzbsi/Ke/XqsumsavFPwNiXs8jSiYeZTmLCLwO+Fg== + dependencies: + "@iconify/types" "^2.0.0" + +"@iconify/types@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@iconify/types/-/types-2.0.0.tgz#ab0e9ea681d6c8a1214f30cd741fe3a20cc57f57" + integrity sha512-+wluvCrRhXrhyOmRDJ3q8mux9JkKy5SJ/v8ol2tu4FVjyYvtEzkc/3pK15ET6RKg4b4w4BmTk1+gsCUhf21Ykg== + +"@jest/schemas@^29.6.3": + version "29.6.3" + resolved "https://registry.yarnpkg.com/@jest/schemas/-/schemas-29.6.3.tgz#430b5ce8a4e0044a7e3819663305a7b3091c8e03" + integrity sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA== + dependencies: + "@sinclair/typebox" "^0.27.8" + +"@jest/types@^29.6.3": + version "29.6.3" + resolved "https://registry.yarnpkg.com/@jest/types/-/types-29.6.3.tgz#1131f8cf634e7e84c5e77bab12f052af585fba59" + integrity sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw== + dependencies: + "@jest/schemas" "^29.6.3" + "@types/istanbul-lib-coverage" "^2.0.0" + "@types/istanbul-reports" "^3.0.0" + "@types/node" "*" + "@types/yargs" "^17.0.8" + chalk "^4.0.0" + +"@jridgewell/gen-mapping@^0.3.12", "@jridgewell/gen-mapping@^0.3.5": + version "0.3.13" + resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz#6342a19f44347518c93e43b1ac69deb3c4656a1f" + integrity sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA== + dependencies: + "@jridgewell/sourcemap-codec" "^1.5.0" + "@jridgewell/trace-mapping" "^0.3.24" + +"@jridgewell/remapping@^2.3.5": + version "2.3.5" + resolved "https://registry.yarnpkg.com/@jridgewell/remapping/-/remapping-2.3.5.tgz#375c476d1972947851ba1e15ae8f123047445aa1" + integrity sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ== + dependencies: + "@jridgewell/gen-mapping" "^0.3.5" + "@jridgewell/trace-mapping" "^0.3.24" + +"@jridgewell/resolve-uri@^3.1.0": + version "3.1.2" + resolved "https://registry.yarnpkg.com/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz#7a0ee601f60f99a20c7c7c5ff0c80388c1189bd6" + integrity sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw== + +"@jridgewell/source-map@^0.3.3": + version "0.3.11" + resolved "https://registry.yarnpkg.com/@jridgewell/source-map/-/source-map-0.3.11.tgz#b21835cbd36db656b857c2ad02ebd413cc13a9ba" + integrity sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA== + dependencies: + "@jridgewell/gen-mapping" "^0.3.5" + "@jridgewell/trace-mapping" "^0.3.25" + +"@jridgewell/sourcemap-codec@^1.4.14", "@jridgewell/sourcemap-codec@^1.5.0": + version "1.5.5" + resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz#6912b00d2c631c0d15ce1a7ab57cd657f2a8f8ba" + integrity sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og== + +"@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.25", "@jridgewell/trace-mapping@^0.3.28": + version "0.3.31" + resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz#db15d6781c931f3a251a3dac39501c98a6082fd0" + integrity sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw== + dependencies: + "@jridgewell/resolve-uri" "^3.1.0" + "@jridgewell/sourcemap-codec" "^1.4.14" + +"@leichtgewicht/ip-codec@^2.0.1": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz#4fc56c15c580b9adb7dc3c333a134e540b44bfb1" + integrity sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw== + +"@mdx-js/mdx@^3.0.0": + version "3.1.1" + resolved "https://registry.yarnpkg.com/@mdx-js/mdx/-/mdx-3.1.1.tgz#c5ffd991a7536b149e17175eee57a1a2a511c6d1" + integrity sha512-f6ZO2ifpwAQIpzGWaBQT2TXxPv6z3RBzQKpVftEWN78Vl/YweF1uwussDx8ECAXVtr3Rs89fKyG9YlzUs9DyGQ== + dependencies: + "@types/estree" "^1.0.0" + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdx" "^2.0.0" + acorn "^8.0.0" + collapse-white-space "^2.0.0" + devlop "^1.0.0" + estree-util-is-identifier-name "^3.0.0" + estree-util-scope "^1.0.0" + estree-walker "^3.0.0" + hast-util-to-jsx-runtime "^2.0.0" + markdown-extensions "^2.0.0" + recma-build-jsx "^1.0.0" + recma-jsx "^1.0.0" + recma-stringify "^1.0.0" + rehype-recma "^1.0.0" + remark-mdx "^3.0.0" + remark-parse "^11.0.0" + remark-rehype "^11.0.0" + source-map "^0.7.0" + unified "^11.0.0" + unist-util-position-from-estree "^2.0.0" + unist-util-stringify-position "^4.0.0" + unist-util-visit "^5.0.0" + vfile "^6.0.0" + +"@mdx-js/react@^3.0.0": + version "3.1.1" + resolved "https://registry.yarnpkg.com/@mdx-js/react/-/react-3.1.1.tgz#24bda7fffceb2fe256f954482123cda1be5f5fef" + integrity sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw== + dependencies: + "@types/mdx" "^2.0.0" + +"@mui/core-downloads-tracker@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/core-downloads-tracker/-/core-downloads-tracker-7.3.2.tgz#896a7890864d619093dc79541ec1ecfa3b507ad2" + integrity sha512-AOyfHjyDKVPGJJFtxOlept3EYEdLoar/RvssBTWVAvDJGIE676dLi2oT/Kx+FoVXFoA/JdV7DEMq/BVWV3KHRw== + +"@mui/icons-material@^7.3.1": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/icons-material/-/icons-material-7.3.2.tgz#050049cd6195b815e85888aaebd436e8e95084b8" + integrity sha512-TZWazBjWXBjR6iGcNkbKklnwodcwj0SrChCNHc9BhD9rBgET22J1eFhHsEmvSvru9+opDy3umqAimQjokhfJlQ== + dependencies: + "@babel/runtime" "^7.28.3" + +"@mui/material@^7.3.1": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/material/-/material-7.3.2.tgz#21ad66bba695e2cd36e4a93e2e4ff5e04d8636a1" + integrity sha512-qXvbnawQhqUVfH1LMgMaiytP+ZpGoYhnGl7yYq2x57GYzcFL/iPzSZ3L30tlbwEjSVKNYcbiKO8tANR1tadjUg== + dependencies: + "@babel/runtime" "^7.28.3" + "@mui/core-downloads-tracker" "^7.3.2" + "@mui/system" "^7.3.2" + "@mui/types" "^7.4.6" + "@mui/utils" "^7.3.2" + "@popperjs/core" "^2.11.8" + "@types/react-transition-group" "^4.4.12" + clsx "^2.1.1" + csstype "^3.1.3" + prop-types "^15.8.1" + react-is "^19.1.1" + react-transition-group "^4.4.5" + +"@mui/private-theming@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/private-theming/-/private-theming-7.3.2.tgz#9b883ac9ec9288327de038da6ddf8ffa179be831" + integrity sha512-ha7mFoOyZGJr75xeiO9lugS3joRROjc8tG1u4P50dH0KR7bwhHznVMcYg7MouochUy0OxooJm/OOSpJ7gKcMvg== + dependencies: + "@babel/runtime" "^7.28.3" + "@mui/utils" "^7.3.2" + prop-types "^15.8.1" + +"@mui/styled-engine@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/styled-engine/-/styled-engine-7.3.2.tgz#cac6acb9480d6eaf60d9c99a7d24503e53236b32" + integrity sha512-PkJzW+mTaek4e0nPYZ6qLnW5RGa0KN+eRTf5FA2nc7cFZTeM+qebmGibaTLrgQBy3UpcpemaqfzToBNkzuxqew== + dependencies: + "@babel/runtime" "^7.28.3" + "@emotion/cache" "^11.14.0" + "@emotion/serialize" "^1.3.3" + "@emotion/sheet" "^1.4.0" + csstype "^3.1.3" + prop-types "^15.8.1" + +"@mui/system@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/system/-/system-7.3.2.tgz#e838097fc6cb0a2e4c1822478950db89affb116a" + integrity sha512-9d8JEvZW+H6cVkaZ+FK56R53vkJe3HsTpcjMUtH8v1xK6Y1TjzHdZ7Jck02mGXJsE6MQGWVs3ogRHTQmS9Q/rA== + dependencies: + "@babel/runtime" "^7.28.3" + "@mui/private-theming" "^7.3.2" + "@mui/styled-engine" "^7.3.2" + "@mui/types" "^7.4.6" + "@mui/utils" "^7.3.2" + clsx "^2.1.1" + csstype "^3.1.3" + prop-types "^15.8.1" + +"@mui/types@^7.4.6": + version "7.4.6" + resolved "https://registry.yarnpkg.com/@mui/types/-/types-7.4.6.tgz#1432e0814cf155287283f6bbd1e95976a148ef07" + integrity sha512-NVBbIw+4CDMMppNamVxyTccNv0WxtDb7motWDlMeSC8Oy95saj1TIZMGynPpFLePt3yOD8TskzumeqORCgRGWw== + dependencies: + "@babel/runtime" "^7.28.3" + +"@mui/utils@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@mui/utils/-/utils-7.3.2.tgz#361775d72c557a03115150e8aec4329c7ef14563" + integrity sha512-4DMWQGenOdLnM3y/SdFQFwKsCLM+mqxzvoWp9+x2XdEzXapkznauHLiXtSohHs/mc0+5/9UACt1GdugCX2te5g== + dependencies: + "@babel/runtime" "^7.28.3" + "@mui/types" "^7.4.6" + "@types/prop-types" "^15.7.15" + clsx "^2.1.1" + prop-types "^15.8.1" + react-is "^19.1.1" + +"@nodelib/fs.scandir@2.1.5": + version "2.1.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" + integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== + dependencies: + "@nodelib/fs.stat" "2.0.5" + run-parallel "^1.1.9" + +"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" + integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== + +"@nodelib/fs.walk@^1.2.3": + version "1.2.8" + resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" + integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== + dependencies: + "@nodelib/fs.scandir" "2.1.5" + fastq "^1.6.0" + +"@pnpm/config.env-replace@^1.1.0": + version "1.1.0" + resolved "https://registry.yarnpkg.com/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz#ab29da53df41e8948a00f2433f085f54de8b3a4c" + integrity sha512-htyl8TWnKL7K/ESFa1oW2UB5lVDxuF5DpM7tBi6Hu2LNL3mWkIzNLG6N4zoCUP1lCKNxWy/3iu8mS8MvToGd6w== + +"@pnpm/network.ca-file@^1.0.1": + version "1.0.2" + resolved "https://registry.yarnpkg.com/@pnpm/network.ca-file/-/network.ca-file-1.0.2.tgz#2ab05e09c1af0cdf2fcf5035bea1484e222f7983" + integrity sha512-YcPQ8a0jwYU9bTdJDpXjMi7Brhkr1mXsXrUJvjqM2mQDgkRiz8jFaQGOdaLxgjtUfQgZhKy/O3cG/YwmgKaxLA== + dependencies: + graceful-fs "4.2.10" + +"@pnpm/npm-conf@^2.1.0": + version "2.3.1" + resolved "https://registry.yarnpkg.com/@pnpm/npm-conf/-/npm-conf-2.3.1.tgz#bb375a571a0bd63ab0a23bece33033c683e9b6b0" + integrity sha512-c83qWb22rNRuB0UaVCI0uRPNRr8Z0FWnEIvT47jiHAmOIUHbBOg5XvV7pM5x+rKn9HRpjxquDbXYSXr3fAKFcw== + dependencies: + "@pnpm/config.env-replace" "^1.1.0" + "@pnpm/network.ca-file" "^1.0.1" + config-chain "^1.1.11" + +"@polka/url@^1.0.0-next.24": + version "1.0.0-next.29" + resolved "https://registry.yarnpkg.com/@polka/url/-/url-1.0.0-next.29.tgz#5a40109a1ab5f84d6fd8fc928b19f367cbe7e7b1" + integrity sha512-wwQAWhWSuHaag8c4q/KN/vCoeOJYshAIvMQwD4GpSb3OiZklFfvAgmj0VCBBImRpuF/aFgIRzllXlVX93Jevww== + +"@popperjs/core@^2.11.8": + version "2.11.8" + resolved "https://registry.yarnpkg.com/@popperjs/core/-/core-2.11.8.tgz#6b79032e760a0899cd4204710beede972a3a185f" + integrity sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A== + +"@sideway/address@^4.1.5": + version "4.1.5" + resolved "https://registry.yarnpkg.com/@sideway/address/-/address-4.1.5.tgz#4bc149a0076623ced99ca8208ba780d65a99b9d5" + integrity sha512-IqO/DUQHUkPeixNQ8n0JA6102hT9CmaljNTPmQ1u8MEhBo/R4Q8eKLN/vGZxuebwOroDB4cbpjheD4+/sKFK4Q== + dependencies: + "@hapi/hoek" "^9.0.0" + +"@sideway/formula@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@sideway/formula/-/formula-3.0.1.tgz#80fcbcbaf7ce031e0ef2dd29b1bfc7c3f583611f" + integrity sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg== + +"@sideway/pinpoint@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@sideway/pinpoint/-/pinpoint-2.0.0.tgz#cff8ffadc372ad29fd3f78277aeb29e632cc70df" + integrity sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ== + +"@sinclair/typebox@^0.27.8": + version "0.27.8" + resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.8.tgz#6667fac16c436b5434a387a34dedb013198f6e6e" + integrity sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA== + +"@sindresorhus/is@^4.6.0": + version "4.6.0" + resolved "https://registry.yarnpkg.com/@sindresorhus/is/-/is-4.6.0.tgz#3c7c9c46e678feefe7a2e5bb609d3dbd665ffb3f" + integrity sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw== + +"@sindresorhus/is@^5.2.0": + version "5.6.0" + resolved "https://registry.yarnpkg.com/@sindresorhus/is/-/is-5.6.0.tgz#41dd6093d34652cddb5d5bdeee04eafc33826668" + integrity sha512-TV7t8GKYaJWsn00tFDqBw8+Uqmr8A0fRU1tvTQhyZzGv0sJCGRQL3JGMI3ucuKo3XIZdUP+Lx7/gh2t3lewy7g== + +"@slorber/remark-comment@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@slorber/remark-comment/-/remark-comment-1.0.0.tgz#2a020b3f4579c89dec0361673206c28d67e08f5a" + integrity sha512-RCE24n7jsOj1M0UPvIQCHTe7fI0sFL4S2nwKVWwHyVr/wI/H8GosgsJGyhnsZoGFnD/P2hLf1mSbrrgSLN93NA== + dependencies: + micromark-factory-space "^1.0.0" + micromark-util-character "^1.1.0" + micromark-util-symbol "^1.0.1" + +"@svgr/babel-plugin-add-jsx-attribute@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-add-jsx-attribute/-/babel-plugin-add-jsx-attribute-8.0.0.tgz#4001f5d5dd87fa13303e36ee106e3ff3a7eb8b22" + integrity sha512-b9MIk7yhdS1pMCZM8VeNfUlSKVRhsHZNMl5O9SfaX0l0t5wjdgu4IDzGB8bpnGBBOjGST3rRFVsaaEtI4W6f7g== + +"@svgr/babel-plugin-remove-jsx-attribute@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-remove-jsx-attribute/-/babel-plugin-remove-jsx-attribute-8.0.0.tgz#69177f7937233caca3a1afb051906698f2f59186" + integrity sha512-BcCkm/STipKvbCl6b7QFrMh/vx00vIP63k2eM66MfHJzPr6O2U0jYEViXkHJWqXqQYjdeA9cuCl5KWmlwjDvbA== + +"@svgr/babel-plugin-remove-jsx-empty-expression@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-remove-jsx-empty-expression/-/babel-plugin-remove-jsx-empty-expression-8.0.0.tgz#c2c48104cfd7dcd557f373b70a56e9e3bdae1d44" + integrity sha512-5BcGCBfBxB5+XSDSWnhTThfI9jcO5f0Ai2V24gZpG+wXF14BzwxxdDb4g6trdOux0rhibGs385BeFMSmxtS3uA== + +"@svgr/babel-plugin-replace-jsx-attribute-value@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-replace-jsx-attribute-value/-/babel-plugin-replace-jsx-attribute-value-8.0.0.tgz#8fbb6b2e91fa26ac5d4aa25c6b6e4f20f9c0ae27" + integrity sha512-KVQ+PtIjb1BuYT3ht8M5KbzWBhdAjjUPdlMtpuw/VjT8coTrItWX6Qafl9+ji831JaJcu6PJNKCV0bp01lBNzQ== + +"@svgr/babel-plugin-svg-dynamic-title@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-svg-dynamic-title/-/babel-plugin-svg-dynamic-title-8.0.0.tgz#1d5ba1d281363fc0f2f29a60d6d936f9bbc657b0" + integrity sha512-omNiKqwjNmOQJ2v6ge4SErBbkooV2aAWwaPFs2vUY7p7GhVkzRkJ00kILXQvRhA6miHnNpXv7MRnnSjdRjK8og== + +"@svgr/babel-plugin-svg-em-dimensions@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-svg-em-dimensions/-/babel-plugin-svg-em-dimensions-8.0.0.tgz#35e08df300ea8b1d41cb8f62309c241b0369e501" + integrity sha512-mURHYnu6Iw3UBTbhGwE/vsngtCIbHE43xCRK7kCw4t01xyGqb2Pd+WXekRRoFOBIY29ZoOhUCTEweDMdrjfi9g== + +"@svgr/babel-plugin-transform-react-native-svg@8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-transform-react-native-svg/-/babel-plugin-transform-react-native-svg-8.1.0.tgz#90a8b63998b688b284f255c6a5248abd5b28d754" + integrity sha512-Tx8T58CHo+7nwJ+EhUwx3LfdNSG9R2OKfaIXXs5soiy5HtgoAEkDay9LIimLOcG8dJQH1wPZp/cnAv6S9CrR1Q== + +"@svgr/babel-plugin-transform-svg-component@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-transform-svg-component/-/babel-plugin-transform-svg-component-8.0.0.tgz#013b4bfca88779711f0ed2739f3f7efcefcf4f7e" + integrity sha512-DFx8xa3cZXTdb/k3kfPeaixecQLgKh5NVBMwD0AQxOzcZawK4oo1Jh9LbrcACUivsCA7TLG8eeWgrDXjTMhRmw== + +"@svgr/babel-preset@8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/babel-preset/-/babel-preset-8.1.0.tgz#0e87119aecdf1c424840b9d4565b7137cabf9ece" + integrity sha512-7EYDbHE7MxHpv4sxvnVPngw5fuR6pw79SkcrILHJ/iMpuKySNCl5W1qcwPEpU+LgyRXOaAFgH0KhwD18wwg6ug== + dependencies: + "@svgr/babel-plugin-add-jsx-attribute" "8.0.0" + "@svgr/babel-plugin-remove-jsx-attribute" "8.0.0" + "@svgr/babel-plugin-remove-jsx-empty-expression" "8.0.0" + "@svgr/babel-plugin-replace-jsx-attribute-value" "8.0.0" + "@svgr/babel-plugin-svg-dynamic-title" "8.0.0" + "@svgr/babel-plugin-svg-em-dimensions" "8.0.0" + "@svgr/babel-plugin-transform-react-native-svg" "8.1.0" + "@svgr/babel-plugin-transform-svg-component" "8.0.0" + +"@svgr/core@8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/core/-/core-8.1.0.tgz#41146f9b40b1a10beaf5cc4f361a16a3c1885e88" + integrity sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA== + dependencies: + "@babel/core" "^7.21.3" + "@svgr/babel-preset" "8.1.0" + camelcase "^6.2.0" + cosmiconfig "^8.1.3" + snake-case "^3.0.4" + +"@svgr/hast-util-to-babel-ast@8.0.0": + version "8.0.0" + resolved "https://registry.yarnpkg.com/@svgr/hast-util-to-babel-ast/-/hast-util-to-babel-ast-8.0.0.tgz#6952fd9ce0f470e1aded293b792a2705faf4ffd4" + integrity sha512-EbDKwO9GpfWP4jN9sGdYwPBU0kdomaPIL2Eu4YwmgP+sJeXT+L7bMwJUBnhzfH8Q2qMBqZ4fJwpCyYsAN3mt2Q== + dependencies: + "@babel/types" "^7.21.3" + entities "^4.4.0" + +"@svgr/plugin-jsx@8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/plugin-jsx/-/plugin-jsx-8.1.0.tgz#96969f04a24b58b174ee4cd974c60475acbd6928" + integrity sha512-0xiIyBsLlr8quN+WyuxooNW9RJ0Dpr8uOnH/xrCVO8GLUcwHISwj1AG0k+LFzteTkAA0GbX0kj9q6Dk70PTiPA== + dependencies: + "@babel/core" "^7.21.3" + "@svgr/babel-preset" "8.1.0" + "@svgr/hast-util-to-babel-ast" "8.0.0" + svg-parser "^2.0.4" + +"@svgr/plugin-svgo@8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/plugin-svgo/-/plugin-svgo-8.1.0.tgz#b115b7b967b564f89ac58feae89b88c3decd0f00" + integrity sha512-Ywtl837OGO9pTLIN/onoWLmDQ4zFUycI1g76vuKGEz6evR/ZTJlJuz3G/fIkb6OVBJ2g0o6CGJzaEjfmEo3AHA== + dependencies: + cosmiconfig "^8.1.3" + deepmerge "^4.3.1" + svgo "^3.0.2" + +"@svgr/webpack@^8.1.0": + version "8.1.0" + resolved "https://registry.yarnpkg.com/@svgr/webpack/-/webpack-8.1.0.tgz#16f1b5346f102f89fda6ec7338b96a701d8be0c2" + integrity sha512-LnhVjMWyMQV9ZmeEy26maJk+8HTIbd59cH4F2MJ439k9DqejRisfFNGAPvRYlKETuh9LrImlS8aKsBgKjMA8WA== + dependencies: + "@babel/core" "^7.21.3" + "@babel/plugin-transform-react-constant-elements" "^7.21.3" + "@babel/preset-env" "^7.20.2" + "@babel/preset-react" "^7.18.6" + "@babel/preset-typescript" "^7.21.0" + "@svgr/core" "8.1.0" + "@svgr/plugin-jsx" "8.1.0" + "@svgr/plugin-svgo" "8.1.0" + +"@szmarczak/http-timer@^5.0.1": + version "5.0.1" + resolved "https://registry.yarnpkg.com/@szmarczak/http-timer/-/http-timer-5.0.1.tgz#c7c1bf1141cdd4751b0399c8fc7b8b664cd5be3a" + integrity sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw== + dependencies: + defer-to-connect "^2.0.1" + +"@trysound/sax@0.2.0": + version "0.2.0" + resolved "https://registry.yarnpkg.com/@trysound/sax/-/sax-0.2.0.tgz#cccaab758af56761eb7bf37af6f03f326dd798ad" + integrity sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA== + +"@types/body-parser@*": + version "1.19.6" + resolved "https://registry.yarnpkg.com/@types/body-parser/-/body-parser-1.19.6.tgz#1859bebb8fd7dac9918a45d54c1971ab8b5af474" + integrity sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g== + dependencies: + "@types/connect" "*" + "@types/node" "*" + +"@types/bonjour@^3.5.9": + version "3.5.13" + resolved "https://registry.yarnpkg.com/@types/bonjour/-/bonjour-3.5.13.tgz#adf90ce1a105e81dd1f9c61fdc5afda1bfb92956" + integrity sha512-z9fJ5Im06zvUL548KvYNecEVlA7cVDkGUi6kZusb04mpyEFKCIZJvloCcmpmLaIahDpOQGHaHmG6imtPMmPXGQ== + dependencies: + "@types/node" "*" + +"@types/connect-history-api-fallback@^1.3.5": + version "1.5.4" + resolved "https://registry.yarnpkg.com/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.4.tgz#7de71645a103056b48ac3ce07b3520b819c1d5b3" + integrity sha512-n6Cr2xS1h4uAulPRdlw6Jl6s1oG8KrVilPN2yUITEs+K48EzMJJ3W1xy8K5eWuFvjp3R74AOIGSmp2UfBJ8HFw== + dependencies: + "@types/express-serve-static-core" "*" + "@types/node" "*" + +"@types/connect@*": + version "3.4.38" + resolved "https://registry.yarnpkg.com/@types/connect/-/connect-3.4.38.tgz#5ba7f3bc4fbbdeaff8dded952e5ff2cc53f8d858" + integrity sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug== + dependencies: + "@types/node" "*" + +"@types/debug@^4.0.0": + version "4.1.12" + resolved "https://registry.yarnpkg.com/@types/debug/-/debug-4.1.12.tgz#a155f21690871953410df4b6b6f53187f0500917" + integrity sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ== + dependencies: + "@types/ms" "*" + +"@types/eslint-scope@^3.7.7": + version "3.7.7" + resolved "https://registry.yarnpkg.com/@types/eslint-scope/-/eslint-scope-3.7.7.tgz#3108bd5f18b0cdb277c867b3dd449c9ed7079ac5" + integrity sha512-MzMFlSLBqNF2gcHWO0G1vP/YQyfvrxZ0bF+u7mzUdZ1/xK4A4sru+nraZz5i3iEIk1l1uyicaDVTB4QbbEkAYg== + dependencies: + "@types/eslint" "*" + "@types/estree" "*" + +"@types/eslint@*": + version "9.6.1" + resolved "https://registry.yarnpkg.com/@types/eslint/-/eslint-9.6.1.tgz#d5795ad732ce81715f27f75da913004a56751584" + integrity sha512-FXx2pKgId/WyYo2jXw63kk7/+TY7u7AziEJxJAnSFzHlqTAS3Ync6SvgYAN/k4/PQpnnVuzoMuVnByKK2qp0ag== + dependencies: + "@types/estree" "*" + "@types/json-schema" "*" + +"@types/estree-jsx@^1.0.0": + version "1.0.5" + resolved "https://registry.yarnpkg.com/@types/estree-jsx/-/estree-jsx-1.0.5.tgz#858a88ea20f34fe65111f005a689fa1ebf70dc18" + integrity sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg== + dependencies: + "@types/estree" "*" + +"@types/estree@*", "@types/estree@^1.0.0", "@types/estree@^1.0.8": + version "1.0.8" + resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.8.tgz#958b91c991b1867ced318bedea0e215ee050726e" + integrity sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w== + +"@types/express-serve-static-core@*", "@types/express-serve-static-core@^5.0.0": + version "5.0.7" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-5.0.7.tgz#2fa94879c9d46b11a5df4c74ac75befd6b283de6" + integrity sha512-R+33OsgWw7rOhD1emjU7dzCDHucJrgJXMA5PYCzJxVil0dsyx5iBEPHqpPfiKNJQb7lZ1vxwoLR4Z87bBUpeGQ== + dependencies: + "@types/node" "*" + "@types/qs" "*" + "@types/range-parser" "*" + "@types/send" "*" + +"@types/express-serve-static-core@^4.17.33": + version "4.19.6" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.19.6.tgz#e01324c2a024ff367d92c66f48553ced0ab50267" + integrity sha512-N4LZ2xG7DatVqhCZzOGb1Yi5lMbXSZcmdLDe9EzSndPV2HpWYWzRbaerl2n27irrm94EPpprqa8KpskPT085+A== + dependencies: + "@types/node" "*" + "@types/qs" "*" + "@types/range-parser" "*" + "@types/send" "*" + +"@types/express@*": + version "5.0.3" + resolved "https://registry.yarnpkg.com/@types/express/-/express-5.0.3.tgz#6c4bc6acddc2e2a587142e1d8be0bce20757e956" + integrity sha512-wGA0NX93b19/dZC1J18tKWVIYWyyF2ZjT9vin/NRu0qzzvfVzWjs04iq2rQ3H65vCTQYlRqs3YHfY7zjdV+9Kw== + dependencies: + "@types/body-parser" "*" + "@types/express-serve-static-core" "^5.0.0" + "@types/serve-static" "*" + +"@types/express@^4.17.13": + version "4.17.23" + resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.23.tgz#35af3193c640bfd4d7fe77191cd0ed411a433bef" + integrity sha512-Crp6WY9aTYP3qPi2wGDo9iUe/rceX01UMhnF1jmwDcKCFM6cx7YhGP/Mpr3y9AASpfHixIG0E6azCcL5OcDHsQ== + dependencies: + "@types/body-parser" "*" + "@types/express-serve-static-core" "^4.17.33" + "@types/qs" "*" + "@types/serve-static" "*" + +"@types/gtag.js@^0.0.12": + version "0.0.12" + resolved "https://registry.yarnpkg.com/@types/gtag.js/-/gtag.js-0.0.12.tgz#095122edca896689bdfcdd73b057e23064d23572" + integrity sha512-YQV9bUsemkzG81Ea295/nF/5GijnD2Af7QhEofh7xu+kvCN6RdodgNwwGWXB5GMI3NoyvQo0odNctoH/qLMIpg== + +"@types/hast@^3.0.0": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@types/hast/-/hast-3.0.4.tgz#1d6b39993b82cea6ad783945b0508c25903e15aa" + integrity sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ== + dependencies: + "@types/unist" "*" + +"@types/history@^4.7.11": + version "4.7.11" + resolved "https://registry.yarnpkg.com/@types/history/-/history-4.7.11.tgz#56588b17ae8f50c53983a524fc3cc47437969d64" + integrity sha512-qjDJRrmvBMiTx+jyLxvLfJU7UznFuokDv4f3WRuriHKERccVpFU+8XMQUAbDzoiJCsmexxRExQeMwwCdamSKDA== + +"@types/html-minifier-terser@^6.0.0": + version "6.1.0" + resolved "https://registry.yarnpkg.com/@types/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz#4fc33a00c1d0c16987b1a20cf92d20614c55ac35" + integrity sha512-oh/6byDPnL1zeNXFrDXFLyZjkr1MsBG667IM792caf1L2UPOOMf65NFzjUH/ltyfwjAGfs1rsX1eftK0jC/KIg== + +"@types/http-cache-semantics@^4.0.2": + version "4.0.4" + resolved "https://registry.yarnpkg.com/@types/http-cache-semantics/-/http-cache-semantics-4.0.4.tgz#b979ebad3919799c979b17c72621c0bc0a31c6c4" + integrity sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA== + +"@types/http-errors@*": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.5.tgz#5b749ab2b16ba113423feb1a64a95dcd30398472" + integrity sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg== + +"@types/http-proxy@^1.17.8": + version "1.17.16" + resolved "https://registry.yarnpkg.com/@types/http-proxy/-/http-proxy-1.17.16.tgz#dee360707b35b3cc85afcde89ffeebff7d7f9240" + integrity sha512-sdWoUajOB1cd0A8cRRQ1cfyWNbmFKLAqBB89Y8x5iYyG/mkJHc0YUH8pdWBy2omi9qtCpiIgGjuwO0dQST2l5w== + dependencies: + "@types/node" "*" + +"@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0": + version "2.0.6" + resolved "https://registry.yarnpkg.com/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz#7739c232a1fee9b4d3ce8985f314c0c6d33549d7" + integrity sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w== + +"@types/istanbul-lib-report@*": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz#53047614ae72e19fc0401d872de3ae2b4ce350bf" + integrity sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA== + dependencies: + "@types/istanbul-lib-coverage" "*" + +"@types/istanbul-reports@^3.0.0": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz#0f03e3d2f670fbdac586e34b433783070cc16f54" + integrity sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ== + dependencies: + "@types/istanbul-lib-report" "*" + +"@types/json-schema@*", "@types/json-schema@^7.0.15", "@types/json-schema@^7.0.8", "@types/json-schema@^7.0.9": + version "7.0.15" + resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.15.tgz#596a1747233694d50f6ad8a7869fcb6f56cf5841" + integrity sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA== + +"@types/mdast@^4.0.0", "@types/mdast@^4.0.2": + version "4.0.4" + resolved "https://registry.yarnpkg.com/@types/mdast/-/mdast-4.0.4.tgz#7ccf72edd2f1aa7dd3437e180c64373585804dd6" + integrity sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA== + dependencies: + "@types/unist" "*" + +"@types/mdx@^2.0.0": + version "2.0.13" + resolved "https://registry.yarnpkg.com/@types/mdx/-/mdx-2.0.13.tgz#68f6877043d377092890ff5b298152b0a21671bd" + integrity sha512-+OWZQfAYyio6YkJb3HLxDrvnx6SWWDbC0zVPfBRzUk0/nqoDyf6dNxQi3eArPe8rJ473nobTMQ/8Zk+LxJ+Yuw== + +"@types/mime@^1": + version "1.3.5" + resolved "https://registry.yarnpkg.com/@types/mime/-/mime-1.3.5.tgz#1ef302e01cf7d2b5a0fa526790c9123bf1d06690" + integrity sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w== + +"@types/ms@*": + version "2.1.0" + resolved "https://registry.yarnpkg.com/@types/ms/-/ms-2.1.0.tgz#052aa67a48eccc4309d7f0191b7e41434b90bb78" + integrity sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA== + +"@types/node-forge@^1.3.0": + version "1.3.14" + resolved "https://registry.yarnpkg.com/@types/node-forge/-/node-forge-1.3.14.tgz#006c2616ccd65550560c2757d8472eb6d3ecea0b" + integrity sha512-mhVF2BnD4BO+jtOp7z1CdzaK4mbuK0LLQYAvdOLqHTavxFNq4zA1EmYkpnFjP8HOUzedfQkRnp0E2ulSAYSzAw== + dependencies: + "@types/node" "*" + +"@types/node@*": + version "24.5.0" + resolved "https://registry.yarnpkg.com/@types/node/-/node-24.5.0.tgz#70a482e6b1d50e603729d74e62a9a43705ddc9d7" + integrity sha512-y1dMvuvJspJiPSDZUQ+WMBvF7dpnEqN4x9DDC9ie5Fs/HUZJA3wFp7EhHoVaKX/iI0cRoECV8X2jL8zi0xrHCg== + dependencies: + undici-types "~7.12.0" + +"@types/node@^17.0.5": + version "17.0.45" + resolved "https://registry.yarnpkg.com/@types/node/-/node-17.0.45.tgz#2c0fafd78705e7a18b7906b5201a522719dc5190" + integrity sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw== + +"@types/parse-json@^4.0.0": + version "4.0.2" + resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.2.tgz#5950e50960793055845e956c427fc2b0d70c5239" + integrity sha512-dISoDXWWQwUquiKsyZ4Ng+HX2KsPL7LyHKHQwgGFEA3IaKac4Obd+h2a/a6waisAoepJlBcx9paWqjA8/HVjCw== + +"@types/prismjs@^1.26.0": + version "1.26.5" + resolved "https://registry.yarnpkg.com/@types/prismjs/-/prismjs-1.26.5.tgz#72499abbb4c4ec9982446509d2f14fb8483869d6" + integrity sha512-AUZTa7hQ2KY5L7AmtSiqxlhWxb4ina0yd8hNbl4TWuqnv/pFP0nDMb3YrfSBf4hJVGLh2YEIBfKaBW/9UEl6IQ== + +"@types/prop-types@^15.7.15": + version "15.7.15" + resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.15.tgz#e6e5a86d602beaca71ce5163fadf5f95d70931c7" + integrity sha512-F6bEyamV9jKGAFBEmlQnesRPGOQqS2+Uwi0Em15xenOxHaf2hv6L8YCVn3rPdPJOiJfPiCnLIRyvwVaqMY3MIw== + +"@types/qs@*": + version "6.14.0" + resolved "https://registry.yarnpkg.com/@types/qs/-/qs-6.14.0.tgz#d8b60cecf62f2db0fb68e5e006077b9178b85de5" + integrity sha512-eOunJqu0K1923aExK6y8p6fsihYEn/BYuQ4g0CxAAgFc4b/ZLN4CrsRZ55srTdqoiLzU2B2evC+apEIxprEzkQ== + +"@types/range-parser@*": + version "1.2.7" + resolved "https://registry.yarnpkg.com/@types/range-parser/-/range-parser-1.2.7.tgz#50ae4353eaaddc04044279812f52c8c65857dbcb" + integrity sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ== + +"@types/react-router-config@*", "@types/react-router-config@^5.0.7": + version "5.0.11" + resolved "https://registry.yarnpkg.com/@types/react-router-config/-/react-router-config-5.0.11.tgz#2761a23acc7905a66a94419ee40294a65aaa483a" + integrity sha512-WmSAg7WgqW7m4x8Mt4N6ZyKz0BubSj/2tVUMsAHp+Yd2AMwcSbeFq9WympT19p5heCFmF97R9eD5uUR/t4HEqw== + dependencies: + "@types/history" "^4.7.11" + "@types/react" "*" + "@types/react-router" "^5.1.0" + +"@types/react-router-dom@*": + version "5.3.3" + resolved "https://registry.yarnpkg.com/@types/react-router-dom/-/react-router-dom-5.3.3.tgz#e9d6b4a66fcdbd651a5f106c2656a30088cc1e83" + integrity sha512-kpqnYK4wcdm5UaWI3fLcELopqLrHgLqNsdpHauzlQktfkHL3npOSwtj1Uz9oKBAzs7lFtVkV8j83voAz2D8fhw== + dependencies: + "@types/history" "^4.7.11" + "@types/react" "*" + "@types/react-router" "*" + +"@types/react-router@*", "@types/react-router@^5.1.0": + version "5.1.20" + resolved "https://registry.yarnpkg.com/@types/react-router/-/react-router-5.1.20.tgz#88eccaa122a82405ef3efbcaaa5dcdd9f021387c" + integrity sha512-jGjmu/ZqS7FjSH6owMcD5qpq19+1RS9DeVRqfl1FeBMxTDQAGwlMWOcs52NDoXaNKyG3d1cYQFMs9rCrb88o9Q== + dependencies: + "@types/history" "^4.7.11" + "@types/react" "*" + +"@types/react-transition-group@^4.4.12": + version "4.4.12" + resolved "https://registry.yarnpkg.com/@types/react-transition-group/-/react-transition-group-4.4.12.tgz#b5d76568485b02a307238270bfe96cb51ee2a044" + integrity sha512-8TV6R3h2j7a91c+1DXdJi3Syo69zzIZbz7Lg5tORM5LEJG7X/E6a1V3drRyBRZq7/utz7A+c4OgYLiLcYGHG6w== + +"@types/react@*": + version "19.1.13" + resolved "https://registry.yarnpkg.com/@types/react/-/react-19.1.13.tgz#fc650ffa680d739a25a530f5d7ebe00cdd771883" + integrity sha512-hHkbU/eoO3EG5/MZkuFSKmYqPbSVk5byPFa3e7y/8TybHiLMACgI8seVYlicwk7H5K/rI2px9xrQp/C+AUDTiQ== + dependencies: + csstype "^3.0.2" + +"@types/retry@0.12.0": + version "0.12.0" + resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.0.tgz#2b35eccfcee7d38cd72ad99232fbd58bffb3c84d" + integrity sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA== + +"@types/sax@^1.2.1": + version "1.2.7" + resolved "https://registry.yarnpkg.com/@types/sax/-/sax-1.2.7.tgz#ba5fe7df9aa9c89b6dff7688a19023dd2963091d" + integrity sha512-rO73L89PJxeYM3s3pPPjiPgVVcymqU490g0YO5n5By0k2Erzj6tay/4lr1CHAAU4JyOWd1rpQ8bCf6cZfHU96A== + dependencies: + "@types/node" "*" + +"@types/send@*": + version "0.17.5" + resolved "https://registry.yarnpkg.com/@types/send/-/send-0.17.5.tgz#d991d4f2b16f2b1ef497131f00a9114290791e74" + integrity sha512-z6F2D3cOStZvuk2SaP6YrwkNO65iTZcwA2ZkSABegdkAh/lf+Aa/YQndZVfmEXT5vgAp6zv06VQ3ejSVjAny4w== + dependencies: + "@types/mime" "^1" + "@types/node" "*" + +"@types/serve-index@^1.9.1": + version "1.9.4" + resolved "https://registry.yarnpkg.com/@types/serve-index/-/serve-index-1.9.4.tgz#e6ae13d5053cb06ed36392110b4f9a49ac4ec898" + integrity sha512-qLpGZ/c2fhSs5gnYsQxtDEq3Oy8SXPClIXkW5ghvAvsNuVSA8k+gCONcUCS/UjLEYvYps+e8uBtfgXgvhwfNug== + dependencies: + "@types/express" "*" + +"@types/serve-static@*", "@types/serve-static@^1.13.10": + version "1.15.8" + resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-1.15.8.tgz#8180c3fbe4a70e8f00b9f70b9ba7f08f35987877" + integrity sha512-roei0UY3LhpOJvjbIP6ZZFngyLKl5dskOtDhxY5THRSpO+ZI+nzJ+m5yUMzGrp89YRa7lvknKkMYjqQFGwA7Sg== + dependencies: + "@types/http-errors" "*" + "@types/node" "*" + "@types/send" "*" + +"@types/sockjs@^0.3.33": + version "0.3.36" + resolved "https://registry.yarnpkg.com/@types/sockjs/-/sockjs-0.3.36.tgz#ce322cf07bcc119d4cbf7f88954f3a3bd0f67535" + integrity sha512-MK9V6NzAS1+Ud7JV9lJLFqW85VbC9dq3LmwZCuBe4wBDgKC0Kj/jd8Xl+nSviU+Qc3+m7umHHyHg//2KSa0a0Q== + dependencies: + "@types/node" "*" + +"@types/unist@*", "@types/unist@^3.0.0": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@types/unist/-/unist-3.0.3.tgz#acaab0f919ce69cce629c2d4ed2eb4adc1b6c20c" + integrity sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q== + +"@types/unist@^2.0.0": + version "2.0.11" + resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.11.tgz#11af57b127e32487774841f7a4e54eab166d03c4" + integrity sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA== + +"@types/ws@^8.5.5": + version "8.18.1" + resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.18.1.tgz#48464e4bf2ddfd17db13d845467f6070ffea4aa9" + integrity sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg== + dependencies: + "@types/node" "*" + +"@types/yargs-parser@*": + version "21.0.3" + resolved "https://registry.yarnpkg.com/@types/yargs-parser/-/yargs-parser-21.0.3.tgz#815e30b786d2e8f0dcd85fd5bcf5e1a04d008f15" + integrity sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ== + +"@types/yargs@^17.0.8": + version "17.0.33" + resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-17.0.33.tgz#8c32303da83eec050a84b3c7ae7b9f922d13e32d" + integrity sha512-WpxBCKWPLr4xSsHgz511rFJAM+wS28w2zEO1QDNY5zM/S8ok70NNfztH0xwhqKyaK0OHCbN98LDAZuy1ctxDkA== + dependencies: + "@types/yargs-parser" "*" + +"@ungap/structured-clone@^1.0.0": + version "1.3.0" + resolved "https://registry.yarnpkg.com/@ungap/structured-clone/-/structured-clone-1.3.0.tgz#d06bbb384ebcf6c505fde1c3d0ed4ddffe0aaff8" + integrity sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g== + +"@webassemblyjs/ast@1.14.1", "@webassemblyjs/ast@^1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/ast/-/ast-1.14.1.tgz#a9f6a07f2b03c95c8d38c4536a1fdfb521ff55b6" + integrity sha512-nuBEDgQfm1ccRp/8bCQrx1frohyufl4JlbMMZ4P1wpeOfDhF6FQkxZJ1b/e+PLwr6X1Nhw6OLme5usuBWYBvuQ== + dependencies: + "@webassemblyjs/helper-numbers" "1.13.2" + "@webassemblyjs/helper-wasm-bytecode" "1.13.2" + +"@webassemblyjs/floating-point-hex-parser@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.13.2.tgz#fcca1eeddb1cc4e7b6eed4fc7956d6813b21b9fb" + integrity sha512-6oXyTOzbKxGH4steLbLNOu71Oj+C8Lg34n6CqRvqfS2O71BxY6ByfMDRhBytzknj9yGUPVJ1qIKhRlAwO1AovA== + +"@webassemblyjs/helper-api-error@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-api-error/-/helper-api-error-1.13.2.tgz#e0a16152248bc38daee76dd7e21f15c5ef3ab1e7" + integrity sha512-U56GMYxy4ZQCbDZd6JuvvNV/WFildOjsaWD3Tzzvmw/mas3cXzRJPMjP83JqEsgSbyrmaGjBfDtV7KDXV9UzFQ== + +"@webassemblyjs/helper-buffer@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-buffer/-/helper-buffer-1.14.1.tgz#822a9bc603166531f7d5df84e67b5bf99b72b96b" + integrity sha512-jyH7wtcHiKssDtFPRB+iQdxlDf96m0E39yb0k5uJVhFGleZFoNw1c4aeIcVUPPbXUVJ94wwnMOAqUHyzoEPVMA== + +"@webassemblyjs/helper-numbers@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-numbers/-/helper-numbers-1.13.2.tgz#dbd932548e7119f4b8a7877fd5a8d20e63490b2d" + integrity sha512-FE8aCmS5Q6eQYcV3gI35O4J789wlQA+7JrqTTpJqn5emA4U2hvwJmvFRC0HODS+3Ye6WioDklgd6scJ3+PLnEA== + dependencies: + "@webassemblyjs/floating-point-hex-parser" "1.13.2" + "@webassemblyjs/helper-api-error" "1.13.2" + "@xtuc/long" "4.2.2" + +"@webassemblyjs/helper-wasm-bytecode@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.13.2.tgz#e556108758f448aae84c850e593ce18a0eb31e0b" + integrity sha512-3QbLKy93F0EAIXLh0ogEVR6rOubA9AoZ+WRYhNbFyuB70j3dRdwH9g+qXhLAO0kiYGlg3TxDV+I4rQTr/YNXkA== + +"@webassemblyjs/helper-wasm-section@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.14.1.tgz#9629dda9c4430eab54b591053d6dc6f3ba050348" + integrity sha512-ds5mXEqTJ6oxRoqjhWDU83OgzAYjwsCV8Lo/N+oRsNDmx/ZDpqalmrtgOMkHwxsG0iI//3BwWAErYRHtgn0dZw== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@webassemblyjs/helper-buffer" "1.14.1" + "@webassemblyjs/helper-wasm-bytecode" "1.13.2" + "@webassemblyjs/wasm-gen" "1.14.1" + +"@webassemblyjs/ieee754@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/ieee754/-/ieee754-1.13.2.tgz#1c5eaace1d606ada2c7fd7045ea9356c59ee0dba" + integrity sha512-4LtOzh58S/5lX4ITKxnAK2USuNEvpdVV9AlgGQb8rJDHaLeHciwG4zlGr0j/SNWlr7x3vO1lDEsuePvtcDNCkw== + dependencies: + "@xtuc/ieee754" "^1.2.0" + +"@webassemblyjs/leb128@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/leb128/-/leb128-1.13.2.tgz#57c5c3deb0105d02ce25fa3fd74f4ebc9fd0bbb0" + integrity sha512-Lde1oNoIdzVzdkNEAWZ1dZ5orIbff80YPdHx20mrHwHrVNNTjNr8E3xz9BdpcGqRQbAEa+fkrCb+fRFTl/6sQw== + dependencies: + "@xtuc/long" "4.2.2" + +"@webassemblyjs/utf8@1.13.2": + version "1.13.2" + resolved "https://registry.yarnpkg.com/@webassemblyjs/utf8/-/utf8-1.13.2.tgz#917a20e93f71ad5602966c2d685ae0c6c21f60f1" + integrity sha512-3NQWGjKTASY1xV5m7Hr0iPeXD9+RDobLll3T9d2AO+g3my8xy5peVyjSag4I50mR1bBSN/Ct12lo+R9tJk0NZQ== + +"@webassemblyjs/wasm-edit@^1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-edit/-/wasm-edit-1.14.1.tgz#ac6689f502219b59198ddec42dcd496b1004d597" + integrity sha512-RNJUIQH/J8iA/1NzlE4N7KtyZNHi3w7at7hDjvRNm5rcUXa00z1vRz3glZoULfJ5mpvYhLybmVcwcjGrC1pRrQ== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@webassemblyjs/helper-buffer" "1.14.1" + "@webassemblyjs/helper-wasm-bytecode" "1.13.2" + "@webassemblyjs/helper-wasm-section" "1.14.1" + "@webassemblyjs/wasm-gen" "1.14.1" + "@webassemblyjs/wasm-opt" "1.14.1" + "@webassemblyjs/wasm-parser" "1.14.1" + "@webassemblyjs/wast-printer" "1.14.1" + +"@webassemblyjs/wasm-gen@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-gen/-/wasm-gen-1.14.1.tgz#991e7f0c090cb0bb62bbac882076e3d219da9570" + integrity sha512-AmomSIjP8ZbfGQhumkNvgC33AY7qtMCXnN6bL2u2Js4gVCg8fp735aEiMSBbDR7UQIj90n4wKAFUSEd0QN2Ukg== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@webassemblyjs/helper-wasm-bytecode" "1.13.2" + "@webassemblyjs/ieee754" "1.13.2" + "@webassemblyjs/leb128" "1.13.2" + "@webassemblyjs/utf8" "1.13.2" + +"@webassemblyjs/wasm-opt@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-opt/-/wasm-opt-1.14.1.tgz#e6f71ed7ccae46781c206017d3c14c50efa8106b" + integrity sha512-PTcKLUNvBqnY2U6E5bdOQcSM+oVP/PmrDY9NzowJjislEjwP/C4an2303MCVS2Mg9d3AJpIGdUFIQQWbPds0Sw== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@webassemblyjs/helper-buffer" "1.14.1" + "@webassemblyjs/wasm-gen" "1.14.1" + "@webassemblyjs/wasm-parser" "1.14.1" + +"@webassemblyjs/wasm-parser@1.14.1", "@webassemblyjs/wasm-parser@^1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-parser/-/wasm-parser-1.14.1.tgz#b3e13f1893605ca78b52c68e54cf6a865f90b9fb" + integrity sha512-JLBl+KZ0R5qB7mCnud/yyX08jWFw5MsoalJ1pQ4EdFlgj9VdXKGuENGsiCIjegI1W7p91rUlcB/LB5yRJKNTcQ== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@webassemblyjs/helper-api-error" "1.13.2" + "@webassemblyjs/helper-wasm-bytecode" "1.13.2" + "@webassemblyjs/ieee754" "1.13.2" + "@webassemblyjs/leb128" "1.13.2" + "@webassemblyjs/utf8" "1.13.2" + +"@webassemblyjs/wast-printer@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wast-printer/-/wast-printer-1.14.1.tgz#3bb3e9638a8ae5fdaf9610e7a06b4d9f9aa6fe07" + integrity sha512-kPSSXE6De1XOR820C90RIo2ogvZG+c3KiHzqUoO/F34Y2shGzesfqv7o57xrxovZJH/MetF5UjroJ/R/3isoiw== + dependencies: + "@webassemblyjs/ast" "1.14.1" + "@xtuc/long" "4.2.2" + +"@xtuc/ieee754@^1.2.0": + version "1.2.0" + resolved "https://registry.yarnpkg.com/@xtuc/ieee754/-/ieee754-1.2.0.tgz#eef014a3145ae477a1cbc00cd1e552336dceb790" + integrity sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA== + +"@xtuc/long@4.2.2": + version "4.2.2" + resolved "https://registry.yarnpkg.com/@xtuc/long/-/long-4.2.2.tgz#d291c6a4e97989b5c61d9acf396ae4fe133a718d" + integrity sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ== + +accepts@~1.3.4, accepts@~1.3.8: + version "1.3.8" + resolved "https://registry.yarnpkg.com/accepts/-/accepts-1.3.8.tgz#0bf0be125b67014adcb0b0921e62db7bffe16b2e" + integrity sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw== + dependencies: + mime-types "~2.1.34" + negotiator "0.6.3" + +acorn-import-phases@^1.0.3: + version "1.0.4" + resolved "https://registry.yarnpkg.com/acorn-import-phases/-/acorn-import-phases-1.0.4.tgz#16eb850ba99a056cb7cbfe872ffb8972e18c8bd7" + integrity sha512-wKmbr/DDiIXzEOiWrTTUcDm24kQ2vGfZQvM2fwg2vXqR5uW6aapr7ObPtj1th32b9u90/Pf4AItvdTh42fBmVQ== + +acorn-jsx@^5.0.0: + version "5.3.2" + resolved "https://registry.yarnpkg.com/acorn-jsx/-/acorn-jsx-5.3.2.tgz#7ed5bb55908b3b2f1bc55c6af1653bada7f07937" + integrity sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ== + +acorn-walk@^8.0.0: + version "8.3.4" + resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-8.3.4.tgz#794dd169c3977edf4ba4ea47583587c5866236b7" + integrity sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g== + dependencies: + acorn "^8.11.0" + +acorn@^8.0.0, acorn@^8.0.4, acorn@^8.11.0, acorn@^8.15.0: + version "8.15.0" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.15.0.tgz#a360898bc415edaac46c8241f6383975b930b816" + integrity sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg== + +address@^1.0.1: + version "1.2.2" + resolved "https://registry.yarnpkg.com/address/-/address-1.2.2.tgz#2b5248dac5485a6390532c6a517fda2e3faac89e" + integrity sha512-4B/qKCfeE/ODUaAUpSwfzazo5x29WD4r3vXiWsB7I2mSDAihwEqKO+g8GELZUQSSAo5e1XTYh3ZVfLyxBc12nA== + +aggregate-error@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/aggregate-error/-/aggregate-error-3.1.0.tgz#92670ff50f5359bdb7a3e0d40d0ec30c5737687a" + integrity sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA== + dependencies: + clean-stack "^2.0.0" + indent-string "^4.0.0" + +ajv-formats@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-2.1.1.tgz#6e669400659eb74973bbf2e33327180a0996b520" + integrity sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA== + dependencies: + ajv "^8.0.0" + +ajv-keywords@^3.5.2: + version "3.5.2" + resolved "https://registry.yarnpkg.com/ajv-keywords/-/ajv-keywords-3.5.2.tgz#31f29da5ab6e00d1c2d329acf7b5929614d5014d" + integrity sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ== + +ajv-keywords@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/ajv-keywords/-/ajv-keywords-5.1.0.tgz#69d4d385a4733cdbeab44964a1170a88f87f0e16" + integrity sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw== + dependencies: + fast-deep-equal "^3.1.3" + +ajv@^6.12.5: + version "6.12.6" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4" + integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g== + dependencies: + fast-deep-equal "^3.1.1" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.4.1" + uri-js "^4.2.2" + +ajv@^8.0.0, ajv@^8.9.0: + version "8.17.1" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.17.1.tgz#37d9a5c776af6bc92d7f4f9510eba4c0a60d11a6" + integrity sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g== + dependencies: + fast-deep-equal "^3.1.3" + fast-uri "^3.0.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + +algoliasearch-helper@^3.22.6: + version "3.26.0" + resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.26.0.tgz#d6e283396a9fc5bf944f365dc3b712570314363f" + integrity sha512-Rv2x3GXleQ3ygwhkhJubhhYGsICmShLAiqtUuJTUkr9uOCOXyF2E71LVT4XDnVffbknv8XgScP4U0Oxtgm+hIw== + dependencies: + "@algolia/events" "^4.0.1" + +algoliasearch@^5.14.2, algoliasearch@^5.17.1: + version "5.37.0" + resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.37.0.tgz#73dc4a09654e6e02b529300018d639706b95b47b" + integrity sha512-y7gau/ZOQDqoInTQp0IwTOjkrHc4Aq4R8JgpmCleFwiLl+PbN2DMWoDUWZnrK8AhNJwT++dn28Bt4NZYNLAmuA== + dependencies: + "@algolia/abtesting" "1.3.0" + "@algolia/client-abtesting" "5.37.0" + "@algolia/client-analytics" "5.37.0" + "@algolia/client-common" "5.37.0" + "@algolia/client-insights" "5.37.0" + "@algolia/client-personalization" "5.37.0" + "@algolia/client-query-suggestions" "5.37.0" + "@algolia/client-search" "5.37.0" + "@algolia/ingestion" "1.37.0" + "@algolia/monitoring" "1.37.0" + "@algolia/recommend" "5.37.0" + "@algolia/requester-browser-xhr" "5.37.0" + "@algolia/requester-fetch" "5.37.0" + "@algolia/requester-node-http" "5.37.0" + +ansi-align@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/ansi-align/-/ansi-align-3.0.1.tgz#0cdf12e111ace773a86e9a1fad1225c43cb19a59" + integrity sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w== + dependencies: + string-width "^4.1.0" + +ansi-escapes@^4.3.2: + version "4.3.2" + resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-4.3.2.tgz#6b2291d1db7d98b6521d5f1efa42d0f3a9feb65e" + integrity sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ== + dependencies: + type-fest "^0.21.3" + +ansi-html-community@^0.0.8: + version "0.0.8" + resolved "https://registry.yarnpkg.com/ansi-html-community/-/ansi-html-community-0.0.8.tgz#69fbc4d6ccbe383f9736934ae34c3f8290f1bf41" + integrity sha512-1APHAyr3+PCamwNw3bXCPp4HFLONZt/yIH0sZp0/469KWNTEy+qN5jQ3GVX6DMZ1UXAi34yVwtTeaG/HpBuuzw== + +ansi-regex@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" + integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== + +ansi-regex@^6.0.1: + version "6.2.2" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.2.2.tgz#60216eea464d864597ce2832000738a0589650c1" + integrity sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg== + +ansi-styles@^4.0.0, ansi-styles@^4.1.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" + integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== + dependencies: + color-convert "^2.0.1" + +ansi-styles@^6.1.0: + version "6.2.3" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.3.tgz#c044d5dcc521a076413472597a1acb1f103c4041" + integrity sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg== + +anymatch@~3.1.2: + version "3.1.3" + resolved "https://registry.yarnpkg.com/anymatch/-/anymatch-3.1.3.tgz#790c58b19ba1720a84205b57c618d5ad8524973e" + integrity sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw== + dependencies: + normalize-path "^3.0.0" + picomatch "^2.0.4" + +arg@^5.0.0: + version "5.0.2" + resolved "https://registry.yarnpkg.com/arg/-/arg-5.0.2.tgz#c81433cc427c92c4dcf4865142dbca6f15acd59c" + integrity sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg== + +argparse@^1.0.7: + version "1.0.10" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz#bcd6791ea5ae09725e17e5ad988134cd40b3d911" + integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg== + dependencies: + sprintf-js "~1.0.2" + +argparse@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" + integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== + +array-flatten@1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/array-flatten/-/array-flatten-1.1.1.tgz#9a5f699051b1e7073328f2a008968b64ea2955d2" + integrity sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg== + +array-union@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/array-union/-/array-union-2.1.0.tgz#b798420adbeb1de828d84acd8a2e23d3efe85e8d" + integrity sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw== + +astring@^1.8.0: + version "1.9.0" + resolved "https://registry.yarnpkg.com/astring/-/astring-1.9.0.tgz#cc73e6062a7eb03e7d19c22d8b0b3451fd9bfeef" + integrity sha512-LElXdjswlqjWrPpJFg1Fx4wpkOCxj1TDHlSV4PlaRxHGWko024xICaa97ZkMfs6DRKlCguiAI+rbXv5GWwXIkg== + +autoprefixer@^10.4.19, autoprefixer@^10.4.21: + version "10.4.21" + resolved "https://registry.yarnpkg.com/autoprefixer/-/autoprefixer-10.4.21.tgz#77189468e7a8ad1d9a37fbc08efc9f480cf0a95d" + integrity sha512-O+A6LWV5LDHSJD3LjHYoNi4VLsj/Whi7k6zG12xTYaU4cQ8oxQGckXNX8cRHK5yOZ/ppVHe0ZBXGzSV9jXdVbQ== + dependencies: + browserslist "^4.24.4" + caniuse-lite "^1.0.30001702" + fraction.js "^4.3.7" + normalize-range "^0.1.2" + picocolors "^1.1.1" + postcss-value-parser "^4.2.0" + +babel-loader@^9.2.1: + version "9.2.1" + resolved "https://registry.yarnpkg.com/babel-loader/-/babel-loader-9.2.1.tgz#04c7835db16c246dd19ba0914418f3937797587b" + integrity sha512-fqe8naHt46e0yIdkjUZYqddSXfej3AHajX+CSO5X7oy0EmPc6o5Xh+RClNoHjnieWz9AW4kZxW9yyFMhVB1QLA== + dependencies: + find-cache-dir "^4.0.0" + schema-utils "^4.0.0" + +babel-plugin-dynamic-import-node@^2.3.3: + version "2.3.3" + resolved "https://registry.yarnpkg.com/babel-plugin-dynamic-import-node/-/babel-plugin-dynamic-import-node-2.3.3.tgz#84fda19c976ec5c6defef57f9427b3def66e17a3" + integrity sha512-jZVI+s9Zg3IqA/kdi0i6UDCybUI3aSBLnglhYbSSjKlV7yF1F/5LWv8MakQmvYpnbJDS6fcBL2KzHSxNCMtWSQ== + dependencies: + object.assign "^4.1.0" + +babel-plugin-macros@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/babel-plugin-macros/-/babel-plugin-macros-3.1.0.tgz#9ef6dc74deb934b4db344dc973ee851d148c50c1" + integrity sha512-Cg7TFGpIr01vOQNODXOOaGz2NpCU5gl8x1qJFbb6hbZxR7XrcE2vtbAsTAbJ7/xwJtUuJEw8K8Zr/AE0LHlesg== + dependencies: + "@babel/runtime" "^7.12.5" + cosmiconfig "^7.0.0" + resolve "^1.19.0" + +babel-plugin-polyfill-corejs2@^0.4.14: + version "0.4.14" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.14.tgz#8101b82b769c568835611542488d463395c2ef8f" + integrity sha512-Co2Y9wX854ts6U8gAAPXfn0GmAyctHuK8n0Yhfjd6t30g7yvKjspvvOo9yG+z52PZRgFErt7Ka2pYnXCjLKEpg== + dependencies: + "@babel/compat-data" "^7.27.7" + "@babel/helper-define-polyfill-provider" "^0.6.5" + semver "^6.3.1" + +babel-plugin-polyfill-corejs3@^0.13.0: + version "0.13.0" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz#bb7f6aeef7addff17f7602a08a6d19a128c30164" + integrity sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A== + dependencies: + "@babel/helper-define-polyfill-provider" "^0.6.5" + core-js-compat "^3.43.0" + +babel-plugin-polyfill-regenerator@^0.6.5: + version "0.6.5" + resolved "https://registry.yarnpkg.com/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.5.tgz#32752e38ab6f6767b92650347bf26a31b16ae8c5" + integrity sha512-ISqQ2frbiNU9vIJkzg7dlPpznPZ4jOiUQ1uSmB0fEHeowtN3COYRsXr/xexn64NpU13P06jc/L5TgiJXOgrbEg== + dependencies: + "@babel/helper-define-polyfill-provider" "^0.6.5" + +bail@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/bail/-/bail-2.0.2.tgz#d26f5cd8fe5d6f832a31517b9f7c356040ba6d5d" + integrity sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw== + +balanced-match@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" + integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== + +baseline-browser-mapping@^2.8.2: + version "2.8.4" + resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.8.4.tgz#e553e12272c4965682743705efd8b4b4cf0d709b" + integrity sha512-L+YvJwGAgwJBV1p6ffpSTa2KRc69EeeYGYjRVWKs0GKrK+LON0GC0gV+rKSNtALEDvMDqkvCFq9r1r94/Gjwxw== + +batch@0.6.1: + version "0.6.1" + resolved "https://registry.yarnpkg.com/batch/-/batch-0.6.1.tgz#dc34314f4e679318093fc760272525f94bf25c16" + integrity sha512-x+VAiMRL6UPkx+kudNvxTl6hB2XNNCG2r+7wixVfIYwu/2HKRXimwQyaumLjMveWvT2Hkd/cAJw+QBMfJ/EKVw== + +big.js@^5.2.2: + version "5.2.2" + resolved "https://registry.yarnpkg.com/big.js/-/big.js-5.2.2.tgz#65f0af382f578bcdc742bd9c281e9cb2d7768328" + integrity sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ== + +binary-extensions@^2.0.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-2.3.0.tgz#f6e14a97858d327252200242d4ccfe522c445522" + integrity sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw== + +body-parser@1.20.3: + version "1.20.3" + resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.20.3.tgz#1953431221c6fb5cd63c4b36d53fab0928e548c6" + integrity sha512-7rAxByjUMqQ3/bHJy7D6OGXvx/MMc4IqBn/X0fcM1QUcAItpZrBEYhWGem+tzXH90c+G01ypMcYJBO9Y30203g== + dependencies: + bytes "3.1.2" + content-type "~1.0.5" + debug "2.6.9" + depd "2.0.0" + destroy "1.2.0" + http-errors "2.0.0" + iconv-lite "0.4.24" + on-finished "2.4.1" + qs "6.13.0" + raw-body "2.5.2" + type-is "~1.6.18" + unpipe "1.0.0" + +bonjour-service@^1.0.11: + version "1.3.0" + resolved "https://registry.yarnpkg.com/bonjour-service/-/bonjour-service-1.3.0.tgz#80d867430b5a0da64e82a8047fc1e355bdb71722" + integrity sha512-3YuAUiSkWykd+2Azjgyxei8OWf8thdn8AITIog2M4UICzoqfjlqr64WIjEXZllf/W6vK1goqleSR6brGomxQqA== + dependencies: + fast-deep-equal "^3.1.3" + multicast-dns "^7.2.5" + +boolbase@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/boolbase/-/boolbase-1.0.0.tgz#68dff5fbe60c51eb37725ea9e3ed310dcc1e776e" + integrity sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww== + +boxen@^6.2.1: + version "6.2.1" + resolved "https://registry.yarnpkg.com/boxen/-/boxen-6.2.1.tgz#b098a2278b2cd2845deef2dff2efc38d329b434d" + integrity sha512-H4PEsJXfFI/Pt8sjDWbHlQPx4zL/bvSQjcilJmaulGt5mLDorHOHpmdXAJcBcmru7PhYSp/cDMWRko4ZUMFkSw== + dependencies: + ansi-align "^3.0.1" + camelcase "^6.2.0" + chalk "^4.1.2" + cli-boxes "^3.0.0" + string-width "^5.0.1" + type-fest "^2.5.0" + widest-line "^4.0.1" + wrap-ansi "^8.0.1" + +boxen@^7.0.0: + version "7.1.1" + resolved "https://registry.yarnpkg.com/boxen/-/boxen-7.1.1.tgz#f9ba525413c2fec9cdb88987d835c4f7cad9c8f4" + integrity sha512-2hCgjEmP8YLWQ130n2FerGv7rYpfBmnmp9Uy2Le1vge6X3gZIfSmEzP5QTDElFxcvVcXlEn8Aq6MU/PZygIOog== + dependencies: + ansi-align "^3.0.1" + camelcase "^7.0.1" + chalk "^5.2.0" + cli-boxes "^3.0.0" + string-width "^5.1.2" + type-fest "^2.13.0" + widest-line "^4.0.1" + wrap-ansi "^8.1.0" + +brace-expansion@^1.1.7: + version "1.1.12" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.12.tgz#ab9b454466e5a8cc3a187beaad580412a9c5b843" + integrity sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg== + dependencies: + balanced-match "^1.0.0" + concat-map "0.0.1" + +braces@^3.0.3, braces@~3.0.2: + version "3.0.3" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.3.tgz#490332f40919452272d55a8480adc0c441358789" + integrity sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA== + dependencies: + fill-range "^7.1.1" + +browserslist@^4.0.0, browserslist@^4.23.0, browserslist@^4.24.0, browserslist@^4.24.4, browserslist@^4.25.1, browserslist@^4.25.3: + version "4.26.0" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.26.0.tgz#035ca84b4ff312a3c6a7014a77beb83456a882dd" + integrity sha512-P9go2WrP9FiPwLv3zqRD/Uoxo0RSHjzFCiQz7d4vbmwNqQFo9T9WCeP/Qn5EbcKQY6DBbkxEXNcpJOmncNrb7A== + dependencies: + baseline-browser-mapping "^2.8.2" + caniuse-lite "^1.0.30001741" + electron-to-chromium "^1.5.218" + node-releases "^2.0.21" + update-browserslist-db "^1.1.3" + +buffer-from@^1.0.0: + version "1.1.2" + resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" + integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== + +bytes@3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.0.0.tgz#d32815404d689699f85a4ea4fa8755dd13a96048" + integrity sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw== + +bytes@3.1.2: + version "3.1.2" + resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.1.2.tgz#8b0beeb98605adf1b128fa4386403c009e0221a5" + integrity sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg== + +cacheable-lookup@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/cacheable-lookup/-/cacheable-lookup-7.0.0.tgz#3476a8215d046e5a3202a9209dd13fec1f933a27" + integrity sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w== + +cacheable-request@^10.2.8: + version "10.2.14" + resolved "https://registry.yarnpkg.com/cacheable-request/-/cacheable-request-10.2.14.tgz#eb915b665fda41b79652782df3f553449c406b9d" + integrity sha512-zkDT5WAF4hSSoUgyfg5tFIxz8XQK+25W/TLVojJTMKBaxevLBBtLxgqguAuVQB8PVW79FVjHcU+GJ9tVbDZ9mQ== + dependencies: + "@types/http-cache-semantics" "^4.0.2" + get-stream "^6.0.1" + http-cache-semantics "^4.1.1" + keyv "^4.5.3" + mimic-response "^4.0.0" + normalize-url "^8.0.0" + responselike "^3.0.0" + +call-bind-apply-helpers@^1.0.0, call-bind-apply-helpers@^1.0.1, call-bind-apply-helpers@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz#4b5428c222be985d79c3d82657479dbe0b59b2d6" + integrity sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ== + dependencies: + es-errors "^1.3.0" + function-bind "^1.1.2" + +call-bind@^1.0.8: + version "1.0.8" + resolved "https://registry.yarnpkg.com/call-bind/-/call-bind-1.0.8.tgz#0736a9660f537e3388826f440d5ec45f744eaa4c" + integrity sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww== + dependencies: + call-bind-apply-helpers "^1.0.0" + es-define-property "^1.0.0" + get-intrinsic "^1.2.4" + set-function-length "^1.2.2" + +call-bound@^1.0.2, call-bound@^1.0.3: + version "1.0.4" + resolved "https://registry.yarnpkg.com/call-bound/-/call-bound-1.0.4.tgz#238de935d2a2a692928c538c7ccfa91067fd062a" + integrity sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg== + dependencies: + call-bind-apply-helpers "^1.0.2" + get-intrinsic "^1.3.0" + +callsites@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73" + integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ== + +camel-case@^4.1.2: + version "4.1.2" + resolved "https://registry.yarnpkg.com/camel-case/-/camel-case-4.1.2.tgz#9728072a954f805228225a6deea6b38461e1bd5a" + integrity sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw== + dependencies: + pascal-case "^3.1.2" + tslib "^2.0.3" + +camelcase@^6.2.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-6.3.0.tgz#5685b95eb209ac9c0c177467778c9c84df58ba9a" + integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== + +camelcase@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-7.0.1.tgz#f02e50af9fd7782bc8b88a3558c32fd3a388f048" + integrity sha512-xlx1yCK2Oc1APsPXDL2LdlNP6+uu8OCDdhOBSVT279M/S+y75O30C2VuD8T2ogdePBBl7PfPF4504tnLgX3zfw== + +caniuse-api@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/caniuse-api/-/caniuse-api-3.0.0.tgz#5e4d90e2274961d46291997df599e3ed008ee4c0" + integrity sha512-bsTwuIg/BZZK/vreVTYYbSWoe2F+71P7K5QGEX+pT250DZbfU1MQ5prOKpPR+LL6uWKK3KMwMCAS74QB3Um1uw== + dependencies: + browserslist "^4.0.0" + caniuse-lite "^1.0.0" + lodash.memoize "^4.1.2" + lodash.uniq "^4.5.0" + +caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001702, caniuse-lite@^1.0.30001741: + version "1.0.30001741" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001741.tgz#67fb92953edc536442f3c9da74320774aa523143" + integrity sha512-QGUGitqsc8ARjLdgAfxETDhRbJ0REsP6O3I96TAth/mVjh2cYzN2u+3AzPP3aVSm2FehEItaJw1xd+IGBXWeSw== + +ccount@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/ccount/-/ccount-2.0.1.tgz#17a3bf82302e0870d6da43a01311a8bc02a3ecf5" + integrity sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg== + +chalk@^4.0.0, chalk@^4.1.2: + version "4.1.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01" + integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== + dependencies: + ansi-styles "^4.1.0" + supports-color "^7.1.0" + +chalk@^5.0.1, chalk@^5.2.0: + version "5.6.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.6.2.tgz#b1238b6e23ea337af71c7f8a295db5af0c158aea" + integrity sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA== + +char-regex@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/char-regex/-/char-regex-1.0.2.tgz#d744358226217f981ed58f479b1d6bcc29545dcf" + integrity sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw== + +character-entities-html4@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/character-entities-html4/-/character-entities-html4-2.1.0.tgz#1f1adb940c971a4b22ba39ddca6b618dc6e56b2b" + integrity sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA== + +character-entities-legacy@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz#76bc83a90738901d7bc223a9e93759fdd560125b" + integrity sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ== + +character-entities@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/character-entities/-/character-entities-2.0.2.tgz#2d09c2e72cd9523076ccb21157dff66ad43fcc22" + integrity sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ== + +character-reference-invalid@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz#85c66b041e43b47210faf401278abf808ac45cb9" + integrity sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw== + +cheerio-select@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/cheerio-select/-/cheerio-select-2.1.0.tgz#4d8673286b8126ca2a8e42740d5e3c4884ae21b4" + integrity sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g== + dependencies: + boolbase "^1.0.0" + css-select "^5.1.0" + css-what "^6.1.0" + domelementtype "^2.3.0" + domhandler "^5.0.3" + domutils "^3.0.1" + +cheerio@1.0.0-rc.12: + version "1.0.0-rc.12" + resolved "https://registry.yarnpkg.com/cheerio/-/cheerio-1.0.0-rc.12.tgz#788bf7466506b1c6bf5fae51d24a2c4d62e47683" + integrity sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q== + dependencies: + cheerio-select "^2.1.0" + dom-serializer "^2.0.0" + domhandler "^5.0.3" + domutils "^3.0.1" + htmlparser2 "^8.0.1" + parse5 "^7.0.0" + parse5-htmlparser2-tree-adapter "^7.0.0" + +chokidar@^3.5.3: + version "3.6.0" + resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.6.0.tgz#197c6cc669ef2a8dc5e7b4d97ee4e092c3eb0d5b" + integrity sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw== + dependencies: + anymatch "~3.1.2" + braces "~3.0.2" + glob-parent "~5.1.2" + is-binary-path "~2.1.0" + is-glob "~4.0.1" + normalize-path "~3.0.0" + readdirp "~3.6.0" + optionalDependencies: + fsevents "~2.3.2" + +chrome-trace-event@^1.0.2: + version "1.0.4" + resolved "https://registry.yarnpkg.com/chrome-trace-event/-/chrome-trace-event-1.0.4.tgz#05bffd7ff928465093314708c93bdfa9bd1f0f5b" + integrity sha512-rNjApaLzuwaOTjCiT8lSDdGN1APCiqkChLMJxJPWLunPAt5fy8xgU9/jNOchV84wfIxrA0lRQB7oCT8jrn/wrQ== + +ci-info@^3.2.0: + version "3.9.0" + resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-3.9.0.tgz#4279a62028a7b1f262f3473fc9605f5e218c59b4" + integrity sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ== + +clean-css@^5.2.2, clean-css@^5.3.3, clean-css@~5.3.2: + version "5.3.3" + resolved "https://registry.yarnpkg.com/clean-css/-/clean-css-5.3.3.tgz#b330653cd3bd6b75009cc25c714cae7b93351ccd" + integrity sha512-D5J+kHaVb/wKSFcyyV75uCn8fiY4sV38XJoe4CUyGQ+mOU/fMVYUdH1hJC+CJQ5uY3EnW27SbJYS4X8BiLrAFg== + dependencies: + source-map "~0.6.0" + +clean-stack@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/clean-stack/-/clean-stack-2.2.0.tgz#ee8472dbb129e727b31e8a10a427dee9dfe4008b" + integrity sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A== + +cli-boxes@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/cli-boxes/-/cli-boxes-3.0.0.tgz#71a10c716feeba005e4504f36329ef0b17cf3145" + integrity sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g== + +cli-table3@^0.6.3: + version "0.6.5" + resolved "https://registry.yarnpkg.com/cli-table3/-/cli-table3-0.6.5.tgz#013b91351762739c16a9567c21a04632e449bf2f" + integrity sha512-+W/5efTR7y5HRD7gACw9yQjqMVvEMLBHmboM/kPWam+H+Hmyrgjh6YncVKK122YZkXrLudzTuAukUw9FnMf7IQ== + dependencies: + string-width "^4.2.0" + optionalDependencies: + "@colors/colors" "1.5.0" + +clipboard@^2.0.11: + version "2.0.11" + resolved "https://registry.yarnpkg.com/clipboard/-/clipboard-2.0.11.tgz#62180360b97dd668b6b3a84ec226975762a70be5" + integrity sha512-C+0bbOqkezLIsmWSvlsXS0Q0bmkugu7jcfMIACB+RDEntIzQIkdr148we28AfSloQLRdZlYL/QYyrq05j/3Faw== + dependencies: + good-listener "^1.2.2" + select "^1.1.2" + tiny-emitter "^2.0.0" + +clone-deep@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/clone-deep/-/clone-deep-4.0.1.tgz#c19fd9bdbbf85942b4fd979c84dcf7d5f07c2387" + integrity sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ== + dependencies: + is-plain-object "^2.0.4" + kind-of "^6.0.2" + shallow-clone "^3.0.0" + +clsx@^2.0.0, clsx@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/clsx/-/clsx-2.1.1.tgz#eed397c9fd8bd882bfb18deab7102049a2f32999" + integrity sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA== + +collapse-white-space@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/collapse-white-space/-/collapse-white-space-2.1.0.tgz#640257174f9f42c740b40f3b55ee752924feefca" + integrity sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw== + +color-convert@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" + integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== + dependencies: + color-name "~1.1.4" + +color-name@~1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" + integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== + +colord@^2.9.3: + version "2.9.3" + resolved "https://registry.yarnpkg.com/colord/-/colord-2.9.3.tgz#4f8ce919de456f1d5c1c368c307fe20f3e59fb43" + integrity sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw== + +colorette@^2.0.10: + version "2.0.20" + resolved "https://registry.yarnpkg.com/colorette/-/colorette-2.0.20.tgz#9eb793e6833067f7235902fcd3b09917a000a95a" + integrity sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w== + +combine-promises@^1.1.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/combine-promises/-/combine-promises-1.2.0.tgz#5f2e68451862acf85761ded4d9e2af7769c2ca6a" + integrity sha512-VcQB1ziGD0NXrhKxiwyNbCDmRzs/OShMs2GqW2DlU2A/Sd0nQxE1oWDAE5O0ygSx5mgQOn9eIFh7yKPgFRVkPQ== + +comma-separated-tokens@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz#4e89c9458acb61bc8fef19f4529973b2392839ee" + integrity sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg== + +commander@^10.0.0: + version "10.0.1" + resolved "https://registry.yarnpkg.com/commander/-/commander-10.0.1.tgz#881ee46b4f77d1c1dccc5823433aa39b022cbe06" + integrity sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug== + +commander@^2.20.0: + version "2.20.3" + resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33" + integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ== + +commander@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-5.1.0.tgz#46abbd1652f8e059bddaef99bbdcb2ad9cf179ae" + integrity sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg== + +commander@^7.2.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-7.2.0.tgz#a36cb57d0b501ce108e4d20559a150a391d97ab7" + integrity sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw== + +commander@^8.3.0: + version "8.3.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-8.3.0.tgz#4837ea1b2da67b9c616a67afbb0fafee567bca66" + integrity sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww== + +common-path-prefix@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/common-path-prefix/-/common-path-prefix-3.0.0.tgz#7d007a7e07c58c4b4d5f433131a19141b29f11e0" + integrity sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w== + +compressible@~2.0.18: + version "2.0.18" + resolved "https://registry.yarnpkg.com/compressible/-/compressible-2.0.18.tgz#af53cca6b070d4c3c0750fbd77286a6d7cc46fba" + integrity sha512-AF3r7P5dWxL8MxyITRMlORQNaOA2IkAFaTr4k7BUumjPtRpGDTZpl0Pb1XCO6JeDCBdp126Cgs9sMxqSjgYyRg== + dependencies: + mime-db ">= 1.43.0 < 2" + +compression@^1.7.4: + version "1.8.1" + resolved "https://registry.yarnpkg.com/compression/-/compression-1.8.1.tgz#4a45d909ac16509195a9a28bd91094889c180d79" + integrity sha512-9mAqGPHLakhCLeNyxPkK4xVo746zQ/czLH1Ky+vkitMnWfWZps8r0qXuwhwizagCRttsL4lfG4pIOvaWLpAP0w== + dependencies: + bytes "3.1.2" + compressible "~2.0.18" + debug "2.6.9" + negotiator "~0.6.4" + on-headers "~1.1.0" + safe-buffer "5.2.1" + vary "~1.1.2" + +concat-map@0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" + integrity sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg== + +config-chain@^1.1.11: + version "1.1.13" + resolved "https://registry.yarnpkg.com/config-chain/-/config-chain-1.1.13.tgz#fad0795aa6a6cdaff9ed1b68e9dff94372c232f4" + integrity sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ== + dependencies: + ini "^1.3.4" + proto-list "~1.2.1" + +configstore@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/configstore/-/configstore-6.0.0.tgz#49eca2ebc80983f77e09394a1a56e0aca8235566" + integrity sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA== + dependencies: + dot-prop "^6.0.1" + graceful-fs "^4.2.6" + unique-string "^3.0.0" + write-file-atomic "^3.0.3" + xdg-basedir "^5.0.1" + +connect-history-api-fallback@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/connect-history-api-fallback/-/connect-history-api-fallback-2.0.0.tgz#647264845251a0daf25b97ce87834cace0f5f1c8" + integrity sha512-U73+6lQFmfiNPrYbXqr6kZ1i1wiRqXnp2nhMsINseWXO8lDau0LGEffJ8kQi4EjLZympVgRdvqjAgiZ1tgzDDA== + +consola@^3.2.3: + version "3.4.2" + resolved "https://registry.yarnpkg.com/consola/-/consola-3.4.2.tgz#5af110145397bb67afdab77013fdc34cae590ea7" + integrity sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA== + +content-disposition@0.5.2: + version "0.5.2" + resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-0.5.2.tgz#0cf68bb9ddf5f2be7961c3a85178cb85dba78cb4" + integrity sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA== + +content-disposition@0.5.4: + version "0.5.4" + resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-0.5.4.tgz#8b82b4efac82512a02bb0b1dcec9d2c5e8eb5bfe" + integrity sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ== + dependencies: + safe-buffer "5.2.1" + +content-type@~1.0.4, content-type@~1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/content-type/-/content-type-1.0.5.tgz#8b773162656d1d1086784c8f23a54ce6d73d7918" + integrity sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA== + +convert-source-map@^1.5.0: + version "1.9.0" + resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-1.9.0.tgz#7faae62353fb4213366d0ca98358d22e8368b05f" + integrity sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A== + +convert-source-map@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-2.0.0.tgz#4b560f649fc4e918dd0ab75cf4961e8bc882d82a" + integrity sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg== + +cookie-signature@1.0.6: + version "1.0.6" + resolved "https://registry.yarnpkg.com/cookie-signature/-/cookie-signature-1.0.6.tgz#e303a882b342cc3ee8ca513a79999734dab3ae2c" + integrity sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ== + +cookie@0.7.1: + version "0.7.1" + resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.7.1.tgz#2f73c42142d5d5cf71310a74fc4ae61670e5dbc9" + integrity sha512-6DnInpx7SJ2AK3+CTUE/ZM0vWTUboZCegxhC2xiIydHR9jNuTAASBrfEpHhiGOZw/nX51bHt6YQl8jsGo4y/0w== + +copy-text-to-clipboard@^3.2.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/copy-text-to-clipboard/-/copy-text-to-clipboard-3.2.1.tgz#01c3656d6c81a6aa713aa0a8d361214a1eeac6ae" + integrity sha512-3am6cw+WOicd0+HyzhC4kYS02wHJUiVQXmAADxfUARKsHBkWl1Vl3QQEiILlSs8YcPS/C0+y/urCNEYQk+byWA== + +copy-webpack-plugin@^11.0.0: + version "11.0.0" + resolved "https://registry.yarnpkg.com/copy-webpack-plugin/-/copy-webpack-plugin-11.0.0.tgz#96d4dbdb5f73d02dd72d0528d1958721ab72e04a" + integrity sha512-fX2MWpamkW0hZxMEg0+mYnA40LTosOSa5TqZ9GYIBzyJa9C3QUaMPSE2xAi/buNr8u89SfD9wHSQVBzrRa/SOQ== + dependencies: + fast-glob "^3.2.11" + glob-parent "^6.0.1" + globby "^13.1.1" + normalize-path "^3.0.0" + schema-utils "^4.0.0" + serialize-javascript "^6.0.0" + +core-js-compat@^3.43.0: + version "3.45.1" + resolved "https://registry.yarnpkg.com/core-js-compat/-/core-js-compat-3.45.1.tgz#424f3f4af30bf676fd1b67a579465104f64e9c7a" + integrity sha512-tqTt5T4PzsMIZ430XGviK4vzYSoeNJ6CXODi6c/voxOT6IZqBht5/EKaSNnYiEjjRYxjVz7DQIsOsY0XNi8PIA== + dependencies: + browserslist "^4.25.3" + +core-js-pure@^3.43.0: + version "3.45.1" + resolved "https://registry.yarnpkg.com/core-js-pure/-/core-js-pure-3.45.1.tgz#b129d86a5f7f8380378577c7eaee83608570a05a" + integrity sha512-OHnWFKgTUshEU8MK+lOs1H8kC8GkTi9Z1tvNkxrCcw9wl3MJIO7q2ld77wjWn4/xuGrVu2X+nME1iIIPBSdyEQ== + +core-js@^3.31.1: + version "3.45.1" + resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.45.1.tgz#5810e04a1b4e9bc5ddaa4dd12e702ff67300634d" + integrity sha512-L4NPsJlCfZsPeXukyzHFlg/i7IIVwHSItR0wg0FLNqYClJ4MQYTYLbC7EkjKYRLZF2iof2MUgN0EGy7MdQFChg== + +core-util-is@~1.0.0: + version "1.0.3" + resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.3.tgz#a6042d3634c2b27e9328f837b965fac83808db85" + integrity sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ== + +cosmiconfig@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/cosmiconfig/-/cosmiconfig-7.1.0.tgz#1443b9afa596b670082ea46cbd8f6a62b84635f6" + integrity sha512-AdmX6xUzdNASswsFtmwSt7Vj8po9IuqXm0UXz7QKPuEUmPB4XyjGfaAr2PSuELMwkRMVH1EpIkX5bTZGRB3eCA== + dependencies: + "@types/parse-json" "^4.0.0" + import-fresh "^3.2.1" + parse-json "^5.0.0" + path-type "^4.0.0" + yaml "^1.10.0" + +cosmiconfig@^8.1.3, cosmiconfig@^8.3.5: + version "8.3.6" + resolved "https://registry.yarnpkg.com/cosmiconfig/-/cosmiconfig-8.3.6.tgz#060a2b871d66dba6c8538ea1118ba1ac16f5fae3" + integrity sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA== + dependencies: + import-fresh "^3.3.0" + js-yaml "^4.1.0" + parse-json "^5.2.0" + path-type "^4.0.0" + +cross-spawn@^7.0.3: + version "7.0.6" + resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.6.tgz#8a58fe78f00dcd70c370451759dfbfaf03e8ee9f" + integrity sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA== + dependencies: + path-key "^3.1.0" + shebang-command "^2.0.0" + which "^2.0.1" + +crypto-random-string@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/crypto-random-string/-/crypto-random-string-4.0.0.tgz#5a3cc53d7dd86183df5da0312816ceeeb5bb1fc2" + integrity sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA== + dependencies: + type-fest "^1.0.1" + +css-blank-pseudo@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/css-blank-pseudo/-/css-blank-pseudo-7.0.1.tgz#32020bff20a209a53ad71b8675852b49e8d57e46" + integrity sha512-jf+twWGDf6LDoXDUode+nc7ZlrqfaNphrBIBrcmeP3D8yw1uPaix1gCC8LUQUGQ6CycuK2opkbFFWFuq/a94ag== + dependencies: + postcss-selector-parser "^7.0.0" + +css-declaration-sorter@^7.2.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/css-declaration-sorter/-/css-declaration-sorter-7.2.0.tgz#6dec1c9523bc4a643e088aab8f09e67a54961024" + integrity sha512-h70rUM+3PNFuaBDTLe8wF/cdWu+dOZmb7pJt8Z2sedYbAcQVQV/tEchueg3GWxwqS0cxtbxmaHEdkNACqcvsow== + +css-has-pseudo@^7.0.3: + version "7.0.3" + resolved "https://registry.yarnpkg.com/css-has-pseudo/-/css-has-pseudo-7.0.3.tgz#a5ee2daf5f70a2032f3cefdf1e36e7f52a243873" + integrity sha512-oG+vKuGyqe/xvEMoxAQrhi7uY16deJR3i7wwhBerVrGQKSqUC5GiOVxTpM9F9B9hw0J+eKeOWLH7E9gZ1Dr5rA== + dependencies: + "@csstools/selector-specificity" "^5.0.0" + postcss-selector-parser "^7.0.0" + postcss-value-parser "^4.2.0" + +css-loader@^6.11.0: + version "6.11.0" + resolved "https://registry.yarnpkg.com/css-loader/-/css-loader-6.11.0.tgz#33bae3bf6363d0a7c2cf9031c96c744ff54d85ba" + integrity sha512-CTJ+AEQJjq5NzLga5pE39qdiSV56F8ywCIsqNIRF0r7BDgWsN25aazToqAFg7ZrtA/U016xudB3ffgweORxX7g== + dependencies: + icss-utils "^5.1.0" + postcss "^8.4.33" + postcss-modules-extract-imports "^3.1.0" + postcss-modules-local-by-default "^4.0.5" + postcss-modules-scope "^3.2.0" + postcss-modules-values "^4.0.0" + postcss-value-parser "^4.2.0" + semver "^7.5.4" + +css-minimizer-webpack-plugin@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/css-minimizer-webpack-plugin/-/css-minimizer-webpack-plugin-5.0.1.tgz#33effe662edb1a0bf08ad633c32fa75d0f7ec565" + integrity sha512-3caImjKFQkS+ws1TGcFn0V1HyDJFq1Euy589JlD6/3rV2kj+w7r5G9WDMgSHvpvXHNZ2calVypZWuEDQd9wfLg== + dependencies: + "@jridgewell/trace-mapping" "^0.3.18" + cssnano "^6.0.1" + jest-worker "^29.4.3" + postcss "^8.4.24" + schema-utils "^4.0.1" + serialize-javascript "^6.0.1" + +css-prefers-color-scheme@^10.0.0: + version "10.0.0" + resolved "https://registry.yarnpkg.com/css-prefers-color-scheme/-/css-prefers-color-scheme-10.0.0.tgz#ba001b99b8105b8896ca26fc38309ddb2278bd3c" + integrity sha512-VCtXZAWivRglTZditUfB4StnsWr6YVZ2PRtuxQLKTNRdtAf8tpzaVPE9zXIF3VaSc7O70iK/j1+NXxyQCqdPjQ== + +css-select@^4.1.3: + version "4.3.0" + resolved "https://registry.yarnpkg.com/css-select/-/css-select-4.3.0.tgz#db7129b2846662fd8628cfc496abb2b59e41529b" + integrity sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ== + dependencies: + boolbase "^1.0.0" + css-what "^6.0.1" + domhandler "^4.3.1" + domutils "^2.8.0" + nth-check "^2.0.1" + +css-select@^5.1.0: + version "5.2.2" + resolved "https://registry.yarnpkg.com/css-select/-/css-select-5.2.2.tgz#01b6e8d163637bb2dd6c982ca4ed65863682786e" + integrity sha512-TizTzUddG/xYLA3NXodFM0fSbNizXjOKhqiQQwvhlspadZokn1KDy0NZFS0wuEubIYAV5/c1/lAr0TaaFXEXzw== + dependencies: + boolbase "^1.0.0" + css-what "^6.1.0" + domhandler "^5.0.2" + domutils "^3.0.1" + nth-check "^2.0.1" + +css-tree@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/css-tree/-/css-tree-2.3.1.tgz#10264ce1e5442e8572fc82fbe490644ff54b5c20" + integrity sha512-6Fv1DV/TYw//QF5IzQdqsNDjx/wc8TrMBZsqjL9eW01tWb7R7k/mq+/VXfJCl7SoD5emsJop9cOByJZfs8hYIw== + dependencies: + mdn-data "2.0.30" + source-map-js "^1.0.1" + +css-tree@~2.2.0: + version "2.2.1" + resolved "https://registry.yarnpkg.com/css-tree/-/css-tree-2.2.1.tgz#36115d382d60afd271e377f9c5f67d02bd48c032" + integrity sha512-OA0mILzGc1kCOCSJerOeqDxDQ4HOh+G8NbOJFOTgOCzpw7fCBubk0fEyxp8AgOL/jvLgYA/uV0cMbe43ElF1JA== + dependencies: + mdn-data "2.0.28" + source-map-js "^1.0.1" + +css-what@^6.0.1, css-what@^6.1.0: + version "6.2.2" + resolved "https://registry.yarnpkg.com/css-what/-/css-what-6.2.2.tgz#cdcc8f9b6977719fdfbd1de7aec24abf756b9dea" + integrity sha512-u/O3vwbptzhMs3L1fQE82ZSLHQQfto5gyZzwteVIEyeaY5Fc7R4dapF/BvRoSYFeqfBk4m0V1Vafq5Pjv25wvA== + +cssdb@^8.4.0: + version "8.4.0" + resolved "https://registry.yarnpkg.com/cssdb/-/cssdb-8.4.0.tgz#232a1aa7751983ed2b40331634902d4c93f0456c" + integrity sha512-lyATYGyvXwQ8h55WeQeEHXhI+47rl52pXSYkFK/ZrCbAJSgVIaPFjYc3RM8TpRHKk7W3wsAZImmLps+P5VyN9g== + +cssesc@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/cssesc/-/cssesc-3.0.0.tgz#37741919903b868565e1c09ea747445cd18983ee" + integrity sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg== + +cssnano-preset-advanced@^6.1.2: + version "6.1.2" + resolved "https://registry.yarnpkg.com/cssnano-preset-advanced/-/cssnano-preset-advanced-6.1.2.tgz#82b090872b8f98c471f681d541c735acf8b94d3f" + integrity sha512-Nhao7eD8ph2DoHolEzQs5CfRpiEP0xa1HBdnFZ82kvqdmbwVBUr2r1QuQ4t1pi+D1ZpqpcO4T+wy/7RxzJ/WPQ== + dependencies: + autoprefixer "^10.4.19" + browserslist "^4.23.0" + cssnano-preset-default "^6.1.2" + postcss-discard-unused "^6.0.5" + postcss-merge-idents "^6.0.3" + postcss-reduce-idents "^6.0.3" + postcss-zindex "^6.0.2" + +cssnano-preset-default@^6.1.2: + version "6.1.2" + resolved "https://registry.yarnpkg.com/cssnano-preset-default/-/cssnano-preset-default-6.1.2.tgz#adf4b89b975aa775f2750c89dbaf199bbd9da35e" + integrity sha512-1C0C+eNaeN8OcHQa193aRgYexyJtU8XwbdieEjClw+J9d94E41LwT6ivKH0WT+fYwYWB0Zp3I3IZ7tI/BbUbrg== + dependencies: + browserslist "^4.23.0" + css-declaration-sorter "^7.2.0" + cssnano-utils "^4.0.2" + postcss-calc "^9.0.1" + postcss-colormin "^6.1.0" + postcss-convert-values "^6.1.0" + postcss-discard-comments "^6.0.2" + postcss-discard-duplicates "^6.0.3" + postcss-discard-empty "^6.0.3" + postcss-discard-overridden "^6.0.2" + postcss-merge-longhand "^6.0.5" + postcss-merge-rules "^6.1.1" + postcss-minify-font-values "^6.1.0" + postcss-minify-gradients "^6.0.3" + postcss-minify-params "^6.1.0" + postcss-minify-selectors "^6.0.4" + postcss-normalize-charset "^6.0.2" + postcss-normalize-display-values "^6.0.2" + postcss-normalize-positions "^6.0.2" + postcss-normalize-repeat-style "^6.0.2" + postcss-normalize-string "^6.0.2" + postcss-normalize-timing-functions "^6.0.2" + postcss-normalize-unicode "^6.1.0" + postcss-normalize-url "^6.0.2" + postcss-normalize-whitespace "^6.0.2" + postcss-ordered-values "^6.0.2" + postcss-reduce-initial "^6.1.0" + postcss-reduce-transforms "^6.0.2" + postcss-svgo "^6.0.3" + postcss-unique-selectors "^6.0.4" + +cssnano-utils@^4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/cssnano-utils/-/cssnano-utils-4.0.2.tgz#56f61c126cd0f11f2eef1596239d730d9fceff3c" + integrity sha512-ZR1jHg+wZ8o4c3zqf1SIUSTIvm/9mU343FMR6Obe/unskbvpGhZOo1J6d/r8D1pzkRQYuwbcH3hToOuoA2G7oQ== + +cssnano@^6.0.1, cssnano@^6.1.2: + version "6.1.2" + resolved "https://registry.yarnpkg.com/cssnano/-/cssnano-6.1.2.tgz#4bd19e505bd37ee7cf0dc902d3d869f6d79c66b8" + integrity sha512-rYk5UeX7VAM/u0lNqewCdasdtPK81CgX8wJFLEIXHbV2oldWRgJAsZrdhRXkV1NJzA2g850KiFm9mMU2HxNxMA== + dependencies: + cssnano-preset-default "^6.1.2" + lilconfig "^3.1.1" + +csso@^5.0.5: + version "5.0.5" + resolved "https://registry.yarnpkg.com/csso/-/csso-5.0.5.tgz#f9b7fe6cc6ac0b7d90781bb16d5e9874303e2ca6" + integrity sha512-0LrrStPOdJj+SPCCrGhzryycLjwcgUSHBtxNA8aIDxf0GLsRh1cKYhB00Gd1lDOS4yGH69+SNn13+TWbVHETFQ== + dependencies: + css-tree "~2.2.0" + +csstype@^3.0.2, csstype@^3.1.3: + version "3.1.3" + resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.1.3.tgz#d80ff294d114fb0e6ac500fbf85b60137d7eff81" + integrity sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw== + +debounce@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/debounce/-/debounce-1.2.1.tgz#38881d8f4166a5c5848020c11827b834bcb3e0a5" + integrity sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug== + +debug@2.6.9: + version "2.6.9" + resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f" + integrity sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA== + dependencies: + ms "2.0.0" + +debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.3.1, debug@^4.4.1: + version "4.4.3" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.3.tgz#c6ae432d9bd9662582fce08709b038c58e9e3d6a" + integrity sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA== + dependencies: + ms "^2.1.3" + +decode-named-character-reference@^1.0.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/decode-named-character-reference/-/decode-named-character-reference-1.2.0.tgz#25c32ae6dd5e21889549d40f676030e9514cc0ed" + integrity sha512-c6fcElNV6ShtZXmsgNgFFV5tVX2PaV4g+MOAkb8eXHvn6sryJBrZa9r0zV6+dtTyoCKxtDy5tyQ5ZwQuidtd+Q== + dependencies: + character-entities "^2.0.0" + +decompress-response@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/decompress-response/-/decompress-response-6.0.0.tgz#ca387612ddb7e104bd16d85aab00d5ecf09c66fc" + integrity sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ== + dependencies: + mimic-response "^3.1.0" + +deep-extend@^0.6.0: + version "0.6.0" + resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.6.0.tgz#c4fa7c95404a17a9c3e8ca7e1537312b736330ac" + integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA== + +deepmerge@^4.3.1: + version "4.3.1" + resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.3.1.tgz#44b5f2147cd3b00d4b56137685966f26fd25dd4a" + integrity sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A== + +default-gateway@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/default-gateway/-/default-gateway-6.0.3.tgz#819494c888053bdb743edbf343d6cdf7f2943a71" + integrity sha512-fwSOJsbbNzZ/CUFpqFBqYfYNLj1NbMPm8MMCIzHjC83iSJRBEGmDUxU+WP661BaBQImeC2yHwXtz+P/O9o+XEg== + dependencies: + execa "^5.0.0" + +defer-to-connect@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/defer-to-connect/-/defer-to-connect-2.0.1.tgz#8016bdb4143e4632b77a3449c6236277de520587" + integrity sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg== + +define-data-property@^1.0.1, define-data-property@^1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/define-data-property/-/define-data-property-1.1.4.tgz#894dc141bb7d3060ae4366f6a0107e68fbe48c5e" + integrity sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A== + dependencies: + es-define-property "^1.0.0" + es-errors "^1.3.0" + gopd "^1.0.1" + +define-lazy-prop@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz#3f7ae421129bcaaac9bc74905c98a0009ec9ee7f" + integrity sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og== + +define-properties@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/define-properties/-/define-properties-1.2.1.tgz#10781cc616eb951a80a034bafcaa7377f6af2b6c" + integrity sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg== + dependencies: + define-data-property "^1.0.1" + has-property-descriptors "^1.0.0" + object-keys "^1.1.1" + +delegate@^3.1.2: + version "3.2.0" + resolved "https://registry.yarnpkg.com/delegate/-/delegate-3.2.0.tgz#b66b71c3158522e8ab5744f720d8ca0c2af59166" + integrity sha512-IofjkYBZaZivn0V8nnsMJGBr4jVLxHDheKSW88PyxS5QC4Vo9ZbZVvhzlSxY87fVq3STR6r+4cGepyHkcWOQSw== + +depd@2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/depd/-/depd-2.0.0.tgz#b696163cc757560d09cf22cc8fad1571b79e76df" + integrity sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw== + +depd@~1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/depd/-/depd-1.1.2.tgz#9bcd52e14c097763e749b274c4346ed2e560b5a9" + integrity sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ== + +dequal@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/dequal/-/dequal-2.0.3.tgz#2644214f1997d39ed0ee0ece72335490a7ac67be" + integrity sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA== + +destroy@1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/destroy/-/destroy-1.2.0.tgz#4803735509ad8be552934c67df614f94e66fa015" + integrity sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg== + +detect-node@^2.0.4: + version "2.1.0" + resolved "https://registry.yarnpkg.com/detect-node/-/detect-node-2.1.0.tgz#c9c70775a49c3d03bc2c06d9a73be550f978f8b1" + integrity sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g== + +detect-port@^1.5.1: + version "1.6.1" + resolved "https://registry.yarnpkg.com/detect-port/-/detect-port-1.6.1.tgz#45e4073997c5f292b957cb678fb0bb8ed4250a67" + integrity sha512-CmnVc+Hek2egPx1PeTFVta2W78xy2K/9Rkf6cC4T59S50tVnzKj+tnx5mmx5lwvCkujZ4uRrpRSuV+IVs3f90Q== + dependencies: + address "^1.0.1" + debug "4" + +devlop@^1.0.0, devlop@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/devlop/-/devlop-1.1.0.tgz#4db7c2ca4dc6e0e834c30be70c94bbc976dc7018" + integrity sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA== + dependencies: + dequal "^2.0.0" + +dir-glob@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/dir-glob/-/dir-glob-3.0.1.tgz#56dbf73d992a4a93ba1584f4534063fd2e41717f" + integrity sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA== + dependencies: + path-type "^4.0.0" + +dns-packet@^5.2.2: + version "5.6.1" + resolved "https://registry.yarnpkg.com/dns-packet/-/dns-packet-5.6.1.tgz#ae888ad425a9d1478a0674256ab866de1012cf2f" + integrity sha512-l4gcSouhcgIKRvyy99RNVOgxXiicE+2jZoNmaNmZ6JXiGajBOJAesk1OBlJuM5k2c+eudGdLxDqXuPCKIj6kpw== + dependencies: + "@leichtgewicht/ip-codec" "^2.0.1" + +dom-converter@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/dom-converter/-/dom-converter-0.2.0.tgz#6721a9daee2e293682955b6afe416771627bb768" + integrity sha512-gd3ypIPfOMr9h5jIKq8E3sHOTCjeirnl0WK5ZdS1AW0Odt0b1PaWaHdJ4Qk4klv+YB9aJBS7mESXjFoDQPu6DA== + dependencies: + utila "~0.4" + +dom-helpers@^5.0.1: + version "5.2.1" + resolved "https://registry.yarnpkg.com/dom-helpers/-/dom-helpers-5.2.1.tgz#d9400536b2bf8225ad98fe052e029451ac40e902" + integrity sha512-nRCa7CK3VTrM2NmGkIy4cbK7IZlgBE/PYMn55rrXefr5xXDP0LdtfPnblFDoVdcAfslJ7or6iqAUnx0CCGIWQA== + dependencies: + "@babel/runtime" "^7.8.7" + csstype "^3.0.2" + +dom-serializer@^1.0.1: + version "1.4.1" + resolved "https://registry.yarnpkg.com/dom-serializer/-/dom-serializer-1.4.1.tgz#de5d41b1aea290215dc45a6dae8adcf1d32e2d30" + integrity sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag== + dependencies: + domelementtype "^2.0.1" + domhandler "^4.2.0" + entities "^2.0.0" + +dom-serializer@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/dom-serializer/-/dom-serializer-2.0.0.tgz#e41b802e1eedf9f6cae183ce5e622d789d7d8e53" + integrity sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg== + dependencies: + domelementtype "^2.3.0" + domhandler "^5.0.2" + entities "^4.2.0" + +domelementtype@^2.0.1, domelementtype@^2.2.0, domelementtype@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/domelementtype/-/domelementtype-2.3.0.tgz#5c45e8e869952626331d7aab326d01daf65d589d" + integrity sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw== + +domhandler@^4.0.0, domhandler@^4.2.0, domhandler@^4.3.1: + version "4.3.1" + resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-4.3.1.tgz#8d792033416f59d68bc03a5aa7b018c1ca89279c" + integrity sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ== + dependencies: + domelementtype "^2.2.0" + +domhandler@^5.0.2, domhandler@^5.0.3: + version "5.0.3" + resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-5.0.3.tgz#cc385f7f751f1d1fc650c21374804254538c7d31" + integrity sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w== + dependencies: + domelementtype "^2.3.0" + +domutils@^2.5.2, domutils@^2.8.0: + version "2.8.0" + resolved "https://registry.yarnpkg.com/domutils/-/domutils-2.8.0.tgz#4437def5db6e2d1f5d6ee859bd95ca7d02048135" + integrity sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A== + dependencies: + dom-serializer "^1.0.1" + domelementtype "^2.2.0" + domhandler "^4.2.0" + +domutils@^3.0.1: + version "3.2.2" + resolved "https://registry.yarnpkg.com/domutils/-/domutils-3.2.2.tgz#edbfe2b668b0c1d97c24baf0f1062b132221bc78" + integrity sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw== + dependencies: + dom-serializer "^2.0.0" + domelementtype "^2.3.0" + domhandler "^5.0.3" + +dot-case@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/dot-case/-/dot-case-3.0.4.tgz#9b2b670d00a431667a8a75ba29cd1b98809ce751" + integrity sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w== + dependencies: + no-case "^3.0.4" + tslib "^2.0.3" + +dot-prop@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/dot-prop/-/dot-prop-6.0.1.tgz#fc26b3cf142b9e59b74dbd39ed66ce620c681083" + integrity sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA== + dependencies: + is-obj "^2.0.0" + +dunder-proto@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/dunder-proto/-/dunder-proto-1.0.1.tgz#d7ae667e1dc83482f8b70fd0f6eefc50da30f58a" + integrity sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A== + dependencies: + call-bind-apply-helpers "^1.0.1" + es-errors "^1.3.0" + gopd "^1.2.0" + +duplexer@^0.1.2: + version "0.1.2" + resolved "https://registry.yarnpkg.com/duplexer/-/duplexer-0.1.2.tgz#3abe43aef3835f8ae077d136ddce0f276b0400e6" + integrity sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg== + +eastasianwidth@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/eastasianwidth/-/eastasianwidth-0.2.0.tgz#696ce2ec0aa0e6ea93a397ffcf24aa7840c827cb" + integrity sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA== + +ee-first@1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d" + integrity sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow== + +electron-to-chromium@^1.5.218: + version "1.5.218" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.218.tgz#921042a011a98a4620853c9d391ab62bcc124400" + integrity sha512-uwwdN0TUHs8u6iRgN8vKeWZMRll4gBkz+QMqdS7DDe49uiK68/UX92lFb61oiFPrpYZNeZIqa4bA7O6Aiasnzg== + +emoji-regex@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" + integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== + +emoji-regex@^9.2.2: + version "9.2.2" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-9.2.2.tgz#840c8803b0d8047f4ff0cf963176b32d4ef3ed72" + integrity sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg== + +emojilib@^2.4.0: + version "2.4.0" + resolved "https://registry.yarnpkg.com/emojilib/-/emojilib-2.4.0.tgz#ac518a8bb0d5f76dda57289ccb2fdf9d39ae721e" + integrity sha512-5U0rVMU5Y2n2+ykNLQqMoqklN9ICBT/KsvC1Gz6vqHbz2AXXGkG+Pm5rMWk/8Vjrr/mY9985Hi8DYzn1F09Nyw== + +emojis-list@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/emojis-list/-/emojis-list-3.0.0.tgz#5570662046ad29e2e916e71aae260abdff4f6a78" + integrity sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q== + +emoticon@^4.0.1: + version "4.1.0" + resolved "https://registry.yarnpkg.com/emoticon/-/emoticon-4.1.0.tgz#d5a156868ee173095627a33de3f1e914c3dde79e" + integrity sha512-VWZfnxqwNcc51hIy/sbOdEem6D+cVtpPzEEtVAFdaas30+1dgkyaOQ4sQ6Bp0tOMqWO1v+HQfYaoodOkdhK6SQ== + +encodeurl@~1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-1.0.2.tgz#ad3ff4c86ec2d029322f5a02c3a9a606c95b3f59" + integrity sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w== + +encodeurl@~2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-2.0.0.tgz#7b8ea898077d7e409d3ac45474ea38eaf0857a58" + integrity sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg== + +enhanced-resolve@^5.17.3: + version "5.18.3" + resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.3.tgz#9b5f4c5c076b8787c78fe540392ce76a88855b44" + integrity sha512-d4lC8xfavMeBjzGr2vECC3fsGXziXZQyJxD868h2M/mBI3PwAuODxAkLkq5HYuvrPYcUtiLzsTo8U3PgX3Ocww== + dependencies: + graceful-fs "^4.2.4" + tapable "^2.2.0" + +entities@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/entities/-/entities-2.2.0.tgz#098dc90ebb83d8dffa089d55256b351d34c4da55" + integrity sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A== + +entities@^4.2.0, entities@^4.4.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48" + integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw== + +entities@^6.0.0: + version "6.0.1" + resolved "https://registry.yarnpkg.com/entities/-/entities-6.0.1.tgz#c28c34a43379ca7f61d074130b2f5f7020a30694" + integrity sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g== + +error-ex@^1.3.1: + version "1.3.4" + resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.4.tgz#b3a8d8bb6f92eecc1629e3e27d3c8607a8a32414" + integrity sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ== + dependencies: + is-arrayish "^0.2.1" + +es-define-property@^1.0.0, es-define-property@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/es-define-property/-/es-define-property-1.0.1.tgz#983eb2f9a6724e9303f61addf011c72e09e0b0fa" + integrity sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g== + +es-errors@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/es-errors/-/es-errors-1.3.0.tgz#05f75a25dab98e4fb1dcd5e1472c0546d5057c8f" + integrity sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw== + +es-module-lexer@^1.2.1: + version "1.7.0" + resolved "https://registry.yarnpkg.com/es-module-lexer/-/es-module-lexer-1.7.0.tgz#9159601561880a85f2734560a9099b2c31e5372a" + integrity sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA== + +es-object-atoms@^1.0.0, es-object-atoms@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/es-object-atoms/-/es-object-atoms-1.1.1.tgz#1c4f2c4837327597ce69d2ca190a7fdd172338c1" + integrity sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA== + dependencies: + es-errors "^1.3.0" + +esast-util-from-estree@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/esast-util-from-estree/-/esast-util-from-estree-2.0.0.tgz#8d1cfb51ad534d2f159dc250e604f3478a79f1ad" + integrity sha512-4CyanoAudUSBAn5K13H4JhsMH6L9ZP7XbLVe/dKybkxMO7eDyLsT8UHl9TRNrU2Gr9nz+FovfSIjuXWJ81uVwQ== + dependencies: + "@types/estree-jsx" "^1.0.0" + devlop "^1.0.0" + estree-util-visit "^2.0.0" + unist-util-position-from-estree "^2.0.0" + +esast-util-from-js@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/esast-util-from-js/-/esast-util-from-js-2.0.1.tgz#5147bec34cc9da44accf52f87f239a40ac3e8225" + integrity sha512-8Ja+rNJ0Lt56Pcf3TAmpBZjmx8ZcK5Ts4cAzIOjsjevg9oSXJnl6SUQ2EevU8tv3h6ZLWmoKL5H4fgWvdvfETw== + dependencies: + "@types/estree-jsx" "^1.0.0" + acorn "^8.0.0" + esast-util-from-estree "^2.0.0" + vfile-message "^4.0.0" + +escalade@^3.1.1, escalade@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.2.0.tgz#011a3f69856ba189dffa7dc8fcce99d2a87903e5" + integrity sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA== + +escape-goat@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/escape-goat/-/escape-goat-4.0.0.tgz#9424820331b510b0666b98f7873fe11ac4aa8081" + integrity sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg== + +escape-html@^1.0.3, escape-html@~1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988" + integrity sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow== + +escape-string-regexp@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + integrity sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg== + +escape-string-regexp@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" + integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== + +escape-string-regexp@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz#4683126b500b61762f2dbebace1806e8be31b1c8" + integrity sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw== + +eslint-scope@5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-5.1.1.tgz#e786e59a66cb92b3f6c1fb0d508aab174848f48c" + integrity sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw== + dependencies: + esrecurse "^4.3.0" + estraverse "^4.1.1" + +esprima@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71" + integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== + +esrecurse@^4.3.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/esrecurse/-/esrecurse-4.3.0.tgz#7ad7964d679abb28bee72cec63758b1c5d2c9921" + integrity sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag== + dependencies: + estraverse "^5.2.0" + +estraverse@^4.1.1: + version "4.3.0" + resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-4.3.0.tgz#398ad3f3c5a24948be7725e83d11a7de28cdbd1d" + integrity sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw== + +estraverse@^5.2.0: + version "5.3.0" + resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-5.3.0.tgz#2eea5290702f26ab8fe5370370ff86c965d21123" + integrity sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA== + +estree-util-attach-comments@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/estree-util-attach-comments/-/estree-util-attach-comments-3.0.0.tgz#344bde6a64c8a31d15231e5ee9e297566a691c2d" + integrity sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw== + dependencies: + "@types/estree" "^1.0.0" + +estree-util-build-jsx@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/estree-util-build-jsx/-/estree-util-build-jsx-3.0.1.tgz#b6d0bced1dcc4f06f25cf0ceda2b2dcaf98168f1" + integrity sha512-8U5eiL6BTrPxp/CHbs2yMgP8ftMhR5ww1eIKoWRMlqvltHF8fZn5LRDvTKuxD3DUn+shRbLGqXemcP51oFCsGQ== + dependencies: + "@types/estree-jsx" "^1.0.0" + devlop "^1.0.0" + estree-util-is-identifier-name "^3.0.0" + estree-walker "^3.0.0" + +estree-util-is-identifier-name@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/estree-util-is-identifier-name/-/estree-util-is-identifier-name-3.0.0.tgz#0b5ef4c4ff13508b34dcd01ecfa945f61fce5dbd" + integrity sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg== + +estree-util-scope@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/estree-util-scope/-/estree-util-scope-1.0.0.tgz#9cbdfc77f5cb51e3d9ed4ad9c4adbff22d43e585" + integrity sha512-2CAASclonf+JFWBNJPndcOpA8EMJwa0Q8LUFJEKqXLW6+qBvbFZuF5gItbQOs/umBUkjviCSDCbBwU2cXbmrhQ== + dependencies: + "@types/estree" "^1.0.0" + devlop "^1.0.0" + +estree-util-to-js@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/estree-util-to-js/-/estree-util-to-js-2.0.0.tgz#10a6fb924814e6abb62becf0d2bc4dea51d04f17" + integrity sha512-WDF+xj5rRWmD5tj6bIqRi6CkLIXbbNQUcxQHzGysQzvHmdYG2G7p/Tf0J0gpxGgkeMZNTIjT/AoSvC9Xehcgdg== + dependencies: + "@types/estree-jsx" "^1.0.0" + astring "^1.8.0" + source-map "^0.7.0" + +estree-util-value-to-estree@^3.0.1: + version "3.4.0" + resolved "https://registry.yarnpkg.com/estree-util-value-to-estree/-/estree-util-value-to-estree-3.4.0.tgz#827122e40c3a756d3c4cf5d5d296fa06026a1a4f" + integrity sha512-Zlp+gxis+gCfK12d3Srl2PdX2ybsEA8ZYy6vQGVQTNNYLEGRQQ56XB64bjemN8kxIKXP1nC9ip4Z+ILy9LGzvQ== + dependencies: + "@types/estree" "^1.0.0" + +estree-util-visit@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/estree-util-visit/-/estree-util-visit-2.0.0.tgz#13a9a9f40ff50ed0c022f831ddf4b58d05446feb" + integrity sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/unist" "^3.0.0" + +estree-walker@^3.0.0: + version "3.0.3" + resolved "https://registry.yarnpkg.com/estree-walker/-/estree-walker-3.0.3.tgz#67c3e549ec402a487b4fc193d1953a524752340d" + integrity sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g== + dependencies: + "@types/estree" "^1.0.0" + +esutils@^2.0.2: + version "2.0.3" + resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64" + integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g== + +eta@^2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/eta/-/eta-2.2.0.tgz#eb8b5f8c4e8b6306561a455e62cd7492fe3a9b8a" + integrity sha512-UVQ72Rqjy/ZKQalzV5dCCJP80GrmPrMxh6NlNf+erV6ObL0ZFkhCstWRawS85z3smdr3d2wXPsZEY7rDPfGd2g== + +etag@~1.8.1: + version "1.8.1" + resolved "https://registry.yarnpkg.com/etag/-/etag-1.8.1.tgz#41ae2eeb65efa62268aebfea83ac7d79299b0887" + integrity sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg== + +eval@^0.1.8: + version "0.1.8" + resolved "https://registry.yarnpkg.com/eval/-/eval-0.1.8.tgz#2b903473b8cc1d1989b83a1e7923f883eb357f85" + integrity sha512-EzV94NYKoO09GLXGjXj9JIlXijVck4ONSr5wiCWDvhsvj5jxSrzTmRU/9C1DyB6uToszLs8aifA6NQ7lEQdvFw== + dependencies: + "@types/node" "*" + require-like ">= 0.1.1" + +eventemitter3@^4.0.0, eventemitter3@^4.0.4: + version "4.0.7" + resolved "https://registry.yarnpkg.com/eventemitter3/-/eventemitter3-4.0.7.tgz#2de9b68f6528d5644ef5c59526a1b4a07306169f" + integrity sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw== + +events@^3.2.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/events/-/events-3.3.0.tgz#31a95ad0a924e2d2c419a813aeb2c4e878ea7400" + integrity sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q== + +execa@5.1.1, execa@^5.0.0: + version "5.1.1" + resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" + integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== + dependencies: + cross-spawn "^7.0.3" + get-stream "^6.0.0" + human-signals "^2.1.0" + is-stream "^2.0.0" + merge-stream "^2.0.0" + npm-run-path "^4.0.1" + onetime "^5.1.2" + signal-exit "^3.0.3" + strip-final-newline "^2.0.0" + +express@^4.17.3: + version "4.21.2" + resolved "https://registry.yarnpkg.com/express/-/express-4.21.2.tgz#cf250e48362174ead6cea4a566abef0162c1ec32" + integrity sha512-28HqgMZAmih1Czt9ny7qr6ek2qddF4FclbMzwhCREB6OFfH+rXAnuNCwo1/wFvrtbgsQDb4kSbX9de9lFbrXnA== + dependencies: + accepts "~1.3.8" + array-flatten "1.1.1" + body-parser "1.20.3" + content-disposition "0.5.4" + content-type "~1.0.4" + cookie "0.7.1" + cookie-signature "1.0.6" + debug "2.6.9" + depd "2.0.0" + encodeurl "~2.0.0" + escape-html "~1.0.3" + etag "~1.8.1" + finalhandler "1.3.1" + fresh "0.5.2" + http-errors "2.0.0" + merge-descriptors "1.0.3" + methods "~1.1.2" + on-finished "2.4.1" + parseurl "~1.3.3" + path-to-regexp "0.1.12" + proxy-addr "~2.0.7" + qs "6.13.0" + range-parser "~1.2.1" + safe-buffer "5.2.1" + send "0.19.0" + serve-static "1.16.2" + setprototypeof "1.2.0" + statuses "2.0.1" + type-is "~1.6.18" + utils-merge "1.0.1" + vary "~1.1.2" + +extend-shallow@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/extend-shallow/-/extend-shallow-2.0.1.tgz#51af7d614ad9a9f610ea1bafbb989d6b1c56890f" + integrity sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug== + dependencies: + is-extendable "^0.1.0" + +extend@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/extend/-/extend-3.0.2.tgz#f8b1136b4071fbd8eb140aff858b1019ec2915fa" + integrity sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g== + +fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: + version "3.1.3" + resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" + integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== + +fast-glob@^3.2.11, fast-glob@^3.2.9, fast-glob@^3.3.0: + version "3.3.3" + resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.3.3.tgz#d06d585ce8dba90a16b0505c543c3ccfb3aeb818" + integrity sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg== + dependencies: + "@nodelib/fs.stat" "^2.0.2" + "@nodelib/fs.walk" "^1.2.3" + glob-parent "^5.1.2" + merge2 "^1.3.0" + micromatch "^4.0.8" + +fast-json-stable-stringify@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633" + integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== + +fast-uri@^3.0.1: + version "3.1.0" + resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.1.0.tgz#66eecff6c764c0df9b762e62ca7edcfb53b4edfa" + integrity sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA== + +fastq@^1.6.0: + version "1.19.1" + resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.19.1.tgz#d50eaba803c8846a883c16492821ebcd2cda55f5" + integrity sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ== + dependencies: + reusify "^1.0.4" + +fault@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/fault/-/fault-2.0.1.tgz#d47ca9f37ca26e4bd38374a7c500b5a384755b6c" + integrity sha512-WtySTkS4OKev5JtpHXnib4Gxiurzh5NCGvWrFaZ34m6JehfTUhKZvn9njTfw48t6JumVQOmrKqpmGcdwxnhqBQ== + dependencies: + format "^0.2.0" + +faye-websocket@^0.11.3: + version "0.11.4" + resolved "https://registry.yarnpkg.com/faye-websocket/-/faye-websocket-0.11.4.tgz#7f0d9275cfdd86a1c963dc8b65fcc451edcbb1da" + integrity sha512-CzbClwlXAuiRQAlUyfqPgvPoNKTckTPGfwZV4ZdAhVcP2lh9KUxJg2b5GkE7XbjKQ3YJnQ9z6D9ntLAlB+tP8g== + dependencies: + websocket-driver ">=0.5.1" + +feed@^4.2.2: + version "4.2.2" + resolved "https://registry.yarnpkg.com/feed/-/feed-4.2.2.tgz#865783ef6ed12579e2c44bbef3c9113bc4956a7e" + integrity sha512-u5/sxGfiMfZNtJ3OvQpXcvotFpYkL0n9u9mM2vkui2nGo8b4wvDkJ8gAkYqbA8QpGyFCv3RK0Z+Iv+9veCS9bQ== + dependencies: + xml-js "^1.6.11" + +figures@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/figures/-/figures-3.2.0.tgz#625c18bd293c604dc4a8ddb2febf0c88341746af" + integrity sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg== + dependencies: + escape-string-regexp "^1.0.5" + +file-loader@^6.2.0: + version "6.2.0" + resolved "https://registry.yarnpkg.com/file-loader/-/file-loader-6.2.0.tgz#baef7cf8e1840df325e4390b4484879480eebe4d" + integrity sha512-qo3glqyTa61Ytg4u73GultjHGjdRyig3tG6lPtyX/jOEJvHif9uB0/OCI2Kif6ctF3caQTW2G5gym21oAsI4pw== + dependencies: + loader-utils "^2.0.0" + schema-utils "^3.0.0" + +fill-range@^7.1.1: + version "7.1.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.1.1.tgz#44265d3cac07e3ea7dc247516380643754a05292" + integrity sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg== + dependencies: + to-regex-range "^5.0.1" + +finalhandler@1.3.1: + version "1.3.1" + resolved "https://registry.yarnpkg.com/finalhandler/-/finalhandler-1.3.1.tgz#0c575f1d1d324ddd1da35ad7ece3df7d19088019" + integrity sha512-6BN9trH7bp3qvnrRyzsBz+g3lZxTNZTbVO2EV1CS0WIcDbawYVdYvGflME/9QP0h0pYlCDBCTjYa9nZzMDpyxQ== + dependencies: + debug "2.6.9" + encodeurl "~2.0.0" + escape-html "~1.0.3" + on-finished "2.4.1" + parseurl "~1.3.3" + statuses "2.0.1" + unpipe "~1.0.0" + +find-cache-dir@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/find-cache-dir/-/find-cache-dir-4.0.0.tgz#a30ee0448f81a3990708f6453633c733e2f6eec2" + integrity sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg== + dependencies: + common-path-prefix "^3.0.0" + pkg-dir "^7.0.0" + +find-root@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/find-root/-/find-root-1.1.0.tgz#abcfc8ba76f708c42a97b3d685b7e9450bfb9ce4" + integrity sha512-NKfW6bec6GfKc0SGx1e07QZY9PE99u0Bft/0rzSD5k3sO/vwkVUpDUKVm5Gpp5Ue3YfShPFTX2070tDs5kB9Ng== + +find-up@^6.3.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-6.3.0.tgz#2abab3d3280b2dc7ac10199ef324c4e002c8c790" + integrity sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw== + dependencies: + locate-path "^7.1.0" + path-exists "^5.0.0" + +flat@^5.0.2: + version "5.0.2" + resolved "https://registry.yarnpkg.com/flat/-/flat-5.0.2.tgz#8ca6fe332069ffa9d324c327198c598259ceb241" + integrity sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ== + +follow-redirects@^1.0.0: + version "1.15.11" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.11.tgz#777d73d72a92f8ec4d2e410eb47352a56b8e8340" + integrity sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ== + +form-data-encoder@^2.1.2: + version "2.1.4" + resolved "https://registry.yarnpkg.com/form-data-encoder/-/form-data-encoder-2.1.4.tgz#261ea35d2a70d48d30ec7a9603130fa5515e9cd5" + integrity sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw== + +format@^0.2.0: + version "0.2.2" + resolved "https://registry.yarnpkg.com/format/-/format-0.2.2.tgz#d6170107e9efdc4ed30c9dc39016df942b5cb58b" + integrity sha512-wzsgA6WOq+09wrU1tsJ09udeR/YZRaeArL9e1wPbFg3GG2yDnC2ldKpxs4xunpFF9DgqCqOIra3bc1HWrJ37Ww== + +forwarded@0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/forwarded/-/forwarded-0.2.0.tgz#2269936428aad4c15c7ebe9779a84bf0b2a81811" + integrity sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow== + +fraction.js@^4.3.7: + version "4.3.7" + resolved "https://registry.yarnpkg.com/fraction.js/-/fraction.js-4.3.7.tgz#06ca0085157e42fda7f9e726e79fefc4068840f7" + integrity sha512-ZsDfxO51wGAXREY55a7la9LScWpwv9RxIrYABrlvOFBlH/ShPnrtsXeuUIfXKKOVicNxQ+o8JTbJvjS4M89yew== + +fresh@0.5.2: + version "0.5.2" + resolved "https://registry.yarnpkg.com/fresh/-/fresh-0.5.2.tgz#3d8cadd90d976569fa835ab1f8e4b23a105605a7" + integrity sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q== + +fs-extra@^11.1.1, fs-extra@^11.2.0: + version "11.3.2" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-11.3.2.tgz#c838aeddc6f4a8c74dd15f85e11fe5511bfe02a4" + integrity sha512-Xr9F6z6up6Ws+NjzMCZc6WXg2YFRlrLP9NQDO3VQrWrfiojdhS56TzueT88ze0uBdCTwEIhQ3ptnmKeWGFAe0A== + dependencies: + graceful-fs "^4.2.0" + jsonfile "^6.0.1" + universalify "^2.0.0" + +fs-monkey@^1.0.4: + version "1.1.0" + resolved "https://registry.yarnpkg.com/fs-monkey/-/fs-monkey-1.1.0.tgz#632aa15a20e71828ed56b24303363fb1414e5997" + integrity sha512-QMUezzXWII9EV5aTFXW1UBVUO77wYPpjqIF8/AviUCThNeSYZykpoTixUeaNNBwmCev0AMDWMAni+f8Hxb1IFw== + +fs.realpath@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" + integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== + +fsevents@~2.3.2: + version "2.3.3" + resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6" + integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw== + +function-bind@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.2.tgz#2c02d864d97f3ea6c8830c464cbd11ab6eab7a1c" + integrity sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA== + +gensync@^1.0.0-beta.2: + version "1.0.0-beta.2" + resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0" + integrity sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg== + +get-intrinsic@^1.2.4, get-intrinsic@^1.2.5, get-intrinsic@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/get-intrinsic/-/get-intrinsic-1.3.0.tgz#743f0e3b6964a93a5491ed1bffaae054d7f98d01" + integrity sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ== + dependencies: + call-bind-apply-helpers "^1.0.2" + es-define-property "^1.0.1" + es-errors "^1.3.0" + es-object-atoms "^1.1.1" + function-bind "^1.1.2" + get-proto "^1.0.1" + gopd "^1.2.0" + has-symbols "^1.1.0" + hasown "^2.0.2" + math-intrinsics "^1.1.0" + +get-own-enumerable-property-symbols@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz#b5fde77f22cbe35f390b4e089922c50bce6ef664" + integrity sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g== + +get-proto@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/get-proto/-/get-proto-1.0.1.tgz#150b3f2743869ef3e851ec0c49d15b1d14d00ee1" + integrity sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g== + dependencies: + dunder-proto "^1.0.1" + es-object-atoms "^1.0.0" + +get-stream@^6.0.0, get-stream@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-6.0.1.tgz#a262d8eef67aced57c2852ad6167526a43cbf7b7" + integrity sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg== + +github-slugger@^1.5.0: + version "1.5.0" + resolved "https://registry.yarnpkg.com/github-slugger/-/github-slugger-1.5.0.tgz#17891bbc73232051474d68bd867a34625c955f7d" + integrity sha512-wIh+gKBI9Nshz2o46B0B3f5k/W+WI9ZAv6y5Dn5WJ5SK1t0TnDimB4WE5rmTD05ZAIn8HALCZVmCsvj0w0v0lw== + +glob-parent@^5.1.2, glob-parent@~5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== + dependencies: + is-glob "^4.0.1" + +glob-parent@^6.0.1: + version "6.0.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-6.0.2.tgz#6d237d99083950c79290f24c7642a3de9a28f9e3" + integrity sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A== + dependencies: + is-glob "^4.0.3" + +glob-to-regexp@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz#c75297087c851b9a578bd217dd59a92f59fe546e" + integrity sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw== + +glob@^7.1.3: + version "7.2.3" + resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" + integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^3.1.1" + once "^1.3.0" + path-is-absolute "^1.0.0" + +global-dirs@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/global-dirs/-/global-dirs-3.0.1.tgz#0c488971f066baceda21447aecb1a8b911d22485" + integrity sha512-NBcGGFbBA9s1VzD41QXDG+3++t9Mn5t1FpLdhESY6oKY4gYTFpX4wO3sqGUa0Srjtbfj3szX0RnemmrVRUdULA== + dependencies: + ini "2.0.0" + +globby@^11.1.0: + version "11.1.0" + resolved "https://registry.yarnpkg.com/globby/-/globby-11.1.0.tgz#bd4be98bb042f83d796f7e3811991fbe82a0d34b" + integrity sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g== + dependencies: + array-union "^2.1.0" + dir-glob "^3.0.1" + fast-glob "^3.2.9" + ignore "^5.2.0" + merge2 "^1.4.1" + slash "^3.0.0" + +globby@^13.1.1: + version "13.2.2" + resolved "https://registry.yarnpkg.com/globby/-/globby-13.2.2.tgz#63b90b1bf68619c2135475cbd4e71e66aa090592" + integrity sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w== + dependencies: + dir-glob "^3.0.1" + fast-glob "^3.3.0" + ignore "^5.2.4" + merge2 "^1.4.1" + slash "^4.0.0" + +good-listener@^1.2.2: + version "1.2.2" + resolved "https://registry.yarnpkg.com/good-listener/-/good-listener-1.2.2.tgz#d53b30cdf9313dffb7dc9a0d477096aa6d145c50" + integrity sha512-goW1b+d9q/HIwbVYZzZ6SsTr4IgE+WA44A0GmPIQstuOrgsFcT7VEJ48nmr9GaRtNu0XTKacFLGnBPAM6Afouw== + dependencies: + delegate "^3.1.2" + +gopd@^1.0.1, gopd@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/gopd/-/gopd-1.2.0.tgz#89f56b8217bdbc8802bd299df6d7f1081d7e51a1" + integrity sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg== + +got@^12.1.0: + version "12.6.1" + resolved "https://registry.yarnpkg.com/got/-/got-12.6.1.tgz#8869560d1383353204b5a9435f782df9c091f549" + integrity sha512-mThBblvlAF1d4O5oqyvN+ZxLAYwIJK7bpMxgYqPD9okW0C3qm5FFn7k811QrcuEBwaogR3ngOFoCfs6mRv7teQ== + dependencies: + "@sindresorhus/is" "^5.2.0" + "@szmarczak/http-timer" "^5.0.1" + cacheable-lookup "^7.0.0" + cacheable-request "^10.2.8" + decompress-response "^6.0.0" + form-data-encoder "^2.1.2" + get-stream "^6.0.1" + http2-wrapper "^2.1.10" + lowercase-keys "^3.0.0" + p-cancelable "^3.0.0" + responselike "^3.0.0" + +graceful-fs@4.2.10: + version "4.2.10" + resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.10.tgz#147d3a006da4ca3ce14728c7aefc287c367d7a6c" + integrity sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA== + +graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.2.0, graceful-fs@^4.2.11, graceful-fs@^4.2.4, graceful-fs@^4.2.6, graceful-fs@^4.2.9: + version "4.2.11" + resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.11.tgz#4183e4e8bf08bb6e05bbb2f7d2e0c8f712ca40e3" + integrity sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ== + +gray-matter@^4.0.3: + version "4.0.3" + resolved "https://registry.yarnpkg.com/gray-matter/-/gray-matter-4.0.3.tgz#e893c064825de73ea1f5f7d88c7a9f7274288798" + integrity sha512-5v6yZd4JK3eMI3FqqCouswVqwugaA9r4dNZB1wwcmrD02QkV5H0y7XBQW8QwQqEaZY1pM9aqORSORhJRdNK44Q== + dependencies: + js-yaml "^3.13.1" + kind-of "^6.0.2" + section-matter "^1.0.0" + strip-bom-string "^1.0.0" + +gzip-size@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/gzip-size/-/gzip-size-6.0.0.tgz#065367fd50c239c0671cbcbad5be3e2eeb10e462" + integrity sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q== + dependencies: + duplexer "^0.1.2" + +handle-thing@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/handle-thing/-/handle-thing-2.0.1.tgz#857f79ce359580c340d43081cc648970d0bb234e" + integrity sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg== + +has-flag@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" + integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== + +has-property-descriptors@^1.0.0, has-property-descriptors@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz#963ed7d071dc7bf5f084c5bfbe0d1b6222586854" + integrity sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg== + dependencies: + es-define-property "^1.0.0" + +has-symbols@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/has-symbols/-/has-symbols-1.1.0.tgz#fc9c6a783a084951d0b971fe1018de813707a338" + integrity sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ== + +has-yarn@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/has-yarn/-/has-yarn-3.0.0.tgz#c3c21e559730d1d3b57e28af1f30d06fac38147d" + integrity sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA== + +hasown@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/hasown/-/hasown-2.0.2.tgz#003eaf91be7adc372e84ec59dc37252cedb80003" + integrity sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ== + dependencies: + function-bind "^1.1.2" + +hast-util-from-parse5@^8.0.0: + version "8.0.3" + resolved "https://registry.yarnpkg.com/hast-util-from-parse5/-/hast-util-from-parse5-8.0.3.tgz#830a35022fff28c3fea3697a98c2f4cc6b835a2e" + integrity sha512-3kxEVkEKt0zvcZ3hCRYI8rqrgwtlIOFMWkbclACvjlDw8Li9S2hk/d51OI0nr/gIpdMHNepwgOKqZ/sy0Clpyg== + dependencies: + "@types/hast" "^3.0.0" + "@types/unist" "^3.0.0" + devlop "^1.0.0" + hastscript "^9.0.0" + property-information "^7.0.0" + vfile "^6.0.0" + vfile-location "^5.0.0" + web-namespaces "^2.0.0" + +hast-util-parse-selector@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/hast-util-parse-selector/-/hast-util-parse-selector-4.0.0.tgz#352879fa86e25616036037dd8931fb5f34cb4a27" + integrity sha512-wkQCkSYoOGCRKERFWcxMVMOcYE2K1AaNLU8DXS9arxnLOUEWbOXKXiJUNzEpqZ3JOKpnha3jkFrumEjVliDe7A== + dependencies: + "@types/hast" "^3.0.0" + +hast-util-raw@^9.0.0: + version "9.1.0" + resolved "https://registry.yarnpkg.com/hast-util-raw/-/hast-util-raw-9.1.0.tgz#79b66b26f6f68fb50dfb4716b2cdca90d92adf2e" + integrity sha512-Y8/SBAHkZGoNkpzqqfCldijcuUKh7/su31kEBp67cFY09Wy0mTRgtsLYsiIxMJxlu0f6AA5SUTbDR8K0rxnbUw== + dependencies: + "@types/hast" "^3.0.0" + "@types/unist" "^3.0.0" + "@ungap/structured-clone" "^1.0.0" + hast-util-from-parse5 "^8.0.0" + hast-util-to-parse5 "^8.0.0" + html-void-elements "^3.0.0" + mdast-util-to-hast "^13.0.0" + parse5 "^7.0.0" + unist-util-position "^5.0.0" + unist-util-visit "^5.0.0" + vfile "^6.0.0" + web-namespaces "^2.0.0" + zwitch "^2.0.0" + +hast-util-to-estree@^3.0.0: + version "3.1.3" + resolved "https://registry.yarnpkg.com/hast-util-to-estree/-/hast-util-to-estree-3.1.3.tgz#e654c1c9374645135695cc0ab9f70b8fcaf733d7" + integrity sha512-48+B/rJWAp0jamNbAAf9M7Uf//UVqAoMmgXhBdxTDJLGKY+LRnZ99qcG+Qjl5HfMpYNzS5v4EAwVEF34LeAj7w== + dependencies: + "@types/estree" "^1.0.0" + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + comma-separated-tokens "^2.0.0" + devlop "^1.0.0" + estree-util-attach-comments "^3.0.0" + estree-util-is-identifier-name "^3.0.0" + hast-util-whitespace "^3.0.0" + mdast-util-mdx-expression "^2.0.0" + mdast-util-mdx-jsx "^3.0.0" + mdast-util-mdxjs-esm "^2.0.0" + property-information "^7.0.0" + space-separated-tokens "^2.0.0" + style-to-js "^1.0.0" + unist-util-position "^5.0.0" + zwitch "^2.0.0" + +hast-util-to-jsx-runtime@^2.0.0: + version "2.3.6" + resolved "https://registry.yarnpkg.com/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz#ff31897aae59f62232e21594eac7ef6b63333e98" + integrity sha512-zl6s8LwNyo1P9uw+XJGvZtdFF1GdAkOg8ujOw+4Pyb76874fLps4ueHXDhXWdk6YHQ6OgUtinliG7RsYvCbbBg== + dependencies: + "@types/estree" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/unist" "^3.0.0" + comma-separated-tokens "^2.0.0" + devlop "^1.0.0" + estree-util-is-identifier-name "^3.0.0" + hast-util-whitespace "^3.0.0" + mdast-util-mdx-expression "^2.0.0" + mdast-util-mdx-jsx "^3.0.0" + mdast-util-mdxjs-esm "^2.0.0" + property-information "^7.0.0" + space-separated-tokens "^2.0.0" + style-to-js "^1.0.0" + unist-util-position "^5.0.0" + vfile-message "^4.0.0" + +hast-util-to-parse5@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/hast-util-to-parse5/-/hast-util-to-parse5-8.0.0.tgz#477cd42d278d4f036bc2ea58586130f6f39ee6ed" + integrity sha512-3KKrV5ZVI8if87DVSi1vDeByYrkGzg4mEfeu4alwgmmIeARiBLKCZS2uw5Gb6nU9x9Yufyj3iudm6i7nl52PFw== + dependencies: + "@types/hast" "^3.0.0" + comma-separated-tokens "^2.0.0" + devlop "^1.0.0" + property-information "^6.0.0" + space-separated-tokens "^2.0.0" + web-namespaces "^2.0.0" + zwitch "^2.0.0" + +hast-util-whitespace@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz#7778ed9d3c92dd9e8c5c8f648a49c21fc51cb621" + integrity sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw== + dependencies: + "@types/hast" "^3.0.0" + +hastscript@^9.0.0: + version "9.0.1" + resolved "https://registry.yarnpkg.com/hastscript/-/hastscript-9.0.1.tgz#dbc84bef6051d40084342c229c451cd9dc567dff" + integrity sha512-g7df9rMFX/SPi34tyGCyUBREQoKkapwdY/T04Qn9TDWfHhAYt4/I0gMVirzK5wEzeUqIjEB+LXC/ypb7Aqno5w== + dependencies: + "@types/hast" "^3.0.0" + comma-separated-tokens "^2.0.0" + hast-util-parse-selector "^4.0.0" + property-information "^7.0.0" + space-separated-tokens "^2.0.0" + +he@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/he/-/he-1.2.0.tgz#84ae65fa7eafb165fddb61566ae14baf05664f0f" + integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw== + +history@^4.9.0: + version "4.10.1" + resolved "https://registry.yarnpkg.com/history/-/history-4.10.1.tgz#33371a65e3a83b267434e2b3f3b1b4c58aad4cf3" + integrity sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew== + dependencies: + "@babel/runtime" "^7.1.2" + loose-envify "^1.2.0" + resolve-pathname "^3.0.0" + tiny-invariant "^1.0.2" + tiny-warning "^1.0.0" + value-equal "^1.0.1" + +hoist-non-react-statics@^3.1.0, hoist-non-react-statics@^3.3.1: + version "3.3.2" + resolved "https://registry.yarnpkg.com/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz#ece0acaf71d62c2969c2ec59feff42a4b1a85b45" + integrity sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw== + dependencies: + react-is "^16.7.0" + +hpack.js@^2.1.6: + version "2.1.6" + resolved "https://registry.yarnpkg.com/hpack.js/-/hpack.js-2.1.6.tgz#87774c0949e513f42e84575b3c45681fade2a0b2" + integrity sha512-zJxVehUdMGIKsRaNt7apO2Gqp0BdqW5yaiGHXXmbpvxgBYVZnAql+BJb4RO5ad2MgpbZKn5G6nMnegrH1FcNYQ== + dependencies: + inherits "^2.0.1" + obuf "^1.0.0" + readable-stream "^2.0.1" + wbuf "^1.1.0" + +html-entities@^2.3.2: + version "2.6.0" + resolved "https://registry.yarnpkg.com/html-entities/-/html-entities-2.6.0.tgz#7c64f1ea3b36818ccae3d3fb48b6974208e984f8" + integrity sha512-kig+rMn/QOVRvr7c86gQ8lWXq+Hkv6CbAH1hLu+RG338StTpE8Z0b44SDVaqVu7HGKf27frdmUYEs9hTUX/cLQ== + +html-escaper@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453" + integrity sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg== + +html-minifier-terser@^6.0.2: + version "6.1.0" + resolved "https://registry.yarnpkg.com/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz#bfc818934cc07918f6b3669f5774ecdfd48f32ab" + integrity sha512-YXxSlJBZTP7RS3tWnQw74ooKa6L9b9i9QYXY21eUEvhZ3u9XLfv6OnFsQq6RxkhHygsaUMvYsZRV5rU/OVNZxw== + dependencies: + camel-case "^4.1.2" + clean-css "^5.2.2" + commander "^8.3.0" + he "^1.2.0" + param-case "^3.0.4" + relateurl "^0.2.7" + terser "^5.10.0" + +html-minifier-terser@^7.2.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/html-minifier-terser/-/html-minifier-terser-7.2.0.tgz#18752e23a2f0ed4b0f550f217bb41693e975b942" + integrity sha512-tXgn3QfqPIpGl9o+K5tpcj3/MN4SfLtsx2GWwBC3SSd0tXQGyF3gsSqad8loJgKZGM3ZxbYDd5yhiBIdWpmvLA== + dependencies: + camel-case "^4.1.2" + clean-css "~5.3.2" + commander "^10.0.0" + entities "^4.4.0" + param-case "^3.0.4" + relateurl "^0.2.7" + terser "^5.15.1" + +html-tags@^3.3.1: + version "3.3.1" + resolved "https://registry.yarnpkg.com/html-tags/-/html-tags-3.3.1.tgz#a04026a18c882e4bba8a01a3d39cfe465d40b5ce" + integrity sha512-ztqyC3kLto0e9WbNp0aeP+M3kTt+nbaIveGmUxAtZa+8iFgKLUOD4YKM5j+f3QD89bra7UeumolZHKuOXnTmeQ== + +html-void-elements@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/html-void-elements/-/html-void-elements-3.0.0.tgz#fc9dbd84af9e747249034d4d62602def6517f1d7" + integrity sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg== + +html-webpack-plugin@^5.6.0: + version "5.6.4" + resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-5.6.4.tgz#d8cb0f7edff7745ae7d6cccb0bff592e9f7f7959" + integrity sha512-V/PZeWsqhfpE27nKeX9EO2sbR+D17A+tLf6qU+ht66jdUsN0QLKJN27Z+1+gHrVMKgndBahes0PU6rRihDgHTw== + dependencies: + "@types/html-minifier-terser" "^6.0.0" + html-minifier-terser "^6.0.2" + lodash "^4.17.21" + pretty-error "^4.0.0" + tapable "^2.0.0" + +htmlparser2@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-6.1.0.tgz#c4d762b6c3371a05dbe65e94ae43a9f845fb8fb7" + integrity sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A== + dependencies: + domelementtype "^2.0.1" + domhandler "^4.0.0" + domutils "^2.5.2" + entities "^2.0.0" + +htmlparser2@^8.0.1: + version "8.0.2" + resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-8.0.2.tgz#f002151705b383e62433b5cf466f5b716edaec21" + integrity sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA== + dependencies: + domelementtype "^2.3.0" + domhandler "^5.0.3" + domutils "^3.0.1" + entities "^4.4.0" + +http-cache-semantics@^4.1.1: + version "4.2.0" + resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz#205f4db64f8562b76a4ff9235aa5279839a09dd5" + integrity sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ== + +http-deceiver@^1.2.7: + version "1.2.7" + resolved "https://registry.yarnpkg.com/http-deceiver/-/http-deceiver-1.2.7.tgz#fa7168944ab9a519d337cb0bec7284dc3e723d87" + integrity sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw== + +http-errors@2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-2.0.0.tgz#b7774a1486ef73cf7667ac9ae0858c012c57b9d3" + integrity sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ== + dependencies: + depd "2.0.0" + inherits "2.0.4" + setprototypeof "1.2.0" + statuses "2.0.1" + toidentifier "1.0.1" + +http-errors@~1.6.2: + version "1.6.3" + resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-1.6.3.tgz#8b55680bb4be283a0b5bf4ea2e38580be1d9320d" + integrity sha512-lks+lVC8dgGyh97jxvxeYTWQFvh4uw4yC12gVl63Cg30sjPX4wuGcdkICVXDAESr6OJGjqGA8Iz5mkeN6zlD7A== + dependencies: + depd "~1.1.2" + inherits "2.0.3" + setprototypeof "1.1.0" + statuses ">= 1.4.0 < 2" + +http-parser-js@>=0.5.1: + version "0.5.10" + resolved "https://registry.yarnpkg.com/http-parser-js/-/http-parser-js-0.5.10.tgz#b3277bd6d7ed5588e20ea73bf724fcbe44609075" + integrity sha512-Pysuw9XpUq5dVc/2SMHpuTY01RFl8fttgcyunjL7eEMhGM3cI4eOmiCycJDVCo/7O7ClfQD3SaI6ftDzqOXYMA== + +http-proxy-middleware@^2.0.3: + version "2.0.9" + resolved "https://registry.yarnpkg.com/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz#e9e63d68afaa4eee3d147f39149ab84c0c2815ef" + integrity sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q== + dependencies: + "@types/http-proxy" "^1.17.8" + http-proxy "^1.18.1" + is-glob "^4.0.1" + is-plain-obj "^3.0.0" + micromatch "^4.0.2" + +http-proxy@^1.18.1: + version "1.18.1" + resolved "https://registry.yarnpkg.com/http-proxy/-/http-proxy-1.18.1.tgz#401541f0534884bbf95260334e72f88ee3976549" + integrity sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ== + dependencies: + eventemitter3 "^4.0.0" + follow-redirects "^1.0.0" + requires-port "^1.0.0" + +http2-wrapper@^2.1.10: + version "2.2.1" + resolved "https://registry.yarnpkg.com/http2-wrapper/-/http2-wrapper-2.2.1.tgz#310968153dcdedb160d8b72114363ef5fce1f64a" + integrity sha512-V5nVw1PAOgfI3Lmeaj2Exmeg7fenjhRUgz1lPSezy1CuhPYbgQtbQj4jZfEAEMlaL+vupsvhjqCyjzob0yxsmQ== + dependencies: + quick-lru "^5.1.1" + resolve-alpn "^1.2.0" + +human-signals@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" + integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== + +iconv-lite@0.4.24: + version "0.4.24" + resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b" + integrity sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA== + dependencies: + safer-buffer ">= 2.1.2 < 3" + +icss-utils@^5.0.0, icss-utils@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/icss-utils/-/icss-utils-5.1.0.tgz#c6be6858abd013d768e98366ae47e25d5887b1ae" + integrity sha512-soFhflCVWLfRNOPU3iv5Z9VUdT44xFRbzjLsEzSr5AQmgqPMTHdU3PMT1Cf1ssx8fLNJDA1juftYl+PUcv3MqA== + +ignore@^5.2.0, ignore@^5.2.4: + version "5.3.2" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.3.2.tgz#3cd40e729f3643fd87cb04e50bf0eb722bc596f5" + integrity sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g== + +image-size@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/image-size/-/image-size-2.0.2.tgz#84a7b43704db5736f364bf0d1b029821299b4bdc" + integrity sha512-IRqXKlaXwgSMAMtpNzZa1ZAe8m+Sa1770Dhk8VkSsP9LS+iHD62Zd8FQKs8fbPiagBE7BzoFX23cxFnwshpV6w== + +import-fresh@^3.2.1, import-fresh@^3.3.0: + version "3.3.1" + resolved "https://registry.yarnpkg.com/import-fresh/-/import-fresh-3.3.1.tgz#9cecb56503c0ada1f2741dbbd6546e4b13b57ccf" + integrity sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ== + dependencies: + parent-module "^1.0.0" + resolve-from "^4.0.0" + +import-lazy@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/import-lazy/-/import-lazy-4.0.0.tgz#e8eb627483a0a43da3c03f3e35548be5cb0cc153" + integrity sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw== + +imurmurhash@^0.1.4: + version "0.1.4" + resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea" + integrity sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA== + +indent-string@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/indent-string/-/indent-string-4.0.0.tgz#624f8f4497d619b2d9768531d58f4122854d7251" + integrity sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg== + +infima@0.2.0-alpha.45: + version "0.2.0-alpha.45" + resolved "https://registry.yarnpkg.com/infima/-/infima-0.2.0-alpha.45.tgz#542aab5a249274d81679631b492973dd2c1e7466" + integrity sha512-uyH0zfr1erU1OohLk0fT4Rrb94AOhguWNOcD9uGrSpRvNB+6gZXUoJX5J0NtvzBO10YZ9PgvA4NFgt+fYg8ojw== + +inflight@^1.0.4: + version "1.0.6" + resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" + integrity sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== + dependencies: + once "^1.3.0" + wrappy "1" + +inherits@2, inherits@2.0.4, inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + +inherits@2.0.3: + version "2.0.3" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de" + integrity sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw== + +ini@2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/ini/-/ini-2.0.0.tgz#e5fd556ecdd5726be978fa1001862eacb0a94bc5" + integrity sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA== + +ini@^1.3.4, ini@~1.3.0: + version "1.3.8" + resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.8.tgz#a29da425b48806f34767a4efce397269af28432c" + integrity sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew== + +inline-style-parser@0.2.4: + version "0.2.4" + resolved "https://registry.yarnpkg.com/inline-style-parser/-/inline-style-parser-0.2.4.tgz#f4af5fe72e612839fcd453d989a586566d695f22" + integrity sha512-0aO8FkhNZlj/ZIbNi7Lxxr12obT7cL1moPfE4tg1LkX7LlLfC6DeX4l2ZEud1ukP9jNQyNnfzQVqwbwmAATY4Q== + +invariant@^2.2.4: + version "2.2.4" + resolved "https://registry.yarnpkg.com/invariant/-/invariant-2.2.4.tgz#610f3c92c9359ce1db616e538008d23ff35158e6" + integrity sha512-phJfQVBuaJM5raOpJjSfkiD6BpbCE4Ns//LaXl6wGYtUBY83nWS6Rf9tXm2e8VaK60JEjYldbPif/A2B1C2gNA== + dependencies: + loose-envify "^1.0.0" + +ipaddr.js@1.9.1: + version "1.9.1" + resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-1.9.1.tgz#bff38543eeb8984825079ff3a2a8e6cbd46781b3" + integrity sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g== + +ipaddr.js@^2.0.1: + version "2.2.0" + resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-2.2.0.tgz#d33fa7bac284f4de7af949638c9d68157c6b92e8" + integrity sha512-Ag3wB2o37wslZS19hZqorUnrnzSkpOVy+IiiDEiTqNubEYpYuHWIf6K4psgN2ZWKExS4xhVCrRVfb/wfW8fWJA== + +is-alphabetical@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-alphabetical/-/is-alphabetical-2.0.1.tgz#01072053ea7c1036df3c7d19a6daaec7f19e789b" + integrity sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ== + +is-alphanumerical@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz#7c03fbe96e3e931113e57f964b0a368cc2dfd875" + integrity sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw== + dependencies: + is-alphabetical "^2.0.0" + is-decimal "^2.0.0" + +is-arrayish@^0.2.1: + version "0.2.1" + resolved "https://registry.yarnpkg.com/is-arrayish/-/is-arrayish-0.2.1.tgz#77c99840527aa8ecb1a8ba697b80645a7a926a9d" + integrity sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg== + +is-binary-path@~2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/is-binary-path/-/is-binary-path-2.1.0.tgz#ea1f7f3b80f064236e83470f86c09c254fb45b09" + integrity sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw== + dependencies: + binary-extensions "^2.0.0" + +is-ci@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/is-ci/-/is-ci-3.0.1.tgz#db6ecbed1bd659c43dac0f45661e7674103d1867" + integrity sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ== + dependencies: + ci-info "^3.2.0" + +is-core-module@^2.16.0: + version "2.16.1" + resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.16.1.tgz#2a98801a849f43e2add644fbb6bc6229b19a4ef4" + integrity sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w== + dependencies: + hasown "^2.0.2" + +is-decimal@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-decimal/-/is-decimal-2.0.1.tgz#9469d2dc190d0214fd87d78b78caecc0cc14eef7" + integrity sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A== + +is-docker@^2.0.0, is-docker@^2.1.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/is-docker/-/is-docker-2.2.1.tgz#33eeabe23cfe86f14bde4408a02c0cfb853acdaa" + integrity sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ== + +is-extendable@^0.1.0: + version "0.1.1" + resolved "https://registry.yarnpkg.com/is-extendable/-/is-extendable-0.1.1.tgz#62b110e289a471418e3ec36a617d472e301dfc89" + integrity sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw== + +is-extglob@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" + integrity sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ== + +is-fullwidth-code-point@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" + integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== + +is-glob@^4.0.1, is-glob@^4.0.3, is-glob@~4.0.1: + version "4.0.3" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" + integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== + dependencies: + is-extglob "^2.1.1" + +is-hexadecimal@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz#86b5bf668fca307498d319dfc03289d781a90027" + integrity sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg== + +is-installed-globally@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/is-installed-globally/-/is-installed-globally-0.4.0.tgz#9a0fd407949c30f86eb6959ef1b7994ed0b7b520" + integrity sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ== + dependencies: + global-dirs "^3.0.0" + is-path-inside "^3.0.2" + +is-npm@^6.0.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/is-npm/-/is-npm-6.1.0.tgz#f70e0b6c132dfc817ac97d3badc0134945b098d3" + integrity sha512-O2z4/kNgyjhQwVR1Wpkbfc19JIhggF97NZNCpWTnjH7kVcZMUrnut9XSN7txI7VdyIYk5ZatOq3zvSuWpU8hoA== + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +is-obj@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-1.0.1.tgz#3e4729ac1f5fde025cd7d83a896dab9f4f67db0f" + integrity sha512-l4RyHgRqGN4Y3+9JHVrNqO+tN0rV5My76uW5/nuO4K1b6vw5G8d/cmFjP9tRfEsdhZNt0IFdZuK/c2Vr4Nb+Qg== + +is-obj@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-2.0.0.tgz#473fb05d973705e3fd9620545018ca8e22ef4982" + integrity sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w== + +is-path-inside@^3.0.2: + version "3.0.3" + resolved "https://registry.yarnpkg.com/is-path-inside/-/is-path-inside-3.0.3.tgz#d231362e53a07ff2b0e0ea7fed049161ffd16283" + integrity sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ== + +is-plain-obj@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-3.0.0.tgz#af6f2ea14ac5a646183a5bbdb5baabbc156ad9d7" + integrity sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA== + +is-plain-obj@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-4.1.0.tgz#d65025edec3657ce032fd7db63c97883eaed71f0" + integrity sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg== + +is-plain-object@^2.0.4: + version "2.0.4" + resolved "https://registry.yarnpkg.com/is-plain-object/-/is-plain-object-2.0.4.tgz#2c163b3fafb1b606d9d17928f05c2a1c38e07677" + integrity sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og== + dependencies: + isobject "^3.0.1" + +is-regexp@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-regexp/-/is-regexp-1.0.0.tgz#fd2d883545c46bac5a633e7b9a09e87fa2cb5069" + integrity sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA== + +is-stream@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-2.0.1.tgz#fac1e3d53b97ad5a9d0ae9cef2389f5810a5c077" + integrity sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg== + +is-typedarray@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-typedarray/-/is-typedarray-1.0.0.tgz#e479c80858df0c1b11ddda6940f96011fcda4a9a" + integrity sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA== + +is-wsl@^2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/is-wsl/-/is-wsl-2.2.0.tgz#74a4c76e77ca9fd3f932f290c17ea326cd157271" + integrity sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww== + dependencies: + is-docker "^2.0.0" + +is-yarn-global@^0.4.0: + version "0.4.1" + resolved "https://registry.yarnpkg.com/is-yarn-global/-/is-yarn-global-0.4.1.tgz#b312d902b313f81e4eaf98b6361ba2b45cd694bb" + integrity sha512-/kppl+R+LO5VmhYSEWARUFjodS25D68gvj8W7z0I7OWhUla5xWu8KL6CtB2V0R6yqhnRgbcaREMr4EEM6htLPQ== + +isarray@0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/isarray/-/isarray-0.0.1.tgz#8a18acfca9a8f4177e09abfc6038939b05d1eedf" + integrity sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ== + +isarray@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11" + integrity sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ== + +isexe@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" + integrity sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw== + +isobject@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df" + integrity sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg== + +jest-util@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-29.7.0.tgz#23c2b62bfb22be82b44de98055802ff3710fc0bc" + integrity sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA== + dependencies: + "@jest/types" "^29.6.3" + "@types/node" "*" + chalk "^4.0.0" + ci-info "^3.2.0" + graceful-fs "^4.2.9" + picomatch "^2.2.3" + +jest-worker@^27.4.5: + version "27.5.1" + resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-27.5.1.tgz#8d146f0900e8973b106b6f73cc1e9a8cb86f8db0" + integrity sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg== + dependencies: + "@types/node" "*" + merge-stream "^2.0.0" + supports-color "^8.0.0" + +jest-worker@^29.4.3: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-29.7.0.tgz#acad073acbbaeb7262bd5389e1bcf43e10058d4a" + integrity sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw== + dependencies: + "@types/node" "*" + jest-util "^29.7.0" + merge-stream "^2.0.0" + supports-color "^8.0.0" + +jiti@^1.20.0: + version "1.21.7" + resolved "https://registry.yarnpkg.com/jiti/-/jiti-1.21.7.tgz#9dd81043424a3d28458b193d965f0d18a2300ba9" + integrity sha512-/imKNG4EbWNrVjoNC/1H5/9GFy+tqjGBHCaSsN+P2RnPqjsLmv6UD3Ej+Kj8nBWaRAwyk7kK5ZUc+OEatnTR3A== + +joi@^17.9.2: + version "17.13.3" + resolved "https://registry.yarnpkg.com/joi/-/joi-17.13.3.tgz#0f5cc1169c999b30d344366d384b12d92558bcec" + integrity sha512-otDA4ldcIx+ZXsKHWmp0YizCweVRZG96J10b0FevjfuncLO1oX59THoAmHkNubYJ+9gWsYsp5k8v4ib6oDv1fA== + dependencies: + "@hapi/hoek" "^9.3.0" + "@hapi/topo" "^5.1.0" + "@sideway/address" "^4.1.5" + "@sideway/formula" "^3.0.1" + "@sideway/pinpoint" "^2.0.0" + +"js-tokens@^3.0.0 || ^4.0.0", js-tokens@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" + integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== + +js-yaml@^3.13.1: + version "3.14.1" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.1.tgz#dae812fdb3825fa306609a8717383c50c36a0537" + integrity sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g== + dependencies: + argparse "^1.0.7" + esprima "^4.0.0" + +js-yaml@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602" + integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA== + dependencies: + argparse "^2.0.1" + +jsesc@^3.0.2: + version "3.1.0" + resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.1.0.tgz#74d335a234f67ed19907fdadfac7ccf9d409825d" + integrity sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA== + +jsesc@~3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.0.2.tgz#bb8b09a6597ba426425f2e4a07245c3d00b9343e" + integrity sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g== + +json-buffer@3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/json-buffer/-/json-buffer-3.0.1.tgz#9338802a30d3b6605fbe0613e094008ca8c05a13" + integrity sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ== + +json-parse-even-better-errors@^2.3.0, json-parse-even-better-errors@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz#7c47805a94319928e05777405dc12e1f7a4ee02d" + integrity sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w== + +json-schema-traverse@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" + integrity sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== + +json-schema-traverse@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" + integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== + +json5@^2.1.2, json5@^2.2.3: + version "2.2.3" + resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" + integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== + +jsonfile@^6.0.1: + version "6.2.0" + resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.2.0.tgz#7c265bd1b65de6977478300087c99f1c84383f62" + integrity sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg== + dependencies: + universalify "^2.0.0" + optionalDependencies: + graceful-fs "^4.1.6" + +keyv@^4.5.3: + version "4.5.4" + resolved "https://registry.yarnpkg.com/keyv/-/keyv-4.5.4.tgz#a879a99e29452f942439f2a405e3af8b31d4de93" + integrity sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw== + dependencies: + json-buffer "3.0.1" + +kind-of@^6.0.0, kind-of@^6.0.2: + version "6.0.3" + resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-6.0.3.tgz#07c05034a6c349fa06e24fa35aa76db4580ce4dd" + integrity sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw== + +kleur@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/kleur/-/kleur-3.0.3.tgz#a79c9ecc86ee1ce3fa6206d1216c501f147fc07e" + integrity sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w== + +latest-version@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/latest-version/-/latest-version-7.0.0.tgz#843201591ea81a4d404932eeb61240fe04e9e5da" + integrity sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg== + dependencies: + package-json "^8.1.0" + +launch-editor@^2.6.0: + version "2.11.1" + resolved "https://registry.yarnpkg.com/launch-editor/-/launch-editor-2.11.1.tgz#61a0b7314a42fd84a6cbb564573d9e9ffcf3d72b" + integrity sha512-SEET7oNfgSaB6Ym0jufAdCeo3meJVeCaaDyzRygy0xsp2BFKCprcfHljTq4QkzTLUxEKkFK6OK4811YM2oSrRg== + dependencies: + picocolors "^1.1.1" + shell-quote "^1.8.3" + +leven@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" + integrity sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A== + +lilconfig@^3.1.1: + version "3.1.3" + resolved "https://registry.yarnpkg.com/lilconfig/-/lilconfig-3.1.3.tgz#a1bcfd6257f9585bf5ae14ceeebb7b559025e4c4" + integrity sha512-/vlFKAoH5Cgt3Ie+JLhRbwOsCQePABiU3tJ1egGvyQ+33R/vcwM2Zl2QR/LzjsBeItPt3oSVXapn+m4nQDvpzw== + +lines-and-columns@^1.1.6: + version "1.2.4" + resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632" + integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== + +loader-runner@^4.2.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.3.0.tgz#c1b4a163b99f614830353b16755e7149ac2314e1" + integrity sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg== + +loader-utils@^2.0.0: + version "2.0.4" + resolved "https://registry.yarnpkg.com/loader-utils/-/loader-utils-2.0.4.tgz#8b5cb38b5c34a9a018ee1fc0e6a066d1dfcc528c" + integrity sha512-xXqpXoINfFhgua9xiqD8fPFHgkoq1mmmpE92WlDbm9rNRd/EbRb+Gqf908T2DMfuHjjJlksiK2RbHVOdD/MqSw== + dependencies: + big.js "^5.2.2" + emojis-list "^3.0.0" + json5 "^2.1.2" + +locate-path@^7.1.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-7.2.0.tgz#69cb1779bd90b35ab1e771e1f2f89a202c2a8a8a" + integrity sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA== + dependencies: + p-locate "^6.0.0" + +lodash.debounce@^4.0.8: + version "4.0.8" + resolved "https://registry.yarnpkg.com/lodash.debounce/-/lodash.debounce-4.0.8.tgz#82d79bff30a67c4005ffd5e2515300ad9ca4d7af" + integrity sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow== + +lodash.memoize@^4.1.2: + version "4.1.2" + resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe" + integrity sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag== + +lodash.uniq@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.uniq/-/lodash.uniq-4.5.0.tgz#d0225373aeb652adc1bc82e4945339a842754773" + integrity sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ== + +lodash@^4.17.20, lodash@^4.17.21: + version "4.17.21" + resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c" + integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg== + +longest-streak@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/longest-streak/-/longest-streak-3.1.0.tgz#62fa67cd958742a1574af9f39866364102d90cd4" + integrity sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g== + +loose-envify@^1.0.0, loose-envify@^1.2.0, loose-envify@^1.3.1, loose-envify@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/loose-envify/-/loose-envify-1.4.0.tgz#71ee51fa7be4caec1a63839f7e682d8132d30caf" + integrity sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q== + dependencies: + js-tokens "^3.0.0 || ^4.0.0" + +lower-case@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/lower-case/-/lower-case-2.0.2.tgz#6fa237c63dbdc4a82ca0fd882e4722dc5e634e28" + integrity sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg== + dependencies: + tslib "^2.0.3" + +lowercase-keys@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-3.0.0.tgz#c5e7d442e37ead247ae9db117a9d0a467c89d4f2" + integrity sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ== + +lru-cache@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-5.1.1.tgz#1da27e6710271947695daf6848e847f01d84b920" + integrity sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w== + dependencies: + yallist "^3.0.2" + +markdown-extensions@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/markdown-extensions/-/markdown-extensions-2.0.0.tgz#34bebc83e9938cae16e0e017e4a9814a8330d3c4" + integrity sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q== + +markdown-table@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-2.0.0.tgz#194a90ced26d31fe753d8b9434430214c011865b" + integrity sha512-Ezda85ToJUBhM6WGaG6veasyym+Tbs3cMAw/ZhOPqXiYsr0jgocBV3j3nx+4lk47plLlIqjwuTm/ywVI+zjJ/A== + dependencies: + repeat-string "^1.0.0" + +markdown-table@^3.0.0: + version "3.0.4" + resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-3.0.4.tgz#fe44d6d410ff9d6f2ea1797a3f60aa4d2b631c2a" + integrity sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw== + +math-intrinsics@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/math-intrinsics/-/math-intrinsics-1.1.0.tgz#a0dd74be81e2aa5c2f27e65ce283605ee4e2b7f9" + integrity sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g== + +mdast-util-directive@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/mdast-util-directive/-/mdast-util-directive-3.1.0.tgz#f3656f4aab6ae3767d3c72cfab5e8055572ccba1" + integrity sha512-I3fNFt+DHmpWCYAT7quoM6lHf9wuqtI+oCOfvILnoicNIqjh5E3dEJWiXuYME2gNe8vl1iMQwyUHa7bgFmak6Q== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + ccount "^2.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + parse-entities "^4.0.0" + stringify-entities "^4.0.0" + unist-util-visit-parents "^6.0.0" + +mdast-util-find-and-replace@^3.0.0, mdast-util-find-and-replace@^3.0.1: + version "3.0.2" + resolved "https://registry.yarnpkg.com/mdast-util-find-and-replace/-/mdast-util-find-and-replace-3.0.2.tgz#70a3174c894e14df722abf43bc250cbae44b11df" + integrity sha512-Tmd1Vg/m3Xz43afeNxDIhWRtFZgM2VLyaf4vSTYwudTyeuTneoL3qtWMA5jeLyz/O1vDJmmV4QuScFCA2tBPwg== + dependencies: + "@types/mdast" "^4.0.0" + escape-string-regexp "^5.0.0" + unist-util-is "^6.0.0" + unist-util-visit-parents "^6.0.0" + +mdast-util-from-markdown@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.2.tgz#4850390ca7cf17413a9b9a0fbefcd1bc0eb4160a" + integrity sha512-uZhTV/8NBuw0WHkPTrCqDOl0zVe1BIng5ZtHoDk49ME1qqcjYmmLmOf0gELgcRMxN4w2iuIeVso5/6QymSrgmA== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + decode-named-character-reference "^1.0.0" + devlop "^1.0.0" + mdast-util-to-string "^4.0.0" + micromark "^4.0.0" + micromark-util-decode-numeric-character-reference "^2.0.0" + micromark-util-decode-string "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + unist-util-stringify-position "^4.0.0" + +mdast-util-frontmatter@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-frontmatter/-/mdast-util-frontmatter-2.0.1.tgz#f5f929eb1eb36c8a7737475c7eb438261f964ee8" + integrity sha512-LRqI9+wdgC25P0URIJY9vwocIzCcksduHQ9OF2joxQoyTNVduwLAFUzjoopuRJbJAReaKrNQKAZKL3uCMugWJA== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + escape-string-regexp "^5.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + micromark-extension-frontmatter "^2.0.0" + +mdast-util-gfm-autolink-literal@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-gfm-autolink-literal/-/mdast-util-gfm-autolink-literal-2.0.1.tgz#abd557630337bd30a6d5a4bd8252e1c2dc0875d5" + integrity sha512-5HVP2MKaP6L+G6YaxPNjuL0BPrq9orG3TsrZ9YXbA3vDw/ACI4MEsnoDpn6ZNm7GnZgtAcONJyPhOP8tNJQavQ== + dependencies: + "@types/mdast" "^4.0.0" + ccount "^2.0.0" + devlop "^1.0.0" + mdast-util-find-and-replace "^3.0.0" + micromark-util-character "^2.0.0" + +mdast-util-gfm-footnote@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-2.1.0.tgz#7778e9d9ca3df7238cc2bd3fa2b1bf6a65b19403" + integrity sha512-sqpDWlsHn7Ac9GNZQMeUzPQSMzR6Wv0WKRNvQRg0KqHh02fpTz69Qc1QSseNX29bhz1ROIyNyxExfawVKTm1GQ== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.1.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + +mdast-util-gfm-strikethrough@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-gfm-strikethrough/-/mdast-util-gfm-strikethrough-2.0.0.tgz#d44ef9e8ed283ac8c1165ab0d0dfd058c2764c16" + integrity sha512-mKKb915TF+OC5ptj5bJ7WFRPdYtuHv0yTRxK2tJvi+BDqbkiG7h7u/9SI89nRAYcmap2xHQL9D+QG/6wSrTtXg== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-gfm-table@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-gfm-table/-/mdast-util-gfm-table-2.0.0.tgz#7a435fb6223a72b0862b33afbd712b6dae878d38" + integrity sha512-78UEvebzz/rJIxLvE7ZtDd/vIQ0RHv+3Mh5DR96p7cS7HsBhYIICDBCu8csTNWNO6tBWfqXPWekRuj2FNOGOZg== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + markdown-table "^3.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-gfm-task-list-item@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-gfm-task-list-item/-/mdast-util-gfm-task-list-item-2.0.0.tgz#e68095d2f8a4303ef24094ab642e1047b991a936" + integrity sha512-IrtvNvjxC1o06taBAVJznEnkiHxLFTzgonUdy8hzFVeDun0uTjxxrRGVaNFqkU1wJR3RBPEfsxmU6jDWPofrTQ== + dependencies: + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-gfm@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/mdast-util-gfm/-/mdast-util-gfm-3.1.0.tgz#2cdf63b92c2a331406b0fb0db4c077c1b0331751" + integrity sha512-0ulfdQOM3ysHhCJ1p06l0b0VKlhU0wuQs3thxZQagjcjPrlFRqY215uZGHHJan9GEAXd9MbfPjFJz+qMkVR6zQ== + dependencies: + mdast-util-from-markdown "^2.0.0" + mdast-util-gfm-autolink-literal "^2.0.0" + mdast-util-gfm-footnote "^2.0.0" + mdast-util-gfm-strikethrough "^2.0.0" + mdast-util-gfm-table "^2.0.0" + mdast-util-gfm-task-list-item "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-mdx-expression@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.1.tgz#43f0abac9adc756e2086f63822a38c8d3c3a5096" + integrity sha512-J6f+9hUp+ldTZqKRSg7Vw5V6MqjATc+3E4gf3CFNcuZNWD8XdyI6zQ8GqH7f8169MM6P7hMBRDVGnn7oHB9kXQ== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-mdx-jsx@^3.0.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/mdast-util-mdx-jsx/-/mdast-util-mdx-jsx-3.2.0.tgz#fd04c67a2a7499efb905a8a5c578dddc9fdada0d" + integrity sha512-lj/z8v0r6ZtsN/cGNNtemmmfoLAFZnjMbNyLzBafjzikOM+glrjNHPlf6lQDOTccj9n5b0PPihEBbhneMyGs1Q== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + ccount "^2.0.0" + devlop "^1.1.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + parse-entities "^4.0.0" + stringify-entities "^4.0.0" + unist-util-stringify-position "^4.0.0" + vfile-message "^4.0.0" + +mdast-util-mdx@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-mdx/-/mdast-util-mdx-3.0.0.tgz#792f9cf0361b46bee1fdf1ef36beac424a099c41" + integrity sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w== + dependencies: + mdast-util-from-markdown "^2.0.0" + mdast-util-mdx-expression "^2.0.0" + mdast-util-mdx-jsx "^3.0.0" + mdast-util-mdxjs-esm "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-mdxjs-esm@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mdast-util-mdxjs-esm/-/mdast-util-mdxjs-esm-2.0.1.tgz#019cfbe757ad62dd557db35a695e7314bcc9fa97" + integrity sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg== + dependencies: + "@types/estree-jsx" "^1.0.0" + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + devlop "^1.0.0" + mdast-util-from-markdown "^2.0.0" + mdast-util-to-markdown "^2.0.0" + +mdast-util-phrasing@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/mdast-util-phrasing/-/mdast-util-phrasing-4.1.0.tgz#7cc0a8dec30eaf04b7b1a9661a92adb3382aa6e3" + integrity sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w== + dependencies: + "@types/mdast" "^4.0.0" + unist-util-is "^6.0.0" + +mdast-util-to-hast@^13.0.0: + version "13.2.0" + resolved "https://registry.yarnpkg.com/mdast-util-to-hast/-/mdast-util-to-hast-13.2.0.tgz#5ca58e5b921cc0a3ded1bc02eed79a4fe4fe41f4" + integrity sha512-QGYKEuUsYT9ykKBCMOEDLsU5JRObWQusAolFMeko/tYPufNkRffBAQjIE+99jbA87xv6FgmjLtwjh9wBWajwAA== + dependencies: + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + "@ungap/structured-clone" "^1.0.0" + devlop "^1.0.0" + micromark-util-sanitize-uri "^2.0.0" + trim-lines "^3.0.0" + unist-util-position "^5.0.0" + unist-util-visit "^5.0.0" + vfile "^6.0.0" + +mdast-util-to-markdown@^2.0.0: + version "2.1.2" + resolved "https://registry.yarnpkg.com/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.2.tgz#f910ffe60897f04bb4b7e7ee434486f76288361b" + integrity sha512-xj68wMTvGXVOKonmog6LwyJKrYXZPvlwabaryTjLh9LuvovB/KAH+kvi8Gjj+7rJjsFi23nkUxRQv1KqSroMqA== + dependencies: + "@types/mdast" "^4.0.0" + "@types/unist" "^3.0.0" + longest-streak "^3.0.0" + mdast-util-phrasing "^4.0.0" + mdast-util-to-string "^4.0.0" + micromark-util-classify-character "^2.0.0" + micromark-util-decode-string "^2.0.0" + unist-util-visit "^5.0.0" + zwitch "^2.0.0" + +mdast-util-to-string@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz#7a5121475556a04e7eddeb67b264aae79d312814" + integrity sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg== + dependencies: + "@types/mdast" "^4.0.0" + +mdn-data@2.0.28: + version "2.0.28" + resolved "https://registry.yarnpkg.com/mdn-data/-/mdn-data-2.0.28.tgz#5ec48e7bef120654539069e1ae4ddc81ca490eba" + integrity sha512-aylIc7Z9y4yzHYAJNuESG3hfhC+0Ibp/MAMiaOZgNv4pmEdFyfZhhhny4MNiAfWdBQ1RQ2mfDWmM1x8SvGyp8g== + +mdn-data@2.0.30: + version "2.0.30" + resolved "https://registry.yarnpkg.com/mdn-data/-/mdn-data-2.0.30.tgz#ce4df6f80af6cfbe218ecd5c552ba13c4dfa08cc" + integrity sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA== + +media-typer@0.3.0: + version "0.3.0" + resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748" + integrity sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ== + +memfs@^3.4.3: + version "3.6.0" + resolved "https://registry.yarnpkg.com/memfs/-/memfs-3.6.0.tgz#d7a2110f86f79dd950a8b6df6d57bc984aa185f6" + integrity sha512-EGowvkkgbMcIChjMTMkESFDbZeSh8xZ7kNSF0hAiAN4Jh6jgHCRS0Ga/+C8y6Au+oqpezRHCfPsmJ2+DwAgiwQ== + dependencies: + fs-monkey "^1.0.4" + +merge-descriptors@1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/merge-descriptors/-/merge-descriptors-1.0.3.tgz#d80319a65f3c7935351e5cfdac8f9318504dbed5" + integrity sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ== + +merge-stream@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60" + integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== + +merge2@^1.3.0, merge2@^1.4.1: + version "1.4.1" + resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" + integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== + +methods@~1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/methods/-/methods-1.1.2.tgz#5529a4d67654134edcc5266656835b0f851afcee" + integrity sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w== + +micromark-core-commonmark@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz#c691630e485021a68cf28dbc2b2ca27ebf678cd4" + integrity sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg== + dependencies: + decode-named-character-reference "^1.0.0" + devlop "^1.0.0" + micromark-factory-destination "^2.0.0" + micromark-factory-label "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-factory-title "^2.0.0" + micromark-factory-whitespace "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-classify-character "^2.0.0" + micromark-util-html-tag-name "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-resolve-all "^2.0.0" + micromark-util-subtokenize "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-directive@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/micromark-extension-directive/-/micromark-extension-directive-3.0.2.tgz#2eb61985d1995a7c1ff7621676a4f32af29409e8" + integrity sha512-wjcXHgk+PPdmvR58Le9d7zQYWy+vKEU9Se44p2CrCDPiLr2FMyiT4Fyb5UFKFC66wGB3kPlgD7q3TnoqPS7SZA== + dependencies: + devlop "^1.0.0" + micromark-factory-space "^2.0.0" + micromark-factory-whitespace "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + parse-entities "^4.0.0" + +micromark-extension-frontmatter@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-frontmatter/-/micromark-extension-frontmatter-2.0.0.tgz#651c52ffa5d7a8eeed687c513cd869885882d67a" + integrity sha512-C4AkuM3dA58cgZha7zVnuVxBhDsbttIMiytjgsM2XbHAB2faRVaHRle40558FBN+DJcrLNCoqG5mlrpdU4cRtg== + dependencies: + fault "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm-autolink-literal@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-autolink-literal/-/micromark-extension-gfm-autolink-literal-2.1.0.tgz#6286aee9686c4462c1e3552a9d505feddceeb935" + integrity sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-sanitize-uri "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm-footnote@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-footnote/-/micromark-extension-gfm-footnote-2.1.0.tgz#4dab56d4e398b9853f6fe4efac4fc9361f3e0750" + integrity sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw== + dependencies: + devlop "^1.0.0" + micromark-core-commonmark "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-sanitize-uri "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm-strikethrough@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-strikethrough/-/micromark-extension-gfm-strikethrough-2.1.0.tgz#86106df8b3a692b5f6a92280d3879be6be46d923" + integrity sha512-ADVjpOOkjz1hhkZLlBiYA9cR2Anf8F4HqZUO6e5eDcPQd0Txw5fxLzzxnEkSkfnD0wziSGiv7sYhk/ktvbf1uw== + dependencies: + devlop "^1.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-classify-character "^2.0.0" + micromark-util-resolve-all "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm-table@^2.0.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.1.tgz#fac70bcbf51fe65f5f44033118d39be8a9b5940b" + integrity sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg== + dependencies: + devlop "^1.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm-tagfilter@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-tagfilter/-/micromark-extension-gfm-tagfilter-2.0.0.tgz#f26d8a7807b5985fba13cf61465b58ca5ff7dc57" + integrity sha512-xHlTOmuCSotIA8TW1mDIM6X2O1SiX5P9IuDtqGonFhEK0qgRI4yeC6vMxEV2dgyr2TiD+2PQ10o+cOhdVAcwfg== + dependencies: + micromark-util-types "^2.0.0" + +micromark-extension-gfm-task-list-item@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm-task-list-item/-/micromark-extension-gfm-task-list-item-2.1.0.tgz#bcc34d805639829990ec175c3eea12bb5b781f2c" + integrity sha512-qIBZhqxqI6fjLDYFTBIa4eivDMnP+OZqsNwmQ3xNLE4Cxwc+zfQEfbs6tzAo2Hjq+bh6q5F+Z8/cksrLFYWQQw== + dependencies: + devlop "^1.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-gfm@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-gfm/-/micromark-extension-gfm-3.0.0.tgz#3e13376ab95dd7a5cfd0e29560dfe999657b3c5b" + integrity sha512-vsKArQsicm7t0z2GugkCKtZehqUm31oeGBV/KVSorWSy8ZlNAv7ytjFhvaryUiCUJYqs+NoE6AFhpQvBTM6Q4w== + dependencies: + micromark-extension-gfm-autolink-literal "^2.0.0" + micromark-extension-gfm-footnote "^2.0.0" + micromark-extension-gfm-strikethrough "^2.0.0" + micromark-extension-gfm-table "^2.0.0" + micromark-extension-gfm-tagfilter "^2.0.0" + micromark-extension-gfm-task-list-item "^2.0.0" + micromark-util-combine-extensions "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-mdx-expression@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/micromark-extension-mdx-expression/-/micromark-extension-mdx-expression-3.0.1.tgz#43d058d999532fb3041195a3c3c05c46fa84543b" + integrity sha512-dD/ADLJ1AeMvSAKBwO22zG22N4ybhe7kFIZ3LsDI0GlsNr2A3KYxb0LdC1u5rj4Nw+CHKY0RVdnHX8vj8ejm4Q== + dependencies: + "@types/estree" "^1.0.0" + devlop "^1.0.0" + micromark-factory-mdx-expression "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-events-to-acorn "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-extension-mdx-jsx@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/micromark-extension-mdx-jsx/-/micromark-extension-mdx-jsx-3.0.2.tgz#ffc98bdb649798902fa9fc5689f67f9c1c902044" + integrity sha512-e5+q1DjMh62LZAJOnDraSSbDMvGJ8x3cbjygy2qFEi7HCeUT4BDKCvMozPozcD6WmOt6sVvYDNBKhFSz3kjOVQ== + dependencies: + "@types/estree" "^1.0.0" + devlop "^1.0.0" + estree-util-is-identifier-name "^3.0.0" + micromark-factory-mdx-expression "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-events-to-acorn "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + vfile-message "^4.0.0" + +micromark-extension-mdx-md@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-mdx-md/-/micromark-extension-mdx-md-2.0.0.tgz#1d252881ea35d74698423ab44917e1f5b197b92d" + integrity sha512-EpAiszsB3blw4Rpba7xTOUptcFeBFi+6PY8VnJ2hhimH+vCQDirWgsMpz7w1XcZE7LVrSAUGb9VJpG9ghlYvYQ== + dependencies: + micromark-util-types "^2.0.0" + +micromark-extension-mdxjs-esm@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-mdxjs-esm/-/micromark-extension-mdxjs-esm-3.0.0.tgz#de21b2b045fd2059bd00d36746081de38390d54a" + integrity sha512-DJFl4ZqkErRpq/dAPyeWp15tGrcrrJho1hKK5uBS70BCtfrIFg81sqcTVu3Ta+KD1Tk5vAtBNElWxtAa+m8K9A== + dependencies: + "@types/estree" "^1.0.0" + devlop "^1.0.0" + micromark-core-commonmark "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-events-to-acorn "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + unist-util-position-from-estree "^2.0.0" + vfile-message "^4.0.0" + +micromark-extension-mdxjs@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/micromark-extension-mdxjs/-/micromark-extension-mdxjs-3.0.0.tgz#b5a2e0ed449288f3f6f6c544358159557549de18" + integrity sha512-A873fJfhnJ2siZyUrJ31l34Uqwy4xIFmvPY1oj+Ean5PHcPBYzEsvqvWGaWcfEIr11O5Dlw3p2y0tZWpKHDejQ== + dependencies: + acorn "^8.0.0" + acorn-jsx "^5.0.0" + micromark-extension-mdx-expression "^3.0.0" + micromark-extension-mdx-jsx "^3.0.0" + micromark-extension-mdx-md "^2.0.0" + micromark-extension-mdxjs-esm "^3.0.0" + micromark-util-combine-extensions "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-destination@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-factory-destination/-/micromark-factory-destination-2.0.1.tgz#8fef8e0f7081f0474fbdd92deb50c990a0264639" + integrity sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-label@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-factory-label/-/micromark-factory-label-2.0.1.tgz#5267efa97f1e5254efc7f20b459a38cb21058ba1" + integrity sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg== + dependencies: + devlop "^1.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-mdx-expression@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/micromark-factory-mdx-expression/-/micromark-factory-mdx-expression-2.0.3.tgz#bb09988610589c07d1c1e4425285895041b3dfa9" + integrity sha512-kQnEtA3vzucU2BkrIa8/VaSAsP+EJ3CKOvhMuJgOEGg9KDC6OAY6nSnNDVRiVNRqj7Y4SlSzcStaH/5jge8JdQ== + dependencies: + "@types/estree" "^1.0.0" + devlop "^1.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-events-to-acorn "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + unist-util-position-from-estree "^2.0.0" + vfile-message "^4.0.0" + +micromark-factory-space@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/micromark-factory-space/-/micromark-factory-space-1.1.0.tgz#c8f40b0640a0150751d3345ed885a080b0d15faf" + integrity sha512-cRzEj7c0OL4Mw2v6nwzttyOZe8XY/Z8G0rzmWQZTBi/jjwyw/U4uqKtUORXQrR5bAZZnbTI/feRV/R7hc4jQYQ== + dependencies: + micromark-util-character "^1.0.0" + micromark-util-types "^1.0.0" + +micromark-factory-space@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz#36d0212e962b2b3121f8525fc7a3c7c029f334fc" + integrity sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-title@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-factory-title/-/micromark-factory-title-2.0.1.tgz#237e4aa5d58a95863f01032d9ee9b090f1de6e94" + integrity sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw== + dependencies: + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-factory-whitespace@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.1.tgz#06b26b2983c4d27bfcc657b33e25134d4868b0b1" + integrity sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ== + dependencies: + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-character@^1.0.0, micromark-util-character@^1.1.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/micromark-util-character/-/micromark-util-character-1.2.0.tgz#4fedaa3646db249bc58caeb000eb3549a8ca5dcc" + integrity sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg== + dependencies: + micromark-util-symbol "^1.0.0" + micromark-util-types "^1.0.0" + +micromark-util-character@^2.0.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/micromark-util-character/-/micromark-util-character-2.1.1.tgz#2f987831a40d4c510ac261e89852c4e9703ccda6" + integrity sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q== + dependencies: + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-chunked@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-chunked/-/micromark-util-chunked-2.0.1.tgz#47fbcd93471a3fccab86cff03847fc3552db1051" + integrity sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA== + dependencies: + micromark-util-symbol "^2.0.0" + +micromark-util-classify-character@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-classify-character/-/micromark-util-classify-character-2.0.1.tgz#d399faf9c45ca14c8b4be98b1ea481bced87b629" + integrity sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-combine-extensions@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.1.tgz#2a0f490ab08bff5cc2fd5eec6dd0ca04f89b30a9" + integrity sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg== + dependencies: + micromark-util-chunked "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-decode-numeric-character-reference@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.2.tgz#fcf15b660979388e6f118cdb6bf7d79d73d26fe5" + integrity sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw== + dependencies: + micromark-util-symbol "^2.0.0" + +micromark-util-decode-string@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-decode-string/-/micromark-util-decode-string-2.0.1.tgz#6cb99582e5d271e84efca8e61a807994d7161eb2" + integrity sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ== + dependencies: + decode-named-character-reference "^1.0.0" + micromark-util-character "^2.0.0" + micromark-util-decode-numeric-character-reference "^2.0.0" + micromark-util-symbol "^2.0.0" + +micromark-util-encode@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz#0d51d1c095551cfaac368326963cf55f15f540b8" + integrity sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw== + +micromark-util-events-to-acorn@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/micromark-util-events-to-acorn/-/micromark-util-events-to-acorn-2.0.3.tgz#e7a8a6b55a47e5a06c720d5a1c4abae8c37c98f3" + integrity sha512-jmsiEIiZ1n7X1Rr5k8wVExBQCg5jy4UXVADItHmNk1zkwEVhBuIUKRu3fqv+hs4nxLISi2DQGlqIOGiFxgbfHg== + dependencies: + "@types/estree" "^1.0.0" + "@types/unist" "^3.0.0" + devlop "^1.0.0" + estree-util-visit "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + vfile-message "^4.0.0" + +micromark-util-html-tag-name@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.1.tgz#e40403096481986b41c106627f98f72d4d10b825" + integrity sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA== + +micromark-util-normalize-identifier@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.1.tgz#c30d77b2e832acf6526f8bf1aa47bc9c9438c16d" + integrity sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q== + dependencies: + micromark-util-symbol "^2.0.0" + +micromark-util-resolve-all@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.1.tgz#e1a2d62cdd237230a2ae11839027b19381e31e8b" + integrity sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg== + dependencies: + micromark-util-types "^2.0.0" + +micromark-util-sanitize-uri@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz#ab89789b818a58752b73d6b55238621b7faa8fd7" + integrity sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ== + dependencies: + micromark-util-character "^2.0.0" + micromark-util-encode "^2.0.0" + micromark-util-symbol "^2.0.0" + +micromark-util-subtokenize@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/micromark-util-subtokenize/-/micromark-util-subtokenize-2.1.0.tgz#d8ade5ba0f3197a1cf6a2999fbbfe6357a1a19ee" + integrity sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA== + dependencies: + devlop "^1.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromark-util-symbol@^1.0.0, micromark-util-symbol@^1.0.1: + version "1.1.0" + resolved "https://registry.yarnpkg.com/micromark-util-symbol/-/micromark-util-symbol-1.1.0.tgz#813cd17837bdb912d069a12ebe3a44b6f7063142" + integrity sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag== + +micromark-util-symbol@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz#e5da494e8eb2b071a0d08fb34f6cefec6c0a19b8" + integrity sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q== + +micromark-util-types@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/micromark-util-types/-/micromark-util-types-1.1.0.tgz#e6676a8cae0bb86a2171c498167971886cb7e283" + integrity sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg== + +micromark-util-types@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/micromark-util-types/-/micromark-util-types-2.0.2.tgz#f00225f5f5a0ebc3254f96c36b6605c4b393908e" + integrity sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA== + +micromark@^4.0.0: + version "4.0.2" + resolved "https://registry.yarnpkg.com/micromark/-/micromark-4.0.2.tgz#91395a3e1884a198e62116e33c9c568e39936fdb" + integrity sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA== + dependencies: + "@types/debug" "^4.0.0" + debug "^4.0.0" + decode-named-character-reference "^1.0.0" + devlop "^1.0.0" + micromark-core-commonmark "^2.0.0" + micromark-factory-space "^2.0.0" + micromark-util-character "^2.0.0" + micromark-util-chunked "^2.0.0" + micromark-util-combine-extensions "^2.0.0" + micromark-util-decode-numeric-character-reference "^2.0.0" + micromark-util-encode "^2.0.0" + micromark-util-normalize-identifier "^2.0.0" + micromark-util-resolve-all "^2.0.0" + micromark-util-sanitize-uri "^2.0.0" + micromark-util-subtokenize "^2.0.0" + micromark-util-symbol "^2.0.0" + micromark-util-types "^2.0.0" + +micromatch@^4.0.2, micromatch@^4.0.5, micromatch@^4.0.8: + version "4.0.8" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.8.tgz#d66fa18f3a47076789320b9b1af32bd86d9fa202" + integrity sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA== + dependencies: + braces "^3.0.3" + picomatch "^2.3.1" + +mime-db@1.52.0: + version "1.52.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70" + integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg== + +"mime-db@>= 1.43.0 < 2": + version "1.54.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.54.0.tgz#cddb3ee4f9c64530dff640236661d42cb6a314f5" + integrity sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ== + +mime-db@~1.33.0: + version "1.33.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.33.0.tgz#a3492050a5cb9b63450541e39d9788d2272783db" + integrity sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ== + +mime-types@2.1.18: + version "2.1.18" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.18.tgz#6f323f60a83d11146f831ff11fd66e2fe5503bb8" + integrity sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ== + dependencies: + mime-db "~1.33.0" + +mime-types@^2.1.27, mime-types@^2.1.31, mime-types@~2.1.17, mime-types@~2.1.24, mime-types@~2.1.34: + version "2.1.35" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.35.tgz#381a871b62a734450660ae3deee44813f70d959a" + integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== + dependencies: + mime-db "1.52.0" + +mime@1.6.0: + version "1.6.0" + resolved "https://registry.yarnpkg.com/mime/-/mime-1.6.0.tgz#32cd9e5c64553bd58d19a568af452acff04981b1" + integrity sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg== + +mimic-fn@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" + integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== + +mimic-response@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-3.1.0.tgz#2d1d59af9c1b129815accc2c46a022a5ce1fa3c9" + integrity sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ== + +mimic-response@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-4.0.0.tgz#35468b19e7c75d10f5165ea25e75a5ceea7cf70f" + integrity sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg== + +mini-css-extract-plugin@^2.9.2: + version "2.9.4" + resolved "https://registry.yarnpkg.com/mini-css-extract-plugin/-/mini-css-extract-plugin-2.9.4.tgz#cafa1a42f8c71357f49cd1566810d74ff1cb0200" + integrity sha512-ZWYT7ln73Hptxqxk2DxPU9MmapXRhxkJD6tkSR04dnQxm8BGu2hzgKLugK5yySD97u/8yy7Ma7E76k9ZdvtjkQ== + dependencies: + schema-utils "^4.0.0" + tapable "^2.2.1" + +minimalistic-assert@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz#2e194de044626d4a10e7f7fbc00ce73e83e4d5c7" + integrity sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A== + +minimatch@3.1.2, minimatch@^3.1.1: + version "3.1.2" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b" + integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw== + dependencies: + brace-expansion "^1.1.7" + +minimist@^1.2.0: + version "1.2.8" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" + integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== + +mrmime@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/mrmime/-/mrmime-2.0.1.tgz#bc3e87f7987853a54c9850eeb1f1078cd44adddc" + integrity sha512-Y3wQdFg2Va6etvQ5I82yUhGdsKrcYox6p7FfL1LbK2J4V01F9TGlepTIhnK24t7koZibmg82KGglhA1XK5IsLQ== + +ms@2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8" + integrity sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A== + +ms@2.1.3, ms@^2.1.3: + version "2.1.3" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.3.tgz#574c8138ce1d2b5861f0b44579dbadd60c6615b2" + integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== + +multicast-dns@^7.2.5: + version "7.2.5" + resolved "https://registry.yarnpkg.com/multicast-dns/-/multicast-dns-7.2.5.tgz#77eb46057f4d7adbd16d9290fa7299f6fa64cced" + integrity sha512-2eznPJP8z2BFLX50tf0LuODrpINqP1RVIm/CObbTcBRITQgmC/TjcREF1NeTBzIcR5XO/ukWo+YHOjBbFwIupg== + dependencies: + dns-packet "^5.2.2" + thunky "^1.0.2" + +nanoid@^3.3.11: + version "3.3.11" + resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.11.tgz#4f4f112cefbe303202f2199838128936266d185b" + integrity sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w== + +negotiator@0.6.3: + version "0.6.3" + resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.3.tgz#58e323a72fedc0d6f9cd4d31fe49f51479590ccd" + integrity sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg== + +negotiator@~0.6.4: + version "0.6.4" + resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.4.tgz#777948e2452651c570b712dd01c23e262713fff7" + integrity sha512-myRT3DiWPHqho5PrJaIRyaMv2kgYf0mUVgBNOYMuCH5Ki1yEiQaf/ZJuQ62nvpc44wL5WDbTX7yGJi1Neevw8w== + +neo-async@^2.6.2: + version "2.6.2" + resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f" + integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw== + +no-case@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/no-case/-/no-case-3.0.4.tgz#d361fd5c9800f558551a8369fc0dcd4662b6124d" + integrity sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg== + dependencies: + lower-case "^2.0.2" + tslib "^2.0.3" + +node-emoji@^2.1.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/node-emoji/-/node-emoji-2.2.0.tgz#1d000e3c76e462577895be1b436f4aa2d6760eb0" + integrity sha512-Z3lTE9pLaJF47NyMhd4ww1yFTAP8YhYI8SleJiHzM46Fgpm5cnNzSl9XfzFNqbaz+VlJrIj3fXQ4DeN1Rjm6cw== + dependencies: + "@sindresorhus/is" "^4.6.0" + char-regex "^1.0.2" + emojilib "^2.4.0" + skin-tone "^2.0.0" + +node-forge@^1: + version "1.3.1" + resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.1.tgz#be8da2af243b2417d5f646a770663a92b7e9ded3" + integrity sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA== + +node-releases@^2.0.21: + version "2.0.21" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.21.tgz#f59b018bc0048044be2d4c4c04e4c8b18160894c" + integrity sha512-5b0pgg78U3hwXkCM8Z9b2FJdPZlr9Psr9V2gQPESdGHqbntyFJKFW4r5TeWGFzafGY3hzs1JC62VEQMbl1JFkw== + +normalize-path@^3.0.0, normalize-path@~3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65" + integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA== + +normalize-range@^0.1.2: + version "0.1.2" + resolved "https://registry.yarnpkg.com/normalize-range/-/normalize-range-0.1.2.tgz#2d10c06bdfd312ea9777695a4d28439456b75942" + integrity sha512-bdok/XvKII3nUpklnV6P2hxtMNrCboOjAcyBuQnWEhO665FwrSNRxU+AqpsyvO6LgGYPspN+lu5CLtw4jPRKNA== + +normalize-url@^8.0.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-8.1.0.tgz#d33504f67970decf612946fd4880bc8c0983486d" + integrity sha512-X06Mfd/5aKsRHc0O0J5CUedwnPmnDtLF2+nq+KN9KSDlJHkPuh0JUviWjEWMe0SW/9TDdSLVPuk7L5gGTIA1/w== + +npm-run-path@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-4.0.1.tgz#b7ecd1e5ed53da8e37a55e1c2269e0b97ed748ea" + integrity sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw== + dependencies: + path-key "^3.0.0" + +nprogress@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/nprogress/-/nprogress-0.2.0.tgz#cb8f34c53213d895723fcbab907e9422adbcafb1" + integrity sha512-I19aIingLgR1fmhftnbWWO3dXc0hSxqHQHQb3H8m+K3TnEn/iSeTZZOyvKXWqQESMwuUVnatlCnZdLBZZt2VSA== + +nth-check@^2.0.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/nth-check/-/nth-check-2.1.1.tgz#c9eab428effce36cd6b92c924bdb000ef1f1ed1d" + integrity sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w== + dependencies: + boolbase "^1.0.0" + +null-loader@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/null-loader/-/null-loader-4.0.1.tgz#8e63bd3a2dd3c64236a4679428632edd0a6dbc6a" + integrity sha512-pxqVbi4U6N26lq+LmgIbB5XATP0VdZKOG25DhHi8btMmJJefGArFyDg1yc4U3hWCJbMqSrw0qyrz1UQX+qYXqg== + dependencies: + loader-utils "^2.0.0" + schema-utils "^3.0.0" + +object-assign@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863" + integrity sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg== + +object-inspect@^1.13.3: + version "1.13.4" + resolved "https://registry.yarnpkg.com/object-inspect/-/object-inspect-1.13.4.tgz#8375265e21bc20d0fa582c22e1b13485d6e00213" + integrity sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew== + +object-keys@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/object-keys/-/object-keys-1.1.1.tgz#1c47f272df277f3b1daf061677d9c82e2322c60e" + integrity sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA== + +object.assign@^4.1.0: + version "4.1.7" + resolved "https://registry.yarnpkg.com/object.assign/-/object.assign-4.1.7.tgz#8c14ca1a424c6a561b0bb2a22f66f5049a945d3d" + integrity sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw== + dependencies: + call-bind "^1.0.8" + call-bound "^1.0.3" + define-properties "^1.2.1" + es-object-atoms "^1.0.0" + has-symbols "^1.1.0" + object-keys "^1.1.1" + +obuf@^1.0.0, obuf@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/obuf/-/obuf-1.1.2.tgz#09bea3343d41859ebd446292d11c9d4db619084e" + integrity sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg== + +on-finished@2.4.1: + version "2.4.1" + resolved "https://registry.yarnpkg.com/on-finished/-/on-finished-2.4.1.tgz#58c8c44116e54845ad57f14ab10b03533184ac3f" + integrity sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg== + dependencies: + ee-first "1.1.1" + +on-headers@~1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/on-headers/-/on-headers-1.1.0.tgz#59da4f91c45f5f989c6e4bcedc5a3b0aed70ff65" + integrity sha512-737ZY3yNnXy37FHkQxPzt4UZ2UWPWiCZWLvFZ4fu5cueciegX0zGPnrlY6bwRg4FdQOe9YU8MkmJwGhoMybl8A== + +once@^1.3.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== + dependencies: + wrappy "1" + +onetime@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/onetime/-/onetime-5.1.2.tgz#d0e96ebb56b07476df1dd9c4806e5237985ca45e" + integrity sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg== + dependencies: + mimic-fn "^2.1.0" + +open@^8.0.9, open@^8.4.0: + version "8.4.2" + resolved "https://registry.yarnpkg.com/open/-/open-8.4.2.tgz#5b5ffe2a8f793dcd2aad73e550cb87b59cb084f9" + integrity sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ== + dependencies: + define-lazy-prop "^2.0.0" + is-docker "^2.1.1" + is-wsl "^2.2.0" + +opener@^1.5.2: + version "1.5.2" + resolved "https://registry.yarnpkg.com/opener/-/opener-1.5.2.tgz#5d37e1f35077b9dcac4301372271afdeb2a13598" + integrity sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A== + +p-cancelable@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/p-cancelable/-/p-cancelable-3.0.0.tgz#63826694b54d61ca1c20ebcb6d3ecf5e14cd8050" + integrity sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw== + +p-finally@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/p-finally/-/p-finally-1.0.0.tgz#3fbcfb15b899a44123b34b6dcc18b724336a2cae" + integrity sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow== + +p-limit@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-4.0.0.tgz#914af6544ed32bfa54670b061cafcbd04984b644" + integrity sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ== + dependencies: + yocto-queue "^1.0.0" + +p-locate@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-6.0.0.tgz#3da9a49d4934b901089dca3302fa65dc5a05c04f" + integrity sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw== + dependencies: + p-limit "^4.0.0" + +p-map@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/p-map/-/p-map-4.0.0.tgz#bb2f95a5eda2ec168ec9274e06a747c3e2904d2b" + integrity sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ== + dependencies: + aggregate-error "^3.0.0" + +p-queue@^6.6.2: + version "6.6.2" + resolved "https://registry.yarnpkg.com/p-queue/-/p-queue-6.6.2.tgz#2068a9dcf8e67dd0ec3e7a2bcb76810faa85e426" + integrity sha512-RwFpb72c/BhQLEXIZ5K2e+AhgNVmIejGlTgiB9MzZ0e93GRvqZ7uSi0dvRF7/XIXDeNkra2fNHBxTyPDGySpjQ== + dependencies: + eventemitter3 "^4.0.4" + p-timeout "^3.2.0" + +p-retry@^4.5.0: + version "4.6.2" + resolved "https://registry.yarnpkg.com/p-retry/-/p-retry-4.6.2.tgz#9baae7184057edd4e17231cee04264106e092a16" + integrity sha512-312Id396EbJdvRONlngUx0NydfrIQ5lsYu0znKVUzVvArzEIt08V1qhtyESbGVd1FGX7UKtiFp5uwKZdM8wIuQ== + dependencies: + "@types/retry" "0.12.0" + retry "^0.13.1" + +p-timeout@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/p-timeout/-/p-timeout-3.2.0.tgz#c7e17abc971d2a7962ef83626b35d635acf23dfe" + integrity sha512-rhIwUycgwwKcP9yTOOFK/AKsAopjjCakVqLHePO3CC6Mir1Z99xT+R63jZxAT5lFZLa2inS5h+ZS2GvR99/FBg== + dependencies: + p-finally "^1.0.0" + +package-json@^8.1.0: + version "8.1.1" + resolved "https://registry.yarnpkg.com/package-json/-/package-json-8.1.1.tgz#3e9948e43df40d1e8e78a85485f1070bf8f03dc8" + integrity sha512-cbH9IAIJHNj9uXi196JVsRlt7cHKak6u/e6AkL/bkRelZ7rlL3X1YKxsZwa36xipOEKAsdtmaG6aAJoM1fx2zA== + dependencies: + got "^12.1.0" + registry-auth-token "^5.0.1" + registry-url "^6.0.0" + semver "^7.3.7" + +param-case@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/param-case/-/param-case-3.0.4.tgz#7d17fe4aa12bde34d4a77d91acfb6219caad01c5" + integrity sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A== + dependencies: + dot-case "^3.0.4" + tslib "^2.0.3" + +parent-module@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/parent-module/-/parent-module-1.0.1.tgz#691d2709e78c79fae3a156622452d00762caaaa2" + integrity sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g== + dependencies: + callsites "^3.0.0" + +parse-entities@^4.0.0: + version "4.0.2" + resolved "https://registry.yarnpkg.com/parse-entities/-/parse-entities-4.0.2.tgz#61d46f5ed28e4ee62e9ddc43d6b010188443f159" + integrity sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw== + dependencies: + "@types/unist" "^2.0.0" + character-entities-legacy "^3.0.0" + character-reference-invalid "^2.0.0" + decode-named-character-reference "^1.0.0" + is-alphanumerical "^2.0.0" + is-decimal "^2.0.0" + is-hexadecimal "^2.0.0" + +parse-json@^5.0.0, parse-json@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/parse-json/-/parse-json-5.2.0.tgz#c76fc66dee54231c962b22bcc8a72cf2f99753cd" + integrity sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg== + dependencies: + "@babel/code-frame" "^7.0.0" + error-ex "^1.3.1" + json-parse-even-better-errors "^2.3.0" + lines-and-columns "^1.1.6" + +parse-numeric-range@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz#7c63b61190d61e4d53a1197f0c83c47bb670ffa3" + integrity sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ== + +parse5-htmlparser2-tree-adapter@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz#b5a806548ed893a43e24ccb42fbb78069311e81b" + integrity sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g== + dependencies: + domhandler "^5.0.3" + parse5 "^7.0.0" + +parse5@^7.0.0: + version "7.3.0" + resolved "https://registry.yarnpkg.com/parse5/-/parse5-7.3.0.tgz#d7e224fa72399c7a175099f45fc2ad024b05ec05" + integrity sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw== + dependencies: + entities "^6.0.0" + +parseurl@~1.3.2, parseurl@~1.3.3: + version "1.3.3" + resolved "https://registry.yarnpkg.com/parseurl/-/parseurl-1.3.3.tgz#9da19e7bee8d12dff0513ed5b76957793bc2e8d4" + integrity sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ== + +pascal-case@^3.1.2: + version "3.1.2" + resolved "https://registry.yarnpkg.com/pascal-case/-/pascal-case-3.1.2.tgz#b48e0ef2b98e205e7c1dae747d0b1508237660eb" + integrity sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g== + dependencies: + no-case "^3.0.4" + tslib "^2.0.3" + +path-exists@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-5.0.0.tgz#a6aad9489200b21fab31e49cf09277e5116fb9e7" + integrity sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ== + +path-is-absolute@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" + integrity sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg== + +path-is-inside@1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/path-is-inside/-/path-is-inside-1.0.2.tgz#365417dede44430d1c11af61027facf074bdfc53" + integrity sha512-DUWJr3+ULp4zXmol/SZkFf3JGsS9/SIv+Y3Rt93/UjPpDpklB5f1er4O3POIbUuUJ3FXgqte2Q7SrU6zAqwk8w== + +path-key@^3.0.0, path-key@^3.1.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/path-key/-/path-key-3.1.1.tgz#581f6ade658cbba65a0d3380de7753295054f375" + integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== + +path-parse@^1.0.7: + version "1.0.7" + resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735" + integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== + +path-to-regexp@0.1.12: + version "0.1.12" + resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-0.1.12.tgz#d5e1a12e478a976d432ef3c58d534b9923164bb7" + integrity sha512-RA1GjUVMnvYFxuqovrEqZoxxW5NUZqbwKtYz/Tt7nXerk0LbLblQmrsgdeOxV5SFHf0UDggjS/bSeOZwt1pmEQ== + +path-to-regexp@3.3.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-3.3.0.tgz#f7f31d32e8518c2660862b644414b6d5c63a611b" + integrity sha512-qyCH421YQPS2WFDxDjftfc1ZR5WKQzVzqsp4n9M2kQhVOo/ByahFoUNJfl58kOcEGfQ//7weFTDhm+ss8Ecxgw== + +path-to-regexp@^1.7.0: + version "1.9.0" + resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-1.9.0.tgz#5dc0753acbf8521ca2e0f137b4578b917b10cf24" + integrity sha512-xIp7/apCFJuUHdDLWe8O1HIkb0kQrOMb/0u6FXQjemHn/ii5LrIzU6bdECnsiTF/GjZkMEKg1xdiZwNqDYlZ6g== + dependencies: + isarray "0.0.1" + +path-type@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b" + integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw== + +picocolors@^1.0.0, picocolors@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.1.1.tgz#3d321af3eab939b083c8f929a1d12cda81c26b6b" + integrity sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA== + +picomatch@^2.0.4, picomatch@^2.2.1, picomatch@^2.2.3, picomatch@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" + integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== + +pkg-dir@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/pkg-dir/-/pkg-dir-7.0.0.tgz#8f0c08d6df4476756c5ff29b3282d0bab7517d11" + integrity sha512-Ie9z/WINcxxLp27BKOCHGde4ITq9UklYKDzVo1nhk5sqGEXU3FpkwP5GM2voTGJkGd9B3Otl+Q4uwSOeSUtOBA== + dependencies: + find-up "^6.3.0" + +postcss-attribute-case-insensitive@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/postcss-attribute-case-insensitive/-/postcss-attribute-case-insensitive-7.0.1.tgz#0c4500e3bcb2141848e89382c05b5a31c23033a3" + integrity sha512-Uai+SupNSqzlschRyNx3kbCTWgY/2hcwtHEI/ej2LJWc9JJ77qKgGptd8DHwY1mXtZ7Aoh4z4yxfwMBue9eNgw== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-calc@^9.0.1: + version "9.0.1" + resolved "https://registry.yarnpkg.com/postcss-calc/-/postcss-calc-9.0.1.tgz#a744fd592438a93d6de0f1434c572670361eb6c6" + integrity sha512-TipgjGyzP5QzEhsOZUaIkeO5mKeMFpebWzRogWG/ysonUlnHcq5aJe0jOjpfzUU8PeSaBQnrE8ehR0QA5vs8PQ== + dependencies: + postcss-selector-parser "^6.0.11" + postcss-value-parser "^4.2.0" + +postcss-clamp@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/postcss-clamp/-/postcss-clamp-4.1.0.tgz#7263e95abadd8c2ba1bd911b0b5a5c9c93e02363" + integrity sha512-ry4b1Llo/9zz+PKC+030KUnPITTJAHeOwjfAyyB60eT0AorGLdzp52s31OsPRHRf8NchkgFoG2y6fCfn1IV1Ow== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-color-functional-notation@^7.0.11: + version "7.0.11" + resolved "https://registry.yarnpkg.com/postcss-color-functional-notation/-/postcss-color-functional-notation-7.0.11.tgz#ad6b3d2e71fedd94a932f96260b596c33c53c6a5" + integrity sha512-zfqoUSaHMko/k2PA9xnaydVTHqYv5vphq5Q2AHcG/dCdv/OkHYWcVWfVTBKZ526uzT8L7NghuvSw3C9PxlKnLg== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +postcss-color-hex-alpha@^10.0.0: + version "10.0.0" + resolved "https://registry.yarnpkg.com/postcss-color-hex-alpha/-/postcss-color-hex-alpha-10.0.0.tgz#5dd3eba1f8facb4ea306cba6e3f7712e876b0c76" + integrity sha512-1kervM2cnlgPs2a8Vt/Qbe5cQ++N7rkYo/2rz2BkqJZIHQwaVuJgQH38REHrAi4uM0b1fqxMkWYmese94iMp3w== + dependencies: + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +postcss-color-rebeccapurple@^10.0.0: + version "10.0.0" + resolved "https://registry.yarnpkg.com/postcss-color-rebeccapurple/-/postcss-color-rebeccapurple-10.0.0.tgz#5ada28406ac47e0796dff4056b0a9d5a6ecead98" + integrity sha512-JFta737jSP+hdAIEhk1Vs0q0YF5P8fFcj+09pweS8ktuGuZ8pPlykHsk6mPxZ8awDl4TrcxUqJo9l1IhVr/OjQ== + dependencies: + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +postcss-colormin@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-colormin/-/postcss-colormin-6.1.0.tgz#076e8d3fb291fbff7b10e6b063be9da42ff6488d" + integrity sha512-x9yX7DOxeMAR+BgGVnNSAxmAj98NX/YxEMNFP+SDCEeNLb2r3i6Hh1ksMsnW8Ub5SLCpbescQqn9YEbE9554Sw== + dependencies: + browserslist "^4.23.0" + caniuse-api "^3.0.0" + colord "^2.9.3" + postcss-value-parser "^4.2.0" + +postcss-convert-values@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-convert-values/-/postcss-convert-values-6.1.0.tgz#3498387f8efedb817cbc63901d45bd1ceaa40f48" + integrity sha512-zx8IwP/ts9WvUM6NkVSkiU902QZL1bwPhaVaLynPtCsOTqp+ZKbNi+s6XJg3rfqpKGA/oc7Oxk5t8pOQJcwl/w== + dependencies: + browserslist "^4.23.0" + postcss-value-parser "^4.2.0" + +postcss-custom-media@^11.0.6: + version "11.0.6" + resolved "https://registry.yarnpkg.com/postcss-custom-media/-/postcss-custom-media-11.0.6.tgz#6b450e5bfa209efb736830066682e6567bd04967" + integrity sha512-C4lD4b7mUIw+RZhtY7qUbf4eADmb7Ey8BFA2px9jUbwg7pjTZDl4KY4bvlUV+/vXQvzQRfiGEVJyAbtOsCMInw== + dependencies: + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/media-query-list-parser" "^4.0.3" + +postcss-custom-properties@^14.0.6: + version "14.0.6" + resolved "https://registry.yarnpkg.com/postcss-custom-properties/-/postcss-custom-properties-14.0.6.tgz#1af73a650bf115ba052cf915287c9982825fc90e" + integrity sha512-fTYSp3xuk4BUeVhxCSJdIPhDLpJfNakZKoiTDx7yRGCdlZrSJR7mWKVOBS4sBF+5poPQFMj2YdXx1VHItBGihQ== + dependencies: + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +postcss-custom-selectors@^8.0.5: + version "8.0.5" + resolved "https://registry.yarnpkg.com/postcss-custom-selectors/-/postcss-custom-selectors-8.0.5.tgz#9448ed37a12271d7ab6cb364b6f76a46a4a323e8" + integrity sha512-9PGmckHQswiB2usSO6XMSswO2yFWVoCAuih1yl9FVcwkscLjRKjwsjM3t+NIWpSU2Jx3eOiK2+t4vVTQaoCHHg== + dependencies: + "@csstools/cascade-layer-name-parser" "^2.0.5" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + postcss-selector-parser "^7.0.0" + +postcss-dir-pseudo-class@^9.0.1: + version "9.0.1" + resolved "https://registry.yarnpkg.com/postcss-dir-pseudo-class/-/postcss-dir-pseudo-class-9.0.1.tgz#80d9e842c9ae9d29f6bf5fd3cf9972891d6cc0ca" + integrity sha512-tRBEK0MHYvcMUrAuYMEOa0zg9APqirBcgzi6P21OhxtJyJADo/SWBwY1CAwEohQ/6HDaa9jCjLRG7K3PVQYHEA== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-discard-comments@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-discard-comments/-/postcss-discard-comments-6.0.2.tgz#e768dcfdc33e0216380623652b0a4f69f4678b6c" + integrity sha512-65w/uIqhSBBfQmYnG92FO1mWZjJ4GL5b8atm5Yw2UgrwD7HiNiSSNwJor1eCFGzUgYnN/iIknhNRVqjrrpuglw== + +postcss-discard-duplicates@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-discard-duplicates/-/postcss-discard-duplicates-6.0.3.tgz#d121e893c38dc58a67277f75bb58ba43fce4c3eb" + integrity sha512-+JA0DCvc5XvFAxwx6f/e68gQu/7Z9ud584VLmcgto28eB8FqSFZwtrLwB5Kcp70eIoWP/HXqz4wpo8rD8gpsTw== + +postcss-discard-empty@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-discard-empty/-/postcss-discard-empty-6.0.3.tgz#ee39c327219bb70473a066f772621f81435a79d9" + integrity sha512-znyno9cHKQsK6PtxL5D19Fj9uwSzC2mB74cpT66fhgOadEUPyXFkbgwm5tvc3bt3NAy8ltE5MrghxovZRVnOjQ== + +postcss-discard-overridden@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-discard-overridden/-/postcss-discard-overridden-6.0.2.tgz#4e9f9c62ecd2df46e8fdb44dc17e189776572e2d" + integrity sha512-j87xzI4LUggC5zND7KdjsI25APtyMuynXZSujByMaav2roV6OZX+8AaCUcZSWqckZpjAjRyFDdpqybgjFO0HJQ== + +postcss-discard-unused@^6.0.5: + version "6.0.5" + resolved "https://registry.yarnpkg.com/postcss-discard-unused/-/postcss-discard-unused-6.0.5.tgz#c1b0e8c032c6054c3fbd22aaddba5b248136f338" + integrity sha512-wHalBlRHkaNnNwfC8z+ppX57VhvS+HWgjW508esjdaEYr3Mx7Gnn2xA4R/CKf5+Z9S5qsqC+Uzh4ueENWwCVUA== + dependencies: + postcss-selector-parser "^6.0.16" + +postcss-double-position-gradients@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-double-position-gradients/-/postcss-double-position-gradients-6.0.3.tgz#d8c4b126af89855a3aa6687e5b1a0d5460d4a5b7" + integrity sha512-Dl0Z9sdbMwrPslgOaGBZRGo3TASmmgTcqcUODr82MTYyJk6devXZM6MlQjpQKMJqlLJ6oL1w78U7IXFdPA5+ug== + dependencies: + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +postcss-focus-visible@^10.0.1: + version "10.0.1" + resolved "https://registry.yarnpkg.com/postcss-focus-visible/-/postcss-focus-visible-10.0.1.tgz#1f7904904368a2d1180b220595d77b6f8a957868" + integrity sha512-U58wyjS/I1GZgjRok33aE8juW9qQgQUNwTSdxQGuShHzwuYdcklnvK/+qOWX1Q9kr7ysbraQ6ht6r+udansalA== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-focus-within@^9.0.1: + version "9.0.1" + resolved "https://registry.yarnpkg.com/postcss-focus-within/-/postcss-focus-within-9.0.1.tgz#ac01ce80d3f2e8b2b3eac4ff84f8e15cd0057bc7" + integrity sha512-fzNUyS1yOYa7mOjpci/bR+u+ESvdar6hk8XNK/TRR0fiGTp2QT5N+ducP0n3rfH/m9I7H/EQU6lsa2BrgxkEjw== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-font-variant@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/postcss-font-variant/-/postcss-font-variant-5.0.0.tgz#efd59b4b7ea8bb06127f2d031bfbb7f24d32fa66" + integrity sha512-1fmkBaCALD72CK2a9i468mA/+tr9/1cBxRRMXOUaZqO43oWPR5imcyPjXwuv7PXbCid4ndlP5zWhidQVVa3hmA== + +postcss-gap-properties@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/postcss-gap-properties/-/postcss-gap-properties-6.0.0.tgz#d5ff0bdf923c06686499ed2b12e125fe64054fed" + integrity sha512-Om0WPjEwiM9Ru+VhfEDPZJAKWUd0mV1HmNXqp2C29z80aQ2uP9UVhLc7e3aYMIor/S5cVhoPgYQ7RtfeZpYTRw== + +postcss-image-set-function@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/postcss-image-set-function/-/postcss-image-set-function-7.0.0.tgz#538e94e16716be47f9df0573b56bbaca86e1da53" + integrity sha512-QL7W7QNlZuzOwBTeXEmbVckNt1FSmhQtbMRvGGqqU4Nf4xk6KUEQhAoWuMzwbSv5jxiRiSZ5Tv7eiDB9U87znA== + dependencies: + "@csstools/utilities" "^2.0.0" + postcss-value-parser "^4.2.0" + +postcss-lab-function@^7.0.11: + version "7.0.11" + resolved "https://registry.yarnpkg.com/postcss-lab-function/-/postcss-lab-function-7.0.11.tgz#455934181eea130f8e649c1f54692e1768046f6a" + integrity sha512-BEA4jId8uQe1gyjZZ6Bunb6ZsH2izks+v25AxQJDBtigXCjTLmCPWECwQpLTtcxH589MVxhs/9TAmRC6lUEmXQ== + dependencies: + "@csstools/css-color-parser" "^3.1.0" + "@csstools/css-parser-algorithms" "^3.0.5" + "@csstools/css-tokenizer" "^3.0.4" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/utilities" "^2.0.0" + +postcss-loader@^7.3.4: + version "7.3.4" + resolved "https://registry.yarnpkg.com/postcss-loader/-/postcss-loader-7.3.4.tgz#aed9b79ce4ed7e9e89e56199d25ad1ec8f606209" + integrity sha512-iW5WTTBSC5BfsBJ9daFMPVrLT36MrNiC6fqOZTTaHjBNX6Pfd5p+hSBqe/fEeNd7pc13QiAyGt7VdGMw4eRC4A== + dependencies: + cosmiconfig "^8.3.5" + jiti "^1.20.0" + semver "^7.5.4" + +postcss-logical@^8.1.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/postcss-logical/-/postcss-logical-8.1.0.tgz#4092b16b49e3ecda70c4d8945257da403d167228" + integrity sha512-pL1hXFQ2fEXNKiNiAgtfA005T9FBxky5zkX6s4GZM2D8RkVgRqz3f4g1JUoq925zXv495qk8UNldDwh8uGEDoA== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-merge-idents@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-merge-idents/-/postcss-merge-idents-6.0.3.tgz#7b9c31c7bc823c94bec50f297f04e3c2b838ea65" + integrity sha512-1oIoAsODUs6IHQZkLQGO15uGEbK3EAl5wi9SS8hs45VgsxQfMnxvt+L+zIr7ifZFIH14cfAeVe2uCTa+SPRa3g== + dependencies: + cssnano-utils "^4.0.2" + postcss-value-parser "^4.2.0" + +postcss-merge-longhand@^6.0.5: + version "6.0.5" + resolved "https://registry.yarnpkg.com/postcss-merge-longhand/-/postcss-merge-longhand-6.0.5.tgz#ba8a8d473617c34a36abbea8dda2b215750a065a" + integrity sha512-5LOiordeTfi64QhICp07nzzuTDjNSO8g5Ksdibt44d+uvIIAE1oZdRn8y/W5ZtYgRH/lnLDlvi9F8btZcVzu3w== + dependencies: + postcss-value-parser "^4.2.0" + stylehacks "^6.1.1" + +postcss-merge-rules@^6.1.1: + version "6.1.1" + resolved "https://registry.yarnpkg.com/postcss-merge-rules/-/postcss-merge-rules-6.1.1.tgz#7aa539dceddab56019469c0edd7d22b64c3dea9d" + integrity sha512-KOdWF0gju31AQPZiD+2Ar9Qjowz1LTChSjFFbS+e2sFgc4uHOp3ZvVX4sNeTlk0w2O31ecFGgrFzhO0RSWbWwQ== + dependencies: + browserslist "^4.23.0" + caniuse-api "^3.0.0" + cssnano-utils "^4.0.2" + postcss-selector-parser "^6.0.16" + +postcss-minify-font-values@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-minify-font-values/-/postcss-minify-font-values-6.1.0.tgz#a0e574c02ee3f299be2846369211f3b957ea4c59" + integrity sha512-gklfI/n+9rTh8nYaSJXlCo3nOKqMNkxuGpTn/Qm0gstL3ywTr9/WRKznE+oy6fvfolH6dF+QM4nCo8yPLdvGJg== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-minify-gradients@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-minify-gradients/-/postcss-minify-gradients-6.0.3.tgz#ca3eb55a7bdb48a1e187a55c6377be918743dbd6" + integrity sha512-4KXAHrYlzF0Rr7uc4VrfwDJ2ajrtNEpNEuLxFgwkhFZ56/7gaE4Nr49nLsQDZyUe+ds+kEhf+YAUolJiYXF8+Q== + dependencies: + colord "^2.9.3" + cssnano-utils "^4.0.2" + postcss-value-parser "^4.2.0" + +postcss-minify-params@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-minify-params/-/postcss-minify-params-6.1.0.tgz#54551dec77b9a45a29c3cb5953bf7325a399ba08" + integrity sha512-bmSKnDtyyE8ujHQK0RQJDIKhQ20Jq1LYiez54WiaOoBtcSuflfK3Nm596LvbtlFcpipMjgClQGyGr7GAs+H1uA== + dependencies: + browserslist "^4.23.0" + cssnano-utils "^4.0.2" + postcss-value-parser "^4.2.0" + +postcss-minify-selectors@^6.0.4: + version "6.0.4" + resolved "https://registry.yarnpkg.com/postcss-minify-selectors/-/postcss-minify-selectors-6.0.4.tgz#197f7d72e6dd19eed47916d575d69dc38b396aff" + integrity sha512-L8dZSwNLgK7pjTto9PzWRoMbnLq5vsZSTu8+j1P/2GB8qdtGQfn+K1uSvFgYvgh83cbyxT5m43ZZhUMTJDSClQ== + dependencies: + postcss-selector-parser "^6.0.16" + +postcss-modules-extract-imports@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/postcss-modules-extract-imports/-/postcss-modules-extract-imports-3.1.0.tgz#b4497cb85a9c0c4b5aabeb759bb25e8d89f15002" + integrity sha512-k3kNe0aNFQDAZGbin48pL2VNidTF0w4/eASDsxlyspobzU3wZQLOGj7L9gfRe0Jo9/4uud09DsjFNH7winGv8Q== + +postcss-modules-local-by-default@^4.0.5: + version "4.2.0" + resolved "https://registry.yarnpkg.com/postcss-modules-local-by-default/-/postcss-modules-local-by-default-4.2.0.tgz#d150f43837831dae25e4085596e84f6f5d6ec368" + integrity sha512-5kcJm/zk+GJDSfw+V/42fJ5fhjL5YbFDl8nVdXkJPLLW+Vf9mTD5Xe0wqIaDnLuL2U6cDNpTr+UQ+v2HWIBhzw== + dependencies: + icss-utils "^5.0.0" + postcss-selector-parser "^7.0.0" + postcss-value-parser "^4.1.0" + +postcss-modules-scope@^3.2.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/postcss-modules-scope/-/postcss-modules-scope-3.2.1.tgz#1bbccddcb398f1d7a511e0a2d1d047718af4078c" + integrity sha512-m9jZstCVaqGjTAuny8MdgE88scJnCiQSlSrOWcTQgM2t32UBe+MUmFSO5t7VMSfAf/FJKImAxBav8ooCHJXCJA== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-modules-values@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/postcss-modules-values/-/postcss-modules-values-4.0.0.tgz#d7c5e7e68c3bb3c9b27cbf48ca0bb3ffb4602c9c" + integrity sha512-RDxHkAiEGI78gS2ofyvCsu7iycRv7oqw5xMWn9iMoR0N/7mf9D50ecQqUo5BZ9Zh2vH4bCUR/ktCqbB9m8vJjQ== + dependencies: + icss-utils "^5.0.0" + +postcss-nesting@^13.0.2: + version "13.0.2" + resolved "https://registry.yarnpkg.com/postcss-nesting/-/postcss-nesting-13.0.2.tgz#fde0d4df772b76d03b52eccc84372e8d1ca1402e" + integrity sha512-1YCI290TX+VP0U/K/aFxzHzQWHWURL+CtHMSbex1lCdpXD1SoR2sYuxDu5aNI9lPoXpKTCggFZiDJbwylU0LEQ== + dependencies: + "@csstools/selector-resolve-nested" "^3.1.0" + "@csstools/selector-specificity" "^5.0.0" + postcss-selector-parser "^7.0.0" + +postcss-normalize-charset@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-charset/-/postcss-normalize-charset-6.0.2.tgz#1ec25c435057a8001dac942942a95ffe66f721e1" + integrity sha512-a8N9czmdnrjPHa3DeFlwqst5eaL5W8jYu3EBbTTkI5FHkfMhFZh1EGbku6jhHhIzTA6tquI2P42NtZ59M/H/kQ== + +postcss-normalize-display-values@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-display-values/-/postcss-normalize-display-values-6.0.2.tgz#54f02764fed0b288d5363cbb140d6950dbbdd535" + integrity sha512-8H04Mxsb82ON/aAkPeq8kcBbAtI5Q2a64X/mnRRfPXBq7XeogoQvReqxEfc0B4WPq1KimjezNC8flUtC3Qz6jg== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-positions@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-positions/-/postcss-normalize-positions-6.0.2.tgz#e982d284ec878b9b819796266f640852dbbb723a" + integrity sha512-/JFzI441OAB9O7VnLA+RtSNZvQ0NCFZDOtp6QPFo1iIyawyXg0YI3CYM9HBy1WvwCRHnPep/BvI1+dGPKoXx/Q== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-repeat-style@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-repeat-style/-/postcss-normalize-repeat-style-6.0.2.tgz#f8006942fd0617c73f049dd8b6201c3a3040ecf3" + integrity sha512-YdCgsfHkJ2jEXwR4RR3Tm/iOxSfdRt7jplS6XRh9Js9PyCR/aka/FCb6TuHT2U8gQubbm/mPmF6L7FY9d79VwQ== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-string@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-string/-/postcss-normalize-string-6.0.2.tgz#e3cc6ad5c95581acd1fc8774b309dd7c06e5e363" + integrity sha512-vQZIivlxlfqqMp4L9PZsFE4YUkWniziKjQWUtsxUiVsSSPelQydwS8Wwcuw0+83ZjPWNTl02oxlIvXsmmG+CiQ== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-timing-functions@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-timing-functions/-/postcss-normalize-timing-functions-6.0.2.tgz#40cb8726cef999de984527cbd9d1db1f3e9062c0" + integrity sha512-a+YrtMox4TBtId/AEwbA03VcJgtyW4dGBizPl7e88cTFULYsprgHWTbfyjSLyHeBcK/Q9JhXkt2ZXiwaVHoMzA== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-unicode@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-normalize-unicode/-/postcss-normalize-unicode-6.1.0.tgz#aaf8bbd34c306e230777e80f7f12a4b7d27ce06e" + integrity sha512-QVC5TQHsVj33otj8/JD869Ndr5Xcc/+fwRh4HAsFsAeygQQXm+0PySrKbr/8tkDKzW+EVT3QkqZMfFrGiossDg== + dependencies: + browserslist "^4.23.0" + postcss-value-parser "^4.2.0" + +postcss-normalize-url@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-url/-/postcss-normalize-url-6.0.2.tgz#292792386be51a8de9a454cb7b5c58ae22db0f79" + integrity sha512-kVNcWhCeKAzZ8B4pv/DnrU1wNh458zBNp8dh4y5hhxih5RZQ12QWMuQrDgPRw3LRl8mN9vOVfHl7uhvHYMoXsQ== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-normalize-whitespace@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-normalize-whitespace/-/postcss-normalize-whitespace-6.0.2.tgz#fbb009e6ebd312f8b2efb225c2fcc7cf32b400cd" + integrity sha512-sXZ2Nj1icbJOKmdjXVT9pnyHQKiSAyuNQHSgRCUgThn2388Y9cGVDR+E9J9iAYbSbLHI+UUwLVl1Wzco/zgv0Q== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-opacity-percentage@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/postcss-opacity-percentage/-/postcss-opacity-percentage-3.0.0.tgz#0b0db5ed5db5670e067044b8030b89c216e1eb0a" + integrity sha512-K6HGVzyxUxd/VgZdX04DCtdwWJ4NGLG212US4/LA1TLAbHgmAsTWVR86o+gGIbFtnTkfOpb9sCRBx8K7HO66qQ== + +postcss-ordered-values@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-ordered-values/-/postcss-ordered-values-6.0.2.tgz#366bb663919707093451ab70c3f99c05672aaae5" + integrity sha512-VRZSOB+JU32RsEAQrO94QPkClGPKJEL/Z9PCBImXMhIeK5KAYo6slP/hBYlLgrCjFxyqvn5VC81tycFEDBLG1Q== + dependencies: + cssnano-utils "^4.0.2" + postcss-value-parser "^4.2.0" + +postcss-overflow-shorthand@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/postcss-overflow-shorthand/-/postcss-overflow-shorthand-6.0.0.tgz#f5252b4a2ee16c68cd8a9029edb5370c4a9808af" + integrity sha512-BdDl/AbVkDjoTofzDQnwDdm/Ym6oS9KgmO7Gr+LHYjNWJ6ExORe4+3pcLQsLA9gIROMkiGVjjwZNoL/mpXHd5Q== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-page-break@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/postcss-page-break/-/postcss-page-break-3.0.4.tgz#7fbf741c233621622b68d435babfb70dd8c1ee5f" + integrity sha512-1JGu8oCjVXLa9q9rFTo4MbeeA5FMe00/9C7lN4va606Rdb+HkxXtXsmEDrIraQ11fGz/WvKWa8gMuCKkrXpTsQ== + +postcss-place@^10.0.0: + version "10.0.0" + resolved "https://registry.yarnpkg.com/postcss-place/-/postcss-place-10.0.0.tgz#ba36ee4786ca401377ced17a39d9050ed772e5a9" + integrity sha512-5EBrMzat2pPAxQNWYavwAfoKfYcTADJ8AXGVPcUZ2UkNloUTWzJQExgrzrDkh3EKzmAx1evfTAzF9I8NGcc+qw== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-preset-env@^10.2.1: + version "10.3.1" + resolved "https://registry.yarnpkg.com/postcss-preset-env/-/postcss-preset-env-10.3.1.tgz#f3799f0f7a7ea384b3c16e073055c231d11bb3bf" + integrity sha512-8ZOOWVwQ0iMpfEYkYo+U6W7fE2dJ/tP6dtEFwPJ66eB5JjnFupfYh+y6zo+vWDO72nGhKOVdxwhTjfzcSNRg4Q== + dependencies: + "@csstools/postcss-alpha-function" "^1.0.0" + "@csstools/postcss-cascade-layers" "^5.0.2" + "@csstools/postcss-color-function" "^4.0.11" + "@csstools/postcss-color-function-display-p3-linear" "^1.0.0" + "@csstools/postcss-color-mix-function" "^3.0.11" + "@csstools/postcss-color-mix-variadic-function-arguments" "^1.0.1" + "@csstools/postcss-content-alt-text" "^2.0.7" + "@csstools/postcss-exponential-functions" "^2.0.9" + "@csstools/postcss-font-format-keywords" "^4.0.0" + "@csstools/postcss-gamut-mapping" "^2.0.11" + "@csstools/postcss-gradients-interpolation-method" "^5.0.11" + "@csstools/postcss-hwb-function" "^4.0.11" + "@csstools/postcss-ic-unit" "^4.0.3" + "@csstools/postcss-initial" "^2.0.1" + "@csstools/postcss-is-pseudo-class" "^5.0.3" + "@csstools/postcss-light-dark-function" "^2.0.10" + "@csstools/postcss-logical-float-and-clear" "^3.0.0" + "@csstools/postcss-logical-overflow" "^2.0.0" + "@csstools/postcss-logical-overscroll-behavior" "^2.0.0" + "@csstools/postcss-logical-resize" "^3.0.0" + "@csstools/postcss-logical-viewport-units" "^3.0.4" + "@csstools/postcss-media-minmax" "^2.0.9" + "@csstools/postcss-media-queries-aspect-ratio-number-values" "^3.0.5" + "@csstools/postcss-nested-calc" "^4.0.0" + "@csstools/postcss-normalize-display-values" "^4.0.0" + "@csstools/postcss-oklab-function" "^4.0.11" + "@csstools/postcss-progressive-custom-properties" "^4.2.0" + "@csstools/postcss-random-function" "^2.0.1" + "@csstools/postcss-relative-color-syntax" "^3.0.11" + "@csstools/postcss-scope-pseudo-class" "^4.0.1" + "@csstools/postcss-sign-functions" "^1.1.4" + "@csstools/postcss-stepped-value-functions" "^4.0.9" + "@csstools/postcss-text-decoration-shorthand" "^4.0.3" + "@csstools/postcss-trigonometric-functions" "^4.0.9" + "@csstools/postcss-unset-value" "^4.0.0" + autoprefixer "^10.4.21" + browserslist "^4.25.1" + css-blank-pseudo "^7.0.1" + css-has-pseudo "^7.0.3" + css-prefers-color-scheme "^10.0.0" + cssdb "^8.4.0" + postcss-attribute-case-insensitive "^7.0.1" + postcss-clamp "^4.1.0" + postcss-color-functional-notation "^7.0.11" + postcss-color-hex-alpha "^10.0.0" + postcss-color-rebeccapurple "^10.0.0" + postcss-custom-media "^11.0.6" + postcss-custom-properties "^14.0.6" + postcss-custom-selectors "^8.0.5" + postcss-dir-pseudo-class "^9.0.1" + postcss-double-position-gradients "^6.0.3" + postcss-focus-visible "^10.0.1" + postcss-focus-within "^9.0.1" + postcss-font-variant "^5.0.0" + postcss-gap-properties "^6.0.0" + postcss-image-set-function "^7.0.0" + postcss-lab-function "^7.0.11" + postcss-logical "^8.1.0" + postcss-nesting "^13.0.2" + postcss-opacity-percentage "^3.0.0" + postcss-overflow-shorthand "^6.0.0" + postcss-page-break "^3.0.4" + postcss-place "^10.0.0" + postcss-pseudo-class-any-link "^10.0.1" + postcss-replace-overflow-wrap "^4.0.0" + postcss-selector-not "^8.0.1" + +postcss-pseudo-class-any-link@^10.0.1: + version "10.0.1" + resolved "https://registry.yarnpkg.com/postcss-pseudo-class-any-link/-/postcss-pseudo-class-any-link-10.0.1.tgz#06455431171bf44b84d79ebaeee9fd1c05946544" + integrity sha512-3el9rXlBOqTFaMFkWDOkHUTQekFIYnaQY55Rsp8As8QQkpiSgIYEcF/6Ond93oHiDsGb4kad8zjt+NPlOC1H0Q== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-reduce-idents@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-reduce-idents/-/postcss-reduce-idents-6.0.3.tgz#b0d9c84316d2a547714ebab523ec7d13704cd486" + integrity sha512-G3yCqZDpsNPoQgbDUy3T0E6hqOQ5xigUtBQyrmq3tn2GxlyiL0yyl7H+T8ulQR6kOcHJ9t7/9H4/R2tv8tJbMA== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-reduce-initial@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/postcss-reduce-initial/-/postcss-reduce-initial-6.1.0.tgz#4401297d8e35cb6e92c8e9586963e267105586ba" + integrity sha512-RarLgBK/CrL1qZags04oKbVbrrVK2wcxhvta3GCxrZO4zveibqbRPmm2VI8sSgCXwoUHEliRSbOfpR0b/VIoiw== + dependencies: + browserslist "^4.23.0" + caniuse-api "^3.0.0" + +postcss-reduce-transforms@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-reduce-transforms/-/postcss-reduce-transforms-6.0.2.tgz#6fa2c586bdc091a7373caeee4be75a0f3e12965d" + integrity sha512-sB+Ya++3Xj1WaT9+5LOOdirAxP7dJZms3GRcYheSPi1PiTMigsxHAdkrbItHxwYHr4kt1zL7mmcHstgMYT+aiA== + dependencies: + postcss-value-parser "^4.2.0" + +postcss-replace-overflow-wrap@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/postcss-replace-overflow-wrap/-/postcss-replace-overflow-wrap-4.0.0.tgz#d2df6bed10b477bf9c52fab28c568b4b29ca4319" + integrity sha512-KmF7SBPphT4gPPcKZc7aDkweHiKEEO8cla/GjcBK+ckKxiZslIu3C4GCRW3DNfL0o7yW7kMQu9xlZ1kXRXLXtw== + +postcss-selector-not@^8.0.1: + version "8.0.1" + resolved "https://registry.yarnpkg.com/postcss-selector-not/-/postcss-selector-not-8.0.1.tgz#f2df9c6ac9f95e9fe4416ca41a957eda16130172" + integrity sha512-kmVy/5PYVb2UOhy0+LqUYAhKj7DUGDpSWa5LZqlkWJaaAV+dxxsOG3+St0yNLu6vsKD7Dmqx+nWQt0iil89+WA== + dependencies: + postcss-selector-parser "^7.0.0" + +postcss-selector-parser@^6.0.11, postcss-selector-parser@^6.0.16: + version "6.1.2" + resolved "https://registry.yarnpkg.com/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz#27ecb41fb0e3b6ba7a1ec84fff347f734c7929de" + integrity sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg== + dependencies: + cssesc "^3.0.0" + util-deprecate "^1.0.2" + +postcss-selector-parser@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz#4d6af97eba65d73bc4d84bcb343e865d7dd16262" + integrity sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA== + dependencies: + cssesc "^3.0.0" + util-deprecate "^1.0.2" + +postcss-sort-media-queries@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/postcss-sort-media-queries/-/postcss-sort-media-queries-5.2.0.tgz#4556b3f982ef27d3bac526b99b6c0d3359a6cf97" + integrity sha512-AZ5fDMLD8SldlAYlvi8NIqo0+Z8xnXU2ia0jxmuhxAU+Lqt9K+AlmLNJ/zWEnE9x+Zx3qL3+1K20ATgNOr3fAA== + dependencies: + sort-css-media-queries "2.2.0" + +postcss-svgo@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/postcss-svgo/-/postcss-svgo-6.0.3.tgz#1d6e180d6df1fa8a3b30b729aaa9161e94f04eaa" + integrity sha512-dlrahRmxP22bX6iKEjOM+c8/1p+81asjKT+V5lrgOH944ryx/OHpclnIbGsKVd3uWOXFLYJwCVf0eEkJGvO96g== + dependencies: + postcss-value-parser "^4.2.0" + svgo "^3.2.0" + +postcss-unique-selectors@^6.0.4: + version "6.0.4" + resolved "https://registry.yarnpkg.com/postcss-unique-selectors/-/postcss-unique-selectors-6.0.4.tgz#983ab308896b4bf3f2baaf2336e14e52c11a2088" + integrity sha512-K38OCaIrO8+PzpArzkLKB42dSARtC2tmG6PvD4b1o1Q2E9Os8jzfWFfSy/rixsHwohtsDdFtAWGjFVFUdwYaMg== + dependencies: + postcss-selector-parser "^6.0.16" + +postcss-value-parser@^4.1.0, postcss-value-parser@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz#723c09920836ba6d3e5af019f92bc0971c02e514" + integrity sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ== + +postcss-zindex@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/postcss-zindex/-/postcss-zindex-6.0.2.tgz#e498304b83a8b165755f53db40e2ea65a99b56e1" + integrity sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg== + +postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.33, postcss@^8.5.4: + version "8.5.6" + resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.5.6.tgz#2825006615a619b4f62a9e7426cc120b349a8f3c" + integrity sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg== + dependencies: + nanoid "^3.3.11" + picocolors "^1.1.1" + source-map-js "^1.2.1" + +pretty-error@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/pretty-error/-/pretty-error-4.0.0.tgz#90a703f46dd7234adb46d0f84823e9d1cb8f10d6" + integrity sha512-AoJ5YMAcXKYxKhuJGdcvse+Voc6v1RgnsR3nWcYU7q4t6z0Q6T86sv5Zq8VIRbOWWFpvdGE83LtdSMNd+6Y0xw== + dependencies: + lodash "^4.17.20" + renderkid "^3.0.0" + +pretty-time@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/pretty-time/-/pretty-time-1.1.0.tgz#ffb7429afabb8535c346a34e41873adf3d74dd0e" + integrity sha512-28iF6xPQrP8Oa6uxE6a1biz+lWeTOAPKggvjB8HAs6nVMKZwf5bG++632Dx614hIWgUPkgivRfG+a8uAXGTIbA== + +prism-react-renderer@^2.3.0: + version "2.4.1" + resolved "https://registry.yarnpkg.com/prism-react-renderer/-/prism-react-renderer-2.4.1.tgz#ac63b7f78e56c8f2b5e76e823a976d5ede77e35f" + integrity sha512-ey8Ls/+Di31eqzUxC46h8MksNuGx/n0AAC8uKpwFau4RPDYLuE3EXTp8N8G2vX2N7UC/+IXeNUnlWBGGcAG+Ig== + dependencies: + "@types/prismjs" "^1.26.0" + clsx "^2.0.0" + +prismjs@^1.29.0: + version "1.30.0" + resolved "https://registry.yarnpkg.com/prismjs/-/prismjs-1.30.0.tgz#d9709969d9d4e16403f6f348c63553b19f0975a9" + integrity sha512-DEvV2ZF2r2/63V+tK8hQvrR2ZGn10srHbXviTlcv7Kpzw8jWiNTqbVgjO3IY8RxrrOUF8VPMQQFysYYYv0YZxw== + +process-nextick-args@~2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-2.0.1.tgz#7820d9b16120cc55ca9ae7792680ae7dba6d7fe2" + integrity sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag== + +prompts@^2.4.2: + version "2.4.2" + resolved "https://registry.yarnpkg.com/prompts/-/prompts-2.4.2.tgz#7b57e73b3a48029ad10ebd44f74b01722a4cb069" + integrity sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q== + dependencies: + kleur "^3.0.3" + sisteransi "^1.0.5" + +prop-types@^15.6.2, prop-types@^15.7.2, prop-types@^15.8.1: + version "15.8.1" + resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.8.1.tgz#67d87bf1a694f48435cf332c24af10214a3140b5" + integrity sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg== + dependencies: + loose-envify "^1.4.0" + object-assign "^4.1.1" + react-is "^16.13.1" + +property-information@^6.0.0: + version "6.5.0" + resolved "https://registry.yarnpkg.com/property-information/-/property-information-6.5.0.tgz#6212fbb52ba757e92ef4fb9d657563b933b7ffec" + integrity sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig== + +property-information@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/property-information/-/property-information-7.1.0.tgz#b622e8646e02b580205415586b40804d3e8bfd5d" + integrity sha512-TwEZ+X+yCJmYfL7TPUOcvBZ4QfoT5YenQiJuX//0th53DE6w0xxLEtfK3iyryQFddXuvkIk51EEgrJQ0WJkOmQ== + +proto-list@~1.2.1: + version "1.2.4" + resolved "https://registry.yarnpkg.com/proto-list/-/proto-list-1.2.4.tgz#212d5bfe1318306a420f6402b8e26ff39647a849" + integrity sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA== + +proxy-addr@~2.0.7: + version "2.0.7" + resolved "https://registry.yarnpkg.com/proxy-addr/-/proxy-addr-2.0.7.tgz#f19fe69ceab311eeb94b42e70e8c2070f9ba1025" + integrity sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg== + dependencies: + forwarded "0.2.0" + ipaddr.js "1.9.1" + +punycode@^2.1.0: + version "2.3.1" + resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.1.tgz#027422e2faec0b25e1549c3e1bd8309b9133b6e5" + integrity sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg== + +pupa@^3.1.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/pupa/-/pupa-3.2.1.tgz#e28278e4b6e4f5ece1c04404a507ce0d5ecfb4d6" + integrity sha512-6koJt2wLdmDICU5Yht9X4mYjQUFcah7cAu9PEgGP+JGbLQpUQFfaCauHLeutygSkt50oMEX7oAQNmUHxGh5GHQ== + dependencies: + escape-goat "^4.0.0" + +qs@6.13.0: + version "6.13.0" + resolved "https://registry.yarnpkg.com/qs/-/qs-6.13.0.tgz#6ca3bd58439f7e245655798997787b0d88a51906" + integrity sha512-+38qI9SOr8tfZ4QmJNplMUxqjbe7LKvvZgWdExBOmd+egZTtjLB67Gu0HRX3u/XOq7UU2Nx6nsjvS16Z9uwfpg== + dependencies: + side-channel "^1.0.6" + +queue-microtask@^1.2.2: + version "1.2.3" + resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" + integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== + +quick-lru@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/quick-lru/-/quick-lru-5.1.1.tgz#366493e6b3e42a3a6885e2e99d18f80fb7a8c932" + integrity sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA== + +randombytes@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/randombytes/-/randombytes-2.1.0.tgz#df6f84372f0270dc65cdf6291349ab7a473d4f2a" + integrity sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ== + dependencies: + safe-buffer "^5.1.0" + +range-parser@1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/range-parser/-/range-parser-1.2.0.tgz#f49be6b487894ddc40dcc94a322f611092e00d5e" + integrity sha512-kA5WQoNVo4t9lNx2kQNFCxKeBl5IbbSNBl1M/tLkw9WCn+hxNBAW5Qh8gdhs63CJnhjJ2zQWFoqPJP2sK1AV5A== + +range-parser@^1.2.1, range-parser@~1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/range-parser/-/range-parser-1.2.1.tgz#3cf37023d199e1c24d1a55b84800c2f3e6468031" + integrity sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg== + +raw-body@2.5.2: + version "2.5.2" + resolved "https://registry.yarnpkg.com/raw-body/-/raw-body-2.5.2.tgz#99febd83b90e08975087e8f1f9419a149366b68a" + integrity sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA== + dependencies: + bytes "3.1.2" + http-errors "2.0.0" + iconv-lite "0.4.24" + unpipe "1.0.0" + +rc@1.2.8: + version "1.2.8" + resolved "https://registry.yarnpkg.com/rc/-/rc-1.2.8.tgz#cd924bf5200a075b83c188cd6b9e211b7fc0d3ed" + integrity sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw== + dependencies: + deep-extend "^0.6.0" + ini "~1.3.0" + minimist "^1.2.0" + strip-json-comments "~2.0.1" + +react-dom@^19.0.0: + version "19.1.1" + resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-19.1.1.tgz#2daa9ff7f3ae384aeb30e76d5ee38c046dc89893" + integrity sha512-Dlq/5LAZgF0Gaz6yiqZCf6VCcZs1ghAJyrsu84Q/GT0gV+mCxbfmKNoGRKBYMJ8IEdGPqu49YWXD02GCknEDkw== + dependencies: + scheduler "^0.26.0" + +react-fast-compare@^3.2.0: + version "3.2.2" + resolved "https://registry.yarnpkg.com/react-fast-compare/-/react-fast-compare-3.2.2.tgz#929a97a532304ce9fee4bcae44234f1ce2c21d49" + integrity sha512-nsO+KSNgo1SbJqJEYRE9ERzo7YtYbou/OqjSQKxV7jcKox7+usiUVZOAC+XnDOABXggQTno0Y1CpVnuWEc1boQ== + +"react-helmet-async@npm:@slorber/react-helmet-async@1.3.0": + version "1.3.0" + resolved "https://registry.yarnpkg.com/@slorber/react-helmet-async/-/react-helmet-async-1.3.0.tgz#11fbc6094605cf60aa04a28c17e0aab894b4ecff" + integrity sha512-e9/OK8VhwUSc67diWI8Rb3I0YgI9/SBQtnhe9aEuK6MhZm7ntZZimXgwXnd8W96YTmSOb9M4d8LwhRZyhWr/1A== + dependencies: + "@babel/runtime" "^7.12.5" + invariant "^2.2.4" + prop-types "^15.7.2" + react-fast-compare "^3.2.0" + shallowequal "^1.1.0" + +react-is@^16.13.1, react-is@^16.6.0, react-is@^16.7.0: + version "16.13.1" + resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4" + integrity sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ== + +react-is@^19.1.1: + version "19.1.1" + resolved "https://registry.yarnpkg.com/react-is/-/react-is-19.1.1.tgz#038ebe313cf18e1fd1235d51c87360eb87f7c36a" + integrity sha512-tr41fA15Vn8p4X9ntI+yCyeGSf1TlYaY5vlTZfQmeLBrFo3psOPX6HhTDnFNL9uj3EhP0KAQ80cugCl4b4BERA== + +react-json-view-lite@^2.3.0: + version "2.5.0" + resolved "https://registry.yarnpkg.com/react-json-view-lite/-/react-json-view-lite-2.5.0.tgz#c7ff011c7cc80e9900abc7aa4916c6a5c6d6c1c6" + integrity sha512-tk7o7QG9oYyELWHL8xiMQ8x4WzjCzbWNyig3uexmkLb54r8jO0yH3WCWx8UZS0c49eSA4QUmG5caiRJ8fAn58g== + +react-loadable-ssr-addon-v5-slorber@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/react-loadable-ssr-addon-v5-slorber/-/react-loadable-ssr-addon-v5-slorber-1.0.1.tgz#2cdc91e8a744ffdf9e3556caabeb6e4278689883" + integrity sha512-lq3Lyw1lGku8zUEJPDxsNm1AfYHBrO9Y1+olAYwpUJ2IGFBskM0DMKok97A6LWUpHm+o7IvQBOWu9MLenp9Z+A== + dependencies: + "@babel/runtime" "^7.10.3" + +"react-loadable@npm:@docusaurus/react-loadable@6.0.0": + version "6.0.0" + resolved "https://registry.yarnpkg.com/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz#de6c7f73c96542bd70786b8e522d535d69069dc4" + integrity sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ== + dependencies: + "@types/react" "*" + +react-router-config@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/react-router-config/-/react-router-config-5.1.1.tgz#0f4263d1a80c6b2dc7b9c1902c9526478194a988" + integrity sha512-DuanZjaD8mQp1ppHjgnnUnyOlqYXZVjnov/JzFhjLEwd3Z4dYjMSnqrEzzGThH47vpCOqPPwJM2FtthLeJ8Pbg== + dependencies: + "@babel/runtime" "^7.1.2" + +react-router-dom@^5.3.4: + version "5.3.4" + resolved "https://registry.yarnpkg.com/react-router-dom/-/react-router-dom-5.3.4.tgz#2ed62ffd88cae6db134445f4a0c0ae8b91d2e5e6" + integrity sha512-m4EqFMHv/Ih4kpcBCONHbkT68KoAeHN4p3lAGoNryfHi0dMy0kCzEZakiKRsvg5wHZ/JLrLW8o8KomWiz/qbYQ== + dependencies: + "@babel/runtime" "^7.12.13" + history "^4.9.0" + loose-envify "^1.3.1" + prop-types "^15.6.2" + react-router "5.3.4" + tiny-invariant "^1.0.2" + tiny-warning "^1.0.0" + +react-router@5.3.4, react-router@^5.3.4: + version "5.3.4" + resolved "https://registry.yarnpkg.com/react-router/-/react-router-5.3.4.tgz#8ca252d70fcc37841e31473c7a151cf777887bb5" + integrity sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA== + dependencies: + "@babel/runtime" "^7.12.13" + history "^4.9.0" + hoist-non-react-statics "^3.1.0" + loose-envify "^1.3.1" + path-to-regexp "^1.7.0" + prop-types "^15.6.2" + react-is "^16.6.0" + tiny-invariant "^1.0.2" + tiny-warning "^1.0.0" + +react-transition-group@^4.4.5: + version "4.4.5" + resolved "https://registry.yarnpkg.com/react-transition-group/-/react-transition-group-4.4.5.tgz#e53d4e3f3344da8521489fbef8f2581d42becdd1" + integrity sha512-pZcd1MCJoiKiBR2NRxeCRg13uCXbydPnmB4EOeRrY7480qNWO8IIgQG6zlDkm6uRMsURXPuKq0GWtiM59a5Q6g== + dependencies: + "@babel/runtime" "^7.5.5" + dom-helpers "^5.0.1" + loose-envify "^1.4.0" + prop-types "^15.6.2" + +react@^19.0.0: + version "19.1.1" + resolved "https://registry.yarnpkg.com/react/-/react-19.1.1.tgz#06d9149ec5e083a67f9a1e39ce97b06a03b644af" + integrity sha512-w8nqGImo45dmMIfljjMwOGtbmC/mk4CMYhWIicdSflH91J9TyCyczcPFXJzrZ/ZXcgGRFeP6BU0BEJTw6tZdfQ== + +readable-stream@^2.0.1: + version "2.3.8" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.8.tgz#91125e8042bba1b9887f49345f6277027ce8be9b" + integrity sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA== + dependencies: + core-util-is "~1.0.0" + inherits "~2.0.3" + isarray "~1.0.0" + process-nextick-args "~2.0.0" + safe-buffer "~5.1.1" + string_decoder "~1.1.1" + util-deprecate "~1.0.1" + +readable-stream@^3.0.6: + version "3.6.2" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.2.tgz#56a9b36ea965c00c5a93ef31eb111a0f11056967" + integrity sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA== + dependencies: + inherits "^2.0.3" + string_decoder "^1.1.1" + util-deprecate "^1.0.1" + +readdirp@~3.6.0: + version "3.6.0" + resolved "https://registry.yarnpkg.com/readdirp/-/readdirp-3.6.0.tgz#74a370bd857116e245b29cc97340cd431a02a6c7" + integrity sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA== + dependencies: + picomatch "^2.2.1" + +recma-build-jsx@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/recma-build-jsx/-/recma-build-jsx-1.0.0.tgz#c02f29e047e103d2fab2054954e1761b8ea253c4" + integrity sha512-8GtdyqaBcDfva+GUKDr3nev3VpKAhup1+RvkMvUxURHpW7QyIvk9F5wz7Vzo06CEMSilw6uArgRqhpiUcWp8ew== + dependencies: + "@types/estree" "^1.0.0" + estree-util-build-jsx "^3.0.0" + vfile "^6.0.0" + +recma-jsx@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/recma-jsx/-/recma-jsx-1.0.1.tgz#58e718f45e2102ed0bf2fa994f05b70d76801a1a" + integrity sha512-huSIy7VU2Z5OLv6oFLosQGGDqPqdO1iq6bWNAdhzMxSJP7RAso4fCZ1cKu8j9YHCZf3TPrq4dw3okhrylgcd7w== + dependencies: + acorn-jsx "^5.0.0" + estree-util-to-js "^2.0.0" + recma-parse "^1.0.0" + recma-stringify "^1.0.0" + unified "^11.0.0" + +recma-parse@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/recma-parse/-/recma-parse-1.0.0.tgz#c351e161bb0ab47d86b92a98a9d891f9b6814b52" + integrity sha512-OYLsIGBB5Y5wjnSnQW6t3Xg7q3fQ7FWbw/vcXtORTnyaSFscOtABg+7Pnz6YZ6c27fG1/aN8CjfwoUEUIdwqWQ== + dependencies: + "@types/estree" "^1.0.0" + esast-util-from-js "^2.0.0" + unified "^11.0.0" + vfile "^6.0.0" + +recma-stringify@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/recma-stringify/-/recma-stringify-1.0.0.tgz#54632030631e0c7546136ff9ef8fde8e7b44f130" + integrity sha512-cjwII1MdIIVloKvC9ErQ+OgAtwHBmcZ0Bg4ciz78FtbT8In39aAYbaA7zvxQ61xVMSPE8WxhLwLbhif4Js2C+g== + dependencies: + "@types/estree" "^1.0.0" + estree-util-to-js "^2.0.0" + unified "^11.0.0" + vfile "^6.0.0" + +regenerate-unicode-properties@^10.2.2: + version "10.2.2" + resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz#aa113812ba899b630658c7623466be71e1f86f66" + integrity sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g== + dependencies: + regenerate "^1.4.2" + +regenerate@^1.4.2: + version "1.4.2" + resolved "https://registry.yarnpkg.com/regenerate/-/regenerate-1.4.2.tgz#b9346d8827e8f5a32f7ba29637d398b69014848a" + integrity sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A== + +regexpu-core@^6.2.0: + version "6.3.1" + resolved "https://registry.yarnpkg.com/regexpu-core/-/regexpu-core-6.3.1.tgz#fb8b707d0efe18e9464d3ae76ae1e3c96c8467ae" + integrity sha512-DzcswPr252wEr7Qz8AyAVbfyBDKLoYp6eRA1We2Fa9qirRFSdtkP5sHr3yglDKy2BbA0fd2T+j/CUSKes3FeVQ== + dependencies: + regenerate "^1.4.2" + regenerate-unicode-properties "^10.2.2" + regjsgen "^0.8.0" + regjsparser "^0.12.0" + unicode-match-property-ecmascript "^2.0.0" + unicode-match-property-value-ecmascript "^2.2.1" + +registry-auth-token@^5.0.1: + version "5.1.0" + resolved "https://registry.yarnpkg.com/registry-auth-token/-/registry-auth-token-5.1.0.tgz#3c659047ecd4caebd25bc1570a3aa979ae490eca" + integrity sha512-GdekYuwLXLxMuFTwAPg5UKGLW/UXzQrZvH/Zj791BQif5T05T0RsaLfHc9q3ZOKi7n+BoprPD9mJ0O0k4xzUlw== + dependencies: + "@pnpm/npm-conf" "^2.1.0" + +registry-url@^6.0.0: + version "6.0.1" + resolved "https://registry.yarnpkg.com/registry-url/-/registry-url-6.0.1.tgz#056d9343680f2f64400032b1e199faa692286c58" + integrity sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q== + dependencies: + rc "1.2.8" + +regjsgen@^0.8.0: + version "0.8.0" + resolved "https://registry.yarnpkg.com/regjsgen/-/regjsgen-0.8.0.tgz#df23ff26e0c5b300a6470cad160a9d090c3a37ab" + integrity sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q== + +regjsparser@^0.12.0: + version "0.12.0" + resolved "https://registry.yarnpkg.com/regjsparser/-/regjsparser-0.12.0.tgz#0e846df6c6530586429377de56e0475583b088dc" + integrity sha512-cnE+y8bz4NhMjISKbgeVJtqNbtf5QpjZP+Bslo+UqkIt9QPnX9q095eiRRASJG1/tz6dlNr6Z5NsBiWYokp6EQ== + dependencies: + jsesc "~3.0.2" + +rehype-raw@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/rehype-raw/-/rehype-raw-7.0.0.tgz#59d7348fd5dbef3807bbaa1d443efd2dd85ecee4" + integrity sha512-/aE8hCfKlQeA8LmyeyQvQF3eBiLRGNlfBJEvWH7ivp9sBqs7TNqBL5X3v157rM4IFETqDnIOO+z5M/biZbo9Ww== + dependencies: + "@types/hast" "^3.0.0" + hast-util-raw "^9.0.0" + vfile "^6.0.0" + +rehype-recma@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/rehype-recma/-/rehype-recma-1.0.0.tgz#d68ef6344d05916bd96e25400c6261775411aa76" + integrity sha512-lqA4rGUf1JmacCNWWZx0Wv1dHqMwxzsDWYMTowuplHF3xH0N/MmrZ/G3BDZnzAkRmxDadujCjaKM2hqYdCBOGw== + dependencies: + "@types/estree" "^1.0.0" + "@types/hast" "^3.0.0" + hast-util-to-estree "^3.0.0" + +relateurl@^0.2.7: + version "0.2.7" + resolved "https://registry.yarnpkg.com/relateurl/-/relateurl-0.2.7.tgz#54dbf377e51440aca90a4cd274600d3ff2d888a9" + integrity sha512-G08Dxvm4iDN3MLM0EsP62EDV9IuhXPR6blNz6Utcp7zyV3tr4HVNINt6MpaRWbxoOHT3Q7YN2P+jaHX8vUbgog== + +remark-directive@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/remark-directive/-/remark-directive-3.0.1.tgz#689ba332f156cfe1118e849164cc81f157a3ef0a" + integrity sha512-gwglrEQEZcZYgVyG1tQuA+h58EZfq5CSULw7J90AFuCTyib1thgHPoqQ+h9iFvU6R+vnZ5oNFQR5QKgGpk741A== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-directive "^3.0.0" + micromark-extension-directive "^3.0.0" + unified "^11.0.0" + +remark-emoji@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/remark-emoji/-/remark-emoji-4.0.1.tgz#671bfda668047689e26b2078c7356540da299f04" + integrity sha512-fHdvsTR1dHkWKev9eNyhTo4EFwbUvJ8ka9SgeWkMPYFX4WoI7ViVBms3PjlQYgw5TLvNQso3GUB/b/8t3yo+dg== + dependencies: + "@types/mdast" "^4.0.2" + emoticon "^4.0.1" + mdast-util-find-and-replace "^3.0.1" + node-emoji "^2.1.0" + unified "^11.0.4" + +remark-frontmatter@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/remark-frontmatter/-/remark-frontmatter-5.0.0.tgz#b68d61552a421ec412c76f4f66c344627dc187a2" + integrity sha512-XTFYvNASMe5iPN0719nPrdItC9aU0ssC4v14mH1BCi1u0n1gAocqcujWUrByftZTbLhRtiKRyjYTSIOcr69UVQ== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-frontmatter "^2.0.0" + micromark-extension-frontmatter "^2.0.0" + unified "^11.0.0" + +remark-gfm@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/remark-gfm/-/remark-gfm-4.0.1.tgz#33227b2a74397670d357bf05c098eaf8513f0d6b" + integrity sha512-1quofZ2RQ9EWdeN34S79+KExV1764+wCUGop5CPL1WGdD0ocPpu91lzPGbwWMECpEpd42kJGQwzRfyov9j4yNg== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-gfm "^3.0.0" + micromark-extension-gfm "^3.0.0" + remark-parse "^11.0.0" + remark-stringify "^11.0.0" + unified "^11.0.0" + +remark-mdx@^3.0.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/remark-mdx/-/remark-mdx-3.1.1.tgz#047f97038bc7ec387aebb4b0a4fe23779999d845" + integrity sha512-Pjj2IYlUY3+D8x00UJsIOg5BEvfMyeI+2uLPn9VO9Wg4MEtN/VTIq2NEJQfde9PnX15KgtHyl9S0BcTnWrIuWg== + dependencies: + mdast-util-mdx "^3.0.0" + micromark-extension-mdxjs "^3.0.0" + +remark-parse@^11.0.0: + version "11.0.0" + resolved "https://registry.yarnpkg.com/remark-parse/-/remark-parse-11.0.0.tgz#aa60743fcb37ebf6b069204eb4da304e40db45a1" + integrity sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-from-markdown "^2.0.0" + micromark-util-types "^2.0.0" + unified "^11.0.0" + +remark-rehype@^11.0.0: + version "11.1.2" + resolved "https://registry.yarnpkg.com/remark-rehype/-/remark-rehype-11.1.2.tgz#2addaadda80ca9bd9aa0da763e74d16327683b37" + integrity sha512-Dh7l57ianaEoIpzbp0PC9UKAdCSVklD8E5Rpw7ETfbTl3FqcOOgq5q2LVDhgGCkaBv7p24JXikPdvhhmHvKMsw== + dependencies: + "@types/hast" "^3.0.0" + "@types/mdast" "^4.0.0" + mdast-util-to-hast "^13.0.0" + unified "^11.0.0" + vfile "^6.0.0" + +remark-stringify@^11.0.0: + version "11.0.0" + resolved "https://registry.yarnpkg.com/remark-stringify/-/remark-stringify-11.0.0.tgz#4c5b01dd711c269df1aaae11743eb7e2e7636fd3" + integrity sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw== + dependencies: + "@types/mdast" "^4.0.0" + mdast-util-to-markdown "^2.0.0" + unified "^11.0.0" + +renderkid@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/renderkid/-/renderkid-3.0.0.tgz#5fd823e4d6951d37358ecc9a58b1f06836b6268a" + integrity sha512-q/7VIQA8lmM1hF+jn+sFSPWGlMkSAeNYcPLmDQx2zzuiDfaLrOmumR8iaUKlenFgh0XRPIUeSPlH3A+AW3Z5pg== + dependencies: + css-select "^4.1.3" + dom-converter "^0.2.0" + htmlparser2 "^6.1.0" + lodash "^4.17.21" + strip-ansi "^6.0.1" + +repeat-string@^1.0.0: + version "1.6.1" + resolved "https://registry.yarnpkg.com/repeat-string/-/repeat-string-1.6.1.tgz#8dcae470e1c88abc2d600fff4a776286da75e637" + integrity sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w== + +require-from-string@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/require-from-string/-/require-from-string-2.0.2.tgz#89a7fdd938261267318eafe14f9c32e598c36909" + integrity sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw== + +"require-like@>= 0.1.1": + version "0.1.2" + resolved "https://registry.yarnpkg.com/require-like/-/require-like-0.1.2.tgz#ad6f30c13becd797010c468afa775c0c0a6b47fa" + integrity sha512-oyrU88skkMtDdauHDuKVrgR+zuItqr6/c//FXzvmxRGMexSDc6hNvJInGW3LL46n+8b50RykrvwSUIIQH2LQ5A== + +requires-port@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/requires-port/-/requires-port-1.0.0.tgz#925d2601d39ac485e091cf0da5c6e694dc3dcaff" + integrity sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ== + +resolve-alpn@^1.2.0: + version "1.2.1" + resolved "https://registry.yarnpkg.com/resolve-alpn/-/resolve-alpn-1.2.1.tgz#b7adbdac3546aaaec20b45e7d8265927072726f9" + integrity sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g== + +resolve-from@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6" + integrity sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g== + +resolve-pathname@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/resolve-pathname/-/resolve-pathname-3.0.0.tgz#99d02224d3cf263689becbb393bc560313025dcd" + integrity sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng== + +resolve@^1.19.0, resolve@^1.22.10: + version "1.22.10" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.22.10.tgz#b663e83ffb09bbf2386944736baae803029b8b39" + integrity sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w== + dependencies: + is-core-module "^2.16.0" + path-parse "^1.0.7" + supports-preserve-symlinks-flag "^1.0.0" + +responselike@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/responselike/-/responselike-3.0.0.tgz#20decb6c298aff0dbee1c355ca95461d42823626" + integrity sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg== + dependencies: + lowercase-keys "^3.0.0" + +retry@^0.13.1: + version "0.13.1" + resolved "https://registry.yarnpkg.com/retry/-/retry-0.13.1.tgz#185b1587acf67919d63b357349e03537b2484658" + integrity sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg== + +reusify@^1.0.4: + version "1.1.0" + resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.1.0.tgz#0fe13b9522e1473f51b558ee796e08f11f9b489f" + integrity sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw== + +rimraf@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a" + integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA== + dependencies: + glob "^7.1.3" + +rtlcss@^4.1.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/rtlcss/-/rtlcss-4.3.0.tgz#f8efd4d5b64f640ec4af8fa25b65bacd9e07cc97" + integrity sha512-FI+pHEn7Wc4NqKXMXFM+VAYKEj/mRIcW4h24YVwVtyjI+EqGrLc2Hx/Ny0lrZ21cBWU2goLy36eqMcNj3AQJig== + dependencies: + escalade "^3.1.1" + picocolors "^1.0.0" + postcss "^8.4.21" + strip-json-comments "^3.1.1" + +run-parallel@^1.1.9: + version "1.2.0" + resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" + integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== + dependencies: + queue-microtask "^1.2.2" + +safe-buffer@5.2.1, safe-buffer@>=5.1.0, safe-buffer@^5.1.0, safe-buffer@~5.2.0: + version "5.2.1" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6" + integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== + +safe-buffer@~5.1.0, safe-buffer@~5.1.1: + version "5.1.2" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d" + integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g== + +"safer-buffer@>= 2.1.2 < 3": + version "2.1.2" + resolved "https://registry.yarnpkg.com/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a" + integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== + +sax@^1.2.4: + version "1.4.1" + resolved "https://registry.yarnpkg.com/sax/-/sax-1.4.1.tgz#44cc8988377f126304d3b3fc1010c733b929ef0f" + integrity sha512-+aWOz7yVScEGoKNd4PA10LZ8sk0A/z5+nXQG5giUO5rprX9jgYsTdov9qCchZiPIZezbZH+jRut8nPodFAX4Jg== + +scheduler@^0.26.0: + version "0.26.0" + resolved "https://registry.yarnpkg.com/scheduler/-/scheduler-0.26.0.tgz#4ce8a8c2a2095f13ea11bf9a445be50c555d6337" + integrity sha512-NlHwttCI/l5gCPR3D1nNXtWABUmBwvZpEQiD4IXSbIDq8BzLIK/7Ir5gTFSGZDUu37K5cMNp0hFtzO38sC7gWA== + +schema-dts@^1.1.2: + version "1.1.5" + resolved "https://registry.yarnpkg.com/schema-dts/-/schema-dts-1.1.5.tgz#9237725d305bac3469f02b292a035107595dc324" + integrity sha512-RJr9EaCmsLzBX2NDiO5Z3ux2BVosNZN5jo0gWgsyKvxKIUL5R3swNvoorulAeL9kLB0iTSX7V6aokhla2m7xbg== + +schema-utils@^3.0.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-3.3.0.tgz#f50a88877c3c01652a15b622ae9e9795df7a60fe" + integrity sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg== + dependencies: + "@types/json-schema" "^7.0.8" + ajv "^6.12.5" + ajv-keywords "^3.5.2" + +schema-utils@^4.0.0, schema-utils@^4.0.1, schema-utils@^4.3.0, schema-utils@^4.3.2: + version "4.3.2" + resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-4.3.2.tgz#0c10878bf4a73fd2b1dfd14b9462b26788c806ae" + integrity sha512-Gn/JaSk/Mt9gYubxTtSn/QCV4em9mpAPiR1rqy/Ocu19u/G9J5WWdNoUT4SiV6mFC3y6cxyFcFwdzPM3FgxGAQ== + dependencies: + "@types/json-schema" "^7.0.9" + ajv "^8.9.0" + ajv-formats "^2.1.1" + ajv-keywords "^5.1.0" + +section-matter@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/section-matter/-/section-matter-1.0.0.tgz#e9041953506780ec01d59f292a19c7b850b84167" + integrity sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA== + dependencies: + extend-shallow "^2.0.1" + kind-of "^6.0.0" + +select-hose@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/select-hose/-/select-hose-2.0.0.tgz#625d8658f865af43ec962bfc376a37359a4994ca" + integrity sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg== + +select@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/select/-/select-1.1.2.tgz#0e7350acdec80b1108528786ec1d4418d11b396d" + integrity sha512-OwpTSOfy6xSs1+pwcNrv0RBMOzI39Lp3qQKUTPVVPRjCdNa5JH/oPRiqsesIskK8TVgmRiHwO4KXlV2Li9dANA== + +selfsigned@^2.1.1: + version "2.4.1" + resolved "https://registry.yarnpkg.com/selfsigned/-/selfsigned-2.4.1.tgz#560d90565442a3ed35b674034cec4e95dceb4ae0" + integrity sha512-th5B4L2U+eGLq1TVh7zNRGBapioSORUeymIydxgFpwww9d2qyKvtuPU2jJuHvYAwwqi2Y596QBL3eEqcPEYL8Q== + dependencies: + "@types/node-forge" "^1.3.0" + node-forge "^1" + +semver-diff@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/semver-diff/-/semver-diff-4.0.0.tgz#3afcf5ed6d62259f5c72d0d5d50dffbdc9680df5" + integrity sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA== + dependencies: + semver "^7.3.5" + +semver@^6.3.1: + version "6.3.1" + resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.1.tgz#556d2ef8689146e46dcea4bfdd095f3434dffcb4" + integrity sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA== + +semver@^7.3.5, semver@^7.3.7, semver@^7.5.4: + version "7.7.2" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.2.tgz#67d99fdcd35cec21e6f8b87a7fd515a33f982b58" + integrity sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA== + +send@0.19.0: + version "0.19.0" + resolved "https://registry.yarnpkg.com/send/-/send-0.19.0.tgz#bbc5a388c8ea6c048967049dbeac0e4a3f09d7f8" + integrity sha512-dW41u5VfLXu8SJh5bwRmyYUbAoSB3c9uQh6L8h/KtsFREPWpbX1lrljJo186Jc4nmci/sGUZ9a0a0J2zgfq2hw== + dependencies: + debug "2.6.9" + depd "2.0.0" + destroy "1.2.0" + encodeurl "~1.0.2" + escape-html "~1.0.3" + etag "~1.8.1" + fresh "0.5.2" + http-errors "2.0.0" + mime "1.6.0" + ms "2.1.3" + on-finished "2.4.1" + range-parser "~1.2.1" + statuses "2.0.1" + +serialize-javascript@^6.0.0, serialize-javascript@^6.0.1, serialize-javascript@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/serialize-javascript/-/serialize-javascript-6.0.2.tgz#defa1e055c83bf6d59ea805d8da862254eb6a6c2" + integrity sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g== + dependencies: + randombytes "^2.1.0" + +serve-handler@^6.1.6: + version "6.1.6" + resolved "https://registry.yarnpkg.com/serve-handler/-/serve-handler-6.1.6.tgz#50803c1d3e947cd4a341d617f8209b22bd76cfa1" + integrity sha512-x5RL9Y2p5+Sh3D38Fh9i/iQ5ZK+e4xuXRd/pGbM4D13tgo/MGwbttUk8emytcr1YYzBYs+apnUngBDFYfpjPuQ== + dependencies: + bytes "3.0.0" + content-disposition "0.5.2" + mime-types "2.1.18" + minimatch "3.1.2" + path-is-inside "1.0.2" + path-to-regexp "3.3.0" + range-parser "1.2.0" + +serve-index@^1.9.1: + version "1.9.1" + resolved "https://registry.yarnpkg.com/serve-index/-/serve-index-1.9.1.tgz#d3768d69b1e7d82e5ce050fff5b453bea12a9239" + integrity sha512-pXHfKNP4qujrtteMrSBb0rc8HJ9Ms/GrXwcUtUtD5s4ewDJI8bT3Cz2zTVRMKtri49pLx2e0Ya8ziP5Ya2pZZw== + dependencies: + accepts "~1.3.4" + batch "0.6.1" + debug "2.6.9" + escape-html "~1.0.3" + http-errors "~1.6.2" + mime-types "~2.1.17" + parseurl "~1.3.2" + +serve-static@1.16.2: + version "1.16.2" + resolved "https://registry.yarnpkg.com/serve-static/-/serve-static-1.16.2.tgz#b6a5343da47f6bdd2673848bf45754941e803296" + integrity sha512-VqpjJZKadQB/PEbEwvFdO43Ax5dFBZ2UECszz8bQ7pi7wt//PWe1P6MN7eCnjsatYtBT6EuiClbjSWP2WrIoTw== + dependencies: + encodeurl "~2.0.0" + escape-html "~1.0.3" + parseurl "~1.3.3" + send "0.19.0" + +set-function-length@^1.2.2: + version "1.2.2" + resolved "https://registry.yarnpkg.com/set-function-length/-/set-function-length-1.2.2.tgz#aac72314198eaed975cf77b2c3b6b880695e5449" + integrity sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg== + dependencies: + define-data-property "^1.1.4" + es-errors "^1.3.0" + function-bind "^1.1.2" + get-intrinsic "^1.2.4" + gopd "^1.0.1" + has-property-descriptors "^1.0.2" + +setprototypeof@1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.1.0.tgz#d0bd85536887b6fe7c0d818cb962d9d91c54e656" + integrity sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ== + +setprototypeof@1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.2.0.tgz#66c9a24a73f9fc28cbe66b09fed3d33dcaf1b424" + integrity sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw== + +shallow-clone@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/shallow-clone/-/shallow-clone-3.0.1.tgz#8f2981ad92531f55035b01fb230769a40e02efa3" + integrity sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA== + dependencies: + kind-of "^6.0.2" + +shallowequal@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/shallowequal/-/shallowequal-1.1.0.tgz#188d521de95b9087404fd4dcb68b13df0ae4e7f8" + integrity sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ== + +shebang-command@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-2.0.0.tgz#ccd0af4f8835fbdc265b82461aaf0c36663f34ea" + integrity sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA== + dependencies: + shebang-regex "^3.0.0" + +shebang-regex@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" + integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== + +shell-quote@^1.8.3: + version "1.8.3" + resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.8.3.tgz#55e40ef33cf5c689902353a3d8cd1a6725f08b4b" + integrity sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw== + +side-channel-list@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/side-channel-list/-/side-channel-list-1.0.0.tgz#10cb5984263115d3b7a0e336591e290a830af8ad" + integrity sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA== + dependencies: + es-errors "^1.3.0" + object-inspect "^1.13.3" + +side-channel-map@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/side-channel-map/-/side-channel-map-1.0.1.tgz#d6bb6b37902c6fef5174e5f533fab4c732a26f42" + integrity sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA== + dependencies: + call-bound "^1.0.2" + es-errors "^1.3.0" + get-intrinsic "^1.2.5" + object-inspect "^1.13.3" + +side-channel-weakmap@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz#11dda19d5368e40ce9ec2bdc1fb0ecbc0790ecea" + integrity sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A== + dependencies: + call-bound "^1.0.2" + es-errors "^1.3.0" + get-intrinsic "^1.2.5" + object-inspect "^1.13.3" + side-channel-map "^1.0.1" + +side-channel@^1.0.6: + version "1.1.0" + resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.1.0.tgz#c3fcff9c4da932784873335ec9765fa94ff66bc9" + integrity sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw== + dependencies: + es-errors "^1.3.0" + object-inspect "^1.13.3" + side-channel-list "^1.0.0" + side-channel-map "^1.0.1" + side-channel-weakmap "^1.0.2" + +signal-exit@^3.0.2, signal-exit@^3.0.3: + version "3.0.7" + resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.7.tgz#a9a1767f8af84155114eaabd73f99273c8f59ad9" + integrity sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ== + +sirv@^2.0.3: + version "2.0.4" + resolved "https://registry.yarnpkg.com/sirv/-/sirv-2.0.4.tgz#5dd9a725c578e34e449f332703eb2a74e46a29b0" + integrity sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ== + dependencies: + "@polka/url" "^1.0.0-next.24" + mrmime "^2.0.0" + totalist "^3.0.0" + +sisteransi@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/sisteransi/-/sisteransi-1.0.5.tgz#134d681297756437cc05ca01370d3a7a571075ed" + integrity sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg== + +sitemap@^7.1.1: + version "7.1.2" + resolved "https://registry.yarnpkg.com/sitemap/-/sitemap-7.1.2.tgz#6ce1deb43f6f177c68bc59cf93632f54e3ae6b72" + integrity sha512-ARCqzHJ0p4gWt+j7NlU5eDlIO9+Rkr/JhPFZKKQ1l5GCus7rJH4UdrlVAh0xC/gDS/Qir2UMxqYNHtsKr2rpCw== + dependencies: + "@types/node" "^17.0.5" + "@types/sax" "^1.2.1" + arg "^5.0.0" + sax "^1.2.4" + +skin-tone@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/skin-tone/-/skin-tone-2.0.0.tgz#4e3933ab45c0d4f4f781745d64b9f4c208e41237" + integrity sha512-kUMbT1oBJCpgrnKoSr0o6wPtvRWT9W9UKvGLwfJYO2WuahZRHOpEyL1ckyMGgMWh0UdpmaoFqKKD29WTomNEGA== + dependencies: + unicode-emoji-modifier-base "^1.0.0" + +slash@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634" + integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q== + +slash@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/slash/-/slash-4.0.0.tgz#2422372176c4c6c5addb5e2ada885af984b396a7" + integrity sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew== + +snake-case@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/snake-case/-/snake-case-3.0.4.tgz#4f2bbd568e9935abdfd593f34c691dadb49c452c" + integrity sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg== + dependencies: + dot-case "^3.0.4" + tslib "^2.0.3" + +sockjs@^0.3.24: + version "0.3.24" + resolved "https://registry.yarnpkg.com/sockjs/-/sockjs-0.3.24.tgz#c9bc8995f33a111bea0395ec30aa3206bdb5ccce" + integrity sha512-GJgLTZ7vYb/JtPSSZ10hsOYIvEYsjbNU+zPdIHcUaWVNUEPivzxku31865sSSud0Da0W4lEeOPlmw93zLQchuQ== + dependencies: + faye-websocket "^0.11.3" + uuid "^8.3.2" + websocket-driver "^0.7.4" + +sort-css-media-queries@2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/sort-css-media-queries/-/sort-css-media-queries-2.2.0.tgz#aa33cf4a08e0225059448b6c40eddbf9f1c8334c" + integrity sha512-0xtkGhWCC9MGt/EzgnvbbbKhqWjl1+/rncmhTh5qCpbYguXh6S/qwePfv/JQ8jePXXmqingylxoC49pCkSPIbA== + +source-map-js@^1.0.1, source-map-js@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.2.1.tgz#1ce5650fddd87abc099eda37dcff024c2667ae46" + integrity sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA== + +source-map-support@~0.5.20: + version "0.5.21" + resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.21.tgz#04fe7c7f9e1ed2d662233c28cb2b35b9f63f6e4f" + integrity sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w== + dependencies: + buffer-from "^1.0.0" + source-map "^0.6.0" + +source-map@^0.5.7: + version "0.5.7" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.7.tgz#8a039d2d1021d22d1ea14c80d8ea468ba2ef3fcc" + integrity sha512-LbrmJOMUSdEVxIKvdcJzQC+nQhe8FUZQTXQy6+I75skNgn3OoQ0DZA8YnFa7gp8tqtL3KPf1kmo0R5DoApeSGQ== + +source-map@^0.6.0, source-map@~0.6.0: + version "0.6.1" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263" + integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== + +source-map@^0.7.0: + version "0.7.6" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.7.6.tgz#a3658ab87e5b6429c8a1f3ba0083d4c61ca3ef02" + integrity sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ== + +space-separated-tokens@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz#1ecd9d2350a3844572c3f4a312bceb018348859f" + integrity sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q== + +spdy-transport@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/spdy-transport/-/spdy-transport-3.0.0.tgz#00d4863a6400ad75df93361a1608605e5dcdcf31" + integrity sha512-hsLVFE5SjA6TCisWeJXFKniGGOpBgMLmerfO2aCyCU5s7nJ/rpAepqmFifv/GCbSbueEeAJJnmSQ2rKC/g8Fcw== + dependencies: + debug "^4.1.0" + detect-node "^2.0.4" + hpack.js "^2.1.6" + obuf "^1.1.2" + readable-stream "^3.0.6" + wbuf "^1.7.3" + +spdy@^4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/spdy/-/spdy-4.0.2.tgz#b74f466203a3eda452c02492b91fb9e84a27677b" + integrity sha512-r46gZQZQV+Kl9oItvl1JZZqJKGr+oEkB08A6BzkiR7593/7IbtuncXHd2YoYeTsG4157ZssMu9KYvUHLcjcDoA== + dependencies: + debug "^4.1.0" + handle-thing "^2.0.0" + http-deceiver "^1.2.7" + select-hose "^2.0.0" + spdy-transport "^3.0.0" + +sprintf-js@~1.0.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c" + integrity sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g== + +srcset@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/srcset/-/srcset-4.0.0.tgz#336816b665b14cd013ba545b6fe62357f86e65f4" + integrity sha512-wvLeHgcVHKO8Sc/H/5lkGreJQVeYMm9rlmt8PuR1xE31rIuXhuzznUUqAt8MqLhB3MqJdFzlNAfpcWnxiFUcPw== + +statuses@2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/statuses/-/statuses-2.0.1.tgz#55cb000ccf1d48728bd23c685a063998cf1a1b63" + integrity sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ== + +"statuses@>= 1.4.0 < 2": + version "1.5.0" + resolved "https://registry.yarnpkg.com/statuses/-/statuses-1.5.0.tgz#161c7dac177659fd9811f43771fa99381478628c" + integrity sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA== + +std-env@^3.7.0: + version "3.9.0" + resolved "https://registry.yarnpkg.com/std-env/-/std-env-3.9.0.tgz#1a6f7243b339dca4c9fd55e1c7504c77ef23e8f1" + integrity sha512-UGvjygr6F6tpH7o2qyqR6QYpwraIjKSdtzyBdyytFOHmPZY917kwdwLG0RbOjWOnKmnm3PeHjaoLLMie7kPLQw== + +string-width@^4.1.0, string-width@^4.2.0: + version "4.2.3" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" + integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.1" + +string-width@^5.0.1, string-width@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-5.1.2.tgz#14f8daec6d81e7221d2a357e668cab73bdbca794" + integrity sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA== + dependencies: + eastasianwidth "^0.2.0" + emoji-regex "^9.2.2" + strip-ansi "^7.0.1" + +string_decoder@^1.1.1: + version "1.3.0" + resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.3.0.tgz#42f114594a46cf1a8e30b0a84f56c78c3edac21e" + integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== + dependencies: + safe-buffer "~5.2.0" + +string_decoder@~1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.1.1.tgz#9cf1611ba62685d7030ae9e4ba34149c3af03fc8" + integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== + dependencies: + safe-buffer "~5.1.0" + +stringify-entities@^4.0.0: + version "4.0.4" + resolved "https://registry.yarnpkg.com/stringify-entities/-/stringify-entities-4.0.4.tgz#b3b79ef5f277cc4ac73caeb0236c5ba939b3a4f3" + integrity sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg== + dependencies: + character-entities-html4 "^2.0.0" + character-entities-legacy "^3.0.0" + +stringify-object@^3.3.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/stringify-object/-/stringify-object-3.3.0.tgz#703065aefca19300d3ce88af4f5b3956d7556629" + integrity sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw== + dependencies: + get-own-enumerable-property-symbols "^3.0.0" + is-obj "^1.0.1" + is-regexp "^1.0.0" + +strip-ansi@^6.0.0, strip-ansi@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" + integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== + dependencies: + ansi-regex "^5.0.1" + +strip-ansi@^7.0.1: + version "7.1.2" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.1.2.tgz#132875abde678c7ea8d691533f2e7e22bb744dba" + integrity sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA== + dependencies: + ansi-regex "^6.0.1" + +strip-bom-string@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/strip-bom-string/-/strip-bom-string-1.0.0.tgz#e5211e9224369fbb81d633a2f00044dc8cedad92" + integrity sha512-uCC2VHvQRYu+lMh4My/sFNmF2klFymLX1wHJeXnbEJERpV/ZsVuonzerjfrGpIGF7LBVa1O7i9kjiWvJiFck8g== + +strip-final-newline@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/strip-final-newline/-/strip-final-newline-2.0.0.tgz#89b852fb2fcbe936f6f4b3187afb0a12c1ab58ad" + integrity sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA== + +strip-json-comments@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-3.1.1.tgz#31f1281b3832630434831c310c01cccda8cbe006" + integrity sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig== + +strip-json-comments@~2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-2.0.1.tgz#3c531942e908c2697c0ec344858c286c7ca0a60a" + integrity sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ== + +style-to-js@^1.0.0: + version "1.1.17" + resolved "https://registry.yarnpkg.com/style-to-js/-/style-to-js-1.1.17.tgz#488b1558a8c1fd05352943f088cc3ce376813d83" + integrity sha512-xQcBGDxJb6jjFCTzvQtfiPn6YvvP2O8U1MDIPNfJQlWMYfktPy+iGsHE7cssjs7y84d9fQaK4UF3RIJaAHSoYA== + dependencies: + style-to-object "1.0.9" + +style-to-object@1.0.9: + version "1.0.9" + resolved "https://registry.yarnpkg.com/style-to-object/-/style-to-object-1.0.9.tgz#35c65b713f4a6dba22d3d0c61435f965423653f0" + integrity sha512-G4qppLgKu/k6FwRpHiGiKPaPTFcG3g4wNVX/Qsfu+RqQM30E7Tyu/TEgxcL9PNLF5pdRLwQdE3YKKf+KF2Dzlw== + dependencies: + inline-style-parser "0.2.4" + +stylehacks@^6.1.1: + version "6.1.1" + resolved "https://registry.yarnpkg.com/stylehacks/-/stylehacks-6.1.1.tgz#543f91c10d17d00a440430362d419f79c25545a6" + integrity sha512-gSTTEQ670cJNoaeIp9KX6lZmm8LJ3jPB5yJmX8Zq/wQxOsAFXV3qjWzHas3YYk1qesuVIyYWWUpZ0vSE/dTSGg== + dependencies: + browserslist "^4.23.0" + postcss-selector-parser "^6.0.16" + +stylis@4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/stylis/-/stylis-4.2.0.tgz#79daee0208964c8fe695a42fcffcac633a211a51" + integrity sha512-Orov6g6BB1sDfYgzWfTHDOxamtX1bE/zo104Dh9e6fqJ3PooipYyfJ0pUmrZO2wAvO8YbEyeFrkV91XTsGMSrw== + +supports-color@^7.1.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.2.0.tgz#1b7dcdcb32b8138801b3e478ba6a51caa89648da" + integrity sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw== + dependencies: + has-flag "^4.0.0" + +supports-color@^8.0.0: + version "8.1.1" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-8.1.1.tgz#cd6fc17e28500cff56c1b86c0a7fd4a54a73005c" + integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== + dependencies: + has-flag "^4.0.0" + +supports-preserve-symlinks-flag@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09" + integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== + +svg-parser@^2.0.4: + version "2.0.4" + resolved "https://registry.yarnpkg.com/svg-parser/-/svg-parser-2.0.4.tgz#fdc2e29e13951736140b76cb122c8ee6630eb6b5" + integrity sha512-e4hG1hRwoOdRb37cIMSgzNsxyzKfayW6VOflrwvR+/bzrkyxY/31WkbgnQpgtrNp1SdpJvpUAGTa/ZoiPNDuRQ== + +svgo@^3.0.2, svgo@^3.2.0: + version "3.3.2" + resolved "https://registry.yarnpkg.com/svgo/-/svgo-3.3.2.tgz#ad58002652dffbb5986fc9716afe52d869ecbda8" + integrity sha512-OoohrmuUlBs8B8o6MB2Aevn+pRIH9zDALSR+6hhqVfa6fRwG/Qw9VUMSMW9VNg2CFc/MTIfabtdOVl9ODIJjpw== + dependencies: + "@trysound/sax" "0.2.0" + commander "^7.2.0" + css-select "^5.1.0" + css-tree "^2.3.1" + css-what "^6.1.0" + csso "^5.0.5" + picocolors "^1.0.0" + +tapable@^2.0.0, tapable@^2.1.1, tapable@^2.2.0, tapable@^2.2.1: + version "2.2.3" + resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.3.tgz#4b67b635b2d97578a06a2713d2f04800c237e99b" + integrity sha512-ZL6DDuAlRlLGghwcfmSn9sK3Hr6ArtyudlSAiCqQ6IfE+b+HHbydbYDIG15IfS5do+7XQQBdBiubF/cV2dnDzg== + +terser-webpack-plugin@^5.3.11, terser-webpack-plugin@^5.3.9: + version "5.3.14" + resolved "https://registry.yarnpkg.com/terser-webpack-plugin/-/terser-webpack-plugin-5.3.14.tgz#9031d48e57ab27567f02ace85c7d690db66c3e06" + integrity sha512-vkZjpUjb6OMS7dhV+tILUW6BhpDR7P2L/aQSAv+Uwk+m8KATX9EccViHTJR2qDtACKPIYndLGCyl3FMo+r2LMw== + dependencies: + "@jridgewell/trace-mapping" "^0.3.25" + jest-worker "^27.4.5" + schema-utils "^4.3.0" + serialize-javascript "^6.0.2" + terser "^5.31.1" + +terser@^5.10.0, terser@^5.15.1, terser@^5.31.1: + version "5.44.0" + resolved "https://registry.yarnpkg.com/terser/-/terser-5.44.0.tgz#ebefb8e5b8579d93111bfdfc39d2cf63879f4a82" + integrity sha512-nIVck8DK+GM/0Frwd+nIhZ84pR/BX7rmXMfYwyg+Sri5oGVE99/E3KvXqpC2xHFxyqXyGHTKBSioxxplrO4I4w== + dependencies: + "@jridgewell/source-map" "^0.3.3" + acorn "^8.15.0" + commander "^2.20.0" + source-map-support "~0.5.20" + +thunky@^1.0.2: + version "1.1.0" + resolved "https://registry.yarnpkg.com/thunky/-/thunky-1.1.0.tgz#5abaf714a9405db0504732bbccd2cedd9ef9537d" + integrity sha512-eHY7nBftgThBqOyHGVN+l8gF0BucP09fMo0oO/Lb0w1OF80dJv+lDVpXG60WMQvkcxAkNybKsrEIE3ZtKGmPrA== + +tiny-emitter@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/tiny-emitter/-/tiny-emitter-2.1.0.tgz#1d1a56edfc51c43e863cbb5382a72330e3555423" + integrity sha512-NB6Dk1A9xgQPMoGqC5CVXn123gWyte215ONT5Pp5a0yt4nlEoO1ZWeCwpncaekPHXO60i47ihFnZPiRPjRMq4Q== + +tiny-invariant@^1.0.2: + version "1.3.3" + resolved "https://registry.yarnpkg.com/tiny-invariant/-/tiny-invariant-1.3.3.tgz#46680b7a873a0d5d10005995eb90a70d74d60127" + integrity sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg== + +tiny-warning@^1.0.0: + version "1.0.3" + resolved "https://registry.yarnpkg.com/tiny-warning/-/tiny-warning-1.0.3.tgz#94a30db453df4c643d0fd566060d60a875d84754" + integrity sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA== + +tinypool@^1.0.2: + version "1.1.1" + resolved "https://registry.yarnpkg.com/tinypool/-/tinypool-1.1.1.tgz#059f2d042bd37567fbc017d3d426bdd2a2612591" + integrity sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg== + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +toidentifier@1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/toidentifier/-/toidentifier-1.0.1.tgz#3be34321a88a820ed1bd80dfaa33e479fbb8dd35" + integrity sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA== + +totalist@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/totalist/-/totalist-3.0.1.tgz#ba3a3d600c915b1a97872348f79c127475f6acf8" + integrity sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ== + +trim-lines@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/trim-lines/-/trim-lines-3.0.1.tgz#d802e332a07df861c48802c04321017b1bd87338" + integrity sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg== + +trough@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/trough/-/trough-2.2.0.tgz#94a60bd6bd375c152c1df911a4b11d5b0256f50f" + integrity sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw== + +tslib@^2.0.3, tslib@^2.6.0: + version "2.8.1" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" + integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== + +type-fest@^0.21.3: + version "0.21.3" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.21.3.tgz#d260a24b0198436e133fa26a524a6d65fa3b2e37" + integrity sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w== + +type-fest@^1.0.1: + version "1.4.0" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-1.4.0.tgz#e9fb813fe3bf1744ec359d55d1affefa76f14be1" + integrity sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA== + +type-fest@^2.13.0, type-fest@^2.5.0: + version "2.19.0" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-2.19.0.tgz#88068015bb33036a598b952e55e9311a60fd3a9b" + integrity sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA== + +type-is@~1.6.18: + version "1.6.18" + resolved "https://registry.yarnpkg.com/type-is/-/type-is-1.6.18.tgz#4e552cd05df09467dcbc4ef739de89f2cf37c131" + integrity sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g== + dependencies: + media-typer "0.3.0" + mime-types "~2.1.24" + +typedarray-to-buffer@^3.1.5: + version "3.1.5" + resolved "https://registry.yarnpkg.com/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz#a97ee7a9ff42691b9f783ff1bc5112fe3fca9080" + integrity sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q== + dependencies: + is-typedarray "^1.0.0" + +undici-types@~7.12.0: + version "7.12.0" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-7.12.0.tgz#15c5c7475c2a3ba30659529f5cdb4674b622fafb" + integrity sha512-goOacqME2GYyOZZfb5Lgtu+1IDmAlAEu5xnD3+xTzS10hT0vzpf0SPjkXwAw9Jm+4n/mQGDP3LO8CPbYROeBfQ== + +unicode-canonical-property-names-ecmascript@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz#cb3173fe47ca743e228216e4a3ddc4c84d628cc2" + integrity sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg== + +unicode-emoji-modifier-base@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/unicode-emoji-modifier-base/-/unicode-emoji-modifier-base-1.0.0.tgz#dbbd5b54ba30f287e2a8d5a249da6c0cef369459" + integrity sha512-yLSH4py7oFH3oG/9K+XWrz1pSi3dfUrWEnInbxMfArOfc1+33BlGPQtLsOYwvdMy11AwUBetYuaRxSPqgkq+8g== + +unicode-match-property-ecmascript@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz#54fd16e0ecb167cf04cf1f756bdcc92eba7976c3" + integrity sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q== + dependencies: + unicode-canonical-property-names-ecmascript "^2.0.0" + unicode-property-aliases-ecmascript "^2.0.0" + +unicode-match-property-value-ecmascript@^2.2.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.1.tgz#65a7adfad8574c219890e219285ce4c64ed67eaa" + integrity sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg== + +unicode-property-aliases-ecmascript@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.2.0.tgz#301d4f8a43d2b75c97adfad87c9dd5350c9475d1" + integrity sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ== + +unified@^11.0.0, unified@^11.0.3, unified@^11.0.4: + version "11.0.5" + resolved "https://registry.yarnpkg.com/unified/-/unified-11.0.5.tgz#f66677610a5c0a9ee90cab2b8d4d66037026d9e1" + integrity sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA== + dependencies: + "@types/unist" "^3.0.0" + bail "^2.0.0" + devlop "^1.0.0" + extend "^3.0.0" + is-plain-obj "^4.0.0" + trough "^2.0.0" + vfile "^6.0.0" + +unique-string@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/unique-string/-/unique-string-3.0.0.tgz#84a1c377aff5fd7a8bc6b55d8244b2bd90d75b9a" + integrity sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ== + dependencies: + crypto-random-string "^4.0.0" + +unist-util-is@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/unist-util-is/-/unist-util-is-6.0.0.tgz#b775956486aff107a9ded971d996c173374be424" + integrity sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-position-from-estree@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/unist-util-position-from-estree/-/unist-util-position-from-estree-2.0.0.tgz#d94da4df596529d1faa3de506202f0c9a23f2200" + integrity sha512-KaFVRjoqLyF6YXCbVLNad/eS4+OfPQQn2yOd7zF/h5T/CSL2v8NpN6a5TPvtbXthAGw5nG+PuTtq+DdIZr+cRQ== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-position@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/unist-util-position/-/unist-util-position-5.0.0.tgz#678f20ab5ca1207a97d7ea8a388373c9cf896be4" + integrity sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-stringify-position@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz#449c6e21a880e0855bf5aabadeb3a740314abac2" + integrity sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ== + dependencies: + "@types/unist" "^3.0.0" + +unist-util-visit-parents@^6.0.0: + version "6.0.1" + resolved "https://registry.yarnpkg.com/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz#4d5f85755c3b8f0dc69e21eca5d6d82d22162815" + integrity sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw== + dependencies: + "@types/unist" "^3.0.0" + unist-util-is "^6.0.0" + +unist-util-visit@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/unist-util-visit/-/unist-util-visit-5.0.0.tgz#a7de1f31f72ffd3519ea71814cccf5fd6a9217d6" + integrity sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg== + dependencies: + "@types/unist" "^3.0.0" + unist-util-is "^6.0.0" + unist-util-visit-parents "^6.0.0" + +universalify@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.1.tgz#168efc2180964e6386d061e094df61afe239b18d" + integrity sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw== + +unpipe@1.0.0, unpipe@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec" + integrity sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ== + +update-browserslist-db@^1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.1.3.tgz#348377dd245216f9e7060ff50b15a1b740b75420" + integrity sha512-UxhIZQ+QInVdunkDAaiazvvT/+fXL5Osr0JZlJulepYu6Jd7qJtDZjlur0emRlT71EN3ScPoE7gvsuIKKNavKw== + dependencies: + escalade "^3.2.0" + picocolors "^1.1.1" + +update-notifier@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/update-notifier/-/update-notifier-6.0.2.tgz#a6990253dfe6d5a02bd04fbb6a61543f55026b60" + integrity sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og== + dependencies: + boxen "^7.0.0" + chalk "^5.0.1" + configstore "^6.0.0" + has-yarn "^3.0.0" + import-lazy "^4.0.0" + is-ci "^3.0.1" + is-installed-globally "^0.4.0" + is-npm "^6.0.0" + is-yarn-global "^0.4.0" + latest-version "^7.0.0" + pupa "^3.1.0" + semver "^7.3.7" + semver-diff "^4.0.0" + xdg-basedir "^5.1.0" + +uri-js@^4.2.2: + version "4.4.1" + resolved "https://registry.yarnpkg.com/uri-js/-/uri-js-4.4.1.tgz#9b1a52595225859e55f669d928f88c6c57f2a77e" + integrity sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== + dependencies: + punycode "^2.1.0" + +url-loader@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/url-loader/-/url-loader-4.1.1.tgz#28505e905cae158cf07c92ca622d7f237e70a4e2" + integrity sha512-3BTV812+AVHHOJQO8O5MkWgZ5aosP7GnROJwvzLS9hWDj00lZ6Z0wNak423Lp9PBZN05N+Jk/N5Si8jRAlGyWA== + dependencies: + loader-utils "^2.0.0" + mime-types "^2.1.27" + schema-utils "^3.0.0" + +util-deprecate@^1.0.1, util-deprecate@^1.0.2, util-deprecate@~1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" + integrity sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw== + +utila@~0.4: + version "0.4.0" + resolved "https://registry.yarnpkg.com/utila/-/utila-0.4.0.tgz#8a16a05d445657a3aea5eecc5b12a4fa5379772c" + integrity sha512-Z0DbgELS9/L/75wZbro8xAnT50pBVFQZ+hUEueGDU5FN51YSCYM+jdxsfCiHjwNP/4LCDD0i/graKpeBnOXKRA== + +utility-types@^3.10.0: + version "3.11.0" + resolved "https://registry.yarnpkg.com/utility-types/-/utility-types-3.11.0.tgz#607c40edb4f258915e901ea7995607fdf319424c" + integrity sha512-6Z7Ma2aVEWisaL6TvBCy7P8rm2LQoPv6dJ7ecIaIixHcwfbJ0x7mWdbcwlIM5IGQxPZSFYeqRCqlOOeKoJYMkw== + +utils-merge@1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/utils-merge/-/utils-merge-1.0.1.tgz#9f95710f50a267947b2ccc124741c1028427e713" + integrity sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA== + +uuid@^8.3.2: + version "8.3.2" + resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2" + integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg== + +value-equal@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/value-equal/-/value-equal-1.0.1.tgz#1e0b794c734c5c0cade179c437d356d931a34d6c" + integrity sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw== + +vary@~1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/vary/-/vary-1.1.2.tgz#2299f02c6ded30d4a5961b0b9f74524a18f634fc" + integrity sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg== + +vfile-location@^5.0.0: + version "5.0.3" + resolved "https://registry.yarnpkg.com/vfile-location/-/vfile-location-5.0.3.tgz#cb9eacd20f2b6426d19451e0eafa3d0a846225c3" + integrity sha512-5yXvWDEgqeiYiBe1lbxYF7UMAIm/IcopxMHrMQDq3nvKcjPKIhZklUKL+AE7J7uApI4kwe2snsK+eI6UTj9EHg== + dependencies: + "@types/unist" "^3.0.0" + vfile "^6.0.0" + +vfile-message@^4.0.0: + version "4.0.3" + resolved "https://registry.yarnpkg.com/vfile-message/-/vfile-message-4.0.3.tgz#87b44dddd7b70f0641c2e3ed0864ba73e2ea8df4" + integrity sha512-QTHzsGd1EhbZs4AsQ20JX1rC3cOlt/IWJruk893DfLRr57lcnOeMaWG4K0JrRta4mIJZKth2Au3mM3u03/JWKw== + dependencies: + "@types/unist" "^3.0.0" + unist-util-stringify-position "^4.0.0" + +vfile@^6.0.0, vfile@^6.0.1: + version "6.0.3" + resolved "https://registry.yarnpkg.com/vfile/-/vfile-6.0.3.tgz#3652ab1c496531852bf55a6bac57af981ebc38ab" + integrity sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q== + dependencies: + "@types/unist" "^3.0.0" + vfile-message "^4.0.0" + +watchpack@^2.4.1: + version "2.4.4" + resolved "https://registry.yarnpkg.com/watchpack/-/watchpack-2.4.4.tgz#473bda72f0850453da6425081ea46fc0d7602947" + integrity sha512-c5EGNOiyxxV5qmTtAB7rbiXxi1ooX1pQKMLX/MIabJjRA0SJBQOjKF+KSVfHkr9U1cADPon0mRiVe/riyaiDUA== + dependencies: + glob-to-regexp "^0.4.1" + graceful-fs "^4.1.2" + +wbuf@^1.1.0, wbuf@^1.7.3: + version "1.7.3" + resolved "https://registry.yarnpkg.com/wbuf/-/wbuf-1.7.3.tgz#c1d8d149316d3ea852848895cb6a0bfe887b87df" + integrity sha512-O84QOnr0icsbFGLS0O3bI5FswxzRr8/gHwWkDlQFskhSPryQXvrTMxjxGP4+iWYoauLoBvfDpkrOauZ+0iZpDA== + dependencies: + minimalistic-assert "^1.0.0" + +web-namespaces@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/web-namespaces/-/web-namespaces-2.0.1.tgz#1010ff7c650eccb2592cebeeaf9a1b253fd40692" + integrity sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ== + +webpack-bundle-analyzer@^4.10.2: + version "4.10.2" + resolved "https://registry.yarnpkg.com/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.10.2.tgz#633af2862c213730be3dbdf40456db171b60d5bd" + integrity sha512-vJptkMm9pk5si4Bv922ZbKLV8UTT4zib4FPgXMhgzUny0bfDDkLXAVQs3ly3fS4/TN9ROFtb0NFrm04UXFE/Vw== + dependencies: + "@discoveryjs/json-ext" "0.5.7" + acorn "^8.0.4" + acorn-walk "^8.0.0" + commander "^7.2.0" + debounce "^1.2.1" + escape-string-regexp "^4.0.0" + gzip-size "^6.0.0" + html-escaper "^2.0.2" + opener "^1.5.2" + picocolors "^1.0.0" + sirv "^2.0.3" + ws "^7.3.1" + +webpack-dev-middleware@^5.3.4: + version "5.3.4" + resolved "https://registry.yarnpkg.com/webpack-dev-middleware/-/webpack-dev-middleware-5.3.4.tgz#eb7b39281cbce10e104eb2b8bf2b63fce49a3517" + integrity sha512-BVdTqhhs+0IfoeAf7EoH5WE+exCmqGerHfDM0IL096Px60Tq2Mn9MAbnaGUe6HiMa41KMCYF19gyzZmBcq/o4Q== + dependencies: + colorette "^2.0.10" + memfs "^3.4.3" + mime-types "^2.1.31" + range-parser "^1.2.1" + schema-utils "^4.0.0" + +webpack-dev-server@^4.15.2: + version "4.15.2" + resolved "https://registry.yarnpkg.com/webpack-dev-server/-/webpack-dev-server-4.15.2.tgz#9e0c70a42a012560860adb186986da1248333173" + integrity sha512-0XavAZbNJ5sDrCbkpWL8mia0o5WPOd2YGtxrEiZkBK9FjLppIUK2TgxK6qGD2P3hUXTJNNPVibrerKcx5WkR1g== + dependencies: + "@types/bonjour" "^3.5.9" + "@types/connect-history-api-fallback" "^1.3.5" + "@types/express" "^4.17.13" + "@types/serve-index" "^1.9.1" + "@types/serve-static" "^1.13.10" + "@types/sockjs" "^0.3.33" + "@types/ws" "^8.5.5" + ansi-html-community "^0.0.8" + bonjour-service "^1.0.11" + chokidar "^3.5.3" + colorette "^2.0.10" + compression "^1.7.4" + connect-history-api-fallback "^2.0.0" + default-gateway "^6.0.3" + express "^4.17.3" + graceful-fs "^4.2.6" + html-entities "^2.3.2" + http-proxy-middleware "^2.0.3" + ipaddr.js "^2.0.1" + launch-editor "^2.6.0" + open "^8.0.9" + p-retry "^4.5.0" + rimraf "^3.0.2" + schema-utils "^4.0.0" + selfsigned "^2.1.1" + serve-index "^1.9.1" + sockjs "^0.3.24" + spdy "^4.0.2" + webpack-dev-middleware "^5.3.4" + ws "^8.13.0" + +webpack-merge@^5.9.0: + version "5.10.0" + resolved "https://registry.yarnpkg.com/webpack-merge/-/webpack-merge-5.10.0.tgz#a3ad5d773241e9c682803abf628d4cd62b8a4177" + integrity sha512-+4zXKdx7UnO+1jaN4l2lHVD+mFvnlZQP/6ljaJVb4SZiwIKeUnrT5l0gkT8z+n4hKpC+jpOv6O9R+gLtag7pSA== + dependencies: + clone-deep "^4.0.1" + flat "^5.0.2" + wildcard "^2.0.0" + +webpack-merge@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/webpack-merge/-/webpack-merge-6.0.1.tgz#50c776868e080574725abc5869bd6e4ef0a16c6a" + integrity sha512-hXXvrjtx2PLYx4qruKl+kyRSLc52V+cCvMxRjmKwoA+CBbbF5GfIBtR6kCvl0fYGqTUPKB+1ktVmTHqMOzgCBg== + dependencies: + clone-deep "^4.0.1" + flat "^5.0.2" + wildcard "^2.0.1" + +webpack-sources@^3.3.3: + version "3.3.3" + resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.3.3.tgz#d4bf7f9909675d7a070ff14d0ef2a4f3c982c723" + integrity sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg== + +webpack@^5.88.1, webpack@^5.95.0: + version "5.101.3" + resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.101.3.tgz#3633b2375bb29ea4b06ffb1902734d977bc44346" + integrity sha512-7b0dTKR3Ed//AD/6kkx/o7duS8H3f1a4w3BYpIriX4BzIhjkn4teo05cptsxvLesHFKK5KObnadmCHBwGc+51A== + dependencies: + "@types/eslint-scope" "^3.7.7" + "@types/estree" "^1.0.8" + "@types/json-schema" "^7.0.15" + "@webassemblyjs/ast" "^1.14.1" + "@webassemblyjs/wasm-edit" "^1.14.1" + "@webassemblyjs/wasm-parser" "^1.14.1" + acorn "^8.15.0" + acorn-import-phases "^1.0.3" + browserslist "^4.24.0" + chrome-trace-event "^1.0.2" + enhanced-resolve "^5.17.3" + es-module-lexer "^1.2.1" + eslint-scope "5.1.1" + events "^3.2.0" + glob-to-regexp "^0.4.1" + graceful-fs "^4.2.11" + json-parse-even-better-errors "^2.3.1" + loader-runner "^4.2.0" + mime-types "^2.1.27" + neo-async "^2.6.2" + schema-utils "^4.3.2" + tapable "^2.1.1" + terser-webpack-plugin "^5.3.11" + watchpack "^2.4.1" + webpack-sources "^3.3.3" + +webpackbar@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/webpackbar/-/webpackbar-6.0.1.tgz#5ef57d3bf7ced8b19025477bc7496ea9d502076b" + integrity sha512-TnErZpmuKdwWBdMoexjio3KKX6ZtoKHRVvLIU0A47R0VVBDtx3ZyOJDktgYixhoJokZTYTt1Z37OkO9pnGJa9Q== + dependencies: + ansi-escapes "^4.3.2" + chalk "^4.1.2" + consola "^3.2.3" + figures "^3.2.0" + markdown-table "^2.0.0" + pretty-time "^1.1.0" + std-env "^3.7.0" + wrap-ansi "^7.0.0" + +websocket-driver@>=0.5.1, websocket-driver@^0.7.4: + version "0.7.4" + resolved "https://registry.yarnpkg.com/websocket-driver/-/websocket-driver-0.7.4.tgz#89ad5295bbf64b480abcba31e4953aca706f5760" + integrity sha512-b17KeDIQVjvb0ssuSDF2cYXSg2iztliJ4B9WdsuB6J952qCPKmnVq4DyW5motImXHDC1cBT/1UezrJVsKw5zjg== + dependencies: + http-parser-js ">=0.5.1" + safe-buffer ">=5.1.0" + websocket-extensions ">=0.1.1" + +websocket-extensions@>=0.1.1: + version "0.1.4" + resolved "https://registry.yarnpkg.com/websocket-extensions/-/websocket-extensions-0.1.4.tgz#7f8473bc839dfd87608adb95d7eb075211578a42" + integrity sha512-OqedPIGOfsDlo31UNwYbCFMSaO9m9G/0faIHj5/dZFDMFqPTcx6UwqyOy3COEaEOg/9VsGIpdqn62W5KhoKSpg== + +which@^2.0.1: + version "2.0.2" + resolved "https://registry.yarnpkg.com/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1" + integrity sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA== + dependencies: + isexe "^2.0.0" + +widest-line@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/widest-line/-/widest-line-4.0.1.tgz#a0fc673aaba1ea6f0a0d35b3c2795c9a9cc2ebf2" + integrity sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig== + dependencies: + string-width "^5.0.1" + +wildcard@^2.0.0, wildcard@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/wildcard/-/wildcard-2.0.1.tgz#5ab10d02487198954836b6349f74fff961e10f67" + integrity sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ== + +wrap-ansi@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" + integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +wrap-ansi@^8.0.1, wrap-ansi@^8.1.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-8.1.0.tgz#56dc22368ee570face1b49819975d9b9a5ead214" + integrity sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ== + dependencies: + ansi-styles "^6.1.0" + string-width "^5.0.1" + strip-ansi "^7.0.1" + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ== + +write-file-atomic@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-3.0.3.tgz#56bd5c5a5c70481cd19c571bd39ab965a5de56e8" + integrity sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q== + dependencies: + imurmurhash "^0.1.4" + is-typedarray "^1.0.0" + signal-exit "^3.0.2" + typedarray-to-buffer "^3.1.5" + +ws@^7.3.1: + version "7.5.10" + resolved "https://registry.yarnpkg.com/ws/-/ws-7.5.10.tgz#58b5c20dc281633f6c19113f39b349bd8bd558d9" + integrity sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ== + +ws@^8.13.0: + version "8.18.3" + resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.3.tgz#b56b88abffde62791c639170400c93dcb0c95472" + integrity sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg== + +xdg-basedir@^5.0.1, xdg-basedir@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/xdg-basedir/-/xdg-basedir-5.1.0.tgz#1efba19425e73be1bc6f2a6ceb52a3d2c884c0c9" + integrity sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ== + +xml-js@^1.6.11: + version "1.6.11" + resolved "https://registry.yarnpkg.com/xml-js/-/xml-js-1.6.11.tgz#927d2f6947f7f1c19a316dd8eea3614e8b18f8e9" + integrity sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g== + dependencies: + sax "^1.2.4" + +yallist@^3.0.2: + version "3.1.1" + resolved "https://registry.yarnpkg.com/yallist/-/yallist-3.1.1.tgz#dbb7daf9bfd8bac9ab45ebf602b8cbad0d5d08fd" + integrity sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g== + +yaml@^1.10.0: + version "1.10.2" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b" + integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg== + +yocto-queue@^1.0.0: + version "1.2.1" + resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-1.2.1.tgz#36d7c4739f775b3cbc28e6136e21aa057adec418" + integrity sha512-AyeEbWOu/TAXdxlV9wmGcR0+yh2j3vYPGOECcIj2S7MkrLyC7ne+oye2BKTItt0ii2PHk4cDy+95+LshzbXnGg== + +zwitch@^2.0.0: + version "2.0.4" + resolved "https://registry.yarnpkg.com/zwitch/-/zwitch-2.0.4.tgz#c827d4b0acb76fc3e685a4c6ec2902d51070e9d7" + integrity sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==